Progression des leçons dans le stockage des parties

Nouvelle clé « lessons » du magasin settings d'IndexedDB (et
ustagammon.lessons en repli), format versionné relu par
readLessonProgress. Amendement de l'ADR 0007.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Pierre MARTIN
2026-11-12 10:18:07 +01:00
co-authored by Claude Opus 5.5
parent 635612a2a8
commit e9ef965438
7 changed files with 299 additions and 9 deletions
+184
View File
@@ -0,0 +1,184 @@
// La progression dans les leçons (ADR 0011, étape 1g) : où en est chaque
// leçon, et laquelle proposer ensuite. Code pur, testé sous Node
// (app/tests/lessons.test.ts).
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
//
// Le contenu des leçons vit dans docs/lecons/ (ADR 0008) ; ici, une leçon
// n'est que son numéro et les étapes qui portent un exercice « à vous ».
// La progression est enregistrée telle quelle (ADR 0007, amendement du
// 2026-11-12) : son format est durable, et readLessonProgress relit toute
// version enregistrée.
/** Version du format de la progression enregistrée. */
export const LESSON_PROGRESS_VERSION = 1;
/** reached quand l'écran de fin d'une leçon a été vu. */
export const LESSON_END = 99;
/** Où en est une leçon. */
export interface LessonRecord {
/** La dernière étape vue (0 : aucune ; LESSON_END : la fin). */
readonly last: number;
/** L'étape la plus loin déjà vue : la barre de progression ne mène
* qu'aux étapes vues. */
readonly reached: number;
/** Les étapes dont l'exercice « à vous » a été réussi, dans l'ordre. */
readonly solved: readonly number[];
}
/** La progression dans toutes les leçons, par numéro de leçon. */
export interface LessonProgress {
readonly version: typeof LESSON_PROGRESS_VERSION;
readonly lessons: Readonly<Record<string, LessonRecord>>;
}
export const NO_PROGRESS: LessonProgress = { version: LESSON_PROGRESS_VERSION, lessons: {} };
const NO_RECORD: LessonRecord = { last: 0, reached: 0, solved: [] };
/** Ce qu'une leçon offre à la progression : son numéro et les étapes qui
* ont un exercice « à vous ». */
export interface LessonOutline {
readonly number: number;
readonly exercises: readonly number[];
}
function step(value: unknown): number | null {
return typeof value === "number" && Number.isInteger(value) && value >= 0 && value <= LESSON_END
? value
: null;
}
/**
* La progression enregistrée, relue : absente (avant l'étape 1g) ou
* illisible, elle est vide ; une leçon mal formée est oubliée, sans toucher
* aux autres. Une version inconnue (enregistrée par une version future de
* l'application) est lue comme vide plutôt que mal comprise.
*/
export function readLessonProgress(value: unknown): LessonProgress {
if (value === null || typeof value !== "object") {
return NO_PROGRESS;
}
const raw = value as { version?: unknown; lessons?: unknown };
if (raw.version !== LESSON_PROGRESS_VERSION) {
return NO_PROGRESS;
}
if (raw.lessons === null || typeof raw.lessons !== "object") {
return NO_PROGRESS;
}
const lessons: Record<string, LessonRecord> = {};
for (const [key, entry] of Object.entries(raw.lessons as Record<string, unknown>)) {
if (!/^[1-9][0-9]?$/.test(key) || entry === null || typeof entry !== "object") {
continue;
}
const record = entry as { last?: unknown; reached?: unknown; solved?: unknown };
const last = step(record.last);
const reached = step(record.reached);
const solved = Array.isArray(record.solved)
? record.solved.map(step).filter((s): s is number => s !== null && s > 0)
: null;
if (last === null || reached === null || solved === null) {
continue;
}
lessons[key] = { last, reached, solved: [...new Set(solved)].sort((a, b) => a - b) };
}
return { version: LESSON_PROGRESS_VERSION, lessons };
}
/** Où en est la leçon number (rien de fait si elle n'a jamais été ouverte). */
export function lessonRecord(progress: LessonProgress, number: number): LessonRecord {
return progress.lessons[String(number)] ?? NO_RECORD;
}
function withRecord(
progress: LessonProgress,
number: number,
change: (record: LessonRecord) => LessonRecord,
): LessonProgress {
return {
version: LESSON_PROGRESS_VERSION,
lessons: { ...progress.lessons, [String(number)]: change(lessonRecord(progress, number)) },
};
}
/** La progression après l'arrivée sur une étape d'une leçon (LESSON_END :
* sa fin). */
export function withVisit(progress: LessonProgress, number: number, at: number): LessonProgress {
return withRecord(progress, number, (record) => ({
...record,
last: at,
reached: Math.max(record.reached, at),
}));
}
/** La progression après la réussite de l'exercice d'une étape. */
export function withSolved(progress: LessonProgress, number: number, at: number): LessonProgress {
return withRecord(progress, number, (record) =>
record.solved.includes(at)
? record
: { ...record, solved: [...record.solved, at].sort((a, b) => a - b) },
);
}
/** L'état d'une leçon, tel que l'affichent la liste et l'accueil : à
* commencer, en cours (« 2 exercices sur 4 »), terminée (tous ses
* exercices réussis). */
export type LessonState =
| { readonly kind: "toStart"; readonly total: number }
| { readonly kind: "inProgress"; readonly solved: number; readonly total: number }
| { readonly kind: "done"; readonly total: number };
export function lessonState(progress: LessonProgress, outline: LessonOutline): LessonState {
const record = lessonRecord(progress, outline.number);
const total = outline.exercises.length;
const solved = outline.exercises.filter((s) => record.solved.includes(s)).length;
if (solved === total && (total > 0 || record.reached === LESSON_END)) {
return { kind: "done", total };
}
if (solved === 0 && record.reached === 0) {
return { kind: "toStart", total };
}
return { kind: "inProgress", solved, total };
}
/**
* La leçon à proposer ensuite (carte de l'accueil, « Continuer » de la
* liste) : la première en cours, sinon la première à commencer, sinon
* aucune (toutes terminées). L'ordre est conseillé, jamais imposé.
*/
export function nextLesson(
progress: LessonProgress,
outlines: readonly LessonOutline[],
): LessonOutline | null {
const states = outlines.map((outline) => ({ outline, state: lessonState(progress, outline) }));
return (
states.find((s) => s.state.kind === "inProgress")?.outline ??
states.find((s) => s.state.kind === "toStart")?.outline ??
null
);
}
/**
* L'étape où reprendre une leçon : là où on l'a quittée ; après sa fin, le
* premier exercice pas encore réussi ; sinon le début.
*/
export function resumeStep(progress: LessonProgress, outline: LessonOutline): number {
const record = lessonRecord(progress, outline.number);
if (record.last > 0 && record.last < LESSON_END) {
return record.last;
}
if (record.last === LESSON_END) {
return outline.exercises.find((s) => !record.solved.includes(s)) ?? 1;
}
return 1;
}
/** Le nombre de leçons terminées. */
export function finishedLessons(
progress: LessonProgress,
outlines: readonly LessonOutline[],
): number {
return outlines.filter((outline) => lessonState(progress, outline).kind === "done").length;
}
+4
View File
@@ -59,6 +59,10 @@ export interface LibraryBackend {
remove(id: string): Promise<void>;
currentId(): Promise<string | undefined>;
setCurrentId(id: string): Promise<void>;
/** La progression dans les leçons (étape 1g), telle qu'enregistrée
* (undefined : jamais enregistrée) ; relue par readLessonProgress. */
lessonProgress(): Promise<unknown>;
saveLessonProgress(progress: unknown): Promise<void>;
}
export interface LibraryOptions {
+11 -1
View File
@@ -6,7 +6,8 @@
// Base « ustagammon », trois magasins d'objets :
// - games : les résumés des parties (SavedGameSummary), clé id ;
// - journals : leurs journaux, { id, journal }, clé id ;
// - settings : { key, value }, dont la partie en cours (key « current »).
// - settings : { key, value }, dont la partie en cours (key « current ») et
// la progression dans les leçons (key « lessons », étape 1g).
// Le résumé et le journal d'une partie sont écrits dans la même transaction.
// L'API IndexedDB est utilisée directement, sans bibliothèque.
@@ -19,6 +20,9 @@ const VERSION = 1;
const GAMES = "games";
const JOURNALS = "journals";
const SETTINGS = "settings";
/** Clé de la progression dans les leçons, dans le magasin settings (étape
* 1g : nouvelle clé, même schéma, version 1 de la base). */
const LESSONS = "lessons";
/** Le résultat d'une requête IndexedDB, en promesse. */
function done<T>(request: IDBRequest<T>): Promise<T> {
@@ -77,5 +81,11 @@ export async function openIndexedDbBackend(factory: IDBFactory): Promise<Library
transaction.objectStore(SETTINGS).put({ key: "current", value: id });
await committed(transaction);
},
lessonProgress: async () => (await get<{ value: unknown }>(SETTINGS, LESSONS))?.value,
saveLessonProgress: async (progress) => {
const transaction = db.transaction(SETTINGS, "readwrite");
transaction.objectStore(SETTINGS).put({ key: LESSONS, value: progress });
await committed(transaction);
},
};
}
+4
View File
@@ -19,6 +19,8 @@ export interface KeyValueStorage {
const SUMMARIES = "ustagammon.games";
const CURRENT = "ustagammon.current-game-id";
const journalKey = (id: string) => `ustagammon.game.${id}`;
/** La progression dans les leçons (étape 1g). */
const LESSONS = "ustagammon.lessons";
/** La partie unique des versions précédentes (étape 0), à migrer. */
const LEGACY_GAME = "ustagammon.current-game";
@@ -60,6 +62,8 @@ export function createKeyValueBackend(storage: KeyValueStorage): LibraryBackend
return typeof id === "string" ? id : undefined;
},
setCurrentId: async (id) => storage.setItem(CURRENT, JSON.stringify(id)),
lessonProgress: async () => read(storage, LESSONS),
saveLessonProgress: async (progress) => storage.setItem(LESSONS, JSON.stringify(progress)),
};
}
+48
View File
@@ -0,0 +1,48 @@
// La progression dans les leçons (étape 1g), dans le stockage des parties
// (IndexedDB, ou localStorage en repli) : une seule valeur, relue par le
// domaine (readLessonProgress), qui en connaît le format.
//
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
import { type LessonProgress, readLessonProgress } from "../domain/learning/lessons.js";
import type { LibraryBackend } from "./game-library.js";
export interface LessonStore {
/** La progression enregistrée (vide si rien n'est enregistré ou si le
* stockage est illisible). */
load(): Promise<LessonProgress>;
/** Enregistre la progression ; les enregistrements se font dans l'ordre
* des appels. Un stockage refusé ne fait pas échouer l'appel. */
save(progress: LessonProgress): Promise<void>;
}
export function createLessonStore(
backend: Pick<LibraryBackend, "lessonProgress" | "saveLessonProgress">,
): LessonStore {
let queue: Promise<unknown> = Promise.resolve();
const inTurn = <T>(task: () => Promise<T>): Promise<T> => {
const run = queue.then(task, task);
queue = run.catch(() => undefined);
return run;
};
return {
load: () =>
inTurn(async () => {
try {
return readLessonProgress(await backend.lessonProgress());
} catch {
return readLessonProgress(undefined);
}
}),
save: (progress) =>
inTurn(async () => {
try {
await backend.saveLessonProgress(progress);
} catch {
// Stockage plein ou refusé : la progression reste en
// mémoire pour cette visite.
}
}),
};
}
+23 -8
View File
@@ -4,13 +4,19 @@
// Copyright (C) 2026 les auteurs d'Ustagammon.
// Licence : GPLv3 ou ultérieure (voir LICENSE).
import { createGameLibrary, type GameLibrary, type LibraryOptions } from "./game-library.js";
import {
createGameLibrary,
type GameLibrary,
type LibraryBackend,
type LibraryOptions,
} from "./game-library.js";
import { openIndexedDbBackend } from "./indexeddb-backend.js";
import {
createKeyValueBackend,
type KeyValueStorage,
migrateLegacyGame,
} from "./key-value-backend.js";
import { createLessonStore, type LessonStore } from "./lesson-store.js";
/** Les stockages du navigateur ; chacun peut manquer ou être refusé. */
export interface BrowserStorage {
@@ -23,6 +29,8 @@ export interface OpenedLibrary {
/** Le stockage retenu : IndexedDB, son repli localStorage, ou la seule
* mémoire de la page (rien n'est gardé après sa fermeture). */
readonly kind: "indexeddb" | "localStorage" | "memory";
/** La progression dans les leçons, dans le même stockage. */
readonly lessons: LessonStore;
}
/** Au-delà, IndexedDB est tenu pour indisponible (une ouverture bloquée ne
@@ -55,7 +63,7 @@ async function open(storage: BrowserStorage, options: LibraryOptions): Promise<O
timer = setTimeout(() => reject(new Error("IndexedDB muet")), OPEN_TIMEOUT_MS);
}),
]);
return { library: createGameLibrary(backend, options), kind: "indexeddb" };
return opened(backend, options, "indexeddb");
} catch {
// Indisponible (navigation privée de certains navigateurs) : repli.
} finally {
@@ -63,14 +71,21 @@ async function open(storage: BrowserStorage, options: LibraryOptions): Promise<O
}
}
if (storage.localStorage !== undefined && usable(storage.localStorage)) {
return {
library: createGameLibrary(createKeyValueBackend(storage.localStorage), options),
kind: "localStorage",
};
return opened(createKeyValueBackend(storage.localStorage), options, "localStorage");
}
return opened(createKeyValueBackend(memoryStorage()), options, "memory");
}
/** Les parties et la progression dans les leçons, sur le même stockage. */
function opened(
backend: LibraryBackend,
options: LibraryOptions,
kind: OpenedLibrary["kind"],
): OpenedLibrary {
return {
library: createGameLibrary(createKeyValueBackend(memoryStorage()), options),
kind: "memory",
library: createGameLibrary(backend, options),
kind,
lessons: createLessonStore(backend),
};
}
@@ -202,3 +202,28 @@ le panneau d'analyse de gnubg de bureau.
à la reprise et recalculé en arrière-plan ; les analyses de l'ordinateur
(`review.computer`), du même format, aussi.
- Ni les événements (version 2) ni le schéma IndexedDB ne changent.
### 2026-11-12 — La progression dans les leçons
Avec les leçons (étape 1g), la progression rejoint les formats durables. Elle
est rangée dans le stockage des parties (étape 1b), à côté de la partie en
cours :
- IndexedDB : une nouvelle clé `lessons` dans le magasin `settings`
existant. Le schéma ne change pas (base « ustagammon », version 1, mêmes
magasins) : aucune montée de version n'est nécessaire, et une base
enregistrée avant l'étape 1g se lit telle quelle, sans progression.
- Repli localStorage (et mémoire) : la clé `ustagammon.lessons`.
- La valeur, en JSON, porte sa version (`LESSON_PROGRESS_VERSION`, 1) et,
par numéro de leçon, la dernière étape vue (`last`), la plus lointaine
(`reached`, 99 pour la fin) et les étapes dont l'exercice est réussi
(`solved`) (`app/src/domain/learning/lessons.ts`).
- `readLessonProgress` relit toute valeur enregistrée : absente ou
illisible, la progression est vide ; une leçon mal formée est oubliée sans
toucher aux autres ; une version inconnue est lue comme vide plutôt que
mal comprise. Toute évolution du format passera par une nouvelle version
et sa migration dans cette fonction, testées dans
`app/tests/lessons.test.ts` comme ici.
- Une leçon est terminée quand tous ses exercices sont réussis ; ce n'est
pas enregistré à part, mais déduit des exercices réussis et du texte de la
leçon : ajouter un exercice à une leçon la fait repasser « en cours ».