1 Commits

Author SHA1 Message Date
e77c8c5757 fix: run bun in container CMD
All checks were successful
CI / Test (pull_request) Successful in 26s
2025-01-08 13:50:40 +01:00
10 changed files with 156 additions and 230 deletions

View File

@@ -64,38 +64,8 @@ jobs:
with: with:
context: . context: .
file: ./Dockerfile file: ./Dockerfile
platforms: linux/${{ matrix.arch }} platform: linux/${{ matrix.arch }}
push: true push: true
provenance: false
tags: | tags: |
${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}-${{ matrix.arch }} ${{ 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
create_manifest:
name: Create manifest
needs:
- build_and_push
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- 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@v2
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 }}: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 push ${{ env.DOCKER_REGISTRY }}/t.behrendt/${{ steps.meta.outputs.REPO_NAME }}:latest

View File

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

View File

@@ -16,8 +16,8 @@ COPY --from=install /temp/dev/node_modules node_modules
COPY . . COPY . .
RUN bun run build RUN bun run build
FROM base AS release FROM base as release
COPY --from=install /temp/prod/node_modules node_modules COPY --from=install /temp/prod/node_modules node_modules
COPY --from=build /app/dist . COPY --from=build /app/dist .
CMD [ "bun", "/app/main.js"] CMD [ "bun", "/app/app.js"]

BIN
bun.lockb

Binary file not shown.

View File

@@ -1,10 +1,8 @@
{ {
"scripts": { "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: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",
"test:integration": "bun test ./tests/*"
}, },
"devDependencies": { "devDependencies": {
"@types/ts3-nodejs-library": "^2.0.1", "@types/ts3-nodejs-library": "^2.0.1",
@@ -18,11 +16,10 @@
"dependencies": { "dependencies": {
"env-var": "^7.5.0", "env-var": "^7.5.0",
"gotify": "^1.1.0", "gotify": "^1.1.0",
"pino": "^9.6.0", "ts3-nodejs-library": "^3.4.1",
"pino-pretty": "^13.0.0", "winston": "^3.8.2"
"ts3-nodejs-library": "^3.4.1"
}, },
"name": "ts3gotify", "name": "ts3gotify",
"module": "src/main.ts", "module": "src/app.ts",
"type": "module" "type": "module"
} }

136
src/app.ts Normal file
View File

@@ -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);
});
});

View File

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

View File

@@ -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();

View File

@@ -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>;

View File

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