feat: initial prototype

.gitea/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Node.js CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint and Test
+
+    steps:
+      - name: Checkout Source Files
+        uses: actions/checkout@v4
+
+      - name: Use Node.js v22
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 9
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Lint Source Files
+        run: pnpm run lint
+
+      - name: Verify Build
+        run: pnpm run build
+
+      - name: Run Tests
+        run: pnpm run test

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+prod
+coverage

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "eslint.validate": ["typescript"]
+}

eslint.config.js

@@ -0,0 +1,5 @@
+import NaomisConfig from "@nhcarrigan/eslint-config";
+
+export default [
+    ...NaomisConfig
+]

package.json

@@ -0,0 +1,27 @@
+{
+	"name": "alert-server",
+	"version": "0.0.0",
+	"description": "A web server that sends alerts to our Matrix room.",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"build": "rm -rf prod && tsc",
+		"lint": "eslint src --max-warnings 0",
+		"start": "op run --env-file=prod.env --no-masking -- node prod/index.js",
+		"test": "echo \"Error: no test specified\" && exit 0"
+	},
+	"keywords": [],
+	"author": "Naomi Carrigan",
+	"license": "See license in LICENSE.md",
+	"devDependencies": {
+		"@nhcarrigan/eslint-config": "5.1.0",
+		"@nhcarrigan/typescript-config": "4.0.0",
+		"@types/node": "22.13.1",
+		"eslint": "9.20.0",
+		"typescript": "5.7.3"
+	},
+	"dependencies": {
+		"fastify": "5.2.1",
+		"matrix-js-sdk": "36.1.0"
+	}
+}

prod.env

@@ -0,0 +1,3 @@
+MATRIX_ACCESS_TOKEN="op://Environment Variables - Naomi/Alert Server/matrix_access_token"
+MATRIX_ROOM_ID="op://Environment Variables - Naomi/Alert Server/matrix_room_id"
+API_AUTH="op://Environment Variables - Naomi/Alert Server/api_auth"

src/index.ts

@@ -0,0 +1,40 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+import { createClient } from "matrix-js-sdk";
+import { instantiateServer } from "./server/serve.js";
+import type { Logger } from "matrix-js-sdk/lib/logger.js";
+
+const logger: Logger = {
+  debug: () => {
+    return null;
+  },
+  error: () => {
+    return null;
+  },
+  getChild: () => {
+    return logger;
+  },
+  info: () => {
+    return null;
+  },
+  trace: () => {
+    return null;
+  },
+  warn: () => {
+    return null;
+  },
+};
+
+const client = createClient({
+  accessToken: process.env.MATRIX_ACCESS_TOKEN ?? "",
+  baseUrl:     "https://matrix.nhcarrigan.com",
+  logger:      logger,
+  userId:      "@alerts:matrix.nhcarrigan.com",
+});
+
+await client.startClient({ initialSyncLimit: 10 });
+instantiateServer(client);

src/interfaces/error.ts

@@ -0,0 +1,11 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+export interface Error {
+  application: string;
+  stack:       string;
+  message:     string;
+  context:     string;
+}

src/interfaces/log.ts

@@ -0,0 +1,10 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+export interface Log {
+  application: string;
+  level:       string;
+  message:     string;
+}

src/interfaces/uptime.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+export interface Uptime {
+  application: string;
+  message:     string;
+}

src/schemas/errorSchema.ts

@@ -0,0 +1,19 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+export const errorSchema = {
+  schema: {
+    body: {
+      properties: {
+        application: { type: "string" },
+        context:     { type: "string" },
+        message:     { type: "string" },
+        stack:       { type: "string" },
+      },
+      type: "object",
+    },
+  },
+};

src/schemas/logSchema.ts

@@ -0,0 +1,18 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+export const logSchema = {
+  schema: {
+    body: {
+      properties: {
+        application: { type: "string" },
+        level:       { type: "string" },
+        message:     { type: "string" },
+      },
+      type: "object",
+    },
+  },
+};

src/schemas/uptimeSchema.ts

@@ -0,0 +1,17 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+export const uptimeSchema = {
+  schema: {
+    body: {
+      properties: {
+        application: { type: "string" },
+        message:     { type: "string" },
+      },
+      type: "object",
+    },
+  },
+};

src/server/serve.ts

