Merge pull request #18413 from mozilla/FXA-11071-schedule-inactive-delete

feat(inactive account): schedule deletion after third email

Author: chenba

libs/shared/cloud-tasks/src/lib/delete-account-tasks.spec.ts

@@ -6,6 +6,9 @@ import { DeleteAccountTasks } from './delete-account-tasks';
 import { DeleteAccountTasksFactory } from './account-tasks.factories';
 import { ReasonForDeletion } from './account-tasks.types';
 
+const now = 1736500000000;
+jest.useFakeTimers({ now });
+
 describe('account-tasks', () => {
   const mockStatsd = {
     increment: jest.fn(),
@@ -72,8 +75,6 @@ describe('account-tasks', () => {
               queueName: 'delete-account',
             },
           },
-          publicUrl: 'http://localhost:9000',
-          apiVersion: '1',
         },
         mockCloudClient,
         mockStatsd
@@ -90,7 +91,8 @@ describe('account-tasks', () => {
       });
 
       const taskName = await deleteAccountCloudTask.deleteAccount(
-        mockDeleteTaskPayload
+        mockDeleteTaskPayload,
+        { taskId: 'wibble', scheduleTime: { seconds: Date.now() / 1000 } }
       );
       expect(taskName).toEqual('task123');
       expect(mockStatsd.increment).toBeCalledWith(
@@ -112,6 +114,10 @@ describe('account-tasks', () => {
                 mockConfig.cloudTasks.oidc.serviceAccountEmail,
             },
           },
+          name: 'projects/pid123/locations/lid123/queues/delete-account/tasks/wibble',
+          scheduleTime: {
+            seconds: 1736500000,
+          },
         },
       });
     });

libs/shared/cloud-tasks/src/lib/delete-account-tasks.ts

@@ -9,6 +9,7 @@ import {
   DeleteAccountCloudTaskConfig,
   DeleteAccountTask,
 } from './account-tasks.types';
