LG-12617: Add additional profile-related fields to enhanced Idv events

app/services/idv/analytics_events_enhancer.rb

@@ -84,7 +84,6 @@ module AnalyticsEventsEnhancer
       idv_in_person_usps_proofing_results_job_unexpected_response
       idv_in_person_usps_proofing_results_job_user_sent_to_fraud_review
       idv_in_person_usps_request_enroll_exception
-      idv_intro_visit
       idv_ipp_deactivated_for_never_visiting_post_office
       idv_link_sent_capture_doc_polling_complete
       idv_link_sent_capture_doc_polling_started
@@ -109,6 +108,20 @@ module AnalyticsEventsEnhancer
       idv_warning_shown
     ].to_set.freeze
 
+    STANDARD_ARGUMENTS = %i[
+      proofing_components
+      active_profile_idv_level
+      pending_profile_idv_level
+    ].freeze
+
+    METHODS_WITH_PROFILE_HISTORY = %i[
+      idv_doc_auth_verify_proofing_results
+      idv_intro_visit
+      idv_final
+      idv_please_call_visited
+      idv_start_over
+    ].to_set.freeze
+
     def self.included(_mod)
       raise 'this mixin is intended to be prepended, not included'
     end
@@ -117,24 +130,56 @@ def self.prepended(mod)
       mod.instance_methods.each do |method_name|
         if should_enhance_method?(method_name)
           mod.define_method method_name do |**kwargs|
-            super(**kwargs, **common_analytics_attributes)
+            super(**kwargs, **analytics_attributes(method_name))
           end
         end
       end
     end
 
     def self.should_enhance_method?(method_name)
       return false if IGNORED_METHODS.include?(method_name)
-
       method_name.start_with?('idv_')
     end
 
+    def self.extra_args_for_method(method_name)
+      return [] unless should_enhance_method?(method_name)
+
+      args = STANDARD_ARGUMENTS
+
+      if METHODS_WITH_PROFILE_HISTORY.include?(method_name)
+        args = [
+          *args,
+          :profile_history,
+        ]
+      end
+
+      args
+    end
+
     private
 
-    def common_analytics_attributes
-      {
-        proofing_components: proofing_components,
-      }.compact
+    def analytics_attributes(method_name)
+      AnalyticsEventsEnhancer.extra_args_for_method(method_name).
+        index_with do |arg_name|
+          send(arg_name.to_s).presence
+        end.
+        compact
+    end
+
+    def active_profile_idv_level
+      user&.respond_to?(:active_profile) && user&.active_profile&.idv_level
+    end
+
+    def pending_profile_idv_level
+      user&.respond_to?(:pending_profile) && user&.pending_profile&.idv_level
+    end
+
+    def profile_history
+      return if !user&.respond_to?(:profiles)
+
+      (user&.profiles || []).
+        sort_by { |profile| profile.created_at }.
+        map { |profile| ProfileLogging.new(profile) }
     end
 
     def proofing_components

app/services/idv/profile_logging.rb

@@ -0,0 +1,22 @@
+module Idv
+  ProfileLogging = Struct.new(:profile) do
+    def as_json
+      profile.slice(
+        %i[
+          id
+          active
+          idv_level
+          created_at
+          verified_at
+          activated_at
+          in_person_verification_pending_at
+          gpo_verification_pending_at
+          fraud_review_pending_at
+          fraud_rejection_at
+          fraud_pending_reason
+          deactivation_reason
+        ],
+      ).compact
+    end
+  end
+end

spec/controllers/idv/by_mail/letter_enqueued_controller_spec.rb

@@ -16,10 +16,7 @@
 
       get :show
 
-      expect(@analytics).to have_logged_event(
-        'IdV: letter enqueued visited',
-        proofing_components: nil,
-      )
+      expect(@analytics).to have_logged_event('IdV: letter enqueued visited')
     end
 
     it 'renders the show template' do

spec/controllers/idv/by_mail/request_letter_controller_spec.rb

