refactor(api): add model DataForQuest that aggregates Eligibility and Success models

Author: frinyvonnick

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

@@ -0,0 +1,58 @@
+export class DataForQuest {
+  #success;
+  #eligibility;
+
+  constructor({ eligibility, success = null }) {
+    this.#success = success;
+    this.#eligibility = eligibility;
+  }
+
+  get eligibility() {
+    return Object.freeze(this.#eligibility);
+  }
+
+  get success() {
+    return Object.freeze(this.#success);
+  }
+
+  set success(value) {
+    this.#success = value;
+  }
+
+  /*
+   * Eligibility
+   */
+
+  get organizationLearner() {
+    return this.#eligibility.organizationLearner;
+  }
+
+  get organization() {
+    return this.#eligibility.organization;
+  }
+
+  get campaignParticipations() {
+    return this.#eligibility.campaignParticipations;
+  }
+
+  buildDataForQuestScopedByCampaignParticipationId(...args) {
+    const eligibility = this.#eligibility.buildEligibilityScopedByCampaignParticipationId(...args);
+    return new DataForQuest({ eligibility, success: this.#success });
+  }
+
+  hasCampaignParticipation(...args) {
+    return this.#eligibility.hasCampaignParticipation(...args);
+  }
+
+  /*
+   * Success
+   */
+
+  get knowledgeElements() {
+    return this.#success.knowledgeElements;
+  }
+
+  getMasteryPercentageForSkills(...args) {
+    return this.#success.getMasteryPercentageForSkills(...args);
+  }
+}

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

@@ -5,8 +5,7 @@ import {
   TYPES as _REQUIREMENT_TYPES,
 } from './Requirement.js';
 /**
- * @typedef {import ('./Eligibility.js').Eligibility} Eligibility
- * @typedef {import ('./Success.js').Success} Success
+ * @typedef {import ('./DataForQuest.js').DataForQuest} DataForQuest
  */
 
 export const REQUIREMENT_COMPARISONS = _REQUIREMENT_COMPARISONS;
@@ -34,22 +33,20 @@ class Quest {
     });
   }
 
-  // je crois que ce getter sert à rien
   get eligibilityRequirements() {
     return this.#eligibilityRequirements.data;
   }
 
-  // je crois que ce getter sert à rien
   get successRequirements() {
     return this.#successRequirements.data;
   }
 
   /**
-   * @param {Eligibility} eligibility
+   * @param {DataForQuest} data
    * @param {number} campaignParticipationId
    */
-  isCampaignParticipationContributingToQuest({ eligibility, campaignParticipationId }) {
-    const scopedEligibility = eligibility.buildEligibilityScopedByCampaignParticipationId({ campaignParticipationId });
+  isCampaignParticipationContributingToQuest({ data, campaignParticipationId }) {
+    const scopedData = data.buildDataForQuestScopedByCampaignParticipationId({ campaignParticipationId });
 
     const campaignParticipationRequirements = this.#flattenRequirementsByType(
       this.#eligibilityRequirements.data,
@@ -61,24 +58,24 @@ class Quest {
         data: campaignParticipationRequirements,
         comparison: REQUIREMENT_COMPARISONS.ONE_OF,
       });
-      return a.isFulfilled(scopedEligibility);
+      return a.isFulfilled(scopedData);
     }
 
     return false;
   }
 
   /**
-   * @param {Eligibility} eligibility
+   * @param {DataForQuest} data
    */
-  isEligible(eligibility) {
-    return this.#eligibilityRequirements.isFulfilled(eligibility);
+  isEligible(data) {
+    return this.#eligibilityRequirements.isFulfilled(data);
   }
 
   /**
-   * @param {Success} success
+   * @param {DataForQuest} data
    */
-  isSuccessful(success) {
-    return this.#successRequirements.isFulfilled(success);
+  isSuccessful(data) {
+    return this.#successRequirements.isFulfilled(data);
   }
 
   toDTO() {

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

@@ -1,3 +1,5 @@
+import { DataForQuest } from '../models/DataForQuest.js';
+
 export const getQuestResultsForCampaignParticipation = async ({
   userId,
   campaignParticipationId,
@@ -12,20 +14,21 @@ export const getQuestResultsForCampaignParticipation = async ({
   }
 
   const eligibilities = await eligibilityRepository.find({ userId });
-  const eligibility = eligibilities.find((eligibility) =>
-    eligibility.hasCampaignParticipation(campaignParticipationId),
-  );
-  if (!eligibility) {
+  const dataForQuest = eligibilities
+    .map((eligibility) => new DataForQuest({ eligibility }))
+    .find((dataForQuest) => dataForQuest.hasCampaignParticipation(campaignParticipationId));
+
+  if (!dataForQuest) {
     return [];
   }
 
   const questsRelatedToCampaignParticipation = quests.filter((q) =>
-    q.isCampaignParticipationContributingToQuest({ eligibility, campaignParticipationId }),
+    q.isCampaignParticipationContributingToQuest({ data: dataForQuest, campaignParticipationId }),
   );
 
   const questResults = [];
   for (const quest of questsRelatedToCampaignParticipation) {
-    const isEligible = quest.isEligible(eligibility);
+    const isEligible = quest.isEligible(dataForQuest);
     if (!isEligible) continue;
     const questResult = await rewardRepository.getByQuestAndUserId({ userId, quest });
     questResults.push(questResult);

api/src/quest/domain/usecases/reward-user.js

@@ -1,3 +1,5 @@
+import { DataForQuest } from '../models/DataForQuest.js';
+
 export const rewardUser = async ({
   userId,
   questRepository,
@@ -20,9 +22,11 @@ export const rewardUser = async ({
   const rewardIds = rewards.map((reward) => reward.rewardId);
 
   for (const quest of quests) {
-    const isEligibleForQuest = eligibilities.some((eligibility) => quest.isEligible(eligibility));
+    const dataForQuest = eligibilities
+      .map((eligibility) => new DataForQuest({ eligibility }))
+      .find((dataForQuest) => quest.isEligible(dataForQuest));
 
-    if (!isEligibleForQuest) {
+    if (!dataForQuest) {
       continue;
     }
 
@@ -31,7 +35,8 @@ export const rewardUser = async ({
     }
 
     const success = await successRepository.find({ userId });
-    const userHasSucceedQuest = quest.isSuccessful(success);
+    dataForQuest.success = success;
+    const userHasSucceedQuest = quest.isSuccessful(dataForQuest);
 
     if (userHasSucceedQuest) {
       await rewardRepository.reward({ userId, rewardId: quest.rewardId });

api/tests/quest/unit/domain/models/Quest_test.js

@@ -1,3 +1,4 @@
+import { DataForQuest } from '../../../../../src/quest/domain/models/DataForQuest.js';
 import { Eligibility } from '../../../../../src/quest/domain/models/Eligibility.js';
 import {
   CRITERION_COMPARISONS,
@@ -29,8 +30,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
       });
 
       const eligibility = new Eligibility({ organization: { type: 'SCO' } });
+      const data = new DataForQuest({ eligibility });
 
-      expect(quest.isEligible(eligibility)).to.be.true;
+      expect(quest.isEligible(data)).to.be.true;
     });
 
     it('return false', function () {
@@ -51,8 +53,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
       });
 
       const eligibility = new Eligibility({ organization: { type: 'PRO' } });
+      const data = new DataForQuest({ eligibility });
 
-      expect(quest.isEligible(eligibility)).to.be.false;
+      expect(quest.isEligible(data)).to.be.false;
     });
   });
 
@@ -71,8 +74,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { status: KnowledgeElement.StatusType.VALIDATED, skillId: 'skillD' },
         ],
       });
+      const data = new DataForQuest({ success });
 
-      expect(quest.isSuccessful(success)).to.be.true;
+      expect(quest.isSuccessful(data)).to.be.true;
     });
 
     it('returns true when all requirements are met', function () {
@@ -104,8 +108,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { status: KnowledgeElement.StatusType.VALIDATED, skillId: 'skillD' },
         ],
       });
+      const data = new DataForQuest({ success });
 
-      expect(quest.isSuccessful(success)).to.be.true;
+      expect(quest.isSuccessful(data)).to.be.true;
     });
 
     it('returns false when at least one requirement is not met', function () {
@@ -137,8 +142,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { status: KnowledgeElement.StatusType.VALIDATED, skillId: 'skillD' },
         ],
       });
+      const data = new DataForQuest({ success });
 
-      expect(quest.isSuccessful(success)).to.be.false;
+      expect(quest.isSuccessful(data)).to.be.false;
     });
 
     it('returns false when none of the requirements are met', function () {
@@ -170,8 +176,9 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { status: KnowledgeElement.StatusType.INVALIDATED, skillId: 'skillD' },
         ],
       });
