perf: Add O(1) lookup caching for ProjectNode document entries#1292
Closed
CybotTM wants to merge 1 commit intophpDocumentor:mainfrom
Closed
perf: Add O(1) lookup caching for ProjectNode document entries#1292CybotTM wants to merge 1 commit intophpDocumentor:mainfrom
CybotTM wants to merge 1 commit intophpDocumentor:mainfrom
Conversation
- Cache root document entry for O(1) getRootDocumentEntry() - Use direct hash lookup for getDocumentEntry() instead of iteration - Properly rekey array in setDocumentEntries() via addDocumentEntry() - Invalidate cache on reset() The functional test is updated to mark the document as root before compilation (using withIsRoot(true)) so the compiler creates the DocumentEntryNode correctly, rather than pre-creating an entry that gets overwritten by the compiler.
CybotTM
force-pushed
the
perf/project-node-cache
branch
from
093dfab to
4f2ede6
Compare
This was referenced Jan 22, 2026
Contributor
Author
|
Closing in favor of a cleaner PR with distinct commits for: (1) preparatory refactor, (2) performance improvement, (3) test adaptation. See new PR for combined changes. |
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
1 participant
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.
Summary
Adds O(1) caching for frequently called ProjectNode methods:
getRootDocumentEntry(): Caches root document entry on add, eliminating O(n) scangetDocumentEntry($file): Direct hash lookup by file path instead of iterationsetDocumentEntries(): Re-keys array properly viaaddDocumentEntry()to maintain invariantsChanges
ProjectNode.php
$rootDocumentEntrycache propertyaddDocumentEntry(): Caches root entry ifisRoot()is truegetRootDocumentEntry(): Returns cached root directly (O(1))getDocumentEntry(): Usesisset()for O(1) lookupsetDocumentEntries(): Delegates toaddDocumentEntry()to maintain cachereset(): Clears cacheFunctionalTest.php
withIsRoot(true)before compilationRationale
For a project with 500 documents,
getRootDocumentEntry()andgetDocumentEntry()were O(n) iterations called during rendering. Now they're O(1) lookups.Performance Impact
See Performance Analysis Report for detailed benchmarks.
Related PRs
All PRs can be merged independently in any order.