chore: simplify assignment export logic (#134)

arora-r · MmagdyHafezZ · web-flow · commit 74d3bd96204b · 2025-10-09T06:43:06.000-04:00
* featue: authors can set cooldown periods for learner attempts

* adding migration.sql, fixing imports, hiding retakeAttemptCoolDownMinutes if attemptsBeforeCoolDown is 0.

* Delete apps/api/prisma/migrations/20250925181313_assignment_cooldown/migration.sql

* chore: simplify assignment export logic

* fix: add versioning change

---------

Co-authored-by: Magdy-Hafez#030901 &lt;113151015+MmagdyHafezZ@users.noreply.github.com&gt;
Co-authored-by: MmagdyhafezZ &lt;magdy.hafez9123@gmail.com&gt;
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -3,7 +3,7 @@
     "files": null,
     "lines": null
   },
-  "generated_at": "2025-10-09T10:00:02Z",
+  "generated_at": "2025-10-09T10:36:06Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
diff --git a/apps/api/src/api/assignment/v2/services/version-management.service.ts b/apps/api/src/api/assignment/v2/services/version-management.service.ts
@@ -645,7 +645,8 @@ export class VersionManagementService {
             graded: versionToRestore.graded,
             numAttempts: versionToRestore.numAttempts,
             attemptsBeforeCoolDown: versionToRestore.attemptsBeforeCoolDown,
-            retakeAttemptCoolDownMinutes: versionToRestore.retakeAttemptCoolDownMinutes,
+            retakeAttemptCoolDownMinutes:
+              versionToRestore.retakeAttemptCoolDownMinutes,
             allotedTimeMinutes: versionToRestore.allotedTimeMinutes,
             attemptsPerTimeRange: versionToRestore.attemptsPerTimeRange,
             attemptsTimeRangeHours: versionToRestore.attemptsTimeRangeHours,
@@ -1643,7 +1644,8 @@ export class VersionManagementService {
             graded: sourceVersion.graded,
             numAttempts: sourceVersion.numAttempts,
             attemptsBeforeCoolDown: sourceVersion.attemptsBeforeCoolDown,
-            retakeAttemptCoolDownMinutes: sourceVersion.retakeAttemptCoolDownMinutes,
+            retakeAttemptCoolDownMinutes:
+              sourceVersion.retakeAttemptCoolDownMinutes,
             allotedTimeMinutes: sourceVersion.allotedTimeMinutes,
             attemptsPerTimeRange: sourceVersion.attemptsPerTimeRange,
             attemptsTimeRangeHours: sourceVersion.attemptsTimeRangeHours,
@@ -2105,9 +2107,11 @@ export class VersionManagementService {
             numAttempts:
               draftData.assignmentData.numAttempts ?? assignment.numAttempts,
             attemptsBeforeCoolDown:
-              draftData.assignmentData.attemptsBeforeCoolDown ?? assignment.attemptsBeforeCoolDown,
+              draftData.assignmentData.attemptsBeforeCoolDown ??
+              assignment.attemptsBeforeCoolDown,
             retakeAttemptCoolDownMinutes:
-              draftData.assignmentData.retakeAttemptCoolDownMinutes ?? assignment.retakeAttemptCoolDownMinutes,
+              draftData.assignmentData.retakeAttemptCoolDownMinutes ??
+              assignment.retakeAttemptCoolDownMinutes,
             allotedTimeMinutes:
               draftData.assignmentData.allotedTimeMinutes ??
               assignment.allotedTimeMinutes,
diff --git a/apps/web/app/author/[assignmentId]/review/page.tsx b/apps/web/app/author/[assignmentId]/review/page.tsx
@@ -33,6 +33,23 @@ import {
 } from "@heroicons/react/24/solid";
 import { QuestionAuthorStore } from "@/config/types";
 import ExportModal, { ExportOptions } from "../../(components)/ExportModal";
+import { omit } from "../../../../lib/utils";
+
+const CONFIG_KEYS_TO_OMIT = [
+  "errors",
+  "updatedAt",
+  "id",
+  "name",
+  "introduction",
+  "instructions",
+  "gradingCriteriaOverview",
+  "type",
+  "questionOrder",
+  "published",
+  "languageCode",
+  "currentVersionId",
+  "questions",
+];
 
 // Helper function to determine if a validation error is question-related
 const isQuestionRelatedValidationError = (message: string): boolean => {
@@ -744,31 +761,7 @@ function Component() {
   const [isExportModalOpen, setIsExportModalOpen] = useState(false);
   const [isIssuesModalOpen, setIsIssuesModalOpen] = useState(false);
 
-  const [
-    graded,
-    allotedTimeMinutes,
-    timeEstimateMinutes,
-    numAttempts,
-    attemptsBeforeCoolDown,
-    retakeAttemptCoolDownMinutes,
-    passingGrade,
-    displayOrder,
-    questionDisplay,
-    numberOfQuestionsPerAttempt,
-    strictTimeLimit,
-  ] = useAssignmentConfig((state) => [
-    state.graded,
-    state.allotedTimeMinutes,
-    state.timeEstimateMinutes,
-    state.numAttempts,
-    state.attemptsBeforeCoolDown,
-    state.retakeAttemptCoolDownMinutes,
-    state.passingGrade,
-    state.displayOrder,
-    state.questionDisplay,
-    state.numberOfQuestionsPerAttempt,
-    state.strictTimeLimit,
-  ]);
+  const assignmentConfig = useAssignmentConfig((state) => state);
 
   const [
     introduction,
@@ -1124,19 +1117,7 @@ function Component() {
       }
 
       if (exportOptions.includeConfig) {
-        exportData.config = {
-          graded,
-          allotedTimeMinutes,
-          timeEstimateMinutes,
-          numAttempts,
-          attemptsBeforeCoolDown,
-          retakeAttemptCoolDownMinutes,
-          passingGrade,
-          displayOrder,
-          questionDisplay,
-          numberOfQuestionsPerAttempt,
-          strictTimeLimit,
-        };
+        exportData.config = omit(assignmentConfig, CONFIG_KEYS_TO_OMIT);
       }
 
       if (exportOptions.includeFeedbackConfig) {
@@ -1698,7 +1679,7 @@ function Component() {
                     <ChangeComparison
                       label="Assignment Type"
                       before={originalAssignment.graded ? "Graded" : "Practice"}
-                      after={graded ? "Graded" : "Practice"}
+                      after={assignmentConfig.graded ? "Graded" : "Practice"}
                       onNavigate={() =>
                         router.push(`/author/${activeAssignmentId}/config`)
                       }
@@ -1714,8 +1695,8 @@ function Component() {
                           : "No time limit"
                       }
                       after={
-                        allotedTimeMinutes
-                          ? `${allotedTimeMinutes} minutes`
+                        assignmentConfig.allotedTimeMinutes
+                          ? `${assignmentConfig.allotedTimeMinutes} minutes`
                           : "No time limit"
                       }
                     />
@@ -1730,8 +1711,8 @@ function Component() {
                           : "Not set"
                       }
                       after={
-                        timeEstimateMinutes
-                          ? `${timeEstimateMinutes} minutes`
+                        assignmentConfig.timeEstimateMinutes
+                          ? `${assignmentConfig.timeEstimateMinutes} minutes`
                           : "Not set"
                       }
                     />
@@ -1745,39 +1726,59 @@ function Component() {
                           ? "Unlimited"
                           : originalAssignment.numAttempts
                       }
-                      after={numAttempts === -1 ? "Unlimited" : numAttempts}
+                      after={
+                        assignmentConfig.numAttempts === -1
+                          ? "Unlimited"
+                          : assignmentConfig.numAttempts
+                      }
                     />
                   )}
 
                   {changes.attemptsBeforeCoolDown && (
                     <ChangeComparison
                       label="Number of Attempts Before Cooldown Period"
                       before={originalAssignment.attemptsBeforeCoolDown}
-                      after={attemptsBeforeCoolDown}
+                      after={assignmentConfig.attemptsBeforeCoolDown}
                     />
                   )}
 
                   {changes.retakeAttemptCoolDownMinutes && (
                     <ChangeComparison
                       label="Number of Minutes Learners Must Wait Between Attempts"
                       before={originalAssignment.retakeAttemptCoolDownMinutes}
-                      after={retakeAttemptCoolDownMinutes}
+                      after={assignmentConfig.retakeAttemptCoolDownMinutes}
+                    />
+                  )}
+
+                  {changes.attemptsBeforeCoolDown && (
+                    <ChangeComparison
+                      label="Number of Attempts Before Cooldown Period"
+                      before={originalAssignment.attemptsBeforeCoolDown}
+                      after={changes.attemptsBeforeCoolDown}
+                    />
+                  )}
+
+                  {changes.retakeAttemptCoolDownMinutes && (
+                    <ChangeComparison
+                      label="Number of Minutes Learners Must Wait Between Attempts"
+                      before={originalAssignment.retakeAttemptCoolDownMinutes}
+                      after={changes.retakeAttemptCoolDownMinutes}
                     />
                   )}
 
                   {changes.passingGrade && (
                     <ChangeComparison
                       label="Passing Grade"
                       before={`${originalAssignment.passingGrade}%`}
-                      after={`${passingGrade}%`}
+                      after={`${assignmentConfig.passingGrade}%`}
                     />
                   )}
 
                   {changes.displayOrder && (
                     <ChangeComparison
                       label="Display Order"
                       before={originalAssignment.displayOrder}
-                      after={displayOrder}
+                      after={assignmentConfig.displayOrder}
                     />
                   )}
 
@@ -1788,15 +1789,18 @@ function Component() {
                         /_/g,
                         " ",
                       )}
-                      after={questionDisplay?.replace(/_/g, " ")}
+                      after={assignmentConfig.questionDisplay?.replace(
+                        /_/g,
+                        " ",
+                      )}
                     />
                   )}
 
                   {changes.numberOfQuestionsPerAttempt && (
                     <ChangeComparison
                       label="Questions Per Attempt"
                       before={originalAssignment.numberOfQuestionsPerAttempt}
-                      after={numberOfQuestionsPerAttempt}
+                      after={assignmentConfig.numberOfQuestionsPerAttempt}
                       type="number"
                     />
                   )}
diff --git a/apps/web/lib/utils.ts b/apps/web/lib/utils.ts
@@ -187,6 +187,13 @@ export const getSubmitButtonStatus = (
 
   return { disabled: false, reason: null };
 };
+
 export const generateTempQuestionId = (): number => {
   return Math.floor(Math.random() * 2e9);
 };
+
+export const omit = (obj: object, keys: string[]): object => {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([k]) => !keys.includes(k)),
+  );
+};
diff --git a/apps/web/stores/author.ts b/apps/web/stores/author.ts
@@ -16,6 +16,7 @@ import { shallow } from "zustand/shallow";
 import { createWithEqualityFn } from "zustand/traditional";
 import { withUpdatedAt } from "./middlewares";
 import { DraftSummary, VersionSummary } from "@/lib/author";
+import { config } from "process";
 const NON_PERSIST_KEYS = new Set<keyof AuthorState | keyof AuthorActions>([
   // version control state
   "versions",

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"files": null,`
`4`	`4`	`"lines": null`
`5`	`5`	`},`
`6`		`- "generated_at": "2025-10-09T10:00:02Z",`
	`6`	`+ "generated_at": "2025-10-09T10:36:06Z",`
`7`	`7`	`"plugins_used": [`
`8`	`8`	`{`
`9`	`9`	`"name": "AWSKeyDetector"`