Omit empty FormResponse errors from analytics logging

app/services/form_response.rb

@@ -19,7 +19,7 @@ def success?
 
   def to_h
     hash = { success: success }
-    hash[:errors] = errors if !serialize_error_details_only?
+    hash[:errors] = errors.presence if !serialize_error_details_only?
     hash[:error_details] = flatten_details(error_details) if error_details.present?
     hash.merge!(extra)
     hash

spec/controllers/account_reset/delete_account_controller_spec.rb

@@ -24,7 +24,6 @@
         'Account Reset: delete',
         user_id: user.uuid,
         success: true,
-        errors: {},
         mfa_method_counts: {
           backup_codes: BackupCodeGenerator::NUMBER_OF_CODES,
           webauthn: 2,
@@ -117,7 +116,6 @@
         'Account Reset: delete',
         user_id: user.uuid,
         success: true,
-        errors: {},
         mfa_method_counts: { phone: 1 },
         profile_idv_level: 'legacy_unsupervised',
         identity_verified: true,
@@ -140,7 +138,6 @@
         'Account Reset: delete',
         user_id: user.uuid,
         success: true,
-        errors: {},
         mfa_method_counts: { phone: 1 },
         profile_idv_level: 'unsupervised_with_selfie',
         identity_verified: true,
@@ -165,7 +162,6 @@
         'Account Reset: delete',
         user_id: user.uuid,
         success: true,
-        errors: {},
         mfa_method_counts: { phone: 1 },
         profile_idv_level: 'in_person',
         identity_verified: true,

spec/controllers/account_reset/request_controller_spec.rb

@@ -107,7 +107,6 @@
         totp: true,
         piv_cac: false,
         email_addresses: 1,
-        errors: {},
       )
     end
 
@@ -127,7 +126,6 @@
         email_addresses: 1,
         request_id: 'fake-message-request-id',
         message_id: 'fake-message-id',
-        errors: {},
       )
     end
 
@@ -145,7 +143,6 @@
         totp: false,
         piv_cac: true,
         email_addresses: 1,
-        errors: {},
       )
     end
 

spec/controllers/concerns/two_factor_authenticatable_methods_spec.rb

