More things
This commit is contained in:
@@ -147,7 +147,6 @@ function loadFoundryWriters({ seed = {}, settings } = {}) {
|
||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (id === "../services/service-links") return { unlinkFoundryWorld: async () => {} };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
@@ -340,8 +339,6 @@ function makeWorld({ actors = [], remoteActors = [] } = {}) {
|
||||
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; } },
|
||||
@@ -415,87 +412,6 @@ function makeWorld({ actors = [], remoteActors = [] } = {}) {
|
||||
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("a trait row an older campaign left in the inventory does not become a loot duplicate", async () => {
|
||||
// A campaign that synced before #89 still carries its world's traits as inventory
|
||||
// rows. Writing the character must neither make a piece of loot after a trait's name
|
||||
// nor touch the world's feat it holds that name — the row is the campaign's to write
|
||||
// off, and the document is the world's to keep.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: {} },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [{ _id: "feat-1", name: "Darkvision", type: "feat", system: { featType: "trs" } }],
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, {
|
||||
traits: "Darkvision\nSee in the dark.",
|
||||
inventory: [{ name: "Darkvision", quantity: 1, weight: 0 }],
|
||||
})],
|
||||
}).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [["feat", "Darkvision"]],
|
||||
"no gear made after the trait's name, and the feat stands where it was");
|
||||
assert.equal(actor.items.contents[0].system.quantity, undefined, "the world's feat is not written as gear");
|
||||
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||
});
|
||||
|
||||
test("writing the character leaves the world's trait and species documents where they stand", async () => {
|
||||
// An earlier sync marked everything in the actor as its own. The campaign no longer
|
||||
// carries traits and species in the inventory, so those marks must not cost the world
|
||||
// its documents — while loot the campaign truly dropped still goes.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: {} },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [
|
||||
{ _id: "feat-1", name: "Darkvision", type: "feat", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
{ _id: "race-1", name: "Human", type: "race", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
{ _id: "loot-old", name: "Torch", type: "loot", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
],
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, {
|
||||
species: "Human",
|
||||
traits: "Darkvision\nSee in the dark.",
|
||||
inventory: [{ name: "Rations", quantity: 1, weight: 0.5 }],
|
||||
})],
|
||||
}).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [
|
||||
["feat", "Darkvision"],
|
||||
["race", "Human"],
|
||||
["loot", "Rations"],
|
||||
], "the trait and the species survive, the carried gear follows the campaign");
|
||||
assert.equal(actor.system.details.race, "race-1", "the species reference still resolves to the surviving item");
|
||||
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||
});
|
||||
|
||||
test("the snapshot marks the carried gear and no longer the world's own documents", async () => {
|
||||
const actor = makeStubActor("Grimnir", {
|
||||
system: { details: {} },
|
||||
|
||||
@@ -173,6 +173,7 @@ function campaign({ folders = [], notes = [], actors = [], items = [], maps = []
|
||||
// seed says otherwise.
|
||||
Folder: realFolderModel(folders.map((folder) => ({ campaign: "campaign-1", ...folder }))),
|
||||
Note: fakeCollection("note", notes),
|
||||
Media: fakeCollection("media", []),
|
||||
Actor: fakeCollection("actor", actors),
|
||||
Item: fakeCollection("item", items),
|
||||
Map: fakeCollection("map", maps),
|
||||
@@ -182,6 +183,7 @@ function campaign({ folders = [], notes = [], actors = [], items = [], maps = []
|
||||
"../models/Campaign": { findOne: () => ({ lean: async () => campaignDoc }) },
|
||||
"../models/Folder": collections.Folder,
|
||||
"../models/Note": collections.Note,
|
||||
"../models/Media": collections.Media,
|
||||
"../models/Actor": collections.Actor,
|
||||
"../models/Item": collections.Item,
|
||||
"../models/Map": collections.Map,
|
||||
|
||||
@@ -6,21 +6,14 @@
|
||||
// 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.
|
||||
// The backend mapper is plain CommonJS and is required directly: it reads the
|
||||
// Foundry document and resolves those references to the names Dragonroll holds.
|
||||
//
|
||||
// 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"));
|
||||
|
||||
@@ -91,327 +84,3 @@ test("a class reference that resolves to nothing falls back to the class item",
|
||||
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");
|
||||
});
|
||||
|
||||
@@ -283,7 +283,6 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (id === "../services/service-links") return { unlinkFoundryWorld: async () => {} };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
|
||||
@@ -1,938 +0,0 @@
|
||||
// Tests for the campaign's notes reaching the Foundry world as journal pages
|
||||
// (Syndria98/dragonroll#98): each Dragonroll folder stands as a journal named after
|
||||
// its path (root notes share "Dragonroll"), written by the module and kept in step
|
||||
// with the campaign. The copy runs one way — notes are written in Dragonroll — so
|
||||
// the backend answers with the notes and their folder paths and remembers each
|
||||
// note's page; the module reads them, renders the markdown, moves a page when its
|
||||
// note changes folder, and prunes the page of a note the campaign deleted.
|
||||
//
|
||||
// Both sides are loaded the way the other Foundry tests do it: the sync route runs
|
||||
// against a stubbed `require` (models answer with plain objects and a small filter
|
||||
// matcher), and the Foundry module is loaded into a `node:vm` context holding
|
||||
// stubbed Foundry globals (`game.journal` and `JournalEntry` included) with fake
|
||||
// timers, like tests/item-folder-sync.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 MODULE_ID = "dragonroll-foundry";
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||
|
||||
// --- The sync route against stubbed models -------------------------------------
|
||||
|
||||
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Enough of the query language the note routes use: equality, $or, $in, $nin,
|
||||
// $exists, $ne. Anything else is a filter this test did not expect and says so.
|
||||
function matches(document, filter = {}) {
|
||||
return Object.entries(filter).every(([key, expected]) => {
|
||||
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||
const value = document?.[key];
|
||||
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||
return Object.entries(expected).every(([operator, wanted]) => {
|
||||
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$ne") return String(value ?? "") !== String(wanted ?? "");
|
||||
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||
});
|
||||
}
|
||||
return String(value ?? "") === String(expected ?? "");
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
function Document(data = {}) {
|
||||
counter += 1;
|
||||
this._id = `${table}-${counter}`;
|
||||
this.isNew = true;
|
||||
this.foundryNames = [];
|
||||
Object.assign(this, data);
|
||||
}
|
||||
Document.prototype.save = async function save() {
|
||||
if (this.isNew) rows.push(this);
|
||||
this.isNew = false;
|
||||
return this;
|
||||
};
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
// A seeded row belongs to the campaign the requests are made against unless the
|
||||
// seed says otherwise: the routes scope every lookup by campaign.
|
||||
const row = new Document({ campaign: campaignId, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
|
||||
const model = function Model(data) { return new Document(data); };
|
||||
model.rows = rows;
|
||||
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||
model.deleteOne = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.deleteMany = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.updateMany = async (filter, update) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) Object.assign(row, update.$set ?? {});
|
||||
return { modifiedCount: hit.length };
|
||||
};
|
||||
return model;
|
||||
}
|
||||
|
||||
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the
|
||||
// tables with documents the campaign already holds.
|
||||
function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (id === "../services/service-links") return { unlinkFoundryWorld: async () => {} };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function call(route, body = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||
await handlers[handlers.length - 1](req, res);
|
||||
return res.payload;
|
||||
}
|
||||
|
||||
return { call, models, campaign };
|
||||
}
|
||||
|
||||
// --- The sync route: the notes it answers and the page ids it keeps ---------------
|
||||
|
||||
test("the notes revision folds the campaign's notes into one hash", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Session 1", content: "hi" },
|
||||
{ _id: "note-2", title: "Tavern Brawl", content: "ho" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const first = await sync.call("GET /sync/notes/revision");
|
||||
assert.equal(first.status, "ok");
|
||||
assert.match(first.revision, /^[0-9a-f]{64}$/, "a sha-256 of the notes, not their content");
|
||||
|
||||
sync.models["../models/Note"].rows[0].content = "hi there";
|
||||
const edited = await sync.call("GET /sync/notes/revision");
|
||||
assert.notEqual(edited.revision, first.revision, "editing a note moves the revision");
|
||||
|
||||
sync.models["../models/Note"].rows[0].content = "hi";
|
||||
sync.models["../models/Note"].rows[0].foundryPageId = "page-9";
|
||||
const mapped = await sync.call("GET /sync/notes/revision");
|
||||
assert.equal(mapped.revision, first.revision, "mapping a note to its page is not an edit");
|
||||
});
|
||||
|
||||
test("the world reads the campaign's notes with their content and page mapping", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: "page-9" },
|
||||
{ _id: "note-2", title: "Tavern Brawl", content: "- rope" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("GET /sync/notes");
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(response.notes.map((note) => note.title), ["Session 1", "Tavern Brawl"]);
|
||||
assert.equal(response.notes[0].content, "**The start**", "the markdown source travels: the module renders it");
|
||||
assert.equal(response.notes[0].foundryPageId, "page-9", "and the note says which page it already stands as");
|
||||
});
|
||||
|
||||
test("the world reads each note with the path of the folder it lives in", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [
|
||||
{ _id: "folder-1", name: "Sessions", parentFolder: null },
|
||||
{ _id: "folder-2", name: "Arc 1", parentFolder: "folder-1" },
|
||||
],
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Root", content: "root" },
|
||||
{ _id: "note-2", title: "In folder", content: "folder", folder: "folder-1" },
|
||||
{ _id: "note-3", title: "Deep", content: "deep", folder: "folder-2" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("GET /sync/notes");
|
||||
const pathByTitle = Object.fromEntries(response.notes.map((note) => [note.title, note.folderPath]));
|
||||
|
||||
assert.deepEqual(pathByTitle, {
|
||||
Root: "",
|
||||
"In folder": "Sessions",
|
||||
Deep: "Sessions / Arc 1",
|
||||
}, "the module names the journal of a note after its whole folder path");
|
||||
});
|
||||
|
||||
test("renaming a folder moves the notes revision", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [{ _id: "folder-1", name: "Sessions", parentFolder: null }],
|
||||
notes: [{ _id: "note-1", title: "Session 1", content: "hi", folder: "folder-1" }],
|
||||
},
|
||||
});
|
||||
|
||||
const before = await sync.call("GET /sync/notes/revision");
|
||||
sync.models["../models/Folder"].rows[0].name = "Chapters";
|
||||
const after = await sync.call("GET /sync/notes/revision");
|
||||
|
||||
assert.notEqual(after.revision, before.revision,
|
||||
"a folder rename has to reach the world as another journal name");
|
||||
});
|
||||
|
||||
test("mapping a note to the page the module made keeps them paired", async () => {
|
||||
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||
|
||||
const response = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||
});
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(sync.models["../models/Note"].rows[0].foundryPageId, "page-9");
|
||||
|
||||
// Mapping the same pair again is the module checking, not a conflict.
|
||||
const again = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||
});
|
||||
assert.equal(again.status, "ok");
|
||||
});
|
||||
|
||||
test("a page already mapped to another note is refused", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Session 1", content: "hi", foundryPageId: "page-9" },
|
||||
{ _id: "note-2", title: "Tavern Brawl", content: "ho" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-2", foundryPageId: "page-9",
|
||||
});
|
||||
|
||||
assert.equal(response.status, "error");
|
||||
assert.equal(response.msg, "foundry.errors.note-already-synced");
|
||||
assert.equal(sync.models["../models/Note"].rows.find((row) => row._id === "note-2").foundryPageId, undefined,
|
||||
"the first note keeps its page");
|
||||
});
|
||||
|
||||
test("map-note wants this world's note and a page for it", async () => {
|
||||
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||
|
||||
assert.equal((await sync.call("POST /sync/map-note", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/map-note", { noteId: "note-1", foundryPageId: "page-9" })).msg, "errors.missing-data",
|
||||
"another world cannot map this campaign's note");
|
||||
const gone = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-gone", foundryPageId: "page-9",
|
||||
});
|
||||
assert.equal(gone.msg, "errors.notfound");
|
||||
});
|
||||
|
||||
// --- The Foundry module writes the journal ---------------------------------------
|
||||
|
||||
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.noteId"); an
|
||||
// embedded document's own id is not a path to set.
|
||||
function writeFoundryPaths(target, data) {
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
if (key === "_id") continue;
|
||||
const parts = key.split(".");
|
||||
const last = parts.pop();
|
||||
let node = target;
|
||||
for (const part of parts) node = node[part] ??= {};
|
||||
node[last] = value;
|
||||
}
|
||||
return target;
|
||||
}
|
||||
|
||||
function makeWorld() {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
// What Dragonroll answers the notes reconcile with. Mapping a page answers
|
||||
// like the real backend: the note keeps the page id, so later reads carry it.
|
||||
remoteNotes: [],
|
||||
rollMessages: [],
|
||||
clickListeners: [],
|
||||
nextId: 1,
|
||||
};
|
||||
|
||||
const journals = [];
|
||||
|
||||
const makePage = (journal, data = {}) => {
|
||||
const page = {
|
||||
id: `page-${state.nextId++}`,
|
||||
documentName: "JournalEntryPage",
|
||||
name: data.name,
|
||||
text: { content: data.text?.content ?? "" },
|
||||
flags: data.flags ?? {},
|
||||
writes: 0,
|
||||
get uuid() { return `JournalEntry.${journal.id}.JournalEntryPage.${this.id}`; },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(update) {
|
||||
page.writes += 1;
|
||||
writeFoundryPaths(page, update);
|
||||
return page;
|
||||
},
|
||||
async delete() {
|
||||
const index = journal.pages.contents.indexOf(page);
|
||||
if (index >= 0) journal.pages.contents.splice(index, 1);
|
||||
},
|
||||
};
|
||||
return page;
|
||||
};
|
||||
|
||||
const makeJournal = (data = {}) => {
|
||||
const pages = [];
|
||||
return {
|
||||
id: `journal-${state.nextId++}`,
|
||||
name: data.name,
|
||||
documentName: "JournalEntry",
|
||||
flags: data.flags ?? {},
|
||||
get uuid() { return `JournalEntry.${this.id}`; },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
pages: { contents: pages, get: (id) => pages.find((page) => page.id === id) },
|
||||
async update(update) { return writeFoundryPaths(this, update); },
|
||||
async delete() {
|
||||
const index = journals.indexOf(this);
|
||||
if (index >= 0) journals.splice(index, 1);
|
||||
},
|
||||
async createEmbeddedDocuments(documentName, docs) {
|
||||
assert.equal(documentName, "JournalEntryPage", "the notes' pages are journal pages");
|
||||
// Foundry's own page validation refuses a page without a name.
|
||||
for (const doc of docs) assert.ok(doc.name, "a journal page needs a non-empty name");
|
||||
const created = docs.map((doc) => makePage(this, doc));
|
||||
pages.push(...created);
|
||||
return created;
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
document: {
|
||||
addEventListener(name, fn) {
|
||||
if (name === "click") state.clickListeners.push(fn);
|
||||
},
|
||||
},
|
||||
Roll: class FakeRoll {
|
||||
constructor(formula) {
|
||||
this.formula = formula;
|
||||
this.evaluated = false;
|
||||
}
|
||||
async evaluate() {
|
||||
this.evaluated = true;
|
||||
return this;
|
||||
}
|
||||
async toMessage(data) {
|
||||
assert.equal(this.evaluated, true, "the roll is evaluated before it reaches chat");
|
||||
state.rollMessages.push({ formula: this.formula, ...data });
|
||||
}
|
||||
},
|
||||
ChatMessage: { getSpeaker: () => ({ alias: "GM" }) },
|
||||
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 id = state.nextId++;
|
||||
state.timers.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: (fn, delay = 0) => {
|
||||
// Recorded, never run by itself: tests ask for a periodic reconcile with
|
||||
// `runIntervals`, so the ones watching single pushes stay on their own.
|
||||
const id = state.nextId++;
|
||||
state.intervals.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearInterval: (id) => state.intervals.delete(id),
|
||||
fetch: async (url, options = {}) => {
|
||||
const href = String(url);
|
||||
const body = options.body ? JSON.parse(options.body) : null;
|
||||
state.requests.push({ href, method: options.method, body });
|
||||
if (href.includes("foundry/sync/map-note")) {
|
||||
const note = state.remoteNotes.find((entry) => String(entry._id) === String(body.noteId));
|
||||
if (note) note.foundryPageId = body.foundryPageId;
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", note }) };
|
||||
}
|
||||
// The cheap change check: a hash of the notes' content, so changing
|
||||
// `remoteNotes` (and nothing else) is what makes the module pull them over,
|
||||
// like the backend hashing the campaign's notes does.
|
||||
if (href.includes("foundry/sync/notes/revision")) {
|
||||
const revision = state.remoteNotes
|
||||
.map((note) => [
|
||||
note._id, note.title ?? "", note.content ?? "",
|
||||
note.folder ?? "", note.folderPath ?? "",
|
||||
].join("\u0000"))
|
||||
.sort()
|
||||
.join("\u0001");
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", revision }) };
|
||||
}
|
||||
if (href.includes("foundry/sync/notes")) {
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", notes: state.remoteNotes }) };
|
||||
}
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
JournalEntry: {
|
||||
async create(data) {
|
||||
const journal = makeJournal(data);
|
||||
journals.push(journal);
|
||||
return [journal];
|
||||
},
|
||||
},
|
||||
};
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: [], get: () => null },
|
||||
items: { contents: [], get: () => null },
|
||||
folders: { contents: [], get: () => null },
|
||||
journal: { contents: journals, get: (id) => journals.find((journal) => journal.id === id) },
|
||||
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.journals = () => journals;
|
||||
state.addJournal = (name, flags = {}) => {
|
||||
const journal = makeJournal({ name, flags });
|
||||
journals.push(journal);
|
||||
return journal;
|
||||
};
|
||||
state.addPage = (journal, data) => {
|
||||
const page = makePage(journal, data);
|
||||
journal.pages.contents.push(page);
|
||||
return page;
|
||||
};
|
||||
state.mapNoteRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/map-note"));
|
||||
state.notesReads = () => state.requests.filter((request) => request.href.includes("foundry/sync/notes"));
|
||||
// The full note pulls, not the cheap revision pings the change check makes.
|
||||
state.notesPulls = () => state.requests.filter((request) =>
|
||||
request.href.includes("foundry/sync/notes") && !request.href.includes("/revision"));
|
||||
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
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();
|
||||
}
|
||||
};
|
||||
// The reconciles `setInterval` registered: what runs every few seconds on a
|
||||
// linked world, and so what carries each note into its journal page.
|
||||
state.runIntervals = async () => {
|
||||
for (const interval of [...state.intervals.values()]) await interval.fn();
|
||||
await drain();
|
||||
};
|
||||
// Press a dice button the journal drew: the module listens on the document and
|
||||
// finds the button through `closest`, like a click inside a journal page.
|
||||
state.clickRoll = async (formula) => {
|
||||
const button = { dataset: { dragonrollRoll: formula } };
|
||||
const event = {
|
||||
target: { closest: (selector) => (selector === "[data-dragonroll-roll]" ? button : null) },
|
||||
defaultPrevented: false,
|
||||
preventDefault() { this.defaultPrevented = true; },
|
||||
};
|
||||
for (const listener of state.clickListeners) await listener(event);
|
||||
await drain();
|
||||
return event;
|
||||
};
|
||||
state.linkedSetup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
state.requests.length = 0;
|
||||
return state;
|
||||
};
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
// The fetch stub updates a note with the page it maps, like the real backend
|
||||
// does, so every test works on notes of its own.
|
||||
const sessionNote = (over = {}) => ({ _id: "note-1", title: "Session 1", content: "**The start**", ...over });
|
||||
const tavernNote = (over = {}) => ({ _id: "note-2", title: "Tavern Brawl", content: "A rope, a chandelier.", ...over });
|
||||
|
||||
test("the campaign's notes become pages of one Dragonroll journal", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "one journal carries the campaign's notes");
|
||||
const journal = world.journals()[0];
|
||||
assert.equal(journal.name, "Dragonroll");
|
||||
assert.deepEqual(journal.pages.contents.map((page) => [page.name, page.text.content]), [
|
||||
["Session 1", "<p><strong>The start</strong></p>"],
|
||||
["Tavern Brawl", "<p>A rope, a chandelier.</p>"],
|
||||
], "each note is a page, its markdown drawn into the page's HTML");
|
||||
assert.deepEqual(journal.pages.contents.map((page) => page.getFlag(MODULE_ID, "noteId")), ["note-1", "note-2"],
|
||||
"each page keeps the note it stands for");
|
||||
assert.deepEqual(world.mapNoteRequests().map((request) => [request.body.noteId, request.body.foundryPageId]), [
|
||||
["note-1", journal.pages.contents[0].id],
|
||||
["note-2", journal.pages.contents[1].id],
|
||||
], "and the campaign remembers each note's page");
|
||||
});
|
||||
|
||||
test("notes in a folder share the journal named after its path", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [
|
||||
sessionNote(),
|
||||
{ _id: "note-2", title: "The road", content: "east", folder: "folder-1", folderPath: "Sessions" },
|
||||
{ _id: "note-3", title: "The cave", content: "dark", folder: "folder-2", folderPath: "Sessions / Arc 1" },
|
||||
];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const byName = new Map(world.journals().map((journal) => [journal.name, journal]));
|
||||
assert.deepEqual([...byName.keys()].sort(), ["Dragonroll", "Sessions", "Sessions / Arc 1"],
|
||||
"the root notes and each folder path get a journal of their own");
|
||||
assert.deepEqual(byName.get("Dragonroll").pages.contents.map((page) => page.name), ["Session 1"]);
|
||||
assert.deepEqual(byName.get("Sessions").pages.contents.map((page) => page.name), ["The road"]);
|
||||
assert.deepEqual(byName.get("Sessions / Arc 1").pages.contents.map((page) => page.name), ["The cave"],
|
||||
"a subfolder's notes stand in a journal named after the whole path");
|
||||
assert.equal(byName.get("Sessions").getFlag(MODULE_ID, "notesFolder"), "folder-1",
|
||||
"each folder journal keeps the folder it belongs to");
|
||||
assert.equal(byName.get("Sessions / Arc 1").getFlag(MODULE_ID, "notesFolder"), "folder-2");
|
||||
});
|
||||
|
||||
test("renaming a folder renames its journal", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [
|
||||
{ _id: "note-1", title: "The road", content: "east", folder: "folder-1", folderPath: "Sessions" },
|
||||
];
|
||||
await world.runIntervals();
|
||||
|
||||
world.remoteNotes = [{ ...world.remoteNotes[0], folderPath: "Chapters" }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals().map((journal) => journal.name), ["Chapters"],
|
||||
"the journal follows the folder's path without being made again");
|
||||
assert.equal(world.journals()[0].pages.contents.length, 1, "and its page stays where it was");
|
||||
});
|
||||
|
||||
test("a note moved to another folder takes its page to that folder's journal", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [
|
||||
{ _id: "note-1", title: "The road", content: "east", folder: "folder-1", folderPath: "Sessions" },
|
||||
];
|
||||
await world.runIntervals();
|
||||
|
||||
const firstPage = world.journals()[0].pages.contents[0];
|
||||
world.remoteNotes = [{
|
||||
...world.remoteNotes[0],
|
||||
folder: "folder-2",
|
||||
folderPath: "Sessions / Arc 1",
|
||||
}];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals().map((journal) => journal.name), ["Sessions / Arc 1"],
|
||||
"the journal the note left goes when it has nothing else in it");
|
||||
const moved = world.journals()[0].pages.contents[0];
|
||||
assert.equal(moved.name, "The road");
|
||||
assert.notEqual(moved.id, firstPage.id, "the page is made in the journal the note moved to");
|
||||
assert.equal(world.remoteNotes[0].foundryPageId, moved.id, "and the campaign maps the note to its new page");
|
||||
});
|
||||
|
||||
test("reconciling again does not double the journal or its pages", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "the journal is made once, not per reconcile");
|
||||
assert.equal(world.journals()[0].pages.contents.length, 2, "and each note stands as the one page it was given");
|
||||
assert.equal(world.mapNoteRequests().length, 2, "an already-mapped note is not mapped again");
|
||||
});
|
||||
|
||||
test("an existing journal named Dragonroll is used, not doubled", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const gmsOwn = world.addJournal("Dragonroll");
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "the journal the world already had is the notes' one");
|
||||
assert.deepEqual(gmsOwn.pages.contents.map((page) => page.name), ["Session 1"]);
|
||||
assert.equal(gmsOwn.getFlag(MODULE_ID, "notesJournal"), true, "and it is marked, so renaming it keeps the notes' home findable");
|
||||
});
|
||||
|
||||
test("extra journals named Dragonroll are removed before the notes are written", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const kept = world.addJournal("Dragonroll", { [MODULE_ID]: { notesJournal: true } });
|
||||
const gmDuplicate = world.addJournal("Dragonroll");
|
||||
const flaggedDuplicate = world.addJournal("Dragonroll", { [MODULE_ID]: { notesJournal: true } });
|
||||
const unrelated = world.addJournal("Session Log");
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals(), [kept, unrelated],
|
||||
"only the journal the reconcile writes into survives, beside the GM's other journals");
|
||||
assert.deepEqual(kept.pages.contents.map((page) => page.name), ["Session 1"]);
|
||||
assert.equal(gmDuplicate.pages.contents.length, 0);
|
||||
assert.equal(flaggedDuplicate.pages.contents.length, 0);
|
||||
assert.ok(unrelated, "a journal of another name is left alone");
|
||||
});
|
||||
|
||||
test("several journals named Dragonroll collapse into the first one", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const first = world.addJournal("Dragonroll");
|
||||
world.addJournal("Dragonroll");
|
||||
world.addJournal("Dragonroll");
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals(), [first], "the duplicates go, the first one stays the notes' home");
|
||||
assert.deepEqual(first.pages.contents.map((page) => page.name), ["Session 1"]);
|
||||
assert.equal(first.getFlag(MODULE_ID, "notesJournal"), true);
|
||||
});
|
||||
|
||||
test("a note edited in Dragonroll rewrites its page", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const first = world.remoteNotes[0];
|
||||
world.remoteNotes = [{ ...first, title: "Session 1 — revisited", content: "**A different start**" }];
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
assert.equal(journal.pages.contents.length, 1, "the note still stands as the same single page");
|
||||
assert.deepEqual(journal.pages.contents[0].name, "Session 1 — revisited");
|
||||
assert.equal(journal.pages.contents[0].text.content, "<p><strong>A different start</strong></p>");
|
||||
assert.equal(world.mapNoteRequests().length, 1, "the pairing the world reads back needs no remapping");
|
||||
});
|
||||
|
||||
test("a note deleted in Dragonroll takes its page with it", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
const gmsPage = world.addPage(journal, { name: "My own notes", text: { content: "not from Dragonroll" } });
|
||||
world.remoteNotes = world.remoteNotes.filter((note) => note._id !== "note-2");
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(journal.pages.contents.map((page) => page.name), ["Session 1", "My own notes"],
|
||||
"the deleted note's page goes; the GM's own page stays");
|
||||
assert.ok(journal.pages.contents.includes(gmsPage));
|
||||
});
|
||||
|
||||
test("pages already in step with the campaign are not rewritten", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const [page] = world.journals()[0].pages.contents;
|
||||
assert.equal(page.writes, 0, "the page was created whole, not patched");
|
||||
await world.runIntervals();
|
||||
assert.equal(page.writes, 0, "a reconcile that changes nothing leaves the page alone");
|
||||
});
|
||||
|
||||
test("an unchanged campaign is not pulled over again", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
assert.equal(world.notesPulls().length, 1, "the first reconcile pulls the notes");
|
||||
|
||||
await world.runIntervals();
|
||||
assert.equal(world.notesPulls().length, 1,
|
||||
"with the revision and the journal unchanged, only the cheap revision is asked for");
|
||||
});
|
||||
|
||||
test("a page a GM edited is written back from the campaign's note", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const page = world.journals()[0].pages.contents[0];
|
||||
page.name = "GM renamed it";
|
||||
page.text.content = "GM wrote this";
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(page.name, "Session 1", "the campaign's title is written back over the GM's");
|
||||
assert.equal(page.text.content, "<p><strong>The start</strong></p>", "and so is its content");
|
||||
});
|
||||
|
||||
test("a journal page a GM removed is built again from the campaign's note", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
world.journals()[0].pages.contents.length = 0;
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals()[0].pages.contents.map((entry) => entry.name), ["Session 1"],
|
||||
"the journal holds the note's page again");
|
||||
});
|
||||
|
||||
test("the campaign's page mapping claims a page whose flag was lost", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const journal = world.addJournal("Dragonroll");
|
||||
const orphan = world.addPage(journal, { name: "Old name", text: { content: "old" } });
|
||||
|
||||
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: orphan.id }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(journal.pages.contents.length, 1, "no second page under the same title");
|
||||
assert.equal(orphan.name, "Session 1");
|
||||
assert.equal(orphan.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked again");
|
||||
});
|
||||
|
||||
test("text that is not markdown is escaped, not injected", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "a & b < c\nline two\n\nsecond para" }];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(
|
||||
world.journals()[0].pages.contents[0].text.content,
|
||||
"<p>a & b < c<br />line two</p>\n<p>second para</p>",
|
||||
"the raw text is escaped and stays legible",
|
||||
);
|
||||
});
|
||||
|
||||
test("a note's markdown is drawn into the page: headings, lists and marks", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{
|
||||
_id: "note-1",
|
||||
title: "Session 1",
|
||||
content: "# Session One\n\n## The Tavern\n\n- rope\n- **torch**\n\n> danger\n\n---\n\n`code` and [a link](https://dragonroll.test)",
|
||||
}];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(
|
||||
world.journals()[0].pages.contents[0].text.content,
|
||||
"<h1>Session One</h1>\n"
|
||||
+ "<h2>The Tavern</h2>\n"
|
||||
+ "<ul>\n<li>rope</li>\n<li><strong>torch</strong></li>\n</ul>\n"
|
||||
+ "<blockquote><p>danger</p></blockquote>\n"
|
||||
+ "<hr />\n"
|
||||
+ "<p><code>code</code> and <a href=\"https://dragonroll.test\">a link</a></p>",
|
||||
"the note is drawn as the elements Foundry's journal styles know",
|
||||
);
|
||||
});
|
||||
|
||||
test("a note's dice widgets become buttons that roll in Foundry", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{
|
||||
_id: "note-1",
|
||||
title: "Goblin",
|
||||
content: "The goblin attacks with @roll[1d20+4].\n\n@roll\n8d6\n@end",
|
||||
}];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const html = world.journals()[0].pages.contents[0].text.content;
|
||||
assert.match(html,
|
||||
/<p>The goblin attacks with <button type="button" class="dragonroll-note-roll" data-dragonroll-roll="1d20\+4" title="Roll 1d20\+4"><i class="fa-solid fa-dice-d20" aria-hidden="true"><\/i><span>1d20\+4<\/span><\/button>\.<\/p>/,
|
||||
"the inline widget is a button showing the expression the note wrote");
|
||||
assert.match(html,
|
||||
/<button type="button" class="dragonroll-note-roll dragonroll-note-roll-block" data-dragonroll-roll="8d6" title="Roll 8d6">/,
|
||||
"the block widget is a button of its own, drawn full width");
|
||||
|
||||
const event = await world.clickRoll("1d20+4");
|
||||
assert.equal(event.defaultPrevented, true, "the click does not navigate the journal");
|
||||
assert.deepEqual(world.rollMessages.map((message) => message.formula), ["1d20+4"],
|
||||
"pressing the button evaluates that expression in Foundry");
|
||||
assert.equal(world.rollMessages[0].speaker.alias, "GM");
|
||||
assert.match(world.rollMessages[0].flavor, /1d20\+4/,
|
||||
"the chat card says the roll came from Dragonroll");
|
||||
});
|
||||
|
||||
test("advantage and disadvantage become Foundry's keep-highest and keep-lowest", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{
|
||||
_id: "note-1",
|
||||
title: "Rolls",
|
||||
content: "@roll[d20adv] @roll[2d20dis] @roll[4d6kh1]",
|
||||
}];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const html = world.journals()[0].pages.contents[0].text.content;
|
||||
assert.match(html, /data-dragonroll-roll="2d20kh1"/, "advantage rolls twice and keeps the higher die");
|
||||
assert.match(html, /data-dragonroll-roll="2d20kl1"/, "disadvantage rolls twice and keeps the lower die");
|
||||
assert.match(html, /data-dragonroll-roll="4d6kh1"/, "a keep-highest expression already reads as Foundry does");
|
||||
});
|
||||
|
||||
test("a dice widget inside a code span stays text", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{ _id: "note-1", title: "Syntax", content: "`@roll[1d6]`" }];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals()[0].pages.contents[0].text.content,
|
||||
"<p><code>@roll[1d6]</code></p>",
|
||||
"code that shows the widget syntax is not turned into a button");
|
||||
});
|
||||
|
||||
// --- Wiki links and embeds in the journal page -----------------------------------
|
||||
|
||||
test("a note's [[links]] and ![[embeds]] become Foundry's own enrichers", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.game.actors.contents.push({ id: "actor-1", name: "Mira", documentName: "Actor" });
|
||||
world.game.items.contents.push({ id: "item-1", name: "Rope of Climbing", documentName: "Item" });
|
||||
world.remoteNotes = [{
|
||||
_id: "note-1",
|
||||
title: "Links",
|
||||
content: "[[Mira]] and ![[Mira]]\n\n[[Rope of Climbing]] and ![[Rope of Climbing]]",
|
||||
}];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const html = world.journals()[0].pages.contents[0].text.content;
|
||||
assert.match(html, /@UUID\[Actor\.actor-1\]\{Mira\}/,
|
||||
"a link to a character opens it in Foundry");
|
||||
assert.match(html, /@Embed\[Actor\.actor-1\]\{Mira\}/,
|
||||
"an embedded character is drawn as a sheet preview");
|
||||
assert.match(html, /@UUID\[Item\.item-1\]\{Rope of Climbing\}/,
|
||||
"a link to an item opens it in Foundry");
|
||||
assert.match(html, /@Embed\[Item\.item-1\]\{Rope of Climbing\}/,
|
||||
"an embedded item is drawn as its sheet");
|
||||
});
|
||||
|
||||
test("a name the world does not have is left dimmed, and only sheets can be embedded", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [{
|
||||
_id: "note-1",
|
||||
title: "Missing",
|
||||
content: "[[Nobody]]\n\n![[Nobody]]\n\n![[Tavern Brawl]]",
|
||||
}];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const html = world.journals()[0].pages.contents[0].text.content;
|
||||
assert.match(html, /<span class="dragonroll-note-link is-unresolved">Nobody<\/span>/,
|
||||
"an unresolved link still reads, but cannot be opened");
|
||||
assert.match(html, /<span class="dragonroll-note-link is-unresolved">Tavern Brawl<\/span>/,
|
||||
"a note written with the bang is not embedded as a sheet");
|
||||
assert.doesNotMatch(html, /@Embed\[/, "nothing is embedded when there is no character or item");
|
||||
});
|
||||
|
||||
test("a note can link to another note created in the same pull", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [
|
||||
sessionNote({ content: "See [[Tavern Brawl]]." }),
|
||||
tavernNote(),
|
||||
];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
const sessionPage = journal.pages.contents.find((page) => page.name === "Session 1");
|
||||
const tavernPage = journal.pages.contents.find((page) => page.name === "Tavern Brawl");
|
||||
assert.match(
|
||||
sessionPage.text.content,
|
||||
new RegExp(`@UUID\\[JournalEntry\\.${journal.id}\\.JournalEntryPage\\.${tavernPage.id}\\]\\{Tavern Brawl\\}`),
|
||||
"the page of the note it points at opens from the link"
|
||||
);
|
||||
});
|
||||
|
||||
test("autosync off: the campaign's notes are not written into the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals(), [], "no journal is made");
|
||||
assert.deepEqual(world.notesReads(), [], "and the campaign is not even asked");
|
||||
});
|
||||
@@ -302,7 +302,7 @@ test("force sync refuses an actor Dragonroll does not import", async () => {
|
||||
assert.ok(world.notifications.some(([kind, text]) => kind === "warn" && text.includes("Cart")));
|
||||
});
|
||||
|
||||
test("turning autosync back on reconciles both sides again", async () => {
|
||||
test("turning autosync back on sends the world's snapshot again", async () => {
|
||||
const world = makeStubWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
@@ -314,6 +314,4 @@ test("turning autosync back on reconciles both sides again", async () => {
|
||||
|
||||
assert.ok(world.syncRequests().some((request) => request.body?.fullSync === true),
|
||||
"the world sends its full snapshot again");
|
||||
assert.ok(world.requests.some((request) => request.href.includes("foundry/sync/characters")),
|
||||
"Dragonroll documents are applied back into the world");
|
||||
});
|
||||
|
||||
@@ -144,7 +144,6 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (id === "../services/service-links") return { unlinkFoundryWorld: async () => {} };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
@@ -420,28 +419,6 @@ test("a module that says nothing about colours leaves the campaign's colour alon
|
||||
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
|
||||
});
|
||||
|
||||
test("the folder list the world reads back carries the colours the campaign picked", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [
|
||||
{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#0080ff" },
|
||||
{ _id: "folder-2", target: "item", name: "Homebrew" },
|
||||
{ _id: "folder-3", name: "Chapter 1" },
|
||||
],
|
||||
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("GET /sync/items");
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(response.items.length, 1);
|
||||
const coloured = response.folders.find((folder) => folder._id === "folder-1");
|
||||
assert.equal(coloured.foundryFolderId, "folder-melee", "the world's folder to write the colour back to");
|
||||
assert.equal(coloured.color, "#0080ff");
|
||||
assert.ok(!response.folders.some((folder) => folder._id === "folder-3"), "only the item list's folders travel back");
|
||||
});
|
||||
|
||||
test("every folder listing says which campaign list it belongs to", () => {
|
||||
// The sidebar's four lists share the Folder model, so a listing that names no target
|
||||
// would show folders of the other lists between its own rows. The note routes and
|
||||
@@ -476,9 +453,6 @@ function makeWorld() {
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
// What Dragonroll answers a folder reconcile with: the campaign's folders and the
|
||||
// colours its user gave them.
|
||||
remoteFolders: [],
|
||||
nextTimerId: 1,
|
||||
};
|
||||
|
||||
@@ -579,9 +553,7 @@ function makeWorld() {
|
||||
method: options.method,
|
||||
body: options.body ? JSON.parse(options.body) : null,
|
||||
});
|
||||
const payload = { status: "ok", actors: [], items: [] };
|
||||
if (href.includes("foundry/sync/items")) payload.folders = state.remoteFolders;
|
||||
return { ok: true, status: 200, json: async () => payload };
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
@@ -632,12 +604,6 @@ function makeWorld() {
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
// The reconciles `setInterval` registered: what runs every few seconds on a world
|
||||
// that is linked, and so what carries Dragonroll's folder colours back into the world.
|
||||
state.runIntervals = async () => {
|
||||
for (const interval of [...state.intervals.values()]) await interval.fn();
|
||||
await drain();
|
||||
};
|
||||
state.linkedSetup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
@@ -740,43 +706,6 @@ test("autosync off: folder changes stop syncing", async () => {
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
});
|
||||
|
||||
// --- The colours the campaign gives those folders travel back to the world ---------
|
||||
|
||||
test("a folder coloured in the Dragonroll campaign is coloured in the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
world.remoteFolders = [
|
||||
{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" },
|
||||
// A folder the campaign made for its own items: there is no world document to colour.
|
||||
{ _id: "db-homebrew", name: "Homebrew", color: "#00ff00" },
|
||||
];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, "#0080ff");
|
||||
assert.equal(world.folder("folder-ranged").color, null, "a folder the campaign says nothing about keeps what the world shows");
|
||||
assert.deepEqual(world.requests.filter((request) => request.method === "POST"), [],
|
||||
"Dragonroll's own write is not pushed back to the campaign as a world change");
|
||||
});
|
||||
|
||||
test("a colour taken off in the campaign comes off the world's folder", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: null }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, null, "uncoloured in the campaign is uncoloured in the world");
|
||||
});
|
||||
|
||||
test("autosync off: the campaign's folder colours are not written into the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
await world.game.settings.set("dragonroll-foundry", "autoSync", false);
|
||||
|
||||
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, "#8b0000", "the world keeps what it shows while autosync is off");
|
||||
});
|
||||
|
||||
// --- The sidebar groups its items under those folders ----------------------------
|
||||
|
||||
// `vm.compileFunction` is synchronous, so the service is ready right away. Loading it with
|
||||
|
||||
@@ -92,9 +92,6 @@ test("the item window shows the info and offers both icon sources", () => {
|
||||
test("the Foundry module sends item icons as URLs Dragonroll can load", () => {
|
||||
// actor-embedded items go through the same serializer as world items
|
||||
assert.match(moduleSource, /items:\s*\(actor\.items\?\.contents\?\.map\(serializeFoundryItem\)/);
|
||||
// the icon chosen in Dragonroll travels back into the linked world
|
||||
assert.match(moduleSource, /const image = getDragonrollImageUrl\(entry\.image\);\s*if \(image\) updates\.img = image;/);
|
||||
assert.match(moduleSource, /img: getDragonrollImageUrl\(entry\.image\) \|\| undefined,\s*system:/);
|
||||
});
|
||||
|
||||
test("every locale names the item window and its icon controls", () => {
|
||||
|
||||
@@ -1,600 +0,0 @@
|
||||
// Tests for the world's scenes arriving as the campaign's maps (Syndria98/dragonroll#99).
|
||||
// Only a scene's background picture and the grid laid over it travel: the campaign keeps its
|
||||
// own scale, its folders, its pinned notes and the tokens standing on the map, and none of it
|
||||
// goes back to the world.
|
||||
//
|
||||
// Same set-up as tests/item-folder-sync.test.js, which the repository root runs without
|
||||
// installing anything: the sync route is loaded into `node:vm` with express, mongoose and its
|
||||
// models stubbed (plain rows and a small filter matcher), so creating, adopting and pruning
|
||||
// maps is observable without a database. The Foundry module is loaded into a `node:vm` context
|
||||
// holding stubbed Foundry globals (`game.scenes` included) with fake timers, like
|
||||
// tests/foundry-sync-toggle.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 repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||
|
||||
// --- The sync route against stubbed models -------------------------------------
|
||||
|
||||
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Enough of the query language the scene sync uses: equality, $in, $nin, $exists.
|
||||
// Anything else is a filter this test did not expect and says so.
|
||||
function matches(document, filter = {}) {
|
||||
return Object.entries(filter).every(([key, expected]) => {
|
||||
const value = document?.[key];
|
||||
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||
return Object.entries(expected).every(([operator, wanted]) => {
|
||||
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||
});
|
||||
}
|
||||
return String(value ?? "") === String(expected ?? "");
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
function Document(data = {}) {
|
||||
counter += 1;
|
||||
this._id = `${table}-${counter}`;
|
||||
this.isNew = true;
|
||||
Object.assign(this, data);
|
||||
}
|
||||
Document.prototype.save = async function save() {
|
||||
if (this.isNew) rows.push(this);
|
||||
this.isNew = false;
|
||||
return this;
|
||||
};
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
// A seeded row belongs to the campaign the requests are made against unless the seed
|
||||
// says otherwise: the sync scopes every lookup by campaign.
|
||||
const row = new Document({ campaign: campaignId, name: undefined, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
|
||||
const model = function Model(data) { return new Document(data); };
|
||||
model.rows = rows;
|
||||
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||
model.deleteOne = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.deleteMany = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
return model;
|
||||
}
|
||||
|
||||
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the tables
|
||||
// with documents the campaign already holds.
|
||||
function loadSyncRoute({ seed = {}, worldId = "world-1", settings } = {}) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const campaign = {
|
||||
_id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId,
|
||||
...(settings ? { settings } : {}),
|
||||
};
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return { foundryItemToItemData: () => null };
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (id === "../services/service-links") return { unlinkFoundryWorld: async () => {} };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function call(route, body = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||
await handlers[handlers.length - 1](req, res);
|
||||
return res.payload;
|
||||
}
|
||||
|
||||
return { call, models, campaign };
|
||||
}
|
||||
|
||||
// A scene of the world, as the module sends it: plain document data with its picture read
|
||||
// from the world. This one is 70 px cells and the picture of the ruined keep.
|
||||
function worldScene(over = {}) {
|
||||
return {
|
||||
_id: "scene-1",
|
||||
name: "The Ruined Keep",
|
||||
img: "http://vtt.test/images/keep.webp",
|
||||
grid: 70,
|
||||
flags: {},
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
const maps = (sync) => sync.models["../models/Map"].rows;
|
||||
|
||||
// --- A scene arrives as a map -------------------------------------------------------
|
||||
|
||||
test("a world scene arrives as a map of the campaign", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.name, "The Ruined Keep");
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp", "the scene's background picture is the map's");
|
||||
assert.equal(map.gridSize, 70, "the scene's own cell size is the grid the campaign draws");
|
||||
assert.equal(map.offsetX, 0);
|
||||
assert.equal(map.offsetY, 0, "a scene that shifts nothing has its grid at the corner of the picture");
|
||||
assert.equal(map.foundrySceneId, "scene-1");
|
||||
assert.equal(map.campaign, sync.campaign._id, "the map belongs to the campaign the world is linked to");
|
||||
assert.deepEqual(response.maps, [{ foundrySceneId: "scene-1", mapId: map._id, created: true }]);
|
||||
});
|
||||
|
||||
test("a scene keeps the grid its world shifted onto the picture", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ grid: 64, flags: { core: { shiftX: 12, shiftY: -8 } } })],
|
||||
});
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.gridSize, 64);
|
||||
assert.equal(map.offsetX, 12);
|
||||
assert.equal(map.offsetY, -8, "a grid that starts off the corner of the picture arrives where the world puts it");
|
||||
});
|
||||
|
||||
test("a scene of a newer Foundry still arrives", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
// Since Foundry V13 the picture sits under `background.src` and the cell size under
|
||||
// `grid.size`.
|
||||
await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ img: undefined, background: { src: "http://vtt.test/images/keep.webp" }, grid: { size: 128 } })],
|
||||
});
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||
assert.equal(map.gridSize, 128);
|
||||
});
|
||||
|
||||
test("a scene's picture is read against the world the campaign knows", async () => {
|
||||
// An older module sends Foundry's own relative path; it is read against the world's
|
||||
// address, the way an actor's portrait is (Syndria98/dragonroll#89).
|
||||
const sync = loadSyncRoute({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ img: "images/keep.webp" })] });
|
||||
|
||||
assert.equal(maps(sync)[0].image, "http://vtt.test:30000/images/keep.webp");
|
||||
});
|
||||
|
||||
test("a scene with no picture is not a map", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", image: "http://vtt.test/images/keep.webp" }] },
|
||||
});
|
||||
|
||||
// The GM took the picture off the scene: its id still travels with the snapshot, so its
|
||||
// map is neither made blank nor dropped, and no new row is made for it either.
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ img: "" })],
|
||||
fullSync: true,
|
||||
});
|
||||
|
||||
assert.deepEqual(response.maps, []);
|
||||
assert.equal(maps(sync).length, 1);
|
||||
assert.equal(maps(sync)[0].image, "http://vtt.test/images/keep.webp");
|
||||
});
|
||||
|
||||
test("what one of the map's cells stands for stays the campaign's", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", gridSize: 50, scale: 1.5 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ gridDistance: 1500, gridUnits: "m" })] });
|
||||
|
||||
assert.equal(maps(sync)[0].gridSize, 70, "the world's cell size arrives");
|
||||
assert.equal(maps(sync)[0].scale, 1.5, "and the distance the campaign says a cell covers is left alone");
|
||||
});
|
||||
|
||||
// --- One map per scene ---------------------------------------------------------------
|
||||
|
||||
test("the same scene is never made into two maps", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ name: "The Ruined Keep, II", grid: 80 })],
|
||||
});
|
||||
|
||||
assert.equal(maps(sync).length, 1, "the scene was written over, not doubled");
|
||||
assert.equal(maps(sync)[0].name, "The Ruined Keep, II");
|
||||
assert.equal(maps(sync)[0].gridSize, 80);
|
||||
assert.equal(response.maps[0].created, false, "the push says it wrote a map it already had");
|
||||
});
|
||||
|
||||
test("a live scene edit lands on the map, however the campaign had it", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "Old name", foundrySceneId: "scene-1", image: "old.png", gridSize: 40 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||
assert.equal(map.gridSize, 70);
|
||||
assert.equal(map.name, "The Ruined Keep");
|
||||
});
|
||||
|
||||
test("a full snapshot leaves the picture and grid the campaign lined up alone", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "My keep", foundrySceneId: "scene-1", image: "my-keep.png", gridSize: 40 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "my-keep.png", "a GM reconnecting does not write over a map the campaign already had");
|
||||
assert.equal(map.gridSize, 40);
|
||||
assert.equal(map.name, "My keep");
|
||||
});
|
||||
|
||||
test("a scene takes over the map the campaign drew by hand", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", image: "hand-made.png", gridSize: 50 }] },
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(maps(sync).length, 1, "the room the campaign drew first is not doubled by its scene");
|
||||
assert.equal(maps(sync)[0]._id, "map-1");
|
||||
assert.equal(maps(sync)[0].foundrySceneId, "scene-1", "and it is the scene's map from then on");
|
||||
assert.equal(response.maps[0].mapId, "map-1");
|
||||
});
|
||||
|
||||
test("a scene carrying the campaign's map id adopts that row", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-0123456789abcdef0123456789", name: "Keep under way", image: "hand-made.png" }] },
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ name: "Somewhere else", flags: { "dragonroll-foundry": { mapId: "map-0123456789abcdef0123456789" } } })],
|
||||
});
|
||||
|
||||
assert.equal(maps(sync).length, 1);
|
||||
assert.equal(response.maps[0].mapId, "map-0123456789abcdef0123456789", "the flag says which map the scene is");
|
||||
});
|
||||
|
||||
// --- Pruning --------------------------------------------------------------------------
|
||||
|
||||
test("a full snapshot prunes the maps whose scene this world let go of", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
maps: [
|
||||
{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" },
|
||||
{ _id: "map-2", name: "Homebrew ford" },
|
||||
{ _id: "map-3", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||
|
||||
assert.deepEqual(maps(sync).map((map) => map._id).sort(), ["map-2", "map-3"],
|
||||
"the scene that is gone takes its map with it, and the campaign's own maps stay");
|
||||
});
|
||||
|
||||
test("a live scene push never prunes", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(maps(sync).length, 2, "a push of one scene says nothing about the world's other scenes");
|
||||
});
|
||||
|
||||
test("a scene the world deleted takes its map with it", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
maps: [
|
||||
{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||
{ _id: "map-2", name: "Homebrew ford" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scene-delete", { worldId: "world-1", foundrySceneId: "scene-1" });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(maps(sync).map((map) => map._id), ["map-2"], "only the map of that scene goes");
|
||||
});
|
||||
|
||||
// --- What the route refuses -----------------------------------------------------------
|
||||
|
||||
test("a push that is not the campaign's world, or names no scenes, is refused", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
assert.equal((await sync.call("POST /sync/scenes", { worldId: "another-world", scenes: [worldScene()] })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/scenes", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.deepEqual(maps(sync), [], "nothing was written");
|
||||
});
|
||||
|
||||
test("a delete from another world, or naming no scene, is refused", async () => {
|
||||
const sync = loadSyncRoute({ seed: { maps: [{ _id: "map-1", name: "Keep", foundrySceneId: "scene-1" }] } });
|
||||
|
||||
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "another-world", foundrySceneId: "scene-1" })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.equal(maps(sync).length, 1, "and the map is still there");
|
||||
});
|
||||
|
||||
test("a map remembers which scene of the world it mirrors", () => {
|
||||
const model = read("backend", "src", "models", "Map.js");
|
||||
assert.match(model, /foundrySceneId:\s*{\s*type:\s*String\s*}/, "the scene a map mirrors is kept on the map");
|
||||
assert.match(model, /\{\s*campaign:\s*1,\s*foundrySceneId:\s*1\s*\}/, "and is unique within the campaign");
|
||||
});
|
||||
|
||||
// --- The Foundry module sends its scenes ---------------------------------------------
|
||||
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
|
||||
function makeWorld({ autoSync = true } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
nextTimerId: 1,
|
||||
};
|
||||
|
||||
// A Scene document: the plain data `toObject()` answers with, which since V13 carries
|
||||
// the picture under `background` rather than `img`.
|
||||
const makeScene = (id, name, over = {}) => ({
|
||||
id, name, documentName: "Scene", img: "", grid: 50, flags: {},
|
||||
toObject() {
|
||||
return {
|
||||
_id: this.id, name: this.name, img: this.img, grid: this.grid, flags: this.flags,
|
||||
...(this.background ? { background: this.background } : {}),
|
||||
};
|
||||
},
|
||||
...over,
|
||||
});
|
||||
const scenes = [
|
||||
makeScene("scene-keep", "The Ruined Keep", { img: "images/keep.webp", grid: 70 }),
|
||||
// A newer Foundry keeps its picture under `background`, and this one is already an
|
||||
// absolute URL, which travels as it is.
|
||||
makeScene("scene-tavern", "Tavern", { img: undefined, background: { src: "http://other.test/tavern.jpg" }, grid: 50 }),
|
||||
];
|
||||
|
||||
const settingsStore = { autoSync, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
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 id = state.nextTimerId++;
|
||||
state.timers.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: (fn, delay = 0) => {
|
||||
const id = state.nextTimerId++;
|
||||
state.intervals.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearInterval: (id) => state.intervals.delete(id),
|
||||
fetch: async (url, options = {}) => {
|
||||
state.requests.push({
|
||||
href: String(url),
|
||||
method: options.method,
|
||||
body: options.body ? JSON.parse(options.body) : null,
|
||||
});
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok" }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: [], get: () => null },
|
||||
items: { contents: [], get: () => null },
|
||||
scenes: { contents: scenes, get: (id) => scenes.find((scene) => scene.id === id) },
|
||||
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.scene = (id) => scenes.find((scene) => scene.id === id);
|
||||
// The two routes the maps travel on: the campaign's reads live under the same prefix and
|
||||
// tell nothing about what the world sent.
|
||||
state.sceneRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/scenes")
|
||||
|| request.href.includes("foundry/sync/scene-delete"));
|
||||
state.pushes = (route) => state.requests.filter((request) => request.href.includes(route));
|
||||
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
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();
|
||||
}
|
||||
};
|
||||
// A world that is already linked: init, ready, and the pushes the world makes as it loads.
|
||||
state.setup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
return state;
|
||||
};
|
||||
// The same, with the world's own pushes out of the way, so a test only sees what it causes.
|
||||
state.linkedSetup = async () => {
|
||||
await state.setup();
|
||||
state.requests.length = 0;
|
||||
return state;
|
||||
};
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
test("the world sends its whole scene list as the campaign's maps when it loads", async () => {
|
||||
const world = await makeWorld().setup();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scenes");
|
||||
assert.ok(push, "a linked world pushes its scenes as it loads");
|
||||
assert.equal(push.body.fullSync, true, "the whole list travels, which is the push that lets the campaign prune");
|
||||
assert.deepEqual(push.body.worldId, "world-1");
|
||||
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name]), [
|
||||
["scene-keep", "The Ruined Keep"],
|
||||
["scene-tavern", "Tavern"],
|
||||
]);
|
||||
assert.equal(push.body.scenes[0].img, "http://vtt.test/images/keep.webp",
|
||||
"the picture is read from this world, so it travels as an absolute URL");
|
||||
assert.equal(push.body.scenes[0].grid, 70, "the scene's own cell size travels with it");
|
||||
assert.equal(push.body.scenes[1].background.src, "http://other.test/tavern.jpg",
|
||||
"a picture that is already absolute is left as it is");
|
||||
});
|
||||
|
||||
test("a scene the GM changes reaches the campaign as that map", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
const keep = world.scene("scene-keep");
|
||||
keep.name = "The Sunken Keep";
|
||||
keep.grid = 100;
|
||||
await world.fire("updateScene", keep);
|
||||
await world.runTimers();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scenes");
|
||||
assert.equal(push.body.fullSync, false, "a live scene edit never prunes the campaign's other maps");
|
||||
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name, scene.grid]), [
|
||||
["scene-keep", "The Sunken Keep", 100],
|
||||
]);
|
||||
});
|
||||
|
||||
test("a scene the GM deletes takes its map off the campaign", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||
await world.runTimers();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scene-delete");
|
||||
assert.equal(push.body.foundrySceneId, "scene-tavern");
|
||||
assert.deepEqual(world.pushes("foundry/sync/scenes"), [], "a deleted scene is not sent as a map to keep");
|
||||
});
|
||||
|
||||
test("autosync off: the world's scenes stop syncing, at world start and afterwards", async () => {
|
||||
const world = makeWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.sceneRequests(), [], "a world with autosync off sends no scene list");
|
||||
|
||||
await world.fire("updateScene", world.scene("scene-keep"));
|
||||
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||
await world.runTimers();
|
||||
|
||||
assert.deepEqual(world.sceneRequests(), []);
|
||||
});
|
||||
|
||||
test("the scene edits queued while autosync was off are sent when it is turned back on", async () => {
|
||||
const world = await makeWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
|
||||
await world.fire("updateScene", world.scene("scene-keep"));
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.sceneRequests(), []);
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||
await world.runTimers();
|
||||
|
||||
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === true
|
||||
&& push.body.scenes.length === 2),
|
||||
"turning autosync back on sends this world's whole scene list again");
|
||||
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === false
|
||||
&& push.body.scenes.map((scene) => scene._id).includes("scene-keep")),
|
||||
"and the scene edit queued while it was off is sent");
|
||||
});
|
||||
@@ -184,6 +184,8 @@ function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deleted
|
||||
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
|
||||
deleteOne: () => mongooseQuery({ deletedCount }),
|
||||
},
|
||||
// The note lists also carry the media files standing beside the notes.
|
||||
"../models/Media": { find: () => mongooseQuery([]) },
|
||||
"../models/Folder": {
|
||||
find: () => mongooseQuery(folders),
|
||||
// models/Folder.js: the note tree is every folder that is not one of the other
|
||||
|
||||
196
tests/map-walls.test.js
Normal file
196
tests/map-walls.test.js
Normal file
@@ -0,0 +1,196 @@
|
||||
// Tests for the walls of a map: straight segments drawn with the wall tool, stored with the map in
|
||||
// image pixels, in three kinds (normal, terrain, invisible).
|
||||
//
|
||||
// Same set-up as tests/map-tokens.test.js, which the repository root runs without installing
|
||||
// anything: the express router is loaded into `node:vm` with its models stubbed, and the last checks
|
||||
// read the viewer template, where the drawing wiring itself is what has to stay right.
|
||||
//
|
||||
// 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");
|
||||
|
||||
function readRepoFile(...parts) {
|
||||
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
}
|
||||
|
||||
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and lets `select()`
|
||||
// and `sort()` sit in between.
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Loads an express router file with every module it requires stubbed out.
|
||||
function loadRouter(relativeParts, stubs) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
|
||||
if (!(id in stubs)) throw new Error(`require("${id}") is not stubbed`);
|
||||
return stubs[id];
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(readRepoFile(...relativeParts), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function call(route, { body = {}, query = {}, params = {}, user = { id: "user-1" } } = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; } };
|
||||
await handlers[handlers.length - 1]({ body, query, params, user }, res);
|
||||
return res.payload;
|
||||
}
|
||||
|
||||
return { routes, call };
|
||||
}
|
||||
|
||||
function makeMap(walls = []) {
|
||||
return { _id: "map-1", campaign: "campaign-1", walls, save: async () => {} };
|
||||
}
|
||||
|
||||
function loadMapRoutes({ ownsCampaign = true, maps = [] } = {}) {
|
||||
return loadRouter(["backend", "src", "routes", "map.js"], {
|
||||
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
|
||||
"../models/Map": { findById: (id) => mongooseQuery(maps.find((map) => map._id === id) ?? null) },
|
||||
"../models/Note": { findOne: () => mongooseQuery(null) },
|
||||
"../models/Actor": { findOne: () => mongooseQuery(null) },
|
||||
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||
});
|
||||
}
|
||||
|
||||
function wallRouteTests() {
|
||||
test("a wall is saved with its type and both of its spots in image pixels", async () => {
|
||||
const map = makeMap();
|
||||
const api = loadMapRoutes({ maps: [map] });
|
||||
|
||||
const response = await api.call("POST /wall", {
|
||||
body: { id: "map-1", type: "terrain", x1: "10.4", y1: "-3", x2: "70.6", y2: "40" },
|
||||
});
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(map.walls, [{ type: "terrain", x1: 10, y1: 0, x2: 71, y2: 40 }]);
|
||||
});
|
||||
|
||||
test("a wall without a known type is a normal wall", async () => {
|
||||
const map = makeMap();
|
||||
const api = loadMapRoutes({ maps: [map] });
|
||||
|
||||
await api.call("POST /wall", { body: { id: "map-1", x1: 0, y1: 0, x2: 50, y2: 0 } });
|
||||
await api.call("POST /wall", { body: { id: "map-1", type: "door", x1: 0, y1: 50, x2: 50, y2: 50 } });
|
||||
|
||||
assert.deepEqual(map.walls.map((wall) => wall.type), ["normal", "normal"]);
|
||||
});
|
||||
|
||||
test("the three kinds of wall are kept apart", async () => {
|
||||
const map = makeMap();
|
||||
const api = loadMapRoutes({ maps: [map] });
|
||||
|
||||
for (const type of ["normal", "terrain", "invisible"]) {
|
||||
await api.call("POST /wall", { body: { id: "map-1", type, x1: 0, y1: 0, x2: 10, y2: 10 } });
|
||||
}
|
||||
|
||||
assert.deepEqual(map.walls.map((wall) => wall.type), ["normal", "terrain", "invisible"]);
|
||||
});
|
||||
|
||||
test("a wall needs its map and both of its ends", async () => {
|
||||
const map = makeMap();
|
||||
const api = loadMapRoutes({ maps: [map] });
|
||||
|
||||
assert.equal((await api.call("POST /wall", { body: { x1: 0, y1: 0, x2: 10, y2: 10 } })).msg, "errors.missing-data");
|
||||
assert.equal((await api.call("POST /wall", { body: { id: "map-1", x1: 0, y1: 0, y2: 10 } })).msg, "errors.missing-data");
|
||||
assert.deepEqual(map.walls, []);
|
||||
});
|
||||
|
||||
test("a map of somebody else's campaign takes no wall", async () => {
|
||||
const map = makeMap();
|
||||
const api = loadMapRoutes({ ownsCampaign: false, maps: [map] });
|
||||
|
||||
const response = await api.call("POST /wall", { body: { id: "map-1", type: "terrain", x1: 0, y1: 0, x2: 10, y2: 10 } });
|
||||
|
||||
assert.equal(response.msg, "unauthorized");
|
||||
assert.deepEqual(map.walls, []);
|
||||
});
|
||||
|
||||
test("removing a wall takes the one it is given and keeps the others", async () => {
|
||||
const map = makeMap([
|
||||
{ _id: "wall-1", type: "normal", x1: 0, y1: 0, x2: 50, y2: 0 },
|
||||
{ _id: "wall-2", type: "invisible", x1: 50, y1: 0, x2: 50, y2: 50 },
|
||||
]);
|
||||
const api = loadMapRoutes({ maps: [map] });
|
||||
|
||||
const response = await api.call("POST /unwall", { body: { id: "map-1", wall: "wall-1" } });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(map.walls, [{ _id: "wall-2", type: "invisible", x1: 50, y1: 0, x2: 50, y2: 50 }]);
|
||||
});
|
||||
|
||||
test("removing a wall of a map of somebody else keeps it", async () => {
|
||||
const map = makeMap([{ _id: "wall-1", type: "normal", x1: 0, y1: 0, x2: 50, y2: 0 }]);
|
||||
const api = loadMapRoutes({ ownsCampaign: false, maps: [map] });
|
||||
|
||||
const response = await api.call("POST /unwall", { body: { id: "map-1", wall: "wall-1" } });
|
||||
|
||||
assert.equal(response.msg, "unauthorized");
|
||||
assert.equal(map.walls.length, 1);
|
||||
});
|
||||
|
||||
test("the map schema stores walls of the three kinds", () => {
|
||||
const model = readRepoFile("backend", "src", "models", "Map.js");
|
||||
assert.match(model, /walls:\s*\[/);
|
||||
for (const type of ["normal", "terrain", "invisible"]) {
|
||||
assert.match(model, new RegExp(`['"]${type}['"]`), `the ${type} wall is missing from the schema`);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function mapViewerWallWiringTests() {
|
||||
const pane = readRepoFile("frontend", "app", "components", "viewer", "map", "MapViewerPane.vue");
|
||||
|
||||
test("the wall tool is a toggle of the map toolbar", () => {
|
||||
assert.match(pane, /:class="\{ selected: wallMode \}"/);
|
||||
assert.match(pane, /@click="toggleWalls"/);
|
||||
assert.match(pane, /const WALL_TYPES = \['normal', 'terrain', 'invisible'\]/);
|
||||
assert.match(pane, /v-for="type in WALL_TYPES"/);
|
||||
});
|
||||
|
||||
test("a drag with the wall tool on draws a wall instead of panning the map", () => {
|
||||
assert.match(pane, /if \(wallMode\.value\) \{[^}]*imagePointOf\(event\)/);
|
||||
assert.match(pane, /drawingWall\.value = \{ x1: spot\.x, y1: spot\.y, x2: spot\.x, y2: spot\.y \}/);
|
||||
assert.match(pane, /['"]\/map\/wall['"]/);
|
||||
assert.match(pane, /['"]\/map\/unwall['"]/);
|
||||
});
|
||||
|
||||
test("a click that did not drag leaves no wall behind", () => {
|
||||
assert.match(pane, /Math\.hypot\(wall\.x2 - wall\.x1, wall\.y2 - wall\.y1\) >= 2\) await saveWall\(wall\)/);
|
||||
});
|
||||
|
||||
test("walls are drawn over the image and only catch the mouse with the tool on", () => {
|
||||
assert.match(pane, /class="map-walls"/);
|
||||
assert.match(pane, /\.map-walls\s*\{[^}]*pointer-events:\s*none/);
|
||||
assert.match(pane, /\.map-walls\.editing \.map-wall-hit\s*\{[^}]*pointer-events:\s*stroke/);
|
||||
assert.match(pane, /@contextmenu\.stop\.prevent="onWallContextMenu\(wall\)"/);
|
||||
});
|
||||
|
||||
test("invisible walls are hidden until the wall tool is on", () => {
|
||||
assert.match(pane, /function wallVisible\(wall\) \{\s*return wall\.type !== 'invisible' \|\| wallMode\.value;/);
|
||||
});
|
||||
}
|
||||
|
||||
wallRouteTests();
|
||||
mapViewerWallWiringTests();
|
||||
198
tests/note-media.test.js
Normal file
198
tests/note-media.test.js
Normal file
@@ -0,0 +1,198 @@
|
||||
// Tests for the media files that stand in the note tree beside the notes (the sidebar lists
|
||||
// images, sounds, videos and documents with an icon of their type, the way a file explorer does).
|
||||
//
|
||||
// The repository root installs no dependencies, so the media routes run against a stubbed
|
||||
// `require`, the note lists are read out of the real route file the same way, and the sidebar and
|
||||
// nested list are read as text like tests/sidebar-entity-entry.test.js reads them.
|
||||
//
|
||||
// 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");
|
||||
|
||||
function loadRoutes(file, models) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id === "path") return path;
|
||||
// The upload folder and the file it drops are not what these checks are about.
|
||||
if (id === "fs") return { unlink: (file, done) => done() };
|
||||
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", file), ["require", "module", "exports", "__dirname"])(
|
||||
requireStub, moduleStub, moduleStub.exports, path.join(__dirname, "..", "backend", "src", "routes")
|
||||
);
|
||||
|
||||
return async function call(route, { body = {}, query = {}, file = null } = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; } };
|
||||
await handlers[handlers.length - 1]({ body, query, file, user: { id: "user-1" } }, res);
|
||||
return res.payload;
|
||||
};
|
||||
}
|
||||
|
||||
function loadMediaRoutes({ ownsCampaign = true, media = null, folderOk = true } = {}) {
|
||||
const deleted = [];
|
||||
const api = loadRoutes("media.js", {
|
||||
"../models/Campaign": { findOne: () => ({ lean: async () => (ownsCampaign ? { _id: "campaign-1" } : null) }) },
|
||||
"../models/Folder": { belongsToSection: async () => folderOk },
|
||||
"../models/Media": Object.assign(
|
||||
function Media(data) { Object.assign(this, { _id: "media-new", save: async () => {} }, data); },
|
||||
{
|
||||
findById: async () => media,
|
||||
deleteOne: async (filter) => { deleted.push(filter); return { deletedCount: 1 }; },
|
||||
}
|
||||
),
|
||||
});
|
||||
return { api, deleted };
|
||||
}
|
||||
|
||||
function seededMedia() {
|
||||
return {
|
||||
_id: "media-1", campaign: "campaign-1", file: "file-1.png", mimeType: "image/png",
|
||||
save: async () => {},
|
||||
};
|
||||
}
|
||||
|
||||
// --- Routes ---------------------------------------------------------------------
|
||||
|
||||
test("an uploaded file becomes a media row of the campaign", async () => {
|
||||
const { api } = loadMediaRoutes();
|
||||
const response = await api("POST /upload", {
|
||||
body: { campaign: "campaign-1" },
|
||||
file: { filename: "file-1.png", mimetype: "image/png", originalname: "harbour.png" },
|
||||
});
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(response.media.name, "harbour.png");
|
||||
assert.equal(response.media.file, "file-1.png");
|
||||
assert.equal(response.media.mimeType, "image/png");
|
||||
assert.equal(response.media.folder, null);
|
||||
});
|
||||
|
||||
test("an upload into another campaign is refused", async () => {
|
||||
const { api } = loadMediaRoutes({ ownsCampaign: false });
|
||||
const response = await api("POST /upload", {
|
||||
body: { campaign: "campaign-1" },
|
||||
file: { filename: "file-1.png", mimetype: "image/png", originalname: "harbour.png" },
|
||||
});
|
||||
|
||||
assert.equal(response.msg, "unauthorized");
|
||||
});
|
||||
|
||||
test("a media file only stands in a note folder", async () => {
|
||||
const { api } = loadMediaRoutes({ folderOk: false });
|
||||
const response = await api("POST /upload", {
|
||||
body: { campaign: "campaign-1", folder: "actor-folder-1" },
|
||||
file: { filename: "file-1.png", mimetype: "image/png", originalname: "harbour.png" },
|
||||
});
|
||||
|
||||
assert.equal(response.msg, "errors.notfound");
|
||||
});
|
||||
|
||||
test("a media row moves into a folder and back to the root", async () => {
|
||||
const media = seededMedia();
|
||||
const { api } = loadMediaRoutes({ media });
|
||||
|
||||
const moved = await api("POST /update", { body: { id: "media-1", folder: "folder-1" } });
|
||||
assert.equal(moved.status, "ok");
|
||||
assert.equal(media.folder, "folder-1");
|
||||
|
||||
await api("POST /update", { body: { id: "media-1", folder: null } });
|
||||
assert.equal(media.folder, null);
|
||||
});
|
||||
|
||||
test("deleting a media file of somebody else's campaign leaves it where it is", async () => {
|
||||
const { api, deleted } = loadMediaRoutes({ media: seededMedia(), ownsCampaign: false });
|
||||
const response = await api("POST /delete", { body: { id: "media-1" } });
|
||||
|
||||
assert.equal(response.msg, "unauthorized");
|
||||
assert.equal(deleted.length, 0, "the row must not be dropped");
|
||||
});
|
||||
|
||||
test("deleting a media file drops its row", async () => {
|
||||
const { api, deleted } = loadMediaRoutes({ media: seededMedia() });
|
||||
const response = await api("POST /delete", { body: { id: "media-1" } });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(deleted.length, 1);
|
||||
});
|
||||
|
||||
test("a deleted note folder takes its media rows to the root with it", () => {
|
||||
const folderRoute = read("backend", "src", "routes", "folder.js");
|
||||
assert.match(folderRoute, /Media\.updateMany\(\s*\{ folder: folderId \}/);
|
||||
});
|
||||
|
||||
// --- Both note lists carry the media standing at their level ---------------------
|
||||
|
||||
test("the note tree's root list carries the media at the root", () => {
|
||||
const noteRoute = read("backend", "src", "routes", "note.js");
|
||||
assert.match(noteRoute, /Media\.find\(\{ campaign, folder: null \}\)/);
|
||||
const list = /router\.get\('\/list'[\s\S]*?res\.json\(\{ status: 'ok', folders, notes: rootNotes, media \}\)/.exec(noteRoute);
|
||||
assert.ok(list, "expected /note/list to answer with media");
|
||||
});
|
||||
|
||||
test("a folder's list carries the media standing in that folder", () => {
|
||||
const noteRoute = read("backend", "src", "routes", "note.js");
|
||||
assert.match(noteRoute, /Media\.find\(\{ campaign, folder \}\)/);
|
||||
assert.match(noteRoute, /res\.json\(\{ status: 'ok', subfolders, notes, media \}\)/);
|
||||
});
|
||||
|
||||
// --- The sidebar -----------------------------------------------------------------
|
||||
|
||||
test("the notes section offers a media upload", () => {
|
||||
const sidebar = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||
assert.match(sidebar, /chooseMedia/);
|
||||
assert.match(sidebar, /type="file" multiple @change="uploadMedia"/);
|
||||
assert.match(sidebar, /Server\(\)\.post\('\/media\/upload'/);
|
||||
});
|
||||
|
||||
test("the note tree passes each level's media down to its rows", () => {
|
||||
const sidebar = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||
assert.match(sidebar, /:media="media"/);
|
||||
|
||||
const nested = read("frontend", "app", "components", "partials", "NestedNoteList.vue");
|
||||
assert.match(nested, /:media="getFolderMedia\(folder\._id\)"/);
|
||||
assert.match(nested, /v-for="item in media"/);
|
||||
});
|
||||
|
||||
test("every media row leads with the icon of its type", () => {
|
||||
const nested = read("frontend", "app", "components", "partials", "NestedNoteList.vue");
|
||||
assert.match(nested, /type\.startsWith\('image\/'\)[\s\S]*media-image\.svg/);
|
||||
assert.match(nested, /type\.startsWith\('audio\/'\)[\s\S]*music-note\.svg/);
|
||||
assert.match(nested, /type\.startsWith\('video\/'\)[\s\S]*media-video\.svg/);
|
||||
assert.match(nested, /application\/pdf[\s\S]*page\.svg/);
|
||||
});
|
||||
|
||||
test("a media window is registered and reads the file from /api/public", () => {
|
||||
const definitions = read("frontend", "app", "services", "WindowDefinitions.js");
|
||||
assert.match(definitions, /media_viewer: \{[\s\S]*MediaViewerWindow\.vue/);
|
||||
|
||||
const viewer = read("frontend", "app", "components", "windows", "MediaViewerWindow.vue");
|
||||
assert.match(viewer, /getBaseUrl\(\)\}\/public\/\$\{media\.file\}/);
|
||||
});
|
||||
|
||||
test("every locale names the upload and the media window", () => {
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
|
||||
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
|
||||
assert.ok(campaigns.media?.upload, `${locale} must name the media upload`);
|
||||
assert.ok(campaigns.media?.["upload-error"], `${locale} must say an upload failed`);
|
||||
assert.ok(windows["media-viewer"], `${locale} must name the media window`);
|
||||
}
|
||||
});
|
||||
198
tests/obsidian-auto-sync.test.js
Normal file
198
tests/obsidian-auto-sync.test.js
Normal file
@@ -0,0 +1,198 @@
|
||||
// Tests for the Obsidian plugin's automatic sync: vault events push edits, create notes for files
|
||||
// added to the campaign folder, and delete the note of a deleted file. The plugin is loaded from
|
||||
// source with a stubbed `obsidian` module so the real class runs under node:test.
|
||||
//
|
||||
// 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, "..", "obsidian-plugin", "obsidian-dragonroll", "main.js"),
|
||||
"utf8",
|
||||
);
|
||||
|
||||
function loadPluginClass() {
|
||||
const module = { exports: {} };
|
||||
const requireStub = (name) => {
|
||||
if (name !== "obsidian") throw new Error(`unexpected require: ${name}`);
|
||||
return {
|
||||
Notice: class { constructor(message) { this.message = message; } },
|
||||
Plugin: class {},
|
||||
PluginSettingTab: class {},
|
||||
Setting: class {},
|
||||
normalizePath: (value) => value,
|
||||
requestUrl: async () => { throw new Error("network is not stubbed"); },
|
||||
};
|
||||
};
|
||||
new Function("module", "exports", "require", SOURCE)(module, module.exports, requireStub);
|
||||
return module.exports;
|
||||
}
|
||||
|
||||
const DragonrollPlugin = loadPluginClass();
|
||||
|
||||
const FILE = {
|
||||
path: "Dragonroll/Campaign/Session 1.md",
|
||||
basename: "Session 1",
|
||||
extension: "md",
|
||||
};
|
||||
|
||||
const BUFFER = [
|
||||
"---",
|
||||
"dragonrollId: n1",
|
||||
"dragonrollCampaign: c1",
|
||||
"tags: [session]",
|
||||
"---",
|
||||
"# Hello",
|
||||
"",
|
||||
].join("\n");
|
||||
|
||||
function makePlugin({ file = FILE, frontmatter = {}, settings = {}, buffer = BUFFER } = {}) {
|
||||
const plugin = new DragonrollPlugin();
|
||||
plugin.settings = { token: "t", campaignId: "c1", autoSync: true, snapshots: {}, ...settings };
|
||||
plugin.status = { setText() {} };
|
||||
plugin.suspended = false;
|
||||
plugin.internalWrites = new Set();
|
||||
plugin.linkedNotes = new Map();
|
||||
plugin.syncChain = Promise.resolve();
|
||||
plugin.saveSettings = async () => {};
|
||||
plugin.requests = [];
|
||||
plugin.request = async (url, options = {}) => {
|
||||
plugin.requests.push({ url, options });
|
||||
if (url === "/campaign/list") return { status: "ok", campaigns: [{ _id: "c1", name: "Campaign" }] };
|
||||
if (url === "/note/create") return { status: "ok", note: { _id: "n2" } };
|
||||
if (url === "/note/update") return { status: "ok", note: { _id: "n1" } };
|
||||
return { status: "ok" };
|
||||
};
|
||||
plugin.app = {
|
||||
vault: {
|
||||
getAbstractFileByPath: () => file,
|
||||
read: async () => buffer,
|
||||
getMarkdownFiles: () => [file],
|
||||
},
|
||||
metadataCache: {
|
||||
getFileCache: () => ({ frontmatter: { dragonrollId: "n1", dragonrollCampaign: "c1", ...frontmatter } }),
|
||||
},
|
||||
fileManager: {
|
||||
processFrontMatter: async (target, apply) => {
|
||||
const written = {};
|
||||
apply(written);
|
||||
plugin.writtenFrontmatter = written;
|
||||
},
|
||||
},
|
||||
};
|
||||
return plugin;
|
||||
}
|
||||
|
||||
async function settle(plugin) {
|
||||
await plugin.syncChain;
|
||||
}
|
||||
|
||||
test("vault events are ignored when auto-sync is off, the file is not markdown, or the plugin wrote it", async () => {
|
||||
const off = makePlugin({ settings: { autoSync: false } });
|
||||
off.onVaultChange(FILE);
|
||||
await settle(off);
|
||||
assert.equal(off.requests.length, 0);
|
||||
|
||||
const notMarkdown = makePlugin();
|
||||
notMarkdown.onVaultChange({ ...FILE, extension: "pdf" });
|
||||
await settle(notMarkdown);
|
||||
assert.equal(notMarkdown.requests.length, 0);
|
||||
|
||||
const importing = makePlugin();
|
||||
importing.suspended = true;
|
||||
importing.onVaultChange(FILE);
|
||||
await settle(importing);
|
||||
assert.equal(importing.requests.length, 0);
|
||||
|
||||
const ownWrite = makePlugin();
|
||||
ownWrite.internalWrites.add(FILE.path);
|
||||
ownWrite.onVaultChange(FILE);
|
||||
await settle(ownWrite);
|
||||
assert.equal(ownWrite.requests.length, 0);
|
||||
});
|
||||
|
||||
test("saving a linked note updates it with the file content, frontmatter stripped", async () => {
|
||||
const plugin = makePlugin();
|
||||
|
||||
plugin.onVaultChange(FILE);
|
||||
await settle(plugin);
|
||||
|
||||
assert.equal(plugin.requests.length, 1);
|
||||
const [request] = plugin.requests;
|
||||
assert.equal(request.url, "/note/update");
|
||||
assert.deepEqual(request.options.body, {
|
||||
id: "n1",
|
||||
title: "Session 1",
|
||||
content: "---\ntags: [session]\n---\n# Hello\n",
|
||||
});
|
||||
assert.ok(plugin.settings.snapshots.n1, "the pushed version becomes the import baseline");
|
||||
|
||||
plugin.onVaultChange(FILE);
|
||||
await settle(plugin);
|
||||
assert.equal(plugin.requests.length, 1, "an unchanged save is not pushed again");
|
||||
});
|
||||
|
||||
test("a new note inside the campaign folder becomes a campaign note", async () => {
|
||||
const plugin = makePlugin({
|
||||
file: { path: "Dragonroll/Campaign/New Note.md", basename: "New Note", extension: "md" },
|
||||
frontmatter: { dragonrollId: undefined },
|
||||
buffer: "Body",
|
||||
});
|
||||
|
||||
plugin.onVaultChange(plugin.app.vault.getMarkdownFiles()[0]);
|
||||
await settle(plugin);
|
||||
|
||||
const create = plugin.requests.find((request) => request.url === "/note/create");
|
||||
assert.ok(create, "the new file was not created in the campaign");
|
||||
assert.deepEqual(create.options.body, { title: "New Note", content: "Body", campaign: "c1" });
|
||||
assert.deepEqual(plugin.writtenFrontmatter, {
|
||||
dragonrollId: "n2",
|
||||
dragonrollCampaign: "c1",
|
||||
dragonrollTitle: "New Note",
|
||||
});
|
||||
assert.deepEqual(plugin.linkedNotes.get("Dragonroll/Campaign/New Note.md"), { noteId: "n2", campaignId: "c1" });
|
||||
});
|
||||
|
||||
test("a new note outside the campaign folder stays local", async () => {
|
||||
const plugin = makePlugin({
|
||||
file: { path: "Notes/Idea.md", basename: "Idea", extension: "md" },
|
||||
frontmatter: { dragonrollId: undefined },
|
||||
buffer: "Body",
|
||||
});
|
||||
|
||||
plugin.onVaultChange(plugin.app.vault.getMarkdownFiles()[0]);
|
||||
await settle(plugin);
|
||||
|
||||
assert.equal(plugin.requests.length, 0);
|
||||
});
|
||||
|
||||
test("deleting a linked file, or a folder holding linked files, deletes the campaign notes", async () => {
|
||||
const plugin = makePlugin();
|
||||
plugin.settings.snapshots.n1 = "sig";
|
||||
plugin.linkedNotes.set(FILE.path, { noteId: "n1", campaignId: "c1" });
|
||||
plugin.linkedNotes.set("Dragonroll/Campaign/Other.md", { noteId: "n3", campaignId: "c1" });
|
||||
|
||||
plugin.onVaultDelete(FILE);
|
||||
await settle(plugin);
|
||||
assert.deepEqual(plugin.requests.map((request) => request.url), ["/note/delete"]);
|
||||
assert.deepEqual(plugin.requests[0].options.body, { id: "n1" });
|
||||
assert.equal(plugin.settings.snapshots.n1, undefined);
|
||||
|
||||
plugin.onVaultDelete({ path: "Dragonroll/Campaign" });
|
||||
await settle(plugin);
|
||||
assert.deepEqual(plugin.requests[1].options.body, { id: "n3" });
|
||||
assert.equal(plugin.linkedNotes.size, 0);
|
||||
});
|
||||
|
||||
test("deleting a file linked to another campaign leaves that campaign alone", async () => {
|
||||
const plugin = makePlugin();
|
||||
plugin.linkedNotes.set(FILE.path, { noteId: "n9", campaignId: "c2" });
|
||||
|
||||
plugin.onVaultDelete(FILE);
|
||||
await settle(plugin);
|
||||
|
||||
assert.equal(plugin.requests.length, 0);
|
||||
});
|
||||
@@ -16,6 +16,10 @@ const source = fs.readFileSync(
|
||||
path.join(__dirname, "..", "frontend", "app", "components", "partials", "ContentSidebar.vue"),
|
||||
"utf8"
|
||||
);
|
||||
const noteListSource = fs.readFileSync(
|
||||
path.join(__dirname, "..", "frontend", "app", "components", "partials", "NestedNoteList.vue"),
|
||||
"utf8"
|
||||
);
|
||||
|
||||
// `selector` is inserted verbatim, so escape the `.` of a class combination (`entity-entry\\.anchored`).
|
||||
// A trailing `\.entity-entry\s*\{` cannot match `.entity-entry:hover` or `.entity-entry-name`, so the
|
||||
@@ -86,3 +90,22 @@ test("a long entry name wraps instead of pushing the entry out of the sidebar",
|
||||
assert.ok(name, "expected a .entity-entry-name style rule");
|
||||
assert.match(name, /(word-break|overflow-wrap):/, "an unbreakable name has to wrap inside the entry");
|
||||
});
|
||||
|
||||
test("every entity entry leads with the icon of what it is", () => {
|
||||
for (const icon of ["user.svg", "box.svg", "map.svg"]) {
|
||||
assert.match(source, new RegExp(`class="entity-entry-icon"[^>]*${icon.replace('.', '\\.')}`),
|
||||
`expected the ${icon} icon on an entry row`);
|
||||
}
|
||||
// An item that brings its own picture still has the type icon when it carries none.
|
||||
assert.match(source, /v-else class="entity-entry-icon"[^>]*box\.svg/);
|
||||
|
||||
const icon = ruleFor("entity-entry-icon");
|
||||
assert.ok(icon, "expected a .entity-entry-icon style rule");
|
||||
assert.match(declaration(icon, "width"), /^\d+px$/);
|
||||
});
|
||||
|
||||
test("note rows lead with the page icon and media rows with the icon of their type", () => {
|
||||
assert.match(noteListSource, /class="note-link-icon"[^>]*journal-page\.svg/);
|
||||
assert.match(noteListSource, /v-for="item in media"[\s\S]*media-link-icon/);
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user