[TECH] Expliciter la définiton des quêtes (PIX-16445)

api/db/seeds/data/team-prescription/build-quests.js

@@ -1,5 +1,6 @@
 import { ATTESTATIONS } from '../../../../src/profile/domain/constants.js';
 import { REWARD_TYPES } from '../../../../src/quest/domain/constants.js';
+import { TYPES } from '../../../../src/quest/domain/models/Eligibility.js';
 import { COMPARISON } from '../../../../src/quest/domain/models/Quest.js';
 import { Assessment, CampaignParticipationStatuses, Membership } from '../../../../src/shared/domain/models/index.js';
 import { temporaryStorage } from '../../../../src/shared/infrastructure/key-value-storages/index.js';
@@ -157,22 +158,22 @@ const buildSixthGradeQuests = (
 ) => {
   const firstQuestRequirement = [
     {
-      type: 'organization',
+      type: TYPES.ORGANIZATION,
       data: {
         type: 'SCO',
       },
       comparison: COMPARISON.ALL,
     },
     {
-      type: 'organization',
+      type: TYPES.ORGANIZATION,
       data: {
         isManagingStudents: true,
         tags: [AEFE_TAG.name],
       },
       comparison: COMPARISON.ONE_OF,
     },
     {
-      type: 'campaignParticipations',
+      type: TYPES.CAMPAIGN_PARTICIPATIONS,
       data: {
         targetProfileIds: [firstTargetProfile.id],
       },
@@ -198,22 +199,22 @@ const buildSixthGradeQuests = (
 
   const secondQuestEligibilityRequirements = [
     {
-      type: 'organization',
+      type: TYPES.ORGANIZATION,
       data: {
         type: 'SCO',
       },
       comparison: COMPARISON.ALL,
     },
     {
-      type: 'organization',
+      type: TYPES.ORGANIZATION,
       data: {
         isManagingStudents: true,
         tags: [AEFE_TAG.name],
       },
       comparison: COMPARISON.ONE_OF,
     },
     {
-      type: 'campaignParticipations',
+      type: TYPES.CAMPAIGN_PARTICIPATIONS,
       data: {
         targetProfileIds: [secondTargetProfile.id, thirdTargetProfile.id],
       },

api/src/quest/domain/models/Eligibility.js

@@ -1,45 +1,16 @@
-export class Eligibility {
-  #campaignParticipations;
+export const TYPES = {
+  ORGANIZATION_LEARNER: 'organizationLearner',
+  ORGANIZATION: 'organization',
+  CAMPAIGN_PARTICIPATIONS: 'campaignParticipations',
+};
 
+export class Eligibility {
   constructor({ organizationLearner, organization, campaignParticipations = [] }) {
     this.organizationLearner = {
+      id: organizationLearner?.id,
       MEFCode: organizationLearner?.MEFCode,
     };
     this.organization = organization;
-    this.#campaignParticipations = campaignParticipations;
-  }
-
-  get campaignParticipations() {
-    return {
-      targetProfileIds: this.#campaignParticipations.map(({ targetProfileId }) => targetProfileId),
-    };
-  }
-
-  set campaignParticipations(campaignParticipations) {
-    this.#campaignParticipations = campaignParticipations;
-  }
-
-  hasCampaignParticipation(campaignParticipationId) {
-    return Boolean(
-      this.#campaignParticipations.find(
-        (campaignParticipation) => campaignParticipation.id === campaignParticipationId,
-      ),
-    );
-  }
-
-  hasCampaignParticipationForTargetProfileId(targetProfileId) {
-    return Boolean(
-      this.#campaignParticipations.find(
-        (campaignParticipation) => campaignParticipation.targetProfileId === targetProfileId,
-      ),
-    );
-  }
-
-  getTargetProfileForCampaignParticipation(campaignParticipationId) {
-    const campaignParticipation = this.#campaignParticipations.find(
-      (campaignParticipation) => campaignParticipation.id === campaignParticipationId,
-    );
-
-    return campaignParticipation?.targetProfileId ?? null;
+    this.campaignParticipations = campaignParticipations;
   }
 }

api/src/quest/domain/models/Quest.js

@@ -1,4 +1,5 @@
 import { KnowledgeElement } from '../../../shared/domain/models/index.js';
+import { TYPES as ELIGIBILITY_TYPES } from './Eligibility.js';
 
 export const COMPARISON = {
   ALL: 'all',
@@ -15,26 +16,76 @@ class Quest {
     this.successRequirements = successRequirements;
   }
 
+  /**
+   * @param {Eligibility} eligibility
+   * @param {number} campaignParticipationId
+   */
+  isGrantedWithParticipationId({ eligibility, campaignParticipationId }) {
+    const criteria = this.eligibilityRequirements.filter(
+      (eligibilityRequirement) => eligibilityRequirement.type === ELIGIBILITY_TYPES.CAMPAIGN_PARTICIPATIONS,
+    );
+
+    if (criteria.length === 0) return true;
+
+    const campaignParticipation = eligibility.campaignParticipations.find(
+      (campaignParticipation) => campaignParticipation.id === campaignParticipationId,
+    );
+
+    for (const criterion of criteria) {
+      const alterKey = criterion.data.targetProfileIds !== undefined ? 'targetProfileIds' : 'targetProfileId';
+
+      const isQuestRelatedToCampaignParticipationId = criterion.data[alterKey].includes(
+        campaignParticipation.targetProfileId,
+      );
+
+      if (isQuestRelatedToCampaignParticipationId) return true;
+    }
+
+    return false;
+  }
+
   /**
    * @param {Eligibility} eligibility
    */
   isEligible(eligibility) {
+    if (this.eligibilityRequirements.length === 0) return false;
+
     return this.eligibilityRequirements.every((eligibilityRequirement) =>
       this.#checkRequirement(eligibilityRequirement, eligibility),
     );
   }
 
+  #checkCriterion({ criterion, eligibilityData }) {
+    if (Array.isArray(criterion)) {
+      if (Array.isArray(eligibilityData)) {
+        return criterion.every((valueToTest) => eligibilityData.includes(valueToTest));
+      }
+      return criterion.some((valueToTest) => valueToTest === eligibilityData);
+    }
+    return eligibilityData === criterion;
+  }
+
   #checkRequirement(eligibilityRequirement, eligibility) {
-    const comparaisonFunction = eligibilityRequirement.comparison === COMPARISON.ONE_OF ? 'some' : 'every';
+    const comparisonFunction = eligibilityRequirement.comparison === COMPARISON.ONE_OF ? 'some' : 'every';
 
-    return Object.keys(eligibilityRequirement.data)[comparaisonFunction]((key) => {
-      const eligibilityData = eligibility[eligibilityRequirement.type][key];
-      const criterion = eligibilityRequirement.data[key];
+    if (Array.isArray(eligibility[eligibilityRequirement.type])) {
+      return eligibility[eligibilityRequirement.type].some((item) => {
+        return Object.keys(eligibilityRequirement.data)[comparisonFunction]((key) => {
+          // TODO: Dés que les quêtes ont été mises à jour il faudra retirer cette ligne
+          const alterKey = key === 'targetProfileIds' ? 'targetProfileId' : key;
+          return this.#checkCriterion({
+            criterion: eligibilityRequirement.data[key],
+            eligibilityData: item[alterKey],
+          });
+        });
+      });
+    }
 
-      if (Array.isArray(criterion)) {
-        return criterion.every((valueToTest) => eligibilityData.includes(valueToTest));
-      }
-      return eligibilityData === criterion;
+    return Object.keys(eligibilityRequirement.data)[comparisonFunction]((key) => {
+      return this.#checkCriterion({
+        criterion: eligibilityRequirement.data[key],
+        eligibilityData: eligibility[eligibilityRequirement.type][key],
+      });
     });
   }
 

api/src/quest/domain/usecases/get-quest-results-for-campaign-participation.js

@@ -1,105 +1,33 @@
-const getEligibilityForThisCampaignParticipation = async (eligibilityRepository, userId, campaignParticipationId) => {
-  const eligibilities = await eligibilityRepository.find({ userId });
-  return eligibilities.find((e) => e.hasCampaignParticipation(campaignParticipationId));
-};
-
-const getTargetProfileRequirementsPerQuest = (quests) =>
-  quests
-    .map((quest) => {
-      const campaignParticipationsRequirement = quest.eligibilityRequirements.find(
-        (requirement) => requirement.type === 'campaignParticipations',
-      );
-      if (campaignParticipationsRequirement && campaignParticipationsRequirement.data.targetProfileIds)
-        return campaignParticipationsRequirement.data.targetProfileIds;
-    })
-    .filter(Boolean);
-
-/**
- * This function retrieves the target profiles we should use for the current participation.
- * It first retrieves the target profile for the current campaign participation.
- * Then it retrieves the target profile requirements for each quest.
- * It filters the target profile requirements to only keep the ones that contain the target profile for the current participation.
- * It checks if the user has participated in campaigns linked to all the target profiles present in the quest requirements.
- * If the user has participated in campaigns linked to all the target profiles present in the quest requirements, it returns the target profile requirements containing the target profile for the current participation.
- * If not, it returns the target profile for the current participation.
- *
- * @param campaignParticipationRepository
- * @param {number} campaignParticipationId
- * @param {[Quest]} quests
- * @param {Eligibility} eligibility
- * @returns {Promise<[number]>}
- */
-const getTargetProfilesForThisCampaignParticipation = async ({
-  campaignParticipationRepository,
-  campaignParticipationId,
-  quests,
-  eligibility,
-}) => {
-  const { targetProfileId: targetProfileForThisParticipation } =
-    await campaignParticipationRepository.getCampaignByParticipationId({
-      campaignParticipationId,
-    });
-
-  const targetProfileRequirementsPerQuest = getTargetProfileRequirementsPerQuest(quests);
-
-  const targetProfileRequirementsContainingTargetProfileForCurrentParticipation =
-    targetProfileRequirementsPerQuest.filter((targetProfileIds) =>
-      targetProfileIds.includes(targetProfileForThisParticipation),
-    );
-
-  const targetProfileRequirementContainingTargetProfileForCurrentParticipationWithParticipationForEveryTargetProfile =
-    targetProfileRequirementsContainingTargetProfileForCurrentParticipation.find((targetProfileRequirement) =>
-      targetProfileRequirement.every((targetProfileId) =>
-        eligibility.hasCampaignParticipationForTargetProfileId(targetProfileId),
-      ),
-    );
-
-  return (
-    targetProfileRequirementContainingTargetProfileForCurrentParticipationWithParticipationForEveryTargetProfile ?? [
-      targetProfileForThisParticipation,
-    ]
-  );
-};
+import * as campaignParticipationRepository from '../../../prescription/campaign-participation/infrastructure/repositories/campaign-participation-repository.js';
 
 export const getQuestResultsForCampaignParticipation = async ({
   userId,
   campaignParticipationId,
+  dirtyImportcampaignParticipationRepository = campaignParticipationRepository,
   questRepository,
   eligibilityRepository,
   rewardRepository,
-  campaignParticipationRepository,
 }) => {
   const quests = await questRepository.findAll();
 
   if (quests.length === 0) {
     return [];
   }
 
-  const eligibility = await getEligibilityForThisCampaignParticipation(
-    eligibilityRepository,
-    userId,
-    campaignParticipationId,
-  );
+  const campaignParticipation = await dirtyImportcampaignParticipationRepository.get(campaignParticipationId);
 
-  if (!eligibility) return [];
+  const eligibilities = await eligibilityRepository.find({ userId });
 
-  const targetProfileIdsForThisCampaignParticipation = await getTargetProfilesForThisCampaignParticipation({
-    campaignParticipationRepository,
-    campaignParticipationId,
-    quests,
-    eligibility,
-  });
+  const eligibility = eligibilities.find(
+    (eligibility) => eligibility.organizationLearner.id === campaignParticipation.organizationLearnerId,
+  );
 
-  eligibility.campaignParticipations = targetProfileIdsForThisCampaignParticipation.map((targetProfileId) => ({
-    targetProfileId,
-  }));
+  const questsRelatedToCampaignParticipation = quests.filter(
+    (q) => q.isGrantedWithParticipationId({ eligibility, campaignParticipationId }) && q.isEligible(eligibility),
+  );
 
   const questResults = [];
-  for (const quest of quests) {
-    const isEligibleForQuest = quest.isEligible(eligibility);
-
-    if (!isEligibleForQuest) continue;
-
+  for (const quest of questsRelatedToCampaignParticipation) {
     const questResult = await rewardRepository.getByQuestAndUserId({ userId, quest });
     questResults.push(questResult);
   }

api/tests/quest/acceptance/application/quest-route_test.js

@@ -43,6 +43,9 @@ describe('Quest | Acceptance | Application | Quest Route ', function () {
 
       // then
       expect(response.statusCode).to.equal(200);
+      // TODO: it seems to be 0 if we refer to unit test of
+      // Quest | Unit | Domain | Usecases | getQuestResultsForCampaignParticipation
+      // should return empty array when there is no eligibility ? So can you explain this please
       expect(response.result.data).to.have.lengthOf(1);
     });
   });

api/tests/quest/integration/domain/usecases/get-quest-results-for-campaign-participation_test.js

@@ -61,7 +61,14 @@ describe('Quest | Integration | Domain | Usecases | getQuestResultsForCampaignPa
           {
             type: 'campaignParticipations',
             data: {
-              targetProfileIds: [firstTargetProfile.id, secondTargetProfile.id],
+              targetProfileIds: [firstTargetProfile.id],
+            },
+            comparison: COMPARISON.ALL,
+          },
+          {
+            type: 'campaignParticipations',
+            data: {
+              targetProfileIds: [secondTargetProfile.id],
             },
             comparison: COMPARISON.ALL,
           },
@@ -146,7 +153,21 @@ describe('Quest | Integration | Domain | Usecases | getQuestResultsForCampaignPa
           {
             type: 'campaignParticipations',
             data: {
-              targetProfileIds: [firstTargetProfile.id, secondTargetProfile.id, thirdTargetProfile.id],
+              targetProfileIds: [firstTargetProfile.id],
+            },
+            comparison: COMPARISON.ALL,
+          },
+          {
+            type: 'campaignParticipations',
+            data: {
+              targetProfileIds: [secondTargetProfile.id],
+            },
+            comparison: COMPARISON.ALL,
+          },
+          {
+            type: 'campaignParticipations',
+            data: {
+              targetProfileIds: [thirdTargetProfile.id],
             },
             comparison: COMPARISON.ALL,
           },