david raistrick
2569cc4497
feat(combat): add first-class undo and redo controls Add undo and redo controls to the combat UI so the DM can recover from recent actions without leaving the encounter view. Undo and redo operate on the current encounter's combat history. Empty stacks produce clear feedback instead of failing silently. Redo order follows normal stack behavior after multiple undos. This makes combat history actionable during play, not just visible in the log. feat(logs): make combat logs replayable Replace plain combat log messages with structured combat events that can be used by the UI, exported as JSON, replayed, and verified. Each new log entry records the action type, encounter identity, participant identity, a small action delta, undo intent, and a turn snapshot. Download and copy now export the event stream as JSON so a saved combat log is useful for offline analysis and debugging. Legacy logs remain viewable, but new logs use the structured event format. feat(logs): make undo and redo transactional Apply undo and redo as single storage operations so the encounter state and log state cannot drift apart. Server storage applies the encounter update and the log undone flag inside one SQLite transaction. Firebase storage uses a batch write for the same behavior. The storage contract now includes undo/redo semantics. This replaces fragile multi-write undo behavior where a failure could update the encounter without marking the log, or mark the log without updating the encounter. feat(combat): add unified replay and verification tool Add one combat CLI for replaying live combat and verifying combat logs. Replay drives the live backend through the same shared combat logic used by the app, writes a JSON event log to an explicit output path, and automatically verifies the result. Verification checks for DM-visible combat problems such as skipped turns, double actions, bad round changes, and unexpected turn order changes. The tool uses the same JSON event stream produced by log downloads, supports verbose turn output, and handles Ctrl-C by ending the encounter, writing the partial log, and verifying what was captured. fix(perf): keep long combat logging fast Remove the combat-time log query bottleneck that made long replays slow as log volume grew. Combat controls no longer subscribe to the log collection just to keep undo and redo state warm. Undo and redo now query the latest matching encounter log only when clicked. Server collection queries support exact filters, ordering, limits, and offsets, and SQLite indexes keep latest-log and per-encounter log lookups fast. Also fix duplicate WebSocket handler registration so realtime updates do not double-fire under write load. fix(turns): make toggle active a status change Make toggle active a roster/status edit instead of a turn advance. Deactivating the current participant no longer passes the turn or increments the round. The current turn stays where it is until the DM explicitly clicks Next Turn, and Next Turn skips inactive participants during normal rotation. This matches the initiative design: slot order is stable, toggle active does not move participants, and round changes only come from explicit turn advance. chore(ci): make warnings and hangs fail fast Tighten test and build checks so failures are visible instead of noisy or silent. Builds run with CI enabled so warnings fail production builds. The full test command runs app, shared, and server suites with hard timeouts so hangs fail quickly. Static eslint coverage fails on warnings as well as errors. Tests were updated around the new async combat logging flow, structured log events, transactional undo, replay verification, and toggle-active semantics.
250 lines
8.7 KiB
JavaScript
250 lines
8.7 KiB
JavaScript
// Logging contract: every mutating combat op writes a log entry to ctx.logPath
|
|
// via ctx.storage.addDoc. No-op (no state change) performs NO writes and
|
|
// returns the same encounter reference. Display lifecycle ops write the display
|
|
// doc, no combat log.
|
|
//
|
|
// Contract = every combat mutation produces a log entry.
|
|
// New shape: mutating funcs are async, take ctx, write encounter (updateDoc) +
|
|
// log (addDoc) internally, return newEnc. Logs are read back via storage.logs().
|
|
//
|
|
// undo payloads now live on the written log entry's `undo_payload.updates`.
|
|
|
|
'use strict';
|
|
|
|
const shared = require('@ttrpg/shared');
|
|
const { mockCtx } = require('./_helpers');
|
|
const {
|
|
makeParticipant,
|
|
startEncounter, nextTurn, togglePause,
|
|
addParticipant, addParticipants, updateParticipant, removeParticipant,
|
|
toggleParticipantActive, applyHpChange, deathSave, toggleCondition,
|
|
reorderParticipants, endEncounter,
|
|
} = shared;
|
|
|
|
function p(id, init) {
|
|
return makeParticipant({ id, name: id, type: 'monster',
|
|
initiative: init, maxHp: 100, currentHp: 100 });
|
|
}
|
|
function enc(ps, extra = {}) {
|
|
return { name:'t', participants:ps, isStarted:false, isPaused:false,
|
|
round:0, currentTurnParticipantId:null, turnOrderIds:[], ...extra };
|
|
}
|
|
|
|
// Assert last written log entry is a well-formed mutation log.
|
|
function expectLastLogged(storage) {
|
|
const logs = storage.logs();
|
|
expect(logs.length).toBeGreaterThan(0);
|
|
const last = logs[logs.length - 1];
|
|
expect(typeof last.message).toBe('string');
|
|
expect(last.message.length).toBeGreaterThan(0);
|
|
return last;
|
|
}
|
|
|
|
describe('Logging contract: mutating ops', () => {
|
|
let storage, ctx;
|
|
beforeEach(() => {
|
|
({ storage, ctx } = mockCtx());
|
|
});
|
|
|
|
test('startEncounter logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await startEncounter(e, ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('nextTurn logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const started = await startEncounter(e, ctx); // 1 log
|
|
await nextTurn(started, ctx); // 2 logs
|
|
expect(storage.logs()).toHaveLength(2);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('togglePause logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const started = await startEncounter(e, ctx);
|
|
await togglePause(started, ctx);
|
|
expect(storage.logs()).toHaveLength(2);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('addParticipant logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await addParticipant(e, p('d', 5), ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('removeParticipant logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await removeParticipant(e, 'b', ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('toggleParticipantActive logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await toggleParticipantActive(e, 'b', ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('applyHpChange (damage) logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await applyHpChange(e, 'b', 'damage', 10, ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('applyHpChange (heal) logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await applyHpChange(e, 'b', 'heal', 5, ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('deathSave logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const started = await startEncounter(e, ctx); // 1 log
|
|
const dying = await applyHpChange(started, 'b', 'damage', 100, ctx); // 2 logs
|
|
const r = await deathSave(dying, 'b', 'fail', 1, ctx); // 3 logs
|
|
expect(r.status).toBe('pending');
|
|
expect(storage.logs()).toHaveLength(3);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('toggleCondition logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await toggleCondition(e, 'b', 'poisoned', ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('reorderParticipants logs (BUG-7)', async () => {
|
|
// same-init tie (both 10) for valid reorder (unstarted: no pointer check)
|
|
const e2 = enc([p('a', 10), p('x', 10), p('c', 3)]);
|
|
await reorderParticipants(e2, 'x', 'a', ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('endEncounter logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const started = await startEncounter(e, ctx);
|
|
await endEncounter(started, ctx);
|
|
expect(storage.logs()).toHaveLength(2);
|
|
expectLastLogged(storage);
|
|
});
|
|
});
|
|
|
|
describe('Logging contract: no-ops', () => {
|
|
let storage, ctx;
|
|
beforeEach(() => {
|
|
({ storage, ctx } = mockCtx());
|
|
});
|
|
|
|
test('reorder same-id = no-op', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const newEnc = await reorderParticipants(e, 'a', 'a', ctx);
|
|
expect(newEnc).toBe(e); // same ref = no write
|
|
expect(storage.logs()).toHaveLength(0);
|
|
});
|
|
|
|
test('reorder cross-init = no-op', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const newEnc = await reorderParticipants(e, 'a', 'b', ctx);
|
|
expect(newEnc).toBe(e); // same ref = no write
|
|
expect(storage.logs()).toHaveLength(0);
|
|
});
|
|
});
|
|
|
|
describe('Logging undo payloads', () => {
|
|
let storage, ctx;
|
|
beforeEach(() => {
|
|
({ storage, ctx } = mockCtx());
|
|
});
|
|
|
|
test('startEncounter undo restores pre-combat state', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
await startEncounter(e, ctx);
|
|
const log = expectLastLogged(storage);
|
|
expect(log.undo).toBeDefined();
|
|
expect(log.undo.isStarted).toBe(false);
|
|
});
|
|
|
|
test('endEncounter undo restores combat state', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const started = await startEncounter(e, ctx);
|
|
await endEncounter(started, ctx);
|
|
const log = expectLastLogged(storage);
|
|
expect(log.undo).toBeDefined();
|
|
expect(log.undo.isStarted).toBe(true);
|
|
});
|
|
|
|
test('applyHpChange undo restores prior hp', async () => {
|
|
const e = enc([p('a', 10), p('b', 7), p('c', 3)]);
|
|
const newEnc = await applyHpChange(e, 'b', 'damage', 10, ctx);
|
|
const log = expectLastLogged(storage);
|
|
expect(log.undo).toBeDefined();
|
|
const restored = { ...newEnc, ...shared.expandUndo(log, newEnc).updates };
|
|
expect(restored.participants.find(x => x.id === 'b').currentHp).toBe(100);
|
|
});
|
|
|
|
test('reorder undo restores prior order (BUG-7)', async () => {
|
|
const e2 = enc([p('a', 10), p('x', 10), p('c', 3)]);
|
|
const orig = e2.participants.map(p => p.id);
|
|
const newEnc = await reorderParticipants(e2, 'x', 'a', ctx);
|
|
const log = expectLastLogged(storage);
|
|
expect(log.undo).toBeDefined();
|
|
const restored = { ...newEnc, ...shared.expandUndo(log, newEnc).updates };
|
|
expect(restored.participants.map(p => p.id)).toEqual(orig);
|
|
});
|
|
});
|
|
|
|
describe('Logging: addParticipants + updateParticipant', () => {
|
|
let storage, ctx;
|
|
beforeEach(() => {
|
|
({ storage, ctx } = mockCtx());
|
|
});
|
|
|
|
test('addParticipants logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7)]);
|
|
await addParticipants(e, [p('c', 3)], ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('updateParticipant (same slot) logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7)]);
|
|
await updateParticipant(e, 'b', { name: 'B' }, ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('updateParticipant (init change) logs', async () => {
|
|
const e = enc([p('a', 10), p('b', 7)]);
|
|
await updateParticipant(e, 'b', { initiative: 5 }, ctx);
|
|
expect(storage.logs()).toHaveLength(1);
|
|
expectLastLogged(storage);
|
|
});
|
|
|
|
test('addParticipants undo restores prior list', async () => {
|
|
const e = enc([p('a', 10), p('b', 7)]);
|
|
const orig = e.participants.map(p => p.id);
|
|
const newEnc = await addParticipants(e, [p('c', 3)], ctx);
|
|
const log = expectLastLogged(storage);
|
|
const restored = { ...newEnc, ...shared.expandUndo(log, newEnc).updates };
|
|
expect(restored.participants.map(p => p.id)).toEqual(orig);
|
|
});
|
|
|
|
test('updateParticipant undo restores prior participant', async () => {
|
|
const e = enc([p('a', 10), p('b', 7)]);
|
|
const orig = e.participants.map(p => p.id);
|
|
const newEnc = await updateParticipant(e, 'b', { name: 'B' }, ctx);
|
|
const log = expectLastLogged(storage);
|
|
const restored = { ...newEnc, ...shared.expandUndo(log, newEnc).updates };
|
|
expect(restored.participants.map(p => p.id)).toEqual(orig);
|
|
});
|
|
});
|