Merge pull request #18439 from mozilla/FXA-10497-acct-delete-metrics

feat(metrics): add more metrics around account deletion

Author: chenba

packages/fxa-auth-server/lib/account-delete.ts

@@ -129,31 +129,46 @@ export class AccountDeleteManager {
   public async deleteAccount(
     uid: string,
     reason: ReasonForDeletion,
-    customerId?: string
+    customerId?: string,
+    request?: AuthRequest
   ) {
     // there's a day's time between shceduling and deletion so we need to check
     // if the account has became active in the meantime
     if (
       reason === ReasonForDeletion.InactiveAccountScheduled &&
       (await this.inactiveAccountsManager.isActive(uid))
     ) {
-      this.glean.inactiveAccountDeletion.deletionSkipped(requestForGlean, {
-        uid,
-        reason: 'active_account',
-      });
+      this.glean.inactiveAccountDeletion.deletionSkipped(
+        request ?? requestForGlean,
+        {
+          uid,
+          reason: 'active_account',
+        }
+      );
       this.statsd.increment('account.inactive.deletion.skipped.active');
       return;
     }
 
     await this.deleteAccountFromDb(uid);
     await this.deleteOAuthTokens(uid);
+
+    // data eng rely on this to delete the account data from BQ.
+    // user self-deletes are logged when the client request was handled
+    if (reason !== ReasonForDeletion.UserRequested) {
+      this.log.info('accountDeleted.byCloudTask', { uid });
+    }
+
     // see comment in the function on why we are not awaiting
     this.deletePushboxRecords(uid);
 
     await this.deleteSubscriptions(uid, reason, customerId);
     await this.deleteFirestoreCustomer(uid);
     await this.appleIap?.purchaseManager.deletePurchases(uid);
     await this.playBilling?.purchaseManager.deletePurchases(uid);
+    this.statsd.increment('account.destroy.success', { reason });
+    this.glean.account.deleteTaskHandled(request ?? requestForGlean, {
+      reason,
+    });
   }
 
   /**
@@ -171,6 +186,7 @@ export class AccountDeleteManager {
     try {
       await this.deleteAccountFromDb(uid);
       await this.deleteOAuthTokens(uid);
+      this.statsd.increment('account.destroy.quick-delete');
     } catch (error) {
       // If the account wasn't fully deleted, we should log the error and
       // still queue the account for cleanup.

packages/fxa-auth-server/lib/metrics/glean/index.ts

@@ -298,6 +298,9 @@ export function gleanMetrics(config: ConfigType) {
 
     account: {
       deleteComplete: createEventFn('account_delete_complete'),
+      deleteTaskHandled: createEventFn('account_delete_task_handled', {
+        additionalMetrics: extraKeyReasonCb,
+      }),
     },
     twoFactorAuth: {
       codeComplete: createEventFn('two_factor_auth_code_complete'),

packages/fxa-auth-server/lib/metrics/glean/server_events.ts

@@ -556,6 +556,94 @@ class EventsServerEventLogger {
       event,
     });
   }
+  /**
+   * Record and submit a account_delete_task_handled event:
+   * An account was deleted from FxA.
+   * Event is logged using internal mozlog logger.
+   *
+   * @param {string} user_agent - The user agent.
+   * @param {string} ip_address - The IP address. Will be used to decode Geo
+   *                              information and scrubbed at ingestion.
+   * @param {string} account_user_id - The firefox/mozilla account id.
+   * @param {string} account_user_id_sha256 - A hex string of a sha256 hash of the account's uid.
+   * @param {string} relying_party_oauth_client_id - The client id of the relying party.
+   * @param {string} relying_party_service - The service name of the relying party.
+   * @param {string} session_device_type - one of 'mobile', 'tablet', or ''.
+   * @param {string} session_entrypoint - Entrypoint to the service.
+   * @param {string} session_entrypoint_experiment - Identifier for the experiment the user is part of at the entrypoint.
+   * @param {string} session_entrypoint_variation - Identifier for the experiment variation the user is part of at the entrypoint.
+   * @param {string} session_flow_id - an ID generated by FxA for its flow metrics.
+   * @param {string} utm_campaign - A marketing campaign.  For example, if a user signs into FxA from selecting a Mozilla VPN plan on Mozilla VPN's product site, then the value of this metric could be 'vpn-product-page'.  The value has a max length of 128 characters with the alphanumeric characters, _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen) in the allowed set of characters.  The special value of 'page+referral+-+not+part+of+a+campaign' is also allowed..
+   * @param {string} utm_content - The content on which the user acted.  For example, if the user clicked on the (previously available) "Get started here" link in "Looking for Firefox Sync? Get started here", then the value for this metric would be 'fx-sync-get-started'. The value has a max length of 128 characters with the alphanumeric characters, _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen) in the allowed set of characters..
+   * @param {string} utm_medium - The "medium" on which the user acted.  For example, if the user clicked on a link in an email, then the value of this metric would be 'email'.  The value has a max length of 128 characters with the alphanumeric characters, _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen) in the allowed set of characters..
+   * @param {string} utm_source - The source from where the user started.  For example, if the user clicked on a link on the Mozilla accounts web site, this value could be 'fx-website'.  The value has a max length of 128 characters with the alphanumeric characters, _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen) in the allowed set of characters..
+   * @param {string} utm_term - This metric is similar to the `utm.source`; it is used in the Firefox browser.  For example, if the user started from about:welcome, then the value could be 'aboutwelcome-default-screen'.  The value has a max length of 128 characters with the alphanumeric characters, _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen) in the allowed set of characters..
+   * @param {string} reason - The reason for the deletion..
+   */
+  recordAccountDeleteTaskHandled({
+    user_agent,
+    ip_address,
+    account_user_id,
+    account_user_id_sha256,
+    relying_party_oauth_client_id,
+    relying_party_service,
+    session_device_type,
+    session_entrypoint,
+    session_entrypoint_experiment,
+    session_entrypoint_variation,
+    session_flow_id,
+    utm_campaign,
+    utm_content,
+    utm_medium,
+    utm_source,
+    utm_term,
+    reason,
+  }: {
+    user_agent: string;
+    ip_address: string;
+    account_user_id: string;
+    account_user_id_sha256: string;
+    relying_party_oauth_client_id: string;
+    relying_party_service: string;
+    session_device_type: string;
+    session_entrypoint: string;
+    session_entrypoint_experiment: string;
+    session_entrypoint_variation: string;
+    session_flow_id: string;
+    utm_campaign: string;
+    utm_content: string;
+    utm_medium: string;
+    utm_source: string;
+    utm_term: string;
+    reason: string;
+  }) {
+    const event = {
+      category: 'account',
+      name: 'delete_task_handled',
+      extra: {
+        reason: String(reason),
+      },
+    };
+    this.#record({
+      user_agent,
+      ip_address,
+      account_user_id,
+      account_user_id_sha256,
+      relying_party_oauth_client_id,
+      relying_party_service,
+      session_device_type,
+      session_entrypoint,
+      session_entrypoint_experiment,
+      session_entrypoint_variation,
+      session_flow_id,
+      utm_campaign,
+      utm_content,
+      utm_medium,
+      utm_source,
+      utm_term,
+      event,
+    });
+  }
   /**
    * Record and submit a account_password_reset event:
    * Forgot Password Complete Successful completion of the forgot password funnel.

packages/fxa-auth-server/lib/routes/account.ts

@@ -1906,6 +1906,9 @@ export class AccountHandler {
       ReasonForDeletion.UserRequested
     );
 
+    // data eng rely on this to delete the account data from BQ
+    this.log.info('accountDeleted.ByRequest', { uid: accountRecord.uid });
+
     const result = await getAccountCustomerByUid(accountRecord.uid);
     await this.accountTasks.deleteAccount({
       uid: accountRecord.uid,

packages/fxa-auth-server/lib/routes/cloud-tasks.ts

@@ -27,12 +27,13 @@ export class CloudTaskHandler {
     this.emailCloudTaskManager = Container.get(EmailCloudTaskManager);
   }
 
-  async deleteAccount(taskPayload: DeleteAccountTask) {
+  async deleteAccount(taskPayload: DeleteAccountTask, request?: AuthRequest) {
     this.log.debug('Received delete account task', taskPayload);
     await this.accountDeleteManager.deleteAccount(
       taskPayload.uid,
       taskPayload.reason,
-      taskPayload.customerId
+      taskPayload.customerId,
+      request
     );
     return {};
   }
@@ -81,7 +82,10 @@ export const cloudTaskRoutes = (
         },
       },
       handler: (request: AuthRequest) =>
-        cloudTaskHandler.deleteAccount(request.payload as DeleteAccountTask),
+        cloudTaskHandler.deleteAccount(
+          request.payload as DeleteAccountTask,
+          request
+        ),
     },
 
     {

packages/fxa-auth-server/test/local/account-delete.js

@@ -281,6 +281,11 @@ describe('AccountDeleteManager', function () {
         sinon.assert.calledWithMatch(mockFxaDb.deleteAccount, {
           uid,
         });
+        sinon.assert.calledOnceWithExactly(
+          mockLog.info,
+          'accountDeleted.byCloudTask',
+          { uid }
+        );
       });
     });
   });

packages/fxa-auth-server/test/local/metrics/glean.ts

@@ -39,6 +39,7 @@ const recordThirdPartyAuthGoogleRegCompleteStub = sinon.stub();
 const recordThirdPartyAuthAppleRegCompleteStub = sinon.stub();
 const recordThirdPartyAuthSetPasswordCompleteStub = sinon.stub();
 const recordAccountDeleteCompleteStub = sinon.stub();
+const recordAccountDeleteTaskHandledStub = sinon.stub();
 const recordPasswordResetEmailConfirmationSentStub = sinon.stub();
 const recordPasswordResetEmailConfirmationSuccessStub = sinon.stub();
 const recordTwoFactorAuthCodeCompleteStub = sinon.stub();
@@ -106,6 +107,7 @@ const gleanProxy = proxyquire('../../../lib/metrics/glean', {
       recordThirdPartyAuthSetPasswordComplete:
         recordThirdPartyAuthSetPasswordCompleteStub,
       recordAccountDeleteComplete: recordAccountDeleteCompleteStub,
+      recordAccountDeleteTaskHandled: recordAccountDeleteTaskHandledStub,
       recordPasswordResetEmailConfirmationSent:
         recordPasswordResetEmailConfirmationSentStub,
       recordPasswordResetEmailConfirmationSuccess:

packages/fxa-auth-server/test/local/routes/account.js

@@ -3892,6 +3892,11 @@ describe('/account/destroy', () => {
       assert.calledOnceWithExactly(glean.account.deleteComplete, mockRequest, {
         uid,
       });
+      sinon.assert.calledOnceWithExactly(
+        mockLog.info,
+        'accountDeleted.ByRequest',
+        { uid }
+      );
     });
   });
 

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

@@ -114,6 +114,29 @@ account:
     expires: never
     data_sensitivity:
       - interaction
+  delete_task_handled:
+    type: event
+    description: |
+      An account was deleted from FxA.
+    lifetime: ping
+    send_in_pings:
+      - events
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/FXA-10497
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
+    expires: never
+    data_sensitivity:
+      - technical
+    extra_keys:
+      reason:
+        description: |
+          The reason for the deletion.
+        type: string
+
 
 relying_party:
   service: