Skip to content

Use cache atomically #7

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
22 changes: 8 additions & 14 deletions src/Helpers/Cache.php
Original file line number Diff line number Diff line change
@@ -4,6 +4,9 @@

namespace DaveLiddament\PhpstanPhpLanguageExtensions\Helpers;

use function array_key_exists;
use Closure;

/**
* @template TValue
*/
@@ -12,24 +15,15 @@ class Cache
/** @var array<string,TValue> */
private array $cache = [];

public function hasEntry(string $key): bool
{
return array_key_exists($key, $this->cache);
}

/** @return TValue */
public function getEntry(string $key)
/**
* @return TValue
*/
public function get(string $key, Closure $initializer): mixed
{
if (!array_key_exists($key, $this->cache)) {
throw new \LogicException('Call hasEntry first');
$this->cache[$key] = $initializer();
}

return $this->cache[$key];
}

/** @param TValue $entry */
public function addEntry(string $key, $entry): void
{
$this->cache[$key] = $entry;
}
}
24 changes: 10 additions & 14 deletions src/Rules/AbstractFriendRule.php
Original file line number Diff line number Diff line change
@@ -45,26 +45,22 @@ protected function getErrorOrNull(
$className = $classReflection->getName();
$fullMethodName = "{$className}::{$methodName}";

if ($this->cache->hasEntry($fullMethodName)) {
$allowedCallingClassesFromMethod = $this->cache->getEntry($fullMethodName);
} else {
$allowedCallingClassesFromMethod = AttributeValueReader::getAttributeValuesForMethod(
$allowedCallingClassesFromMethod = $this->cache->get(
$fullMethodName,
static fn (): array => AttributeValueReader::getAttributeValuesForMethod(
$classReflection->getNativeReflection(),
$methodName,
Friend::class
);
$this->cache->addEntry($fullMethodName, $allowedCallingClassesFromMethod);
}
)
);

if ($this->cache->hasEntry($className)) {
$allowedCallingClassesFromClass = $this->cache->getEntry($className);
} else {
$allowedCallingClassesFromClass = AttributeValueReader::getAttributeValuesForClass(
$allowedCallingClassesFromClass = $this->cache->get(
$className,
static fn (): array => AttributeValueReader::getAttributeValuesForClass(
$classReflection->getNativeReflection(),
Friend::class
);
$this->cache->addEntry($className, $allowedCallingClassesFromClass);
}
)
);

$allowedCallingClasses = array_merge($allowedCallingClassesFromClass, $allowedCallingClassesFromMethod);

27 changes: 10 additions & 17 deletions src/Rules/AbstractPackageRule.php
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@

namespace DaveLiddament\PhpstanPhpLanguageExtensions\Rules;

use function count;
use DaveLiddament\PhpLanguageExtensions\Package;
use DaveLiddament\PhpstanPhpLanguageExtensions\Config\TestConfig;
use DaveLiddament\PhpstanPhpLanguageExtensions\Helpers\Cache;
@@ -45,24 +46,16 @@ protected function getErrorOrNull(

$fullMethodName = "{$className}::{$methodName}";

if ($this->cache->hasEntry($fullMethodName)) {
$isMethodPackageLevel = $this->cache->getEntry($fullMethodName);
} else {
if ($nativeReflection->hasMethod($methodName)) {
$methodReflection = $nativeReflection->getMethod($methodName);
$isMethodPackageLevel = count($methodReflection->getAttributes(Package::class)) > 0;
} else {
$isMethodPackageLevel = false;
}
$this->cache->addEntry($fullMethodName, $isMethodPackageLevel);
}
$isMethodPackageLevel = $this->cache->get(
$fullMethodName,
static fn (): bool => $nativeReflection->hasMethod($methodName)
&& count($nativeReflection->getMethod($methodName)->getAttributes(Package::class)) > 0
);

if ($this->cache->hasEntry($className)) {
$isClassPackageLevel = $this->cache->getEntry($className);
} else {
$isClassPackageLevel = count($nativeReflection->getAttributes(Package::class)) > 0;
$this->cache->addEntry($className, $isClassPackageLevel);
}
$isClassPackageLevel = $this->cache->get(
$className,
static fn (): bool => count($nativeReflection->getAttributes(Package::class)) > 0
);

$isPackageLevel = $isClassPackageLevel || $isMethodPackageLevel;

17 changes: 6 additions & 11 deletions src/Rules/AbstractTestTagRule.php
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@

namespace DaveLiddament\PhpstanPhpLanguageExtensions\Rules;

use function count;
use DaveLiddament\PhpLanguageExtensions\TestTag;
use DaveLiddament\PhpstanPhpLanguageExtensions\Config\TestConfig;
use DaveLiddament\PhpstanPhpLanguageExtensions\Helpers\Cache;
@@ -45,17 +46,11 @@ protected function getErrorOrNull(

$fullMethodName = "{$className}::{$methodName}";

if ($this->cache->hasEntry($fullMethodName)) {
$isTestTag = $this->cache->getEntry($fullMethodName);
} else {
if ($nativeReflection->hasMethod($methodName)) {
$methodReflection = $nativeReflection->getMethod($methodName);
$isTestTag = count($methodReflection->getAttributes(TestTag::class)) > 0;
} else {
$isTestTag = false;
}
$this->cache->addEntry($fullMethodName, $isTestTag);
}
$isTestTag = $this->cache->get(
$fullMethodName,
static fn (): bool => $nativeReflection->hasMethod($methodName)
&& count($nativeReflection->getMethod($methodName)->getAttributes(TestTag::class)) > 0
);

if (!$isTestTag) {
return null;
7 changes: 1 addition & 6 deletions src/Rules/InjectableVersionRule.php
Original file line number Diff line number Diff line change
@@ -73,12 +73,7 @@ public function processNode(Node $node, Scope $scope): array
: $type->getReferencedClasses();

foreach ($classesToCheck as $className) {
if ($this->cache->hasEntry($className)) {
$classToUse = $this->cache->getEntry($className);
} else {
$classToUse = $this->checkClass($className);
$this->cache->addEntry($className, $classToUse);
}
$classToUse = $this->cache->get($className, fn () => $this->checkClass($className));

if (null !== $classToUse) {
$message = sprintf(
25 changes: 12 additions & 13 deletions tests/Unit/CacheTest.php
Original file line number Diff line number Diff line change
@@ -22,21 +22,20 @@ protected function setup(): void
$this->cache = new Cache();
}

public function testEmptyCache(): void
public function testEntriesShouldOnlyBeInitializedOnce(): void
{
$this->assertFalse($this->cache->hasEntry(self::ENTRY_1));
}
$initializationCount = 0;

public function testAddValueToCache(): void
{
$this->cache->addEntry(self::ENTRY_1, self::VALUE_1);
$this->assertTrue($this->cache->hasEntry(self::ENTRY_1));
$this->assertSame(self::VALUE_1, $this->cache->getEntry(self::ENTRY_1));
}
$initializer = static function () use (&$initializationCount): string {
++$initializationCount;

public function testAccessMissingEntry(): void
{
$this->expectException(\LogicException::class);
$this->cache->getEntry(self::ENTRY_1);
return self::VALUE_1;
};

self::assertSame(self::VALUE_1, $this->cache->get(self::ENTRY_1, $initializer));
self::assertSame(1, $initializationCount);

self::assertSame(self::VALUE_1, $this->cache->get(self::ENTRY_1, $initializer));
self::assertSame(1, $initializationCount);
}
}