[TECH] Migrer la route de mise à jour Has Seen Assessment Instructions (PIX-14725).

 #10677

Author: pix-service-auto-merge

api/lib/application/users/index.js

@@ -156,31 +156,6 @@ const register = async function (server) {
         tags: ['api', 'user', 'trainings'],
       },
     },
-    {
-      method: 'PATCH',
-      path: '/api/users/{id}/remember-user-has-seen-assessment-instructions',
-      config: {
-        pre: [
-          {
-            method: securityPreHandlers.checkRequestedUserIsAuthenticatedUser,
-            assign: 'requestedUserIsAuthenticatedUser',
-          },
-        ],
-        validate: {
-          params: Joi.object({
-            id: identifiersType.userId,
-          }),
-        },
-        handler: userController.rememberUserHasSeenAssessmentInstructions,
-        notes: [
-          '- **Cette route est restreinte aux utilisateurs authentifiés**\n' +
-            "- Sauvegarde le fait que l'utilisateur ait vu le didacticiel" +
-            '- L’id demandé doit correspondre à celui de l’utilisateur authentifié',
-          "- Le contenu de la requête n'est pas pris en compte.",
-        ],
-        tags: ['api', 'user'],
-      },
-    },
     {
       method: 'PATCH',
       path: '/api/users/{id}/has-seen-challenge-tooltip/{challengeType}',

api/lib/application/users/user-controller.js

@@ -9,13 +9,6 @@ import * as requestResponseUtils from '../../../src/shared/infrastructure/utils/
 import { usecases } from '../../domain/usecases/index.js';
 import * as userOrganizationForAdminSerializer from '../../infrastructure/serializers/jsonapi/user-organization-for-admin-serializer.js';
 
-const rememberUserHasSeenAssessmentInstructions = async function (request, h, dependencies = { userSerializer }) {
-  const authenticatedUserId = request.auth.credentials.userId;
-
-  const updatedUser = await usecases.rememberUserHasSeenAssessmentInstructions({ userId: authenticatedUserId });
-  return dependencies.userSerializer.serialize(updatedUser);
-};
-
 const rememberUserHasSeenChallengeTooltip = async function (request, h, dependencies = { userSerializer }) {
   const authenticatedUserId = request.auth.credentials.userId;
   const challengeType = request.params.challengeType;
@@ -117,7 +110,6 @@ const userController = {
   findPaginatedUserRecommendedTrainings,
   findUserOrganizationsForAdmin,
   reassignAuthenticationMethods,
-  rememberUserHasSeenAssessmentInstructions,
   rememberUserHasSeenChallengeTooltip,
   resetScorecard,
 };

api/src/evaluation/application/users/index.js

@@ -31,6 +31,31 @@ const register = async function (server) {
         tags: ['api', 'user'],
       },
     },
+    {
+      method: 'PATCH',
+      path: '/api/users/{id}/remember-user-has-seen-assessment-instructions',
+      config: {
+        pre: [
+          {
+            method: securityPreHandlers.checkRequestedUserIsAuthenticatedUser,
+            assign: 'requestedUserIsAuthenticatedUser',
+          },
+        ],
+        validate: {
+          params: Joi.object({
+            id: identifiersType.userId,
+          }),
+        },
+        handler: userController.rememberUserHasSeenAssessmentInstructions,
+        notes: [
+          '- **Cette route est restreinte aux utilisateurs authentifiés**\n' +
+            "- Sauvegarde le fait que l'utilisateur ait vu le didacticiel" +
+            '- L’id demandé doit correspondre à celui de l’utilisateur authentifié',
+          "- Le contenu de la requête n'est pas pris en compte.",
+        ],
+        tags: ['api', 'user'],
+      },
+    },
   ]);
 };
 

api/src/evaluation/application/users/user-controller.js

@@ -8,6 +8,16 @@ const rememberUserHasSeenNewDashboardInfo = async function (request, h, dependen
   return dependencies.userSerializer.serialize(updatedUser);
 };
 
