feat(i18n): add server-side i18n for notification agents

Adds @formatjs/intl-based translation support to all notification agents, allowing notifications to
be sent in each user's preferred language or a configurable system locale for channel-based agents.

fix #1576, fix #1706

Author: fallenbagel

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
 
             This usually happens when you've added or modified translation strings in your code but haven't updated the translation file.
 
-            Please run `pnpm i18n:extract` and commit the changes.
+            Please run `pnpm i18n:extract` and/or `pnpm i18n:extract:server` and commit the changes.
         run: |
           retry() { n=0; until "$@"; do n=$((n+1)); [ $n -ge 3 ] && break; echo "retry $n: $*" >&2; sleep 2; done; }
           check_failed=0; node bin/check-i18n.js || check_failed=$?

bin/check-i18n.js

@@ -1,39 +1,52 @@
 #!/usr/bin/env node
-
+/* eslint-disable @typescript-eslint/no-require-imports, no-console */
 /**
  * Check that i18n locale files are in sync with extracted messages.
- * Runs `pnpm i18n:extract` and compares en.json; exits 1 if they differ.
+ * Runs extract scripts and compares en.json; exits 1 if they differ.
  */
 const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 
-const localePath = path.join(
-  __dirname,
-  '..',
-  'src',
-  'i18n',
-  'locale',
-  'en.json'
-);
-const backupPath = `${localePath}.bak`;
+const targets = [
+  {
+    localePath: path.join(__dirname, '..', 'src', 'i18n', 'locale', 'en.json'),
+    script: 'pnpm i18n:extract',
+  },
+  {
+    localePath: path.join(
+      __dirname,
+      '..',
+      'server',
+      'lib',
+      'i18n',
+      'locale',
+      'en.json'
+    ),
+    script: 'pnpm i18n:extract:server',
+  },
+];
 
-try {
-  fs.copyFileSync(localePath, backupPath);
-  execSync('pnpm i18n:extract', { stdio: 'inherit' });
-  const original = fs.readFileSync(backupPath, 'utf8');
-  const extracted = fs.readFileSync(localePath, 'utf8');
-  fs.unlinkSync(backupPath);
+for (const { localePath, script } of targets) {
+  const backupPath = `${localePath}.bak`;
+  try {
+    fs.copyFileSync(localePath, backupPath);
+    execSync(script, { stdio: 'inherit' });
 
-  if (original !== extracted) {
-    console.error(
-      "i18n messages are out of sync. Please run 'pnpm i18n:extract' and commit the changes."
-    );
-    process.exit(1);
-  }
-} catch (err) {
-  if (fs.existsSync(backupPath)) {
+    const original = fs.readFileSync(backupPath, 'utf8');
+    const extracted = fs.readFileSync(localePath, 'utf8');
     fs.unlinkSync(backupPath);
+
+    if (original !== extracted) {
+      console.error(
+        `i18n messages are out of sync. Please run '${script}' and commit the changes.`
+      );
+      process.exit(1);
+    }
+  } catch (err) {
+    if (fs.existsSync(backupPath)) {
+      fs.unlinkSync(backupPath);
+    }
+    throw err;
   }
-  throw err;
 }

package.json

@@ -7,14 +7,15 @@
     "preinstall": "npx only-allow pnpm",
     "postinstall": "next telemetry disable",
     "dev": "nodemon -e ts --watch server --watch seerr-api.yml -e .json,.ts,.yml -x ts-node -r tsconfig-paths/register --files --project server/tsconfig.json server/index.ts",
-    "build:server": "tsc --project server/tsconfig.json && copyfiles -u 2 server/templates/**/*.{html,pug} dist/templates && tsc-alias -p server/tsconfig.json",
+    "build:server": "tsc --project server/tsconfig.json && copyfiles -u 2 server/templates/**/*.{html,pug} dist/templates && copyfiles -u 2 \"server/lib/i18n/locale/*.json\" dist/lib/i18n/locale && tsc-alias -p server/tsconfig.json",
     "build:next": "next build",
     "build": "pnpm build:next && pnpm build:server",
     "lint": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --cache",
     "lintfix": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --fix",
     "test": "node server/test/index.mts",
     "start": "NODE_ENV=production node dist/index.js",
     "i18n:extract": "ts-node --project server/tsconfig.json src/i18n/extractMessages.ts",
+    "i18n:extract:server": "ts-node --project server/tsconfig.json server/lib/i18n/extractMessages.ts",
     "migration:generate": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:generate -d server/datasource.ts",
     "migration:create": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:create -d server/datasource.ts",
     "migration:run": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:run -d server/datasource.ts",
@@ -36,6 +37,7 @@
   "dependencies": {
     "@dr.pogodin/csurf": "^1.16.6",
     "@fontsource-variable/inter": "^5.2.8",
+    "@formatjs/intl": "^4.1.4",
     "@formatjs/intl-displaynames": "6.8.13",
     "@formatjs/intl-locale": "3.1.1",
     "@formatjs/intl-pluralrules": "5.4.6",

pnpm-lock.yaml

@@ -5,6 +5,7 @@ import DiscoverSlider from '@server/entity/DiscoverSlider';
 import { Session } from '@server/entity/Session';
 import { User } from '@server/entity/User';
 import { startJobs } from '@server/job/schedule';
+import { initI18n } from '@server/lib/i18n';
 import notificationManager from '@server/lib/notifications';
 import DiscordAgent from '@server/lib/notifications/agents/discord';
 import EmailAgent from '@server/lib/notifications/agents/email';
@@ -82,6 +83,8 @@ app
     const settings = await getSettings().load();
     restartFlag.initializeSettings(settings);
 
+    initI18n();
+
     if (settings.network.forceIpv4First) {
       axios.defaults.httpAgent = new http.Agent({ family: 4 });
       axios.defaults.httpsAgent = new https.Agent({ family: 4 });