feat: misc

Author: hongaar

extensions/firestore-send-email.env

@@ -1,4 +1,4 @@
-DEFAULT_FROM=info@examtraining.online
+DEFAULT_FROM="examtraining.online <info@examtraining.online>"
 MAIL_COLLECTION=mail
 SMTP_CONNECTION_URI=smtps://postmaster%40mg.examtraining.online@smtp.eu.mailgun.org:465
 SMTP_PASSWORD=projects/${param:PROJECT_NUMBER}/secrets/firestore-send-email-SMTP_PASSWORD/versions/latest

packages/core/src/schema.ts

@@ -20,6 +20,7 @@ export type Mail = {
 };
 
 export type Answer = {
+  id: string;
   order: number;
   description: string;
   correct: boolean;
@@ -28,12 +29,9 @@ export type Answer = {
 export type Question = {
   order: number;
   description: string;
-  answers: CollectionReference<Answer>;
+  answers: Answer[];
   explanation: string;
-};
-
-export type QuestionWithAnswers = Omit<Question, "answers"> & {
-  answers: AddId<Answer>[];
+  categories?: string[];
 };
 
 export type Secret = {
@@ -54,7 +52,7 @@ export type Exam = {
 
 export type ExamWithQuestions = Omit<Exam, "questions" | "secrets"> & {
   id: string;
-  questions: AddId<QuestionWithAnswers>[];
+  questions: AddId<Question>[];
 };
 
 type DocEnum = {

packages/functions/src/createExam.ts

@@ -21,7 +21,7 @@ const EDIT_HASH_LENGTH = 8;
 const ACCESS_HASH_LENGTH = 2;
 
 type CreateExamParams = { exam: Partial<Exam>; owner: string };
-type CreateExamReturn = {};
+type CreateExamReturn = { accessCode?: string; editCode: string };
 
 export const createExam = onCall<CreateExamParams, Promise<CreateExamReturn>>(
   { region: "europe-west1", cors: "*" },
@@ -66,11 +66,12 @@ export const createExam = onCall<CreateExamParams, Promise<CreateExamReturn>>(
       await exams.doc(slug).set(exam as Exam);
 
       // Queue mail
-      await mail.add({
-        to: owner,
-        message: {
-          subject: "Exam created",
-          html: `Your exam "${exam.title}" has been created.<br/>
+      if (!process.env.FUNCTIONS_EMULATOR) {
+        await mail.add({
+          to: owner,
+          message: {
+            subject: "Exam created",
+            html: `Your exam "${exam.title}" has been created.<br/>
 <br/>
 ${
   exam.private
@@ -84,12 +85,16 @@ Access the exam by using this link: <a href="https://examtraining.online/${slug}
 In order to make changes to this exam, you need an edit code.<br/>
 The edit code is: <code>${editCode}</code><br/>
 Edit the exam by using this link: <a href="https://examtraining.online/${slug}/edit?editCode=${editCode}">https://examtraining.online/${slug}/edit?editCode=${editCode}</a>`,
-        },
-      });
+          },
+        });
+      }
 
       logger.info({ message: "created exam", data });
 
-      return {};
+      return {
+        accessCode,
+        editCode,
+      };
     } catch (error) {
       logger.error(error);
       throw error;

packages/functions/src/createExamQuestion.ts

@@ -7,17 +7,13 @@ try {
 import { logger } from "firebase-functions/v2";
 import { HttpsError, onCall } from "firebase-functions/v2/https";
 // @ts-ignore
-import {
-  FirestoreCollection,
-  Question,
-  QuestionWithAnswers,
-} from "@examtraining/core";
-import { collectionRef, getDocument } from "./utils";
+import { FirestoreCollection, Question } from "@examtraining/core";
+import { collectionRef, getDocument, migrateAnswersIfNeeded } from "./utils";
 
 type CreateExamQuestionParams = {
   slug: string;
   editCode: string;
-  data: QuestionWithAnswers;
+  data: Question;
 };
 
 type CreateExamQuestionReturn = {};
@@ -56,30 +52,21 @@ export const createExamQuestion = onCall<
       );
     }
 
+    await migrateAnswersIfNeeded(exam);
+
     // Add question
-    const questionRef = await collectionRef(
+    await collectionRef(
       FirestoreCollection.Exams,
       data.slug,
       FirestoreCollection.Questions,
     ).add({
       order: data.data.order,
       description: data.data.description,
       explanation: data.data.explanation,
+      answers: data.data.answers,
+      categories: data.data.categories,
     } as Question);
 
-    // Add answers
-    const answers = collectionRef(
-      FirestoreCollection.Exams,
-      data.slug,
-      FirestoreCollection.Questions,
-      questionRef.id,
-      FirestoreCollection.Answers,
-    );
-
-    for (const answer of data.data.answers) {
-      await answers.add(answer);
-    }
-
     logger.info({ message: "created exam question", data });
 
     return {};

packages/functions/src/editExamDetails.ts

@@ -16,7 +16,7 @@ type EditExamDetailsParams = {
   data: Partial<Exam>;
 };
 
-type EditExamDetailsReturn = {};
+type EditExamDetailsReturn = { accessCode?: string };
 
 export const editExamDetails = onCall<
   EditExamDetailsParams,
@@ -58,19 +58,21 @@ export const editExamDetails = onCall<
     await docRef(FirestoreCollection.Exams, data.slug).update(data.data);
 
     // Queue mail
-    if (exam.private === false && data.data.private === true) {
-      await mail.add({
-        to: secrets.data()!.owner,
-        message: {
-          subject: "Exam made private",
-          html: `Your exam "${exam.title}" is now private.<br/>
+    if (!process.env.FUNCTIONS_EMULATOR) {
+      if (exam.private === false && data.data.private === true) {
+        await mail.add({
+          to: secrets.data()!.owner,
+          message: {
+            subject: "Exam made private",
+            html: `Your exam "${exam.title}" is now private.<br/>
 <br/>
 In order to view it you need an access code.<br/>
 The access code is: <code>${secrets.data()!.accessCode}</code><br/>
 Access the exam by using this link: <a href="https://examtraining.online/${data.slug}?accessCode=${secrets.data()!.accessCode}">https://examtraining.online/${data.slug}?accessCode=${secrets.data()!.accessCode}</a><br/>
 <br/>`,
-        },
-      });
+          },
+        });
+      }
     }
 
     logger.info({ message: "edited exam details", data });

packages/functions/src/editExamQuestion.ts

@@ -7,18 +7,14 @@ try {
 import { logger } from "firebase-functions/v2";
 import { HttpsError, onCall } from "firebase-functions/v2/https";
 // @ts-ignore
-import {
-  FirestoreCollection,
-  Question,
-  QuestionWithAnswers,
-} from "@examtraining/core";
-import { collectionRef, getDocument } from "./utils";
+import { FirestoreCollection, Question } from "@examtraining/core";
+import { collectionRef, getDocument, migrateAnswersIfNeeded } from "./utils";
 
 type EditExamQuestionParams = {
   slug: string;
   editCode: string;
   questionId: string;
-  data: QuestionWithAnswers;
+  data: Question;
 };
 
 type EditExamQuestionReturn = {};
@@ -57,6 +53,8 @@ export const editExamQuestion = onCall<
       );
     }
 
+    await migrateAnswersIfNeeded(exam);
+
     // Update question
     const questionRef = collectionRef(
       FirestoreCollection.Exams,
@@ -66,25 +64,10 @@ export const editExamQuestion = onCall<
     await questionRef.update({
       description: data.data.description,
       explanation: data.data.explanation,
+      answers: data.data.answers,
+      categories: data.data.categories,
     } as Question);
 
-    // Remove answers collection
-    const answers = collectionRef(
-      FirestoreCollection.Exams,
-      data.slug,
-      FirestoreCollection.Questions,
-      questionRef.id,
-      FirestoreCollection.Answers,
-    );
-    for (const doc of (await answers.get()).docs) {
-      await doc.ref.delete();
-    }
-
-    // Add answers
-    for (const answer of data.data.answers) {
-      await answers.add(answer);
-    }
-
     logger.info({ message: "edited exam question", data });
 
     return {};

packages/functions/src/getExam.ts

@@ -7,14 +7,7 @@ try {
 import { logger } from "firebase-functions/v2";
 import { HttpsError, onCall } from "firebase-functions/v2/https";
 // @ts-ignore
-import {
-  AddId,
-  Answer,
-  ExamWithQuestions,
-  FirestoreCollection,
-  PlainDoc,
-  QuestionWithAnswers,
-} from "@examtraining/core";
+import { ExamWithQuestions, FirestoreCollection } from "@examtraining/core";
 import { collectionRef, getDocument, toIdAndRef, toPlainObject } from "./utils";
 
 type GetExamParams = { slug: string; accessCode?: string; editCode?: string };
@@ -76,46 +69,9 @@ export const getExam = onCall<GetExamParams, Promise<GetExamReturn>>(
           .get(),
       );
 
-      const plainQuestions: PlainDoc<AddId<QuestionWithAnswers>>[] = [];
-      const promises: Promise<void>[] = [];
-
-      for (const key in questions) {
-        const question = questions[key];
-        const plainQuestion = toPlainObject(
-          question,
-        ) as AddId<QuestionWithAnswers>;
-
-        promises.push(
-          new Promise(async (resolve) => {
-            await collectionRef(
-              FirestoreCollection.Exams,
-              data.slug,
-              FirestoreCollection.Questions,
-              question.id,
-              FirestoreCollection.Answers,
-            )
-              .orderBy("order")
-              .get()
-              .then((snapshot) => {
-                const answers = toIdAndRef(snapshot);
-                const plainAnswers: PlainDoc<AddId<Answer>>[] = [];
-
-                answers.forEach((answer) => {
-                  plainAnswers.push(
-                    toPlainObject(answer) as PlainDoc<AddId<Answer>>,
-                  );
-                });
-
-                plainQuestion.answers = plainAnswers;
-                plainQuestions[key] = plainQuestion;
-              })
-              .then(resolve);
-          }),
-        );
-      }
-
-      await Promise.all(promises);
-
+      const plainQuestions = questions.map((question) =>
+        toPlainObject(question),
+      );
       const plainExam = toPlainObject(exam);
       const examWithQuestions = {
         ...plainExam,

packages/functions/src/index.ts

@@ -6,4 +6,5 @@ export * from "./editExamDetails";
 export * from "./editExamQuestion";
 export * from "./getExam";
 export * from "./isSlugAvailable";
+export * from "./onExamDeleted";
 export * from "./removeExamQuestion";

packages/functions/src/onExamDeleted.ts

@@ -0,0 +1,33 @@
+import admin from "firebase-admin";
+
+try {
+  admin.initializeApp();
+} catch (error) {}
+
+import { Exam } from "@examtraining/core";
+import { QueryDocumentSnapshot } from "firebase-admin/firestore";
+import { logger } from "firebase-functions/v2";
+import { onDocumentDeleted } from "firebase-functions/v2/firestore";
+
+export const onExamDeleted = onDocumentDeleted(
+  "exams/{examId}",
+  async (event) => {
+    const snap = event.data as QueryDocumentSnapshot<Exam> | undefined;
+    const exam = snap?.data();
+
+    if (!exam) {
+      throw new Error("could not grab snapshot data.");
+    }
+
+    try {
+      await exam.secrets.delete();
+
+      logger.info({ message: "deleted secret", data: exam });
+
+      return {};
+    } catch (error) {
+      logger.error(error);
+      throw error;
+    }
+  },
+);

packages/functions/src/removeExamQuestion.ts

@@ -1,4 +1,4 @@
-import admin, { firestore } from "firebase-admin";
+import admin from "firebase-admin";
 
 try {
   admin.initializeApp();
@@ -53,12 +53,13 @@ export const removeExamQuestion = onCall<
     }
 
     // Remove question
-    const questionRef = collectionRef(
+    await collectionRef(
       FirestoreCollection.Exams,
       data.slug,
       FirestoreCollection.Questions,
-    ).doc(data.questionId);
-    await firestore().recursiveDelete(questionRef);
+    )
+      .doc(data.questionId)
+      .delete();
 
     logger.info({ message: "removed exam question", data });