LG-10837: Add New Piv Cac Logging for login visited (#9294)

* changelog: Internal Fixes, Authentication LG-10837: Piv Cac Logging fixes * changelog: Internal, Authentication, Add Login visited for pivcac/change logging names to be uniform * uniform spec test * fix naming convention for piv cac * update rspec * add previous name
18F · Oct 11, 2023 · f1462fc · f1462fc
1 parent f9a0cd0
commit f1462fc
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 18 deletions.
diff --git a/app/controllers/users/piv_cac_authentication_setup_controller.rb b/app/controllers/users/piv_cac_authentication_setup_controller.rb
@@ -56,7 +56,7 @@ def submit_new_piv_cac
     private
 
     def track_piv_cac_setup_visit
-      analytics.piv_cac_setup_visit(**analytics_properties)
+      analytics.piv_cac_setup_visited(**analytics_properties)
     end
 
     def remove_piv_cac

diff --git a/app/controllers/users/piv_cac_login_controller.rb b/app/controllers/users/piv_cac_login_controller.rb
@@ -37,7 +37,7 @@ def error
     private
 
     def render_prompt
-      analytics.piv_cac_setup_visit(in_account_creation_flow: false)
+      analytics.piv_cac_login_visited
       @presenter = PivCacAuthenticationLoginPresenter.new(piv_cac_login_form, url_options)
       render :new
     end

diff --git a/app/controllers/users/piv_cac_setup_from_sign_in_controller.rb b/app/controllers/users/piv_cac_setup_from_sign_in_controller.rb
@@ -32,7 +32,7 @@ def decline
     private
 
     def render_prompt
-      analytics.piv_cac_setup_visit(in_account_creation_flow: false)
+      analytics.piv_cac_setup_visited(in_account_creation_flow: false)
       render :prompt
     end
 

diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb
@@ -2652,13 +2652,14 @@ def multi_factor_auth_added_phone(enabled_mfa_methods_count:, **extra)
     )
   end
 
