Migrate analytics events, batch 21 (LG-5940)

app/controllers/mfa_confirmation_controller.rb

@@ -71,7 +71,7 @@ def handle_invalid_password
   end
 
   def handle_max_password_attempts_reached
-    analytics.track_event(Analytics::PASSWORD_MAX_ATTEMPTS)
+    analytics.password_max_attempts
     sign_out
     redirect_to root_url, flash: { error: t('errors.max_password_attempts_reached') }
   end

app/controllers/password_capture_controller.rb

@@ -54,7 +54,7 @@ def handle_invalid_password
   end
 
   def handle_max_password_attempts_reached
-    analytics.track_event(Analytics::PASSWORD_MAX_ATTEMPTS)
+    analytics.password_max_attempts
     sign_out
     redirect_to root_url, flash: { error: t('errors.max_password_attempts_reached') }
   end

app/controllers/sign_up/passwords_controller.rb

@@ -13,7 +13,7 @@ def new
 
     def create
       result = password_form.submit(permitted_params)
-      analytics.track_event(Analytics::PASSWORD_CREATION, result.to_h)
+      analytics.password_creation(**result.to_h)
       store_sp_metadata_in_session unless sp_request_id.empty?
 
       if result.success?

app/controllers/users/passwords_controller.rb

@@ -15,7 +15,7 @@ def update
 
       result = @update_user_password_form.submit(user_params)
 
-      analytics.track_event(Analytics::PASSWORD_CHANGED, result.to_h)
+      analytics.password_changed(**result.to_h)
 
       if result.success?
         handle_valid_password

app/controllers/users/reset_passwords_controller.rb

@@ -9,7 +9,7 @@ def create
       @password_reset_email_form = PasswordResetEmailForm.new(email)
       result = @password_reset_email_form.submit
 
-      analytics.track_event(Analytics::PASSWORD_RESET_EMAIL, result.to_h)
+      analytics.password_reset_email(**result.to_h)
 
       if result.success?
         handle_valid_email
@@ -38,7 +38,7 @@ def update
 
       result = @reset_password_form.submit(user_params)
 
-      analytics.track_event(Analytics::PASSWORD_RESET_PASSWORD, result.to_h)
+      analytics.password_reset_password(**result.to_h)
 
       if result.success?
         handle_successful_password_reset

app/services/analytics.rb

@@ -153,11 +153,6 @@ def session_started_at
   OPENID_CONNECT_REQUEST_AUTHORIZATION = 'OpenID Connect: authorization request'
   OPENID_CONNECT_TOKEN = 'OpenID Connect: token'
   OTP_DELIVERY_SELECTION = 'OTP: Delivery Selection'
-  PASSWORD_CHANGED = 'Password Changed'
-  PASSWORD_CREATION = 'Password Creation'
-  PASSWORD_MAX_ATTEMPTS = 'Password Max Attempts Reached'
-  PASSWORD_RESET_EMAIL = 'Password Reset: Email Submitted'
-  PASSWORD_RESET_PASSWORD = 'Password Reset: Password Submitted'
   PASSWORD_RESET_TOKEN = 'Password Reset: Token Submitted'
   PASSWORD_RESET_VISIT = 'Password Reset: Email Form Visited'
   PENDING_ACCOUNT_RESET_CANCELLED = 'Pending account reset cancelled'

app/services/analytics_events.rb

@@ -987,6 +987,58 @@ def multi_factor_auth_enter_webauthn_visit(
     )
   end
 
+  # @param [Boolean] success
+  # @param [Hash] errors
+  # The user updated their password
+  def password_changed(success:, errors:, **extra)
+    track_event('Password Changed', success: success, errors: errors, **extra)
+  end
+
+  # @param [Boolean] success
+  # @param [Hash] errors
+  # The user added a password after verifying their email for account creation
+  def password_creation(success:, errors:, **extra)
+    track_event('Password Creation', success: success, errors: errors, **extra)
+  end
+
+  # The user got their password incorrect the max number of times, their session was terminated
+  def password_max_attempts
+    track_event('Password Max Attempts Reached')
+  end
+
+  # @param [Boolean] success
+  # @param [Hash] errors
+  # @param [Boolean, nil] confirmed if the account the reset is being requested for has a
+  # confirmed email
+  # @param [Boolean, nil] active_profile if the account the reset is being requested for has an
+  # active proofed profile
+  # The user entered an email address to request a password reset
+  def password_reset_email(success:, errors:, confirmed:, active_profile:, **extra)
+    track_event(
+      'Password Reset: Email Submitted',
+      success: success,
+      errors: errors,
+      confirmed: confirmed,
+      active_profile: active_profile,
+      **extra,
+    )
+  end
+
+  # @param [Boolean] success
+  # @param [Hash] errors
+  # @param [Boolean] profile_deactivated if the active profile for the account was deactivated
+  # (the user will need to use their personal key to reactivate their profile)
+  # The user changed the password for their account via the paswword reset flow
+  def password_reset_password(success:, errors:, profile_deactivated:, **extra)
+    track_event(
+      'Password Reset: Password Submitted',
+      success: success,
+      errors: errors,
+      profile_deactivated: profile_deactivated,
+      **extra,
+    )
+  end
+
   # User has visited the page that lets them confirm if they want a new personal key
   def profile_personal_key_visit
     track_event('Profile: Visited new personal key')

spec/controllers/mfa_confirmation_controller_spec.rb

@@ -100,7 +100,7 @@
         expect(controller.current_user).to be_nil
         expect(flash[:error]).to eq t('errors.max_password_attempts_reached')
         expect(@analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_MAX_ATTEMPTS)
