[TECH] Récupérer les paliers acquis dans la page "Mes parcours" (PIX-8912)

Author: pix-service-auto-merge

api/lib/domain/read-models/CampaignParticipationOverview.js

@@ -10,40 +10,34 @@ class CampaignParticipationOverview {
     sharedAt,
     organizationName,
     status,
+    campaignId,
+    targetProfileId,
     campaignCode,
     campaignTitle,
     campaignArchivedAt,
     deletedAt,
     masteryRate,
+    totalStagesCount,
+    validatedStagesCount,
     validatedSkillsCount,
-    stageCollection,
   } = {}) {
     this.id = id;
     this.createdAt = createdAt;
+    this.targetProfileId = targetProfileId;
     this.isShared = status === SHARED;
     this.sharedAt = sharedAt;
     this.organizationName = organizationName;
     this.status = status;
+    this.campaignId = campaignId;
     this.campaignCode = campaignCode;
     this.campaignTitle = campaignTitle;
-    this.stageCollection = stageCollection;
     this.masteryRate = !_.isNil(masteryRate) ? Number(masteryRate) : null;
     this.validatedSkillsCount = validatedSkillsCount;
-
     const dates = [deletedAt, campaignArchivedAt].filter((a) => a != null);
-
+    this.totalStagesCount = totalStagesCount;
+    this.validatedStagesCount = validatedStagesCount;
     this.disabledAt = _.min(dates) || null;
   }
-
-  get validatedStagesCount() {
-    if (this.stageCollection.totalStages === 0 || !this.isShared) return null;
-
-    return this.stageCollection.getReachedStage(this.validatedSkillsCount, this.masteryRate * 100).reachedStage;
-  }
-
-  get totalStagesCount() {
-    return this.stageCollection.totalStages;
-  }
 }
 
 export { CampaignParticipationOverview };

api/lib/domain/services/stages/stage-and-stage-acquisition-comparison-service.js

@@ -0,0 +1,79 @@
+/**
+ * This service compares available and acquired stages for a campaign participation.
+ */
+class StagesAndAcquiredStagesComparison {
+  /**
+   * @type {Stage[]}
+   */
+  #acquiredStages = [];
+
+  /**
+   * @type {number}
+   */
+  #totalNumberOfStages;
+
+  /**
+   * @param {Stage[]} availableStages
+   * @param {StageAcquisition[]} stageAcquisitions
+   */
+  constructor(availableStages, stageAcquisitions) {
+    this.#totalNumberOfStages = availableStages.length;
+    this.#acquiredStages = availableStages
+      .sort(this.#sortByLevelOrThreshold)
+      .filter((availableStage) => stageAcquisitions.find(({ stageId }) => stageId === availableStage.id));
+  }
+
+  /**
+   * @param {Stage} previousStage
+   * @param {Stage} currentStage
+   *
+   * @returns {-1, 0, 1}
+   */
+  #sortByLevelOrThreshold(previousStage, currentStage) {
+    if (currentStage.isFirstSkill) {
+      return previousStage.isZeroStage ? -1 : 1;
+    }
+    return currentStage.level
+      ? previousStage.level - currentStage.level
+      : previousStage.threshold - currentStage.threshold;
+  }
+
+  /**
+   * @returns {number}
+   */
+  get reachedStageNumber() {
+    return this.#acquiredStages.length;
+  }
+
+  /**
+   * @returns {number}
+   */
+  get totalNumberOfStages() {
+    return this.#totalNumberOfStages;
+  }
+
+  /**
+   * @returns {Stage}
+   */
+  get reachedStage() {
+    return this.#acquiredStages[this.#acquiredStages.length - 1];
+  }
+}
+
+/**
+ * Compare stages and stages acquisitions to
+ * build stages information for a campaign.
+ *
+ * @param {Stage[]} availableStages
+ * @param {StageAcquisition[]} stageAcquisitions
+ * @returns {{reachedStage: Stage, reachedStageNumber: number, totalNumberOfStages: number}}
+ */
+export const compare = (availableStages, stageAcquisitions) => {
+  const stageComparison = new StagesAndAcquiredStagesComparison(availableStages, stageAcquisitions);
+
+  return {
+    reachedStageNumber: stageComparison.reachedStageNumber,
+    totalNumberOfStages: stageComparison.totalNumberOfStages,
+    reachedStage: stageComparison.reachedStage,
+  };
+};

api/lib/domain/usecases/find-user-campaign-participation-overviews.js

