Compare commits
10 Commits
ai/issue-1
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eead3c9be8 | ||
| b5d5e570d5 | |||
|
|
cd1e3cb125 | ||
| 013c3512fe | |||
| 3f2ac16394 | |||
| 55fbacbdd7 | |||
| 5efe43fd99 | |||
| 00ac1b16cd | |||
|
|
07dcf08616 | ||
|
|
967c704801 |
11
AGENTS.md
11
AGENTS.md
@@ -83,11 +83,12 @@ campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, user
|
|||||||
|
|
||||||
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||||
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
||||||
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
|
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`, `foundryPageId`
|
||||||
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
||||||
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), `discordUserId` (the Discord player holding the character, unique per campaign — set only by `routes/discord.js`), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), `discordUserId` (the Discord player holding the character, unique per campaign — set only by `routes/discord.js`), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
||||||
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
||||||
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`)
|
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`, or a full URL a synced scene's
|
||||||
|
picture arrives as), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`), `foundrySceneId` (the Foundry scene this map mirrors, unique per campaign)
|
||||||
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
||||||
|
|
||||||
**API surface** (all under `/api`, all `{status,msg}`):
|
**API surface** (all under `/api`, all `{status,msg}`):
|
||||||
@@ -114,11 +115,15 @@ rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
|||||||
|
|
||||||
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
||||||
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
||||||
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
|
`item-snapshot`, `item-delete`, `scenes` (the world's scenes as the campaign's maps, `fullSync` also
|
||||||
|
prunes), `scene-delete`, `characters`, `items`, `notes` / `map-note`, `status`,
|
||||||
|
`map` / `map-item`, `delete`. Rules:
|
||||||
|
|
||||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||||
- **Only the world's item directory reaches the item list** (Syndria98/dragonroll#67) — `snapshotItemSources` reads `body.items` (`game.items`) alone; gear embedded in a character is that actor's `inventory` (see the `Actor` model), not an `Item`. A world item still folds into a hand-made or renamed row it matches by name (`foundryNames`), so a rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
- **Only the world's item directory reaches the item list** (Syndria98/dragonroll#67) — `snapshotItemSources` reads `body.items` (`game.items`) alone; gear embedded in a character is that actor's `inventory` (see the `Actor` model), not an `Item`. A world item still folds into a hand-made or renamed row it matches by name (`foundryNames`), so a rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||||
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
|
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
|
||||||
|
- **A world's scenes arrive as its campaign's maps** (Syndria98/dragonroll#99): `POST /foundry/sync/scenes` writes one `Map` per scene through `saveFoundryScene`, and only the scene's background picture and grid cross over (`services/map-foundry.js`: `gridSize` from `grid`/`grid.size`, the offsets from `flags.core.shiftX`/`.shiftY`) — `scale`, the folder, the pins and the tokens stay with the campaign and nothing of a map goes back to the world. Identity is `Map.foundrySceneId` (unique per campaign), a `dragonroll-foundry.mapId` flag or a hand-made unmapped map of the same name; a scene with no picture makes no map. `POST /foundry/sync/scene-delete` drops the map of a deleted scene, and only the full list the module sends when the world links or loads prunes.
|
||||||
|
- **Notes reach the world as journal pages, one way** (Syndria98/dragonroll#98): the module reads `GET /sync/notes` and stands every campaign note as a page of one world `JournalEntry` named Dragonroll — the page carries the note's id in a `dragonroll-foundry.noteId` flag, the note keeps the page's id in `foundryPageId` (`POST /sync/map-note`). The reconcile rewrites pages from the notes and drops the page of a deleted note; journal edits never travel back.
|
||||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
||||||
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
|
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
|
||||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. Its one write, `POST /import`, pulls the bridge's actors or world items into the campaign through the same writers as a sync push.
|
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. Its one write, `POST /import`, pulls the bridge's actors or world items into the campaign through the same writers as a sync push.
|
||||||
|
|||||||
@@ -39,7 +39,15 @@ const MapSchema = new Schema({
|
|||||||
ref: 'Folder',
|
ref: 'Folder',
|
||||||
default: null
|
default: null
|
||||||
},
|
},
|
||||||
|
// The Foundry scene this map mirrors, set by the scene sync only
|
||||||
|
// (see routes/foundry-link.js). Only the picture and the grid follow the world.
|
||||||
|
foundrySceneId: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
MapSchema.index(
|
||||||
|
{ campaign: 1, foundrySceneId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundrySceneId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Map', MapSchema);
|
module.exports = mongoose.model('Map', MapSchema);
|
||||||
|
|||||||
@@ -14,7 +14,16 @@ const NoteSchema = new Schema({
|
|||||||
ref: 'Folder'
|
ref: 'Folder'
|
||||||
},
|
},
|
||||||
color: { type: String },
|
color: { type: String },
|
||||||
|
// The journal page this note is written as in the linked Foundry world: the
|
||||||
|
// page of the one "Dragonroll" journal whose rows carry this note's id in
|
||||||
|
// their `dragonroll-foundry.noteId` flag (see the module's notes sync).
|
||||||
|
foundryPageId: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
NoteSchema.index(
|
||||||
|
{ campaign: 1, foundryPageId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundryPageId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Note', NoteSchema);
|
module.exports = mongoose.model('Note', NoteSchema);
|
||||||
@@ -6,9 +6,13 @@ const router = express.Router();
|
|||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Actor = require('../models/Actor');
|
const Actor = require('../models/Actor');
|
||||||
const Item = require('../models/Item');
|
const Item = require('../models/Item');
|
||||||
|
// Not `Map`: this route builds plain `Map`s of its own to mirror the world's folder tree.
|
||||||
|
const MapModel = require('../models/Map');
|
||||||
const Folder = require('../models/Folder');
|
const Folder = require('../models/Folder');
|
||||||
|
const Note = require('../models/Note');
|
||||||
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
||||||
const { foundryItemToItemData } = require('../services/item-foundry');
|
const { foundryItemToItemData } = require('../services/item-foundry');
|
||||||
|
const { foundrySceneToMapData } = require('../services/map-foundry');
|
||||||
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
||||||
|
|
||||||
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
||||||
@@ -64,9 +68,9 @@ function resolveWorldAssets(fields, campaign) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveFoundryActor(campaign, source, fullSync = false) {
|
async function saveFoundryActor(campaign, source, fullSync = false, replace = false) {
|
||||||
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
const fields = foundryActorToCharacter(source || {});
|
const fields = foundryActorToCharacter(source || {}, replace);
|
||||||
if (!foundryActorId || !fields.name) return null;
|
if (!foundryActorId || !fields.name) return null;
|
||||||
resolveWorldAssets(fields, campaign);
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
@@ -268,6 +272,47 @@ function resolveFoundryItemFolder(source, folders) {
|
|||||||
return folders.get(foundryFolderId.trim())?._id || null;
|
return folders.get(foundryFolderId.trim())?._id || null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Maps -------------------------------------------------------------------
|
||||||
|
// A scene of the world becomes one of the campaign's maps (Syndria98/dragonroll#99):
|
||||||
|
// services/map-foundry.js says what of a scene travels — its background picture and the
|
||||||
|
// grid laid over it, and nothing else, so the map's pins, its tokens, the folder it
|
||||||
|
// stands in and what one of its cells means stay the campaign's own.
|
||||||
|
|
||||||
|
async function saveFoundryScene(campaign, source, fullSync = false) {
|
||||||
|
const foundrySceneId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
|
const fields = foundrySceneToMapData(source || {});
|
||||||
|
if (!foundrySceneId || !fields) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
|
let map = await MapModel.findOne({ campaign: campaign._id, foundrySceneId });
|
||||||
|
const dragonrollMapId = source?.flags?.['dragonroll-foundry']?.mapId;
|
||||||
|
if (!map && mongoose.isValidObjectId(dragonrollMapId)) {
|
||||||
|
const flagged = await MapModel.findOne({ _id: dragonrollMapId, campaign: campaign._id });
|
||||||
|
// Only adopt a flagged map while no other scene owns its mapping.
|
||||||
|
if (flagged && (!flagged.foundrySceneId || flagged.foundrySceneId === foundrySceneId)) map = flagged;
|
||||||
|
}
|
||||||
|
if (!map) {
|
||||||
|
// The campaign drew this place by hand before the scene of it ever arrived: a scene
|
||||||
|
// naming the one unmapped map the campaign holds folds into that row instead of
|
||||||
|
// adding a second copy of the same room.
|
||||||
|
const sameName = await MapModel.find({
|
||||||
|
campaign: campaign._id,
|
||||||
|
name: fields.name,
|
||||||
|
foundrySceneId: { $exists: false }
|
||||||
|
}).limit(2);
|
||||||
|
map = sameName.length === 1 ? sameName[0] : new MapModel({ campaign: campaign._id });
|
||||||
|
}
|
||||||
|
|
||||||
|
map.foundrySceneId = foundrySceneId;
|
||||||
|
// `created` says whether this row is new, like the actor and item writers answer it.
|
||||||
|
const created = map.isNew;
|
||||||
|
// A full snapshot runs when a GM reconnects: the grid the campaign lined up for a map
|
||||||
|
// it already has survives that. Live scene edits continue to overwrite normally.
|
||||||
|
if (!fullSync || map.isNew) Object.assign(map, fields);
|
||||||
|
await map.save();
|
||||||
|
return { foundrySceneId, mapId: map.id, created };
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// Linking a world to a campaign happens through the sign-up link every service
|
// Linking a world to a campaign happens through the sign-up link every service
|
||||||
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
||||||
@@ -304,12 +349,16 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const fullSync = req.body.fullSync === true;
|
const fullSync = req.body.fullSync === true;
|
||||||
|
// A forced actor sync from the module's context menu replaces the campaign's
|
||||||
|
// row for the actors it sends entirely (Syndria98/dragonroll#96). It stays
|
||||||
|
// clear of fullSync: it never prunes, unlike a reconnect's full snapshot.
|
||||||
|
const replace = req.body.replace === true;
|
||||||
// A module that knows nothing about item folders sends neither the tree
|
// A module that knows nothing about item folders sends neither the tree
|
||||||
// nor the folder of an item, and then nothing here touches the folders.
|
// nor the folder of an item, and then nothing here touches the folders.
|
||||||
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
||||||
const actors = [];
|
const actors = [];
|
||||||
for (const source of actorSources || []) {
|
for (const source of actorSources || []) {
|
||||||
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
const mapping = await saveFoundryActor(campaign, source, fullSync, replace);
|
||||||
if (mapping) actors.push(mapping);
|
if (mapping) actors.push(mapping);
|
||||||
}
|
}
|
||||||
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
||||||
@@ -434,6 +483,59 @@ router.post('/sync/item-delete', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The world's scenes, upserted as the campaign's maps (Syndria98/dragonroll#99). Like a
|
||||||
|
// world item push, this one prunes only when it is told it carries every scene: that push
|
||||||
|
// alone sees the whole scene list, so it alone knows which synced maps the world has let go
|
||||||
|
// of. A map the campaign made by hand has no scene of its own and is never pruned.
|
||||||
|
router.post('/sync/scenes', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.scenes)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const fullSync = req.body.fullSync === true;
|
||||||
|
const maps = [];
|
||||||
|
for (const source of req.body.scenes) {
|
||||||
|
const mapping = await saveFoundryScene(campaign, source, fullSync);
|
||||||
|
if (mapping) maps.push(mapping);
|
||||||
|
}
|
||||||
|
if (fullSync) {
|
||||||
|
const currentIds = req.body.scenes
|
||||||
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
|
.filter(Boolean);
|
||||||
|
await MapModel.deleteMany({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundrySceneId: { $exists: true, $nin: currentIds }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
res.json({ status: 'ok', maps });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A scene the world deleted takes its map with it. Only the world says so; deleting a map
|
||||||
|
// in the campaign leaves the world's scene alone, which is the campaign's own to do.
|
||||||
|
router.post('/sync/scene-delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const foundrySceneId = String(req.body.foundrySceneId || '').trim();
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundrySceneId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
await MapModel.deleteOne({ campaign: campaign._id, foundrySceneId });
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
// The item list the world reconciles against, together with the folders its rows are
|
// The item list the world reconciles against, together with the folders its rows are
|
||||||
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
||||||
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
||||||
@@ -477,6 +579,57 @@ router.post('/sync/map-item', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// --- Note pages ------------------------------------------------------------
|
||||||
|
// The campaign's notes are read where their authors' table sits: every note
|
||||||
|
// stands as a page of the one journal the world calls "Dragonroll". Notes are
|
||||||
|
// written in Dragonroll, so this copy runs one way — the module reads the notes
|
||||||
|
// and rewrites their pages; nothing of the journal travels back. Its pages keep
|
||||||
|
// the note's id in a `dragonroll-foundry.noteId` flag, and the note keeps the
|
||||||
|
// page's id here, so either side recognises the pairing again after a restart.
|
||||||
|
|
||||||
|
// Every note of the campaign, content included: enough for the module to write
|
||||||
|
// each one as a page. Folders of the notes do not travel — the journal is flat.
|
||||||
|
router.get('/sync/notes', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const notes = await Note.find({ campaign: campaign._id })
|
||||||
|
.select('_id title content foundryPageId date')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
res.json({ status: 'ok', notes });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The page the module made for a note, kept on the note so the next reconcile —
|
||||||
|
// or a world whose page flags were lost — writes that page instead of a second
|
||||||
|
// one under the same title.
|
||||||
|
router.post('/sync/map-note', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { noteId, foundryPageId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !noteId || !foundryPageId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const note = await Note.findOne({ _id: noteId, campaign: campaign._id });
|
||||||
|
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await Note.findOne({ campaign: campaign._id, foundryPageId, _id: { $ne: note._id } });
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.note-already-synced' });
|
||||||
|
|
||||||
|
note.foundryPageId = String(foundryPageId).trim().slice(0, 120);
|
||||||
|
await note.save();
|
||||||
|
res.json({ status: 'ok', note });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = router;
|
module.exports = router;
|
||||||
// The writers every Foundry document goes through: the sync pushes above, and the
|
// The writers every Foundry document goes through: the sync pushes above, and the
|
||||||
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
||||||
|
|||||||
@@ -130,7 +130,11 @@ function foundryTraits(source, items) {
|
|||||||
return features.length ? features.join('\n\n') : undefined;
|
return features.length ? features.join('\n\n') : undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
function foundryActorToCharacter(foundryActor) {
|
// `replace` is a forced actor sync from the module's context menu (Syndria98/dragonroll#96):
|
||||||
|
// it replaces everything the campaign holds for this actor, so the fields a live edit
|
||||||
|
// leaves out when the world says nothing are written empty instead of kept. A live Foundry
|
||||||
|
// change passes `false` and keeps the campaign's own toggles and text.
|
||||||
|
function foundryActorToCharacter(foundryActor, replace = false) {
|
||||||
const system = foundryActor.system || {};
|
const system = foundryActor.system || {};
|
||||||
const details = system.details || {};
|
const details = system.details || {};
|
||||||
const abilities = system.abilities || {};
|
const abilities = system.abilities || {};
|
||||||
@@ -169,7 +173,9 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
])),
|
])),
|
||||||
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
||||||
speed: numberOr(movement.walk ?? movement.value, 30),
|
speed: numberOr(movement.walk ?? movement.value, 30),
|
||||||
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
// A replace takes the world's text even when it has none, so what Dragonroll
|
||||||
|
// cached on the actor's flag does not survive it; a live edit keeps that text.
|
||||||
|
proficiencies: foundryProficiencies || (replace ? '' : asText(savedDragonrollFields.proficiencies)),
|
||||||
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
||||||
// is a trait — its tab shows it — and a race is the species; standing them in the
|
// is a trait — its tab shows it — and a race is the species; standing them in the
|
||||||
// inventory next to the longswords is how traits and items got mixed up.
|
// inventory next to the longswords is how traits and items got mixed up.
|
||||||
@@ -201,9 +207,21 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
const currency = foundryCurrency(system);
|
const currency = foundryCurrency(system);
|
||||||
if (currency) fields.currency = currency;
|
if (currency) fields.currency = currency;
|
||||||
const worldTraits = foundryTraits(foundryActor, items);
|
const worldTraits = foundryTraits(foundryActor, items);
|
||||||
const campaignTraits = asText(savedDragonrollFields.traits);
|
const campaignTraits = replace ? '' : asText(savedDragonrollFields.traits);
|
||||||
if (worldTraits || campaignTraits) fields.traits = worldTraits || campaignTraits;
|
if (worldTraits || campaignTraits) fields.traits = worldTraits || campaignTraits;
|
||||||
|
|
||||||
|
// A replace writes the fields a live edit would leave out when the world says
|
||||||
|
// nothing, so the campaign's toggles, lists and text for this actor go with it and
|
||||||
|
// the row reads as the Foundry actor alone (Syndria98/dragonroll#96).
|
||||||
|
if (replace) {
|
||||||
|
if (fields.skills === undefined) fields.skills = {};
|
||||||
|
if (fields.savingThrows === undefined) fields.savingThrows = {};
|
||||||
|
if (fields.tools === undefined) fields.tools = [];
|
||||||
|
if (fields.languages === undefined) fields.languages = [];
|
||||||
|
if (fields.currency === undefined) fields.currency = {};
|
||||||
|
if (fields.traits === undefined) fields.traits = '';
|
||||||
|
}
|
||||||
|
|
||||||
return fields;
|
return fields;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
49
backend/src/services/map-foundry.js
Normal file
49
backend/src/services/map-foundry.js
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
const { numberOr, asText } = require('./foundry-fields');
|
||||||
|
|
||||||
|
// A Foundry scene is one of the campaign's maps (Syndria98/dragonroll#99): its background
|
||||||
|
// picture and the grid laid over it travel to Dragonroll. Everything else a scene holds —
|
||||||
|
// its padding, its lighting, the tokens standing on it — belongs to the world's table, and
|
||||||
|
// so does what one of its cells stands for (`gridDistance` with its units): the campaign
|
||||||
|
// sets its own scale and keeps it.
|
||||||
|
|
||||||
|
// The scene's background picture: `background.src` since Foundry V13, plain `img` before.
|
||||||
|
function sceneImage(scene) {
|
||||||
|
return asText(scene?.background?.src).trim() || asText(scene?.img).trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
// How many pixels of the picture one grid cell covers. Foundry keeps it under `grid.size`
|
||||||
|
// since V13 and under plain `grid` before; 50 px is its own default cell size, and
|
||||||
|
// Dragonroll's is the same, so a scene that says nothing gets the grid it draws.
|
||||||
|
function sceneGridSize(scene) {
|
||||||
|
const size = numberOr(scene?.grid?.size ?? scene?.grid, 0);
|
||||||
|
return size >= 1 ? Math.round(size) : 50;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Where that grid starts on the picture. A world shifts it with the core flags of its own
|
||||||
|
// (`flags.core.shiftX` / `.shiftY`, what it uses to line a hexagonal grid up); one that says
|
||||||
|
// nothing has its grid at the corner of the picture. The scene's padding is blank canvas
|
||||||
|
// *outside* the picture, so it is no part of the grid the campaign lays on the picture itself.
|
||||||
|
function sceneGridOffset(scene, axis) {
|
||||||
|
return Math.round(numberOr(scene?.flags?.core?.[`shift${axis}`], 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns null for a scene that is not a map: one with no name, or with no background
|
||||||
|
// picture. A Dragonroll map without a picture is an empty viewer, so those scenes stay in
|
||||||
|
// the world — their id is still listed by the snapshot that carries them, so nothing of the
|
||||||
|
// campaign is pruned because of one.
|
||||||
|
function foundrySceneToMapData(scene) {
|
||||||
|
const name = asText(scene?.name).trim();
|
||||||
|
const image = sceneImage(scene);
|
||||||
|
if (!name || !image) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
name,
|
||||||
|
// The module sends Foundry's picture as an absolute URL, like actors do.
|
||||||
|
image,
|
||||||
|
gridSize: sceneGridSize(scene),
|
||||||
|
offsetX: sceneGridOffset(scene, 'X'),
|
||||||
|
offsetY: sceneGridOffset(scene, 'Y')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { foundrySceneToMapData };
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
||||||
This integration uses a small companion bridge process on that host:
|
This integration uses a small companion bridge process on that host:
|
||||||
|
|
||||||
1. A linked GM client syncs character Actors and world Items directly with the Dragonroll campaign.
|
1. A linked GM client syncs character Actors, world Items and Scenes directly with the Dragonroll campaign.
|
||||||
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
||||||
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
||||||
|
|
||||||
@@ -73,9 +73,11 @@ queued while it was off are sent as the world catches up.
|
|||||||
With autosync off — or any time a single character needs to cross over right now — right-click an
|
With autosync off — or any time a single character needs to cross over right now — right-click an
|
||||||
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
|
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
|
||||||
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
|
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
|
||||||
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
|
when autosync is off, **replacing everything that campaign holds for them** (Syndria98/dragonroll#96):
|
||||||
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
|
what the campaign had edited on those actors is written over by what the world says. It replaces
|
||||||
not a character, NPC or creature) are refused with a notification.
|
those actors only — it never prunes the campaign's other actors, which a full snapshot does and a
|
||||||
|
forced sync never claims to. Actors Dragonroll does not import (anything that is not a character, NPC
|
||||||
|
or creature) are refused with a notification.
|
||||||
|
|
||||||
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
|
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
|
||||||
`/api/foundry/*`, which is never written into the campaign.
|
`/api/foundry/*`, which is never written into the campaign.
|
||||||
@@ -105,6 +107,42 @@ else (Syndria98/dragonroll#67):
|
|||||||
the whole world directory and can tell which synced rows it has let go of. Deleting a synced item in
|
the whole world directory and can tell which synced rows it has let go of. Deleting a synced item in
|
||||||
Dragonroll removes its Foundry world copy on the next reconcile.
|
Dragonroll removes its Foundry world copy on the next reconcile.
|
||||||
|
|
||||||
|
### Maps
|
||||||
|
|
||||||
|
A scene of the world is one of the campaign's maps (Syndria98/dragonroll#99), and only two things
|
||||||
|
about it cross over: the scene's **background picture** and the **grid** laid over it.
|
||||||
|
|
||||||
|
- The picture is sent as an absolute URL of this world, the way an actor's portrait is, so the
|
||||||
|
campaign draws the same battle map the table is looking at. Its cell size is the scene's own
|
||||||
|
(`grid`, and `grid.size` since Foundry V13), and the grid starts where the world shifts it
|
||||||
|
(`flags.core.shiftX` / `.shiftY`). A scene with no background picture makes no map.
|
||||||
|
- Everything else a scene holds stays in the world, and everything else a map holds stays in the
|
||||||
|
campaign: what one of its cells stands for, the folder it stands in, the notes pinned onto it and
|
||||||
|
the actors standing on it as tokens are the campaign's own. Nothing of a map is written back into
|
||||||
|
the world — scene sync runs one way, so a map deleted in the campaign comes back with its scene on
|
||||||
|
the next full list, and taking the scene off is what ends the map.
|
||||||
|
- A scene is matched to a map by its Foundry id, kept on the map as `foundrySceneId` (unique within
|
||||||
|
the campaign). A campaign that drew the same place by hand before its scene arrived is adopted
|
||||||
|
instead of doubled: the scene takes over the unmapped map holding its name.
|
||||||
|
- Live scene edits overwrite the map, including a picture and grid the campaign had set itself; a
|
||||||
|
full snapshot (the world linking or loading) leaves a map it already has alone. The maps of scenes
|
||||||
|
the world let go of are pruned by a full snapshot only, and a scene deleted in the world is
|
||||||
|
reported on `foundry/sync/scene-delete`.
|
||||||
|
- Autosync covers maps like everything else: turned off, no scene crosses over at all, and the ones
|
||||||
|
queued while it was off go over when it is turned back on.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
|
||||||
|
The campaign's notes read like the campaign's journal in the world (Syndria98/dragonroll#98): every
|
||||||
|
note stands as a page of one JournalEntry named **Dragonroll**. The module creates that journal — or
|
||||||
|
adopts one the GM already made under that name, marking it as the notes' journal — and renders each
|
||||||
|
note's markdown into page HTML with Foundry's own renderer. Notes are written in Dragonroll, so this
|
||||||
|
copy runs one way: a note made or edited in the campaign rewrites its page on the next reconcile, and
|
||||||
|
a note deleted there takes its page with it. A page standing under a note's title but carrying no
|
||||||
|
Dragonroll mark is claimed as that note's page, so a lost pairing does not double it. Any other page in
|
||||||
|
that journal — the GM's own — is left alone, and nothing written in the journal travels back. Autosync
|
||||||
|
off stops it too, like the rest of the sync.
|
||||||
|
|
||||||
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
||||||
|
|
||||||
| Route | Use |
|
| Route | Use |
|
||||||
@@ -112,14 +150,20 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
|
|||||||
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
||||||
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
||||||
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
||||||
|
| `POST /api/foundry/sync/scenes` | The world's scenes upsert as the campaign's maps; `fullSync` also prunes |
|
||||||
|
| `POST /api/foundry/sync/scene-delete` | A scene was deleted |
|
||||||
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
||||||
| `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
|
| `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
|
||||||
|
| `GET /api/foundry/sync/notes` | The campaign's notes, markdown and all, and the journal page each stands as |
|
||||||
|
| `POST /api/foundry/sync/map-note` | Store a note's journal page id after creating that page |
|
||||||
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
|
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
|
||||||
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
||||||
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
||||||
|
|
||||||
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
||||||
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
flag, and a journal page the module made for a note keeps its note's id in the `dragonroll-foundry.noteId`
|
||||||
|
flag, so the notes reconcile recognises its own pages. World items are marked with
|
||||||
|
`dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
||||||
the write is not echoed back. A folder colour is written with that folder held in the client's set of
|
the write is not echoed back. A folder colour is written with that folder held in the client's set of
|
||||||
folders being synced, for the same reason.
|
folders being synced, for the same reason.
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"id": "dragonroll-foundry",
|
"id": "dragonroll-foundry",
|
||||||
"title": "Dragonroll Foundry API",
|
"title": "Dragonroll Foundry API",
|
||||||
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||||
"version": "0.4.0",
|
"version": "0.6.0",
|
||||||
"library": true,
|
"library": true,
|
||||||
"compatibility": {
|
"compatibility": {
|
||||||
"minimum": "12",
|
"minimum": "12",
|
||||||
|
|||||||
@@ -33,9 +33,13 @@ let itemSyncRunning = false;
|
|||||||
let itemSyncErrorLogged = false;
|
let itemSyncErrorLogged = false;
|
||||||
let folderSyncTimeout;
|
let folderSyncTimeout;
|
||||||
let folderSyncRunning = false;
|
let folderSyncRunning = false;
|
||||||
|
let sceneSyncTimeout;
|
||||||
|
let sceneSyncRetryTimeout;
|
||||||
|
let sceneSyncErrorLogged = false;
|
||||||
const syncingItemIds = new Set();
|
const syncingItemIds = new Set();
|
||||||
const syncingFolderIds = new Set();
|
const syncingFolderIds = new Set();
|
||||||
const queuedItemChanges = new Map();
|
const queuedItemChanges = new Map();
|
||||||
|
const queuedSceneChanges = new Map();
|
||||||
|
|
||||||
function getCollectionContents(collection, collectionName) {
|
function getCollectionContents(collection, collectionName) {
|
||||||
if (!collection) {
|
if (!collection) {
|
||||||
@@ -300,6 +304,7 @@ async function applyDragonrollLink(result) {
|
|||||||
scheduleSnapshotSync(0);
|
scheduleSnapshotSync(0);
|
||||||
setTimeout(initializeCharacterSync, 0);
|
setTimeout(initializeCharacterSync, 0);
|
||||||
setTimeout(reconcileDragonrollItems, 2000);
|
setTimeout(reconcileDragonrollItems, 2000);
|
||||||
|
setTimeout(initializeSceneSync, 1000);
|
||||||
} else {
|
} else {
|
||||||
// Without a token this client cannot sync, and only a fresh link gives one.
|
// Without a token this client cannot sync, and only a fresh link gives one.
|
||||||
linkProblem = "this client could not save the token it was given";
|
linkProblem = "this client could not save the token it was given";
|
||||||
@@ -441,6 +446,8 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
clearTimeout(folderSyncTimeout);
|
clearTimeout(folderSyncTimeout);
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
clearTimeout(sceneSyncRetryTimeout);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (!game.user?.isGM || !getSyncToken()) return;
|
if (!game.user?.isGM || !getSyncToken()) return;
|
||||||
@@ -450,6 +457,8 @@ function handleAutoSyncChange(value) {
|
|||||||
initializeCharacterSync();
|
initializeCharacterSync();
|
||||||
reconcileDragonrollItems();
|
reconcileDragonrollItems();
|
||||||
queueFoundryItemFolders(400);
|
queueFoundryItemFolders(400);
|
||||||
|
reconcileDragonrollNotes();
|
||||||
|
initializeSceneSync();
|
||||||
if (queuedActorChanges.size) {
|
if (queuedActorChanges.size) {
|
||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
||||||
@@ -458,6 +467,10 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
||||||
}
|
}
|
||||||
|
if (queuedSceneChanges.size) {
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function dragonrollActorId(actor) {
|
function dragonrollActorId(actor) {
|
||||||
@@ -566,7 +579,7 @@ function reportActorSyncError(error) {
|
|||||||
console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error);
|
console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function pushFoundryActors(actors, fullSync = false) {
|
async function pushFoundryActors(actors, fullSync = false, replace = false) {
|
||||||
const token = getSyncToken();
|
const token = getSyncToken();
|
||||||
if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return;
|
if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return;
|
||||||
if (game.system.id !== "dnd5e") {
|
if (game.system.id !== "dnd5e") {
|
||||||
@@ -585,6 +598,9 @@ async function pushFoundryActors(actors, fullSync = false) {
|
|||||||
// The folder tree those world items stand in (see worldItemFolderSnapshots).
|
// The folder tree those world items stand in (see worldItemFolderSnapshots).
|
||||||
folders: worldItemFolderSnapshots(),
|
folders: worldItemFolderSnapshots(),
|
||||||
fullSync,
|
fullSync,
|
||||||
|
// A forced sync replaces the campaign's row for these actors outright; a live
|
||||||
|
// change or a full snapshot never sets this, so the campaign keeps its edits.
|
||||||
|
replace,
|
||||||
}, token);
|
}, token);
|
||||||
|
|
||||||
for (const mapping of result.actors || []) {
|
for (const mapping of result.actors || []) {
|
||||||
@@ -607,8 +623,9 @@ async function deleteDragonrollActor(foundryActorId) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Sending actors on purpose, whether or not autosync is on: this is the push the
|
// Sending actors on purpose, whether or not autosync is on: this is the push the
|
||||||
// GM asks for. It upserts those actors only, so unlike a full snapshot it never
|
// GM asks for. It replaces everything the campaign holds for those actors (Syndria98/
|
||||||
// prunes anything else the campaign holds.
|
// dragonroll#96), but it upserts them only, so unlike a full snapshot it never prunes
|
||||||
|
// anything else the campaign holds.
|
||||||
async function forceSyncActorsToDragonroll(actors) {
|
async function forceSyncActorsToDragonroll(actors) {
|
||||||
if (!game.user?.isGM || !game.world || !actors.length) return;
|
if (!game.user?.isGM || !game.world || !actors.length) return;
|
||||||
if (!getSyncToken()) {
|
if (!getSyncToken()) {
|
||||||
@@ -624,7 +641,7 @@ async function forceSyncActorsToDragonroll(actors) {
|
|||||||
if (!supported.length) return;
|
if (!supported.length) return;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await pushFoundryActors(supported);
|
await pushFoundryActors(supported, false, true);
|
||||||
ui.notifications?.info(supported.length === 1
|
ui.notifications?.info(supported.length === 1
|
||||||
? `${supported[0].name} was sent to the Dragonroll campaign.`
|
? `${supported[0].name} was sent to the Dragonroll campaign.`
|
||||||
: `${supported.length} actors were sent to the Dragonroll campaign.`);
|
: `${supported.length} actors were sent to the Dragonroll campaign.`);
|
||||||
@@ -1356,6 +1373,276 @@ function queueFoundryActorChange(kind, actor) {
|
|||||||
queueActorChange(kind, actor);
|
queueActorChange(kind, actor);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Scene sync ---------------------------------------------------------------
|
||||||
|
// A scene of this world is one of the campaign's maps (Syndria98/dragonroll#99): its
|
||||||
|
// background picture and the grid laid over it travel to Dragonroll, which keeps a map per
|
||||||
|
// scene. That is all of a scene that crosses over — pinning notes on a map, standing tokens
|
||||||
|
// on it and saying how far one of its cells goes are the campaign's own business, so none
|
||||||
|
// of it comes back to the world.
|
||||||
|
|
||||||
|
// A scene travels as plain document data with its picture read from this world: Dragonroll
|
||||||
|
// draws it outside Foundry, so the path becomes an absolute URL the way a portrait does.
|
||||||
|
// Since V13 the picture sits under `background.src`, and under plain `img` before that.
|
||||||
|
function serializeFoundryScene(scene) {
|
||||||
|
const data = toPlainData(scene);
|
||||||
|
if (!data) return null;
|
||||||
|
|
||||||
|
const absolute = (path) => new URL(path, window.location.origin).toString();
|
||||||
|
if (data.background?.src && !/^(https?:|data:|\/\/)/i.test(data.background.src)) {
|
||||||
|
data.background = { ...data.background, src: absolute(data.background.src) };
|
||||||
|
} else if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
||||||
|
data.img = absolute(data.img);
|
||||||
|
}
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The scenes the campaign mirrors as its maps. Every scene goes, including one with no
|
||||||
|
// picture: Dragonroll decides what of a scene is a map and, since such a scene's id is
|
||||||
|
// still listed, no map of the campaign is pruned because of it.
|
||||||
|
async function pushFoundryScenes(scenes, fullSync = false) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
// A full push travels even with no scenes left: it is the one that tells the campaign
|
||||||
|
// which of the maps it mirrors from this world the world has let go of.
|
||||||
|
if (!token || !game.user?.isGM || !game.world || (!scenes.length && !fullSync)) return;
|
||||||
|
|
||||||
|
await postDragonroll("foundry/sync/scenes", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
scenes: scenes.map(serializeFoundryScene).filter(Boolean),
|
||||||
|
fullSync,
|
||||||
|
}, token);
|
||||||
|
sceneSyncErrorLogged = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function deleteDragonrollScene(foundrySceneId) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.world || !foundrySceneId) return;
|
||||||
|
await postDragonroll("foundry/sync/scene-delete", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
foundrySceneId,
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportSceneSyncError(error) {
|
||||||
|
if (sceneSyncErrorLogged) return;
|
||||||
|
sceneSyncErrorLogged = true;
|
||||||
|
console.warn(`${MODULE_ID} | Map sync failed and will retry.`, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
function queueFoundrySceneChange(kind, scene) {
|
||||||
|
if (!scene || !game.user?.isGM || !getSyncToken()) return;
|
||||||
|
|
||||||
|
queuedSceneChanges.set(scene.id, { kind, scene });
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function flushSceneChanges() {
|
||||||
|
// Autosync off: the scene edits wait here, like the actor and item changes do.
|
||||||
|
if (!isAutoSyncEnabled()) return;
|
||||||
|
const changes = [...queuedSceneChanges.values()];
|
||||||
|
queuedSceneChanges.clear();
|
||||||
|
const deleted = changes.filter((change) => change.kind === "delete");
|
||||||
|
const changed = changes.filter((change) => change.kind !== "delete");
|
||||||
|
|
||||||
|
try {
|
||||||
|
for (const change of deleted) await deleteDragonrollScene(change.scene.id);
|
||||||
|
if (changed.length) await pushFoundryScenes(changed.map((change) => change.scene));
|
||||||
|
} catch (error) {
|
||||||
|
reportSceneSyncError(error);
|
||||||
|
for (const change of changes) queuedSceneChanges.set(change.scene.id, change);
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 5000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The whole scene list travels when the world links and when it loads: the campaign's map
|
||||||
|
// list mirrors this world's scenes, and only a push holding every scene can say which of
|
||||||
|
// those maps the world has let go of.
|
||||||
|
async function initializeSceneSync() {
|
||||||
|
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||||
|
try {
|
||||||
|
await pushFoundryScenes(game.scenes?.contents || [], true);
|
||||||
|
} catch (error) {
|
||||||
|
reportSceneSyncError(error);
|
||||||
|
clearTimeout(sceneSyncRetryTimeout);
|
||||||
|
sceneSyncRetryTimeout = setTimeout(initializeSceneSync, 15000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Note pages ------------------------------------------------------------
|
||||||
|
// The campaign's notes read like the campaign's journal in the world: every note
|
||||||
|
// stands as a page of one JournalEntry named "Dragonroll". Notes are written in
|
||||||
|
// Dragonroll, so this copy runs one way — the reconcile writes each note into its
|
||||||
|
// page and drops the page of a note the campaign deleted. Nothing of the journal
|
||||||
|
// is read back. A page the module made carries the `dragonroll-foundry.noteId`
|
||||||
|
// flag; one without it that stands under a note's title is claimed as that note's
|
||||||
|
// page rather than doubled, and any other page is the GM's own and left alone.
|
||||||
|
|
||||||
|
const NOTES_JOURNAL_NAME = "Dragonroll";
|
||||||
|
let noteSyncRunning = false;
|
||||||
|
let noteSyncErrorLogged = false;
|
||||||
|
|
||||||
|
function dragonrollNoteId(page) {
|
||||||
|
return page.getFlag?.(MODULE_ID, "noteId") || page.flags?.[MODULE_ID]?.noteId || "";
|
||||||
|
}
|
||||||
|
|
||||||
|
// A note is markdown, a journal page is HTML. Foundry's own renderer keeps the
|
||||||
|
// page readable in the journal and in its styles; where this Foundry does not
|
||||||
|
// offer one, escaped paragraphs keep the text legible until it does.
|
||||||
|
function notePageHtml(content) {
|
||||||
|
const markdown = String(content ?? "");
|
||||||
|
if (!markdown.trim()) return "";
|
||||||
|
if (typeof TextEditor !== "undefined" && typeof TextEditor._getMarkdown === "function") {
|
||||||
|
const html = TextEditor._getMarkdown(markdown);
|
||||||
|
if (html) return html;
|
||||||
|
}
|
||||||
|
return markdown
|
||||||
|
.split(/\n\s*\n/)
|
||||||
|
.map((block) => `<p>${escapeNoteHtml(block.trim()).replace(/\n/g, "<br />")}</p>`)
|
||||||
|
.join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
function escapeNoteHtml(value) {
|
||||||
|
return String(value).replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
|
||||||
|
}
|
||||||
|
|
||||||
|
function notePageTitle(entry) {
|
||||||
|
return String(entry.title || "").trim() || "Untitled note";
|
||||||
|
}
|
||||||
|
|
||||||
|
// The journal this module writes the campaign's notes into: the one it flagged as
|
||||||
|
// its own, or one the GM already made under that name. An unflagged one is
|
||||||
|
// flagged on use, so renaming it afterwards still leaves the notes' home findable.
|
||||||
|
function notesJournal() {
|
||||||
|
const journals = game.journals?.contents || [];
|
||||||
|
return journals.find((journal) => journal.getFlag?.(MODULE_ID, "notesJournal"))
|
||||||
|
|| journals.find((journal) => journal.name === NOTES_JOURNAL_NAME)
|
||||||
|
|| null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ensureNotesJournal() {
|
||||||
|
const existing = notesJournal();
|
||||||
|
if (existing) {
|
||||||
|
if (!existing.getFlag?.(MODULE_ID, "notesJournal")) {
|
||||||
|
await existing.update({ [`flags.${MODULE_ID}.notesJournal`]: true });
|
||||||
|
}
|
||||||
|
return existing;
|
||||||
|
}
|
||||||
|
const created = await JournalEntry.create(
|
||||||
|
{ name: NOTES_JOURNAL_NAME, flags: { [MODULE_ID]: { notesJournal: true } } },
|
||||||
|
{ renderSheet: false },
|
||||||
|
);
|
||||||
|
return Array.isArray(created) ? created[0] : created;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The page a note stands as: rewrite what the campaign changed, and claim a page
|
||||||
|
// the campaign mapped by id but whose flag was lost.
|
||||||
|
async function applyDragonrollNotePage(page, entry) {
|
||||||
|
const title = notePageTitle(entry);
|
||||||
|
const html = notePageHtml(entry.content);
|
||||||
|
const updates = {};
|
||||||
|
if (String(page.name ?? "") !== title) updates.name = title;
|
||||||
|
if (String(page.text?.content ?? "") !== html) updates["text.content"] = html;
|
||||||
|
if (!dragonrollNoteId(page)) updates[`flags.${MODULE_ID}.noteId`] = String(entry._id);
|
||||||
|
if (Object.keys(updates).length) await page.update(updates);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createDragonrollNotePage(journal, entry) {
|
||||||
|
const pages = await journal.createEmbeddedDocuments("JournalEntryPage", [{
|
||||||
|
// A page's display title is its `name`; `title` only holds the table-of-contents
|
||||||
|
// flags (`show`/`level`). Missing `name` fails the document's validation.
|
||||||
|
name: notePageTitle(entry),
|
||||||
|
text: { content: notePageHtml(entry.content) },
|
||||||
|
flags: { [MODULE_ID]: { noteId: String(entry._id) } },
|
||||||
|
}], { renderSheet: false });
|
||||||
|
return Array.isArray(pages) ? pages[0] : pages;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function mapDragonrollNote(noteId, foundryPageId) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
return postDragonroll("foundry/sync/map-note", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
noteId: String(noteId),
|
||||||
|
foundryPageId: String(foundryPageId),
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportNoteSyncError(error) {
|
||||||
|
if (noteSyncErrorLogged) return;
|
||||||
|
noteSyncErrorLogged = true;
|
||||||
|
console.warn(`${MODULE_ID} | Note journal sync failed and will retry.`, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function reconcileDragonrollNotes() {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.user?.isGM || !game.world || noteSyncRunning || !isAutoSyncEnabled()) return;
|
||||||
|
noteSyncRunning = true;
|
||||||
|
try {
|
||||||
|
const result = await getDragonroll("foundry/sync/notes", token);
|
||||||
|
const remoteNotes = result.notes || [];
|
||||||
|
// A campaign without notes gets no journal of its own — but one it once had
|
||||||
|
// stays, so the pages of notes it deleted can go with them.
|
||||||
|
if (!remoteNotes.length && !notesJournal()) return;
|
||||||
|
const journal = await ensureNotesJournal();
|
||||||
|
if (!journal) return;
|
||||||
|
|
||||||
|
const remoteById = new Map(remoteNotes.map((entry) => [String(entry._id), entry]));
|
||||||
|
const localByRemoteId = new Map((journal.pages?.contents || [])
|
||||||
|
.map((page) => [String(dragonrollNoteId(page)), page])
|
||||||
|
.filter(([noteId]) => noteId));
|
||||||
|
const retainedPageIds = new Set();
|
||||||
|
|
||||||
|
for (const entry of remoteNotes) {
|
||||||
|
let page = entry.foundryPageId ? journal.pages?.get(entry.foundryPageId) : null;
|
||||||
|
if (!page) page = localByRemoteId.get(String(entry._id));
|
||||||
|
if (page) {
|
||||||
|
retainedPageIds.add(page.id);
|
||||||
|
await applyDragonrollNotePage(page, entry);
|
||||||
|
if (!entry.foundryPageId) await mapDragonrollNote(entry._id, page.id);
|
||||||
|
} else {
|
||||||
|
// A page under the note's title that carries no Dragonroll mark — one the
|
||||||
|
// module made before the campaign kept its mapping, or one whose flag was
|
||||||
|
// lost — is claimed as that note's page instead of adding a second page of
|
||||||
|
// the same name. Like the item sync's same-name adoption, this is what keeps
|
||||||
|
// a note from being written as a new page on every reconcile.
|
||||||
|
const sameName = (journal.pages?.contents || []).find((candidate) => (
|
||||||
|
String(candidate.name ?? "") === notePageTitle(entry)
|
||||||
|
&& !dragonrollNoteId(candidate)
|
||||||
|
&& !retainedPageIds.has(candidate.id)
|
||||||
|
));
|
||||||
|
if (sameName) {
|
||||||
|
retainedPageIds.add(sameName.id);
|
||||||
|
await applyDragonrollNotePage(sameName, entry);
|
||||||
|
await mapDragonrollNote(entry._id, sameName.id);
|
||||||
|
} else {
|
||||||
|
const created = await createDragonrollNotePage(journal, entry);
|
||||||
|
if (created) {
|
||||||
|
retainedPageIds.add(created.id);
|
||||||
|
// The create carries the note's flag, but a world that drops it would leave
|
||||||
|
// the page unclaimed and the next reconcile would make another: mark it
|
||||||
|
// again the way the rest of the sync marks its documents.
|
||||||
|
await applyDragonrollNotePage(created, entry);
|
||||||
|
await mapDragonrollNote(entry._id, created.id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pages whose note the campaign deleted go with it. Only pages this module
|
||||||
|
// made are its business: an unflagged page is the GM's own.
|
||||||
|
for (const page of journal.pages?.contents || []) {
|
||||||
|
const noteId = dragonrollNoteId(page);
|
||||||
|
if (!noteId || retainedPageIds.has(page.id) || remoteById.has(String(noteId))) continue;
|
||||||
|
await page.delete();
|
||||||
|
}
|
||||||
|
noteSyncErrorLogged = false;
|
||||||
|
} catch (error) {
|
||||||
|
reportNoteSyncError(error);
|
||||||
|
} finally {
|
||||||
|
noteSyncRunning = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function publishSnapshot() {
|
async function publishSnapshot() {
|
||||||
if (!game.user?.isGM || !game.world) return;
|
if (!game.user?.isGM || !game.world) return;
|
||||||
if (syncInProgress) {
|
if (syncInProgress) {
|
||||||
@@ -1448,6 +1735,14 @@ Hooks.once("ready", () => {
|
|||||||
// already seen the world directory when it starts sending its own items back.
|
// already seen the world directory when it starts sending its own items back.
|
||||||
setTimeout(reconcileDragonrollItems, 2000);
|
setTimeout(reconcileDragonrollItems, 2000);
|
||||||
setInterval(reconcileDragonrollItems, 5000);
|
setInterval(reconcileDragonrollItems, 5000);
|
||||||
|
// The campaign's notes arrive as pages of the world's Dragonroll journal on
|
||||||
|
// the same rhythm: a note written in the app is on the journal within seconds.
|
||||||
|
setTimeout(reconcileDragonrollNotes, 3000);
|
||||||
|
setInterval(reconcileDragonrollNotes, 5000);
|
||||||
|
// The campaign's maps mirror this world's scenes: the whole list goes once the world is
|
||||||
|
// loaded, and that push alone tells the campaign which of its synced maps this world has
|
||||||
|
// let go of.
|
||||||
|
setTimeout(initializeSceneSync, 3000);
|
||||||
|
|
||||||
for (const event of [
|
for (const event of [
|
||||||
"createActor", "updateActor", "deleteActor",
|
"createActor", "updateActor", "deleteActor",
|
||||||
@@ -1481,10 +1776,18 @@ Hooks.once("ready", () => {
|
|||||||
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A scene the GM makes, renames or throws away is one of the campaign's maps being drawn
|
||||||
|
// or let go of (Syndria98/dragonroll#99). Only its picture and grid cross over, so this
|
||||||
|
// goes one way and needs no snapshot of the world behind it.
|
||||||
|
for (const event of ["createScene", "updateScene", "deleteScene"]) {
|
||||||
|
Hooks.on(event, (document) => queueFoundrySceneChange(event.startsWith("delete") ? "delete" : "upsert", document));
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// A GM sends selected actors to Dragonroll from the actor directory's context
|
// A GM sends selected actors to Dragonroll from the actor directory's context
|
||||||
// menu. This works with autosync on and off: it is the one push done on purpose.
|
// menu, replacing whatever the campaign holds for them. This works with autosync on
|
||||||
|
// and off: it is the one push done on purpose.
|
||||||
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
||||||
if (!game.user?.isGM || !getSyncToken()) return;
|
if (!game.user?.isGM || !getSyncToken()) return;
|
||||||
|
|
||||||
|
|||||||
@@ -49,3 +49,18 @@ the actor it stands for, and **Enter** does the same on a token focused with the
|
|||||||
|
|
||||||
Tokens belong to the map, not to the actor: the same character can stand on several maps, and taking a
|
Tokens belong to the map, not to the actor: the same character can stand on several maps, and taking a
|
||||||
token off does not remove the character from the campaign.
|
token off does not remove the character from the campaign.
|
||||||
|
|
||||||
|
## Maps from a linked Foundry world
|
||||||
|
|
||||||
|
With a Foundry world linked to the campaign, its scenes arrive as maps of their own: each one with the
|
||||||
|
scene's background picture and the grid laid over it, in the scene's own cell size and where the world
|
||||||
|
shifts that grid onto the picture. That is all a scene lends a map — what one of your cells stands
|
||||||
|
for, the folder a map stands in, and whatever you pin or stand on it stay yours, and nothing about a
|
||||||
|
map goes back to the world.
|
||||||
|
|
||||||
|
A scene renamed in Foundry, or its grid moved, updates its map. Take the background picture off a
|
||||||
|
scene and its map keeps the one it has; delete the scene and its map goes with it the next time the
|
||||||
|
world sends its whole scene list, which is when the world loads. For the same reason a map you delete
|
||||||
|
in the campaign comes back on the next world load while its scene is still there — take the scene off
|
||||||
|
in Foundry to be rid of the map. A map you made yourself is never doubled by the scene of it: a scene
|
||||||
|
arriving with the name of an unmapped map adopts that one. See [Foundry VTT](/docs/foundry).
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Foundry VTT
|
# Foundry VTT
|
||||||
|
|
||||||
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
||||||
characters and item directory arrive in the campaign, and what you change in Dragonroll goes back to
|
characters, item directory and scenes arrive in the campaign, and what you change in Dragonroll of
|
||||||
the world.
|
those characters and items goes back to the world.
|
||||||
|
|
||||||
There are two separate parts, and you only need the first of them:
|
There are two separate parts, and you only need the first of them:
|
||||||
|
|
||||||
@@ -51,12 +51,23 @@ Worth knowing:
|
|||||||
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
||||||
| The folders grouping that item directory | Item folders with the same names and nesting |
|
| The folders grouping that item directory | Item folders with the same names and nesting |
|
||||||
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
||||||
|
| The world's **scenes** | The campaign's maps: the scene's background picture and the grid laid over it, in the scene's own cell size |
|
||||||
|
| A journal called **Dragonroll** — one page per note | Your campaign's notes. They arrive **from** Dragonroll: what you write in the journal does not go back |
|
||||||
|
|
||||||
The item list is the world's item directory and nothing else. The gear a character carries is that
|
The item list is the world's item directory and nothing else. The gear a character carries is that
|
||||||
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
||||||
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
||||||
species are not gear and are not imported.
|
species are not gear and are not imported.
|
||||||
|
|
||||||
|
The world's scenes are the campaign's maps, and only their **background picture** and their **grid**
|
||||||
|
cross over: a map arrives with the scene's picture and its cell size, and with the grid where the
|
||||||
|
world shifts it. That is where the two stop — what one of your cells stands for, the folder a map
|
||||||
|
stands in, the notes pinned onto it and the characters standing on it as tokens stay in the campaign,
|
||||||
|
and nothing about a map is written back into the world. The scene list goes over when the world links
|
||||||
|
and when it loads, which is also when the map of a scene the GM deleted goes with it; scenes changed
|
||||||
|
afterwards arrive as they happen. A scene with no background picture makes no map, and the full list
|
||||||
|
leaves a map the campaign already had alone, so a grid you lined up yourself survives a reload.
|
||||||
|
|
||||||
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
||||||
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
||||||
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
||||||
@@ -67,6 +78,13 @@ few seconds. A **full** snapshot — the one taken when the world links, or forc
|
|||||||
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
||||||
notice what is gone. Live edits never delete anything.
|
notice what is gone. Live edits never delete anything.
|
||||||
|
|
||||||
|
Notes are the exception that runs one way, because notes are written in Dragonroll: every note stands
|
||||||
|
as a page of a single journal called **Dragonroll**. A note you make or edit in the app appears on that
|
||||||
|
journal within a few seconds, and deleting one takes its page with it. A page that stands under a note's
|
||||||
|
title but carries no Dragonroll mark is claimed as that note's page, so a pairing that was lost does not
|
||||||
|
double it. Any other page — one the GM made in that journal themselves — is left alone, and nothing
|
||||||
|
written in the journal travels back to the campaign.
|
||||||
|
|
||||||
## Auto-sync, and sending one actor on purpose
|
## Auto-sync, and sending one actor on purpose
|
||||||
|
|
||||||
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
||||||
|
|||||||
@@ -410,6 +410,36 @@ test("an actor that holds no traits does not clear what the campaign has", () =>
|
|||||||
assert.ok(!("traits" in character), "a live edit that knows nothing about traits leaves the tab as it is");
|
assert.ok(!("traits" in character), "a live edit that knows nothing about traits leaves the tab as it is");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// A forced actor sync from the module's context menu replaces everything the campaign
|
||||||
|
// holds for that actor (Syndria98/dragonroll#96): the fields a live edit leaves out when
|
||||||
|
// the world says nothing are written empty instead of kept, and the campaign's own text
|
||||||
|
// on the actor's flag does not survive it.
|
||||||
|
test("a forced sync writes empty the fields a live edit would leave out", () => {
|
||||||
|
const actor = {
|
||||||
|
name: "Thalia",
|
||||||
|
system: {},
|
||||||
|
items: [],
|
||||||
|
flags: { [MODULE_ID]: { traits: "What the campaign typed", proficiencies: "Armour, tools" } },
|
||||||
|
};
|
||||||
|
|
||||||
|
const live = foundryActorToCharacter(actor);
|
||||||
|
assert.equal(live.traits, "What the campaign typed", "a live edit fills the traits tab from the actor's flag");
|
||||||
|
assert.equal(live.proficiencies, "Armour, tools", "and the free-text proficiencies from it too");
|
||||||
|
assert.ok(
|
||||||
|
!("tools" in live) && !("languages" in live) && !("skills" in live) && !("savingThrows" in live) && !("currency" in live),
|
||||||
|
"and says nothing about the toggles and lists the world has no data for"
|
||||||
|
);
|
||||||
|
|
||||||
|
const replaced = foundryActorToCharacter(actor, true);
|
||||||
|
assert.equal(replaced.traits, "", "a forced sync clears the traits the campaign typed");
|
||||||
|
assert.equal(replaced.proficiencies, "", "down to the free-text proficiencies");
|
||||||
|
assert.deepEqual(replaced.tools, []);
|
||||||
|
assert.deepEqual(replaced.languages, []);
|
||||||
|
assert.deepEqual(replaced.skills, {});
|
||||||
|
assert.deepEqual(replaced.savingThrows, {});
|
||||||
|
assert.deepEqual(replaced.currency, {});
|
||||||
|
});
|
||||||
|
|
||||||
// --- The module sends the names a sheet outside Foundry can read -----------------
|
// --- The module sends the names a sheet outside Foundry can read -----------------
|
||||||
|
|
||||||
function makeWorld({ actor, config = {}, worldItems = [] }) {
|
function makeWorld({ actor, config = {}, worldItems = [] }) {
|
||||||
|
|||||||
@@ -133,6 +133,8 @@ function loadFoundryWriters({ seed = {}, settings } = {}) {
|
|||||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
};
|
};
|
||||||
|
|
||||||
const requireStub = (id) => {
|
const requireStub = (id) => {
|
||||||
@@ -143,6 +145,7 @@ function loadFoundryWriters({ seed = {}, settings } = {}) {
|
|||||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
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/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/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 (models[id]) return models[id];
|
if (models[id]) return models[id];
|
||||||
throw new Error(`require("${id}") is not stubbed`);
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -271,6 +271,8 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
|||||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
};
|
};
|
||||||
|
|
||||||
const requireStub = (id) => {
|
const requireStub = (id) => {
|
||||||
@@ -281,6 +283,7 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
|||||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
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/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/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 (models[id]) return models[id];
|
if (models[id]) return models[id];
|
||||||
throw new Error(`require("${id}") is not stubbed`);
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
};
|
};
|
||||||
@@ -328,6 +331,46 @@ test("an actor the world has never been seen as becomes one row, and the next im
|
|||||||
assert.equal(sync.models["../models/Actor"].rows[0].foundryActorId, "actor-9");
|
assert.equal(sync.models["../models/Actor"].rows[0].foundryActorId, "actor-9");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// A forced sync from the module's context menu (Syndria98/dragonroll#96) replaces
|
||||||
|
// everything the campaign holds for the actor; a live change is a merge and leaves the
|
||||||
|
// fields the world says nothing about to the campaign.
|
||||||
|
test("a forced actor sync clears what the campaign wrote; a live change keeps it", async () => {
|
||||||
|
const sync = loadFoundryWriters({
|
||||||
|
seed: { actors: [{
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
foundryActorId: "actor-1",
|
||||||
|
traits: "A trait the campaign wrote",
|
||||||
|
tools: ["Thieves' tools"],
|
||||||
|
languages: ["Elvish"],
|
||||||
|
skills: { perception: true },
|
||||||
|
savingThrows: { dex: true },
|
||||||
|
currency: { gp: 50 },
|
||||||
|
}] },
|
||||||
|
});
|
||||||
|
// The world says nothing about any of those: the fields a live edit leaves out.
|
||||||
|
const worldActor = { _id: "actor-1", name: "Thalia", type: "character", system: {} };
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, false);
|
||||||
|
let row = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(row.traits, "A trait the campaign wrote", "a live push leaves what the campaign wrote alone");
|
||||||
|
assert.deepEqual(row.tools, ["Thieves' tools"]);
|
||||||
|
assert.deepEqual(row.languages, ["Elvish"]);
|
||||||
|
assert.deepEqual(row.skills, { perception: true });
|
||||||
|
assert.deepEqual(row.savingThrows, { dex: true });
|
||||||
|
assert.deepEqual(row.currency, { gp: 50 });
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, true);
|
||||||
|
row = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(row.name, "Thalia", "the actor is still the one the world sent");
|
||||||
|
assert.equal(row.traits, "", "a forced sync clears the trait the campaign wrote");
|
||||||
|
assert.deepEqual(row.tools, [], "and the tools, languages, skills, saving throws and coin it held");
|
||||||
|
assert.deepEqual(row.languages, []);
|
||||||
|
assert.deepEqual(row.skills, {});
|
||||||
|
assert.deepEqual(row.savingThrows, {});
|
||||||
|
assert.deepEqual(row.currency, {});
|
||||||
|
});
|
||||||
|
|
||||||
test("a hand-made item folds into the import instead of doubling, and keeps being updated", async () => {
|
test("a hand-made item folds into the import instead of doubling, and keeps being updated", async () => {
|
||||||
const sync = loadFoundryWriters({
|
const sync = loadFoundryWriters({
|
||||||
seed: { items: [{ _id: "item-1", name: "Longsword", quantity: 1 }] },
|
seed: { items: [{ _id: "item-1", name: "Longsword", quantity: 1 }] },
|
||||||
|
|||||||
605
tests/foundry-note-journal.test.js
Normal file
605
tests/foundry-note-journal.test.js
Normal file
@@ -0,0 +1,605 @@
|
|||||||
|
// Tests for the campaign's notes reaching the Foundry world as journal pages
|
||||||
|
// (Syndria98/dragonroll#98): every Dragonroll note stands as a page of the one
|
||||||
|
// journal the world calls "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 remembers each note's page; the module reads
|
||||||
|
// them, renders the markdown, 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.journals` 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 (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 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("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({ markdown = true, keepCreateFlags = true, failMapNote = false } = {}) {
|
||||||
|
const state = {
|
||||||
|
hooks: new Map(),
|
||||||
|
registered: new Map(),
|
||||||
|
requests: [],
|
||||||
|
timers: new Map(),
|
||||||
|
intervals: new Map(),
|
||||||
|
keepCreateFlags,
|
||||||
|
failMapNote,
|
||||||
|
// 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: [],
|
||||||
|
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,
|
||||||
|
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 ?? {},
|
||||||
|
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 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");
|
||||||
|
// A world that does not keep the flags a create was handed: the page
|
||||||
|
// exists but carries no mark, which is what a lost pairing looks like.
|
||||||
|
const created = docs.map((doc) => makePage(this, keepCreateFlags ? doc : { ...doc, flags: {} }));
|
||||||
|
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" } },
|
||||||
|
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")) {
|
||||||
|
if (state.failMapNote) return { ok: false, status: 500, json: async () => ({ status: "error", msg: "errors.internal" }) };
|
||||||
|
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 }) };
|
||||||
|
}
|
||||||
|
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];
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
if (markdown) sandbox.TextEditor = { _getMarkdown: (md) => `<marked>${md}</marked>` };
|
||||||
|
|
||||||
|
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 },
|
||||||
|
journals: { 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"));
|
||||||
|
|
||||||
|
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();
|
||||||
|
};
|
||||||
|
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", "<marked>**The start**</marked>"],
|
||||||
|
["Tavern Brawl", "<marked>A rope, a chandelier.</marked>"],
|
||||||
|
], "each note is a page, its markdown rendered by Foundry's own renderer");
|
||||||
|
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("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("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, "<marked>**A different start**</marked>");
|
||||||
|
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("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("a page under the note's title with no mark is claimed, not doubled", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const journal = world.addJournal("Dragonroll");
|
||||||
|
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||||
|
|
||||||
|
// The campaign has no page id for the note, and the page carries no flag: this
|
||||||
|
// is a page the module made before the pairing was kept, or one whose flag was
|
||||||
|
// lost. It is claimed instead of a second page being made under the same title.
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "no second page under the note's title");
|
||||||
|
assert.equal(existing.text.content, "<marked>**The start**</marked>", "the note's text lands on the page the world already had");
|
||||||
|
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked as the note's");
|
||||||
|
assert.deepEqual(world.mapNoteRequests().map((request) => request.body.foundryPageId), [existing.id],
|
||||||
|
"the campaign is told which page the note now stands as");
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "reconciling again does not add another");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("two notes of one title do not share a single page", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const journal = world.addJournal("Dragonroll");
|
||||||
|
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||||
|
|
||||||
|
world.remoteNotes = [sessionNote(), { _id: "note-9", title: "Session 1", content: "second" }];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(journal.pages.contents.length, 2, "the second note gets a page of its own");
|
||||||
|
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "the world's page is claimed by the first note");
|
||||||
|
assert.equal(journal.pages.contents[1].getFlag(MODULE_ID, "noteId"), "note-9");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a page whose mark and mapping were both lost is claimed again, not doubled", async () => {
|
||||||
|
// Both ways of recognising the pairing are gone: the create's flag did not stick,
|
||||||
|
// and the campaign never got to keep the page id. Without claiming the page it
|
||||||
|
// already made, every reconcile would write another one.
|
||||||
|
const world = await makeWorld({ keepCreateFlags: false, failMapNote: true }).linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const journal = world.journals()[0];
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "one note stands as the one page it was given");
|
||||||
|
assert.equal(journal.pages.contents[0].getFlag(MODULE_ID, "noteId"), "note-1",
|
||||||
|
"and the page keeps the note it stands for even though the create did not mark it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("without Foundry's markdown renderer the fallback keeps the text legible", async () => {
|
||||||
|
const world = await makeWorld({ markdown: false }).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>",
|
||||||
|
"escaped paragraphs instead of nothing, until this Foundry offers a renderer",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
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");
|
||||||
|
});
|
||||||
@@ -207,6 +207,7 @@ test("autosync on: Foundry CRUD events keep syncing with Dragonroll", async () =
|
|||||||
const pushes = world.syncRequests();
|
const pushes = world.syncRequests();
|
||||||
assert.equal(pushes.length, 1);
|
assert.equal(pushes.length, 1);
|
||||||
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
||||||
|
assert.equal(pushes[0].body.replace, false, "a live actor change never asks Dragonroll to replace the campaign's edits");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("autosync off: CRUD requests stop syncing", async () => {
|
test("autosync off: CRUD requests stop syncing", async () => {
|
||||||
@@ -260,6 +261,7 @@ test("force sync sends selected actors to Dragonroll even with autosync off", as
|
|||||||
const pushes = world.syncRequests();
|
const pushes = world.syncRequests();
|
||||||
assert.equal(pushes.length, 1);
|
assert.equal(pushes.length, 1);
|
||||||
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
||||||
|
assert.equal(pushes[0].body.replace, true, "a forced sync replaces everything the campaign holds for those actors");
|
||||||
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
||||||
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -132,6 +132,8 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
|||||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
};
|
};
|
||||||
|
|
||||||
const requireStub = (id) => {
|
const requireStub = (id) => {
|
||||||
@@ -142,6 +144,7 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
|||||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
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/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/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 (models[id]) return models[id];
|
if (models[id]) return models[id];
|
||||||
throw new Error(`require("${id}") is not stubbed`);
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
};
|
};
|
||||||
|
|||||||
599
tests/map-foundry-sync.test.js
Normal file
599
tests/map-foundry-sync.test.js
Normal file
@@ -0,0 +1,599 @@
|
|||||||
|
// 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 (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");
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user