feat(metrics): add "Add 2FA" button clean metrics

2024-07-12 13:40:37 -04:00 · 2024-07-12 13:40:37 -04:00 · 705c8e3ac1
--- a/packages/fxa-settings/src/components/Settings/Security/index.tsx
+++ b/packages/fxa-settings/src/components/Settings/Security/index.tsx
@ -14,6 +14,7 @@ import {
  LocalizedDateOptions,
 } from 'fxa-react/lib/utils';
 import { Link } from '@reach/router';
+import GleanMetrics from '../../../lib/glean';

 const PwdDate = ({ passwordCreated }: { passwordCreated: number }) => {
  const pwdDateText = Intl.DateTimeFormat('default', {
@ -71,6 +72,9 @@ export const Security = forwardRef<HTMLDivElement>((_, ref) => {
                : '/settings/create_password'
            }
            prefixDataTestId="password"
+            ctaOnClickAction={() => {
+              GleanMetrics.accountPref.changePasswordSubmit();
+            }}
          >
            {hasPassword ? (
              <PwdDate {...{ passwordCreated }} />
--- a/packages/fxa-settings/src/components/Settings/UnitRowTwoStepAuth/index.tsx
+++ b/packages/fxa-settings/src/components/Settings/UnitRowTwoStepAuth/index.tsx
@ -12,6 +12,7 @@ import { useAccount, useAlertBar } from '../../../models';
 import { ButtonIconReload } from '../ButtonIcon';
 import { HomePath } from '../../../constants';
 import { Localized, useLocalization } from '@fluent/react';
+import GleanMetrics from '../../../lib/glean';

 const route = `${HomePath}/two_step_authentication`;
 const replaceCodesRoute = `${route}/replace_codes`;
@ -110,6 +111,9 @@ export const UnitRowTwoStepAuth = () => {
          />
        </Localized>
      }
+      ctaOnClickAction={() => {
+        GleanMetrics.accountPref.twoStepAuthSubmit();
+      }}
    >
      <Localized id="tfa-row-content-explain">
        <p className="text-sm mt-3">
--- a/packages/fxa-settings/src/lib/glean/index.test.ts
+++ b/packages/fxa-settings/src/lib/glean/index.test.ts
@ -577,6 +577,30 @@ describe('lib/glean', () => {
        );
        sinon.assert.calledOnce(spy);
      });
+
+      it('submits a ping with the account_pref_two_step_auth_submit event name', async () => {
+        GleanMetrics.accountPref.twoStepAuthSubmit();
+        const spy = sandbox.spy(accountPref.twoStepAuthSubmit, 'record');
+        await GleanMetrics.isDone();
+        sinon.assert.calledOnce(setEventNameStub);
+        sinon.assert.calledWith(
+          setEventNameStub,
+          'account_pref_two_step_auth_submit'
+        );
+        sinon.assert.called(spy);
+      });
+
+      it('submits a ping with the account_pref_change_password_submit event name', async () => {
+        GleanMetrics.accountPref.changePasswordSubmit();
+        const spy = sandbox.spy(accountPref.changePasswordSubmit, 'record');
+        await GleanMetrics.isDone();
+        sinon.assert.calledOnce(setEventNameStub);
+        sinon.assert.calledWith(
+          setEventNameStub,
+          'account_pref_change_password_submit'
+        );
+        sinon.assert.called(spy);
+      });
    });

    describe('deleteAccount', () => {
--- a/packages/fxa-settings/src/lib/glean/index.ts
+++ b/packages/fxa-settings/src/lib/glean/index.ts
@ -376,6 +376,12 @@ const recordEventMetric = (
    case 'delete_account_password_submit':
      deleteAccount.passwordSubmit.record();
      break;
+    case 'account_pref_two_step_auth_submit':
+      accountPref.twoStepAuthSubmit.record();
+      break;
+    case 'account_pref_change_password_submit':
+      accountPref.changePasswordSubmit.record();
+      break;
  }
 };

--- a/packages/fxa-shared/metrics/glean/fxa-ui-metrics.yaml
+++ b/packages/fxa-shared/metrics/glean/fxa-ui-metrics.yaml
@ -1842,6 +1842,40 @@ account_pref:
    expires: never
    data_sensitivity:
      - interaction
+  two_step_auth_submit:
+    type: event
+    description: |
+      Click on "Add" button on account settings page for adding 2FA to account
+    send_in_pings:
+      - events
+    notification_emails:
+      - vzare@mozilla.com
+      - fxa-staff@mozilla.com
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/FXA-10039
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
+    expires: never
+    data_sensitivity:
+      - interaction
+  change_password_submit:
+    type: event
+    description: |
+      Click on "Change" on account settings page to change password for account
+    send_in_pings:
+      - events
+    notification_emails:
+      - vzare@mozilla.com
+      - fxa-staff@mozilla.com
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/FXA-10039
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
+    expires: never
+    data_sensitivity:
+      - interaction
 delete_account:
  settings_submit:
    type: event
--- a/packages/fxa-shared/metrics/glean/web/account.ts
+++ b/packages/fxa-shared/metrics/glean/web/account.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import StringMetricType from '@mozilla/glean/private/metrics/string';

--- a/packages/fxa-shared/metrics/glean/web/accountPref.ts
+++ b/packages/fxa-shared/metrics/glean/web/accountPref.ts
@ -2,10 +2,26 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

+/**
+ * Click on "Change" on account settings page to change password for account
+ *
+ * Generated from `account_pref.change_password_submit`.
+ */
+export const changePasswordSubmit = new EventMetricType(
+  {
+    category: 'account_pref',
+    name: 'change_password_submit',
+    sendInPings: ['events'],
+    lifetime: 'ping',
+    disabled: false,
+  },
+  []
+);
+
 /**
 * Click on "Create" or "Change" button on account settings page to add a recovery
 * key to the account
@ -23,6 +39,22 @@ export const recoveryKeySubmit = new EventMetricType(
  []
 );

+/**
+ * Click on "Add" button on account settings page for adding 2FA to account
+ *
+ * Generated from `account_pref.two_step_auth_submit`.
+ */
+export const twoStepAuthSubmit = new EventMetricType(
+  {
+    category: 'account_pref',
+    name: 'two_step_auth_submit',
+    sendInPings: ['events'],
+    lifetime: 'ping',
+    disabled: false,
+  },
+  []
+);
+
 /**
 * View of the account settings page
 *
--- a/packages/fxa-shared/metrics/glean/web/cachedLogin.ts
+++ b/packages/fxa-shared/metrics/glean/web/cachedLogin.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cad.ts
+++ b/packages/fxa-shared/metrics/glean/web/cad.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cadApproveDevice.ts
+++ b/packages/fxa-shared/metrics/glean/web/cadApproveDevice.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cadFirefox.ts
+++ b/packages/fxa-shared/metrics/glean/web/cadFirefox.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cadMobilePair.ts
+++ b/packages/fxa-shared/metrics/glean/web/cadMobilePair.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cadMobilePairUseApp.ts
+++ b/packages/fxa-shared/metrics/glean/web/cadMobilePairUseApp.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/cadRedirectDesktop.ts
+++ b/packages/fxa-shared/metrics/glean/web/cadRedirectDesktop.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/deleteAccount.ts
+++ b/packages/fxa-shared/metrics/glean/web/deleteAccount.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/email.ts
+++ b/packages/fxa-shared/metrics/glean/web/email.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/event.ts
+++ b/packages/fxa-shared/metrics/glean/web/event.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import StringMetricType from '@mozilla/glean/private/metrics/string';

--- a/packages/fxa-shared/metrics/glean/web/index.ts
+++ b/packages/fxa-shared/metrics/glean/web/index.ts
@ -2,8 +2,6 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-import { recoveryKeySubmit } from './accountPref';
-
 export type GleanMetricsConfig = {
  enabled: boolean;
  applicationId: string;
@ -149,6 +147,8 @@ export const eventsMap = {
  accountPref: {
    view: 'account_pref_view',
    recoveryKeySubmit: 'account_pref_recovery_key_submit',
+    twoStepAuthSubmit: 'account_pref_two_step_auth_submit',
+    changePasswordSubmit: 'account_pref_change_password_submit',
  },

  deleteAccount: {
--- a/packages/fxa-shared/metrics/glean/web/login.ts
+++ b/packages/fxa-shared/metrics/glean/web/login.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/passwordReset.ts
+++ b/packages/fxa-shared/metrics/glean/web/passwordReset.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/pings.ts
+++ b/packages/fxa-shared/metrics/glean/web/pings.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import PingType from '@mozilla/glean/private/ping';

--- a/packages/fxa-shared/metrics/glean/web/reg.ts
+++ b/packages/fxa-shared/metrics/glean/web/reg.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/relyingParty.ts
+++ b/packages/fxa-shared/metrics/glean/web/relyingParty.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import StringMetricType from '@mozilla/glean/private/metrics/string';

--- a/packages/fxa-shared/metrics/glean/web/session.ts
+++ b/packages/fxa-shared/metrics/glean/web/session.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import StringMetricType from '@mozilla/glean/private/metrics/string';

--- a/packages/fxa-shared/metrics/glean/web/standard.ts
+++ b/packages/fxa-shared/metrics/glean/web/standard.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import LabeledMetricType from '@mozilla/glean/private/metrics/labeled';
 import BooleanMetricType from '@mozilla/glean/private/metrics/boolean';
--- a/packages/fxa-shared/metrics/glean/web/sync.ts
+++ b/packages/fxa-shared/metrics/glean/web/sync.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import LabeledMetricType from '@mozilla/glean/private/metrics/labeled';
 import BooleanMetricType from '@mozilla/glean/private/metrics/boolean';
--- a/packages/fxa-shared/metrics/glean/web/thirdPartyAuth.ts
+++ b/packages/fxa-shared/metrics/glean/web/thirdPartyAuth.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/thirdPartyAuthSetPassword.ts
+++ b/packages/fxa-shared/metrics/glean/web/thirdPartyAuthSetPassword.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import EventMetricType from '@mozilla/glean/private/metrics/event';

--- a/packages/fxa-shared/metrics/glean/web/utm.ts
+++ b/packages/fxa-shared/metrics/glean/web/utm.ts
@ -2,7 +2,7 @@
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

-// AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. DO NOT COMMIT.
+// AUTOGENERATED BY glean_parser v14.2.0. DO NOT EDIT. DO NOT COMMIT.

 import StringMetricType from '@mozilla/glean/private/metrics/string';