Merge branch 'main' into DRY

Author: joppekoers

Dockerfile

@@ -18,7 +18,7 @@ COPY package.json ./
 COPY package-lock.json ./
 
 # Setup the application itself
-RUN npm install --silent
+RUN npm install
 
 COPY . ./
 
@@ -28,4 +28,4 @@ RUN npm run build
 ENTRYPOINT [ "npm", "run", "start" ]
 
 # For debugging.
-# ENTRYPOINT ["tail", "-f", "/dev/null"]
+# ENTRYPOINT ["tail", "-f", "/dev/null"]

config/.env-example

@@ -18,5 +18,3 @@ WEBHOOK_UPDATE_SECRET = ""
 # https://profile.intra.42.fr/oauth/applications/8540
 INTRA_UID = ""
 INTRA_SECRET = ""
-
-SENTRY_SECRET = ""

package.json

@@ -26,7 +26,7 @@
 		"ts-node-dev": "^1.1.6"
 	},
 	"scripts": {
-		"prepare": "[ -d .git ] && (P=.git/hooks/pre-commit; echo \"#!/bin/sh\\nnpm run lint:check\" > $P; chmod 777 $P)",
+		"prepare": "[ -d .git ] && (P=.git/hooks/pre-commit; echo \"#!/bin/sh\\nnpm run lint:check\" > $P; chmod 777 $P) || true",
 		"dev": "ts-node-dev --quiet --rs --respawn --clear --transpile-only src/app.ts",
 		"init-db": "sqlite3 ./db/peerdb.sqlite < ./sql/default.sql",
 		"build": "tsc",

sql/default.sql

@@ -5,6 +5,7 @@ CREATE TABLE IF NOT EXISTS expiredTeam(
 	created_at INTEGER DEFAULT (datetime('now', 'localtime'))
 );
 
+-- Students that want to receive notifcations.
 CREATE TABLE IF NOT EXISTS evaluators(
 	intraUID INTEGER PRIMARY KEY NOT NULL,
 	slackUID varchar(512) NOT NULL,
@@ -16,3 +17,9 @@ CREATE TABLE IF NOT EXISTS evaluators(
 
 	notifyOfNewLock BOOLEAN NOT NULL
 );
+
+-- Avoid duplicate deliveries.
+CREATE TABLE IF NOT EXISTS webhookDeliveries(
+	delivery varchar(1024) PRIMARY KEY NOT NULL,
+	body varchar(65535) NOT NULL
+)

src/bots/webhook.ts

@@ -14,9 +14,35 @@ import { IntraWebhook } from "../utils/types";
 import Logger, { LogType } from "../utils/logger";
 import { Request, Response, NextFunction } from "express";
 import * as Checks from "../checks/evaluators";
+import db from "../db";
 
 /*============================================================================*/
 
+// Intra, like many distributed systems will sometimes deliver the same webhook > 1 times
+// This is where we filter those situations
+async function filterAlreadyDeliveredWebhook(req: Request) {
+	const headerKey = "x-delivery";
+	const id = req.headers[headerKey];
+	if (!id || typeof id !== "string") {
+		Logger.log(`WEBHOOK: Request header "${headerKey}" has invalid value of: "${id}"`);
+		return false;
+	}
+
+	const hasDelivery = await db.hasWebhookDelivery(id).catch((e) => {
+		Logger.log(`WEBHOOK: Could not load from db: ${e}`);
+		return false;
+	});
+	if (hasDelivery) {
+		return true;
+	}
+
+	await db.addWebhookDelivery(id, JSON.stringify(req.body)).catch((e) => {
+		Logger.log(`WEBHOOK: Could not add webhook delivery: ${e}`);
+	});
+
+	return false;
+}
+
 /**
  * Filters for requests and sends back corresponding error.
  * @param req The incoming request.
@@ -161,6 +187,7 @@ webhookApp.post("/create", filterHook(Env.WEBHOOK_CREATE_SECRET), async (req: Re
 		});
 		if (yeetEval != undefined) {
 			await Intra.deleteEvaluation(yeetEval);
+			res.status(200).send();
 			return Logger.log(`Evaluation cancelled: These users shouldn't evaluate each other, yikes.`);
 		}
 	}
@@ -198,7 +225,7 @@ webhookApp.post("/create", filterHook(Env.WEBHOOK_CREATE_SECRET), async (req: Re
 webhookApp.post("/delete", filterHook(Env.WEBHOOK_DELETE_SECRET), async (req: Request, res: Response) => {
 	const hook: IntraWebhook.Root = req.body;
 
-	Logger.log(`Evaluation destroyed: ${hook.team.name} -> ${hook.project.name}`);
+	Logger.log(`Evaluation destroyed: ${hook.team.name} -> ${hook.project.name} -> ID: ${req.headers["x-delivery"]}`);
 	if (hook.user && hook.user.id != Config.botID) {
 		res.status(204).send();
 		return Logger.log("Ignored: Webhook does not concern bot.");
@@ -232,7 +259,7 @@ webhookApp.post("/delete", filterHook(Env.WEBHOOK_DELETE_SECRET), async (req: Re
 webhookApp.post("/update", filterHook(Env.WEBHOOK_UPDATE_SECRET), async (req: Request, res: Response) => {
 	const hook: IntraWebhook.Root = req.body;
 
-	Logger.log(`Evaluation update: ${hook.team.name} -> ${hook.project.name}`);
+	Logger.log(`Evaluation update: ${hook.team.name} -> ${hook.project.name} -> ID: ${req.headers["x-delivery"]}`);
 
 	try {
 		const check = await DB.exists(hook.team.id);

src/db.ts

@@ -58,6 +58,14 @@ namespace DB {
 		return team.amount > 0;
 	}
 
+	export async function hasWebhookDelivery(id: string): Promise<boolean> {
+		return !!(await dbGet<any>(`SELECT delivery FROM webhookDeliveries WHERE delivery = '${id}'`));
+	}
+
+	export async function addWebhookDelivery(id: string, body: string): Promise<void> {
+		await dbRun(`INSERT INTO webhookDeliveries(delivery, body) VALUES('${id}', '${body}')`);
+	}
+
 	export async function saveEvaluator(user: User, notify: boolean): Promise<void> {
 		const { intraUID, intraLogin, slackUID, email, level, campusID } = user;
 		const staff = user.staff ? 1 : 0;