squad_state_list fails for root on adapter-backed backends: StateBackendStorageAdapter.toRelative() returns "." for squadDir
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 63/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Repo with
stateBackend: "two-layer"(ororphan/git-notes). - Run
squad state-mcp, callsquad_state_list {}. - 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
packages/squad-sdk/src/tools/index.tsnormalizeStateToolDir()correctly maps an omitted dir to"", then callsthis.storage.listSync(path.join(this.squadRoot, "")), i.e.listSync(squadRoot).packages/squad-sdk/src/state-backend.tsStateBackendStorageAdapter.toRelative()has:if (fileCmp === squadCmp) { return '.'; }- Every backend
list()runsnormalizeKey(relativeDir).normalizeKeyexplicitly allows""as root ("Empty string after normalization means root — valid for list() operations"), but"."is non-empty, sovalidateStateKey('.')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 especiallydeleteDir/deleteDirSync. Returning""there would turndeleteDir(squadDir)into a wipe of all state, andread("")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)andadapter.readSync(squadDir)still throw.
Downstream report: OlyForge3D/PrintFarmer#3372
- Dominant language
- TypeScript
- Stars
- 3.4k
- Forks
- 516
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 116
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/squad
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
ilan-pinto/roaring-lions#1552 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug: [React Native/Android] KeepAliveService never starts when CAMERA is not granted (Android 14+)Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cloudflare/realtimekit-ui#208 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
usebruno/bruno-vscode#235 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day