Parties enregistrées : IndexedDB, branches, export SGF relu par gnubg

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Pierre MARTIN
2026-11-03 15:29:01 +01:00
co-authored by Claude Opus 5.5
parent 08cb89735f
commit 274fbf6252
19 changed files with 1896 additions and 90 deletions
+172
View File
@@ -0,0 +1,172 @@
// Tests du domaine : les branches d'une partie et son export SGF, sur des
// journaux écrits à la main (sans moteur, sauf un faux pour une position de
// départ particulière). La relecture des SGF par le vrai GNU Backgammon est
// faite par tests/test_web.sh (tests/sgf/check.py).
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
import assert from "node:assert/strict";
import { test } from "node:test";
import { branches, switchToBranch } from "../src/domain/game/branches.js";
import type { Board, Engine } from "../src/domain/game/engine.js";
import {
appendEvent,
currentLine,
EMPTY_JOURNAL,
type GameJournal,
goBackTo,
type NewGameEvent,
} from "../src/domain/game/events.js";
import { parseHalfMoves, START_POSITION } from "../src/domain/game/position.js";
import { exportSgf } from "../src/domain/game/sgf.js";
function add(journal: GameJournal, ...events: NewGameEvent[]): GameJournal {
return events.reduce(appendEvent, journal);
}
const start: NewGameEvent = {
type: "GameStarted",
position: START_POSITION,
cube: { value: 1, owner: null },
firstTurn: null,
};
const move = (side: "player" | "computer", text: string, position = "P"): NewGameEvent => ({
type: "MovePlayed",
side,
halfMoves: parseHalfMoves(text),
position,
});
const roll = (side: "player" | "computer" | null, a: number, b: number): NewGameEvent => ({
type: "DiceRolled",
side,
roll: [a, b],
});
/**
* Une partie et ses branches :
* 1 début, 2 ouverture 3-1 (joueur), 3 coup 8/5 6/5, 4 dés ordinateur 6-4,
* 5 coup 24/18 13/9, 6 dés joueur 2-1 ;
* rejouée après 3 : 7 dés ordinateur 5-5 ; puis rejouée après 2 (même
* ouverture, autre coup) : 8 coup 24/23 13/10.
*/
function branchedGame(): GameJournal {
let j = add(
EMPTY_JOURNAL,
start,
roll(null, 3, 1),
move("player", "8/5 6/5"),
roll("computer", 6, 4),
move("computer", "24/18 13/9"),
roll("player", 2, 1),
);
j = add(goBackTo(j, "3"), roll("computer", 5, 5));
j = add(goBackTo(j, "2"), move("player", "24/23 13/10"));
return j;
}
test("les branches : feuilles de l'arbre, avec leur point de départ", () => {
const j = branchedGame();
const all = branches(j);
assert.deepEqual(
all.map((b) => [b.head, b.forkedFrom, b.forkMoveCount, b.moveCount, b.containsHead]),
[
["6", null, 0, 2, false],
["7", "3", 1, 1, false],
["8", "2", 0, 1, true],
],
);
assert.deepEqual(branches(EMPTY_JOURNAL), []);
// Passer d'une branche à l'autre ne perd rien.
const back = switchToBranch(j, "6");
assert.equal(back.events, j.events);
assert.deepEqual(
currentLine(back).map((e) => e.id),
["1", "2", "3", "4", "5", "6"],
);
assert.throws(() => switchToBranch(j, "4"), /branche introuvable/);
});
test("une branche rejouée puis continuée garde son ordre de création", () => {
// La ligne d'origine continue après la création d'une branche : elle
// reste la première.
let j = add(EMPTY_JOURNAL, start, roll(null, 3, 1), move("player", "8/5 6/5"));
j = add(goBackTo(j, "2"), move("player", "24/23 13/10"));
j = add(goBackTo(j, "3"), roll("computer", 6, 4));
assert.deepEqual(
branches(j).map((b) => [b.head, b.forkedFrom]),
[
["5", null],
["4", "2"],
],
);
});
/** Un faux moteur qui ne sait que décoder un plateau. */
function boardEngine(board: Board): Engine {
return { board: async () => board } as unknown as Engine;
}
const noEngine = boardEngine({} as Board);
const names = { playerName: "Vous", computerName: "Ordi]nateur", date: "2026-11-03" };
test("SGF : les coups, les variantes, la branche courante d'abord", async () => {
const sgf = await exportSgf(noEngine, branchedGame(), names);
assert.equal(
sgf,
"(;FF[4]GM[6]CA[UTF-8]AP[Ustagammon]MI[length:0][game:0][ws:0][bs:0]" +
"PW[Ordi\\]nateur]PB[Vous]DT[2026-11-03](" +
// Branche courante : même ouverture, autre coup.
"\n;B[31ablo])(" +
// Ligne d'origine : 8/5 6/5 (B : 'x' - (case - 1)).
"\n;B[31qtst](" +
// Puis 24/18 13/9 de l'ordinateur (W : 'a' + (case - 1)), et
// des dés lancés, pas joués.
"\n;W[64xrmi]\n;PL[B]DI[21])(" +
"\n;PL[W]DI[55])))\n",
);
});
test("SGF : barre, sortie, coup impossible, videau et résultat", async () => {
const j = add(
EMPTY_JOURNAL,
start,
roll(null, 1, 6),
move("computer", "bar/19 6/off"),
{ type: "CubeOffered", side: "player" },
{ type: "CubeTaken", side: "computer" },
roll("player", 6, 6),
move("player", ""),
{ type: "CubeOffered", side: "computer" },
{ type: "CubeDropped", side: "player" },
{ type: "GameEnded", winner: "computer", kind: "single", points: 2 },
);
const sgf = await exportSgf(noEngine, j, names);
assert.ok(sgf.includes("RE[W+2]"));
assert.ok(
sgf.endsWith("\n;W[16ysfz]\n;B[double]\n;W[take]\n;B[66]\n;W[double]\n;B[drop])\n"),
sgf,
);
});
test("SGF : une position de départ particulière est posée", async () => {
// Le joueur a la main : 2 pions sur sa case 1, 1 sur la barre ;
// l'ordinateur : 3 pions sur sa case 24. Videau à 4 chez l'ordinateur.
const points = (entries: Record<number, number>) =>
Array.from({ length: 24 }, (_, i) => entries[i + 1] ?? 0);
const engine = boardEngine({
onRoll: { points: points({ 1: 2 }), bar: 1, off: 12, pipCount: 27 },
opponent: { points: points({ 24: 3 }), bar: 0, off: 12, pipCount: 72 },
swappedPosition: "X",
result: null,
});
const j = add(EMPTY_JOURNAL, {
type: "GameStarted",
position: "ABC",
cube: { value: 4, owner: "computer" },
firstTurn: "player",
});
const sgf = await exportSgf(engine, j, names);
assert.ok(sgf.endsWith("\n;PL[B]AE[a:y]AW[x][x][x]AB[x][x][y]\n;CV[4]\n;CP[w])\n"), sgf);
await assert.rejects(exportSgf(noEngine, EMPTY_JOURNAL, names), /vide/);
});
+218
View File
@@ -0,0 +1,218 @@
// Tests du stockage des parties (src/storage/), sans navigateur : la
// bibliothèque de parties sur un stockage clé-valeur en mémoire (le repli
// de localStorage), la migration de la partie des versions précédentes et
// le choix du stockage. IndexedDB, absent de Node, est essayé dans un vrai
// navigateur (tests/browser/play.mjs).
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
import assert from "node:assert/strict";
import { test } from "node:test";
import {
appendEvent,
EMPTY_JOURNAL,
type GameJournal,
goBackTo,
} from "../src/domain/game/events.js";
import { START_POSITION } from "../src/domain/game/position.js";
import { createGameLibrary, isJournal, newGameId } from "../src/storage/game-library.js";
import {
createKeyValueBackend,
type KeyValueStorage,
migrateLegacyGame,
} from "../src/storage/key-value-backend.js";
import { memoryStorage, openGameLibrary } from "../src/storage/open-library.js";
/** Une partie commencée, et éventuellement quelques événements de plus. */
function journal(extraRolls = 0): GameJournal {
let j = appendEvent(EMPTY_JOURNAL, {
type: "GameStarted",
position: START_POSITION,
cube: { value: 1, owner: null },
firstTurn: null,
});
for (let i = 0; i < extraRolls; i++) {
j = appendEvent(j, { type: "DiceRolled", side: null, roll: [3, 3] });
}
return j;
}
/** Une horloge qui avance d'une seconde à chaque lecture. */
function clock(start = 1_000_000): () => number {
let t = start;
return () => {
t += 1000;
return t;
};
}
function library(storage: KeyValueStorage = memoryStorage()) {
return createGameLibrary(createKeyValueBackend(storage), { now: clock() });
}
test("plusieurs parties : liste, chargement, dernière jouée d'abord", async () => {
const games = library();
assert.deepEqual(await games.list(), []);
assert.equal(await games.current(), null);
const a = await games.save("a", journal(), { level: "2ply" });
await games.save("b", journal(1), { level: "beginner" });
assert.deepEqual(
(await games.list()).map((s) => s.id),
["b", "a"],
);
assert.equal(a.status, "playing");
assert.equal(a.result, null);
assert.equal(a.moveCount, 0);
assert.equal(a.branchCount, 1);
// Rejouer « a » la remet en tête ; sa date de début ne change pas.
const again = await games.save("a", journal(2), { level: "2ply" });
assert.equal(again.startedAt, a.startedAt);
assert.ok(again.updatedAt > a.updatedAt);
assert.deepEqual(
(await games.list()).map((s) => s.id),
["a", "b"],
);
assert.deepEqual((await games.load("a"))?.journal, journal(2));
assert.equal((await games.load("b"))?.summary.level, "beginner");
assert.equal(await games.load("inconnue"), null);
});
test("partie en cours : la dernière enregistrée, ou celle qu'on reprend", async () => {
const games = library();
await games.save("ancienne", journal(), { level: "2ply" });
await games.save("nouvelle", journal(1), { level: "2ply" });
assert.equal((await games.current())?.summary.id, "nouvelle");
// « Reprendre l'ancienne » : elle redevient la partie en cours, sans
// être modifiée ; la nouvelle peut être supprimée.
const before = await games.load("ancienne");
await games.setCurrent("ancienne");
await games.remove("nouvelle");
assert.deepEqual(await games.current(), before);
assert.deepEqual(
(await games.list()).map((s) => s.id),
["ancienne"],
);
await assert.rejects(games.setCurrent("nouvelle"), /introuvable/);
// La partie en cours supprimée : la dernière jouée la remplace.
await games.save("autre", journal(), { level: "2ply" });
await games.setCurrent("ancienne");
await games.remove("ancienne");
assert.equal((await games.current())?.summary.id, "autre");
});
test("les opérations sont faites dans l'ordre des appels", async () => {
const games = library();
// Lancées sans attendre, comme l'enregistrement après chaque action.
void games.save("a", journal(), { level: "2ply" });
void games.save("a", journal(3), { level: "2ply" });
void games.remove("a");
void games.save("b", journal(), { level: "2ply" });
assert.deepEqual(
(await games.list()).map((s) => s.id),
["b"],
);
});
test("les branches et le résultat sont résumés", async () => {
const games = library();
let j = journal(2);
j = goBackTo(j, "2");
j = appendEvent(j, { type: "DiceRolled", side: null, roll: [5, 2] });
j = appendEvent(j, {
type: "MovePlayed",
side: "player",
halfMoves: [],
position: START_POSITION,
});
j = appendEvent(j, { type: "GameEnded", winner: "player", kind: "gammon", points: 2 });
const summary = await games.save("x", j, { level: "2ply" });
assert.equal(summary.branchCount, 2);
assert.equal(summary.moveCount, 1);
assert.equal(summary.status, "over");
assert.deepEqual(summary.result, { winner: "player", kind: "gammon", points: 2 });
});
test("un journal illisible n'est pas chargé ; un stockage plein ne casse rien", async () => {
const storage = memoryStorage();
const games = library(storage);
await games.save("a", journal(), { level: "2ply" });
storage.setItem("ustagammon.game.a", "{pas du JSON");
assert.equal(await games.load("a"), null);
assert.equal(isJournal({ events: [], head: 3 }), false);
assert.equal(isJournal(null), false);
const full = library({
getItem: () => null,
setItem: () => {
throw new Error("plein");
},
removeItem: () => {},
});
await assert.rejects(full.save("a", journal(), { level: "2ply" }), /plein/);
// La bibliothèque reste utilisable après un échec.
assert.deepEqual(await full.list(), []);
});
test("la partie des versions précédentes est migrée, une seule fois", async () => {
const storage = memoryStorage();
const old = journal(1);
storage.setItem("ustagammon.current-game", JSON.stringify(old));
const games = library(storage);
const id = await migrateLegacyGame(storage, games, 42);
assert.ok(id !== null);
assert.equal(storage.getItem("ustagammon.current-game"), null);
const current = await games.current();
assert.equal(current?.summary.id, id);
assert.deepEqual(current?.journal, old);
assert.equal(await migrateLegacyGame(storage, games), null);
assert.equal((await games.list()).length, 1);
// Un ancien enregistrement illisible est seulement effacé.
storage.setItem("ustagammon.current-game", "{pas du JSON");
assert.equal(await migrateLegacyGame(storage, games), null);
assert.equal(storage.getItem("ustagammon.current-game"), null);
assert.equal((await games.list()).length, 1);
});
test("sans IndexedDB : localStorage, ou à défaut la mémoire", async () => {
const storage = memoryStorage();
storage.setItem("ustagammon.current-game", JSON.stringify(journal()));
const opened = await openGameLibrary({ localStorage: storage });
assert.equal(opened.kind, "localStorage");
assert.equal((await opened.library.list()).length, 1);
const refused: KeyValueStorage = {
getItem: () => {
throw new Error("interdit");
},
setItem: () => {
throw new Error("interdit");
},
removeItem: () => {
throw new Error("interdit");
},
};
const memory = await openGameLibrary({ localStorage: refused });
assert.equal(memory.kind, "memory");
await memory.library.save("a", journal(), { level: "2ply" });
assert.equal((await memory.library.current())?.summary.id, "a");
// IndexedDB qui échoue à l'ouverture : repli.
const broken = {
open: () => {
throw new Error("indisponible");
},
} as unknown as IDBFactory;
assert.equal((await openGameLibrary({ indexedDB: broken })).kind, "memory");
});
test("les identifiants de partie sont distincts", () => {
const ids = new Set(Array.from({ length: 100 }, () => newGameId(1)));
assert.ok(ids.size > 95);
assert.match(newGameId(), /^[0-9a-z]+-[0-9a-z]{6}$/);
});
+210
View File
@@ -0,0 +1,210 @@
// Parties d'exemple exportées en SGF, pour les faire relire par le GNU
// Backgammon de référence (tests/test_sgf_reference.sh).
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
//
// Usage : node build/web/tests/tools/sgf-samples.js <dossier>
//
// Joue sur le vrai moteur WebAssembly, avec des dés reproductibles, des
// parties variées : complètes, avec branches, avec videau, depuis une
// position particulière. Pour chaque branche de chaque partie, écrit
// <nom>.sgf (la partie exportée, cette branche en premier : c'est celle que
// gnubg lit) et <nom>.json : les positions successives du journal sur cette
// branche, celles que gnubg doit retrouver (tests/sgf/check.py).
import { mkdirSync, writeFileSync } from "node:fs";
import { join } from "node:path";
import type { Engine } from "../../src/domain/game/engine.js";
import { Game } from "../../src/domain/game/game.js";
import type { DiceSource } from "../../src/domain/game/roll.js";
import { exportSgf } from "../../src/domain/game/sgf.js";
import { loadNodeEngine } from "../support/node-engine.js";
/** Des dés pseudo-aléatoires reproductibles (générateur congruentiel). */
function seededDice(seed: number): DiceSource {
let state = seed;
return () => {
state = (state * 1103515245 + 12345) % 2147483648;
return 1 + (Math.floor(state / 65536) % 6);
};
}
/**
* Une action de la partie, quel que soit le camp qui a la main. Le joueur
* joue le choice-ième coup légal (le dernier s'il y en a moins), prend les
* doubles si take, et double quand il le peut si double.
*/
async function step(
game: Game,
engine: Engine,
strategy: { choice?: number; take?: boolean; double?: boolean } = {},
): Promise<void> {
const state = game.state;
if (state.turn === "computer" && state.phase === "doubled") {
if (strategy.take ?? true) {
game.take();
} else {
game.drop();
}
} else if (state.turn === "computer") {
await game.playComputerTurn();
} else if (state.phase === "rolling") {
if (strategy.double === true && (await game.canDouble())) {
await game.double();
} else {
await game.roll();
}
} else if (state.phase === "moving" && state.roll !== null) {
const moves = await engine.legalMoves(state.position, state.roll);
const move = moves[Math.min(strategy.choice ?? 0, moves.length - 1)];
if (move === undefined) {
await game.skipTurn();
return;
}
for (const halfMove of move.halfMoves) {
if (!(await game.playHalfMove(halfMove))) {
throw new Error("coup légal refusé");
}
}
await game.confirmMove();
} else {
throw new Error(`phase inattendue : ${state.phase}`);
}
}
async function playMoves(game: Game, engine: Engine, count: number, choice = 0): Promise<void> {
let played = 0;
while (played < count && game.state.phase !== "over") {
const before = game.events.length;
await step(game, engine, { choice });
played += game.events.slice(before).filter((event) => event.type === "MovePlayed").length;
}
}
async function playToTheEnd(game: Game, engine: Engine, choice = 0): Promise<void> {
for (let i = 0; game.state.phase !== "over"; i++) {
if (i > 2000) {
throw new Error("la partie ne finit pas");
}
await step(game, engine, { choice });
}
}
/** Le dernier événement « coup joué » de la ligne courante. */
function lastMoveId(game: Game, skip = 0): string {
const moves = game.events.filter((event) => event.type === "MovePlayed");
const move = moves.at(-1 - skip);
if (move === undefined) {
throw new Error("aucun coup joué");
}
return move.id;
}
async function main(): Promise<void> {
const out = process.argv[2];
if (out === undefined) {
throw new Error("usage : sgf-samples.js <dossier>");
}
mkdirSync(out, { recursive: true });
const engine = await loadNodeEngine();
const games: [string, Game][] = [];
// Une partie complète, puis une autre où le joueur joue autrement.
for (const [seed, choice] of [
[3, 0],
[11, 2],
] as const) {
const game = Game.start(engine, { dice: seededDice(seed), ply: 0 });
await playToTheEnd(game, engine, choice);
games.push([`complete-${seed}`, game]);
}
// Des branches : rejouée d'un coup de l'ordinateur (nouveaux dés), d'un
// jet du joueur (même jet, autre coup), et une branche d'une branche.
{
const game = Game.start(engine, { dice: seededDice(5), ply: 0 });
await playMoves(game, engine, 14);
const original = game.events.at(-1)?.id as string;
game.goBackTo(lastMoveId(game, 6));
await playMoves(game, engine, 8);
const rolled = game.events.findLast((e) => e.type === "DiceRolled" && e.side === "player");
if (rolled === undefined) {
throw new Error("aucun jet du joueur");
}
game.goBackTo(rolled.id);
await playMoves(game, engine, 5, 1);
game.switchBranch(original);
await playToTheEnd(game, engine);
games.push(["branches", game]);
}
// Le joueur double d'entrée ; l'ordinateur prend ou passe selon le moteur.
{
const game = Game.start(engine, { dice: seededDice(9), ply: 0 });
for (let i = 0; i < 400 && game.state.phase !== "over"; i++) {
await step(game, engine, { double: true });
}
games.push(["player-doubles", game]);
}
// Depuis une position particulière : l'ordinateur, au trait, double
// (position de référence « cube-double-take ») ; le joueur prend dans
// une branche, passe dans une autre.
{
const game = Game.start(engine, {
dice: seededDice(13),
ply: 0,
setup: { position: "6O5uAAC4uzsAAA", firstTurn: "computer" },
});
await step(game, engine);
const offered = game.events.at(-1)?.id as string;
await playMoves(game, engine, 6);
game.goBackTo(offered);
await step(game, engine, { take: false });
games.push(["setup-cube", game]);
}
// Depuis une position particulière, videau déjà doublé chez le joueur,
// qui a la main ; partie laissée en cours, dés lancés et pas joués.
{
const game = Game.start(engine, {
dice: seededDice(17),
ply: 0,
setup: {
position: "t+0OAADg/wcAQA",
firstTurn: "player",
cube: { value: 2, owner: "player" },
},
});
await playMoves(game, engine, 4);
await game.roll();
games.push(["setup-unfinished", game]);
}
let files = 0;
for (const [name, game] of games) {
const original = game.journal;
for (const [i, branch] of game.branches.entries()) {
game.switchBranch(branch.head);
const sgf = await exportSgf(engine, game.journal, {
playerName: "Vous",
computerName: "Ordinateur",
date: "2026-11-03",
});
// Après chaque coup, la position vue de celui qui a alors la main,
// et le résultat.
const expected = {
after: game.events.flatMap((e) => (e.type === "MovePlayed" ? [e.position] : [])),
result: game.state.result,
};
writeFileSync(join(out, `${name}-${i}.sgf`), sgf);
writeFileSync(join(out, `${name}-${i}.json`), `${JSON.stringify(expected)}\n`);
files++;
}
game.goBackTo(original.head as string);
}
console.log(`${files} parties exportées dans ${out}`);
}
await main();
+2 -34
View File
@@ -1,6 +1,6 @@
// Tests de ce qui, dans l'interface et le stockage, se vérifie sans
// navigateur : le plateau à dessiner, les mises en évidence, la lecture de
// l'aide, l'enregistrement de la partie.
// l'aide. Le stockage des parties a ses tests (storage.test.ts).
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
@@ -9,9 +9,7 @@ import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { test } from "node:test";
import type { BoardSide } from "../src/domain/game/engine.js";
import { appendEvent, EMPTY_JOURNAL } from "../src/domain/game/events.js";
import { parseHalfMoves, START_POSITION } from "../src/domain/game/position.js";
import { createGameStore } from "../src/storage/game-store.js";
import { parseHalfMoves } from "../src/domain/game/position.js";
import {
boardModel,
moveTargets,
@@ -176,36 +174,6 @@ test("l'aide lit chaque fiche de l'index du glossaire", () => {
assert.equal(parseGlossaryEntry("pas une fiche"), null);
});
test("la partie enregistrée se relit ; un enregistrement illisible est ignoré", () => {
const data = new Map<string, string>();
const storage = {
getItem: (key: string) => data.get(key) ?? null,
setItem: (key: string, value: string) => void data.set(key, value),
};
const store = createGameStore(storage);
assert.equal(store.load(), null);
const journal = appendEvent(EMPTY_JOURNAL, {
type: "GameStarted",
position: START_POSITION,
cube: { value: 1, owner: null },
firstTurn: null,
});
store.save(journal);
assert.deepEqual(store.load(), journal);
for (const key of data.keys()) {
data.set(key, "{pas du JSON");
}
assert.equal(store.load(), null);
// Un stockage plein ou interdit ne casse pas la partie.
const full = createGameStore({
getItem: () => null,
setItem: () => {
throw new Error("plein");
},
});
assert.doesNotThrow(() => full.save(journal));
});
test("les textes de fin de partie emploient les mots du glossaire", () => {
assert.equal(TEXTS.youWin("gammon", 2), "Vous gagnez un gammon : 2 points.");
assert.equal(