feat: tutorial requirements

packages/api/db/migrations/20200715083645_add_requirements_to_texts.ts

@@ -0,0 +1,7 @@
+import Knex from "knex";
+
+export const up = async (knex: Knex) =>
+    knex.schema.table("texts", table => table.jsonb("requirements"));
+
+export const down = async (knex: Knex) =>
+    knex.schema.table("texts", table => table.dropColumn("requirements"));

packages/api/src/modules/texts/actions/addText.ts

@@ -7,14 +7,16 @@ export default async (
     difficulty: number,
     author: number,
     ordered = true,
-    tutorial = false
+    tutorial = false,
+    requirements
 ) => {
     await knex<Text>("texts").insert({
         title,
         text,
         difficulty,
         author,
         ordered,
-        tutorial
+        tutorial,
+        requirements
     });
 };

packages/api/src/modules/texts/router.test.ts

@@ -57,8 +57,8 @@ describe("Texts routes", async () => {
             .expect(200);
 
         expect(response.body).to.deep.equal([
-            { ...newText, id: 1 },
-            { ...newRandomText, id: 2 }
+            { ...newText, id: 1, requirements: null },
+            { ...newRandomText, id: 2, requirements: null }
         ]);
     });
 
@@ -70,8 +70,8 @@ describe("Texts routes", async () => {
             .expect(200);
 
         expect([
-            { ...newText, id: 1 },
-            { ...newRandomText, id: 2 }
+            { ...newText, id: 1, requirements: null },
+            { ...newRandomText, id: 2, requirements: null }
         ]).to.deep.include(response.body);
     });
 });

packages/api/src/modules/texts/router.ts

@@ -7,6 +7,7 @@ import { addTextBody } from "./schema/addTextBody";
 import { validateSchema } from "../schema/middleware/validateSchema";
 import deleteText from "./actions/deleteText";
 import editText from "./actions/editText";
+import { HttpError } from "../../common/error/classes/httpError";
 
 const router = new Router({ prefix: "/texts" });
 
@@ -16,8 +17,23 @@ router.post(
     validateSchema(addTextBody, "body"),
     async (ctx, next) => {
         const { title, text, difficulty, ordered, tutorial } = ctx.request.body;
+        const requirements = ctx.request.body.requirements;
+        if (tutorial && !requirements) {
+            throw new HttpError(
+                400,
+                "You need to have requirements for a tutorial!"
+            );
+        }
         const { user } = ctx.session!;
-        await addText(title, text, difficulty, user, ordered, tutorial);
+        await addText(
+            title,
+            text,
+            difficulty,
+            user,
+            ordered,
+            tutorial,
+            requirements
+        );
         ctx.status = 201;
         ctx.body = {
             message: "Successfully added text"

packages/api/src/modules/texts/types/Text.ts

@@ -1,3 +1,5 @@
+type Requirement = "wpm" | "rawwpm" | "acc";
+
 export default interface Text {
     id: number;
     title: string;
@@ -6,4 +8,5 @@ export default interface Text {
     tutorial: boolean;
     difficulty: number;
     author: number;
+    requirements?: Record<Requirement, number>;
 }

packages/api/src/modules/tutorials/actions/compareRequirements.ts

@@ -0,0 +1,12 @@
+import Requirement from "../types/Requirement";
+
+const typesafeKeys = Object.keys as <T extends object>(o: T) => Array<keyof T>;
+
+export default (
+    base: Record<Requirement, number>,
+    head: Record<Requirement, number>
+) => {
+    return typesafeKeys(base)
+        .map(l => [base[l], head[l]])
+        .every(l => l[1] > l[0]);
+};

packages/api/src/modules/tutorials/actions/completeTutorial.ts

@@ -1,8 +1,14 @@
 import { Tutorial } from "../types/Tutorial";
 import knex from "../../../../db/knex";
 import User from "../../users/types/User";
+import compareRequirements from "./compareRequirements";
+import Requirement from "../types/Requirement";
 
-export default async (tutorialid: number, userid: number) => {
+export default async (
+    tutorialid: number,
+    userid: number,
+    requirements: Record<Requirement, number>
+) => {
     const tutorial = await knex<Tutorial>("texts")
         .where({
             id: tutorialid,
@@ -14,7 +20,10 @@ export default async (tutorialid: number, userid: number) => {
             id: userid
         })
         .first();
-    if (!tutorial || !user) return false;
+    if (!tutorial || !user) return null;
+    if (!compareRequirements(tutorial.requirements!, requirements)) {
+        return false;
+    }
     await knex("users")
         .update({
             tutorials: knex.raw("array_append(tutorials, ?)", [tutorialid])

packages/api/src/modules/tutorials/router.test.ts

@@ -17,10 +17,10 @@ describe("Tutorials routes", async () => {
             password: "MaoGay"
         });
 
-        await addText("blah", "blah", 1, 1, false, true);
+        await addText("blah", "blah", 1, 1, false, true, { wpm: 100 });
         const response = await agent
             .post(`/api/tutorials/completeTutorial/`)
-            .send({ id: 3 })
+            .send({ id: 3, requirements: { wpm: 110 } })
             .set("Accept", "application/json")
             .expect("Content-Type", /json/)
             .expect(200);
@@ -30,15 +30,17 @@ describe("Tutorials routes", async () => {
         );
     });
 
-    it("Cannot complete a non-existent tutorial", async () => {
+    it("Cannot complete a tutorial without meeting requirements", async () => {
         const response = await agent
             .post(`/api/tutorials/completeTutorial/`)
-            .send({ id: 1 })
+            .send({ id: 3, requirements: { wpm: 90 } })
             .set("Accept", "application/json")
             .expect("Content-Type", /json/)
             .expect(400);
 
-        expect(response.body.message).to.equal("That tutorial does not exist!");
+        expect(response.body.message).to.equal(
+            "You do not meet the requirements for this tutorial"
+        );
     });
 
     it("Gets tutorials completed for the user", async () => {

packages/api/src/modules/tutorials/router.ts

@@ -8,11 +8,14 @@ import getAllTutorials from "./actions/getAllTutorials";
 const router = new Router({ prefix: "/tutorials" });
 
 router.post("/completeTutorial", requireAuthenticated(), async (ctx, next) => {
-    const { id } = ctx.request.body;
+    const { id, requirements } = ctx.request.body;
     const { user } = ctx.session!;
-    const success = await completeTutorial(id, user);
+    const success = await completeTutorial(id, user, requirements);
     if (!success) {
-        throw new HttpError(400, "That tutorial does not exist!");
+        throw new HttpError(
+            400,
+            "You do not meet the requirements for this tutorial"
+        );
     }
     ctx.status = 200;
     ctx.body = {

packages/api/src/modules/tutorials/types/Requirement.ts

@@ -0,0 +1,4 @@
+type Requirement = "wpm" | "rawwpm" | "acc";
+
+// eslint-disable-next-line no-undef
+export default Requirement;