Merge pull request #18352 from mozilla/FXA-10478

feat(auth): cleanup old carts script

Author: julianpoy

packages/fxa-auth-server/lib/payments/processing-tasks-setup.ts

@@ -88,5 +88,6 @@ export async function setupProcessingTaskObjects(processName: string) {
     database,
     senders,
     stripeHelper,
+    config,
   };
 }

packages/fxa-auth-server/scripts/cleanup-old-carts.ts

@@ -0,0 +1,100 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 program from 'commander';
+
+import { setupProcessingTaskObjects } from '../lib/payments/processing-tasks-setup';
+import { CartCleanup } from './cleanup-old-carts/cleanup-old-carts';
+import { setupAccountDatabase } from '@fxa/shared/db/mysql/account';
+
+const pckg = require('../package.json');
+
+const anonymizeableFields = new Set(['email', 'taxAddress'] as const);
+
+const parseDeleteBefore = (deleteBefore: string | number) => {
+  const date = new Date(deleteBefore);
+  if (!date.getTime()) {
+    throw new Error('deleteBefore is invalid');
+  }
+  return date;
+};
+
+const parseAnonymizeBefore = (anonymizeBefore: string | number) => {
+  if (!anonymizeBefore) {
+    return null;
+  }
+  const date = new Date(anonymizeBefore);
+  if (!date.getTime()) {
+    throw new Error('anonymizeBefore is invalid');
+  }
+  return date;
+};
+
+const parseAnonymizeFields = (
+  anonymizeFields: string
+): typeof anonymizeableFields | null => {
+  if (!anonymizeFields) {
+    return null;
+  }
+  const fields = new Set(anonymizeFields.split(','));
+  for (const field of fields) {
+    if (!(anonymizeableFields as Set<string>).has(field)) {
+      throw new Error(`Invalid anonymized field name: ${field}`);
+    }
+  }
+  return fields as typeof anonymizeableFields;
+};
+
+async function init() {
+  program
+    .version(pckg.version)
+    .option(
+      '-d, --delete-before [string]',
+      'An ISO 8601 date string.  All carts last updated before this date will be deleted.'
+    )
+    .option(
+      '-a, --anonymize-before [string]',
+      'An ISO 8601 date string.  All carts last updated before this date will be anonymized.'
+    )
+    .option(
+      '-f, --anonymize-fields [string]',
+      `A comma separated list of fields. Can be any of: ${[
+        ...anonymizeableFields,
+      ].join(', ')}`
+    )
+    .parse(process.argv);
+
+  const { config } = await setupProcessingTaskObjects('cleanup-old-carts');
+
+  const database = await setupAccountDatabase(config.database.mysql.auth);
+
+  const deleteBefore = parseDeleteBefore(program.deleteBefore);
+  const anonymizeBefore = parseAnonymizeBefore(program.anonymizeBefore);
+  const anonymizeFields = parseAnonymizeFields(program.anonymizeFields);
+
+  if (anonymizeBefore && !anonymizeFields) {
+    throw new Error(
+      'Anonymize fields must be provided if anonymize before is used'
+    );
+  }
+
+  const cartCleanup = new CartCleanup(
+    deleteBefore,
+    anonymizeBefore,
+    anonymizeFields,
+    database
+  );
+
+  await cartCleanup.run();
+
+  return 0;
+}
+
+if (require.main === module) {
+  init()
+    .catch((err) => {
+      console.error(err);
+      process.exit(1);
+    })
+    .then((result) => process.exit(result));
+}

packages/fxa-auth-server/scripts/cleanup-old-carts/cleanup-old-carts.ts

@@ -0,0 +1,36 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { AccountDatabase } from '@fxa/shared/db/mysql/account';
+
+export class CartCleanup {
+  constructor(
+    private deleteBefore: Date,
+    private anonymizeBefore: Date | null,
+    private anonymizeFields: Set<'email' | 'taxAddress'> | null,
+    private database: AccountDatabase
+  ) {}
+
+  async run(): Promise<void> {
+    await this.database
+      .deleteFrom('carts')
+      .where('updatedAt', '<', this.deleteBefore.getTime())
+      .execute();
+
+    if (this.anonymizeBefore && this.anonymizeFields?.size) {
+      let anonymizePendingQuery = this.database
+        .updateTable('carts')
+        .where('updatedAt', '<', this.anonymizeBefore.getTime());
+
+      if (this.anonymizeFields.has('email')) {
+        anonymizePendingQuery = anonymizePendingQuery.set('email', null);
+      }
+      if (this.anonymizeFields.has('taxAddress')) {
+        anonymizePendingQuery = anonymizePendingQuery.set('taxAddress', null);
+      }
+
+      await anonymizePendingQuery.execute();
+    }
+  }
+}

packages/fxa-auth-server/test/scripts/cleanup-old-carts.ts

@@ -0,0 +1,91 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 sinon from 'sinon';
+import { expect } from 'chai';
+import { CartCleanup } from '../../scripts/cleanup-old-carts/cleanup-old-carts';
+import Sinon from 'sinon';
+
+describe('CartCleanup', () => {
+  let cartCleanup: CartCleanup;
+  let dbStub: {
+    deleteFrom: Sinon.SinonSpy;
+    where: Sinon.SinonSpy;
+    execute: Sinon.SinonSpy;
+    updateTable: Sinon.SinonSpy;
+    set: Sinon.SinonSpy;
+  };
+
+  const deleteBefore = new Date('2024-01-01T00:00:00Z');
+  const anonymizeBefore = new Date('2023-06-01T00:00:00Z');
+  const anonymizeFields = new Set(['email', 'taxAddress'] as const);
+
+  beforeEach(() => {
+    dbStub = {
+      deleteFrom: sinon.stub().returnsThis(),
+      where: sinon.stub().returnsThis(),
+      execute: sinon.stub().resolves(),
+      updateTable: sinon.stub().returnsThis(),
+      set: sinon.stub().returnsThis(),
+    };
+
+    cartCleanup = new CartCleanup(
+      deleteBefore,
+      anonymizeBefore,
+      anonymizeFields,
+      dbStub
+    );
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  describe('run', () => {
+    it('deletes old carts', async () => {
+      await cartCleanup.run();
+
+      expect(dbStub.deleteFrom.calledWith('carts')).to.be.true;
+      expect(dbStub.where.calledWith('updatedAt', '<', deleteBefore.getTime()))
+        .to.be.true;
+      expect(dbStub.execute.called).to.be.true;
+    });
+
+    it('anonymizes fields within carts', async () => {
+      await cartCleanup.run();
+
+      expect(dbStub.updateTable.calledWith('carts')).to.be.true;
+      expect(
+        dbStub.where.calledWith('updatedAt', '<', anonymizeBefore.getTime())
+      ).to.be.true;
+      expect(dbStub.set.calledWith('email', null)).to.be.true;
+      expect(dbStub.set.calledWith('taxAddress', null)).to.be.true;
+      expect(dbStub.execute.calledTwice).to.be.true;
+    });
+
+    it('does not anonymize if no fields are provided', async () => {
+      cartCleanup = new CartCleanup(
+        deleteBefore,
+        anonymizeBefore,
+        new Set(),
+        dbStub
+      );
+      await cartCleanup.run();
+
+      expect(dbStub.updateTable.called).to.be.false;
+    });
+
+    it('does not anonymize if anonymizeBefore is null', async () => {
+      cartCleanup = new CartCleanup(
+        deleteBefore,
+        null,
+        anonymizeFields,
+        dbStub
+      );
+      await cartCleanup.run();
+
+      expect(dbStub.updateTable.called).to.be.false;
+    });
+  });
+});