Skip to content

perf: Store analysis cache metadata as a compact fingerprint #415

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
samsonasik wants to merge 1 commit into from
Closed

perf: Store analysis cache metadata as a compact fingerprint #415

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
18 changes: 6 additions & 12 deletions src/Cache/AnalysisResultCache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ final class AnalysisResultCache
* their shape or naming changes: it is recorded in the metadata marker,
* so a cache written by an older format is cleared on its next use.
*/
public const FORMAT_VERSION = 8;
public const FORMAT_VERSION = 9;

private readonly string $cacheDirectory;

Expand Down Expand Up @@ -325,7 +325,7 @@ private function analysisNodePayload(string $file, string $namespace): ?array
{
$payload = $this->read($this->analysisNodesKey($file, $namespace));

if ($payload === null || ($payload['metadata'] ?? null) !== $this->fileMetadata($file, $namespace)) {
if ($payload === null || ($payload['metadata'] ?? null) !== $this->fileMetadataHash($file, $namespace)) {
return null;
}

Expand Down Expand Up @@ -437,7 +437,7 @@ public function storeAnalysisNodes(
$this->ensureCacheInitialised();

$payload = [
'metadata' => $this->fileMetadata($file, $namespace),
'metadata' => $this->fileMetadataHash($file, $namespace),
'nodes' => array_map($this->classNodeToArray(...), $classNodes),
];

Expand Down Expand Up @@ -1493,15 +1493,9 @@ private function analysisNodesKey(string $file, string $namespace): string
return 'analysis-nodes-' . hash('xxh128', $namespace . "\0" . $file);
}

/**
* @return array<string, mixed>
*/
private function fileMetadata(string $file, string $namespace): array
/** The metadata is only compared for equality; store one hash instead of repeating the file and namespace. */
private function fileMetadataHash(string $file, string $namespace): string
{
return [
'namespace' => $namespace,
'file' => $file,
'hash' => $this->fileHashProvider->hash($file),
];
return hash('xxh128', $namespace . "\0" . $file . "\0" . $this->fileHashProvider->hash($file));
}
}
119 changes: 108 additions & 11 deletions tests/Cache/AnalysisResultCacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1357,12 +1357,13 @@ public function testClassNodesLoadOldCachePayloadWithoutInterfaceExtends(): void
file_put_contents($sourceFile, '<?php class Foo {}');

try {
$analysisResultCache->storeAnalysisNodes($sourceFile, 'config', []);
$cacheFile = $this->firstJsonFile($cacheDirectory);
$payload = json_decode((string) file_get_contents($cacheFile), true, 512, JSON_THROW_ON_ERROR);
$this->assertIsArray($payload);

$this->writeCachePayload($cacheDirectory, [
'metadata' => [
'namespace' => 'config',
'file' => $sourceFile,
'hash' => hash('xxh128', (string) file_get_contents($sourceFile)),
],
'metadata' => $payload['metadata'],
'nodes' => [
[
'className' => Foo::class,
Expand All @@ -1388,7 +1389,7 @@ public function testClassNodesLoadOldCachePayloadWithoutInterfaceExtends(): void
'layers' => [],
],
],
], 'analysis-nodes-' . hash('xxh128', "config\0" . $sourceFile) . '.json');
], $cacheFile);

$loaded = $analysisResultCache->loadAnalysisNodes($sourceFile, 'config')['classNodes'] ?? null;

Expand Down Expand Up @@ -1877,6 +1878,104 @@ public function testClassNodesMissWhenFileMetadataChanges(): void
}
}

/** @return iterable<string, array{string, string}> */
public static function differentAnalysisIdentityProvider(): iterable
{
yield 'same contents at another path' => ['Bar.php', 'config'];
yield 'same file in another namespace' => ['Foo.php', 'other-config'];
}