-const userController = { rememberUserHasSeenNewDashboardInfo };
+const rememberUserHasSeenAssessmentInstructions = async function (request, h, dependencies = { userSerializer }) {
+  const authenticatedUserId = request.auth.credentials.userId;
+
+  const updatedUser = await usecases.rememberUserHasSeenAssessmentInstructions({ userId: authenticatedUserId });
+  return dependencies.userSerializer.serialize(updatedUser);
+};
+
+const userController = {
+  rememberUserHasSeenNewDashboardInfo,
+  rememberUserHasSeenAssessmentInstructions,
+};
 
 export { userController };

api/lib/domain/usecases/remember-user-has-seen-assessment-instructions.js api/src/evaluation/domain/usecases/remember-user-has-seen-assessment-instructions.js

@@ -1,5 +1,5 @@
 const rememberUserHasSeenAssessmentInstructions = function ({ userId, userRepository }) {
-  return userRepository.updateHasSeenAssessmentInstructionsToTrue(userId);
+  return userRepository.updateAssessmentInstructionsInfoAsSeen({ userId });
 };
 
 export { rememberUserHasSeenAssessmentInstructions };

api/src/evaluation/infrastructure/repositories/user-repository.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import ("./index.js").UserApi} UserApi
+ * @typedef {import ('./index.js').UserApi} UserApi
  */
 
 /**
@@ -12,4 +12,14 @@ const updateHasSeenNewDashboardInfo = async function ({ userId, userApi }) {
   return userApi.markNewDashboardInfoAsSeen({ userId });
 };
 
-export { updateHasSeenNewDashboardInfo };
+/**
+ * @function
+ * @param {Object} params
+ * @param {UserApi} params.userApi
+ * @param {number} params.userId
+ */
+const updateAssessmentInstructionsInfoAsSeen = async function ({ userId, userApi }) {
+  return userApi.markAssessmentInstructionsInfoAsSeen({ userId });
+};
+
+export { updateAssessmentInstructionsInfoAsSeen, updateHasSeenNewDashboardInfo };

api/src/identity-access-management/application/api/users-api.js

@@ -8,6 +8,10 @@ export const markNewDashboardInfoAsSeen = async ({ userId }) => {
   return usecases.markUserHasSeenNewDashboardInfo({ userId });
 };
 
+export const markAssessmentInstructionsInfoAsSeen = async ({ userId }) => {
+  return usecases.markAssessmentInstructionsInfoAsSeen({ userId });
+};
+
 export const getUserDetailsByUserIds = async ({ userIds }) => {
   const users = await usecases.getUserDetailsByUserIds({ userIds });
   return users.map((user) => new UserDTO(user));

api/src/identity-access-management/domain/usecases/mark-assessment-instructions-info-as-seen.usecase.js

@@ -0,0 +1,14 @@
+/**
+ * @typedef {import ('../../domain/usecases/index.js').UserRepository} UserRepository
+ */
+
+/**
+ * @param {Object} params
+ * @param {number} params.userId
+ * @param {UserRepository} params.userRepository
+ */
+const markAssessmentInstructionsInfoAsSeen = function ({ userId, userRepository }) {
+  return userRepository.updateHasSeenAssessmentInstructionsToTrue(userId);
+};
+
+export { markAssessmentInstructionsInfoAsSeen };

api/tests/evaluation/unit/application/users/user-controller_test.js

@@ -29,4 +29,36 @@ describe('Unit | Controller | user-controller', function () {
       expect(response).to.be.equal('ok');
     });
   });
+
+  describe('#rememberUserHasSeenAssessmentInstructions', function () {
+    let request;
+    let userSerializer;
+    const userId = 1;
+
+    beforeEach(function () {
+      request = {
+        auth: { credentials: { userId } },
+        params: { id: userId },
+      };
+      userSerializer = {
+        serialize: sinon.stub(),
+      };
+
+      sinon.stub(evaluationUsecases, 'rememberUserHasSeenAssessmentInstructions');
+    });
+
+    it('should remember user has seen assessment instructions', async function () {
+      // given
+      evaluationUsecases.rememberUserHasSeenAssessmentInstructions.withArgs({ userId }).resolves({});
+      userSerializer.serialize.withArgs({}).returns('ok');
+
+      // when
+      const response = await userController.rememberUserHasSeenAssessmentInstructions(request, hFake, {
+        userSerializer,
+      });
+
+      // then
+      expect(response).to.be.equal('ok');
+    });
+  });
 });

