Skip to content
Open
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions e2e/bug-15375/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/vendor
/composer.lock
3 changes: 3 additions & 0 deletions e2e/bug-15375/bootstrap.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<?php declare(strict_types = 1);

define('Bug15375\FRAMEWORK_VERSION', '13.26.1');
27 changes: 27 additions & 0 deletions e2e/bug-15375/bug-15375_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/usr/bin/env bash
# @tags result-cache

function set_up() {
e2e::set_up
}

function tear_down() {
e2e::tear_down
}

function test_bug_15375() {
# A class that was missing when the result cache was saved exists now. Restoring the
# cache computes the class's value - its declarations and its ancestors' - in the main
# process, before the deferred bootstrapFiles have run. It must not reach
# StubPhpDocProvider, which runs the StubFilesExtensions.
composer install
OUTPUT=$(../../bin/phpstan analyse -vvv 2>&1 || true)
echo "$OUTPUT"
assert_contains 'Instantiated class Bug15375\Later not found.' "$OUTPUT"
cp later/Later.php src/Later.php
OUTPUT=$(../../bin/phpstan analyse -vvv 2>&1 || true)
echo "$OUTPUT"
assert_not_contains 'StubFilesExtension ran before bootstrapFiles.' "$OUTPUT"
assert_contains 'No errors' "$OUTPUT"
../../bin/phpstan analyse -vvv
}
7 changes: 7 additions & 0 deletions e2e/bug-15375/composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"autoload": {
"psr-4": {
"Bug15375\\": "extension/"
}
}
}
22 changes: 22 additions & 0 deletions e2e/bug-15375/extension/FrameworkStubFilesExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php declare(strict_types = 1);

namespace Bug15375;

use LogicException;
use PHPStan\PhpDoc\StubFilesExtension;
use function defined;

final class FrameworkStubFilesExtension implements StubFilesExtension
{

public function getFiles(): array
{
// mimics larastan, which picks its stubs by the framework version its bootstrapFiles entry defines
if (!defined('Bug15375\FRAMEWORK_VERSION')) {
throw new LogicException('StubFilesExtension ran before bootstrapFiles.');
}

return [];
}

}
15 changes: 15 additions & 0 deletions e2e/bug-15375/later/Later.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php declare(strict_types = 1);

namespace Bug15375;

/**
* @extends Base<Entity>
*/
class Later extends Base
{

use HasName;

public string $label = 'later';

}
12 changes: 12 additions & 0 deletions e2e/bug-15375/phpstan.neon
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
parameters:
level: 8
paths:
- src
bootstrapFiles:
- bootstrap.php

services:
-
class: Bug15375\FrameworkStubFilesExtension
tags:
- phpstan.stubFilesExtension
14 changes: 14 additions & 0 deletions e2e/bug-15375/src/Base.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php declare(strict_types = 1);

namespace Bug15375;

/**
* @template T of Entity
*/
abstract class Base implements Named
{

/** @var list<T> */
public array $items = [];

}
13 changes: 13 additions & 0 deletions e2e/bug-15375/src/Caller.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php declare(strict_types = 1);

namespace Bug15375;

class Caller
{

public function name(): string
{
return (new Later())->name();
}

}
8 changes: 8 additions & 0 deletions e2e/bug-15375/src/Entity.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php declare(strict_types = 1);

namespace Bug15375;

class Entity
{

}
13 changes: 13 additions & 0 deletions e2e/bug-15375/src/HasName.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php declare(strict_types = 1);

namespace Bug15375;

trait HasName
{

public function name(): string
{
return 'name';
}

}
10 changes: 10 additions & 0 deletions e2e/bug-15375/src/Named.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php declare(strict_types = 1);

namespace Bug15375;

interface Named
{

public function name(): string;

}
49 changes: 44 additions & 5 deletions src/Analyser/ResultCache/ClassResultCacheValueExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
namespace PHPStan\Analyser\ResultCache;

use PHPStan\Analyser\ValueDependencyCollector;
use PHPStan\BetterReflection\Reflection\ReflectionClass;
use PHPStan\Dependency\ExportedNodeFetcher;
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\File\FileContentHasher;
use PHPStan\Reflection\ReflectionProvider;
use function array_key_exists;
use function array_pop;
use function hash;
use function implode;
use function json_encode;
Expand Down Expand Up @@ -52,22 +54,59 @@ public function getValue(string $key): string
return ValueDependencyCollector::MISSING;
}

$classReflection = $this->reflectionProvider->getClass($key);
$declarations = [];
foreach ([$classReflection->getName() => $classReflection] + $classReflection->getAncestors() as $name => $declaringClass) {
$reflection = $this->reflectionProvider->getClass($key)->getNativeReflection()->getBetterReflection();
foreach ($this->getDeclaringClasses($reflection) as $lowercaseName => $declaringClass) {
// a built-in class is read from a stub, which one depends on the source locator that
// reflected it first; it changes only with PHP, its extensions or PHPStan itself
$fileName = $declaringClass->isBuiltin() ? null : $declaringClass->getFileName();
$declarations[strtolower($name)] = $fileName === null
$fileName = $declaringClass->isInternal() ? null : $declaringClass->getFileName();
$declarations[$lowercaseName] = $fileName === null
? 'built-in'
: sprintf('%s %s', $fileName, $this->getExportedNode($fileName, $name));
: sprintf('%s %s', $fileName, $this->getExportedNode($fileName, $declaringClass->getName()));
}

ksort($declarations);

return hash('sha256', implode("\n", $declarations));
}

/**
* The class with its parents, interfaces and traits. ClassReflection::getAncestors() would also
* resolve their generic types from the class PHPDocs, reaching StubPhpDocProvider - which runs
* the StubFilesExtensions, while the result cache is restored before the bootstrapFiles they
* can rely on.
*
* @return array<string, ReflectionClass> lowercase name => class
*/
private function getDeclaringClasses(ReflectionClass $reflection): array
{
$classes = [];
$queue = [$reflection];
while ($queue !== []) {
$class = array_pop($queue);
$lowercaseName = strtolower($class->getName());
if (array_key_exists($lowercaseName, $classes)) {
continue;
}

$classes[$lowercaseName] = $class;
foreach ($class->getImmediateInterfaces() as $interface) {
$queue[] = $interface;
}
foreach ($class->getTraits() as $trait) {
$queue[] = $trait;
}
$parentClass = $class->getParentClass();
if ($parentClass === null) {
continue;
}

$queue[] = $parentClass;
}

return $classes;
}

public function keyToResultCache(string $key): string
{
return $key;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php declare(strict_types = 1);

namespace PHPStan\Analyser\ResultCache;

use LogicException;
use PHPStan\PhpDoc\StubFilesExtension;

/**
* Stands for a StubFilesExtension relying on the bootstrapFiles, which have not run yet when the
* result cache is restored.
*/
final class BootstrapDependentStubFilesExtension implements StubFilesExtension
{

public function getFiles(): array
{
throw new LogicException('The StubFilesExtensions must not run while the result cache is restored.');
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,13 @@ public function testValue(): void
$this->assertNotSame($value, $extension->getValue(ClassResultCacheValueExtension::createKey(DirectoryResultCacheValueExtensionTest::class)));
}

public static function getAdditionalConfigFiles(): array
{
// the values are compared when the result cache is restored, before the bootstrapFiles
// have run - getValue() must not reach the StubFilesExtensions
return [
__DIR__ . '/classResultCacheValueExtension.neon',
];
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
services:
-
class: PHPStan\Analyser\ResultCache\BootstrapDependentStubFilesExtension
tags:
- phpstan.stubFilesExtension
Loading