@@ -32,7 +32,6 @@
         expect(@analytics).to have_logged_event(
           'Multi-Factor Authentication',
           success: true,
-          errors: {},
           multi_factor_auth_method: TwoFactorAuthenticatable::AuthMethod::REMEMBER_DEVICE,
           enabled_mfa_methods_count: 0,
           new_device: true,
@@ -219,7 +218,6 @@
         expect(@analytics).to have_logged_event(
           'Multi-Factor Authentication',
           success: true,
-          errors: {},
           multi_factor_auth_method: TwoFactorAuthenticatable::AuthMethod::SMS,
           enabled_mfa_methods_count: 1,
           new_device: true,

spec/controllers/event_disavowal_controller_spec.rb

@@ -172,7 +172,7 @@
     end
   end
 
-  def build_analytics_hash(success: true, errors: {}, user_id: nil)
+  def build_analytics_hash(success: true, errors: nil, user_id: nil)
     hash_including(
       {
         event_created_at: event.created_at,

spec/controllers/idv/address_controller_spec.rb

@@ -90,7 +90,6 @@
       expect(@analytics).to have_logged_event(
         'IdV: address submitted',
         success: true,
-        errors: {},
         address_edited: true,
       )
     end

spec/controllers/idv/agreement_controller_spec.rb

@@ -100,7 +100,6 @@
     let(:analytics_args) do
       {
         success: true,
-        errors: {},
         step: 'agreement',
         analytics_id: 'Doc Auth',
       }

spec/controllers/idv/by_mail/enter_code_controller_spec.rb

@@ -200,7 +200,6 @@
         expect(@analytics).to have_logged_event(
           'IdV: enter verify by mail code submitted',
           success: true,
-          errors: {},
           pending_in_person_enrollment: false,
           fraud_check_failed: false,
           enqueued_at: pending_profile.gpo_confirmation_codes.last.code_sent_at,
@@ -246,7 +245,6 @@
           expect(@analytics).to have_logged_event(
             'IdV: enter verify by mail code submitted',
             success: true,
-            errors: {},
             pending_in_person_enrollment: true,
             fraud_check_failed: false,
             enqueued_at: pending_profile.gpo_confirmation_codes.last.code_sent_at,
@@ -276,7 +274,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: enter verify by mail code submitted',
               success: true,
-              errors: {},
               pending_in_person_enrollment: false,
               fraud_check_failed: true,
               enqueued_at: pending_profile.gpo_confirmation_codes.last.code_sent_at,
@@ -314,7 +311,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: enter verify by mail code submitted',
               success: true,
-              errors: {},
               pending_in_person_enrollment: false,
               fraud_check_failed: true,
               enqueued_at: user.pending_profile.gpo_confirmation_codes.last.code_sent_at,
@@ -357,7 +353,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: enter verify by mail code submitted',
               success: true,
-              errors: {},
               pending_in_person_enrollment: false,
               fraud_check_failed: true,
               enqueued_at: user.pending_profile.gpo_confirmation_codes.last.code_sent_at,
@@ -455,11 +450,11 @@
 
           failed_gpo_submission_events =
             @analytics.events['IdV: enter verify by mail code submitted']
-              .reject { |event_attributes| event_attributes[:errors].empty? }
+              .reject { |event_attributes| event_attributes[:errors].blank? }
 
           successful_gpo_submission_events =
             @analytics.events['IdV: enter verify by mail code submitted']
-              .select { |event_attributes| event_attributes[:errors].empty? }
+              .select { |event_attributes| event_attributes[:errors].blank? }
 
           expect(failed_gpo_submission_events.count).to eq(max_attempts - 1)
           expect(successful_gpo_submission_events.count).to eq(1)

spec/controllers/idv/document_capture_controller_spec.rb

@@ -348,7 +348,6 @@
     let(:analytics_args) do
       {
         success: true,
-        errors: {},
         analytics_id: 'Doc Auth',
         flow_path: 'standard',
         step: 'document_capture',

spec/controllers/idv/how_to_verify_controller_spec.rb

@@ -205,7 +205,6 @@
         {
           analytics_id: 'Doc Auth',
           step: 'how_to_verify',
-          errors: {},
           success: true,
           selection:,
         }
@@ -230,7 +229,6 @@
         {
           analytics_id: 'Doc Auth',
           step: 'how_to_verify',
-          errors: {},
           success: true,
           selection:,
         }

spec/controllers/idv/hybrid_handoff_controller_spec.rb

@@ -342,7 +342,6 @@
       let(:analytics_args) do
         {
           success: true,
-          errors: {},
           destination: :document_capture,
           flow_path: 'standard',
           step: 'hybrid_handoff',

spec/controllers/idv/hybrid_mobile/document_capture_controller_spec.rb

@@ -196,7 +196,6 @@
       let(:analytics_args) do
         {
           success: true,
-          errors: {},
           analytics_id: 'Doc Auth',
           flow_path: 'hybrid',
           step: 'document_capture',

spec/controllers/idv/image_uploads_controller_spec.rb

@@ -346,7 +346,6 @@
         expect(@analytics).to have_logged_event(
           'IdV: doc auth image upload form submitted',
           success: true,
-          errors: {},
           user_id: user.uuid,
           submit_attempts: 1,
           remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -392,7 +391,6 @@
         expect(@analytics).to have_logged_event(
           'IdV: doc auth image upload vendor pii validation',
           success: true,
-          errors: {},
           attention_with_barcode: false,
           user_id: user.uuid,
           submit_attempts: 1,
@@ -479,7 +477,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: doc auth image upload form submitted',
               success: true,
-              errors: {},
               user_id: user.uuid,
               submit_attempts: 1,
               remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -558,7 +555,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: doc auth image upload form submitted',
               success: true,
-              errors: {},
               user_id: user.uuid,
               submit_attempts: 1,
               remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -637,7 +633,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: doc auth image upload form submitted',
               success: true,
-              errors: {},
               user_id: user.uuid,
               submit_attempts: 1,
               remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -713,7 +708,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: doc auth image upload form submitted',
               success: true,
-              errors: {},
               user_id: user.uuid,
               submit_attempts: 1,
               remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -788,7 +782,6 @@
             expect(@analytics).to have_logged_event(
               'IdV: doc auth image upload form submitted',
               success: true,
-              errors: {},
               user_id: user.uuid,
               submit_attempts: 1,
               remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -890,7 +883,6 @@
         expect(@analytics).to have_logged_event(
           'IdV: doc auth image upload form submitted',
           success: true,
-          errors: {},
           user_id: user.uuid,
           submit_attempts: 1,
           remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,
@@ -957,7 +949,6 @@
         expect(@analytics).to have_logged_event(
           'IdV: doc auth image upload form submitted',
           success: true,
-          errors: {},
           user_id: user.uuid,
           submit_attempts: 1,
           remaining_submit_attempts: IdentityConfig.store.doc_auth_max_attempts - 1,

spec/controllers/idv/in_person/address_controller_spec.rb

@@ -136,7 +136,6 @@
       let(:analytics_args) do
         {
           success: true,
-          errors: {},
           analytics_id: 'In Person Proofing',
           flow_path: 'standard',
           step: 'address',
@@ -217,7 +216,6 @@
       let(:analytics_args) do
         {
           success: false,
-          errors: {},
           analytics_id: 'In Person Proofing',
           flow_path: 'standard',
           step: 'address',

spec/controllers/idv/in_person/ssn_controller_spec.rb

@@ -138,7 +138,6 @@
           flow_path: 'standard',
           step: 'ssn',
           success: true,
-          errors: {},
         }
       end
 
@@ -176,7 +175,6 @@
             step: 'ssn',
             success: true,
             previous_ssn_edit_distance: 6,
-            errors: {},
           }
         end
 

spec/controllers/idv/in_person/state_id_controller_spec.rb

@@ -150,7 +150,6 @@
       let(:analytics_args) do
         {
           success: true,
-          errors: {},
           analytics_id: 'In Person Proofing',
           flow_path: 'standard',
           step: 'state_id',

spec/controllers/idv/otp_verification_controller_spec.rb

@@ -160,7 +160,6 @@
         'IdV: phone confirmation otp submitted',
         hash_including(
           success: true,
-          errors: {},
           code_expired: false,
           code_matches: true,
           otp_delivery_preference: :sms,

spec/controllers/idv/phone_controller_spec.rb

@@ -337,7 +337,6 @@
           'IdV: phone confirmation form',
           hash_including(
             success: true,
-            errors: {},
             area_code: '703',
             country_code: 'US',
             carrier: 'Test Mobile Carrier',
@@ -441,7 +440,6 @@
             success: true,
             new_phone_added: true,
             hybrid_handoff_phone_used: false,
-            errors: {},
             phone_fingerprint: Pii::Fingerprinter.fingerprint(proofing_phone.e164),
             country_code: proofing_phone.country,
             area_code: proofing_phone.area_code,

spec/controllers/idv/resend_otp_controller_spec.rb

@@ -57,7 +57,6 @@
         hash_including(
           success: true,
           phone_fingerprint: Pii::Fingerprinter.fingerprint(Phonelib.parse(phone).e164),
-          errors: {},
           otp_delivery_preference: :sms,
           country_code: 'US',
           area_code: '225',

spec/controllers/idv/ssn_controller_spec.rb

@@ -159,7 +159,6 @@
           flow_path: 'standard',
           step: 'ssn',
           success: true,
-          errors: {},
         }
       end
 
@@ -177,7 +176,6 @@
             step: 'ssn',
             success: true,
             previous_ssn_edit_distance: 6,
-            errors: {},
           }
         end