LG-8190: A/B Testing of Acuant SDK Upgrade

app/forms/idv/api_image_upload_form.rb

@@ -207,7 +207,7 @@ def update_analytics(client_response)
           client_image_metrics: image_metadata,
           async: false,
           flow_path: params[:flow_path],
-        ).merge(native_camera_ab_test_data),
+        ).merge(native_camera_ab_test_data, acuant_sdk_upgrade_ab_test_data),
       )
       pii_from_doc = client_response.pii_from_doc || {}
       store_encrypted_images_if_required
@@ -250,6 +250,14 @@ def native_camera_ab_test_data
       }
     end
 
+    def acuant_sdk_upgrade_ab_test_data
+      return {} unless IdentityConfig.store.idv_acuant_sdk_upgrade_a_b_testing_enabled
+      {
+        acuant_sdk_upgrade_ab_test_bucket:
+          AbTests::ACUANT_SDK.bucket(document_capture_session.uuid),
+      }
+    end
+
     def acuant_sdk_capture?
       image_metadata.dig(:front, :source) == Idp::Constants::Vendors::ACUANT &&
         image_metadata.dig(:back, :source) == Idp::Constants::Vendors::ACUANT

app/javascript/packages/document-capture/context/acuant-sdk-upgrade-a-b-test.tsx

@@ -0,0 +1,23 @@
+import { createContext } from 'react';
+
+interface AcuantSdkUpgradeABTestContextValue {
+  /**
+   * Whether or not the A/B testing of using the newer Acuant
+   * SDK version vs the older version is enabled
+   */
+  acuantSdkUpgradeABTestingEnabled: boolean;
+  /**
+   * Whether or not we should use the newer sdk version as opposed
+   * to the older / current version
+   */
+  useNewerSdk: boolean;
+}
+export const AcuantSdkUpgradeABTestContext = createContext<AcuantSdkUpgradeABTestContextValue>({
+  acuantSdkUpgradeABTestingEnabled: false,
+  useNewerSdk: false,
+});
+
+AcuantSdkUpgradeABTestContext.displayName = 'AcuantSdkUpgradeABTestContext';
+
+export default AcuantSdkUpgradeABTestContext;
+export const AcuantSdkUpgradeABTestContextProvider = AcuantSdkUpgradeABTestContext.Provider;

app/javascript/packages/document-capture/context/acuant.tsx

@@ -3,6 +3,7 @@ import type { ReactNode } from 'react';
 import useObjectMemo from '@18f/identity-react-hooks/use-object-memo';
 import DeviceContext from './device';
 import AnalyticsContext from './analytics';