+          with('Password Max Attempts Reached')
       end
     end
 

spec/controllers/sign_up/passwords_controller_spec.rb

@@ -21,7 +21,7 @@
           { errors: {}, success: true, user_id: user.uuid },
         )
       expect(@analytics).to receive(:track_event).
-        with(Analytics::PASSWORD_CREATION, analytics_hash)
+        with('Password Creation', analytics_hash)
 
       post :create, params: {
         password_form: { password: 'NewVal!dPassw0rd' },
@@ -85,7 +85,7 @@
         )
 
       expect(@analytics).to receive(:track_event).
-        with(Analytics::PASSWORD_CREATION, analytics_hash)
+        with('Password Creation', analytics_hash)
 
       post :create, params: { password_form: { password: 'NewVal' }, confirmation_token: token }
     end

spec/controllers/users/passwords_controller_spec.rb

@@ -14,7 +14,7 @@
         patch :update, params: { update_user_password_form: params }
 
         expect(@analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_CHANGED, success: true, errors: {})
+          with('Password Changed', success: true, errors: {})
         expect(response).to redirect_to account_url
         expect(flash[:info]).to eq t('notices.password_changed')
         expect(flash[:personal_key]).to be_nil
@@ -73,7 +73,7 @@
         patch :update, params: { update_user_password_form: params }
 
         expect(@analytics).to have_received(:track_event).with(
-          Analytics::PASSWORD_CHANGED,
+          'Password Changed',
           success: false,
           errors: {
             password: [

spec/controllers/users/reset_passwords_controller_spec.rb

@@ -1,9 +1,9 @@
 require 'rails_helper'
 
 describe Users::ResetPasswordsController, devise: true do
-  let(:password_error_message) {
+  let(:password_error_message) do
     "This password is too short (minimum is #{Devise.password_length.first} characters)"
-  }
+  end
   describe '#edit' do
     context 'no user matches token' do
       it 'redirects to page where user enters email for password reset token' do
@@ -114,7 +114,7 @@
         }
 
         expect(@analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_RESET_PASSWORD, analytics_hash)
+          with('Password Reset: Password Submitted', analytics_hash)
 
         expect(response).to redirect_to new_user_password_path
         expect(flash[:error]).to eq t('devise.passwords.token_expired')
@@ -147,7 +147,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with(Analytics::PASSWORD_RESET_PASSWORD, analytics_hash)
+          with('Password Reset: Password Submitted', analytics_hash)
 
         put :update, params: { reset_password_form: form_params }
 
@@ -210,7 +210,7 @@
           }
 
           expect(@analytics).to have_received(:track_event).
-            with(Analytics::PASSWORD_RESET_PASSWORD, analytics_hash)
+            with('Password Reset: Password Submitted', analytics_hash)
 
           expect(user.events.password_changed.size).to be 1
 
@@ -251,7 +251,7 @@
         }
 
         expect(@analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_RESET_PASSWORD, analytics_hash)
+          with('Password Reset: Password Submitted', analytics_hash)
 
         expect(user.active_profile.present?).to eq false
 
@@ -290,7 +290,7 @@
         }
 
         expect(@analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_RESET_PASSWORD, analytics_hash)
+          with('Password Reset: Password Submitted', analytics_hash)
 
         expect(user.reload.confirmed?).to eq true
 
@@ -302,9 +302,7 @@
   describe '#create' do
     context 'no user matches email' do
       it 'send an email to tell the user they do not have an account yet' do
-        analytics = instance_double(Analytics)
-        allow(Analytics).to receive(:new).and_return(analytics)
-        allow(analytics).to receive(:track_event)
+        stub_analytics
         email = 'nonexistent@example.com'
 
         expect do
@@ -321,8 +319,7 @@
           active_profile: false,
         }
 
-        expect(analytics).to have_received(:track_event).
-          with(Analytics::PASSWORD_RESET_EMAIL, analytics_hash)
+        expect(@analytics).to have_logged_event('Password Reset: Email Submitted', analytics_hash)
 
         analytics_hash = {
           success: true,
@@ -332,8 +329,7 @@
           user_id: User.find_with_email(email).uuid,
           domain_name: 'example.com',
         }
-        expect(analytics).to have_received(:track_event).
-          with(Analytics::USER_REGISTRATION_EMAIL, analytics_hash)
+        expect(@analytics).to have_logged_event(Analytics::USER_REGISTRATION_EMAIL, analytics_hash)
 
         expect(response).to redirect_to forgot_password_path
       end
@@ -354,7 +350,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with(Analytics::PASSWORD_RESET_EMAIL, analytics_hash)
+          with('Password Reset: Email Submitted', analytics_hash)
 
         expect do
           put :create, params: { password_reset_email_form: { email: 'Test@example.com' } }
@@ -379,7 +375,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with(Analytics::PASSWORD_RESET_EMAIL, analytics_hash)
+          with('Password Reset: Email Submitted', analytics_hash)
 
         params = { password_reset_email_form: { email: user.email } }
         expect { put :create, params: params }.
@@ -408,7 +404,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with(Analytics::PASSWORD_RESET_EMAIL, analytics_hash)
+          with('Password Reset: Email Submitted', analytics_hash)
 
         params = { password_reset_email_form: { email: user.email } }
         put :create, params: params
@@ -429,7 +425,7 @@
         }
 
         expect(@analytics).to receive(:track_event).
-          with(Analytics::PASSWORD_RESET_EMAIL, analytics_hash)
+          with('Password Reset: Email Submitted', analytics_hash)
 
         params = { password_reset_email_form: { email: 'foo' } }
         expect { put :create, params: params }.