feat(api): add importUserLastLoggedAt script

Author: P-Jeremy

api/src/identity-access-management/scripts/import-user-last-logged-at.script.js

@@ -0,0 +1,61 @@
+import Joi from 'joi';
+
+import { csvFileParser } from '../../shared/application/scripts/parsers.js';
+import { Script } from '../../shared/application/scripts/script.js';
+import { ScriptRunner } from '../../shared/application/scripts/script-runner.js';
+import { usecases } from '../domain/usecases/index.js';
+
+export const csvSchemas = [
+  { name: 'userId', schema: Joi.number().required() },
+  { name: 'last_activity', schema: Joi.date().required() },
+];
+
+export class ImportUserLastLogeedAtScript extends Script {
+  constructor() {
+    super({
+      description: 'This script allows to update user last logged at',
+      permanent: false,
+      options: {
+        file: {
+          type: 'string',
+          describe: 'CSV file path',
+          demandOption: true,
+          coerce: csvFileParser(csvSchemas),
+        },
+        dryRun: {
+          type: 'boolean',
+          describe: 'Executes the script in dry run mode',
+          default: false,
+        },
+      },
+    });
+  }
+  async handle({ options, logger, importUserLastLoggedAt = usecases.importUserLastLoggedAt }) {
+    const { file, dryRun } = options;
+
+    const total = file.length;
+    logger.info(`${total} users must be processed for last logged date update.`);
+    let count = 0;
+    let updatedCount = 0;
+    let notUpdatedCount = 0;
+
+    for (const row of file) {
+      const { userId, last_activity } = row;
+      count += 1;
+      const result = await importUserLastLoggedAt({ dryRun, userId, lastActivity: last_activity });
+      if (result) {
+        logger.info(`${count}/${total} - user updated`);
+        updatedCount += 1;
+      } else {
+        logger.info(`${count}/${total} - user not updated`);
+        notUpdatedCount += 1;
+      }
+    }
+
+    logger.info(`${count} users processed.`);
+    logger.info(`${updatedCount} users with last logged at updated.`);
+    logger.info(`${notUpdatedCount} users with last logged at NOT updated.`);
+  }
+}
+
+await ScriptRunner.execute(import.meta.url, ImportUserLastLogeedAtScript);

api/tests/identity-access-management/unit/scripts/files/new-update-last-logged-at.csv

@@ -0,0 +1,3 @@
+userId,last_activity
+1234,2017-09-05 14:00:08+0000
+4567,2018-03-02 15:26:16+0000

api/tests/identity-access-management/unit/scripts/import-user-last-logged-at.script.test.js

@@ -0,0 +1,63 @@
+import * as url from 'node:url';
+
+import sinon from 'sinon';
+
+import { ImportUserLastLogeedAtScript } from '../../../../src/identity-access-management/scripts/import-user-last-logged-at.script.js';
+import { expect } from '../../../test-helper.js';
+
+const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
+
+describe('ImportUserLAstLogeedAtScript', function () {
+  describe('Options', function () {
+    it('parses CSV file correctly', async function () {
+      // given
+      const testCsvFile = `${currentDirectory}files/new-update-last-logged-at.csv`;
+      const script = new ImportUserLastLogeedAtScript();
+
+      // when
+      const { options } = script.metaInfo;
+      const fileData = await options.file.coerce(testCsvFile);
+
+      // then
+      expect(fileData).to.deep.equal([
+        { userId: 1234, last_activity: new Date('2017-09-05T14:00:08Z') },
+        { userId: 4567, last_activity: new Date('2018-03-02T15:26:16Z') },
+      ]);
+    });
+  });
+
+  describe('#handle', function () {
+    let script;
+    let importUserLastLoggedAt;
+    let logger;
+
+    beforeEach(function () {
+      script = new ImportUserLastLogeedAtScript();
+      importUserLastLoggedAt = sinon.stub();
+      logger = { info: sinon.stub() };
+    });
+
+    it('runs the script', async function () {
+      // given
+      const file = [
+        { userId: 1234, last_activity: '2017-09-05 14:00:08+0000' },
+        { userId: 4567, last_activity: '2018-03-02 15:26:16+0000' },
+      ];
+
+      // when
+      await script.handle({ options: { file, dryRun: true }, importUserLastLoggedAt, logger });
+
+      // then
+      expect(importUserLastLoggedAt).to.have.been.calledWith({
+        dryRun: true,
+        userId: 1234,
+        lastActivity: '2017-09-05 14:00:08+0000',
+      });
+      expect(importUserLastLoggedAt).to.have.been.calledWith({
+        dryRun: true,
+        userId: 4567,
+        lastActivity: '2018-03-02 15:26:16+0000',
+      });
+    });
+  });
+});