@@ -2,17 +2,50 @@ const findUserCampaignParticipationOverviews = async function ({
   userId,
   states,
   page,
+  stageRepository,
+  stageAcquisitionRepository,
   campaignParticipationOverviewRepository,
+  stageAndStageAcquisitionComparisonService,
 }) {
   const concatenatedStates = states ? [].concat(states) : undefined;
 
-  const campaignParticipationOverviews = await campaignParticipationOverviewRepository.findByUserIdWithFilters({
-    userId,
-    states: concatenatedStates,
-    page,
-  });
+  const { campaignParticipationOverviews, pagination } =
+    await campaignParticipationOverviewRepository.findByUserIdWithFilters({
+      userId,
+      states: concatenatedStates,
+      page,
+    });
 
-  return campaignParticipationOverviews;
+  // We deduplicate targetProfileIds in the case where several campaigns belong to the same target profile
+  const targetProfileIds = [...new Set(campaignParticipationOverviews.map(({ targetProfileId }) => targetProfileId))];
+  const campaignParticipationIds = campaignParticipationOverviews.map(({ id }) => id);
+
+  const [stages, acquiredStages] = await Promise.all([
+    stageRepository.getByTargetProfileIds(targetProfileIds),
+    stageAcquisitionRepository.getByCampaignParticipations(campaignParticipationIds),
+  ]);
+
+  const campaignParticipationOverviewsWithStages = campaignParticipationOverviews.map(
+    (campaignParticipationOverview) => {
+      const stagesForThisCampaign = stages.filter(
+        ({ targetProfileId }) => targetProfileId === campaignParticipationOverview.targetProfileId,
+      );
+      const acquiredStagesForThisCampaign = acquiredStages.filter(
+        ({ campaignParticipationId }) => campaignParticipationId === campaignParticipationOverview.id,
+      );
+      const stagesComparison = stageAndStageAcquisitionComparisonService.compare(
+        stagesForThisCampaign,
+        acquiredStagesForThisCampaign,
+      );
+
+      campaignParticipationOverview.totalStagesCount = stagesComparison.totalNumberOfStages;
+      campaignParticipationOverview.validatedStagesCount = stagesComparison.reachedStageNumber;
+
+      return campaignParticipationOverview;
+    },
+  );
+
+  return { campaignParticipationOverviews: campaignParticipationOverviewsWithStages, pagination };
 };
 
 export { findUserCampaignParticipationOverviews };

api/lib/domain/usecases/index.js

@@ -160,6 +160,8 @@ import * as skillRepository from '../../infrastructure/repositories/skill-reposi
 import * as smartRandom from '../../domain/services/algorithm-methods/smart-random.js';
 import * as stageCollectionForTargetProfileRepository from '../../infrastructure/repositories/target-profile-management/stage-collection-repository.js';
 import * as stageCollectionRepository from '../../infrastructure/repositories/user-campaign-results/stage-collection-repository.js';
+import * as stageRepository from '../../infrastructure/repositories/stage-repository.js';
+import * as stageAcquisitionRepository from '../../infrastructure/repositories/stage-acquisition-repository.js';
 import * as studentRepository from '../../infrastructure/repositories/student-repository.js';
 import * as supervisorAccessRepository from '../../infrastructure/repositories/supervisor-access-repository.js';
 import * as supOrganizationLearnerRepository from '../../../src/prescription/learner-management/infrastructure/repositories/sup-organization-learner-repository.js';
@@ -187,6 +189,8 @@ import * as userToCreateRepository from '../../infrastructure/repositories/user-
 import * as userValidator from '../validators/user-validator.js';
 import * as verifyCertificateCodeService from '../../domain/services/verify-certificate-code-service.js';
 import * as writeCsvUtils from '../../infrastructure/utils/csv/write-csv-utils.js';
+import * as writeOdsUtils from '../../infrastructure/utils/ods/write-ods-utils.js';
+import * as stageAndStageAcquisitionComparisonService from '../../domain/services/stages/stage-and-stage-acquisition-comparison-service.js';
 import { CampaignParticipationsStatsRepository as campaignParticipationsStatsRepository } from '../../infrastructure/repositories/campaign-participations-stats-repository.js';
 import { campaignParticipantActivityRepository } from '../../infrastructure/repositories/campaign-participant-activity-repository.js';
 import { campaignParticipationResultRepository } from '../../infrastructure/repositories/campaign-participation-result-repository.js';
