[FEATURE] Ajout d'une route pour récupérer les infos de début de parcours (PIX-14813).

pix-service-auto-merge · web-flow · commit 239e83d5ccf4 · 2024-10-23T15:02:56.000+02:00
#10352
diff --git a/api/src/prescription/campaign/application/campaign-controller.js b/api/src/prescription/campaign/application/campaign-controller.js
@@ -3,6 +3,7 @@ import * as campaignAnalysisSerializer from '../../campaign-participation/infras
 import { usecases } from '../domain/usecases/index.js';
 import * as divisionSerializer from '../infrastructure/serializers/jsonapi/division-serializer.js';
 import * as groupSerializer from '../infrastructure/serializers/jsonapi/group-serializer.js';
+import * as presentationStepsSerializer from '../infrastructure/serializers/jsonapi/presentation-steps-serializer.js';
 
 const division = async function (request) {
   const { userId } = request.auth.credentials;
@@ -28,10 +29,24 @@ const getAnalysis = async function (request, h, dependencies = { campaignAnalysi
   return dependencies.campaignAnalysisSerializer.serialize(campaignAnalysis);
 };
 
+const getPresentationSteps = async function (
+  request,
+  _,
+  dependencies = { presentationStepsSerializer, extractLocaleFromRequest },
+) {
+  const { userId } = request.auth.credentials;
+  const campaignCode = request.params.campaignCode;
+  const locale = dependencies.extractLocaleFromRequest(request);
+
+  const presentationSteps = await usecases.getPresentationSteps({ userId, campaignCode, locale });
+  return dependencies.presentationStepsSerializer.serialize(presentationSteps);
+};
+
 const campaignController = {
   division,
   getAnalysis,
   getGroups,
+  getPresentationSteps,
 };
 
 export { campaignController };
diff --git a/api/src/prescription/campaign/application/campaign-route.js b/api/src/prescription/campaign/application/campaign-route.js
@@ -1,6 +1,7 @@
 import Joi from 'joi';
 
 import { identifiersType } from '../../../shared/domain/types/identifiers-type.js';
+import { identifiersType as prescriptionIdentifiersType } from '../../shared/domain/types/identifiers-type.js';
 import { campaignController } from './campaign-controller.js';
 
 const register = async function (server) {
@@ -56,6 +57,23 @@ const register = async function (server) {
         tags: ['api', 'campaign'],
       },
     },
+    {
+      method: 'GET',
+      path: '/api/campaigns/{campaignCode}/presentation-steps',
+      config: {
+        handler: campaignController.getPresentationSteps,
+        validate: {
+          params: Joi.object({
+            campaignCode: prescriptionIdentifiersType.campaignCode,
+          }),
+        },
+        notes: [
+          '- **Cette route est restreinte aux utilisateurs authentifiés**\n' +
+            '- Récupération des infos des écrans de présentation de début de parcours',
+        ],
+        tags: ['api', 'campaign', 'presentation'],
+      },
+    },
   ]);
 };
 
diff --git a/api/src/prescription/campaign/domain/usecases/get-presentation-steps.js b/api/src/prescription/campaign/domain/usecases/get-presentation-steps.js
@@ -0,0 +1,35 @@
+import { CampaignCodeError, UserNotAuthorizedToAccessEntityError } from '../../../../shared/domain/errors.js';
+import { ArchivedCampaignError, DeletedCampaignError } from '../errors.js';
+
+const getPresentationSteps = async function ({
+  userId,
+  campaignCode,
+  locale,
+  badgeRepository,
+  campaignRepository,
+  learningContentRepository,
+}) {
+  const campaign = await campaignRepository.getByCode(campaignCode);
+
+  if (!campaign) throw new CampaignCodeError();
+  if (campaign.archivedAt) throw new ArchivedCampaignError();
+  if (campaign.deletedAt) throw new DeletedCampaignError();
+
+  const hasUserAccessToResult = await campaignRepository.checkIfUserOrganizationHasAccessToCampaign(
+    campaign.id,
+    userId,
+  );
+  if (!hasUserAccessToResult)
+    throw new UserNotAuthorizedToAccessEntityError('User does not have access to this campaign');
+
+  const campaignBadges = await badgeRepository.findByCampaignId(campaign.id);
+  const learningContent = await learningContentRepository.findByCampaignId(campaign.id, locale);
+
+  return {
+    customLandingPageText: campaign.customLandingPageText,
+    badges: campaignBadges,
+    competences: learningContent?.competences,
+  };
+};
+
+export { getPresentationSteps };
diff --git a/api/src/prescription/campaign/infrastructure/serializers/jsonapi/presentation-steps-serializer.js b/api/src/prescription/campaign/infrastructure/serializers/jsonapi/presentation-steps-serializer.js
@@ -0,0 +1,19 @@
+import jsonapiSerializer from 'jsonapi-serializer';
+
+const { Serializer } = jsonapiSerializer;
+
+const serialize = function (presentationSteps) {
+  return new Serializer('campaign-presentation-step', {
+    attributes: ['customLandingPageText', 'badges', 'competences'],
+    badges: {
+      ref: 'id',
+      attributes: ['altMessage', 'imageUrl', 'isAlwaysVisible', 'isCertifiable', 'key', 'message', 'title'],
+    },
+    competences: {
+      ref: 'id',
+      attributes: ['index', 'name'],
+    },
+  }).serialize(presentationSteps);
+};
+
+export { serialize };
diff --git a/api/src/prescription/shared/domain/types/identifiers-type.js b/api/src/prescription/shared/domain/types/identifiers-type.js
@@ -3,9 +3,13 @@ import Joi from 'joi';
 import { categories } from '../../../../shared/domain/models/TargetProfile.js';
 import { certificabilityByLabel } from '../../application/helpers.js';
 
