-
Notifications
You must be signed in to change notification settings - Fork 28
fix(rag): skip hidden and junk directories when indexing #5633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+203
−4
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| """Shared directory-walk pruning for personal-document indexing (#5559). | ||
|
|
||
| Single source of the hidden-dir / junk-dir / hidden-file skip so the vector | ||
| index (``rag_vector.index_personal_documents``) and the keyword index | ||
| (``personal_docs.load_personal_index``) apply the exact same policy and cannot | ||
| drift — the drift is what left the keyword path sweeping in `.obsidian/`, | ||
| `.git/`, and `node_modules/` after the vector path was fixed. | ||
| """ | ||
| from typing import List, Set | ||
|
|
||
| # Well-known non-hidden junk directories to skip. Matched case-insensitively so | ||
| # a `Node_Modules` on a case-insensitive filesystem (macOS default) is still | ||
| # pruned. Hidden directories (dot-prefixed) are pruned separately. Kept | ||
| # deliberately small: over-pruning would silently drop a user's real content | ||
| # (e.g. a notes directory legitimately named "build"). | ||
| EXCLUDED_DIR_NAMES: Set[str] = {'node_modules', '__pycache__', 'venv'} | ||
|
|
||
|
|
||
| def prune_index_dirs(dirs: List[str]) -> None: | ||
| """In-place ``os.walk`` (topdown) directory prune: drop hidden and known | ||
| junk directories so the walk never descends into them. | ||
|
|
||
| The explicitly-targeted walk root is never a member of ``dirs`` (it is the | ||
| ``dirpath`` argument), so it stays exempt — a user who deliberately points | ||
| indexing at a hidden directory gets its contents, minus nested junk. | ||
| """ | ||
| dirs[:] = [ | ||
| d for d in dirs | ||
| if not d.startswith('.') and d.lower() not in EXCLUDED_DIR_NAMES | ||
| ] | ||
|
|
||
|
|
||
| def is_indexable_file(name: str) -> bool: | ||
| """A file is indexable only if it is not hidden (dot-prefixed).""" | ||
| return not name.startswith('.') |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| """Regression guard for #5559 — the KEYWORD index (load_personal_index, which | ||
| PersonalDocsManager.refresh_index builds from) must skip hidden dirs, hidden | ||
| files, and junk dirs at ANY depth, the same as the vector index. Both walkers | ||
| share one pruning helper (src/index_walk) so they cannot drift again. | ||
| """ | ||
| import os | ||
|
|
||
| os.environ.setdefault("DATABASE_URL", "sqlite:///:memory:") | ||
|
|
||
| from src.personal_docs import load_personal_index | ||
|
|
||
|
|
||
| def _write(path, content="real content"): | ||
| path.parent.mkdir(parents=True, exist_ok=True) | ||
| path.write_text(content, encoding="utf-8") | ||
|
|
||
|
|
||
| def _indexed(root): | ||
| return {rec["name"] for rec in load_personal_index(str(root))} | ||
|
|
||
|
|
||
| def test_keyword_index_skips_hidden_and_junk_dirs(tmp_path): | ||
| _write(tmp_path / "note.md") | ||
| _write(tmp_path / "sub" / "deeper.md") | ||
| _write(tmp_path / ".obsidian" / "workspace.json") | ||
| _write(tmp_path / ".git" / "hooks.md") | ||
| _write(tmp_path / "node_modules" / "lib" / "readme.md") | ||
| _write(tmp_path / "__pycache__" / "cached.txt") | ||
| _write(tmp_path / "venv" / "lib" / "site.txt") | ||
| assert _indexed(tmp_path) == {"note.md", os.path.join("sub", "deeper.md")} | ||
|
|
||
|
|
||
| def test_keyword_index_skips_hidden_files(tmp_path): | ||
| _write(tmp_path / "visible.md") | ||
| _write(tmp_path / ".hidden.md") | ||
| _write(tmp_path / "sub" / ".secret.txt") | ||
| assert _indexed(tmp_path) == {"visible.md"} | ||
|
|
||
|
|
||
| def test_keyword_index_prunes_junk_at_depth(tmp_path): | ||
| """Pruning must apply at every level, not just the first (the vector test's | ||
| fixtures only nested one level under the root).""" | ||
| _write(tmp_path / "a" / "b" / "keep.md") | ||
| _write(tmp_path / "a" / "b" / "node_modules" / "dep.md") | ||
| _write(tmp_path / "a" / ".obsidian" / "deep.json") | ||
| assert _indexed(tmp_path) == {os.path.join("a", "b", "keep.md")} | ||
|
|
||
|
|
||
| def test_keyword_index_junk_match_is_case_insensitive(tmp_path): | ||
| """A case-variant junk dir must still be pruned (macOS default FS is | ||
| case-insensitive, so `Node_Modules` and `node_modules` are the same dir).""" | ||
| _write(tmp_path / "keep.md") | ||
| _write(tmp_path / "Node_Modules" / "dep.md") | ||
| assert _indexed(tmp_path) == {"keep.md"} | ||
|
|
||
|
|
||
| def test_keyword_index_explicit_hidden_root_still_indexed(tmp_path): | ||
| """Children-only pruning: pointing indexing at a hidden dir gets its | ||
| contents, minus nested hidden/junk.""" | ||
| root = tmp_path / ".notes" | ||
| _write(root / "idea.md") | ||
| _write(root / ".obsidian" / "plugin.json") | ||
| assert {rec["name"] for rec in load_personal_index(str(root))} == {"idea.md"} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| """Regression guard for #5559 — directory indexing must skip hidden directories, | ||
| hidden files, and well-known junk directories. | ||
|
|
||
| VectorRAG.index_personal_documents walked the whole tree with no pruning, so | ||
| pointing RAG at a real-world folder (an Obsidian vault, a git repo) swept in | ||
| `.obsidian/` plugin JavaScript, `.git/` internals, `node_modules/`, etc. The | ||
| junk multiplied indexing time and polluted retrieval. | ||
|
|
||
| These tests are hermetic — no chromadb; VectorRAG is created via __new__ (skip | ||
| Chroma connect) with add_document stubbed to record which files get indexed. | ||
| """ | ||
| import os | ||
|
|
||
| os.environ.setdefault("DATABASE_URL", "sqlite:///:memory:") | ||
|
|
||
| import src.rag_vector as rag_vector | ||
|
|
||
|
|
||
| def _make_rag(recorded_sources): | ||
| rag = rag_vector.VectorRAG.__new__(rag_vector.VectorRAG) # skip Chroma connect | ||
|
|
||
| def _record(text, metadata): | ||
| recorded_sources.add(metadata["source"]) | ||
| return True | ||
|
|
||
| rag.add_document = _record | ||
| return rag | ||
|
|
||
|
|
||
| def _write(path, content="some real content"): | ||
| path.parent.mkdir(parents=True, exist_ok=True) | ||
| path.write_text(content, encoding="utf-8") | ||
|
|
||
|
|
||
| def test_index_skips_hidden_and_junk_directories(tmp_path): | ||
| _write(tmp_path / "note.md") | ||
| _write(tmp_path / "sub" / "deeper.md") | ||
| _write(tmp_path / ".obsidian" / "plugins" / "plugin.js") | ||
| _write(tmp_path / ".git" / "hooks.js") | ||
| _write(tmp_path / "node_modules" / "lib" / "index.js") | ||
| _write(tmp_path / "__pycache__" / "cached.py") | ||
| _write(tmp_path / "venv" / "lib" / "site.py") | ||
|
|
||
| recorded = set() | ||
| rag = _make_rag(recorded) | ||
| result = rag.index_personal_documents(str(tmp_path)) | ||
|
|
||
| assert result["success"] is True | ||
| indexed = {os.path.relpath(p, str(tmp_path)) for p in recorded} | ||
| assert indexed == {"note.md", os.path.join("sub", "deeper.md")} | ||
|
|
||
|
|
||
| def test_index_skips_hidden_files(tmp_path): | ||
| _write(tmp_path / "visible.md") | ||
| _write(tmp_path / ".hidden.md") | ||
| _write(tmp_path / "sub" / ".secret.txt") | ||
|
|
||
| recorded = set() | ||
| rag = _make_rag(recorded) | ||
| rag.index_personal_documents(str(tmp_path)) | ||
|
|
||
| indexed = {os.path.relpath(p, str(tmp_path)) for p in recorded} | ||
| assert indexed == {"visible.md"} | ||
|
|
||
|
|
||
| def test_explicitly_passed_hidden_root_is_still_indexed(tmp_path): | ||
| """Pruning applies to children only — a user who deliberately points RAG at | ||
| a hidden directory gets its contents, minus nested hidden/junk dirs.""" | ||
| root = tmp_path / ".notes" | ||
| _write(root / "idea.md") | ||
| _write(root / ".obsidian" / "plugin.js") | ||
|
|
||
| recorded = set() | ||
| rag = _make_rag(recorded) | ||
| rag.index_personal_documents(str(root)) | ||
|
|
||
| indexed = {os.path.relpath(p, str(root)) for p in recorded} | ||
| assert indexed == {"idea.md"} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.