api/tests/unit/domain/usecases/remember-user-has-seen-assessment-instructions_test.js api/tests/evaluation/unit/domain/usecases/remember-user-has-seen-assessment-instructions_test.js

@@ -1,24 +1,24 @@
-import { rememberUserHasSeenAssessmentInstructions } from '../../../../lib/domain/usecases/remember-user-has-seen-assessment-instructions.js';
-import { expect, sinon } from '../../../test-helper.js';
+import { rememberUserHasSeenAssessmentInstructions } from '../../../../../src/evaluation/domain/usecases/remember-user-has-seen-assessment-instructions.js';
+import { expect, sinon } from '../../../../test-helper.js';
 
 describe('Unit | UseCase | remember-user-has-seen-assessment-instructions', function () {
   let userRepository;
 
   beforeEach(function () {
-    userRepository = { updateHasSeenAssessmentInstructionsToTrue: sinon.stub() };
+    userRepository = { updateAssessmentInstructionsInfoAsSeen: sinon.stub() };
   });
 
   it('should update has seen assessment instructions', async function () {
     // given
     const userId = 'userId';
     const updatedUser = Symbol('updateduser');
-    userRepository.updateHasSeenAssessmentInstructionsToTrue.resolves(updatedUser);
+    userRepository.updateAssessmentInstructionsInfoAsSeen.resolves(updatedUser);
 
     // when
     const actualUpdatedUser = await rememberUserHasSeenAssessmentInstructions({ userId, userRepository });
 
     // then
-    expect(userRepository.updateHasSeenAssessmentInstructionsToTrue).to.have.been.calledWithExactly(userId);
+    expect(userRepository.updateAssessmentInstructionsInfoAsSeen).to.have.been.calledWithExactly({ userId });
     expect(actualUpdatedUser).to.equal(updatedUser);
   });
 });

api/tests/identity-access-management/integration/domain/usecases/mark-assessment-instructions-info-as-seen.usecase.test.js

@@ -0,0 +1,21 @@
+import { usecases } from '../../../../../src/identity-access-management/domain/usecases/index.js';
+import { databaseBuilder, expect } from '../../../../test-helper.js';
+
+describe('Integration | Identity Access Management | Domain | UseCase | markAssessmentInstructionsInfoAsSeen', function () {
+  it('should update hasSeenAssessmentInstructions property as true for the user', async function () {
+    // given
+    const user = databaseBuilder.factory.buildUser({
+      email: 'myusertoupdate@example.net',
+      hasSeenAssessmentInstructions: false,
+    });
+    await databaseBuilder.commit();
+
+    // when
+    const result = await usecases.markAssessmentInstructionsInfoAsSeen({
+      userId: user.id,
+    });
+
+    // then
+    expect(result.hasSeenAssessmentInstructions).to.be.true;
+  });
+});

api/tests/unit/application/users/user-controller_test.js

@@ -17,34 +17,6 @@ describe('Unit | Controller | user-controller', function () {
     };
   });
 
-  describe('#rememberUserHasSeenAssessmentInstructions', function () {
-    let request;
-    const userId = 1;
-
-    beforeEach(function () {
-      request = {
-        auth: { credentials: { userId } },
-        params: { id: userId },
-      };
-
-      sinon.stub(usecases, 'rememberUserHasSeenAssessmentInstructions');
-    });
-
-    it('should remember user has seen assessment instructions', async function () {
-      // given
-      usecases.rememberUserHasSeenAssessmentInstructions.withArgs({ userId }).resolves({});
-      userSerializer.serialize.withArgs({}).returns('ok');
-
-      // when
-      const response = await userController.rememberUserHasSeenAssessmentInstructions(request, hFake, {
-        userSerializer,
-      });
-
-      // then
-      expect(response).to.be.equal('ok');
-    });
-  });
-
   describe('#rememberUserHasSeenChallengeTooltip', function () {
     let request;
     const userId = 1;