[TECH] Migrer la route User Has Seen New Dashboard (PIX-14451).

#10173
1024pix · Sep 27, 2024 · 461871f · 461871f
2 parents 3d56a0d + c8bda34
commit 461871f
Show file tree

Hide file tree

Showing 14 changed files with 110 additions and 68 deletions.
diff --git a/api/lib/application/users/index.js b/api/lib/application/users/index.js
@@ -447,31 +447,6 @@ const register = async function (server) {
         tags: ['api', 'user'],
       },
     },
-    {
-      method: 'PATCH',
-      path: '/api/users/{id}/has-seen-new-dashboard-info',
-      config: {
-        pre: [
-          {
-            method: securityPreHandlers.checkRequestedUserIsAuthenticatedUser,
-            assign: 'requestedUserIsAuthenticatedUser',
-          },
-        ],
-        validate: {
-          params: Joi.object({
-            id: identifiersType.userId,
-          }),
-        },
-        handler: userController.rememberUserHasSeenNewDashboardInfo,
-        notes: [
-          '- **Cette route est restreinte aux utilisateurs authentifiés**\n' +
-            "- Sauvegarde le fait que l'utilisateur ait vu le message sur le nouveau dashboard" +
-            '- 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}',

diff --git a/api/lib/application/users/user-controller.js b/api/lib/application/users/user-controller.js
@@ -44,13 +44,6 @@ const rememberUserHasSeenAssessmentInstructions = async function (request, h, de
   return dependencies.userSerializer.serialize(updatedUser);
 };
 
-const rememberUserHasSeenNewDashboardInfo = async function (request, h, dependencies = { userSerializer }) {
-  const authenticatedUserId = request.auth.credentials.userId;
-
-  const updatedUser = await usecases.rememberUserHasSeenNewDashboardInfo({ 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;
@@ -269,7 +262,6 @@ const userController = {
   reassignAuthenticationMethods,
   rememberUserHasSeenAssessmentInstructions,
   rememberUserHasSeenChallengeTooltip,
-  rememberUserHasSeenNewDashboardInfo,
   removeAuthenticationMethod,
   resetScorecard,
   updateUserDetailsForAdministration,

diff --git a/api/src/evaluation/application/users/index.js b/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}/has-seen-new-dashboard-info',
+      config: {
+        pre: [
+          {
+            method: securityPreHandlers.checkRequestedUserIsAuthenticatedUser,
+            assign: 'requestedUserIsAuthenticatedUser',
+          },
+        ],
+        validate: {
+          params: Joi.object({
+            id: identifiersType.userId,
+          }),
+        },
+        handler: userController.rememberUserHasSeenNewDashboardInfo,
+        notes: [
+          '- **Cette route est restreinte aux utilisateurs authentifiés**\n' +
+            "- Sauvegarde le fait que l'utilisateur ait vu le message sur le nouveau dashboard" +
+            '- 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'],
+      },
+    },
   ]);
 };
 

diff --git a/api/src/evaluation/application/users/user-controller.js b/api/src/evaluation/application/users/user-controller.js
@@ -8,6 +8,13 @@ const rememberUserHasSeenLevelSevenInfo = async function (request, h, dependenci
   return dependencies.userSerializer.serialize(updatedUser);
 };
 
-const userController = { rememberUserHasSeenLevelSevenInfo };
+const rememberUserHasSeenNewDashboardInfo = async function (request, h, dependencies = { userSerializer }) {
+  const authenticatedUserId = request.auth.credentials.userId;
+
+  const updatedUser = await usecases.rememberUserHasSeenNewDashboardInfo({ userId: authenticatedUserId });
+  return dependencies.userSerializer.serialize(updatedUser);
+};
+
+const userController = { rememberUserHasSeenLevelSevenInfo, rememberUserHasSeenNewDashboardInfo };
 
 export { userController };
diff --git a/api/src/evaluation/domain/usecases/remember-user-has-seen-level-seven-info.js b/api/src/evaluation/domain/usecases/remember-user-has-seen-level-seven-info.js
@@ -1,5 +1,5 @@
 const rememberUserHasSeenLevelSevenInfo = function ({ userId, userRepository }) {
-  return userRepository.update({ userId });
+  return userRepository.updateMarkLevelSevenInfoAsSeen({ userId });
 };
 
 export { rememberUserHasSeenLevelSevenInfo };
diff --git a/...ember-user-has-seen-new-dashboard-info.js → ...ember-user-has-seen-new-dashboard-info.js b/...ember-user-has-seen-new-dashboard-info.js → ...ember-user-has-seen-new-dashboard-info.js
@@ -1,5 +1,5 @@
 const rememberUserHasSeenNewDashboardInfo = function ({ userId, userRepository }) {
-  return userRepository.updateHasSeenNewDashboardInfoToTrue(userId);
+  return userRepository.updateHasSeenNewDashboardInfo({ userId });
 };
 
 export { rememberUserHasSeenNewDashboardInfo };
diff --git a/api/src/evaluation/infrastructure/repositories/user-repository.js b/api/src/evaluation/infrastructure/repositories/user-repository.js
@@ -7,8 +7,18 @@
  * @param {Object} params
  * @param {UserApi} params.userApi
  */
-const update = async function ({ userId, userApi }) {
+const updateMarkLevelSevenInfoAsSeen = async function ({ userId, userApi }) {
   return userApi.markLevelSevenInfoAsSeen({ userId });
 };
 
-export { update };
+/**
+ * @function
+ * @param {Object} params
+ * @param {UserApi} params.userApi
+ * @param {number} params.userId
+ */
+const updateHasSeenNewDashboardInfo = async function ({ userId, userApi }) {
+  return userApi.markNewDashboardInfoAsSeen({ userId });
+};
+
+export { updateHasSeenNewDashboardInfo, updateMarkLevelSevenInfoAsSeen };
diff --git a/api/src/identity-access-management/application/api/users-api.js b/api/src/identity-access-management/application/api/users-api.js
@@ -6,3 +6,7 @@ import { usecases } from '../../domain/usecases/index.js';
 export const markLevelSevenInfoAsSeen = async ({ userId }) => {
   return usecases.rememberUserHasSeenLevelSevenInformation({ userId });
 };
+
+export const markNewDashboardInfoAsSeen = async ({ userId }) => {
+  return usecases.markUserHasSeenNewDashboardInfo({ userId });
+};
diff --git a/...entity-access-management/domain/usecases/mark-user-has-seen-new-dashboard-info.usecase.js b/...entity-access-management/domain/usecases/mark-user-has-seen-new-dashboard-info.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 markUserHasSeenNewDashboardInfo = function ({ userId, userRepository }) {
+  return userRepository.updateHasSeenNewDashboardInfoToTrue(userId);
+};
+
+export { markUserHasSeenNewDashboardInfo };
diff --git a/...-user-has-seen-new-dashboard-info_test.js → ...-user-has-seen-new-dashboard-info_test.js b/...-user-has-seen-new-dashboard-info_test.js → ...-user-has-seen-new-dashboard-info_test.js
@@ -3,7 +3,7 @@ import {
   databaseBuilder,
   expect,
   generateValidRequestAuthorizationHeader,
-} from '../../../test-helper.js';
+} from '../../../../test-helper.js';
 
 describe('Acceptance | Controller | users-controller-has-seen-new-dashboard-info', function () {
   let server;

diff --git a/api/tests/evaluation/unit/application/users/user-controller_test.js b/api/tests/evaluation/unit/application/users/user-controller_test.js
@@ -31,4 +31,31 @@ describe('Unit | Controller | user-controller', function () {
       expect(response).to.be.equal(userInformationSerialized);
     });
   });
+
+  describe('#rememberUserHasSeenNewDashboardInfo', function () {
+    it('should remember user has seen new dashboard info', async function () {
+      // given
+      const userId = 1;
+      const userSerializer = {
+        serialize: sinon.stub(),
+      };
+      sinon.stub(evaluationUsecases, 'rememberUserHasSeenNewDashboardInfo');
+
+      evaluationUsecases.rememberUserHasSeenNewDashboardInfo.withArgs({ userId }).resolves({});
+      userSerializer.serialize.withArgs({}).returns('ok');
+
+      // when
+      const response = await userController.rememberUserHasSeenNewDashboardInfo(
+        {
+          auth: { credentials: { userId } },
+          params: { id: userId },
+        },
+        hFake,
+        { userSerializer },
+      );
+
+      // then
+      expect(response).to.be.equal('ok');
+    });
+  });
 });