@@ -166,12 +166,13 @@
 
         expect(@analytics).to have_logged_event(
           'IdV: USPS address letter requested',
-          resend: false,
-          phone_step_attempts: 1,
-          first_letter_requested_at: nil,
-          hours_since_first_letter: 0,
-          proofing_components: nil,
-          **ab_test_args,
+          hash_including(
+            resend: false,
+            phone_step_attempts: 1,
+            first_letter_requested_at: nil,
+            hours_since_first_letter: 0,
+            **ab_test_args,
+          ),
         )
       end
 
@@ -222,23 +223,26 @@
 
         expect(@analytics).to have_logged_event(
           'IdV: USPS address letter requested',
-          resend: true,
-          phone_step_attempts: 1,
-          first_letter_requested_at: pending_profile.gpo_verification_pending_at,
-          hours_since_first_letter: 24,
-          proofing_components: nil,
-          **ab_test_args,
+          hash_including(
+            resend: true,
+            phone_step_attempts: 1,
+            first_letter_requested_at: pending_profile.gpo_verification_pending_at,
+            hours_since_first_letter: 24,
+            **ab_test_args,
+          ),
         )
 
         expect(@analytics).to have_logged_event(
           'IdV: USPS address letter enqueued',
-          resend: true,
-          first_letter_requested_at: pending_profile.gpo_verification_pending_at,
-          hours_since_first_letter: 24,
-          enqueued_at: Time.zone.now,
-          phone_step_attempts: 1,
-          proofing_components: nil,
-          **ab_test_args,
+          hash_including(
+            resend: true,
+            first_letter_requested_at: pending_profile.gpo_verification_pending_at,
+            hours_since_first_letter: 24,
+            enqueued_at: Time.zone.now,
+            phone_step_attempts: 1,
+            proofing_components: nil,
+            **ab_test_args,
+          ),
         )
       end
 

spec/controllers/idv/cancellations_controller_spec.rb

@@ -22,9 +22,10 @@
 
       expect(@analytics).to have_logged_event(
         'IdV: cancellation visited',
-        request_came_from: 'no referer',
-        step: nil,
-        proofing_components: nil,
+        hash_including(
+          request_came_from: 'no referer',
+          step: nil,
+        ),
       )
     end
 
@@ -37,9 +38,10 @@
 
       expect(@analytics).to have_logged_event(
         'IdV: cancellation visited',
-        request_came_from: 'users/sessions#new',
-        step: nil,
-        proofing_components: nil,
+        hash_including(
+          request_came_from: 'users/sessions#new',
+          step: nil,
+        ),
       )
     end
 
@@ -51,9 +53,10 @@
 
       expect(@analytics).to have_logged_event(
         'IdV: cancellation visited',
-        request_came_from: 'no referer',
-        step: 'first',
-        proofing_components: nil,
+        hash_including(
+          request_came_from: 'no referer',
+          step: 'first',
+        ),
       )
     end
 
@@ -115,11 +118,9 @@
 
       expect(@analytics).to have_logged_event(
         'IdV: cancellation go back',
-        step: 'first',
-        proofing_components: nil,
-        cancelled_enrollment: nil,
-        enrollment_code: nil,
-        enrollment_id: nil,
+        hash_including(
+          step: 'first',
+        ),
       )
     end
 
@@ -137,11 +138,12 @@
 
         expect(@analytics).to have_logged_event(
           'IdV: cancellation go back',
-          step: 'barcode',
-          proofing_components: nil,
-          cancelled_enrollment: false,
-          enrollment_code: enrollment.enrollment_code,
-          enrollment_id: enrollment.id,
+          hash_including(
+            step: 'barcode',
+            cancelled_enrollment: false,
+            enrollment_code: enrollment.enrollment_code,
+            enrollment_id: enrollment.id,
+          ),
         )
       end
     end
@@ -172,8 +174,7 @@
 
       expect(@analytics).to have_logged_event(
         'IdV: cancellation confirmed',
-        step: 'first',
-        proofing_components: nil,
+        hash_including(step: 'first'),
       )
     end