Merged in feature-multiplerandomexams (pull request #1)

Dynamic tests generation of assignment + Minor changes

Approved-by: Tiago Ribeiro

.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Next.js: debug server-side",
+        "type": "node-terminal",
+        "request": "launch",
+        "command": "npm run dev"
+      },
+      {
+        "name": "Next.js: debug client-side",
+        "type": "chrome",
+        "request": "launch",
+        "url": "http://localhost:3000"
+      },
+      {
+        "name": "Next.js: debug full stack",
+        "type": "node-terminal",
+        "request": "launch",
+        "command": "npm run dev",
+        "serverReadyAction": {
+          "pattern": "- Local:.+(https?://.+)",
+          "uriFormat": "%s",
+          "action": "debugWithChrome"
+        }
+      }
+    ]
+  }

src/dashboards/Admin.tsx

@@ -13,9 +13,8 @@ import {
 	BsGlobeCentralSouthAsia,
 	BsPerson,
 	BsPersonFill,
-	BsPersonFillGear,
+	BsPencilSquare,
-	BsPersonGear,
+	BsBank,
-	BsPersonLinesFill,
 } from "react-icons/bs";
 import UserCard from "@/components/UserCard";
 import useGroups from "@/hooks/useGroups";
@@ -43,6 +42,8 @@ export default function AdminDashboard({user}: Props) {
 		setShowModal(!!selectedUser && page === "");
 	}, [selectedUser, page]);
 
+	const inactiveCountryManagerFilter = (x: User) => x.type === "agent" && (x.status === "disabled" || moment().isAfter(x.subscriptionExpirationDate));
+
 	const UserDisplay = (displayUser: User) => (
 		<div
 			onClick={() => setSelectedUser(displayUser)}
@@ -149,6 +150,24 @@ export default function AdminDashboard({user}: Props) {
 		</>
 	);
 
+	const InactiveCountryManagerList = () => {
+		return (
+			<>
+				<div className="flex flex-col gap-4">
+					<div
+						onClick={() => setPage("")}
+						className="flex gap-2 items-center text-mti-purple-light cursor-pointer hover:text-mti-purple-dark transition ease-in-out duration-300">
+						<BsArrowLeft className="text-xl" />
+						<span>Back</span>
+					</div>
+					<h2 className="text-2xl font-semibold">Inactive Country Managers ({users.filter(inactiveCountryManagerFilter).length})</h2>
+				</div>
+
+				<UserList user={user} filters={[inactiveCountryManagerFilter]} />
+			</>
+		);
+	}
+
 	const InactiveStudentsList = () => {
 		const filter = (x: User) => x.type === "student" && (x.status === "disabled" || moment().isAfter(x.subscriptionExpirationDate));
 
@@ -200,14 +219,14 @@ export default function AdminDashboard({user}: Props) {
 					color="purple"
 				/>
 				<IconCard
-					Icon={BsPersonLinesFill}
+					Icon={BsPencilSquare}
 					label="Teachers"
 					value={users.filter((x) => x.type === "teacher").length}
 					onClick={() => setPage("teachers")}
 					color="purple"
 				/>
 				<IconCard
-					Icon={BsPersonLinesFill}
+					Icon={BsBank}
 					label="Corporate"
 					value={users.filter((x) => x.type === "corporate").length}
 					onClick={() => setPage("corporate")}
@@ -236,6 +255,13 @@ export default function AdminDashboard({user}: Props) {
 					}
 					color="rose"
 				/>
+				<IconCard
+					onClick={() => setPage("inactiveCountryManagers")}
+					Icon={BsPerson}
+					label="Inactive Country Managers"
+					value={users.filter(inactiveCountryManagerFilter).length}
+					color="rose"
+				/>
 				<IconCard
 					onClick={() => setPage("inactiveCorporate")}
 					Icon={BsPerson}
@@ -298,7 +324,7 @@ export default function AdminDashboard({user}: Props) {
 					</div>
 				</div>
 				<div className="bg-white shadow flex flex-col rounded-xl w-full">
-					<span className="p-4">Teachers expiring in 1 month</span>
+					<span className="p-4">Country Manager expiring in 1 month</span>
 					<div className="flex flex-col items-start h-96 overflow-scroll scrollbar-hide">
 						{users
 							.filter(
@@ -342,7 +368,7 @@ export default function AdminDashboard({user}: Props) {
 					</div>
 				</div>
 				<div className="bg-white shadow flex flex-col rounded-xl w-full">
-					<span className="p-4">Expired Teachers</span>
+					<span className="p-4">Expired Country Manager</span>
 					<div className="flex flex-col items-start h-96 overflow-scroll scrollbar-hide">
 						{users
 							.filter(
@@ -454,7 +480,9 @@ export default function AdminDashboard({user}: Props) {
 			{page === "agents" && <AgentsList />}
 			{page === "inactiveStudents" && <InactiveStudentsList />}
 			{page === "inactiveCorporate" && <InactiveCorporateList />}
+			{page === "inactiveCountryManagers" && <InactiveCountryManagerList />}
 			{page === "" && <DefaultDashboard />}
+			
 		</>
 	);
 }

src/dashboards/Agent.tsx

@@ -9,17 +9,8 @@ import moment from "moment";
 import {useEffect, useState} from "react";
 import {
 	BsArrowLeft,
-	BsClipboard2Data,
-	BsClipboard2DataFill,
-	BsClock,
-	BsGlobeCentralSouthAsia,
-	BsPaperclip,
-	BsPerson,
-	BsPersonAdd,
 	BsPersonFill,
-	BsPersonFillGear,
+	BsBank
-	BsPersonGear,
-	BsPersonLinesFill,
 } from "react-icons/bs";
 import UserCard from "@/components/UserCard";
 import useGroups from "@/hooks/useGroups";
@@ -50,6 +41,7 @@ export default function AgentDashboard({user}: Props) {
 	const corporateFilter = (user: User) => user.type === "corporate";
 	const referredCorporateFilter = (x: User) =>
 		x.type === "corporate" && !!x.corporateInformation && x.corporateInformation.referralAgent === user.id;
+	const inactiveReferredCorporateFilter = (x: User) => referredCorporateFilter(x)  && (x.status === "disabled" || moment().isAfter(x.subscriptionExpirationDate));
 
 	const UserDisplay = (displayUser: User) => (
 		<div
@@ -68,8 +60,6 @@ export default function AgentDashboard({user}: Props) {
 	);
 
 	const ReferredCorporateList = () => {
-		const filter = (x: User) => x.type === "corporate" && !!x.corporateInformation && x.corporateInformation.referralAgent === user.id;
-
 		return (
 			<>
 				<div className="flex flex-col gap-4">
@@ -79,10 +69,28 @@ export default function AgentDashboard({user}: Props) {
 						<BsArrowLeft className="text-xl" />
 						<span>Back</span>
 					</div>
-					<h2 className="text-2xl font-semibold">Referred Corporate ({users.filter(filter).length})</h2>
+					<h2 className="text-2xl font-semibold">Referred Corporate ({users.filter(referredCorporateFilter).length})</h2>
 				</div>
 
-				<UserList user={user} filters={[filter]} />
+				<UserList user={user} filters={[referredCorporateFilter]} />
+			</>
+		);
+	};
+
+	const InactiveReferredCorporateList = () => {
+		return (
+			<>
+				<div className="flex flex-col gap-4">
+					<div
+						onClick={() => setPage("")}
+						className="flex gap-2 items-center text-mti-purple-light cursor-pointer hover:text-mti-purple-dark transition ease-in-out duration-300">
+						<BsArrowLeft className="text-xl" />
+						<span>Back</span>
+					</div>
+					<h2 className="text-2xl font-semibold">Inactive Referred Corporate ({users.filter(inactiveReferredCorporateFilter).length})</h2>
+				</div>
+
+				<UserList user={user} filters={[inactiveReferredCorporateFilter]} />
 			</>
 		);
 	};
@@ -118,8 +126,15 @@ export default function AgentDashboard({user}: Props) {
 					color="purple"
 				/>
 				<IconCard
-					onClick={() => setPage("corporate")}
+					onClick={() => setPage("inactiveReferredCorporate")}
 					Icon={BsPersonFill}
+					label="Inactive Referred Corporate"
+					value={users.filter(inactiveReferredCorporateFilter).length}
+					color="rose"
+				/>
+				<IconCard
+					onClick={() => setPage("corporate")}
+					Icon={BsBank}
 					label="Corporate"
 					value={users.filter(corporateFilter).length}
 					color="purple"
@@ -149,6 +164,21 @@ export default function AgentDashboard({user}: Props) {
 							))}
 					</div>
 				</div>
+				<div className="bg-white shadow flex flex-col rounded-xl w-full">
+					<span className="p-4">Referenced corporate expiring in 1 month</span>
+					<div className="flex flex-col items-start h-96 overflow-scroll scrollbar-hide">
+						{users
+							.filter(
+								(x) =>
+									referredCorporateFilter(x) &&
+									moment().isAfter(moment(x.subscriptionExpirationDate).subtract(30, "days")) &&
+									moment().isBefore(moment(x.subscriptionExpirationDate)),
+							)
+							.map((x) => (
+								<UserDisplay key={x.id} {...x} />
+							))}
+					</div>
+				</div>
 			</section>
 		</>
 	);
@@ -177,6 +207,7 @@ export default function AgentDashboard({user}: Props) {
 			</Modal>
 			{page === "referredCorporate" && <ReferredCorporateList />}
 			{page === "corporate" && <CorporateList />}
+			{page === "inactiveReferredCorporate" && <InactiveReferredCorporateList />}
 			{page === "" && <DefaultDashboard />}
 		</>
 	);

src/dashboards/AssignmentCreator.tsx

@@ -18,6 +18,7 @@ import {getExam} from "@/utils/exams";
 import {toast} from "react-toastify";
 import {uuidv4} from "@firebase/util";
 import {Assignment} from "@/interfaces/results";
+import Checkbox from "@/components/Low/Checkbox";
 
 interface Props {
 	isCreating: boolean;
@@ -35,6 +36,8 @@ export default function AssignmentCreator({isCreating, assignment, assigner, gro
 	const [isLoading, setIsLoading] = useState(false);
 	const [startDate, setStartDate] = useState<Date | null>(assignment ? moment(assignment.startDate).toDate() : moment().add(1, "day").toDate());
 	const [endDate, setEndDate] = useState<Date | null>(assignment ? moment(assignment.endDate).toDate() : moment().add(8, "day").toDate());
+	// creates a new exam for each assignee or just one exam for all assignees
+	const [generateMultiple, setGenerateMultiple] = useState<boolean>(false);
 
 	const toggleModule = (module: Module) => {
 		const modules = selectedModules.filter((x) => x !== module);
@@ -48,20 +51,23 @@ export default function AssignmentCreator({isCreating, assignment, assigner, gro
 	const createAssignment = () => {
     setIsLoading(true);
 
-		const examPromises = selectedModules.map(async (module) => getExam(module, false));
+    (assignment ? axios.patch : axios.post)(
-		Promise.all(examPromises)
+      `/api/assignments${assignment ? `/${assignment.id}` : ""}`,
-			.then((exams) => {
+      {
-				(assignment ? axios.patch : axios.post)(`/api/assignments${assignment ? `/${assignment.id}` : ""}`, {
-					assigner,
         assignees,
         name,
         startDate,
         endDate,
-					results: [],
+		selectedModules,
-					exams: exams.map((e) => ({module: e?.module, id: e?.id})),
+		generateMultiple,
-				})
+      }
+    )
       .then(() => {
-						toast.success(`The assignment "${name}" has been ${assignment ? "updated" : "created"} successfully!`);
+        toast.success(
+          `The assignment "${name}" has been ${
+            assignment ? "updated" : "created"
+          } successfully!`
+        );
         cancelCreation();
       })
       .catch((e) => {
@@ -69,12 +75,6 @@ export default function AssignmentCreator({isCreating, assignment, assigner, gro
         toast.error("Something went wrong, please try again later!");
       })
       .finally(() => setIsLoading(false));
-			})
-			.catch((e) => {
-				console.log(e);
-				toast.error("Something went wrong, please try again later!");
-				setIsLoading(false);
-			});
   };
 
 	const deleteAssignment = () => {
@@ -284,6 +284,11 @@ export default function AssignmentCreator({isCreating, assignment, assigner, gro
 						))}
 					</div>
 				</section>
+				<div className="flex gap-4 w-full justify-end">
+					<Checkbox isChecked={generateMultiple} onChange={() => setGenerateMultiple(d => !d)}>
+						Generate different exams
+					</Checkbox>
+				</div>
 				<div className="flex gap-4 w-full justify-end">
 					<Button className="w-full max-w-[200px]" variant="outline" onClick={cancelCreation} disabled={isLoading} isLoading={isLoading}>
 						Cancel

src/dashboards/Corporate.tsx

@@ -19,7 +19,7 @@ import {
 	BsPersonFill,
 	BsPersonFillGear,
 	BsPersonGear,
-	BsPersonLinesFill,
+	BsPencilSquare,
 } from "react-icons/bs";
 import UserCard from "@/components/UserCard";
 import useGroups from "@/hooks/useGroups";
@@ -170,7 +170,7 @@ export default function CorporateDashboard({user}: Props) {
 				/>
 				<IconCard
 					onClick={() => setPage("teachers")}
-					Icon={BsPersonLinesFill}
+					Icon={BsPencilSquare}
 					label="Teachers"
 					value={users.filter(teacherFilter).length}
 					color="purple"

src/dashboards/Student.tsx

@@ -38,7 +38,7 @@ export default function StudentDashboard({user}: Props) {
 	const setAssignment = useExamStore((state) => state.setAssignment);
 
 	const startAssignment = (assignment: Assignment) => {
-		const examPromises = assignment.exams.map((e) => getExamById(e.module, e.id));
+		const examPromises = assignment.exams.filter((e) => e.assignee === user.id).map((e) => getExamById(e.module, e.id));
 
 		Promise.all(examPromises).then((exams) => {
 			if (exams.every((x) => !!x)) {
@@ -121,6 +121,7 @@ export default function StudentDashboard({user}: Props) {
 								<div className="flex justify-between w-full items-center">
 									<div className="grid grid-cols-2 gap-2 place-items-center justify-center w-fit min-w-[104px] -md:mt-2">
 										{assignment.exams
+											.filter((e) => e.assignee === user.id)
 											.map((e) => e.module)
 											.sort(sortByModuleName)
 											.map((module) => (

src/dashboards/Teacher.tsx

@@ -24,7 +24,6 @@ import {
 	BsPersonFill,
 	BsPersonFillGear,
 	BsPersonGear,
-	BsPersonLinesFill,
 	BsPlus,
 	BsRepeat,
 	BsRepeat1,

src/interfaces/results.ts

@@ -19,7 +19,7 @@ export interface Assignment {
 		type: "academic" | "general";
 		stats: Stat[];
 	}[];
-	exams: {id: string; module: Module}[];
+	exams: {id: string; module: Module, assignee: string}[];
 	startDate: Date;
 	endDate: Date;
 }

src/pages/api/assignments/index.ts

@@ -5,6 +5,10 @@ import {getFirestore, collection, getDocs, query, where, setDoc, doc} from "fire
 import {withIronSessionApiRoute} from "iron-session/next";
 import {sessionOptions} from "@/lib/session";
 import {uuidv4} from "@firebase/util";
+import { Module } from "@/interfaces";
+import { getExams } from "@/utils/exams.be";
+import { Exam } from "@/interfaces/exam";
+import { flatten } from "lodash";
 
 const db = getFirestore(app);
 
@@ -34,8 +38,107 @@ async function GET(req: NextApiRequest, res: NextApiResponse) {
 	res.status(200).json(docs);
 }
 
+interface ExamWithUser {
+  module: Module;
+  id: string;
+  assignee: string;
+}
+
+function getRandomIndex(arr: any[]): number {
+  const randomIndex = Math.floor(Math.random() * arr.length);
+  return randomIndex;
+}
+
+const generateExams = async (
+  generateMultiple: Boolean,
+  selectedModules: Module[],
+  assignees: string[]
+): Promise<ExamWithUser[]> => {
+  if (generateMultiple) {
+    // for optimization purposes, it would be better to create a new endpoint that returned the answers for all users at once
+    const allExams = await assignees.map(async (assignee) => {
+      const selectedModulePromises = await selectedModules.map(
+        async (module: Module) => {
+          try {
+            const exams: Exam[] = await getExams(db, module, "true", assignee);
+
+            const exam = exams[getRandomIndex(exams)];
+            if (exam) {
+              return { module: exam.module, id: exam.id, assignee };
+            }
+            return null;
+          } catch (e) {
+            console.error(e);
+            return null;
+          }
+        },
+        []
+      );
+      const newModules = await Promise.all(selectedModulePromises);
+
+      return newModules;
+    }, []);
+
+    const exams = flatten(await Promise.all(allExams)).filter(
+      (x) => x !== null
+    ) as ExamWithUser[];
+    return exams;
+  }
+
+  const selectedModulePromises = await selectedModules.map(
+    async (module: Module) => {
+      const exams: Exam[] = await getExams(db, module, "false", undefined);
+      const exam = exams[getRandomIndex(exams)];
+
+      if (exam) {
+        return { module: exam.module, id: exam.id };
+      }
+      return null;
+    }
+  );
+
+  const exams = await Promise.all(selectedModulePromises);
+  const examesFiltered = exams.filter((x) => x !== null) as ExamWithUser[];
+  return flatten(
+    assignees.map((assignee) =>
+      examesFiltered.map((exam) => ({ ...exam, assignee }))
+    )
+  );
+};
+
 async function POST(req: NextApiRequest, res: NextApiResponse) {
-	await setDoc(doc(db, "assignments", uuidv4()), {assigner: req.session.user?.id, ...req.body});
+  const {
+    selectedModules,
+    assignees,
+    // Generarte multiple true would generate an unique exam for eacah user
+    // false would generate the same exam for all usersa
+    generateMultiple = false,
+    ...body
+  } = req.body as {
+    selectedModules: Module[];
+    assignees: string[];
+    generateMultiple: Boolean;
+  };
+
+  const exams: ExamWithUser[] = await generateExams(
+    generateMultiple,
+    selectedModules,
+    assignees
+  );
+  if (exams.length === 0) {
+    res
+      .status(400)
+      .json({ ok: false, error: "No exams found for the selected modules" });
+    return;
+  }
+
+  await setDoc(doc(db, "assignments", uuidv4()), {
+    assigner: req.session.user?.id,
+    assignees,
+    results: [],
+    exams,
+    ...body,
+  });
 
   res.status(200).json({ ok: true });
 }

src/pages/api/exam/[module]/index.ts

@@ -1,14 +1,11 @@
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
 import type {NextApiRequest, NextApiResponse} from "next";
 import {app} from "@/firebase";
-import {getFirestore, collection, getDocs, query, where, setDoc, doc} from "firebase/firestore";
+import {getFirestore, setDoc, doc} from "firebase/firestore";
 import {withIronSessionApiRoute} from "iron-session/next";
 import {sessionOptions} from "@/lib/session";
-import {shuffle} from "lodash";
 import {Exam} from "@/interfaces/exam";
-import {Stat} from "@/interfaces/user";
+import { getExams } from "@/utils/exams.be";
-import {v4} from "uuid";
-
 const db = getFirestore(app);
 
 export default withIronSessionApiRoute(handler, sessionOptions);
@@ -26,31 +23,12 @@ async function GET(req: NextApiRequest, res: NextApiResponse) {
 		return;
 	}
 
-	const {module, avoidRepeated} = req.query as {module: string; avoidRepeated: string};
+	const {
-	const moduleRef = collection(db, module);
-
-	const q = query(moduleRef, where("isDiagnostic", "==", false));
-	const snapshot = await getDocs(q);
-
-	const exams: Exam[] = shuffle(
-		snapshot.docs.map((doc) => ({
-			id: doc.id,
-			...doc.data(),
 		module,
-		})),
+		avoidRepeated,
-	) as Exam[];
+	} = req.query as {module: string; avoidRepeated: string};
-
-	if (avoidRepeated === "true") {
-		const statsQ = query(collection(db, "stats"), where("user", "==", req.session.user.id));
-		const statsSnapshot = await getDocs(statsQ);
-
-		const stats: Stat[] = statsSnapshot.docs.map((doc) => ({id: doc.id, ...doc.data()})) as unknown as Stat[];
-		const filteredExams = exams.filter((x) => !stats.map((s) => s.exam).includes(x.id));
-
-		res.status(200).json(filteredExams.length > 0 ? filteredExams : exams);
-		return;
-	}
 
+	const exams: Exam[] = await getExams(db, module, avoidRepeated, req.session.user.id);
 	res.status(200).json(exams);
 }
 

src/utils/exams.be.ts

@@ -0,0 +1,52 @@
+import {
+  collection,
+  getDocs,
+  query,
+  where,
+  setDoc,
+  doc,
+  Firestore,
+} from "firebase/firestore";
+import { shuffle } from "lodash";
+import { Exam } from "@/interfaces/exam";
+import { Stat } from "@/interfaces/user";
+
+export const getExams = async (
+  db: Firestore,
+  module: string,
+  avoidRepeated: string,
+  // added userId as due to assignments being set from the teacher to the student
+  // we need to make sure we are serving exams not executed by the user and not
+  // by the teacher that performed the request
+  userId: string | undefined
+): Promise<Exam[]> => {
+  const moduleRef = collection(db, module);
+
+  const q = query(moduleRef, where("isDiagnostic", "==", false));
+  const snapshot = await getDocs(q);
+
+  const exams: Exam[] = shuffle(
+    snapshot.docs.map((doc) => ({
+      id: doc.id,
+      ...doc.data(),
+      module,
+    }))
+  ) as Exam[];
+
+  if (avoidRepeated === "true") {
+    const statsQ = query(collection(db, "stats"), where("user", "==", userId));
+    const statsSnapshot = await getDocs(statsQ);
+
+    const stats: Stat[] = statsSnapshot.docs.map((doc) => ({
+      id: doc.id,
+      ...doc.data(),
+    })) as unknown as Stat[];
+    const filteredExams = exams.filter(
+      (x) => !stats.map((s) => s.exam).includes(x.id)
+    );
+
+    return filteredExams.length > 0 ? filteredExams : exams;
+  }
+
+  return exams;
+};