diff --git a/api/tests/evaluation/unit/domain/usecases/remember-user-has-seen-level-seven-info_test.js b/api/tests/evaluation/unit/domain/usecases/remember-user-has-seen-level-seven-info_test.js
@@ -4,9 +4,9 @@ import { expect, sinon } from '../../../../test-helper.js';
 describe('Unit | UseCase | remember-user-has-seen-level-seven-info', function () {
   it('should return user information', async function () {
     // given
-    const userRepository = { update: sinon.stub() };
+    const userRepository = { updateMarkLevelSevenInfoAsSeen: sinon.stub() };
     const userId = 1;
-    userRepository.update.withArgs({ userId }).resolves();
+    userRepository.updateMarkLevelSevenInfoAsSeen.withArgs({ userId }).resolves();
 
     // when
     await rememberUserHasSeenLevelSevenInfo({
@@ -15,6 +15,6 @@ describe('Unit | UseCase | remember-user-has-seen-level-seven-info', function ()
     });
 
     // then
-    expect(userRepository.update).to.have.been.calledOnce;
+    expect(userRepository.updateMarkLevelSevenInfoAsSeen).to.have.been.calledOnce;
   });
 });
diff --git a/api/tests/identity-access-management/integration/application/api/users-api_test.js b/api/tests/identity-access-management/integration/application/api/users-api_test.js
@@ -15,4 +15,18 @@ describe('Integration | Application | users-api', function () {
       expect(actualUser.hasSeenLevelSevenInfo).to.be.true;
     });
   });