#[DataProvider('differentAnalysisIdentityProvider')]
public function testAnalysisNodesRejectPayloadFromDifferentIdentity(string $filename, string $namespace): void
{
$cacheDirectory = $this->createTempDirectory();
$sourceFile = $cacheDirectory . '/Foo.php';
$otherFile = $cacheDirectory . '/' . $filename;
$analysisResultCache = new AnalysisResultCache(__DIR__, new FileHashProvider(), $cacheDirectory);

file_put_contents($sourceFile, '<?php class Foo {}');
file_put_contents($otherFile, '<?php class Foo {}');

try {
$analysisResultCache->storeAnalysisNodes($sourceFile, 'config', [$this->makeClassNode($sourceFile)]);
$originalPayload = (string) file_get_contents($this->firstJsonFile($cacheDirectory));

$analysisResultCache->storeAnalysisNodes($otherFile, $namespace, [$this->makeClassNode($otherFile)]);
$this->assertNotNull($analysisResultCache->loadAnalysisNodes($otherFile, $namespace));

$otherCacheFile = $cacheDirectory . '/analysis-nodes-'
. hash('xxh128', $namespace . "\0" . $otherFile) . '.json';
file_put_contents($otherCacheFile, $originalPayload);

$this->assertNull($analysisResultCache->loadAnalysisNodes($otherFile, $namespace));
$this->assertNotNull($analysisResultCache->loadAnalysisNodes($sourceFile, 'config'));
} finally {
unlink($sourceFile);

if ($otherFile !== $sourceFile) {
unlink($otherFile);
}

$this->removeTempDirectory($cacheDirectory);
}
}

public function testAnalysisNodesStoreCompactMetadataAndRejectMalformedHashes(): void
{
$cacheDirectory = $this->createTempDirectory();
$sourceFile = $cacheDirectory . '/Foo.php';
$analysisResultCache = new AnalysisResultCache(__DIR__, new FileHashProvider(), $cacheDirectory);

file_put_contents($sourceFile, '<?php class Foo {}');

try {
$analysisResultCache->storeAnalysisNodes(
$sourceFile,
'config',
[],
new FileAnalysis($sourceFile, false, true, null, true, true, false, 1),
);
$cacheFile = $this->firstJsonFile($cacheDirectory);
$payload = json_decode((string) file_get_contents($cacheFile), true, 512, JSON_THROW_ON_ERROR);
$this->assertIsArray($payload);
$this->assertIsString($payload['metadata']);
$this->assertMatchesRegularExpression('/^[a-f0-9]{32}$/', $payload['metadata']);
$this->assertNotNull($analysisResultCache->loadAnalysisNodesWithFileAnalysis($sourceFile, 'config'));

$invalidMetadata = [
'null' => null,
'integer' => 1,
'boolean' => false,
'list' => [],
'string' => 'invalid',
'wrong hash' => hash('xxh128', 'other identity'),
'old format' => [
'namespace' => 'config',
'file' => $sourceFile,
'hash' => hash_file('xxh128', $sourceFile),
],
];

foreach ($invalidMetadata as $description => $metadata) {
$payload['metadata'] = $metadata;
$this->writeCachePayload($cacheDirectory, $payload, $cacheFile);

$this->assertNull($analysisResultCache->loadAnalysisNodes($sourceFile, 'config'), $description);
$this->assertNull(
$analysisResultCache->loadAnalysisNodesWithFileAnalysis($sourceFile, 'config'),
$description,
);
}

unset($payload['metadata']);
$this->writeCachePayload($cacheDirectory, $payload, $cacheFile);
$this->assertNull($analysisResultCache->loadAnalysisNodes($sourceFile, 'config'));
} finally {
unlink($sourceFile);
$this->removeTempDirectory($cacheDirectory);
}
}

public function testClearResetsSharedFileHashes(): void
{
$cacheDirectory = $this->createTempDirectory();
Expand Down Expand Up @@ -2660,13 +2759,11 @@ public function testClassNodesMissWhenPayloadIsMalformed(array $payloadOverride)
try {
$analysisResultCache->storeAnalysisNodes($sourceFile, 'config', [$this->makeClassNode($sourceFile)]);
$cacheFile = $this->firstJsonFile($cacheDirectory);
$payload = json_decode((string) file_get_contents($cacheFile), true, 512, JSON_THROW_ON_ERROR);
$this->assertIsArray($payload);

$this->writeCachePayload($cacheDirectory, [
'metadata' => [
'namespace' => 'config',
'file' => $sourceFile,
'hash' => hash('xxh128', (string) file_get_contents($sourceFile)),
],
...$payload,
...$payloadOverride,
], $cacheFile);

Expand Down