type safety

.bun-version

@@ -1 +1 @@
-1.3.4
+1.1.42

.gitea/workflows/cd.yaml

@@ -4,14 +4,6 @@ on:
   push:
     branches:
       - main
-    paths:
-      - src/**
-      - .bun-version
-      - package.json
-      - tsconfig.json
-      - Dockerfile
-      - bun.lockb
-  workflow_dispatch:
 
 env:
   DOCKER_REGISTRY: gitea.t000-n.de
@@ -22,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+        uses: actions/checkout@v4
 
-      - uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2
+      - uses: oven-sh/setup-bun@v2
         with:
           bun-version-file: ".bun-version"
 
@@ -49,13 +41,13 @@ jobs:
       - linux_${{ matrix.arch }}
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+        uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3
+        uses: docker/setup-buildx-action@v2
 
       - name: Login to Registry
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3
+        uses: docker/login-action@v2
         with:
           registry: ${{ env.DOCKER_REGISTRY }}
           username: ${{ secrets.REGISTRY_USER }}
@@ -68,66 +60,12 @@ jobs:
           echo REPO_VERSION=$(git describe --tags --always | sed 's/^v//') >> $GITHUB_OUTPUT
 
       - name: Build and push
-        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6
+        uses: docker/build-push-action@v4
         with:
           context: .
           file: ./Dockerfile
-          platforms: linux/${{ matrix.arch }}
+          platform: linux/${{ matrix.arch }}
           push: true
-          provenance: false
           tags: |
-            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-${{ matrix.arch }}
-
-  create_tag:
-    name: Create tag
-    needs:
-      - test
-    runs-on: ubuntu-latest
-    outputs:
-      tag: ${{ steps.tag.outputs.new-tag }}
-    steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
-        with:
-          fetch-depth: 0
-      - uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@0.1.20
-        id: tag
-        with:
-          token: ${{ secrets.GITEA_TOKEN }}
-          prerelease: ${{ github.event_name == 'workflow_dispatch' }}
-      - uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@0.0.2
-        with:
-          tag: ${{ steps.tag.outputs.new-tag }}
-      - name: Set output
-        run: |
-          echo "tag=${{ steps.tag.outputs.new-tag }}" >> $GITHUB_OUTPUT
-
-  create_manifest:
-    name: Create manifest
-    needs:
-      - build_and_push
-      - create_tag
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
-
-      - name: Get Metadata
-        id: meta
-        run: |
-          echo REPO_NAME=$(echo ${GITHUB_REPOSITORY} | awk -F"/" '{print $2}' | tr '[:upper:]' '[:lower:]') >> $GITHUB_OUTPUT
-          echo REPO_VERSION=$(git describe --tags --always | sed 's/^v//') >> $GITHUB_OUTPUT
-
-      - name: Login to Registry
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3
-        with:
-          registry: ${{ env.DOCKER_REGISTRY }}
-          username: ${{ secrets.REGISTRY_USER }}
-          password: ${{ secrets.REGISTRY_PASSWORD }}
-
-      - name: Create manifest
-        run: |
-          docker manifest create ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ needs.create_tag.outputs.tag }} \
-            ${{ 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 push ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ needs.create_tag.outputs.tag }}
+            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}
+            ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:latest

.gitea/workflows/ci.yaml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+        uses: actions/checkout@v4
 
-      - uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2
+      - uses: oven-sh/setup-bun@v2
         with:
           bun-version-file: ".bun-version"
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM oven/bun:1.3.4@sha256:7608db4aeb44f1fe8169cc8ec7055376b3013557b106407ccf092b00e426407d AS base
+FROM oven/bun:1.1.42 AS base
 
 WORKDIR /app
 
@@ -16,8 +16,8 @@ COPY --from=install /temp/dev/node_modules node_modules
 COPY . .
 RUN bun run build
 
-FROM base AS release
+FROM base as release
 COPY --from=install /temp/prod/node_modules node_modules
 COPY --from=build /app/dist .
 
-CMD [ "bun", "/app/main.js"]
+CMD [ "node", "/app/app.js"]

package.json

@@ -1,26 +1,25 @@
 {
   "scripts": {
-    "build": "bun build --minify --target bun --outdir dist --sourcemap src/main.ts",
+    "build": "bun build --minify --target bun --outdir dist --sourcemap src/app.ts",
     "check:code": "eslint src/ --ext .ts",
-    "check:spell": "cspell --config cspell.code.json **/*.ts",
-    "start": "bun run src/main.ts"
+    "check:spell": "cspell --config cspell.code.json **/*.ts"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "5.62.0",
-    "@typescript-eslint/parser": "5.62.0",
-    "cspell": "8.19.4",
-    "eslint": "8.57.1",
-    "typescript": "5.9.3",
+    "@types/ts3-nodejs-library": "^2.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.46.0",
+    "@typescript-eslint/parser": "^5.46.0",
+    "cspell": "^6.17.0",
+    "eslint": "^8.29.0",
+    "typescript": "^4.9.3",
     "@types/bun": "latest"
   },
   "dependencies": {
-    "env-var": "7.5.0",
-    "gotify": "1.1.0",
-    "pino": "10.1.0",
-    "pino-pretty": "13.1.3",
-    "ts3-nodejs-library": "3.5.1"
+    "env-var": "^7.5.0",
+    "gotify": "^1.1.0",
+    "ts3-nodejs-library": "^3.4.1",
+    "winston": "^3.8.2"
   },
   "name": "ts3gotify",
-  "module": "src/main.ts",
+  "module": "src/app.ts",
   "type": "module"
 }

renovate.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "local>t.behrendt/renovate-configs:common",
-    "local>t.behrendt/renovate-configs:action"
-  ],
-  "packageRules": [
-    {
-      "matchPackageNames": ["Bun", "oven/bun"],
-      "groupName": "bun version"
-    }
-  ]
-}

src/app.ts

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

src/main.ts

@@ -1,64 +0,0 @@
-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

@@ -1,106 +0,0 @@
-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,8 +1,3 @@
 export type Mode = "connect" | "disconnect" | "moved" | "message";
 
 export type LogLevel = "error" | "info" | "debug";
-
-export type GotifyConfig = {
-  app: string;
-  title: string;
-};