Regression: a game still ends through four separate code paths

Aperta
#173 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
backend, testing

Direzione di ricerca

Read the listed ending paths in js/game.js, the save inference in js/saved-game.js, and the related tests tests/unit/review-result.test.js and tests/unit/draws-promotion.test.js. Start by running npm test and tracing how each ending updates state, stops the clock, and starts scoring. Done means end-state fields are assigned in one function and the acceptance tests cover each listed ending and its expected state.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

help wanted severity: medium tech-debt

Summary

#140 moved the rule decision into gameOutcome, but the end state of a game is still written in four places, and they already behave differently. A related hidden coupling: updateStatusDisplay, which is a render call, also records the players and starts scoring the finished game. Every game ending therefore depends on a redraw happening.

Where

  • js/game.js:725-745 (endWith)
  • js/game.js:856-881 (endGameWithoutMove)
  • js/game.js:1686-1694 (importPGN sets the end-state fields inline)
  • js/game.js:799-802 (Undo reopens a game by hand)
  • js/game.js:637-638, js/game.js:835-836, js/game.js:1760 (each caller of playMove must remember endIfAutomaticDraw)
  • js/saved-game.js:114-122 (result inference for old saves)
  • js/game.js:1576-1584 (updateStatusDisplay calls recordPlayers() and scoreFinishedGame())

Details

importPGN writes the end state itself instead of using either helper:

if (ending) {
    isGameOver = true;
    gameResult = ending.result;
    endedWithoutMove = true;
    currentStatus = ending.status;
}

playMove itself decides only checkmate and stalemate. Each caller then has to call endIfAutomaticDraw for repetition, the fifty-move rule and insufficient material.

Impact

The paths already differ: an imported ending plays no sound, and its clock handling differs from endGameWithoutMove. Anything new that must happen when a game ends, such as #160's results record, has to be added to every path. A future caller of playMove that forgets endIfAutomaticDraw would let a game continue past threefold repetition. If a state change ever skips updateStatusDisplay, scoring and player recording are skipped without any error.

Suggested fix

  1. Add markEnded(result, status, { withoutMove }). Have endWith, endGameWithoutMove and importPGN all set the end state through it.
  2. Add playAndJudge(from, to, promo) (that is, playMove followed by endIfAutomaticDraw) and use it in makeMove and redoMove. Keep importPGN on plain playMove, with a comment explaining why.
  3. Call recordPlayers() and scoreFinishedGame() from these transition helpers, and remove them from updateStatusDisplay in a separate commit.
  4. Once old saves without a result can be dropped, remove the inference in saved-game.js.

Acceptance criteria

  • Before starting: one end-to-end test per ending (mate, stalemate, threefold via redo, fifty-move via redo, resignation, agreed draw, flag fall, PGN result tag). Each asserts gameResult, endedWithoutMove, the status text, that the clock timer stopped, and that scoring started.
  • The end-state fields are assigned in one function.

Getting started

  • Relevant files: js/game.js, js/saved-game.js, tests/unit/review-result.test.js, tests/unit/draws-promotion.test.js
  • How to run tests: npm test

Regression of #140.


Filed by repo-audit/full-audit at 01c6a35. Severity: medium. Effort: M. audit-key: tech-debt|js/game.js|endWith

Lingua principale
JavaScript
Stelle
4
Fork
2
Merge medio
22h 16m
PR unite (30g)
9

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Static_Chess

Tutte le issue di TMHSDigital/Static_Chess

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.