+      const data = new DataForQuest({ success });
 
-      expect(quest.isSuccessful(success)).to.be.false;
+      expect(quest.isSuccessful(data)).to.be.false;
     });
   });
 
@@ -219,12 +226,13 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { id: 10, targetProfileId: 1 },
           { id: 11, targetProfileId: 3 },
         ];
-        const eligibilityData = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const eligibility = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const data = new DataForQuest({ eligibility });
         const campaignParticipationIdToCheck = 11;
 
         // when
         const isContributing = quest.isCampaignParticipationContributingToQuest({
-          eligibility: eligibilityData,
+          data,
           campaignParticipationId: campaignParticipationIdToCheck,
         });
 
@@ -271,12 +279,13 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
           { id: 10, targetProfileId: 1 },
           { id: 11, targetProfileId: 3 },
         ];
-        const eligibilityData = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const eligibility = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const data = new DataForQuest({ eligibility });
         const campaignParticipationIdToCheck = 10;
 
         // when
         const isContributing = quest.isCampaignParticipationContributingToQuest({
-          eligibility: eligibilityData,
+          data,
           campaignParticipationId: campaignParticipationIdToCheck,
         });
 
@@ -312,12 +321,13 @@ describe('Quest | Unit | Domain | Models | Quest ', function () {
         ];
         const quest = new Quest({ eligibilityRequirements, successRequirements: [] });
         const campaignParticipations = [{ id: 10 }, { id: 11 }];
-        const eligibilityData = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const eligibility = new Eligibility({ organization, organizationLearner, campaignParticipations });
+        const data = new DataForQuest({ eligibility });
         const campaignParticipationIdToCheck = 10;
 
         // when
         const isContributing = quest.isCampaignParticipationContributingToQuest({
-          eligibility: eligibilityData,
+          data,
           campaignParticipationId: campaignParticipationIdToCheck,
         });