Regression: a game still ends through four separate code paths

未关闭
#173 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
活跃
技术栈
javascript
领域
backend, testing

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
JavaScript
星标
4
派生
2
平均合并
22 小时 16 分钟
30 天内合并 PR
9

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/Static_Chess 的其他 Issue

查看 TMHSDigital/Static_Chess 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。