[FEATURE] Ajout d'une route de mise à disposition pour les résultats de campagne

 #11868

Author: pix-service-auto-merge

Diff for: api/db/seeds/data/common/common-builder.js

@@ -97,7 +97,7 @@ function createClientApplications(databaseBuilder) {
     name: 'multi-organizations-client-application',
     clientId: 'maddo-client',
     clientSecret: 'maddo-secret',
-    scopes: ['meta'],
+    scopes: ['meta', 'campaigns'],
     jurisdiction: { rules: [{ name: 'tags', value: [COLLEGE_TAG.name] }] },
   });
 }

Diff for: api/server.maddo.js

@@ -6,8 +6,9 @@ import { setupErrorHandling } from './config/server-setup-error-handling.js';
 import { knex } from './db/knex-database-connection.js';
 import { authentication } from './lib/infrastructure/authentication.js';
 import { identityAccessManagementRoutes } from './src/identity-access-management/application/routes.js';
-import * as organizationRoutes from './src/maddo/application/organizations-routes.js';
-import * as replicationRoutes from './src/maddo/application/replications-routes.js';
+import * as campaignsRoutes from './src/maddo/application/campaigns-routes.js';
+import * as organizationsRoutes from './src/maddo/application/organizations-routes.js';
+import * as replicationsRoutes from './src/maddo/application/replications-routes.js';
 import { Metrics } from './src/monitoring/infrastructure/metrics.js';
 import * as healthcheckRoutes from './src/shared/application/healthcheck/index.js';
 import { config } from './src/shared/config.js';
