mirror of
https://github.com/ether/etherpad-lite.git
synced 2026-07-17 16:47:05 +00:00
* fix(admin): restore i18n on /admin by copying locales to the right path The admin SPA fetches `/admin/locales/<lang>.json`. Building with vite-plugin-static-copy and `src: '../src/locales'` was placing the 115 core locale files at `src/templates/admin/src/locales/` (the plugin's `dirClean` strips a leading `../` but keeps the remaining parent path). The express admin handler 404'd those fetches, fell back to serving `index.html`, JSON.parse silently failed, and every `<Trans>` rendered its raw key — see #7586. Replace the plugin with a small inline build/dev plugin: at build time copy `src/locales/*.json` to `<outDir>/locales/`; in dev serve the same files via middleware so `vite dev` also works. Drop the now-unused `vite-plugin-static-copy` dependency. Add regression coverage that none of the existing admin specs had: - backend HTTP test for GET /admin/locales/{en,de}.json - Playwright admin i18n spec asserting translated <h1> renders for the default locale and for ?lng=de, plus a request-level check that the response is JSON, not the SPA fallback. Closes #7586 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(admin): bundle locales via import.meta.glob, drop copy plugin The first pass at #7586 replaced vite-plugin-static-copy with a custom build/dev plugin that copied src/locales/*.json into the admin output and served them in dev. That works, but the vite-plugin-static-copy README explicitly recommends the public directory or a JS import for this case, and the import path is strictly cleaner: no copy step, no /admin/locales/* express route, no SPA-fallback-shaped failure mode. Use import.meta.glob in admin/src/localization/i18n.ts so each language ships as its own hashed JSON chunk and is lazy-loaded on demand. The vite config goes back to just react + base + outDir. The plugin namespaces (e.g. ep_admin_pads) keep their existing admin/public/<ns>/<lang>.json layout. Tests: - Drop tests/backend/specs/adminLocales.ts — it asserted on a /admin/locales/<lang>.json route that this approach no longer uses; the regression mechanism it pinned doesn't exist anymore and the test required the admin frontend to be built before the backend test runs (which CI doesn't do). - Keep tests/frontend-new/admin-spec/admini18n.spec.ts (rendered <h1> in default and ?lng=de). Verified red→green: reverting just the loader to the pre-fix /admin/locales fetch makes both specs fail; restoring makes them pass. Also update pnpm-lock.yaml to drop the now-unused vite-plugin-static-copy entries — fixes ERR_PNPM_OUTDATED_LOCKFILE that was failing every CI install upfront. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
John McLear
GitHub
parent
ea57f764ad
commit
5fd600d608
5 changed files with 86 additions and 64 deletions
|
|
@ -37,7 +37,6 @@
|
|||
"typescript": "^6.0.3",
|
||||
"vite": "npm:rolldown-vite@7.2.10",
|
||||
"vite-plugin-babel": "^1.6.0",
|
||||
"vite-plugin-static-copy": "^4.1.0",
|
||||
"zustand": "^5.0.12"
|
||||
},
|
||||
"overrides": {
|
||||
|
|
|
|||
|
|
@ -1,36 +1,47 @@
|
|||
import i18n from 'i18next'
|
||||
import {initReactI18next} from "react-i18next";
|
||||
import LanguageDetector from 'i18next-browser-languagedetector'
|
||||
import type {BackendModule} from 'i18next';
|
||||
|
||||
// Core translations live in /src/locales (shared with the pad UI). Letting
|
||||
// Vite resolve them via import.meta.glob means each language ships as its own
|
||||
// hashed JSON chunk, lazy-loaded on demand — no build-time copy step or
|
||||
// /admin/locales/* express route. Earlier setups copying files into the build
|
||||
// output were fragile (see https://github.com/ether/etherpad/issues/7586).
|
||||
const coreLocales = import.meta.glob<{default: Record<string, unknown>}>(
|
||||
'../../../src/locales/*.json');
|
||||
|
||||
import { BackendModule } from 'i18next';
|
||||
const coreLocaleByLang = (language: string) =>
|
||||
coreLocales[`../../../src/locales/${language}.json`];
|
||||
|
||||
const LazyImportPlugin: BackendModule = {
|
||||
type: 'backend',
|
||||
init: function () {
|
||||
},
|
||||
read: async function (language, namespace, callback) {
|
||||
|
||||
let baseURL = import.meta.env.BASE_URL
|
||||
if(namespace === "translation") {
|
||||
// If default we load the translation file
|
||||
baseURL+=`/locales/${language}.json`
|
||||
} else {
|
||||
// Else we load the former plugin translation file
|
||||
baseURL+=`/${namespace}/${language}.json`
|
||||
}
|
||||
|
||||
const localeJSON = await fetch(baseURL)
|
||||
let json;
|
||||
|
||||
try {
|
||||
json = JSON.parse(await localeJSON.text())
|
||||
} catch(e) {
|
||||
callback(new Error("Error loading"), null);
|
||||
if (namespace === 'translation') {
|
||||
const loader = coreLocaleByLang(language);
|
||||
if (!loader) {
|
||||
callback(new Error(`No core locale for "${language}"`), null);
|
||||
return;
|
||||
}
|
||||
const mod = await loader();
|
||||
callback(null, mod.default);
|
||||
return;
|
||||
}
|
||||
// Plugin namespaces (e.g. ep_admin_pads) are still served as static
|
||||
// assets from admin/public/<namespace>/<lang>.json.
|
||||
const baseURL = `${import.meta.env.BASE_URL}/${namespace}/${language}.json`;
|
||||
const res = await fetch(baseURL);
|
||||
if (!res.ok) {
|
||||
callback(new Error(`HTTP ${res.status} loading ${baseURL}`), null);
|
||||
return;
|
||||
}
|
||||
callback(null, await res.json());
|
||||
} catch (e) {
|
||||
callback(e instanceof Error ? e : new Error(String(e)), null);
|
||||
}
|
||||
|
||||
|
||||
callback(null, json);
|
||||
},
|
||||
|
||||
save: function () {
|
||||
|
|
|
|||
|
|
@ -1,36 +1,31 @@
|
|||
import { defineConfig } from 'vite'
|
||||
import {viteStaticCopy} from "vite-plugin-static-copy";
|
||||
import react from '@vitejs/plugin-react';
|
||||
import react from '@vitejs/plugin-react'
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
plugins: [viteStaticCopy({
|
||||
targets: [
|
||||
{
|
||||
src: '../src/locales',
|
||||
dest: ''
|
||||
}
|
||||
]
|
||||
}), react({
|
||||
babel: {
|
||||
plugins: ['babel-plugin-react-compiler'],
|
||||
}})],
|
||||
base: '/admin',
|
||||
build:{
|
||||
outDir: '../src/templates/admin',
|
||||
emptyOutDir: true,
|
||||
},
|
||||
server:{
|
||||
plugins: [
|
||||
react({
|
||||
babel: {
|
||||
plugins: ['babel-plugin-react-compiler'],
|
||||
},
|
||||
}),
|
||||
],
|
||||
base: '/admin',
|
||||
build: {
|
||||
outDir: '../src/templates/admin',
|
||||
emptyOutDir: true,
|
||||
},
|
||||
server: {
|
||||
proxy: {
|
||||
'/socket.io/*': {
|
||||
target: 'http://localhost:9001',
|
||||
changeOrigin: true,
|
||||
rewrite: (path) => path.replace(/^\/api/, '')
|
||||
rewrite: (path) => path.replace(/^\/api/, ''),
|
||||
},
|
||||
'/admin-auth/': {
|
||||
target: 'http://localhost:9001',
|
||||
changeOrigin: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
'/admin-auth/': {
|
||||
target: 'http://localhost:9001',
|
||||
changeOrigin: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue