chore(deps): update oven/bun docker tag to v1.2.11

Co-authored-by: Renovate Bot <renovate@t00n.de>
Reviewed-on: #32

.bun-version

@@ -1 +1 @@
-1.1.42
+1.2.11

.gitea/workflows/cd.yaml

@@ -9,6 +9,28 @@ env:
   DOCKER_REGISTRY: gitea.t000-n.de
 
 jobs:
+  check-changes:
+    name: Check changes
+    runs-on: ubuntu-latest
+    outputs:
+      changes: ${{ steps.filter.outputs.code }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: filter
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            code:
+              - 'src/**'
+              - '.bun-version'
+              - 'package.json'
+              - 'tsconfig.json'
+              - 'Dockerfile'
+              - 'bun.lockb'
+
   test:
     name: Test
     runs-on: ubuntu-latest
@@ -36,18 +58,20 @@ jobs:
         arch: [amd64, arm64]
     needs:
       - test
+      - check-changes
     runs-on:
       - ubuntu-latest
       - linux_${{ matrix.arch }}
+    if: ${{ needs.check-changes.outputs.changes == 'true' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.DOCKER_REGISTRY }}
           username: ${{ secrets.REGISTRY_USER }}
@@ -60,7 +84,7 @@ jobs:
           echo REPO_VERSION=$(git describe --tags --always | sed 's/^v//') >> $GITHUB_OUTPUT
 
       - name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: ./Dockerfile
@@ -68,7 +92,7 @@ jobs:
           push: true
           provenance: false
           tags: |
-            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-${{ matrix.arch }}
+            ${{ env.DOCKER_REGISTRY }}/t00n/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-${{ matrix.arch }}
 
   create_manifest:
     name: Create manifest
@@ -86,7 +110,7 @@ jobs:
           echo REPO_VERSION=$(git describe --tags --always | sed 's/^v//') >> $GITHUB_OUTPUT
 
       - name: Login to Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.DOCKER_REGISTRY }}
           username: ${{ secrets.REGISTRY_USER }}
@@ -94,8 +118,8 @@ jobs:
 
       - name: Create manifest
         run: |
-          docker manifest create ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:latest \
-            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-amd64 \
-            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-arm64
+          docker manifest create ${{ env.DOCKER_REGISTRY }}/t00n/${{ steps.meta.outputs.REPO_NAME }}:latest \
+            ${{ env.DOCKER_REGISTRY }}/t00n/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-amd64 \
+            ${{ env.DOCKER_REGISTRY }}/t00n/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-arm64
 
-          docker manifest push ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:latest
+          docker manifest push ${{ env.DOCKER_REGISTRY }}/t00n/${{ steps.meta.outputs.REPO_NAME }}:latest

Dockerfile

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

package.json

@@ -1,25 +1,27 @@
 {
   "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"
+    "check:spell": "cspell --config cspell.code.json **/*.ts",
+    "start": "bun run src/main.ts"
   },
   "devDependencies": {
     "@types/ts3-nodejs-library": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^5.46.0",
     "@typescript-eslint/parser": "^5.46.0",
-    "cspell": "^6.17.0",
+    "cspell": "^8.0.0",
     "eslint": "^8.29.0",
-    "typescript": "^4.9.3",
+    "typescript": "^5.0.0",
     "@types/bun": "latest"
   },
   "dependencies": {
     "env-var": "^7.5.0",
     "gotify": "^1.1.0",
-    "ts3-nodejs-library": "^3.4.1",
-    "winston": "^3.8.2"
+    "pino": "^9.6.0",
+    "pino-pretty": "^13.0.0",
+    "ts3-nodejs-library": "^3.4.1"
   },
   "name": "ts3gotify",
-  "module": "src/app.ts",
+  "module": "src/main.ts",
   "type": "module"
 }

renovate.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
+}

src/app.ts

@@ -1,136 +0,0 @@
-import { Gotify } from "gotify";
-import {
-  QueryProtocol,
-  TeamSpeak,
-  TextMessageTargetMode,
-} from "ts3-nodejs-library";
-import { createLogger, transports, format } from "winston";
-
-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 = createLogger({
-  level: LOG_LEVEL,
-  transports: [new transports.Console()],
-  format: format.combine(format.colorize(), format.timestamp()),
-});
-
-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 Object.assign(
-    {
-      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");
-
-  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/env.ts

@@ -11,13 +11,16 @@ const envVar = from(process.env, {
       throw new Error("Invalid log level");
     }
   },
-  asTs3GotifyMode: (value): Mode => {
+  asTs3GotifyMode: (value): Mode[] => {
+    const parsedValue: string[] = envVar.accessors.asJsonArray(value);
+
     const modes = ["connect", "disconnect", "moved", "message"];
-    if (modes.includes(value)) {
-      return value as Mode;
-    } else {
+    for (const mode of parsedValue) {
+      if (!modes.includes(mode)) {
         throw new Error("Invalid mode");
       }
+    }
+    return parsedValue as Mode[];
   },
 });
 
@@ -46,8 +49,4 @@ export const GOTIFY_TITLE = envVar
   .default("ts3gotify")
   .asString();
 
-export const MODE = envVar
-  .get("MODE")
-  .default("['connect']")
-  .asJsonArray()
-  .map((value) => value.asTs3GotifyMode());
+export const MODE = envVar.get("MODE").default('["connect"]').asTs3GotifyMode();

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;
+};