+
+  describe('#markNewDashboardInfoAsSeen', function () {
+    it('should return user information', async function () {
+      // given
+      const userId = databaseBuilder.factory.buildUser({ hasSeenNewDashboardInfo: false }).id;
+      await databaseBuilder.commit();
+
+      // when
+      const actualUser = await userApi.markNewDashboardInfoAsSeen({ userId });
+
+      // then
+      expect(actualUser.hasSeenNewDashboardInfo).to.be.true;
+    });
+  });
 });
diff --git a/api/tests/unit/application/users/user-controller_test.js b/api/tests/unit/application/users/user-controller_test.js
@@ -122,32 +122,6 @@ describe('Unit | Controller | user-controller', function () {
     });
   });
 
-  describe('#rememberUserHasSeenNewDashboardInfo', function () {
-    let request;
-    const userId = 1;
-
-    beforeEach(function () {
-      request = {
-        auth: { credentials: { userId } },
-        params: { id: userId },
-      };
-
-      sinon.stub(usecases, 'rememberUserHasSeenNewDashboardInfo');
-    });
-
-    it('should remember user has seen new dashboard info', async function () {
-      // given
-      usecases.rememberUserHasSeenNewDashboardInfo.withArgs({ userId }).resolves({});
-      userSerializer.serialize.withArgs({}).returns('ok');
-
-      // when
-      const response = await userController.rememberUserHasSeenNewDashboardInfo(request, hFake, { userSerializer });
-
-      // then
-      expect(response).to.be.equal('ok');
-    });
-  });
-
   describe('#rememberUserHasSeenChallengeTooltip', function () {
     let request;
     const userId = 1;