[FEATURE] Sauvegarder les événements PASSAGE_TERMINATED(PIX-16811) (#11559)

dianeCdrPix · web-flow · commit ad8ee930c717 · 2025-03-05T16:03:21.000+01:00
diff --git a/api/src/devcomp/application/passages/controller.js b/api/src/devcomp/application/passages/controller.js
@@ -1,3 +1,5 @@
+import { requestResponseUtils } from '../../../shared/infrastructure/utils/request-response-utils.js';
+
 const create = async function (request, h, { usecases, passageSerializer, extractUserIdFromRequest }) {
   const { 'module-id': moduleId } = request.payload.data.attributes;
   const userId = extractUserIdFromRequest(request);
@@ -17,7 +19,8 @@ const verifyAndSaveAnswer = async function (request, h, { usecases, elementAnswe
 
 const terminate = async function (request, h, { usecases, passageSerializer }) {
   const { passageId } = request.params;
-  const updatedPassage = await usecases.terminatePassage({ passageId });
+  const requestTimestamp = requestResponseUtils.extractTimestampFromRequest(request);
+  const updatedPassage = await usecases.terminatePassage({ passageId, occurredAt: new Date(requestTimestamp) });
   return passageSerializer.serialize(updatedPassage);
 };
 
diff --git a/api/src/devcomp/domain/usecases/terminate-passage.js b/api/src/devcomp/domain/usecases/terminate-passage.js
@@ -1,14 +1,24 @@
+import { withTransaction } from '../../../shared/domain/DomainTransaction.js';
 import { NotFoundError } from '../../../shared/domain/errors.js';
 import { PassageDoesNotExistError, PassageTerminatedError } from '../errors.js';
+import { PassageTerminatedEvent } from '../models/passage-events/passage-events.js';
 
-async function terminatePassage({ passageId, passageRepository }) {
+const terminatePassage = withTransaction(async function ({
+  passageId,
+  occurredAt,
+  passageRepository,
+  passageEventRepository,
+}) {
   const passage = await _getPassage({ passageId, passageRepository });
   if (passage.terminatedAt) {
     throw new PassageTerminatedError();
   }
   passage.terminate();
-  return passageRepository.update({ passage });
-}
+  const terminatedPassage = await passageRepository.update({ passage });
+  const event = new PassageTerminatedEvent({ passageId, occurredAt });
+  await passageEventRepository.record(event);
+  return terminatedPassage;
+});
 
 async function _getPassage({ passageId, passageRepository }) {
   try {
diff --git a/api/src/devcomp/infrastructure/repositories/index.js b/api/src/devcomp/infrastructure/repositories/index.js
@@ -3,6 +3,7 @@ import moduleDatasource from '../datasources/learning-content/module-datasource.
 import * as elementAnswerRepository from './element-answer-repository.js';
 import * as elementRepository from './element-repository.js';
 import * as moduleRepository from './module-repository.js';
+import * as passageEventRepository from './passage-event-repository.js';
 import * as passageRepository from './passage-repository.js';
 import * as trainingRepository from './training-repository.js';
 import * as trainingTriggerRepository from './training-trigger-repository.js';
@@ -15,6 +16,7 @@ const repositoriesWithoutInjectedDependencies = {
   elementAnswerRepository,
   elementRepository,
   moduleRepository,
+  passageEventRepository,
   passageRepository,
   trainingRepository,
   trainingTriggerRepository,
diff --git a/api/src/shared/infrastructure/utils/request-response-utils.js b/api/src/shared/infrastructure/utils/request-response-utils.js
@@ -6,9 +6,12 @@ import { tokenService } from '../../../shared/domain/services/token-service.js';
 
 const { ENGLISH_SPOKEN, FRENCH_FRANCE, FRENCH_SPOKEN } = LOCALE;
 const { DUTCH, SPANISH } = LANGUAGES_CODE;
-const requestResponseUtils = { escapeFileName, extractUserIdFromRequest, extractLocaleFromRequest };
-
-export { escapeFileName, extractLocaleFromRequest, extractUserIdFromRequest, requestResponseUtils };
+const requestResponseUtils = {
+  escapeFileName,
+  extractUserIdFromRequest,
+  extractLocaleFromRequest,
+  extractTimestampFromRequest,
+};
 
 function escapeFileName(fileName) {
   return fileName
@@ -37,3 +40,15 @@ function extractLocaleFromRequest(request) {
   const acceptedLanguages = [ENGLISH_SPOKEN, FRENCH_SPOKEN, FRENCH_FRANCE, DUTCH, SPANISH];
   return accept.language(languageHeader, acceptedLanguages) || defaultLocale;
 }
+
+function extractTimestampFromRequest(request) {
+  return request.headers?.['X-Request-Start'] ?? new Date().getTime();
+}
+
+export {
+  escapeFileName,
+  extractLocaleFromRequest,
+  extractTimestampFromRequest,
+  extractUserIdFromRequest,
+  requestResponseUtils,
+};
diff --git a/api/tests/devcomp/unit/application/passages/controller_test.js b/api/tests/devcomp/unit/application/passages/controller_test.js
@@ -1,4 +1,5 @@
 import { passageController } from '../../../../../src/devcomp/application/passages/controller.js';
+import { requestResponseUtils } from '../../../../../src/shared/infrastructure/utils/request-response-utils.js';
 import { expect, sinon } from '../../../../test-helper.js';
 
 describe('Unit | Devcomp | Application | Passages | Controller', function () {
@@ -90,13 +91,17 @@ describe('Unit | Devcomp | Application | Passages | Controller', function () {
   describe('#terminate', function () {
     it('should call terminate use-case and return serialized passage', async function () {
       // given
+      const requestTimestamp = new Date('2025-01-01').getTime();
       const serializedPassage = Symbol('serialized modules');
       const passageId = Symbol('passage-id');
       const passage = Symbol('passage');
+      const extractTimestampStub = sinon
+        .stub(requestResponseUtils, 'extractTimestampFromRequest')
+        .returns(requestTimestamp);
       const usecases = {
         terminatePassage: sinon.stub(),
       };
-      usecases.terminatePassage.withArgs({ passageId }).returns(passage);
+      usecases.terminatePassage.withArgs({ passageId, occurredAt: new Date(requestTimestamp) }).returns(passage);
       const passageSerializer = {
         serialize: sinon.stub(),
       };
@@ -110,6 +115,7 @@ describe('Unit | Devcomp | Application | Passages | Controller', function () {
 
       // then
       expect(returned).to.deep.equal(serializedPassage);
+      expect(extractTimestampStub).to.have.been.calledOnce;
     });
   });
 });
diff --git a/api/tests/devcomp/unit/domain/usecases/terminate-passage_test.js b/api/tests/devcomp/unit/domain/usecases/terminate-passage_test.js
@@ -1,9 +1,15 @@
 import { PassageDoesNotExistError, PassageTerminatedError } from '../../../../../src/devcomp/domain/errors.js';
+import { PassageTerminatedEvent } from '../../../../../src/devcomp/domain/models/passage-events/passage-events.js';
 import { terminatePassage } from '../../../../../src/devcomp/domain/usecases/terminate-passage.js';
+import { DomainTransaction } from '../../../../../src/shared/domain/DomainTransaction.js';
 import { NotFoundError } from '../../../../../src/shared/domain/errors.js';
 import { catchErr, expect, sinon } from '../../../../test-helper.js';
 
 describe('Unit | Devcomp | Domain | UseCases | terminate-passage', function () {
+  beforeEach(function () {
+    sinon.stub(DomainTransaction, 'execute').callsFake((lambda) => lambda());
+  });
+
   describe('#terminatePassage', function () {
     describe('when passage is not found', function () {
       it('should throw a PassageDoesNotExistError', async function () {
@@ -45,32 +51,45 @@ describe('Unit | Devcomp | Domain | UseCases | terminate-passage', function () {
         expect(error).to.be.instanceof(PassageTerminatedError);
       });
 
-      it('should call terminate method and update passage and return it', async function () {
+      it('should call terminate method and update passage and return it, then record an event', async function () {
         // given
         const passageId = Symbol('passageId');
+        const occurredAt = new Date('2025-01-01');
 
         const passageRepository = {
           get: sinon.stub(),
           update: sinon.stub(),
         };
+        const passageEventRepository = {
+          record: sinon.stub(),
+        };
+
         const passage = {
           terminatedAt: null,
           terminate: sinon.stub(),
         };
         passageRepository.get.withArgs({ passageId }).resolves(passage);
 
-        const updatedPassage = Symbol();
+        const updatedPassage = {
+          terminatedAt: new Date('2025-03-04'),
+          id: passageId,
+        };
         passageRepository.update.withArgs({ passage }).resolves(updatedPassage);
 
+        const event = new PassageTerminatedEvent({ passageId, occurredAt });
+
         // when
         const returnedPassage = await terminatePassage({
           passageId,
+          occurredAt,
           passageRepository,
+          passageEventRepository,
         });
 
         // then
         expect(passage.terminate).to.have.been.calledOnce;
         expect(returnedPassage).to.equal(updatedPassage);
+        expect(passageEventRepository.record).to.have.been.calledOnceWithExactly(event);
       });
     });
   });
diff --git a/api/tests/shared/unit/infrastructure/utils/request-response-utils_test.js b/api/tests/shared/unit/infrastructure/utils/request-response-utils_test.js
@@ -2,9 +2,10 @@ import { LOCALE } from '../../../../../src/shared/domain/constants.js';
 import {
   escapeFileName,
   extractLocaleFromRequest,
+  extractTimestampFromRequest,
   extractUserIdFromRequest,
 } from '../../../../../src/shared/infrastructure/utils/request-response-utils.js';
-import { expect, generateAuthenticatedUserRequestHeaders } from '../../../../test-helper.js';
+import { expect, generateAuthenticatedUserRequestHeaders, sinon } from '../../../../test-helper.js';
 
 const { ENGLISH_SPOKEN, FRENCH_FRANCE, FRENCH_SPOKEN } = LOCALE;
 
@@ -81,4 +82,48 @@ describe('Unit | Utils | Request Utils', function () {
       });
     });
   });
+
+  describe('#extractTimestampFromRequest', function () {
+    context('when "X-Request-Start" header exist', function () {
+      it('returns the value of the header', function () {
+        // given
+        const startDateTimestamp = new Date('2025-01-01').getTime();
+        const request = {
+          headers: {
+            'X-Request-Start': startDateTimestamp,
+          },
+        };
+
+        // when
+        const timestamp = extractTimestampFromRequest(request);
+
+        // then
+        expect(timestamp).to.equal(startDateTimestamp);
+      });
+    });
+
+    context('when "X-Request-Start" header does not exist', function () {
+      let clock, now;
+
+      beforeEach(function () {
+        now = new Date('2023-09-12');
+        clock = sinon.useFakeTimers({ now, toFake: ['Date'] });
+      });
+
+      afterEach(function () {
+        clock.restore();
+      });
+
+      it('returns a new date in timestamp', function () {
+        // given
+        const request = {};
+
+        // when
+        const timestamp = extractTimestampFromRequest(request);
+
+        // then
+        expect(timestamp).to.equal(now.getTime());
+      });
+    });
+  });
 });
