From 601a168b2fd526d1967199cabfe86272f01a0b4c Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Mon, 15 Apr 2024 14:10:40 -0400 Subject: [PATCH 1/7] LG-12178: new event name of idv_selfie_image_clicked and captureAttempts. changelog: Internal, Doc Auth, Update analytics event for selfie image clicked. --- app/controllers/frontend_log_controller.rb | 2 +- .../document-capture/components/acuant-capture.tsx | 14 +++++++++----- .../components/acuant-capture-spec.jsx | 12 ++++++++---- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/app/controllers/frontend_log_controller.rb b/app/controllers/frontend_log_controller.rb index fd10cdcf9a6..bfdb44323bf 100644 --- a/app/controllers/frontend_log_controller.rb +++ b/app/controllers/frontend_log_controller.rb @@ -35,7 +35,6 @@ class FrontendLogController < ApplicationController 'IdV: personal key acknowledgment toggled' => :idv_personal_key_acknowledgment_toggled, 'IdV: prepare submitted' => :idv_in_person_prepare_submitted, 'IdV: prepare visited' => :idv_in_person_prepare_visited, - 'IdV: selfie image clicked' => :idv_selfie_image_clicked, 'IdV: switch_back submitted' => :idv_in_person_switch_back_submitted, 'IdV: switch_back visited' => :idv_in_person_switch_back_visited, 'IdV: user clicked sp link on ready to verify page' => :idv_in_person_ready_to_verify_sp_link_clicked, @@ -51,6 +50,7 @@ class FrontendLogController < ApplicationController idv_camera_info_error idv_camera_info_logged idv_sdk_error_before_init + idv_sdk_selfie_image_clicked idv_sdk_selfie_image_capture_closed_without_photo idv_sdk_selfie_image_capture_failed idv_sdk_selfie_image_capture_opened diff --git a/app/javascript/packages/document-capture/components/acuant-capture.tsx b/app/javascript/packages/document-capture/components/acuant-capture.tsx index 0b71c29398c..5b1b2e12e7d 100644 --- a/app/javascript/packages/document-capture/components/acuant-capture.tsx +++ b/app/javascript/packages/document-capture/components/acuant-capture.tsx @@ -437,11 +437,15 @@ function AcuantCapture( return any>(fn: T) => (...args: Parameters) => { if (!isSuppressingClickLogging.current) { - trackEvent(`IdV: ${name} image clicked`, { - source, - ...metadata, - liveness_checking_required: isSelfieCaptureEnabled, - }); + trackEvent( + name === 'selfie' ? 'idv_selfie_image_clicked' : `IdV: ${name} image clicked`, + { + source, + ...metadata, + liveness_checking_required: isSelfieCaptureEnabled, + captureAttempts, + }, + ); } return fn(...args); diff --git a/spec/javascript/packages/document-capture/components/acuant-capture-spec.jsx b/spec/javascript/packages/document-capture/components/acuant-capture-spec.jsx index da4a369ab84..931b49bf775 100644 --- a/spec/javascript/packages/document-capture/components/acuant-capture-spec.jsx +++ b/spec/javascript/packages/document-capture/components/acuant-capture-spec.jsx @@ -1176,7 +1176,7 @@ describe('document-capture/components/acuant-capture', () => { }), }); - expect(trackEvent).to.be.calledWith('IdV: selfie image clicked'); + expect(trackEvent).to.be.calledWith('idv_selfie_image_clicked'); expect(trackEvent).to.be.calledWith('IdV: Acuant SDK loaded'); expect(trackEvent).to.have.been.calledWith('idv_sdk_selfie_image_capture_opened'); @@ -1193,7 +1193,7 @@ describe('document-capture/components/acuant-capture', () => { }), }); - expect(trackEvent).to.be.calledWith('IdV: selfie image clicked'); + expect(trackEvent).to.be.calledWith('idv_selfie_image_clicked'); expect(trackEvent).to.be.calledWith('IdV: Acuant SDK loaded'); expect(trackEvent).to.have.been.calledWith( @@ -1212,7 +1212,7 @@ describe('document-capture/components/acuant-capture', () => { }), }); - expect(trackEvent).to.be.calledWith('IdV: selfie image clicked'); + expect(trackEvent).to.be.calledWith('idv_selfie_image_clicked'); expect(trackEvent).to.be.calledWith('IdV: Acuant SDK loaded'); expect(trackEvent).to.have.been.calledWith( @@ -1236,7 +1236,7 @@ describe('document-capture/components/acuant-capture', () => { }), }); - expect(trackEvent).to.be.calledWith('IdV: selfie image clicked'); + expect(trackEvent).to.be.calledWith('idv_selfie_image_clicked'); expect(trackEvent).to.be.calledWith('IdV: Acuant SDK loaded'); expect(trackEvent).to.have.been.calledWith( @@ -1402,16 +1402,19 @@ describe('document-capture/components/acuant-capture', () => { source: 'placeholder', isDrop: false, liveness_checking_required: false, + captureAttempts: 1, }); expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', { source: 'button', isDrop: false, liveness_checking_required: false, + captureAttempts: 1, }); expect(trackEvent).to.have.been.calledWith('IdV: test image clicked', { source: 'upload', isDrop: false, liveness_checking_required: false, + captureAttempts: 1, }); }); @@ -1432,6 +1435,7 @@ describe('document-capture/components/acuant-capture', () => { source: 'placeholder', isDrop: true, liveness_checking_required: false, + captureAttempts: 1, }); }); From 062170fbb7b62bcda313a8c51837cdd37338eaec Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Mon, 15 Apr 2024 16:20:12 -0400 Subject: [PATCH 2/7] LG-12178: fix test. --- app/controllers/frontend_log_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/controllers/frontend_log_controller.rb b/app/controllers/frontend_log_controller.rb index bfdb44323bf..5f140efba36 100644 --- a/app/controllers/frontend_log_controller.rb +++ b/app/controllers/frontend_log_controller.rb @@ -50,10 +50,10 @@ class FrontendLogController < ApplicationController idv_camera_info_error idv_camera_info_logged idv_sdk_error_before_init - idv_sdk_selfie_image_clicked idv_sdk_selfie_image_capture_closed_without_photo idv_sdk_selfie_image_capture_failed idv_sdk_selfie_image_capture_opened + idv_sdk_selfie_image_clicked idv_selfie_image_added phone_input_country_changed ].freeze From 8ffc56122260f09012ab536cd7d3cd1dbbab8742 Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Tue, 16 Apr 2024 12:00:42 -0400 Subject: [PATCH 3/7] LG-12178: event name. --- app/controllers/frontend_log_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/controllers/frontend_log_controller.rb b/app/controllers/frontend_log_controller.rb index 5f140efba36..11efab30328 100644 --- a/app/controllers/frontend_log_controller.rb +++ b/app/controllers/frontend_log_controller.rb @@ -53,8 +53,8 @@ class FrontendLogController < ApplicationController idv_sdk_selfie_image_capture_closed_without_photo idv_sdk_selfie_image_capture_failed idv_sdk_selfie_image_capture_opened - idv_sdk_selfie_image_clicked idv_selfie_image_added + idv_selfie_image_clicked phone_input_country_changed ].freeze From d601d88d70ae4b03c94ed15359d884ff60845788 Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Tue, 16 Apr 2024 14:12:08 -0400 Subject: [PATCH 4/7] LG-12178: add captureAttempts to all click events. --- app/services/analytics_events.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index a7761ae27be..76baff47939 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -764,6 +764,7 @@ def idv_back_image_added( # @param [Boolean] source # @param [Boolean] use_alternate_sdk # @param [String] liveness_checking_required Whether or not the selfie is required + # @param [Number] captureAttempts count of image capturing attempts def idv_back_image_clicked( acuant_sdk_upgrade_a_b_testing_enabled:, acuant_version:, @@ -772,6 +773,7 @@ def idv_back_image_clicked( source:, use_alternate_sdk:, liveness_checking_required:, + captureAttempts:, **extra ) track_event( @@ -783,6 +785,7 @@ def idv_back_image_clicked( source: source, use_alternate_sdk: use_alternate_sdk, liveness_checking_required: liveness_checking_required, + captureAttempts: captureAttempts, **extra, ) end @@ -1529,6 +1532,7 @@ def idv_front_image_added( # @param [Boolean] isDrop # @param [String] source # @param [String] use_alternate_sdk + # @param [Number] captureAttempts count of image capturing attempts # @param [Boolean] liveness_checking_required def idv_front_image_clicked( acuant_sdk_upgrade_a_b_testing_enabled:, @@ -1537,6 +1541,7 @@ def idv_front_image_clicked( isDrop:, source:, use_alternate_sdk:, + captureAttempts:, liveness_checking_required: nil, **extra ) @@ -1549,6 +1554,7 @@ def idv_front_image_clicked( source: source, use_alternate_sdk: use_alternate_sdk, liveness_checking_required: liveness_checking_required, + captureAttempts: captureAttempts, **extra, ) end From f4d94d571dff703aadd2fd053fbc7289bbe247b0 Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Tue, 16 Apr 2024 14:30:20 -0400 Subject: [PATCH 5/7] LG-12178: add captureAttempts to event. --- app/services/analytics_events.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index 76baff47939..28b0efdb59f 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -3335,6 +3335,7 @@ def idv_selfie_image_clicked( isDrop:, source:, use_alternate_sdk:, + captureAttempts:, liveness_checking_required: nil, proofing_components: nil, active_profile_idv_level: nil, @@ -3349,6 +3350,7 @@ def idv_selfie_image_clicked( isDrop: isDrop, source: source, use_alternate_sdk: use_alternate_sdk, + captureAttempts: captureAttempts, liveness_checking_required: liveness_checking_required, proofing_components: proofing_components, active_profile_idv_level: active_profile_idv_level, From fb71056a14c53d1223a1fe4b3cfd516daf0334c4 Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Tue, 16 Apr 2024 14:32:13 -0400 Subject: [PATCH 6/7] LG-12178: add captureAttempts to event. --- app/services/analytics_events.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index 28b0efdb59f..d53ef314b98 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -3324,6 +3324,7 @@ def idv_selfie_image_added( # @param [Boolean] isDrop # @param [String] source # @param [String] use_alternate_sdk + # @param [Number] captureAttempts # @param [Boolean] liveness_checking_required # @param [Hash,nil] proofing_components User's proofing components. # @param [String,nil] active_profile_idv_level ID verification level of user's active profile. From a5212509fb3e3f3a065d1dac7c560dca50207faa Mon Sep 17 00:00:00 2001 From: Dawei Wang Date: Tue, 16 Apr 2024 14:33:33 -0400 Subject: [PATCH 7/7] LG-12178: adjust param order --- app/services/analytics_events.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index d53ef314b98..bafd3338e67 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -763,8 +763,8 @@ def idv_back_image_added( # @param [Boolean] isDrop # @param [Boolean] source # @param [Boolean] use_alternate_sdk - # @param [String] liveness_checking_required Whether or not the selfie is required # @param [Number] captureAttempts count of image capturing attempts + # @param [String] liveness_checking_required Whether or not the selfie is required def idv_back_image_clicked( acuant_sdk_upgrade_a_b_testing_enabled:, acuant_version:, @@ -772,8 +772,8 @@ def idv_back_image_clicked( isDrop:, source:, use_alternate_sdk:, - liveness_checking_required:, captureAttempts:, + liveness_checking_required:, **extra ) track_event(