@@ -180,7 +181,13 @@ const setupAuthentication = function (server) {
 };
 
 const setupRoutesAndPlugins = async function (server) {
-  const routes = [healthcheckRoutes, ...identityAccessManagementRoutes, replicationRoutes, organizationRoutes];
+  const routes = [
+    ...identityAccessManagementRoutes,
+    campaignsRoutes,
+    healthcheckRoutes,
+    organizationsRoutes,
+    replicationsRoutes,
+  ];
   const routesWithOptions = routes.map((route) => ({
     plugin: route,
     options: { tags: ['maddo'] },

Diff for: api/src/maddo/application/campaigns-controller.js

@@ -0,0 +1,12 @@
+import { usecases } from '../domain/usecases/index.js';
+
+export async function getCampaignParticipations(
+  request,
+  h,
+  dependencies = { getCampaignParticipations: usecases.getCampaignParticipations },
+) {
+  const campaignParticipations = await dependencies.getCampaignParticipations({
+    campaignId: request.params.campaignId,
+  });
+  return h.response(campaignParticipations).code(200);
+}

Diff for: api/src/maddo/application/campaigns-routes.js

@@ -0,0 +1,29 @@
+import Joi from 'joi';
+
+import { identifiersType } from '../../shared/domain/types/identifiers-type.js';
+import { getCampaignParticipations } from './campaigns-controller.js';
+import { isCampaignInJurisdictionPreHandler, organizationPreHandler } from './pre-handlers.js';
+
+const register = async function (server) {
+  server.route([
+    {
+      method: 'GET',
+      path: '/api/campaigns/{campaignId}/participations',
+      config: {
+        auth: { access: { scope: 'campaigns' } },
+        validate: {
+          params: Joi.object({
+            campaignId: identifiersType.campaignId,
+          }),
+        },
+        pre: [organizationPreHandler, isCampaignInJurisdictionPreHandler],
+        handler: getCampaignParticipations,
+        notes: ['- Retourne les résultats de la campagne donnée.'],
+        tags: ['api', 'campaigns', 'maddo'],
+      },
+    },
+  ]);
+};
+
+const name = 'maddo-campaigns-api';
+export { name, register };

Diff for: api/src/maddo/application/organizations-controller.js

@@ -1,5 +1,3 @@
-import boom from '@hapi/boom';
-
 import { usecases } from '../domain/usecases/index.js';
 
 export async function getOrganizations(request, h, dependencies = { findOrganizations: usecases.findOrganizations }) {
@@ -8,11 +6,7 @@ export async function getOrganizations(request, h, dependencies = { findOrganiza
 }
 
 export async function getOrganizationCampaigns(request, h, dependencies = { findCampaigns: usecases.findCampaigns }) {
-  const organizationIds = request.pre.organizationIds;
   const requestedOrganizationId = request.params.organizationId;
-  if (!organizationIds.includes(requestedOrganizationId)) {
-    return boom.forbidden();
-  }
   const campaigns = await dependencies.findCampaigns({ organizationId: requestedOrganizationId });
   return h.response(campaigns).code(200);
 }

Diff for: api/src/maddo/application/organizations-routes.js

@@ -2,7 +2,7 @@ import Joi from 'joi';
 
 import { identifiersType } from '../../shared/domain/types/identifiers-type.js';
 import { getOrganizationCampaigns, getOrganizations } from './organizations-controller.js';
-import { organizationPreHandler } from './pre-handlers.js';
+import { isOrganizationInJurisdictionPreHandler, organizationPreHandler } from './pre-handlers.js';
 
 const register = async function (server) {
   server.route([
@@ -21,15 +21,15 @@ const register = async function (server) {
       method: 'GET',
       path: '/api/organizations/{organizationId}/campaigns',
       config: {
-        auth: { access: { scope: 'meta' } },
+        auth: { access: { scope: 'campaigns' } },
         validate: {
           params: Joi.object({
             organizationId: identifiersType.organizationId,
           }),
         },
-        pre: [organizationPreHandler],
+        pre: [organizationPreHandler, isOrganizationInJurisdictionPreHandler],
         handler: getOrganizationCampaigns,
-        notes: ["- Retourne la liste des campaignes de l'organisation fournie"],
+        notes: ["- Retourne la liste des campaignes de l'organisation donnée"],
         tags: ['api', 'meta'],
       },
     },

Diff for: api/src/maddo/application/pre-handlers.js

@@ -1,3 +1,5 @@
+import boom from '@hapi/boom';
+
 import { usecases } from '../domain/usecases/index.js';
 
 export const organizationPreHandler = {
@@ -10,3 +12,28 @@ export const organizationPreHandler = {
     return dependencies.findOrganizationIdsByClientApplication({ clientId: request.auth.credentials.client_id });
   },
 };
+
+export const isOrganizationInJurisdictionPreHandler = {
+  method: function (request, h) {
+    return isOrganizationInJurisdiction(request.pre?.organizationIds, request.params.organizationId, h);
+  },
+};
+
+export const isCampaignInJurisdictionPreHandler = {
+  method: async function (
+    request,
+    h,
+    dependencies = { getCampaignOrganizationId: usecases.getCampaignOrganizationId },
+  ) {
+    const { campaignId } = request.params;
+    const organizationId = await dependencies.getCampaignOrganizationId({ campaignId });
+    return isOrganizationInJurisdiction(request.pre?.organizationIds, organizationId, h);
+  },
+};
+
+function isOrganizationInJurisdiction(jurisdictionOrganizationIds = [], organizationId, h) {
+  if (!jurisdictionOrganizationIds.includes(organizationId)) {
+    return boom.forbidden();
+  }
+  return h.continue;
+}

Diff for: api/src/maddo/domain/models/CampaignParticipation.js

@@ -0,0 +1,24 @@
+class CampaignParticipation {
+  constructor({
+    id,
+    createdAt,
+    participantExternalId,
+    status,
+    sharedAt,
+    campaignId,
+    userId,
+    organizationLearnerId,
+  } = {}) {
+    this.id = id;
+    this.createdAt = createdAt;
+    this.status = status;
+    this.participantExternalId = participantExternalId;
+    this.sharedAt = sharedAt;
+    this.campaignId = campaignId;
+    this.userId = userId;
+    this.status = status;
+    this.organizationLearnerId = organizationLearnerId;
+  }
+}
+
+export { CampaignParticipation };

Diff for: api/src/maddo/domain/usecases/get-campaign-organization-id.js

@@ -0,0 +1,3 @@
+export async function getCampaignOrganizationId({ campaignId, campaignRepository }) {
+  return campaignRepository.getOrganizationId(campaignId);
+}

Diff for: api/src/maddo/domain/usecases/get-campaign-participations.js

@@ -0,0 +1,3 @@
+export async function getCampaignParticipations({ campaignId, campaignParticipationRepository }) {
+  return campaignParticipationRepository.findByCampaignId(campaignId);
+}

Diff for: api/src/maddo/domain/usecases/index.js

@@ -3,6 +3,7 @@ import { fileURLToPath } from 'node:url';
 
 import { injectDependencies } from '../../../shared/infrastructure/utils/dependency-injection.js';
 import { importNamedExportsFromDirectory } from '../../../shared/infrastructure/utils/import-named-exports-from-directory.js';
+import * as campaignParticipationRepository from '../../infrastructure/repositories/campaign-participation-repository.js';
 import * as campaignRepository from '../../infrastructure/repositories/campaign-repository.js';
 import * as clientApplicationRepository from '../../infrastructure/repositories/client-application-repository.js';
 import * as organizationRepository from '../../infrastructure/repositories/organization-repository.js';
@@ -13,6 +14,7 @@ const dependencies = {
   clientApplicationRepository,
   organizationRepository,
   campaignRepository,
+  campaignParticipationRepository,
 };
 
 const usecasesWithoutInjectedDependencies = {

Diff for: api/src/maddo/infrastructure/repositories/campaign-participation-repository.js

@@ -0,0 +1,26 @@
+import { knex } from '../../../../db/knex-database-connection.js';
+import { CampaignParticipation } from '../../domain/models/CampaignParticipation.js';
+
+export async function findByCampaignId(campaignId) {
+  const rawCampaigns = await knex
+    .select(
+      'id',
+      'createdAt',
+      'participantExternalId',
+      'status',
+      'sharedAt',
+      'deletedAt',
+      'deletedBy',
+      'campaignId',
+      'userId',
+      'organizationLearnerId',
+    )
+    .from('campaign-participations')
+    .where('campaignId', campaignId)
+    .orderBy('id');
+  return rawCampaigns.map(toDomain);
+}
+
+function toDomain(rawCampaignParticipation) {
+  return new CampaignParticipation(rawCampaignParticipation);
+}

Diff for: api/src/maddo/infrastructure/repositories/campaign-repository.js

@@ -22,6 +22,11 @@ export async function findByOrganizationId(organizationId) {
   return rawCampaigns.map(toDomain);
 }
 
+export async function getOrganizationId(campaignId) {
+  const [organizationId] = await knex.pluck('organizationId').from('campaigns').where('id', campaignId);
+  return organizationId;
+}
+
 function toDomain(rawCampaign) {
   return new Campaign(rawCampaign);
 }

Diff for: api/tests/maddo/application/acceptance/campaigns-routes_test.js

@@ -0,0 +1,60 @@
+import { CampaignParticipation } from '../../../../src/maddo/domain/models/CampaignParticipation.js';
+import { CampaignParticipationStatuses } from '../../../../src/prescription/shared/domain/constants.js';
+import {
+  createMaddoServer,
+  databaseBuilder,
+  expect,
+  generateValidRequestAuthorizationHeaderForApplication,
+} from '../../../test-helper.js';
+
+describe('Acceptance | Maddo | Route | Campaigns', function () {
+  let server;
+
+  beforeEach(async function () {
+    server = await createMaddoServer();
+  });
+
+  describe('GET /api/campaigns/{campaignId}/participations', function () {
+    it('returns the list of all participations of campaign with an HTTP status code 200', async function () {
+      // given
+      const orgaInJurisdiction = databaseBuilder.factory.buildOrganization({ name: 'orga-in-jurisdiction' });
+      databaseBuilder.factory.buildOrganization({ name: 'orga-not-in-jurisdiction' });
+
+      const tag = databaseBuilder.factory.buildTag();
+      databaseBuilder.factory.buildOrganizationTag({ organizationId: orgaInJurisdiction.id, tagId: tag.id });
+
+      const clientId = 'client';
+      databaseBuilder.factory.buildClientApplication({
+        clientId: 'client',
+        jurisdiction: { rules: [{ name: 'tags', value: [tag.name] }] },
+      });
+
+      const campaign = databaseBuilder.factory.buildCampaign({ organizationId: orgaInJurisdiction.id });
+      const participation1 = databaseBuilder.factory.buildCampaignParticipation({ campaignId: campaign.id });
+      const participation2 = databaseBuilder.factory.buildCampaignParticipation({
+        campaignId: campaign.id,
+        status: CampaignParticipationStatuses.STARTED,
+      });
+
+      await databaseBuilder.commit();
+
+      const options = {
+        method: 'GET',
+        url: `/api/campaigns/${campaign.id}/participations`,
+        headers: {
+          authorization: generateValidRequestAuthorizationHeaderForApplication(clientId, 'pix-client', 'campaigns'),
+        },
+      };
+
+      // when
+      const response = await server.inject(options);
+
+      // then
+      expect(response.statusCode).to.equal(200);
+      expect(response.result).to.deep.equal([
+        new CampaignParticipation(participation1),
+        new CampaignParticipation(participation2),
+      ]);
+    });
+  });
+});

Diff for: api/tests/maddo/application/acceptance/organizations-routes_test.js

@@ -92,7 +92,7 @@ describe('Acceptance | Maddo | Route | Organizations', function () {
         method: 'GET',
         url: `/api/organizations/${orgaInJurisdiction.id}/campaigns`,
         headers: {
-          authorization: generateValidRequestAuthorizationHeaderForApplication(clientId, 'pix-client', 'meta'),
+          authorization: generateValidRequestAuthorizationHeaderForApplication(clientId, 'pix-client', 'campaigns'),
         },
       };