+  # @identity.idp.previous_event_name Multi-Factor Authentication: Added PIV_CAC
   # Tracks when the user has added the MFA method piv_cac to their account
   # @param [Integer] enabled_mfa_methods_count number of registered mfa methods for the user
   # @param [Boolean] in_account_creation_flow whether user is going through creation flow
   def multi_factor_auth_added_piv_cac(enabled_mfa_methods_count:, in_account_creation_flow:,
                                       **extra)
     track_event(
-      'Multi-Factor Authentication: Added PIV_CAC', # rubocop:disable IdentityIdp/AnalyticsEventNameLinter
+      :multi_factor_auth_added_piv_cac,
       {
         method_name: :piv_cac,
         enabled_mfa_methods_count:,
@@ -2767,6 +2768,7 @@ def multi_factor_auth_enter_personal_key_visit(context:, **extra)
     )
   end
 
+  # @identity.idp.previous_event_name 'Multi-Factor Authentication: enter PIV CAC visited'
   # @param ["authentication","reauthentication","confirmation"] context user session context
   # @param ["piv_cac"] multi_factor_auth_method
   # @param [Integer, nil] piv_cac_configuration_id PIV/CAC configuration database ID
@@ -2778,7 +2780,7 @@ def multi_factor_auth_enter_piv_cac(
     **extra
   )
     track_event(
-      'Multi-Factor Authentication: enter PIV CAC visited', # rubocop:disable IdentityIdp/AnalyticsEventNameLinter
+      :multi_factor_auth_enter_piv_cac,
       context: context,
       multi_factor_auth_method: multi_factor_auth_method,
       piv_cac_configuration_id: piv_cac_configuration_id,
@@ -3352,29 +3354,36 @@ def phone_deletion(success:, phone_configuration_id:, **extra)
   end
 
   # @identity.idp.previous_event_name User Registration: piv cac disabled
+  # @identity.idp.previous_event_name PIV CAC disabled
   # Tracks when user's piv cac is disabled
   def piv_cac_disabled
-    track_event('PIV CAC disabled') # rubocop:disable IdentityIdp/AnalyticsEventNameLinter
+    track_event(:piv_cac_disabled)
   end
 
+  # @identity.idp.previous_event_name PIV/CAC login
   # @param [Boolean] success
   # @param [Hash] errors
   # tracks piv cac login event
   def piv_cac_login(success:, errors:, **extra)
     track_event(
-      'PIV/CAC Login', # rubocop:disable IdentityIdp/AnalyticsEventNameLinter
+      :piv_cac_login,
       success: success,
       errors: errors,
       **extra,
     )
   end
 
+  def piv_cac_login_visited
+    track_event(:piv_cac_login_visited)
+  end
+
   # @identity.idp.previous_event_name User Registration: piv cac setup visited
+  # @identity.idp.previous_event_name PIV CAC setup visited
   # Tracks when user's piv cac setup
   # @param [Boolean] in_account_creation_flow
-  def piv_cac_setup_visit(in_account_creation_flow:, **extra)
+  def piv_cac_setup_visited(in_account_creation_flow:, **extra)
     track_event(
-      'PIV CAC setup visited', # rubocop:disable IdentityIdp/AnalyticsEventNameLinter
+      :piv_cac_setup_visited,
       in_account_creation_flow:,
       **extra,
     )

diff --git a/spec/controllers/two_factor_authentication/piv_cac_verification_controller_spec.rb b/spec/controllers/two_factor_authentication/piv_cac_verification_controller_spec.rb
@@ -105,7 +105,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with('Multi-Factor Authentication: enter PIV CAC visited', attributes)
+          with(:multi_factor_auth_enter_piv_cac, attributes)
 
         submit_attributes = {
           success: true,
@@ -203,7 +203,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with('Multi-Factor Authentication: enter PIV CAC visited', attributes)
+          with(:multi_factor_auth_enter_piv_cac, attributes)
 
         expect(@irs_attempts_api_tracker).to receive(:mfa_login_rate_limited).
           with(mfa_device_type: 'piv_cac')

diff --git a/spec/controllers/users/piv_cac_authentication_setup_controller_spec.rb b/spec/controllers/users/piv_cac_authentication_setup_controller_spec.rb
@@ -108,7 +108,7 @@
           it 'tracks the analytic event of visited' do
             stub_analytics
             expect(@analytics).to receive(:track_event).
-              with('PIV CAC setup visited', {
+              with(:piv_cac_setup_visited, {
                 in_account_creation_flow: false,
                 enabled_mfa_methods_count: 1,
               })

diff --git a/spec/controllers/users/piv_cac_login_controller_spec.rb b/spec/controllers/users/piv_cac_login_controller_spec.rb
@@ -10,10 +10,9 @@
     context 'without a token' do
       before { get :new }
 
-      it 'tracks the piv_cac setup' do
+      it 'tracks the piv cac login' do
         expect(@analytics).to have_received(:track_event).with(
-          'PIV CAC setup visited',
-          in_account_creation_flow: false,
+          :piv_cac_login_visited,
         )
       end
 
@@ -29,7 +28,7 @@
         before { get :new, params: { token: token } }
         it 'tracks the login attempt' do
           expect(@analytics).to have_received(:track_event).with(
-            'PIV/CAC Login',
+            :piv_cac_login,
             {
               errors: {},
               key_id: nil,
@@ -74,7 +73,7 @@
 
           it 'tracks the login attempt' do
             expect(@analytics).to have_received(:track_event).with(
-              'PIV/CAC Login',
+              :piv_cac_login,
               {
                 errors: {
                   type: 'user.not_found',
@@ -113,7 +112,7 @@
 
           it 'tracks the login attempt' do
             expect(@analytics).to have_received(:track_event).with(
-              'PIV/CAC Login',
+              :piv_cac_login,
               {
                 errors: {},
                 key_id: nil,