More test coverage, more tests

.github/workflows/postgres-redis-ci.yml

@@ -26,4 +26,6 @@ jobs:
         env:
           TEST_POSTGRES: true
         timeout-minutes: 5
-        run: npm test
+        run: npx nyc --silent npm test
+      - name: Generate coverage report
+        run: npm run cover:report

.gitignore

@@ -47,4 +47,5 @@ working
 /dist/
 
 # nyc coverage output
-.nyc_output/
+.nyc_output/
+coverage/

.nycrc.json

@@ -1,5 +1,14 @@
 {
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "check-coverage": false,
+  "ski-full": true,
+  "reporter": ["text", "html"],
+  "include": [
+    "src/**/*.ts"
+  ],
   "exclude": [
-    "src/routes/addUnlitedVideo.ts"
+    "src/routes/addUnlistedVideo.ts",
+    "src/cronjob/downvoteSegmentArchiveJob.ts",
+    "src/databases/*"
   ]
 }

ci.json

@@ -4,11 +4,12 @@
     "globalSalt": "testSalt",
     "adminUserID": "4bdfdc9cddf2c7d07a8a87b57bf6d25389fb75d1399674ee0e0938a6a60f4c3b",
     "newLeafURLs": ["placeholder"],
-    "discordReportChannelWebhookURL": "http://127.0.0.1:8081/ReportChannelWebhook",
-    "discordFirstTimeSubmissionsWebhookURL": "http://127.0.0.1:8081/FirstTimeSubmissionsWebhook",
-    "discordCompletelyIncorrectReportWebhookURL": "http://127.0.0.1:8081/CompletelyIncorrectReportWebhook",
-    "discordNeuralBlockRejectWebhookURL": "http://127.0.0.1:8081/NeuralBlockRejectWebhook",
+    "discordReportChannelWebhookURL": "http://127.0.0.1:8081/webhook/ReportChannel",
+    "discordFirstTimeSubmissionsWebhookURL": "http://127.0.0.1:8081/webhook/FirstTimeSubmissions",
+    "discordCompletelyIncorrectReportWebhookURL": "http://127.0.0.1:8081/webhook/CompletelyIncorrectReport",
+    "discordNeuralBlockRejectWebhookURL": "http://127.0.0.1:8081/webhook/NeuralBlockReject",
     "neuralBlockURL": "http://127.0.0.1:8081/NeuralBlock",
+    "userCounterURL": "http://127.0.0.1:8081/UserCounter",
     "behindProxy": true,
     "postgres": {
         "user": "ci_db_user",
@@ -70,5 +71,10 @@
           "statusCode": 200
         }
     },
+    "patreon": {
+        "clientId": "testClientID",
+        "clientSecret": "testClientSecret",
+        "redirectUri": "http://127.0.0.1/fake/callback"
+    },
     "minReputationToSubmitFiller": -1
 }

package.json

@@ -5,7 +5,8 @@
   "main": "src/index.ts",
   "scripts": {
     "test": "npm run tsc && ts-node test/test.ts",
-    "test:coverage": "nyc npm run test",
+    "cover": "nyc npm test",
+    "cover:report": "nyc report",
     "dev": "nodemon",
     "dev:bash": "nodemon -x 'npm test ; npm start'",
     "postgres:docker": "docker run --rm -p 5432:5432 -e POSTGRES_USER=ci_db_user -e POSTGRES_PASSWORD=ci_db_pass postgres:alpine",
@@ -32,15 +33,18 @@
     "sync-mysql": "^3.0.1"
   },
   "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@types/better-sqlite3": "^7.5.0",
     "@types/cron": "^2.0.0",
     "@types/express": "^4.17.13",
     "@types/lodash": "^4.14.182",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.0.3",
     "@types/pg": "^8.6.5",
+    "@types/sinon": "^10.0.13",
     "@typescript-eslint/eslint-plugin": "^5.30.6",
     "@typescript-eslint/parser": "^5.30.6",
+    "axios-mock-adapter": "^1.21.2",
     "eslint": "^8.19.0",
     "mocha": "^10.0.0",
     "nodemon": "^2.0.19",

src/app.ts

