perf(scanner): chunk file discovery and cache I/O across rules#11
Merged
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changed
src/scanner/index.ts: Introduced a chunk-based processing model wherecontext.filesare sliced into chunks of 100 files at a time.src/types.ts: Added an optionalgetFileContentasync method toScanContext.src/rules/opk-001,opk-002,opk-003: Refactored to consumegetFileContentinstead of callingfs.readFileSyncindependently.Why
Previously, the scanner looped through rules on the outer layer, meaning that if a repository had 10,000 files, and 5 different rules needed to read the file contents to perform AST/Regex checks, the scanner would read each file 5 times from disk, triggering
fs.readFileSync50,000 times!By introducing a shared cache per file chunk, we eliminate redundant disk I/O. The chunk size (100) ensures that we don't hold the entire repository in memory, preventing Out of Memory (OOM) exceptions.
Architecture
Ruleinterface remains perfectly backwards compatible. Existing rules that don't usegetFileContentwill just continue to run perfectly fine.getFileContentexists; if it does, they use it.Testing
Risks
Negligible. We handle read rejections inside the cache and yield
undefinedseamlessly so that rules skip inaccessible files without crashing the whole process.Follow-up
Next step: Add more comprehensive test fixtures to fully close out v0.3.0.