+import { AcuantSdkUpgradeABTestContext } from './acuant-sdk-upgrade-a-b-test';
 
 /**
  * Global declarations
@@ -80,11 +81,13 @@ type AcuantWorkersInitialize = (callback: () => void) => void;
 
 interface AcuantContextProviderProps {
   /**
-   * SDK source URL.
+   * The relative url source for the
+   * main acuant sdk file
    */
   sdkSrc: string;
   /**
-   * Camera JavaScript source URL.
+   * The relative url source for the
+   * camera acuant sdk file
    */
   cameraSrc: string;
   /**
@@ -193,8 +196,8 @@ const getActualAcuantCamera = (): AcuantCameraInterface => {
 };
 
 function AcuantContextProvider({
-  sdkSrc = '/acuant/11.7.1/AcuantJavascriptWebSdk.min.js',
-  cameraSrc = '/acuant/11.7.1/AcuantCamera.min.js',
+  sdkSrc = '/acuant/11.7.0/AcuantJavascriptWebSdk.min.js',
+  cameraSrc = '/acuant/11.7.0/AcuantCamera.min.js',
   credentials = null,
   endpoint = null,
   glareThreshold = DEFAULT_ACCEPTABLE_GLARE_SCORE,
@@ -203,6 +206,26 @@ function AcuantContextProvider({
 }: AcuantContextProviderProps) {
   const { isMobile } = useContext(DeviceContext);
   const { trackEvent } = useContext(AnalyticsContext);
+
+  // Set the appropriate SDK sources based on
+  // A/B Testing
+  const { acuantSdkUpgradeABTestingEnabled, useNewerSdk } = useContext(
+    AcuantSdkUpgradeABTestContext,
+  );
+  let sdkVersion = '11.7.0';
+  if (acuantSdkUpgradeABTestingEnabled && useNewerSdk) {
+    sdkSrc = '/acuant/11.7.1/AcuantJavascriptWebSdk.min.js';
+    cameraSrc = '/acuant/11.7.1/AcuantCamera.min.js';
+    sdkVersion = '11.7.1';
+  }
+
+  if (acuantSdkUpgradeABTestingEnabled) {
+    trackEvent('IdV: Acuant SDK Upgrade A/B Test', {
+      use_newer_sdk: useNewerSdk,
+      version: sdkVersion,
+    });
+  }
+
   // Only mobile devices should load the Acuant SDK. Consider immediately ready otherwise.
   const [isReady, setIsReady] = useState(!isMobile);
   const [isAcuantLoaded, setIsAcuantLoaded] = useState(false);

app/javascript/packages/document-capture/context/index.ts

@@ -20,3 +20,7 @@ export {
   default as NativeCameraABTestContext,
   Provider as NativeCameraABTestContextProvider,
 } from './native-camera-a-b-test';
+export {
+  default as AcuantSdkUpgradeABTestContext,
+  Provider as AcuantSdkUpgradeABTestContextProvider,
+} from './native-camera-a-b-test';

app/javascript/packs/document-capture.tsx

@@ -10,6 +10,7 @@ import {
   AnalyticsContextProvider,
   FailedCaptureAttemptsContextProvider,
   NativeCameraABTestContextProvider,
+  AcuantSdkUpgradeABTestContextProvider,
   MarketingSiteContextProvider,
 } from '@18f/identity-document-capture';
 import { isCameraCapableMobile } from '@18f/identity-device';
@@ -30,6 +31,8 @@ interface AppRootData {
   maxAttemptsBeforeNativeCamera: string;
   nativeCameraABTestingEnabled: string;
   nativeCameraOnly: string;
+  acuantSdkUpgradeABTestingEnabled: string;
+  useNewerSdk: string;
   flowPath: FlowPath;
   cancelUrl: string;
   idvInPersonUrl?: string;
@@ -110,6 +113,8 @@ const trackEvent: typeof baseTrackEvent = (event, payload) => {
     maxSubmissionAttemptsBeforeNativeCamera,
     nativeCameraABTestingEnabled,
     nativeCameraOnly,
+    acuantSdkUpgradeABTestingEnabled,
+    useNewerSdk,
     appName,
     flowPath,
     cancelUrl: cancelURL,
@@ -171,6 +176,13 @@ const trackEvent: typeof baseTrackEvent = (event, payload) => {
         nativeCameraOnly: nativeCameraOnly === 'true',
       },
     ],
+    [
+      AcuantSdkUpgradeABTestContextProvider,
+      {
+        acuantSdkUpgradeABTestingEnabled: acuantSdkUpgradeABTestingEnabled === 'true',
+        useNewerSdk: useNewerSdk === 'true',
+      },
+    ],
     [DocumentCapture, { isAsyncForm, onStepChange: keepAlive }],
   );
 

app/services/analytics_events.rb

@@ -521,6 +521,23 @@ def idv_native_camera_forced(
     )
   end
 
+  # @param [Boolean] use_newer_sdk Whether not to load the newer Acuant SDK version
+  # @param [String] version The version of the Acuant SDK that was loaded
+  # An A/B test for loading the old vs new version of the Acuant SDK.
+  # If this analytics call is not made at all, then the test isn't enabled.
+  def idv_acuant_sdk_upgrade_a_b_test(
+    use_newer_sdk:,
+    version:,
+    **extra
+  )
+    track_event(
+      'IdV: Acuant SDK Upgrade A/B Test',
+      use_newer_sdk: use_newer_sdk,
+      version: version,
+      **extra,
+    )
+  end
+
   # @param [String] step the step that the user was on when they clicked cancel
   # @param [Idv::ProofingComponentsLogging] proofing_components User's current proofing components
   # The user confirmed their choice to cancel going through IDV

app/services/idv/steps/document_capture_step.rb

@@ -29,7 +29,7 @@ def extra_view_variables
             image_type: 'back',
             transaction_id: flow_session[:document_capture_session_uuid],
           ),
-        }.merge(native_camera_ab_testing_variables)
+        }.merge(native_camera_ab_testing_variables, acuant_sdk_upgrade_a_b_testing_variables)
       end
 
       private
@@ -44,6 +44,15 @@ def native_camera_ab_testing_variables
         }
       end
 
+      def acuant_sdk_upgrade_a_b_testing_variables
+        bucket = AbTests::ACUANT_SDK.bucket(flow_session[:document_capture_session_uuid])
+        {
+          acuant_sdk_upgrade_a_b_testing_enabled:
+              IdentityConfig.store.idv_acuant_sdk_upgrade_a_b_testing_enabled,
+          use_newer_sdk: (bucket == :use_newer_sdk),
+        }
+      end
+
       def handle_stored_result
         if stored_result&.success?
           save_proofing_components

app/views/idv/capture_doc/document_capture.html.erb

@@ -8,4 +8,6 @@
       back_image_upload_url: back_image_upload_url,
       native_camera_a_b_testing_enabled: native_camera_a_b_testing_enabled,
       native_camera_only: native_camera_only,
+      acuant_sdk_upgrade_a_b_testing_enabled: acuant_sdk_upgrade_a_b_testing_enabled,
+      use_newer_sdk: use_newer_sdk,
     ) %>

app/views/idv/doc_auth/document_capture.html.erb

@@ -8,4 +8,6 @@
       back_image_upload_url: back_image_upload_url,
       native_camera_a_b_testing_enabled: native_camera_a_b_testing_enabled,
       native_camera_only: native_camera_only,
+      acuant_sdk_upgrade_a_b_testing_enabled: acuant_sdk_upgrade_a_b_testing_enabled,
+      use_newer_sdk: use_newer_sdk,
     ) %>

app/views/idv/shared/_document_capture.html.erb

@@ -33,6 +33,8 @@
       max_submission_attempts_before_native_camera: IdentityConfig.store.doc_auth_max_submission_attempts_before_native_camera,
       native_camera_a_b_testing_enabled: native_camera_a_b_testing_enabled,
       native_camera_only: native_camera_only,
+      acuant_sdk_upgrade_a_b_testing_enabled: acuant_sdk_upgrade_a_b_testing_enabled,
+      use_newer_sdk: use_newer_sdk,
       sp_name: sp_name,
       flow_path: flow_path,
       cancel_url: idv_cancel_path,

config/application.yml.default

@@ -116,6 +116,8 @@ idv_max_attempts: 5
 idv_min_age_years: 13
 idv_native_camera_a_b_testing_enabled: false
 idv_native_camera_a_b_testing_percent: 10
+idv_acuant_sdk_upgrade_a_b_testing_enabled: true
+idv_acuant_sdk_upgrade_a_b_testing_percent: 50
 idv_send_link_attempt_window_in_minutes: 10
 idv_send_link_max_attempts: 5
 ie11_support_end_date: '2022-12-31'

config/initializers/ab_tests.rb

@@ -18,4 +18,11 @@ module AbTests
         nil,
     }.compact,
   )
+
+  ACUANT_SDK = AbTestBucket.new(
+    experiment_name: 'Acuant SDK Upgrade',
+    buckets: {
+      use_newer_sdk: IdentityConfig.store.idv_acuant_sdk_upgrade_a_b_testing_percent,
+    },
+  )
 end

lib/identity_config.rb

@@ -195,6 +195,8 @@ def self.build_store(config_map)
     config.add(:idv_min_age_years, type: :integer)
     config.add(:idv_native_camera_a_b_testing_enabled, type: :boolean)
     config.add(:idv_native_camera_a_b_testing_percent, type: :integer)
+    config.add(:idv_acuant_sdk_upgrade_a_b_testing_enabled, type: :boolean)
+    config.add(:idv_acuant_sdk_upgrade_a_b_testing_percent, type: :integer)
     config.add(:idv_send_link_attempt_window_in_minutes, type: :integer)
     config.add(:idv_send_link_max_attempts, type: :integer)
     config.add(:idv_sp_required, type: :boolean)

spec/javascripts/packages/document-capture/components/acuant-capture-spec.jsx

@@ -958,16 +958,16 @@ describe('document-capture/components/acuant-capture', () => {
     const upload = getByText('Upload');
     fireEvent.click(upload);
 
-    expect(trackEvent).to.have.been.calledThrice();
-    expect(trackEvent.getCall(0)).to.have.been.calledWith('IdV: test image clicked', {
+    expect(trackEvent.callCount).to.be.at.least(3);
+    expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', {
       source: 'placeholder',
       isDrop: false,
     });
-    expect(trackEvent.getCall(1)).to.have.been.calledWith('IdV: test image clicked', {
+    expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', {
       source: 'button',
       isDrop: false,
     });
-    expect(trackEvent.getCall(2)).to.have.been.calledWith('IdV: test image clicked', {
+    expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', {
       source: 'upload',
       isDrop: false,
     });
@@ -986,7 +986,7 @@ describe('document-capture/components/acuant-capture', () => {
     const input = getByLabelText('Image');
     fireEvent.drop(input);
 
-    expect(trackEvent.getCall(0)).to.have.been.calledWith('IdV: test image clicked', {
+    expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', {
       source: 'placeholder',
       isDrop: true,
     });