Merge pull request #11 from FOSWLY/dev

v2.1.3

Author: ilyhalight

.github/workflows/deploy.yml

@@ -0,0 +1,24 @@
+name: Deploy
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Configure SSH 🔧
+        run: |
+          mkdir -p ~/.ssh
+          echo -e "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts
+      - name: Connect and deploy 🔧
+        run: |
+          ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "
+            sudo ./translate-backend-deploy.sh GITHUB_REPOSITORY=${{ github.repository }} LOKI_HOST=${{ secrets.LOKI_HOST }} LOKI_USER=${{ secrets.LOKI_USER }} LOKI_PASSWORD=${{ secrets.LOKI_PASSWORD }} SERVICE_PORT=${{ secrets.SERVICE_PORT }} ALLOW_UNSAFE_EVAL=${{ secrets.ALLOW_UNSAFE_EVAL }} &&
+            exit
+          "

README.md

@@ -28,10 +28,7 @@
 
 Если вы хотите использовать несколько версий сервера переводов, то вам необходимо реализовать версионирование с помощью путей через ваш веб-сервер.
 
-Наш сервер [translate.toil.cc](https://translate.toil.cc) поддерживает версионирование с помощью нескольких путей. Доступные версии API:
-
-1. `/v2` - (поддерживается) - использовать версию, которая совместима с новыми ответами из 2.1.0
-2. без указания версии (устаревшая) - использовать устаревшую версию 2.0, которая будет удалена через N время
+Наш сервер [translate.toil.cc](https://translate.toil.cc) поддерживает только самую последнюю версию.
 
 ## 📦 Деплой
 
@@ -48,8 +45,8 @@ git clone https://github.com/FOSWLY/translate-backend
 bun install
 ```
 
-1. Переименуйте `.example.env` в `.env` и установите необходимые поля
-2. Запустите сервер
+4. Переименуйте `.example.env` в `.env` и установите необходимые поля
+5. Запустите сервер
 
 ```bash
 bun start

bun.lock

@@ -1,3 +1,9 @@
+# 2.1.3
+
+- Изменен метод установки cors на установку с помощью библиотеки `@elysiajs/cors`
+- Библиотека `pino` и ее модули заменены на `@vaylo/pino`
+- Обновлены зависимости
+
 # 2.1.2
 
 - Добавлена проверка на allowUnsafeEval при создание клиента перевода

changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "translate-backend",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "author": "Toil",
   "repository": {
     "type": "git",
@@ -13,29 +13,28 @@
     "prepare": "husky"
   },
   "dependencies": {
+    "@elysiajs/cors": "^1.2.0",
     "@elysiajs/swagger": "^1.2.2",
-    "@toil/translate": "^1.0.6",
-    "elysia": "^1.2.21",
-    "elysia-http-status-code": "^1.0.9",
-    "pino": "^9.6.0",
-    "pino-loki": "^2.5.0"
+    "@toil/translate": "^1.0.7",
+    "@vaylo/pino": "^1.0.1",
+    "elysia": "^1.2.25",
+    "elysia-http-status-code": "^1.0.9"
   },
   "devDependencies": {
-    "@sinclair/typebox": "^0.34.28",
-    "bun-types": "^1.2.3",
-    "eslint": "^9.21.0",
-    "eslint-plugin-oxlint": "^0.15.11",
+    "@sinclair/typebox": "^0.34.33",
+    "bun-types": "^1.2.9",
+    "eslint": "^9.24.0",
+    "eslint-plugin-oxlint": "^0.16.6",
     "husky": "^9.1.7",
-    "oxlint": "^0.15.11",
-    "pino-pretty": "^13.0.0",
-    "typescript-eslint": "^8.24.1"
+    "oxlint": "^0.16.6",
+    "typescript-eslint": "^8.29.1"
   },
   "module": "src/index.js",
   "bun-create": {
     "start": "bun run src/index.ts"
   },
   "type": "module",
   "peerDependencies": {
-    "typescript": "^5.6.3"
+    "typescript": "^5.7.3"
   }
 }

package.json

@@ -24,11 +24,12 @@ export default Value.Parse(ConfigSchema, {
   logging: {
     level: Bun.env.NODE_ENV === "production" ? "info" : "debug",
     logPath: path.join(__dirname, "..", "logs"),
+    logToFile: Bun.env.LOG_TO_FILE === "true",
     loki: {
       host: Bun.env.LOKI_HOST,
       user: Bun.env.LOKI_USER,
       password: Bun.env.LOKI_PASSWORD,
-      label: Bun.env.LOKI_LABEL,
+      label: Bun.env.LOKI_LABEL ?? "translate-backend",
     },
   },
 });

src/config.ts

@@ -2,6 +2,8 @@ import fs from "node:fs/promises";
 
 import { Elysia } from "elysia";
 import { swagger } from "@elysiajs/swagger";
+import { cors } from "@elysiajs/cors";
+import { HttpStatusCode } from "elysia-http-status-code";
 
 import config from "./config";
 import { log } from "./logging";
@@ -11,7 +13,6 @@ import translate from "./controllers/translate";
 import detect from "./controllers/detect";
 import getLangs from "./controllers/getLangs";
 import { LibreTransalteDisabledError } from "./errors";
-import { HttpStatusCode } from "elysia-http-status-code";
 
 if (!(await fs.exists(config.logging.logPath))) {
   await fs.mkdir(config.logging.logPath, { recursive: true });
@@ -48,11 +49,7 @@ const app = new Elysia({
     }),
   )
   .use(HttpStatusCode())
-  .onRequest(({ set }) => {
-    for (const [key, val] of Object.entries(config.cors)) {
-      set.headers[key] = val;
-    }
-  })
+  .use(cors(config.cors))
   .error({
     LIBRE_TRANSLATE_DISABLED: LibreTransalteDisabledError,
   })

src/index.ts

@@ -1,64 +1,15 @@
-import * as path from "node:path";
-import { pino, type TransportMultiOptions, type TransportTargetOptions } from "pino";
-
 import config from "@/config";
+import { PinoClient } from "@vaylo/pino";
 
-const { loki } = config.logging;
-const startingDate = new Date().toISOString().split("T")[0];
-
-type PinoOpts = Parameters<typeof pino>[0] & {
-  transport: TransportMultiOptions & { targets: TransportTargetOptions[] };
-};
-
-// https://github.com/pinojs/pino/issues/1791
-// if don't take out the options separately, it willn't work
-const opts: PinoOpts = {
-  level: config.logging.level,
-  redact: {
-    // these just cause clutter
-    paths: ["pid", "hostname"],
-    remove: true,
-  },
-  transport: {
-    targets: [],
-  },
-};
+const {
+  logging: { loki, level, logPath, logToFile },
+} = config;
 
-// it may be higher level than global, but it cann't be lower
-opts.transport.targets.push({
-  level: config.logging.level,
-  target: "pino-pretty",
-  options: {
-    colorized: true,
-  },
+export const loggerClient = new PinoClient({
+  loki,
+  level,
+  logToFile,
+  logPath,
 });
 
-opts.transport.targets.push({
-  level: config.logging.level,
-  target: "pino/file",
-  options: {
-    destination: path.join(config.logging.logPath, `${startingDate}.log`),
-  },
-});
-
-if (loki.host) {
-  opts.transport.targets.push({
-    level: config.logging.level,
-    target: "pino-loki",
-    options: {
-      batching: true,
-      interval: 5,
-      labels: { application: config.logging.loki.label },
-      host: loki.host,
-      basicAuth:
-        loki.user && loki.password
-          ? {
-              username: loki.user,
-              password: loki.password,
-            }
-          : undefined,
-    },
-  });
-}
-
-export const log = pino(opts);
+export const log = loggerClient.init();

src/logging.ts

@@ -1,4 +1,5 @@
 import { Type as t, type Static } from "@sinclair/typebox";
+import { Config as LoggingConfig } from "@vaylo/pino/schema";
 
 import { version } from "../../package.json";
 
@@ -40,21 +41,12 @@ export const ConfigSchema = t.Object({
     allowUnsafeEval: t.Boolean({ default: false }),
   }),
   cors: t.Object({
-    "Access-Control-Allow-Origin": t.String({ default: "*" }),
-    "Access-Control-Allow-Headers": t.String({ default: "*" }),
-    "Access-Control-Allow-Methods": t.String({ default: "POST, GET, OPTIONS" }),
-    "Access-Control-Max-Age": t.String({ default: "86400" }),
-  }),
-  logging: t.Object({
-    level: LoggingLevel,
-    logPath: t.String(),
-    loki: t.Object({
-      host: t.String({ default: "" }),
-      user: t.String({ default: "" }),
-      password: t.String({ default: "" }),
-      label: t.String({ default: "translate-backend" }),
-    }),
+    allowedHeaders: t.String({ default: "*" }),
+    origin: t.String({ default: "*" }),
+    methods: t.String({ default: "GET, POST, OPTIONS" }),
+    maxAge: t.Number({ default: 86400 }),
   }),
+  logging: LoggingConfig,
 });
 
 export type ConfigSchemaType = Static<typeof ConfigSchema>;