#1929 - Current days of study/studybreaks count is 1 short of total

sources/packages/backend/apps/api/src/services/education-program-offering/_tests_/unit/education-program-offering.service-getCalculatedStudyBreaksAndWeeks.spec.ts

@@ -0,0 +1,247 @@
+import { OfferingStudyBreakCalculationContext } from "../../education-program-offering-validation.models";
+import { EducationProgramOfferingService } from "../../education-program-offering.service";
+
+describe("EducationProgramOfferingService-getCalculatedStudyBreaksAndWeeks", () => {
+  it("Should calculate funded study period and total days when study start and end study dates are available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "2023-01-01",
+        studyEndDate: "2023-01-10",
+        studyBreaks: [],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: 1,
+      fundedStudyPeriodDays: 10,
+      studyBreaks: [],
+      sumOfTotalEligibleBreakDays: 0,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: 10,
+      totalFundedWeeks: 2,
+      unfundedStudyPeriodDays: 0,
+    });
+  });
+
+  it("Should not calculate funded study period days and total days when study start date is not available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "",
+        studyEndDate: "2023-01-10",
+        studyBreaks: [],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: NaN,
+      fundedStudyPeriodDays: NaN,
+      studyBreaks: [],
+      sumOfTotalEligibleBreakDays: 0,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: NaN,
+      totalFundedWeeks: NaN,
+      unfundedStudyPeriodDays: NaN,
+    });
+  });
+
+  it("Should not calculate funded study period days and total days when study end date is not available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "2023-01-01",
+        studyEndDate: "",
+        studyBreaks: [],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: NaN,
+      fundedStudyPeriodDays: NaN,
+      studyBreaks: [],
+      sumOfTotalEligibleBreakDays: 0,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: NaN,
+      totalFundedWeeks: NaN,
+      unfundedStudyPeriodDays: NaN,
+    });
+  });
+
+  it("Should calculate study breaks when start and end study break dates available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "",
+        studyEndDate: "",
+        studyBreaks: [
+          {
+            breakStartDate: "2023-05-29",
+            breakEndDate: "2023-06-06",
+          },
+          {
+            breakStartDate: "2023-06-08",
+            breakEndDate: "2023-06-13",
+          },
+        ],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: NaN,
+      fundedStudyPeriodDays: NaN,
+      studyBreaks: [
+        {
+          breakDays: 9,
+          breakEndDate: "2023-06-06",
+          breakStartDate: "2023-05-29",
+          eligibleBreakDays: 9,
+          ineligibleBreakDays: 0,
+        },
+        {
+          breakDays: 6,
+          breakEndDate: "2023-06-13",
+          breakStartDate: "2023-06-08",
+          eligibleBreakDays: 6,
+          ineligibleBreakDays: 0,
+        },
+      ],
+      sumOfTotalEligibleBreakDays: 15,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: NaN,
+      totalFundedWeeks: NaN,
+      unfundedStudyPeriodDays: NaN,
+    });
+  });
+
+  it("Should not calculate study breaks when start study break date is not available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "",
+        studyEndDate: "",
+        studyBreaks: [
+          {
+            breakStartDate: "",
+            breakEndDate: "2023-06-06",
+          },
+        ],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: NaN,
+      fundedStudyPeriodDays: NaN,
+      studyBreaks: [],
+      sumOfTotalEligibleBreakDays: 0,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: NaN,
+      totalFundedWeeks: NaN,
+      unfundedStudyPeriodDays: NaN,
+    });
+  });
+
+  it("Should not calculate study breaks when end study break date is not available.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "",
+        studyEndDate: "",
+        studyBreaks: [
+          {
+            breakStartDate: "2023-06-06",
+            breakEndDate: "",
+          },
+        ],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: NaN,
+      fundedStudyPeriodDays: NaN,
+      studyBreaks: [],
+      sumOfTotalEligibleBreakDays: 0,
+      sumOfTotalIneligibleBreakDays: 0,
+      totalDays: NaN,
+      totalFundedWeeks: NaN,
+      unfundedStudyPeriodDays: NaN,
+    });
+  });
+
+  it("Should calculate eligible break days as a maximum of 21 days when a study break exceeds it.", () => {
+    //Arrange
+    const offeringStudyBreakCalculationContext: OfferingStudyBreakCalculationContext =
+      {
+        studyStartDate: "2023-05-29",
+        studyEndDate: "2023-09-29",
+        studyBreaks: [
+          {
+            breakStartDate: "2023-06-08",
+            breakEndDate: "2023-06-30",
+          },
+        ],
+      };
+
+    // Act
+    const calculatedStudyBreaksAndWeeks =
+      EducationProgramOfferingService.getCalculatedStudyBreaksAndWeeks(
+        offeringStudyBreakCalculationContext,
+      );
+
+    // Assert
+    expect(calculatedStudyBreaksAndWeeks).toStrictEqual({
+      allowableStudyBreaksDaysAmount: 12.4,
+      fundedStudyPeriodDays: 113.4,
+      studyBreaks: [
+        {
+          breakDays: 23,
+          breakEndDate: "2023-06-30",
+          breakStartDate: "2023-06-08",
+          eligibleBreakDays: 21,
+          ineligibleBreakDays: 2,
+        },
+      ],
+      sumOfTotalEligibleBreakDays: 21,
+      sumOfTotalIneligibleBreakDays: 2,
+      totalDays: 124,
+      totalFundedWeeks: 17,
+      unfundedStudyPeriodDays: 10.6,
+    });
+  });
+});

sources/packages/backend/libs/utilities/src/date-utils.ts

@@ -50,7 +50,7 @@ export const isAfter = (
 };
 
 /**
- * Difference in days between endDate and startDate (endDate-startDate).
+ * Difference in days between endDate and startDate (endDate-startDate) with start and end date inclusive.
  * @param endDate end date.
  * @param startDate start date.
  * @returns the date difference in days.
@@ -59,7 +59,7 @@ export const dateDifference = (
   endDate: string | Date,
   startDate: string | Date,
 ): number => {
-  return dayjs(endDate).diff(startDate, "days");
+  return dayjs(endDate).diff(startDate, "days") + 1;
 };
 
 /**

sources/packages/forms/src/form-definitions/educationprogramoffering.json

@@ -2771,7 +2771,7 @@
                       "requireDecimal": false,
                       "inputFormat": "plain",
                       "truncateMultipleSpaces": false,
-                      "calculateValue": "value = 0;\r\nif (row.breakStartDate && row.breakEndDate) {\r\n  const diffDays = moment(row.breakEndDate, \"YYYY-MM-DD\").diff(\r\n    moment(row.breakStartDate, \"YYYY-MM-DD\"),\r\n    \"days\"\r\n  );\r\n  value = Math.max(diffDays, 0);\r\n}\r\n",
+                      "calculateValue": "value = 0;\r\nif (row.breakStartDate && row.breakEndDate) {\r\n  const diffDays = moment(row.breakEndDate, \"YYYY-MM-DD\").diff(\r\n    moment(row.breakStartDate, \"YYYY-MM-DD\"),\r\n    \"days\"\r\n  ) + 1 ;\r\n  value = Math.max(diffDays, 0);\r\n}\r\n",
                       "calculateServer": true,
                       "validate": {
                         "required": true,