[bug/rfe] Rebuild or mark repos stale when zoekt shard files are missing but DB marks repos indexed
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 58/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- typescript
Direzione di ricerca
Start in packages/backend/src/repoIndexManager.ts with scheduleIndexJobs() and cleanupOrphanedDiskResources(), then inspect startup directory handling in packages/backend/src/index.ts and shard creation in packages/backend/src/zoekt.ts. Reproduce by deleting the shard files and restarting with a long reindex interval; done means missing shards trigger recovery and search returns the repository contents again.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
If the zoekt index directory is deleted while the Sourcebot database and repo clones remain intact, Sourcebot starts successfully but does not automatically rebuild the missing shards. Repos remain marked as indexed in the DB, while zoekt has no shard files to search, so search returns incomplete or empty results from an otherwise healthy instance.
This matters for Kubernetes deployments that want to place only .sourcebot/index on more performant ephemeral/local storage while keeping DB/repos on durable storage.
Version
Observed on:
- Sourcebot image:
ghcr.io/sourcebot-dev/sourcebot:v4.17.1
Background / Use Case
For performance reasons, we are evaluating a hybrid storage layout:
- durable PVC for
/data - node-local / ephemeral storage for
/data/.sourcebot/index
The zoekt index is derived/rebuildable, while the DB and repo clones should remain durable. This can improve cold/random read performance for large zoekt indexes, but pod replacement would delete only the index directory.
In that scenario, Sourcebot should ideally detect that indexed repos no longer have shard files and enqueue rebuilds, or otherwise mark those repos as not indexed.
Current Behavior
When /data/.sourcebot/index is empty but the DB still has repos with fresh indexedAt values:
- Sourcebot starts normally.
- zoekt tolerates the empty index directory.
- The repo remains marked as indexed/completed in the DB.
- No new indexing job is scheduled.
- Search returns zero/incomplete results.
- Manual reindex through
/api/index-reposuccessfully rebuilds the missing shard.
Expected Behavior
On startup, or during repo-index scheduling, Sourcebot should detect repos that are marked indexed in the DB but have no corresponding zoekt shard files.
Possible expected behaviors:
- enqueue index jobs for affected repos,
- set
indexedAt = nullfor affected repos so the existing scheduler picks them up, - or expose a supported startup/recovery command that rebuilds all missing index shards.
Relevant Code Paths
From a quick read of the code:
-
packages/backend/src/constants.tsREPOS_CACHE_DIR = DATA_CACHE_DIR/reposINDEX_CACHE_DIR = DATA_CACHE_DIR/index
-
packages/backend/src/index.ts- creates the repos and index directories at startup if absent
-
packages/backend/src/repoIndexManager.tsscheduleIndexJobs()selects repos whereindexedAtisnullor older thanreindexIntervalMscleanupOrphanedDiskResources()removes shard files with no corresponding DB repo, but does not detect the inverse: DB repo exists and is marked indexed, but shard files are missing
-
packages/backend/src/zoekt.tsindexGitRepository()invokeszoekt-git-index -index ${INDEX_CACHE_DIR}
Suggested Fix
Add startup or scheduler reconciliation that compares DB repo state with shard files in INDEX_CACHE_DIR.
For each repo with indexedAt != null, verify that at least one shard exists with that repo's shard prefix. If no shard exists, either:
- enqueue an index job for that repo, or
- mark the repo as stale by clearing
indexedAt, allowing the existing scheduler to enqueue it.
This would make derived/ephemeral index storage safe to use with durable DB/repos.
To reproduce
Reproduction
Use a small Sourcebot instance with a local file:// repo.
Example config:
{
"connections": {
"local-repos": {
"type": "git",
"url": "file:///data/local-repos/*"
}
},
"settings": {
"reindexIntervalMs": 86400000,
"reindexRepoPollingIntervalMs": 1000,
"maxRepoIndexingJobConcurrency": 1
}
}
The long reindexIntervalMs is intentional so we can distinguish immediate missing-shard recovery from the normal periodic reindex.
Steps:
- Create a local git repo under
/data/local-repos/testrepo. - Start Sourcebot.
- Wait for the repo to index successfully.
- Confirm:
- a shard exists under
/data/.sourcebot/index - the repo has
indexedAtset - search returns a result from the repo
- a shard exists under
- Delete only the zoekt shard files:
rm -f /data/.sourcebot/index/*.zoekt \
/data/.sourcebot/index/*.zoekt.meta \
/data/.sourcebot/index/*.tmp
- Restart Sourcebot with the same DB and repo data.
- Observe that no new index job is created and search returns no results.
Manual recovery works:
curl -s -X POST http://localhost:3060/api/index-repo \
-H "Content-Type: application/json" \
-d '{"repoId":1}'
After this, the shard is rebuilt and search works again.
Sourcebot deployment information
ghcr.io/sourcebot-dev/sourcebot:v4.17.1
Additional information
No response
- Lingua principale
- TypeScript
- Stelle
- 3.9k
- Fork
- 374
- Merge medio
- 21h 18m
- PR unite (30g)
- 39
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di sourcebot-dev/sourcebot
-
bug triage needed
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
sourcebot-dev/sourcebot#1681 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
sourcebot-dev/sourcebot#1633 ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
sourcebot-dev/sourcebot#1384 · 4 commenti ·
-
ask_sb bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
sourcebot-dev/sourcebot#1137 · 4 commenti ·
-
bug triage needed
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
sourcebot-dev/sourcebot#1661 · 1 commento ·
Tutte le issue di sourcebot-dev/sourcebot
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
fil-donadoni/tolaria#4409 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
corsairdev/corsair#1764 ·