Skip to content

perf: Add O(1) lookup caching for ProjectNode document entries #1292

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.

Sign up for GitHub

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

Closed
CybotTM wants to merge 1 commit into from
+22 −15
Closed

perf: Add O(1) lookup caching for ProjectNode document entries #1292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions packages/guides/src/Nodes/ProjectNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ final class ProjectNode extends CompoundNode
/** @var array<string, array<string, InternalTarget>> */
private array $internalLinkTargets = [];

/** @var DocumentEntryNode[] */
/** Cached root document entry for O(1) lookup */
private DocumentEntryNode|null $rootDocumentEntry = null;

/** @var array<string, DocumentEntryNode> */
private array $documentEntries = [];
private DateTimeImmutable $lastRendered;

Expand Down Expand Up @@ -182,6 +185,11 @@ public function getAllInternalTargets(): array

public function addDocumentEntry(DocumentEntryNode $documentEntry): void
{
// Cache root for O(1) lookup
if ($documentEntry->isRoot()) {
$this->rootDocumentEntry = $documentEntry;
}

$this->documentEntries[$documentEntry->getFile()] = $documentEntry;
}

Expand All @@ -193,10 +201,8 @@ public function getAllDocumentEntries(): array

public function getRootDocumentEntry(): DocumentEntryNode
{
foreach ($this->documentEntries as $documentEntry) {
if ($documentEntry->isRoot()) {
return $documentEntry;
}
if ($this->rootDocumentEntry !== null) {
return $this->rootDocumentEntry;
}

throw new Exception('No root document entry was found');
Expand All @@ -205,10 +211,9 @@ public function getRootDocumentEntry(): DocumentEntryNode
/** @throws DocumentEntryNotFound */
public function getDocumentEntry(string $file): DocumentEntryNode
{
foreach ($this->documentEntries as $documentEntry) {
if ($documentEntry->getFile() === $file) {
return $documentEntry;
}
// O(1) lookup by file path
if (isset($this->documentEntries[$file])) {
return $this->documentEntries[$file];
}

throw new DocumentEntryNotFound('No document Entry found for file ' . $file);
Expand All @@ -217,7 +222,12 @@ public function getDocumentEntry(string $file): DocumentEntryNode
/** @param DocumentEntryNode[] $documentEntries */
public function setDocumentEntries(array $documentEntries): void
{
$this->documentEntries = $documentEntries;
$this->documentEntries = [];
$this->rootDocumentEntry = null;

foreach ($documentEntries as $entry) {
$this->addDocumentEntry($entry);
}
}

public function findDocumentEntry(string $filePath): DocumentEntryNode|null
Expand All @@ -228,6 +238,7 @@ public function findDocumentEntry(string $filePath): DocumentEntryNode|null
public function reset(): void
{
$this->documentEntries = [];
$this->rootDocumentEntry = null;
}

public function getLastRendered(): DateTimeImmutable
Expand Down
6 changes: 1 addition & 5 deletions tests/Functional/FunctionalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@
use phpDocumentor\Guides\Compiler\Compiler;
use phpDocumentor\Guides\Compiler\CompilerContext;
use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
use phpDocumentor\Guides\Nodes\Node;
use phpDocumentor\Guides\Nodes\ProjectNode;
use phpDocumentor\Guides\Nodes\TitleNode;
use phpDocumentor\Guides\Parser;
use phpDocumentor\Guides\RenderContext;
use phpDocumentor\Guides\Settings\ProjectSettings;
Expand Down Expand Up @@ -110,13 +108,11 @@ public function testFunctional(

$parser = $this->getContainer()->get(Parser::class);
assert($parser instanceof Parser);
$document = $parser->parse($rst);
$documentEntry = new DocumentEntryNode($document->getFilePath(), $document->getTitle() ?? TitleNode::fromString(''), true);
$document = $parser->parse($rst)->withIsRoot(true);

$compiler = $this->getContainer()->get(Compiler::class);
assert($compiler instanceof Compiler);
$projectNode = new ProjectNode();
$projectNode->setDocumentEntries([$documentEntry]);
$compiler->run([$document], new CompilerContext($projectNode));

$inputFilesystem = FlySystemAdapter::createFromFileSystem(new Filesystem(new InMemoryFilesystemAdapter()));
Expand Down