add test script and ci

Reviewed-on: #11
Co-authored-by: Timo Behrendt <t.behrendt@t00n.de>
Co-committed-by: Timo Behrendt <t.behrendt@t00n.de>

.gitea/workflows/ci.yaml

@@ -23,3 +23,6 @@ jobs:
 
       - name: Run spellcheck
         run: bun run check:spell
+
+      - name: Run integration tests
+        run: bun run test:integration

Dockerfile

@@ -20,4 +20,4 @@ FROM base AS release
 COPY --from=install /temp/prod/node_modules node_modules
 COPY --from=build /app/dist .
 
-CMD [ "bun", "/app/app.js"]
+CMD [ "bun", "/app/main.js"]

package.json

@@ -1,9 +1,10 @@
 {
   "scripts": {
-    "build": "bun build --minify --target bun --outdir dist --sourcemap src/app.ts",
+    "build": "bun build --minify --target bun --outdir dist --sourcemap src/main.ts",
     "check:code": "eslint src/ --ext .ts",
     "check:spell": "cspell --config cspell.code.json **/*.ts",
-    "start": "bun run src/app.ts"
+    "start": "bun run src/main.ts",
+    "test:integration": "bun test ./tests/*"
   },
   "devDependencies": {
     "@types/ts3-nodejs-library": "^2.0.1",
@@ -22,6 +23,6 @@
     "ts3-nodejs-library": "^3.4.1"
   },
   "name": "ts3gotify",
-  "module": "src/app.ts",
+  "module": "src/main.ts",
   "type": "module"
 }

src/app.ts

@@ -1,141 +0,0 @@
-import { Gotify } from "gotify";
-import {
-  QueryProtocol,
-  TeamSpeak,
-  TextMessageTargetMode,
-} from "ts3-nodejs-library";
-
-import { pino } from "pino";
-
-import {
-  GOTIFY_TITLE,
-  GOTIFY_TOKEN,
-  GOTIFY_URL,
-  LOG_LEVEL,
-  MODE,
-  TS3_HOST,
-  TS3_NICKNAME,
-  TS3_PASSWORD,
-  TS3_QUERY_PORT,
-  TS3_SERVER_PORT,
-  TS3_USERNAME,
-} from "./env";
-import type { Mode } from "./types";
-
-const logger = pino({
-  level: LOG_LEVEL,
-  name: "ts3gotify",
-});
-
-const gotify = new Gotify({
-  server: GOTIFY_URL,
-});
-
-const gotifyConfig = {
-  app: GOTIFY_TOKEN,
-  title: GOTIFY_TITLE,
-};
-
-function getModes(): {
-  [key in Mode]: boolean;
-} {
-  const modes = MODE.map((mode) => {
-    return { [mode]: true };
-  });
-
-  return {
-    connect: false,
-    disconnect: false,
-    moved: false,
-    message: false,
-    ...modes,
-  };
-}
-
-function sendNotification(message: string) {
-  gotify
-    .send({
-      ...gotifyConfig,
-      message: message,
-    })
-    .catch((error: Error) => {
-      logger.error(`Error sending message to gotify: ${error.message}`);
-    });
-}
-
-function resolveMessageTarget(target: TextMessageTargetMode): string {
-  if (target === 1) {
-    return "Client";
-  } else if (target === 2) {
-    return "Channel";
-  } else {
-    return "Server";
-  }
-}
-
-function handleMessage(message: string) {
-  logger.debug(message);
-  sendNotification(message);
-}
-
-TeamSpeak.connect({
-  host: TS3_HOST,
-  queryport: TS3_QUERY_PORT,
-  serverport: TS3_SERVER_PORT,
-  protocol: QueryProtocol.RAW,
-  username: TS3_USERNAME,
-  password: TS3_PASSWORD,
-  nickname: TS3_NICKNAME,
-}).then((teamspeak) => {
-  const mode = getModes();
-
-  logger.info(
-    `connected to TS3 in modes: ${Object.entries(mode)
-      .filter(([_, value]) => value)
-      .map(([key]) => key)
-      .join(", ")}`
-  );
-
-  logger.info("connected to TS3");
-
-  if (mode.connect) {
-    teamspeak.on("clientconnect", (event) => {
-      handleMessage(`${event.client.nickname} connected`);
-    });
-  }
-
-  if (mode.disconnect) {
-    teamspeak.on("clientdisconnect", (event) => {
-      handleMessage(`${event.client?.nickname} disconnected`);
-    });
-  }
-
-  if (mode.message) {
-    teamspeak.on("textmessage", (event) => {
-      handleMessage(
-        `${event.invoker.nickname} wrote ${
-          event.msg
-        } to a ${resolveMessageTarget(event.targetmode)}`
-      );
-    });
-  }
-
-  if (mode.moved) {
-    teamspeak.on("clientmoved", (event) => {
-      handleMessage(
-        `${event.client.nickname} got moved to ${event.channel.name}`
-      );
-    });
-  }
-
-  teamspeak.on("close", async () => {
-    logger.debug("disconnected, trying to reconnect...");
-    await teamspeak.reconnect(5, 1000);
-    logger.info("reconnected!");
-  });
-
-  teamspeak.on("error", (error: Error) => {
-    logger.error(`Error connecting to TS3 server: ${error.message}`);
-    process.exit(1);
-  });
-});

src/main.ts

@@ -0,0 +1,64 @@
+import { Gotify } from "gotify";
+import { QueryProtocol, TeamSpeak } from "ts3-nodejs-library";
+
+import { pino } from "pino";
+
+import {
+  GOTIFY_TITLE,
+  GOTIFY_TOKEN,
+  GOTIFY_URL,
+  LOG_LEVEL,
+  MODE,
+  TS3_HOST,
+  TS3_NICKNAME,
+  TS3_PASSWORD,
+  TS3_QUERY_PORT,
+  TS3_SERVER_PORT,
+  TS3_USERNAME,
+} from "./env";
+import type { Mode } from "./types";
+import { getModes, ts3gotifyFactory } from "./ts3gotify";
+
+async function main() {
+  const logger = pino({
+    level: LOG_LEVEL,
+    name: "ts3gotify",
+  });
+
+  const gotify = new Gotify({
+    server: GOTIFY_URL,
+  });
+
+  const teamspeak = await TeamSpeak.connect({
+    host: TS3_HOST,
+    queryport: TS3_QUERY_PORT,
+    serverport: TS3_SERVER_PORT,
+    protocol: QueryProtocol.RAW,
+    username: TS3_USERNAME,
+    password: TS3_PASSWORD,
+    nickname: TS3_NICKNAME,
+  });
+  logger.info("connected to TS3");
+
+  const modeList = getModes(MODE);
+  const enabledModeNames = Object.entries(modeList)
+    .filter(([, value]) => value)
+    .map(([key]) => key);
+
+  logger.info(`connected to TS3 in modes: ${enabledModeNames.join(", ")}`);
+
+  const ts3gotify = ts3gotifyFactory(
+    teamspeak,
+    gotify,
+    {
+      app: GOTIFY_TOKEN,
+      title: GOTIFY_TITLE,
+    },
+    logger
+  );
+
+  for (const mode of enabledModeNames)
+    ts3gotify.registerEventListenerForMode(mode as Mode);
+}
+
+main();

src/ts3gotify.ts

@@ -0,0 +1,106 @@
+import type { Gotify } from "gotify";
+import type { Logger } from "pino";
+import type { TeamSpeak, TextMessageTargetMode } from "ts3-nodejs-library";
+import type { GotifyConfig, Mode } from "./types";
+import {
+  ClientConnect,
+  ClientDisconnect,
+  ClientMoved,
+  TextMessage,
+} from "ts3-nodejs-library/lib/types/Events";
+
+function resolveMessageTarget(target: TextMessageTargetMode): string {
+  if (target === 1) {
+    return "Client";
+  } else if (target === 2) {
+    return "Channel";
+  } else {
+    return "Server";
+  }
+}
+
+export function getModes(mode: Mode[]): {
+  [key in Mode]: boolean;
+} {
+  const modes = mode
+    .map((mode) => {
+      return { [mode]: true };
+    })
+    .reduce((acc, cur) => {
+      return { ...acc, ...cur };
+    });
+
+  return {
+    connect: false,
+    disconnect: false,
+    moved: false,
+    message: false,
+    ...modes,
+  };
+}
+
+export function ts3gotifyFactory(
+  ts3Client: TeamSpeak,
+  gotifyClient: Gotify,
+  gotifyConfig: GotifyConfig,
+  logger: Logger
+) {
+  function sendNotification(message: string) {
+    gotifyClient
+      .send({
+        ...gotifyConfig,
+        message: message,
+      })
+      .catch((error: Error) => {
+        logger.error(`Error sending message to gotify: ${error.message}`);
+      });
+  }
+
+  function registerEventListenerForMode(mode: Mode) {
+    switch (mode) {
+      case "connect":
+        ts3Client.on("clientconnect", (event: ClientConnect) =>
+          sendNotification(`${event.client.nickname} connected`)
+        );
+        break;
+      case "disconnect":
+        ts3Client.on("clientdisconnect", (event: ClientDisconnect) =>
+          sendNotification(`${event.client?.nickname} disconnected`)
+        );
+        break;
+      case "moved":
+        ts3Client.on("clientmoved", (event: ClientMoved) =>
+          sendNotification(
+            `${event.client.nickname} got moved to ${event.channel.name}`
+          )
+        );
+        break;
+      case "message":
+        ts3Client.on("textmessage", (event: TextMessage) =>
+          sendNotification(
+            `${event.invoker.nickname} wrote ${
+              event.msg
+            } to a ${resolveMessageTarget(event.targetmode)}`
+          )
+        );
+        break;
+    }
+  }
+
+  ts3Client.on("close", async () => {
+    logger.info("disconnected, trying to reconnect...");
+    await ts3Client.reconnect(5, 1000);
+    logger.info("reconnected!");
+  });
+
+  ts3Client.on("error", (error: Error) => {
+    logger.error(`Error connecting to TS3 server: ${error.message}`);
+    process.exit(1);
+  });
+
+  return {
+    registerEventListenerForMode,
+  };
+}
+
+export type Ts3Gotify = ReturnType<typeof ts3gotifyFactory>;

src/types.ts

@@ -1,3 +1,8 @@
 export type Mode = "connect" | "disconnect" | "moved" | "message";
 
 export type LogLevel = "error" | "info" | "debug";
+
+export type GotifyConfig = {
+  app: string;
+  title: string;
+};