Merge pull request #19873 from mozilla/password-reset-event-reason

feat(settings): add "reason" to password reset event

Author: toufali

packages/fxa-settings/src/lib/glean/index.ts

@@ -353,13 +353,17 @@ const recordEventMetric = (
       passwordReset.createNewRecoveryKeyMessageClick.record();
       break;
     case 'password_reset_create_new_submit':
-      passwordReset.createNewSubmit.record();
+      passwordReset.createNewSubmit.record({
+        reason: gleanPingMetrics?.event?.['reason'] || '',
+      });
       break;
     case 'password_reset_create_new_success_view':
       passwordReset.createNewSuccessView.record();
       break;
     case 'password_reset_create_new_view':
-      passwordReset.createNewView.record();
+      passwordReset.createNewView.record({
+        reason: gleanPingMetrics?.event?.['reason'] || '',
+      });
       break;
     case 'password_reset_email_confirmation_different_account':
       passwordReset.emailConfirmationDifferentAccount.record();

packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/container.tsx

@@ -320,7 +320,8 @@ const CompleteResetPasswordContainer = ({
           );
         }
       } else if (isResetWithoutRecoveryKey) {
-        GleanMetrics.passwordReset.createNewSubmit();
+        const reason = recoveryKeyExists ? 'with key' : 'without key';
+        GleanMetrics.passwordReset.createNewSubmit({ event: { reason } });
         const includeRecoveryKeyPrompt = !!isSyncUser;
         const accountResetData = await resetPasswordWithoutRecoveryKey(
           code,

packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/index.test.tsx

@@ -127,9 +127,9 @@ describe('CompleteResetPassword page', () => {
       );
 
       await waitFor(() =>
-        expect(GleanMetrics.passwordReset.createNewView).toHaveBeenCalledTimes(
-          1
-        )
+        expect(GleanMetrics.passwordReset.createNewView).toHaveBeenCalledWith({
+          event: { reason: 'without key' },
+        })
       );
     });
   });
@@ -214,6 +214,22 @@ describe('CompleteResetPassword page', () => {
         screen.getByRole('link', { name: 'Use account recovery key' })
       ).toBeVisible();
     });
+
+    it('sends the expected metrics on render with "with key" reason', async () => {
+      renderWithLocalizationProvider(
+        <Subject
+          hasConfirmedRecoveryKey={false}
+          recoveryKeyExists={true}
+          estimatedSyncDeviceCount={2}
+        />
+      );
+
+      await waitFor(() =>
+        expect(GleanMetrics.passwordReset.createNewView).toHaveBeenCalledWith({
+          event: { reason: 'with key' },
+        })
+      );
+    });
   });
 
   describe('reset when account has a recovery key but user lost the key and does not have synced devices', () => {

packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/index.tsx

@@ -35,10 +35,13 @@ const CompleteResetPassword = ({
   const location = useLocation();
   const searchParams = location.search;
   useEffect(() => {
-    hasConfirmedRecoveryKey
-      ? GleanMetrics.passwordReset.recoveryKeyCreatePasswordView()
-      : GleanMetrics.passwordReset.createNewView();
-  }, [hasConfirmedRecoveryKey]);
+    if (hasConfirmedRecoveryKey) {
+      GleanMetrics.passwordReset.recoveryKeyCreatePasswordView();
+    } else {
+      const reason = recoveryKeyExists ? 'with key' : 'without key';
+      GleanMetrics.passwordReset.createNewView({ event: { reason } });
+    }
+  }, [hasConfirmedRecoveryKey, recoveryKeyExists]);
 
   const ftlMsgResolver = useFtlMsgResolver();
 

packages/fxa-shared/metrics/glean/fxa-ui-metrics.yaml

@@ -1051,6 +1051,11 @@ password_reset:
     expires: never
     data_sensitivity:
       - interaction
+    extra_keys:
+      reason:
+        description: |
+          Indicates the password reset flow context: "with key" when user has a recovery key but chose the standard reset flow, or "without key" when user doesn't have a recovery key.
+        type: string
   create_new_success_view:
     type: event
     description: |
@@ -1087,6 +1092,11 @@ password_reset:
     expires: never
     data_sensitivity:
       - interaction
+    extra_keys:
+      reason:
+        description: |
+          Indicates the password reset flow context: "with key" when user has a recovery key but chose the standard reset flow, or "without key" when user doesn't have a recovery key.
+        type: string
   email_confirmation_different_account:
     type: event
     description: |

packages/fxa-shared/metrics/glean/web/event.ts

@@ -4,8 +4,8 @@
 
 // AUTOGENERATED BY glean_parser v14.5.2. DO NOT EDIT. DO NOT COMMIT.
 
-import StringMetricType from '@mozilla/glean/private/metrics/string';
 import BooleanMetricType from '@mozilla/glean/private/metrics/boolean';
+import StringMetricType from '@mozilla/glean/private/metrics/string';
 
 /**
  * The name of the framework used by the app (ie React or Backbone).

packages/fxa-shared/metrics/glean/web/passwordReset.ts

@@ -65,15 +65,17 @@ export const createNewRecoveryKeyMessageClick = new EventMetricType(
  *
  * Generated from `password_reset.create_new_submit`.
  */
-export const createNewSubmit = new EventMetricType(
+export const createNewSubmit = new EventMetricType<{
+  reason?: string;
+}>(
   {
     category: 'password_reset',
     name: 'create_new_submit',
     sendInPings: ['events'],
     lifetime: 'ping',
     disabled: false,
   },
-  []
+  ['reason']
 );
 
 /**
@@ -99,15 +101,17 @@ export const createNewSuccessView = new EventMetricType(
  *
  * Generated from `password_reset.create_new_view`.
  */
-export const createNewView = new EventMetricType(
+export const createNewView = new EventMetricType<{
+  reason?: string;
+}>(
   {
     category: 'password_reset',
     name: 'create_new_view',
     sendInPings: ['events'],
     lifetime: 'ping',
     disabled: false,
   },
-  []
+  ['reason']
 );
 
 /**