Merge branch 'master' into ai/issue-48
Some checks failed
Test / test (push) Failing after 2s

This commit is contained in:
2026-10-15 11:14:37 +00:00
3 changed files with 211 additions and 16 deletions

View File

@@ -0,0 +1,170 @@
// Tests for the settings menu opened from the main menu (Syndria98/dragonroll#47): it used to show a
// "Syntax Error" instead of the menu, and the main menu did not come back after closing it.
//
// vue-i18n answers every translation with `SyntaxError: cannot support locale type` from the moment the
// locale it holds is something it has no messages for. The settings window put `GetUserSetting('lang')`
// straight into that locale, and for a user that never picked a language that is `undefined`: the server
// answers GET /user/get-settings with `settings: undefined`. The locale is global, so the one bad write
// broke every window on screen — the settings window and the main menu behind it.
//
// The repository root installs no dependencies, so the window's script is lifted out of its `<script setup>`
// block and run in a `node:vm` context with `locale` and `selectedLocale` as plain refs, the way
// tests/sidebar-section-pane.test.js loads the sidebar script. The window wiring (coming back to the main
// menu on close, the strings the menu draws) is read from the sources like tests/item-sheet-window.test.js.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const windowSource = read("frontend", "app", "components", "windows", "SettingsWindow.vue");
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
const userRouteSource = read("backend", "src", "routes", "user.js");
const script = /<script setup>([\s\S]*?)<\/script>/.exec(windowSource)?.[1];
// Top-level `function name(){...}` or `const name = (...) => {...}` of the script block: their bodies are
// indented, so the first `}` in column 0 closes them.
function declarationSource(name) {
assert.ok(script, "expected the settings window to have a <script setup> block");
const decl = new RegExp(`(function ${name}\\s*\\(|const ${name}\\s*=)[\\s\\S]*?\\n\\}`).exec(script)?.[0];
assert.ok(decl, `expected a top-level ${name} in the settings window script`);
return decl;
}
// The languages Dragonroll offers (frontend/i18n/locales.ts).
const LOCALES = [
{ code: "en", name: "English" },
{ code: "es", name: "Español" },
{ code: "ca", name: "Català" },
];
// The settings window with the language it is showing. `saved` collects every language the window asks the
// server to store, so a test can tell a language that was applied from one that was merely answered with.
function settingsWindow({ locale = "en" } = {}) {
const body = [
declarationSource("getLocaleFromCode"),
declarationSource("localeToShow"),
declarationSource("applyLanguage"),
declarationSource("getLocaleName"),
declarationSource("changeLocale"),
"return { localeToShow, applyLanguage, getLocaleName, changeLocale };",
].join("\n\n");
const state = {
locale: { value: locale },
selectedLocale: { value: null },
saved: [],
};
const api = vm.compileFunction(body, ["locale", "selectedLocale", "locales", "SetUserSetting"], {
parsingContext: vm.createContext({}),
})(
state.locale,
state.selectedLocale,
LOCALES,
(key, value) => state.saved.push([key, value])
);
return Object.assign(state, api);
}
test("a user without a stored language keeps the one on screen", () => {
const settings = settingsWindow({ locale: "en" });
// What GetUserSetting('lang') answers for a user that never picked a language: the server has no
// settings for them at all.
settings.applyLanguage(undefined);
assert.equal(settings.locale.value, "en", "the language on screen must not be replaced by nothing");
assert.equal(typeof settings.locale.value, "string", "vue-i18n only takes a locale it knows a type for");
});
test("a stored language Dragonroll does not offer is not applied either", () => {
for (const stored of ["", null, "fr", "en-US", 0, {}]) {
const settings = settingsWindow({ locale: "en" });
settings.applyLanguage(stored);
assert.equal(settings.locale.value, "en", `${String(stored)} is no language vue-i18n takes`);
}
});
test("the stored language is applied when it is one of the offered ones", () => {
for (const [code, name] of [["es", "Español"], ["ca", "Català"]]) {
const settings = settingsWindow({ locale: "en" });
assert.equal(settings.applyLanguage(code), true, `${code} must be applied`);
assert.equal(settings.locale.value, code);
assert.equal(settings.selectedLocale.value.name, name, "the dropdown shows the language applied");
}
});
test("the dropdown always shows a language, and never one the window has not got", () => {
const settings = settingsWindow({ locale: "en" });
assert.deepEqual(settings.localeToShow(undefined), LOCALES[0], "no language stored: the first one is shown");
assert.deepEqual(settings.localeToShow("de"), LOCALES[0], "an unknown code shows the same language");
assert.deepEqual(settings.localeToShow("ca"), LOCALES[2]);
assert.match(
script,
/const selectedLocale = ref\(localeToShow\(locale\.value\)\)/,
"the dropdown starts on the language being shown instead of on an empty row"
);
});
test("the dropdown label survives a language that is not there", () => {
const settings = settingsWindow();
assert.equal(settings.getLocaleName(undefined), "");
assert.equal(settings.getLocaleName(LOCALES[1]), "Español");
});
test("picking a language saves it, and picking nothing saves nothing", () => {
const settings = settingsWindow();
settings.changeLocale(LOCALES[2]);
assert.deepEqual(settings.saved, [["lang", "ca"]]);
assert.equal(settings.locale.value, "ca");
const nothing = settingsWindow();
nothing.changeLocale(undefined);
assert.deepEqual(nothing.saved, [], "a language that was not applied is not saved either");
assert.equal(nothing.locale.value, "en");
});
test("the window never hands the server's answer to vue-i18n directly", () => {
assert.match(script, /GetUserSetting\(['"]lang['"]\)/, "the stored language is still read from the server");
assert.match(
script,
/GetUserSetting\(['"]lang['"]\)\s*\.then\(\s*\(value\) => applyLanguage\(value\)\s*\)/,
"it goes through applyLanguage, which only accepts a language Dragonroll offers"
);
const writes = [...script.matchAll(/locale\.value\s*=\s*([^;]+);/g)].map((write) => write[1].trim());
assert.deepEqual(writes, ["stored.code"], "only a language looked up in the offered list reaches vue-i18n");
assert.match(script, /\.catch\(/, "a settings request that fails leaves the language alone");
});
test("GET /user/get-settings answers without a settings object for a user that saved none", () => {
// The window has to cope with what this answers: the reason #47 shows up for every fresh account.
assert.match(userRouteSource, /router\.get\(['"]\/get-settings['"]/);
assert.match(userRouteSource, /settings: data\.settings/);
});
test("closing the settings window goes back to the main menu", () => {
const definition = /^\s{2}settings:\s*\{[\s\S]*?\n \},/m.exec(windowDefsSource)?.[0];
assert.ok(definition, "expected the settings window to be registered");
assert.match(definition, /SettingsWindow\.vue/);
assert.match(definition, /ClearWindow\(\s*\{\s*type:\s*['"]settings['"]\s*\}\s*\)/);
assert.match(definition, /CreateWindow\(\s*['"]main_menu['"]\s*\)/);
});
test("every locale names the settings menu and its tabs", () => {
for (const locale of ["en", "es", "ca"]) {
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
assert.ok(settings.tabs?.["account-settings"], `${locale} is missing the account settings tab`);
assert.ok(settings.tabs?.["site-administration"], `${locale} is missing the site administration tab`);
assert.ok(settings["account-settings"]?.language, `${locale} is missing the language label`);
assert.ok(settings["site-administration"]?.["manage-accounts"], `${locale} is missing manage accounts`);
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
assert.ok(windows.settings, `${locale} is missing the settings window title`);
}
});