+const identifiersType = {
+  campaignCode: Joi.string().min(9).max(9).required(),
+};
+
 const filterType = {
   certificability: Joi.string().valid(...Object.keys(certificabilityByLabel)),
   targetProfileCategory: Joi.string().valid(...Object.values(categories)),
 };
 
-export { filterType };
+export { filterType, identifiersType };
diff --git a/api/tests/prescription/campaign/acceptance/application/campaign-route_test.js b/api/tests/prescription/campaign/acceptance/application/campaign-route_test.js
@@ -2,6 +2,7 @@ import { Membership } from '../../../../../src/shared/domain/models/Membership.j
 import {
   createServer,
   databaseBuilder,
+  domainBuilder,
   expect,
   generateValidRequestAuthorizationHeader,
   learningContentBuilder,
@@ -350,4 +351,96 @@ describe('Acceptance | API | Campaign Route', function () {
       });
     });
   });
+
+  describe('GET /api/campaigns/{campaignId}/presentation-steps', function () {
+    it('should return the presentation steps informations', async function () {
+      // given
+      const userId = databaseBuilder.factory.buildUser().id;
+      const organization = databaseBuilder.factory.buildOrganization();
+
+      databaseBuilder.factory.buildMembership({
+        userId,
+        organizationId: organization.id,
+        organizationRole: Membership.roles.MEMBER,
+      });
+
+      const targetProfile = databaseBuilder.factory.buildTargetProfile({ organizationId: organization.id });
+      const badge = databaseBuilder.factory.buildBadge({ targetProfileId: targetProfile.id });
+      const campaign = databaseBuilder.factory.buildCampaign({
+        code: 'CAMPAIGN1',
+        customLandingPageText: 'landing page text',
+        targetProfileId: targetProfile.id,
+        organizationId: organization.id,
+      });
+
+      const learningContent = domainBuilder.buildLearningContent.withSimpleContent();
+      const learningContentObjects = learningContentBuilder.fromAreas(learningContent.frameworks[0].areas);
+      mockLearningContent(learningContentObjects);
+
+      databaseBuilder.factory.buildCampaignSkill({
+        campaignId: campaign.id,
+        skillId: learningContentObjects.competences[0].skillIds[0],
+      });
+      await databaseBuilder.commit();
+
+      // when
+      const options = {
+        method: 'GET',
+        url: `/api/campaigns/${campaign.code}/presentation-steps`,
+        headers: { authorization: generateValidRequestAuthorizationHeader(userId) },
+      };
+
+      const response = await server.inject(options);
+
+      // then
+      expect(response.statusCode).to.equal(200);
+      expect(response.result).to.deep.equal({
+        data: {
+          type: 'campaign-presentation-steps',
+          attributes: { 'custom-landing-page-text': campaign.customLandingPageText },
+          relationships: {
+            badges: {
+              data: [
+                {
+                  id: String(badge.id),
+                  type: 'badges',
+                },
+              ],
+            },
+            competences: {
+              data: [
+                {
+                  id: learningContentObjects.competences[0].id,
+                  type: 'competences',
+                },
+              ],
+            },
+          },
+        },
+        included: [
+          {
+            type: 'badges',
+            id: String(badge.id),
+            attributes: {
+              'alt-message': badge.altMessage,
+              'image-url': badge.imageUrl,
+              'is-always-visible': badge.isAlwaysVisible,
+              'is-certifiable': badge.isCertifiable,
+              key: badge.key,
+              message: badge.message,
+              title: badge.title,
+            },
+          },
+          {
+            type: 'competences',
+            id: learningContentObjects.competences[0].id,
+            attributes: {
+              index: learningContentObjects.competences[0].index,
+              name: learningContentObjects.competences[0].name,
+            },
+          },
+        ],
+      });
+    });
+  });
 });
diff --git a/api/tests/prescription/campaign/integration/domain/usecases/get-presentation-steps_test.js b/api/tests/prescription/campaign/integration/domain/usecases/get-presentation-steps_test.js
@@ -0,0 +1,58 @@
+import { usecases } from '../../../../../../src/prescription/campaign/domain/usecases/index.js';
+import { LOCALE } from '../../../../../../src/shared/domain/constants.js';
+import {
+  databaseBuilder,
+  domainBuilder,
+  expect,
+  learningContentBuilder,
+  mockLearningContent,
+} from '../../../../../test-helper.js';
+
+const { FRENCH_SPOKEN } = LOCALE;
+
+describe('Integration | Campaign | UseCase | get-presentation-steps', function () {
+  let user, campaign, badges, competences;
+
+  beforeEach(async function () {
+    const learningContent = domainBuilder.buildLearningContent.withSimpleContent();
+    const learningContentObjects = learningContentBuilder.fromAreas(learningContent.frameworks[0].areas);
+    mockLearningContent(learningContentObjects);
+
+    const targetProfileId = databaseBuilder.factory.buildTargetProfile().id;
+
+    campaign = databaseBuilder.factory.buildCampaign({ targetProfileId });
+
+    user = databaseBuilder.factory.buildUser.withMembership({ organizationId: campaign.organizationId });
+
+    badges = [
+      databaseBuilder.factory.buildBadge({ targetProfileId }),
+      databaseBuilder.factory.buildBadge({ targetProfileId }),
+    ];
+
+    competences = learningContentObjects.competences;
+
+    databaseBuilder.factory.buildCampaignSkill({
+      campaignId: campaign.id,
+      skillId: competences[0].skillIds[0],
+    });
+
+    await databaseBuilder.commit();
+  });
+
+  it('should get campaign presentation steps content', async function () {
+    // when
+    const result = await usecases.getPresentationSteps({
+      userId: user.id,
+      campaignCode: campaign.code,
+      locale: FRENCH_SPOKEN,
+    });
+
+    // then
+    expect(result.customLandingPageText).to.equal(campaign.customLandingPageText);
+    expect(result.badges).to.deep.equal(badges);
+    expect(result.competences).to.have.lengthOf(competences.length);
+    expect(result.competences[0].id).to.equal(competences[0].id);
+    expect(result.competences[0].index).to.equal(competences[0].index);
+    expect(result.competences[0].name).to.equal(competences[0].name);
+  });
+});
diff --git a/api/tests/prescription/campaign/unit/application/campaign-controller_test.js b/api/tests/prescription/campaign/unit/application/campaign-controller_test.js
@@ -60,4 +60,43 @@ describe('Unit | Application | Controller | Campaign', function () {
       expect(errorCatched).to.be.instanceof(UserNotAuthorizedToAccessEntityError);
     });
   });
+
+  describe('#getPresentationSteps', function () {
+    it('should return expected results', async function () {
+      // given
+      const userId = Symbol('userId');
+      const campaignCode = Symbol('campaign code');
+      const locale = FRENCH_SPOKEN;
+
+      sinon.stub(usecases, 'getPresentationSteps');
+
+      const dependencies = {
+        extractLocaleFromRequestStub: sinon.stub().returns(locale),
+        presentationStepsSerializerStub: {
+          serialize: sinon.stub(),
+        },
+      };
+
+      const presentationSteps = Symbol('presentation steps');
+      const expectedResults = Symbol('results');
+
+      usecases.getPresentationSteps.withArgs({ userId, campaignCode, locale }).resolves(presentationSteps);
+      dependencies.presentationStepsSerializerStub.serialize.withArgs(presentationSteps).returns(expectedResults);
+
+      const request = {
+        auth: { credentials: { userId } },
+        params: { campaignCode },
+        headers: { 'accept-language': locale },
+      };
+
+      // when
+      const response = await campaignController.getPresentationSteps(request, hFake, {
+        extractLocaleFromRequest: dependencies.extractLocaleFromRequestStub,
+        presentationStepsSerializer: dependencies.presentationStepsSerializerStub,
+      });
+
+      // then
+      expect(response).to.equal(expectedResults);
+    });
+  });
 });
diff --git a/api/tests/prescription/campaign/unit/domain/usecases/get-presentation-steps_test.js b/api/tests/prescription/campaign/unit/domain/usecases/get-presentation-steps_test.js
diff --git a/api/tests/prescription/campaign/unit/infrastructure/serializers/jsonapi/presentation-steps-serializer_test.js b/api/tests/prescription/campaign/unit/infrastructure/serializers/jsonapi/presentation-steps-serializer_test.js