@@ -0,0 +1,153 @@
+/**
+ * @copyright nhcarrigan
+ * @license Naomi's Public License
+ * @author Naomi Carrigan
+ */
+
+import fastify from "fastify";
+import { MsgType, type MatrixClient } from "matrix-js-sdk";
+import { errorSchema } from "../schemas/errorSchema.js";
+import { logSchema } from "../schemas/logSchema.js";
+import { uptimeSchema } from "../schemas/uptimeSchema.js";
+import type { Error } from "../interfaces/error.js";
+import type { Log } from "../interfaces/log.js";
+import type { Uptime } from "../interfaces/uptime.js";
+
+const html = `<!DOCTYPE html>
+<html>
+  <head>
+    <title>Alert Server</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="A basic web server that allows us to pipe logs and errors from our applications into a Matrix room." />
+    <script src="https://cdn.nhcarrigan.com/headers/index.js" async defer></script>
+  </head>
+  <body>
+    <main>
+    <h1>Alert Server</h1>
+    <section>
+      <p>AI-powered multi-purpose assistant for Discord!</p>
+    </section>
+    <section>
+        <h2>Links</h2>
+        <p>
+            <a href="https://git.nhcarrigan.com/nhcarrigan/alert-server">
+                <i class="fa-solid fa-code"></i> Source Code
+            </a>
+        </p>
+        <p>
+            <a href="https://docs.nhcarrigan.com/">
+                <i class="fa-solid fa-book"></i> Documentation
+            </a>
+        </p>
+        <p>
+            <a href="https://chat.nhcarrigan.com">
+                <i class="fa-solid fa-circle-info"></i> Support
+            </a>
+        </p>
+    </section>
+    </main>
+  </body>
+</html>`;
+
+/**
+ * Starts up the server to receive events.
+ * @param client - The authenticated Matrix client.
+ */
+// eslint-disable-next-line max-lines-per-function -- This function is long because it is setting up a server.
+export const instantiateServer = (client: MatrixClient): void => {
+  try {
+    const server = fastify({
+      logger: false,
+    });
+
+    server.get("/", (_request, response) => {
+      response.header("Content-Type", "text/html");
+      response.send(html);
+    });
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention -- Body must be capitalised for Fastify.
+    server.post<{ Body: Log }>("/log", logSchema, async(request, response) => {
+      const { application, level, message } = request.body;
+      await client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+        body:           `**${application}** - *${level}*\n${message}`,
+        format:         "org.matrix.custom.html",
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+        formatted_body: `<strong>${application}</strong> - <em>${level}</em><br>${message}`,
+        msgtype:        MsgType.Text,
+      });
+      await response.status(200).send({ success: true });
+    });
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention -- Body must be capitalised for Fastify.
+    server.post<{ Body: Error }>(
+      "/error",
+      errorSchema,
+      async(request, response) => {
+        const { application, context, stack, message } = request.body;
+        await client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+          body:           `**${application}** - *Error in ${context}*\n${message}\n\`\`\`\n${stack}\n\`\`\``,
+          format:         "org.matrix.custom.html",
+          // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+          formatted_body: `<strong>${application}</strong> - <em>Error in ${context}</em><br>${message}<br><code>${stack}</code>`,
+          msgtype:        MsgType.Text,
+        });
+        await response.status(200).send({ success: true });
+      },
+    );
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention -- Body must be capitalised for Fastify.
+    server.post<{ Body: Uptime }>(
+      "/uptime",
+      uptimeSchema,
+      async(request, response) => {
+        const { application, message } = request.body;
+        await client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+          body:           `${message}\n${application}`,
+          format:         "org.matrix.custom.html",
+          // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+          formatted_body: `${message}<br><sub>${application}</sub>`,
+          msgtype:        MsgType.Text,
+        });
+        await response.status(200).send({ success: true });
+      },
+    );
+
+    server.listen({ port: 5003 }, (error) => {
+      const application = "Alert Server";
+      if (error) {
+        const { message, stack } = error;
+        const context = "Server Startup";
+        void client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+          body:           `**${application}** - *Error in ${context}*\n${message}\n\`\`\`\n${stack ?? "No stack trace available."}\n\`\`\``,
+          format:         "org.matrix.custom.html",
+          // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+          formatted_body: `<strong>${application}</strong> - <em>Error in ${context}</em><br>${message}<br><code>${stack ?? "No stack trace available."}</code>`,
+          msgtype:        MsgType.Text,
+        });
+        return;
+      }
+      const level = "debug";
+      const message = `Server listening on port 5003.`;
+      void client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+        body:           `**${application}** - *${level}*\n${message}`,
+        format:         "org.matrix.custom.html",
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+        formatted_body: `<strong>${application}</strong> - <em>${level}</em><br>${message}`,
+        msgtype:        MsgType.Text,
+      });
+    });
+  } catch (error) {
+    const application = "Alert Server";
+    const context = "Server Startup";
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Totally being lazy.
+    const { message, stack } = error as Error;
+    void client.sendMessage(process.env.MATRIX_ROOM_ID ?? "", {
+      body:           `**${application}** - *Error in ${context}*\n${message}\n\`\`\`\n${stack}\n\`\`\``,
+      format:         "org.matrix.custom.html",
+      // eslint-disable-next-line @typescript-eslint/naming-convention -- Requirement of the SDK.
+      formatted_body: `<strong>${application}</strong> - <em>Error in ${context}</em><br>${message}<br><code>${stack}</code>`,
+      msgtype:        MsgType.Text,
+    });
+  }
+};

tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "@nhcarrigan/typescript-config",
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./prod"
+    },
+    "exclude": ["test/**/*.ts", "vitest.config.ts"]
+}