+import { CloudTaskOptions } from './cloud-tasks.types';
 
 /** Responsible for account deletion tasks */
 export class DeleteAccountTasks extends CloudTasks {
@@ -25,13 +26,19 @@ export class DeleteAccountTasks extends CloudTasks {
    * @param deleteTask The info necessary to queue an account deletion.
    * @returns A taskName
    */
-  public async deleteAccount(deleteTask: DeleteAccountTask) {
+  public async deleteAccount(
+    deleteTask: DeleteAccountTask,
+    cloudTaskOptions?: CloudTaskOptions
+  ) {
     try {
-      const result = await this.enqueueTask({
-        queueName: this.config.cloudTasks.deleteAccounts.queueName,
-        taskUrl: this.config.cloudTasks.deleteAccounts.taskUrl,
-        taskPayload: deleteTask,
-      });
+      const result = await this.enqueueTask(
+        {
+          queueName: this.config.cloudTasks.deleteAccounts.queueName,
+          taskUrl: this.config.cloudTasks.deleteAccounts.taskUrl,
+          taskPayload: deleteTask,
+        },
+        cloudTaskOptions
+      );
       const taskName = result[0].name;
 
       this.statsd.increment('cloud-tasks.account-delete.enqueue.success');

packages/fxa-auth-server/lib/inactive-accounts/index.ts

@@ -287,6 +287,33 @@ export class InactiveAccountsManager {
     );
 
     await this.scheduleNextEmail(taskPayload);
+
+    if (
+      taskPayload.emailType === EmailTypes.INACTIVE_DELETE_FINAL_NOTIFICATION
+    ) {
+      await this.accountTasks.deleteAccount(
+        {
+          uid: taskPayload.uid,
+          customerId: (
+            await getAccountCustomerByUid(taskPayload.uid)
+          )?.stripeCustomerId,
+          reason: ReasonForDeletion.InactiveAccountScheduled,
+        },
+        {
+          taskId: `${taskPayload.uid}-inactive-account-delete`,
+          scheduleTime: {
+            seconds: (now + aDayInMs) / 1000,
+          },
+        }
+      );
+      await this.glean.inactiveAccountDeletion.deletionScheduled(
+        requestForGlean,
+        {
+          uid: taskPayload.uid,
+        }
+      );
+      this.statsd.increment('account.inactive.deletion.scheduled');
+    }
   }
 
   async scheduleNextEmail(taskReqPayload: SendEmailTaskPayload) {

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

@@ -370,6 +370,9 @@ export function gleanMetrics(config: ConfigType) {
       finalEmailSkipped: createEventFn(
         'inactive_account_deletion_final_email_skipped'
       ),
+      deletionScheduled: createEventFn(
+        'inactive_account_deletion_deletion_scheduled'
+      ),
     },
     twoStepAuthPhoneRemove: {
       success: createEventFn('two_step_auth_phone_remove_success'),

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

@@ -638,6 +638,88 @@ class EventsServerEventLogger {
       event,
     });
   }
+  /**
+   * Record and submit a inactive_account_deletion_deletion_scheduled event:
+   * The cloud task to delete the account was scheduled.
+   * 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..
+   */
+  recordInactiveAccountDeletionDeletionScheduled({
+    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,
+  }: {
+    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;
+  }) {
+    const event = {
+      category: 'inactive_account_deletion',
+      name: 'deletion_scheduled',
+    };
+    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 inactive_account_deletion_final_email_skipped event:
    * The final email notification was skipped.

packages/fxa-auth-server/test/local/inactive-accounts/index.js

@@ -40,6 +40,8 @@ const mockGlean = {
     finalEmailTaskEnqueued: sandbox.stub(),
     finalEmailTaskRejected: sandbox.stub(),
     finalEmailTaskRequest: sandbox.stub(),
+
+    deletionScheduled: sandbox.stub(),
   },
 };
 const mockLog = mocks.mockLog(sandbox);
@@ -483,7 +485,7 @@ describe('InactiveAccountsManager', () => {
       sandbox.assert.calledOnce(inactiveAccountManager.scheduleNextEmail);
     });
 
-    it('should send the final email', async () => {
+    it('should send the final email and schedule deletion', async () => {
       sandbox.stub(accountEventsManager, 'findEmailEvents').resolves([]);
       sandbox.stub(inactiveAccountManager, 'isActive').resolves(false);
 
@@ -502,6 +504,28 @@ describe('InactiveAccountsManager', () => {
       );
       // No email cloud task should be run. There are no more emails to schedule.
       sandbox.assert.notCalled(mockEmailTasks.scheduleFinalEmail);
+
+      sandbox.assert.calledOnceWithExactly(
+        mockDeleteAccountTasks.deleteAccount,
+        {
+          uid: mockPayload.uid,
+          customerId: undefined,
+          reason: ReasonForDeletion.InactiveAccountScheduled,
+        },
+        {
+          taskId: `${mockPayload.uid}-inactive-account-delete`,
+          scheduleTime: {
+            seconds: (Date.now() + aDayInMs) / 1000,
+          },
+        }
+      );
+      sandbox.assert.calledOnce(
+        mockGlean.inactiveAccountDeletion.deletionScheduled
+      );
+      sandbox.assert.calledWithExactly(
+        mockStatsd.increment,
+        'account.inactive.deletion.scheduled'
+      );
     });
   });
 });

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

@@ -63,10 +63,12 @@ const recordInactiveAccountDeletionFinalEmailTaskRequestStub = sinon.stub();
 const recordInactiveAccountDeletionFinalEmailTaskEnqueuedStub = sinon.stub();
 const recordInactiveAccountDeletionFinalEmailTaskRejectedStub = sinon.stub();
 const recordInactiveAccountDeletionFinalEmailSkippedStub = sinon.stub();
+const recordInactiveAccountDeletionDeletionScheduleStub = sinon.stub();
 
 const gleanProxy = proxyquire('../../../lib/metrics/glean', {
   './server_events': {
     createAccountsEventsEvent: () => ({ record: recordStub }),
+    // this is out of hand!  we need to switch to use sinon.mock or some such thing
     createEventsServerEventLogger: () => ({
       recordRegAccCreated: recordRegAccCreatedStub,
       recordRegEmailSent: recordRegEmailSentStub,
@@ -148,6 +150,8 @@ const gleanProxy = proxyquire('../../../lib/metrics/glean', {
         recordInactiveAccountDeletionFinalEmailTaskRejectedStub,
       recordInactiveAccountDeletionFinalEmailSkipped:
         recordInactiveAccountDeletionFinalEmailSkippedStub,
+      recordInactiveAccountDeletionDeletionScheduled:
+        recordInactiveAccountDeletionDeletionScheduleStub,
     }),
   },
 });

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

@@ -1303,6 +1303,23 @@ inactive_account_deletion:
         description: |
           The reason the email was skipped.
         type: string
+  deletion_scheduled:
+    type: event
+    description: |
+      The cloud task to delete the account was scheduled.
+    lifetime: ping
+    send_in_pings:
+      - events
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/FXA-11071
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
+    expires: never
+    data_sensitivity:
+      - technical
 
 two_step_auth_phone_remove:
   success: