From 79a532b5fffe1e126ad726898175d50e4b8d61ae Mon Sep 17 00:00:00 2001
From: Tiago Ribeiro <tiago.ribeiro@ecrop.dev>
Date: Sun, 28 May 2023 10:00:06 +0100
Subject: [PATCH] - Implemented an image attachment to the Writing exercise; -
 Made it so the exams are now sorted when going through the history; -
 Corrected some little mistakes;

---
 src/components/Diagnostic.tsx        |  2 +-
 src/components/Exercises/Writing.tsx |  4 +++-
 src/exams/Selection.tsx              |  4 +++-
 src/interfaces/exam.ts               |  5 +++++
 src/pages/api/exam/[module]/index.ts |  6 ++++--
 src/pages/exam/index.tsx             |  2 +-
 src/pages/history.tsx                | 10 ++++++++--
 src/utils/moduleUtils.ts             |  6 ++++++
 8 files changed, 31 insertions(+), 8 deletions(-)

diff --git a/src/components/Diagnostic.tsx b/src/components/Diagnostic.tsx
index fe225045..a67159f5 100644
--- a/src/components/Diagnostic.tsx
+++ b/src/components/Diagnostic.tsx
@@ -47,7 +47,7 @@ export default function Diagnostic({onFinish}: Props) {
 
 	const updateUser = (callback: () => void) => {
 		axios
-			.post("/api/users/update", {focus, levels, isFirstLogin: false})
+			.patch("/api/users/update", {focus, levels, isFirstLogin: false})
 			.then(callback)
 			.catch(() => {
 				toast.error("Something went wrong, please try again later!", {toastId: "user-update-error"});
diff --git a/src/components/Exercises/Writing.tsx b/src/components/Exercises/Writing.tsx
index 5db9d90b..cf2d5063 100644
--- a/src/components/Exercises/Writing.tsx
+++ b/src/components/Exercises/Writing.tsx
@@ -1,3 +1,4 @@
+/* eslint-disable @next/next/no-img-element */
 import {errorButtonStyle, infoButtonStyle} from "@/constants/buttonStyles";
 import {WritingExercise} from "@/interfaces/exam";
 import {mdiArrowLeft, mdiArrowRight} from "@mdi/js";
@@ -7,7 +8,7 @@ import {CommonProps} from ".";
 import {Fragment, useEffect, useState} from "react";
 import {toast} from "react-toastify";
 
-export default function Writing({id, prompt, info, type, wordCounter, onNext, onBack}: WritingExercise & CommonProps) {
+export default function Writing({id, prompt, info, type, wordCounter, attachment, onNext, onBack}: WritingExercise & CommonProps) {
 	const [inputText, setInputText] = useState("");
 	const [isSubmitEnabled, setIsSubmitEnabled] = useState(false);
 
@@ -40,6 +41,7 @@ export default function Writing({id, prompt, info, type, wordCounter, onNext, on
 				<span>
 					You should write {wordCounter.type === "min" ? "at least" : "at most"} {wordCounter.limit} words.
 				</span>
+				{attachment && <img src={attachment} alt="Exercise attachment" />}
 			</div>
 
 			<textarea
diff --git a/src/exams/Selection.tsx b/src/exams/Selection.tsx
index 16338db9..44c3b380 100644
--- a/src/exams/Selection.tsx
+++ b/src/exams/Selection.tsx
@@ -1,13 +1,14 @@
 /* eslint-disable @next/next/no-img-element */
 import Icon from "@mdi/react";
 import {mdiAccountVoice, mdiArrowLeft, mdiArrowRight, mdiBookOpen, mdiHeadphones, mdiPen} from "@mdi/js";
-import {useState} from "react";
+import {useEffect, useState} from "react";
 import {Module} from "@/interfaces";
 import clsx from "clsx";
 import {useRouter} from "next/router";
 import {errorButtonStyle, infoButtonStyle} from "@/constants/buttonStyles";
 import ProfileLevel from "@/components/ProfileLevel";
 import {User} from "@/interfaces/user";
+import useExamStore from "@/stores/examStore";
 
 interface Props {
 	user: User;
@@ -16,6 +17,7 @@ interface Props {
 
 export default function Selection({user, onStart}: Props) {
 	const [selectedModules, setSelectedModules] = useState<Module[]>([]);
+
 	const router = useRouter();
 
 	const toggleModule = (module: Module) => {
diff --git a/src/interfaces/exam.ts b/src/interfaces/exam.ts
index 572228ea..3720d07e 100644
--- a/src/interfaces/exam.ts
+++ b/src/interfaces/exam.ts
@@ -12,6 +12,7 @@ export interface ReadingExam {
 	module: "reading";
 	minTimer: number;
 	type: "academic" | "general";
+	isDiagnostic: boolean;
 }
 
 export interface ListeningExam {
@@ -23,6 +24,7 @@ export interface ListeningExam {
 	exercises: Exercise[];
 	module: "listening";
 	minTimer: number;
+	isDiagnostic: boolean;
 }
 
 export interface UserSolution {
@@ -42,6 +44,7 @@ export interface WritingExam {
 	id: string;
 	exercises: Exercise[];
 	minTimer: number;
+	isDiagnostic: boolean;
 }
 
 interface WordCounter {
@@ -54,6 +57,7 @@ export interface SpeakingExam {
 	module: "speaking";
 	exercises: Exercise[];
 	minTimer: number;
+	isDiagnostic: boolean;
 }
 
 export type Exercise =
@@ -70,6 +74,7 @@ export interface WritingExercise {
 	info: string; //* The information about the task, like the amount of time they should spend on it
 	prompt: string; //* The context given to the user containing what they should write about
 	wordCounter: WordCounter; //* The minimum or maximum amount of words that should be written
+	attachment?: string; //* The url for an image to work as an attachment to show the user
 	userSolutions: {
 		id: string;
 		solution: string;
diff --git a/src/pages/api/exam/[module]/index.ts b/src/pages/api/exam/[module]/index.ts
index 2e85e7d1..4805a5fc 100644
--- a/src/pages/api/exam/[module]/index.ts
+++ b/src/pages/api/exam/[module]/index.ts
@@ -1,7 +1,7 @@
 // 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} from "firebase/firestore";
+import {getFirestore, collection, getDocs, query, where} from "firebase/firestore";
 import {withIronSessionApiRoute} from "iron-session/next";
 import {sessionOptions} from "@/lib/session";
 
@@ -16,8 +16,10 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
 	}
 
 	const {module} = req.query as {module: string};
+	const moduleRef = collection(db, module);
+	const q = query(moduleRef, where("isDiagnostic", "==", false));
 
-	const snapshot = await getDocs(collection(db, module));
+	const snapshot = await getDocs(q);
 
 	res.status(200).json(
 		snapshot.docs.map((doc) => ({
diff --git a/src/pages/exam/index.tsx b/src/pages/exam/index.tsx
index c9330a78..a39555e3 100644
--- a/src/pages/exam/index.tsx
+++ b/src/pages/exam/index.tsx
@@ -41,7 +41,7 @@ export const getServerSideProps = withIronSessionSsr(({req, res}) => {
 
 export default function Page() {
 	const [hasBeenUploaded, setHasBeenUploaded] = useState(false);
-	const [moduleIndex, setModuleIndex] = useState(1);
+	const [moduleIndex, setModuleIndex] = useState(0);
 	const [sessionId, setSessionId] = useState("");
 	const [exam, setExam] = useState<Exam>();
 	const [timer, setTimer] = useState(-1);
diff --git a/src/pages/history.tsx b/src/pages/history.tsx
index 2083e7a7..04e718a4 100644
--- a/src/pages/history.tsx
+++ b/src/pages/history.tsx
@@ -26,6 +26,7 @@ import Icon from "@mdi/react";
 import {mdiArrowRight, mdiChevronRight} from "@mdi/js";
 import {uniqBy} from "lodash";
 import {getExamById} from "@/utils/exams";
+import {sortByModule} from "@/utils/moduleUtils";
 
 export const getServerSideProps = withIronSessionSsr(({req, res}) => {
 	const user = req.session.user;
@@ -87,8 +88,13 @@ export default function History({user}: {user: User}) {
 				if (exams.every((x) => !!x)) {
 					setUserSolutions(convertToUserSolutions(dateStats));
 					setShowSolutions(true);
-					setExams(exams.map((x) => x!));
-					setSelectedModules(exams.map((x) => x!.module));
+					setExams(exams.map((x) => x!).sort(sortByModule));
+					setSelectedModules(
+						exams
+							.map((x) => x!)
+							.sort(sortByModule)
+							.map((x) => x!.module),
+					);
 					router.push("/exam");
 				}
 			});
diff --git a/src/utils/moduleUtils.ts b/src/utils/moduleUtils.ts
index 8414464a..a268bce1 100644
--- a/src/utils/moduleUtils.ts
+++ b/src/utils/moduleUtils.ts
@@ -1,8 +1,14 @@
 import {Module} from "@/interfaces";
 
+const MODULE_ARRAY: Module[] = ["reading", "listening", "writing", "speaking"];
+
 export const moduleLabels: {[key in Module]: string} = {
 	listening: "Listening",
 	reading: "Reading",
 	speaking: "Speaking",
 	writing: "Writing",
 };
+
+export const sortByModule = (a: {module: Module}, b: {module: Module}) => {
+	return MODULE_ARRAY.findIndex((x) => a.module === x) - MODULE_ARRAY.findIndex((x) => b.module === x);
+};