squad_state_list fails for root on adapter-backed backends: StateBackendStorageAdapter.toRelative() returns "." for squadDir

未關閉
#2,231 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
63/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
typescript
領域
backend, cli

研究方向

Start in packages/squad-sdk/src/state-backend.ts and inspect StateBackendStorageAdapter.toRelative() alongside its list and directory methods. Then read packages/squad-sdk/src/tools/index.ts for normalizeStateToolDir() and the existing key validation. Add regression coverage for root listing while preserving traversal and file-operation rejection; done means the listed root entries are returned and the specified invalid paths still fail.

由索引模型根據 Issue 內容生成。

描述

wave:1-next wave1:P1

Summary

squad_state_list with dir omitted (or "", or ".squad") fails on any backend routed through StateBackendStorageAdapter (observed with stateBackend: "two-layer"):

Failed to list state: State key must not contain . or .. path segments

squad_state_list {dir: "decisions"} works.

Environment

  • squad CLI v1.0.1 (WinGet bradygaster.Squad), Windows
  • .squad/config.json → stateBackend: "two-layer"; squad_state_health → State backend storage: StateBackendStorageAdapter
  • Source references below are from main @ 89d6302576ce03b87fe0519235854c9e8638737f (bug still present)

Minimal repro

  1. Repo with stateBackend: "two-layer" (or orphan / git-notes).
  2. Run squad state-mcp, call squad_state_list {}.
  3. Observe the error above.

Unit-level repro:

const adapter = new StateBackendStorageAdapter(new OrphanBranchBackend(repo), squadDir);
adapter.listSync(squadDir); // throws: State key must not contain . or .. path segments

Root cause

  1. packages/squad-sdk/src/tools/index.ts normalizeStateToolDir() correctly maps an omitted dir to "", then calls this.storage.listSync(path.join(this.squadRoot, "")), i.e. listSync(squadRoot).
  2. packages/squad-sdk/src/state-backend.ts StateBackendStorageAdapter.toRelative() has:
    if (fileCmp === squadCmp) {
      return '.';
    }
    
  3. Every backend list() runs normalizeKey(relativeDir). normalizeKey explicitly allows "" as root ("Empty string after normalization means root — valid for list() operations"), but "." is non-empty, so validateStateKey('.') throws.

The adapter emits a root sentinel the backends do not accept.

Suggested fix (keeps traversal rejection)

Do not relax validateStateKey. Map squadDir to "" only for list-shaped reads:

  • list / listSync / isDirectory / isDirectorySync: when the path resolves to squadDir, pass "".
  • Keep "." (and therefore rejection) for file operations and especially deleteDir/deleteDirSync. Returning "" there would turn deleteDir(squadDir) into a wipe of all state, and read("") on git backends could resolve to a tree object.

For example, add private toRelativeDir(p) { const r = this.toRelative(p); return r === '.' ? '' : r; } and use it in the four list methods.

Regression tests

  • adapter.listSync(squadDir) returns root entries for the orphan, git-notes, and two-layer backends.
  • squad_state_list {} and {dir: ""} succeed.
  • {dir: ".."}, {dir: "a/../b"}, and {dir: "."} still fail with the . or .. error.
  • adapter.deleteDirSync(squadDir) and adapter.readSync(squadDir) still throw.

Downstream report: OlyForge3D/PrintFarmer#3372

主要語言
TypeScript
星號
3.4k
分支
516
平均合併
1 天 15 小時
30 天內合併 PR
116

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

github/squad 的其他 Issue

查看 github/squad 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。