@@ -212,7 +216,6 @@ function requirePoleEmploiNotifier() {
 }
 
 const dependencies = {
-  TargetProfileForSpecifierRepository,
   accountRecoveryDemandRepository,
   activityAnswerRepository,
   activityRepository,
@@ -222,6 +225,7 @@ const dependencies = {
   areaRepository,
   assessmentRepository,
   assessmentResultRepository,
+  attachableTargetProfileRepository,
   authenticationMethodRepository,
   authenticationServiceRegistry,
   authenticationSessionService,
@@ -234,7 +238,6 @@ const dependencies = {
   campaignAssessmentParticipationRepository,
   campaignAssessmentParticipationResultListRepository,
   campaignAssessmentParticipationResultRepository,
-  codeGenerator,
   campaignCollectiveResultRepository,
   campaignCreatorRepository,
   campaignCsvExportService,
@@ -282,6 +285,7 @@ const dependencies = {
   certificationResultRepository,
   challengeRepository,
   cleaCertifiedCandidateRepository,
+  codeGenerator,
   codeUtils,
   competenceEvaluationRepository,
   competenceMarkRepository,
@@ -334,9 +338,9 @@ const dependencies = {
   organizationPlacesCapacityRepository,
   organizationPlacesLotRepository,
   organizationRepository,
+  organizationsToAttachToTargetProfileRepository,
   organizationTagRepository,
   organizationValidator,
-  organizationsToAttachToTargetProfileRepository,
   participantResultRepository,
   participantResultsSharedRepository,
   participationsForCampaignManagementRepository,
@@ -371,15 +375,18 @@ const dependencies = {
   sessionsImportValidationService,
   skillRepository,
   smartRandom,
-  stageCollectionRepository,
+  stageAndStageAcquisitionComparisonService,
   stageCollectionForTargetProfileRepository,
+  stageCollectionRepository,
+  stageRepository,
+  stageAcquisitionRepository,
   studentRepository,
+  supervisorAccessRepository,
   supOrganizationLearnerRepository,
   supOrganizationParticipantRepository,
-  supervisorAccessRepository,
   tagRepository,
-  attachableTargetProfileRepository,
   targetProfileForAdminRepository,
+  TargetProfileForSpecifierRepository,
   targetProfileForUpdateRepository,
   targetProfileRepository,
   targetProfileShareRepository,
@@ -395,8 +402,8 @@ const dependencies = {
   tutorialRepository: repositories.tutorialRepository,
   userEmailRepository,
   userLoginRepository,
-  userOrgaSettingsRepository,
   userOrganizationsForAdminRepository,
+  userOrgaSettingsRepository,
   userRecommendedTrainingRepository: repositories.userRecommendedTrainingRepository,
   userReconciliationService,
   userRepository,
@@ -406,6 +413,7 @@ const dependencies = {
   userValidator,
   verifyCertificateCodeService,
   writeCsvUtils,
+  writeOdsUtils,
   attendanceSheetPdfUtils,
 };
 

api/lib/infrastructure/repositories/campaign-participation-overview-repository.js

@@ -1,10 +1,8 @@
 import { knex } from '../../../db/knex-database-connection.js';
 import { CampaignTypes } from '../../domain/models/CampaignTypes.js';
-import { CampaignParticipationOverview } from '../../domain/read-models/CampaignParticipationOverview.js';
 import { fetchPage } from '../utils/knex-utils.js';
-import bluebird from 'bluebird';
 import { CampaignParticipationStatuses } from '../../domain/models/CampaignParticipationStatuses.js';
-import * as stageCollectionRepository from './user-campaign-results/stage-collection-repository.js';
+import { CampaignParticipationOverview } from '../../domain/read-models/CampaignParticipationOverview.js';
 
 const findByUserIdWithFilters = async function ({ userId, states, page }) {
   const queryBuilder = _findByUserId({ userId });
@@ -15,10 +13,10 @@ const findByUserIdWithFilters = async function ({ userId, states, page }) {
 
   const { results, pagination } = await fetchPage(queryBuilder, page);
 
-  const campaignParticipationOverviews = await _toReadModel(results);
-
   return {
-    campaignParticipationOverviews,
+    campaignParticipationOverviews: results.map(
+      (campaignParticipationOverview) => new CampaignParticipationOverview(campaignParticipationOverview),
+    ),
     pagination,
   };
 };
@@ -93,14 +91,3 @@ function _sortEndedBySharedAt() {
 function _filterByStates(queryBuilder, states) {
   queryBuilder.whereIn('participationState', states);
 }
-
-function _toReadModel(campaignParticipationOverviews) {
-  return bluebird.mapSeries(campaignParticipationOverviews, async (data) => {
-    const stageCollection = await stageCollectionRepository.findStageCollection({ campaignId: data.campaignId });
-
-    return new CampaignParticipationOverview({
-      ...data,
-      stageCollection,
-    });
-  });
-}

api/lib/infrastructure/repositories/stage-repository.js

@@ -71,4 +71,16 @@ const getByCampaignParticipationId = async (campaignParticipationId, knexConnect
       .where('campaign-participations.id', campaignParticipationId),
   );
 
-export { getByCampaignIds, getByCampaignId, getByCampaignParticipationId };
+/**
+ * Return campaign stages for several target profile ids,
+ * this is convenient for campaign overviews
+ *
+ * @param {[number]} targetProfileIds
+ * @param knexConnection
+ *
+ * @returns Promise<Stage[]>
+ */
+const getByTargetProfileIds = async (targetProfileIds, knexConnection = knex) =>
+  toDomain(await knexConnection('stages').select('stages.*').whereIn('stages.targetProfileId', targetProfileIds));
+
+export { getByCampaignIds, getByCampaignId, getByCampaignParticipationId, getByTargetProfileIds };