@@ -200,6 +200,7 @@ function setupRoutes(router: Router) {
     router.get("/api/generateToken/:type", generateTokenRequest);
     router.get("/api/verifyToken", verifyTokenRequest);
 
+    /* istanbul ignore next */
     if (config.postgres?.enabled) {
         router.get("/database", (req, res) => dumpDatabase(req, res, true));
         router.get("/database.json", (req, res) => dumpDatabase(req, res, false));

src/routes/deleteLockCategories.ts

@@ -35,6 +35,7 @@ export async function deleteLockCategoriesEndpoint(req: DeleteLockCategoriesRequ
         || !categories
         || !Array.isArray(categories)
         || categories.length === 0
+        || actionTypes && !Array.isArray(actionTypes)
         || actionTypes.length === 0
     ) {
         return res.status(400).json({
@@ -48,7 +49,7 @@ export async function deleteLockCategoriesEndpoint(req: DeleteLockCategoriesRequ
 
     if (!userIsVIP) {
         return res.status(403).json({
-            message: "Must be a VIP to mark videos.",
+            message: "Must be a VIP to lock videos.",
         });
     }
 

src/routes/generateToken.ts

@@ -24,6 +24,7 @@ export async function generateTokenRequest(req: GenerateTokenRequest, res: Respo
     if (type === TokenType.patreon || (type === TokenType.local && adminUserIDHash === config.adminUserID)) {
         const licenseKey = await createAndSaveToken(type, code);
 
+        /* istanbul ignore else */
         if (licenseKey) {
             return res.status(200).send(`
                 <h1>
@@ -45,5 +46,7 @@ export async function generateTokenRequest(req: GenerateTokenRequest, res: Respo
                 </h1>
             `);
         }
+    } else {
+        return res.sendStatus(403);
     }
 }

src/routes/getDaysSavedFormatted.ts

@@ -7,7 +7,11 @@ export async function getDaysSavedFormatted(req: Request, res: Response): Promis
     if (row !== undefined) {
         //send this result
         return res.send({
-            daysSaved: row.daysSaved.toFixed(2),
+            daysSaved: row.daysSaved?.toFixed(2) ?? "0",
+        });
+    } else {
+        return res.send({
+            daysSaved: 0
         });
     }
 }

src/routes/getIsUserVIP.ts

@@ -21,7 +21,7 @@ export async function getIsUserVIP(req: Request, res: Response): Promise<Respons
             hashedUserID: hashedUserID,
             vip: vipState,
         });
-    } catch (err) {
+    } catch (err) /* istanbul ignore next */ {
         Logger.error(err as string);
         return res.sendStatus(500);
     }

src/routes/getLockCategories.ts

@@ -33,7 +33,7 @@ export async function getLockCategories(req: Request, res: Response): Promise<Re
             categories,
             actionTypes
         });
-    } catch (err) {
+    } catch (err) /* istanbul ignore next */{
         Logger.error(err as string);
         return res.sendStatus(500);
     }

src/routes/getLockCategoriesByHash.ts

@@ -44,14 +44,25 @@ const mergeLocks = (source: DBLock[], actionTypes: ActionType[]): LockResultByHa
 
 export async function getLockCategoriesByHash(req: Request, res: Response): Promise<Response> {
     let hashPrefix = req.params.prefix as VideoIDHash;
-    const actionTypes: ActionType[] = req.query.actionTypes
-        ? JSON.parse(req.query.actionTypes as string)
-        : req.query.actionType
-            ? Array.isArray(req.query.actionType)
-                ? req.query.actionType
-                : [req.query.actionType]
-            : [ActionType.Skip, ActionType.Mute];
+    let actionTypes: ActionType[] = [];
+    try {
+        actionTypes = req.query.actionTypes
+            ? JSON.parse(req.query.actionTypes as string)
+            : req.query.actionType
+                ? Array.isArray(req.query.actionType)
+                    ? req.query.actionType
+                    : [req.query.actionType]
+                : [ActionType.Skip, ActionType.Mute];
+        if (!Array.isArray(actionTypes)) {
+            //invalid request
+            return res.sendStatus(400);
+        }
+    } catch (err) {
+        //invalid request
+        return res.status(400).send("Invalid request: JSON parse error (actionTypes)");
+    }
     if (!hashPrefixTester(req.params.prefix)) {
+
         return res.status(400).send("Hash prefix does not match format requirements."); // Exit early on faulty prefix
     }
     hashPrefix = hashPrefix.toLowerCase() as VideoIDHash;
@@ -62,7 +73,7 @@ export async function getLockCategoriesByHash(req: Request, res: Response): Prom
         if (lockedRows.length === 0 || !lockedRows[0]) return res.sendStatus(404);
         // merge all locks
         return res.send(mergeLocks(lockedRows, actionTypes));
-    } catch (err) {
+    } catch (err) /* istanbul ignore next */ {
         Logger.error(err as string);
         return res.sendStatus(500);
     }