This commit is contained in:
417
tests/foundry-actor-details.test.js
Normal file
417
tests/foundry-actor-details.test.js
Normal file
@@ -0,0 +1,417 @@
|
||||
// Tests for the D&D 5e details the system keeps as a reference to an embedded item
|
||||
// (Syndria98/dragonroll#54). `system.details.background` and `system.details.race` are
|
||||
// LocalDocumentFields: they hold the id of the actor's background / race item and never
|
||||
// its name, and their `fallback` option hands the bare id back when that item is gone.
|
||||
// Dragonroll holds names, so reading the id as a name and writing it back gave Foundry a
|
||||
// background item that does not exist and a details reference resolving to nothing —
|
||||
// adding a background in Foundry then failed.
|
||||
//
|
||||
// The backend mapper is plain CommonJS and is required directly. The Foundry module is
|
||||
// loaded into a `node:vm` context holding stubbed Foundry globals with fake timers, like
|
||||
// tests/foundry-sync-toggle.test.js: the characters Dragonroll answers with are applied
|
||||
// to a stubbed actor, so the references it writes are observable.
|
||||
//
|
||||
// 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 MODULE_ID = "dragonroll-foundry";
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
|
||||
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
|
||||
|
||||
// Foundry generates document ids as sixteen characters of its alphabet, digits included.
|
||||
const ID_GONE = "aB3cD9eF1gH2iJ4k";
|
||||
const ID_SOLDIER = "Kx7pQ2mR9vT4wZ8n";
|
||||
const ID_HUMAN = "7QcL2fYh5Bd0Mn3s";
|
||||
|
||||
function foundryActor(details = {}, items = []) {
|
||||
return { _id: "actor-1", name: "Thalia", type: "character", system: { details }, items };
|
||||
}
|
||||
|
||||
test("a background carried as an item arrives by its name, not its id", () => {
|
||||
const character = foundryActor(
|
||||
{ background: ID_SOLDIER },
|
||||
[{ _id: ID_SOLDIER, name: "Soldier", type: "background" }],
|
||||
);
|
||||
|
||||
assert.equal(foundryActorToCharacter(character).background, "Soldier");
|
||||
});
|
||||
|
||||
test("a background reference whose item is gone does not become a background", () => {
|
||||
// The item was deleted, and `fallback: true` gives the id back instead.
|
||||
const character = foundryActor({ background: ID_GONE }, []);
|
||||
|
||||
assert.equal(foundryActorToCharacter(character).background, "");
|
||||
});
|
||||
|
||||
test("a background item takes the place of a reference that resolves to nothing", () => {
|
||||
const character = foundryActor(
|
||||
{ background: ID_GONE },
|
||||
[{ _id: ID_SOLDIER, name: "Soldier", type: "background" }],
|
||||
);
|
||||
|
||||
assert.equal(foundryActorToCharacter(character).background, "Soldier");
|
||||
});
|
||||
|
||||
test("a plain-text background from an older system release is still a name", () => {
|
||||
const character = foundryActor({ background: "Sailor" }, []);
|
||||
|
||||
assert.equal(foundryActorToCharacter(character).background, "Sailor");
|
||||
});
|
||||
|
||||
test("the class, subclass and species references resolve the same way", () => {
|
||||
const items = [
|
||||
{ _id: ID_HUMAN, name: "Human", type: "race" },
|
||||
{ _id: "cls1Id00000000", name: "Fighter", type: "class" },
|
||||
{ _id: "sub1Id00000000", name: "Oracle", type: "subclass" },
|
||||
];
|
||||
const character = foundryActor(
|
||||
{ race: ID_HUMAN, class: "cls1Id00000000", subclass: "sub1Id00000000" },
|
||||
items,
|
||||
);
|
||||
|
||||
const fields = foundryActorToCharacter(character);
|
||||
assert.equal(fields.species, "Human");
|
||||
assert.equal(fields.className, "Fighter");
|
||||
assert.equal(fields.subclass, "Oracle");
|
||||
});
|
||||
|
||||
test("a class reference that resolves to nothing falls back to the class item", () => {
|
||||
const character = foundryActor(
|
||||
{ class: ID_GONE, race: ID_GONE },
|
||||
[{ _id: "cls1Id00000000", name: "Fighter", type: "class" }],
|
||||
);
|
||||
|
||||
const fields = foundryActorToCharacter(character);
|
||||
assert.equal(fields.className, "Fighter", "the class the actor carries, not the id");
|
||||
assert.equal(fields.species, "", "and nothing to name the species from");
|
||||
});
|
||||
|
||||
// --- The Foundry module applies Dragonroll's character --------------------------
|
||||
|
||||
// A reference is either the id this sync wrote or the document the field resolves to.
|
||||
function referenceId(actor, field) {
|
||||
const value = actor.system.details?.[field];
|
||||
return typeof value === "string" ? value : value?._id || "";
|
||||
}
|
||||
|
||||
function makeStubItem(id, { name, type, system = {}, flags = {} }) {
|
||||
return {
|
||||
_id: id,
|
||||
id,
|
||||
name,
|
||||
type,
|
||||
system,
|
||||
flags,
|
||||
parent: { documentName: "Actor" },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
toObject() {
|
||||
return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: this.flags };
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function writeDotted(target, data) {
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
const parts = key.split(".");
|
||||
const last = parts.pop();
|
||||
let node = target;
|
||||
for (const part of parts) node = node[part] ??= {};
|
||||
node[last] = value;
|
||||
}
|
||||
}
|
||||
|
||||
let stubCounter = 0;
|
||||
|
||||
function makeStubActor(name, { type = "character", system = {}, flags = {}, items = [] } = {}) {
|
||||
stubCounter += 1;
|
||||
const id = `actor-${stubCounter}`;
|
||||
const contents = items.map((item, index) => makeStubItem(item._id || `embedded-${stubCounter}-${index}`, item));
|
||||
const actor = {
|
||||
id,
|
||||
name,
|
||||
type,
|
||||
documentName: "Actor",
|
||||
img: "icons/svg/mystery-man.svg",
|
||||
system,
|
||||
flags,
|
||||
items: { contents },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(data) {
|
||||
writeDotted(this, data);
|
||||
return this;
|
||||
},
|
||||
async updateEmbeddedDocuments(documentName, updates) {
|
||||
for (const update of updates) {
|
||||
const item = contents.find((candidate) => candidate.id === update._id);
|
||||
if (item) writeDotted(item, update);
|
||||
}
|
||||
return updates.map((update) => contents.find((candidate) => candidate.id === update._id));
|
||||
},
|
||||
async createEmbeddedDocuments(documentName, datas) {
|
||||
const created = datas.map((data) => {
|
||||
const item = makeStubItem(`embedded-${stubCounter}-${contents.length}`, data);
|
||||
item.name = data.name;
|
||||
item.type = data.type;
|
||||
contents.push(item);
|
||||
return item;
|
||||
});
|
||||
return created;
|
||||
},
|
||||
async deleteEmbeddedDocuments(documentName, ids) {
|
||||
for (const id of ids) {
|
||||
const index = contents.findIndex((item) => item.id === id);
|
||||
if (index >= 0) contents.splice(index, 1);
|
||||
}
|
||||
return ids;
|
||||
},
|
||||
toObject() {
|
||||
return {
|
||||
_id: this.id,
|
||||
name: this.name,
|
||||
type: this.type,
|
||||
img: this.img,
|
||||
flags: this.flags,
|
||||
system: this.system,
|
||||
};
|
||||
},
|
||||
};
|
||||
return actor;
|
||||
}
|
||||
|
||||
// A linked world with the actors it holds, answering `foundry/sync/characters` with the
|
||||
// campaign's characters. Each one is applied to its Foundry actor on the next reconcile.
|
||||
function makeWorld({ actors = [], remoteActors = [] } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
nextTimerId: 1,
|
||||
logs: [],
|
||||
};
|
||||
|
||||
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: {
|
||||
log() {},
|
||||
info() {},
|
||||
warn: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||
error: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||
},
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||
},
|
||||
setTimeout: (fn, delay = 0) => {
|
||||
const timerId = state.nextTimerId++;
|
||||
state.timers.set(timerId, { fn, delay });
|
||||
return timerId;
|
||||
},
|
||||
clearTimeout: (timerId) => state.timers.delete(timerId),
|
||||
setInterval: () => 0,
|
||||
clearInterval: () => {},
|
||||
fetch: async (url, options = {}) => {
|
||||
const href = String(url);
|
||||
state.requests.push({ href, method: options.method, body: options.body ? JSON.parse(options.body) : null });
|
||||
if (href.includes("foundry/sync/characters")) return { ok: true, status: 200, json: async () => ({ status: "ok", actors: remoteActors }) };
|
||||
if (href.includes("foundry/sync/items")) return { ok: true, status: 200, json: async () => ({ status: "ok", items: [] }) };
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Item: { async create() { return null; } },
|
||||
Actor: {
|
||||
async create(data) {
|
||||
const actor = makeStubActor(data.name, {
|
||||
type: data.type,
|
||||
system: structuredClone(data.system || {}),
|
||||
flags: structuredClone(data.flags || {}),
|
||||
items: (data.items || []).map((item) => ({ name: item.name, type: item.type, system: item.system })),
|
||||
});
|
||||
actors.push(actor);
|
||||
return actor;
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: actors, get: (actorId) => actors.find((actor) => actor.id === actorId) },
|
||||
items: { contents: [], get: () => null },
|
||||
folders: { contents: [], get: () => null },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
state.registered.set(key, definition);
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) {
|
||||
settingsStore[key] = value;
|
||||
await state.registered.get(key)?.onChange?.(value);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||
|
||||
state.game = sandbox.game;
|
||||
state.actor = (actorId) => actors.find((actor) => actor.id === actorId);
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
|
||||
// World start: the actors are pushed, then the campaign's characters are applied.
|
||||
state.start = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
return state;
|
||||
};
|
||||
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
if (!state.timers.size && round > 2) break;
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
state.itemNames = (actor) => actor.items.contents.map((item) => [item.type, item.name]);
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
// The campaign's character for `actor`, holding what Dragonroll keeps for it.
|
||||
function campaignCharacter(actor, over = {}) {
|
||||
return {
|
||||
_id: "dr-actor-1",
|
||||
name: "Thalia",
|
||||
type: "character",
|
||||
species: "",
|
||||
className: "",
|
||||
subclass: "",
|
||||
level: 1,
|
||||
background: "",
|
||||
challengeRating: "",
|
||||
description: "",
|
||||
image: "",
|
||||
abilityScores: {},
|
||||
armorClass: 10,
|
||||
speed: 30,
|
||||
traits: "",
|
||||
proficiencies: "",
|
||||
spells: "",
|
||||
inventory: [],
|
||||
foundryActorId: actor?.id ?? null,
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
test("Dragonroll's background becomes the actor's background item, referenced by id", async () => {
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: { background: "" } },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, { background: "Soldier" })],
|
||||
}).start();
|
||||
|
||||
const background = actor.items.contents.find((item) => item.type === "background");
|
||||
assert.ok(background, "the character's background stands in Foundry as an item");
|
||||
assert.equal(background.name, "Soldier");
|
||||
assert.equal(referenceId(actor, "background"), background.id, "its details reference points at the item");
|
||||
assert.equal(actor.system.details.background, background.id);
|
||||
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||
});
|
||||
|
||||
test("the background an earlier sync invented is taken back out", async () => {
|
||||
// What the bug left behind: an item named after the id the details field held, next to
|
||||
// the real background, and a reference the old sync overwrote with that id.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: { background: ID_GONE } },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [
|
||||
{ _id: ID_SOLDIER, name: "Soldier", type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
{ _id: "item-bogus", name: ID_GONE, type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
],
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, { background: "Soldier" })],
|
||||
}).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [["background", "Soldier"]], "only the real background is left");
|
||||
assert.equal(referenceId(actor, "background"), ID_SOLDIER, "and the reference resolves to it");
|
||||
});
|
||||
|
||||
test("a background taken off in Dragonroll clears the reference", async () => {
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: { background: ID_SOLDIER } },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [
|
||||
{ _id: ID_SOLDIER, name: "Soldier", type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
],
|
||||
});
|
||||
const world = await makeWorld({ actors: [actor], remoteActors: [campaignCharacter(actor)] }).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [], "the background item went with it");
|
||||
assert.equal(referenceId(actor, "background"), "", "and no reference is left pointing at nothing");
|
||||
});
|
||||
|
||||
test("a species never lands in the details reference as a name", async () => {
|
||||
const actor = makeStubActor("Thalia", {
|
||||
// A species picked in the sheet: dnd5e made the race item and referenced it by id.
|
||||
system: { details: { race: ID_HUMAN } },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [{ _id: ID_HUMAN, name: "Human", type: "race", flags: { [MODULE_ID]: { syncedItem: true } } }],
|
||||
});
|
||||
await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, { species: "Human", background: "Soldier" })],
|
||||
}).start();
|
||||
|
||||
assert.equal(referenceId(actor, "race"), ID_HUMAN, "the species reference still points at the race item");
|
||||
assert.notEqual(actor.system.details.race, "Human", "a name in it would resolve to nothing");
|
||||
});
|
||||
|
||||
test("a species the world keeps as plain text is left to the world", async () => {
|
||||
// An actor migrated from an older system release: no race item, the name is what the
|
||||
// field holds, and Dragonroll has nothing to reference.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: { race: "Human" } },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
});
|
||||
await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, { species: "Human" })],
|
||||
}).start();
|
||||
|
||||
assert.equal(actor.system.details.race, "Human", "the text the sheet reads is kept as it was");
|
||||
});
|
||||
|
||||
test("a character made in Dragonroll references the background it is created with", async () => {
|
||||
const world = await makeWorld({ actors: [], remoteActors: [campaignCharacter(null, { background: "Soldier" })] }).start();
|
||||
|
||||
const [actor] = world.game.actors.contents;
|
||||
assert.ok(actor, "the campaign's character was made in this world");
|
||||
const background = actor.items.contents.find((item) => item.type === "background");
|
||||
assert.ok(background, "created together with its background item");
|
||||
assert.equal(background.name, "Soldier");
|
||||
assert.equal(referenceId(actor, "background"), background.id, "referenced by that item's id, never its name");
|
||||
});
|
||||
69
tests/item-entry-display.test.js
Normal file
69
tests/item-entry-display.test.js
Normal file
@@ -0,0 +1,69 @@
|
||||
// Tests for Syndria98/dragonroll#53: the item row in the campaign sidebar dropped its "SYNCED"
|
||||
// text badge and now leads with the item's own icon on the left of the entry.
|
||||
//
|
||||
// The repository root installs no dependencies, so these read the sidebar component the way
|
||||
// tests/sidebar-entity-entry.test.js does — the checks are about the markup and style of the row.
|
||||
//
|
||||
// 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 source = fs.readFileSync(
|
||||
path.join(__dirname, "..", "frontend", "app", "components", "partials", "ContentSidebar.vue"),
|
||||
"utf8"
|
||||
);
|
||||
|
||||
// The block that renders the item rows, from the items section down to its closing template. The
|
||||
// items section is followed by the maps section (`v-else`), so the first `</template>` that leads
|
||||
// there ends it; the inner `v-for` close is followed by another close, not by `v-else`.
|
||||
const itemSection =
|
||||
/<template v-else-if="activeSection === 'items'">([\s\S]*?)<\/template>\s*\n\s*<template v-else>/.exec(source)?.[1] ?? "";
|
||||
|
||||
// `selector` is inserted verbatim, so escape the `.` of a class combination. Comments are dropped:
|
||||
// they explain a rule, they are not part of it.
|
||||
function ruleFor(selector) {
|
||||
const rule = new RegExp(`\\.${selector}\\s*\\{([^}]*)\\}`).exec(source)?.[0];
|
||||
return rule?.replace(/\/\*[\s\S]*?\*\//g, "");
|
||||
}
|
||||
|
||||
test("the item entry no longer shows the SYNCED text", () => {
|
||||
assert.ok(itemSection, "expected to find the items section of the sidebar");
|
||||
assert.doesNotMatch(itemSection, /campaigns\.synced/, "the item row must not render the synced text");
|
||||
assert.doesNotMatch(itemSection, /entity-entry-sync/, "the item row must not render the synced badge");
|
||||
});
|
||||
|
||||
test("the item entry shows the item's image on the left when it has one", () => {
|
||||
// the icon renders only for an item that carries an image, resolved through the helper...
|
||||
assert.match(
|
||||
itemSection,
|
||||
/<span v-if="row\.item\.image" class="entity-entry-image"[\s\S]*?<img :src="itemImageUrl\(row\.item\.image\)"/
|
||||
);
|
||||
// ...and on the left: it stands before the name in the row markup.
|
||||
assert.ok(
|
||||
itemSection.indexOf("entity-entry-image") < itemSection.indexOf("entity-entry-name"),
|
||||
"the item image must stand to the left of the name"
|
||||
);
|
||||
});
|
||||
|
||||
test("the item entry lays the icon out beside the name", () => {
|
||||
const title = ruleFor("entity-entry-title");
|
||||
assert.ok(title, "expected a .entity-entry-title style rule");
|
||||
assert.match(title, /display:\s*flex/, "the icon and the name sit side by side");
|
||||
|
||||
const image = ruleFor("entity-entry-image");
|
||||
assert.ok(image, "expected a .entity-entry-image style rule");
|
||||
assert.match(image, /overflow:\s*hidden/, "the icon is clipped to its box");
|
||||
});
|
||||
|
||||
test("an item image resolves like the item window: uploads from /public, full URLs as they are", () => {
|
||||
assert.match(source, /import Server, \{ getBaseUrl \} from ['"]~\/services\/Server['"]/);
|
||||
|
||||
const resolver = /function itemImageUrl\(image\)\s*\{[\s\S]*?\n\}/.exec(source)?.[0] ?? "";
|
||||
assert.ok(resolver, "expected an itemImageUrl helper");
|
||||
assert.match(resolver, /https\?:/, "a full http(s) URL loads as it is");
|
||||
assert.match(resolver, /data:/, "a data URI loads as it is");
|
||||
assert.match(resolver, /\$\{getBaseUrl\(\)\}\/public\//, "an uploaded filename resolves as a /public file");
|
||||
});
|
||||
217
tests/manage-accounts.test.js
Normal file
217
tests/manage-accounts.test.js
Normal file
@@ -0,0 +1,217 @@
|
||||
// Tests for "Manage accounts" of Syndria98/dragonroll#51: the button on the settings window's site
|
||||
// administration tab opened a window type (`account_management`) that was never registered in
|
||||
// `WindowDefinitions.js`, so `getComponent` dereferenced `defWindows[type].component` on `undefined` —
|
||||
// `can't access property "component", (intermediate value)[type] is undefined` — instead of opening
|
||||
// anything. The window is the site administration screen now (list accounts, create one, grant or
|
||||
// take administrator rights, delete one), guarded on the backend by the `isAdmin` middleware.
|
||||
//
|
||||
// Like tests/settings-window.test.js, the window wiring is read from the sources; the window registry
|
||||
// is also checked against every window type the frontend opens, which is what catches this class of
|
||||
// bug before the click does.
|
||||
//
|
||||
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
|
||||
const frontendApp = path.join(__dirname, "..", "frontend", "app");
|
||||
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
|
||||
const settingsWindowSource = read("frontend", "app", "components", "windows", "SettingsWindow.vue");
|
||||
const accountsWindowSource = read("frontend", "app", "components", "windows", "AccountManagementWindow.vue");
|
||||
const userRouteSource = read("backend", "src", "routes", "user.js");
|
||||
|
||||
// -- the window registry -------------------------------------------------------
|
||||
|
||||
// Top-level entries of `defWindows`: every entry sits at 2 spaces, its contents at 4+.
|
||||
function registryEntries() {
|
||||
const header = /^ {2}([A-Za-z_]\w*):\s*\{/gm;
|
||||
const marks = [];
|
||||
let match;
|
||||
while ((match = header.exec(windowDefsSource))) marks.push({ type: match[1], index: match.index });
|
||||
assert.ok(marks.length > 0, "expected window definitions to register windows");
|
||||
|
||||
const entries = {};
|
||||
marks.forEach((mark, i) => {
|
||||
const end = i + 1 < marks.length ? marks[i + 1].index : windowDefsSource.length;
|
||||
entries[mark.type] = windowDefsSource.slice(mark.index, end);
|
||||
});
|
||||
return entries;
|
||||
}
|
||||
|
||||
function* sourceFiles(dir) {
|
||||
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
||||
const full = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) yield* sourceFiles(full);
|
||||
else if (/\.(vue|js|ts)$/.test(entry.name)) yield full;
|
||||
}
|
||||
}
|
||||
|
||||
test("account_management is a registered window with a component on disk", () => {
|
||||
const entries = registryEntries();
|
||||
const definition = entries["account_management"];
|
||||
assert.ok(definition, "account_management must be registered or getComponent opens undefined");
|
||||
assert.match(definition, /AccountManagementWindow\.vue/);
|
||||
const component = path.join(frontendApp, "components", "windows", "AccountManagementWindow.vue");
|
||||
assert.ok(fs.existsSync(component), "the window component file must exist");
|
||||
});
|
||||
|
||||
test("no window is opened with a type that is not registered", () => {
|
||||
const registered = registryEntries();
|
||||
// The type is the first string argument of CreateWindow; CreateChildWindow takes a parent
|
||||
// (GetFirstWindowId('main_menu')-style, a registered type itself) before the type. Data
|
||||
// objects after it hold strings that mean nothing to the registry, so they stay unmatched.
|
||||
const createWindow = /CreateWindow\(\s*['"]([a-z_]+)['"]/g;
|
||||
const createChildWindow = /CreateChildWindow\(\s*(?:GetFirstWindowId\(\s*['"]([a-z_]+)['"]\s*\)|[a-z_]+)\s*,\s*['"]([a-z_]+)['"]/g;
|
||||
|
||||
for (const file of sourceFiles(frontendApp)) {
|
||||
const source = fs.readFileSync(file, "utf8");
|
||||
const found = [...source.matchAll(createWindow), ...source.matchAll(createChildWindow)];
|
||||
for (const match of found) {
|
||||
for (const type of match.slice(1)) {
|
||||
if (!type) continue;
|
||||
assert.ok(
|
||||
registered[type],
|
||||
`${path.relative(frontendApp, file)} opens '${type}', which WindowDefinitions.js does not define`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("every registered window points at a component file that exists", () => {
|
||||
for (const [type, definition] of Object.entries(registryEntries())) {
|
||||
const imported = /import\(['"]([^'"]+)['"]\)/.exec(definition)?.[1];
|
||||
assert.ok(imported, `${type} must import a component`);
|
||||
const file = path.join(frontendApp, imported.replace(/^~\//, ""));
|
||||
assert.ok(fs.existsSync(file), `${type} points at ${imported}, which is not there`);
|
||||
}
|
||||
});
|
||||
|
||||
// -- opening it from the settings window ----------------------------------------
|
||||
|
||||
const openManageAccounts = /function OpenManageAccounts\(\)\s*\{[\s\S]*?\n\}/.exec(settingsWindowSource)?.[0];
|
||||
|
||||
test("the settings tab opens the account window and can come back", () => {
|
||||
assert.ok(openManageAccounts, "expected an OpenManageAccounts in the settings window");
|
||||
assert.match(openManageAccounts, /CreateWindow\(\s*'account_management'/);
|
||||
// ClearWindow takes a selector object; a bare string matched neither `selector.type` nor
|
||||
// `selector.id` and closed nothing, leaving both windows stacked.
|
||||
assert.match(openManageAccounts, /ClearWindow\(\s*\{\s*type:\s*'settings'\s*\}\s*\)/);
|
||||
assert.match(openManageAccounts, /ClearWindow\(\s*\{\s*type:\s*'account_management'\s*\}\s*\)/);
|
||||
assert.match(openManageAccounts, /CreateWindow\(\s*'settings'/, "back returns to the settings window");
|
||||
assert.doesNotMatch(settingsWindowSource, /ClearWindow\(\s*['"]/g, "no ClearWindow call may pass a bare string");
|
||||
});
|
||||
|
||||
// -- the account management window ------------------------------------------------
|
||||
|
||||
test("the account window talks to the account management endpoints", () => {
|
||||
assert.match(accountsWindowSource, /Server\(\)\.get\(['"]\/user\/list['"]/);
|
||||
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/create['"]/);
|
||||
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/set-admin['"]/);
|
||||
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/delete['"]/);
|
||||
});
|
||||
|
||||
test("the window closes the switches on the row of the admin using it", () => {
|
||||
// The server answers the same way to anybody who still posts it (see below); the row just
|
||||
// does not invite the attempt.
|
||||
assert.match(accountsWindowSource, /v-if="!IsSelf\(user\)"/);
|
||||
assert.match(accountsWindowSource, /GetUser\(\)\?\._id/);
|
||||
});
|
||||
|
||||
// -- the backend routes -----------------------------------------------------------
|
||||
|
||||
function routeDeclaration(method, route) {
|
||||
const declaration = new RegExp(`router\\.${method}\\(['"]${route}['"][^\\n]*`).exec(userRouteSource)?.[0];
|
||||
assert.ok(declaration, `expected a ${method.toUpperCase()} ${route} route`);
|
||||
// /api/user is mounted before the JWT guard: without inline authentication the route would
|
||||
// be public to any request (landmine 5 of AGENTS.md), and only an admin may manage accounts.
|
||||
assert.match(declaration, /passport\.authenticate\(['"]jwt['"]/);
|
||||
assert.match(declaration, /isAdmin/, `${route} may only be answered for an administrator`);
|
||||
return declaration;
|
||||
}
|
||||
|
||||
function routeBlock(method, route) {
|
||||
const start = userRouteSource.indexOf(`router.${method}('${route}'`);
|
||||
assert.ok(start !== -1, `expected a ${method.toUpperCase()} ${route} route`);
|
||||
const next = userRouteSource.indexOf(`\nrouter.`, start + 1);
|
||||
return userRouteSource.slice(start, next === -1 ? userRouteSource.length : next);
|
||||
}
|
||||
|
||||
test("GET /user/list answers the accounts without passwords or setup codes", () => {
|
||||
routeDeclaration("get", "/list");
|
||||
assert.match(routeBlock("get", "/list"), /select\(['"]-password -setupCode['"]\)/);
|
||||
});
|
||||
|
||||
test("POST /user/create stores a hashed password and refuses duplicates", () => {
|
||||
const block = routeBlock("post", "/create");
|
||||
assert.match(block, /bcrypt\.hash\(password/, "the password must not go in as it came");
|
||||
assert.match(block, /register\.errors\.email-username-exists/, "duplicates answer with the register message");
|
||||
assert.doesNotMatch(block, /setupCode/, "no half-finished setup account is invented here");
|
||||
});
|
||||
|
||||
for (const route of ["/set-admin", "/delete"]) {
|
||||
test(`POST /user${route} refuses to act on the admin that is asking`, () => {
|
||||
routeDeclaration("post", route);
|
||||
const block = routeBlock("post", route);
|
||||
assert.match(block, /String\(req\.user\._id\) === String\(id\)/, "an admin keeps their own account closed");
|
||||
assert.match(block, /errors\.internal/);
|
||||
});
|
||||
}
|
||||
|
||||
// -- i18n --------------------------------------------------------------------------
|
||||
|
||||
test("every locale titles the account window and names its strings", () => {
|
||||
const required = [
|
||||
"accounts.you",
|
||||
"accounts.admin",
|
||||
"accounts.make-admin",
|
||||
"accounts.remove-admin",
|
||||
"accounts.delete",
|
||||
"accounts.new-account",
|
||||
"accounts.name",
|
||||
"accounts.username",
|
||||
"accounts.email",
|
||||
"accounts.password",
|
||||
"accounts.create",
|
||||
"accounts.created",
|
||||
"accounts.updated",
|
||||
"accounts.deleted",
|
||||
"accounts.errors.self-admin",
|
||||
"accounts.errors.self-delete",
|
||||
];
|
||||
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
|
||||
assert.ok(windows["account-management"]?.trim(), `${locale} is missing the account window title`);
|
||||
|
||||
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
|
||||
assert.ok(settings["site-administration"]?.["manage-accounts"]?.trim(), `${locale} is missing manage accounts`);
|
||||
for (const key of required) {
|
||||
const value = key.split(".").reduce((node, part) => node?.[part], settings["site-administration"]);
|
||||
assert.ok(value?.trim(), `${locale} is missing settings.site-administration.${key}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("every accounts string the window translates exists in every locale", () => {
|
||||
// $t keys with nothing to translate fall back to the key itself, so every accounts key the
|
||||
// window uses has to be carried by every locale. (`errors.internal` is the envelope fallback
|
||||
// every window toasts the same way and stays out of it.)
|
||||
const used = [...new Set(
|
||||
[...accountsWindowSource.matchAll(/\$t\(\s*['"](settings\.site-administration\.accounts\.[\w.-]+)['"]/g)]
|
||||
.map((key) => key[1])
|
||||
)];
|
||||
assert.ok(used.length >= 14, `expected the window's translated strings, found ${used.length}`);
|
||||
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
|
||||
for (const key of used) {
|
||||
const value = key.split(".").slice(1).reduce((node, part) => node?.[part], settings);
|
||||
assert.ok(typeof value === "string" && value.trim(), `${locale} is missing ${key}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
Reference in New Issue
Block a user