Skip to content

[Config] never try loading failed classes twice with ClassExistenceResource #34762

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

Merged
merged 1 commit into from
Dec 7, 2019
Merged

[Config] never try loading failed classes twice with ClassExistenceResource #34762

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
37 changes: 29 additions & 8 deletions src/Symfony/Component/Config/Resource/ClassExistenceResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct($resource, $exists = null)
{
$this->resource = $resource;
if (null !== $exists) {
$this->exists = (bool) $exists;
$this->exists = [(bool) $exists, null];
}
}

Expand Down Expand Up @@ -65,26 +65,33 @@ public function isFresh($timestamp)
{
$loaded = class_exists($this->resource, false) || interface_exists($this->resource, false) || trait_exists($this->resource, false);

if (null !== $exists = &self::$existsCache[(int) (0 >= $timestamp)][$this->resource]) {
$exists = $exists || $loaded;
} elseif (!$exists = $loaded) {
if (null !== $exists = &self::$existsCache[$this->resource]) {
if ($loaded) {
$exists = [true, null];
} elseif (0 >= $timestamp && !$exists[0] && null !== $exists[1]) {
throw new \ReflectionException($exists[1]);
}
} elseif ([false, null] === $exists = [$loaded, null]) {
if (!self::$autoloadLevel++) {
spl_autoload_register(__CLASS__.'::throwOnRequiredClass');
}
$autoloadedClass = self::$autoloadedClass;
self::$autoloadedClass = ltrim($this->resource, '\\');

try {
$exists = class_exists($this->resource) || interface_exists($this->resource, false) || trait_exists($this->resource, false);
$exists[0] = class_exists($this->resource) || interface_exists($this->resource, false) || trait_exists($this->resource, false);
} catch (\Exception $e) {
$exists[1] = $e->getMessage();

try {
self::throwOnRequiredClass($this->resource, $e);
} catch (\ReflectionException $e) {
if (0 >= $timestamp) {
unset(self::$existsCache[1][$this->resource]);
throw $e;
}
}
} catch (\Throwable $e) {
$exists[1] = $e->getMessage();
} finally {
self::$autoloadedClass = $autoloadedClass;
if (!--self::$autoloadLevel) {
Expand All @@ -97,7 +104,7 @@ public function isFresh($timestamp)
$this->exists = $exists;
}

return $this->exists xor !$exists;
return $this->exists[0] xor !$exists[0];
}

/**
Expand All @@ -118,6 +125,10 @@ public function serialize()
public function unserialize($serialized)
{
list($this->resource, $this->exists) = unserialize($serialized);

if (\is_bool($this->exists)) {
$this->exists = [$this->exists, null];
}
}

/**
Expand Down Expand Up @@ -155,7 +166,17 @@ public static function throwOnRequiredClass($class, \Exception $previous = null)
throw $previous;
}

$e = new \ReflectionException(sprintf('Class "%s" not found while loading "%s".', $class, self::$autoloadedClass), 0, $previous);
$message = sprintf('Class "%s" not found.', $class);

if (self::$autoloadedClass !== $class) {
$message = substr_replace($message, sprintf(' while loading "%s"', self::$autoloadedClass), -1, 0);
}

if (null !== $previous) {
$message = $previous->getMessage();
}

$e = new \ReflectionException($message, 0, $previous);

if (null !== $previous) {
throw $e;
Expand Down
9 changes: 9 additions & 0 deletions src/Symfony/Component/Config/Tests/Fixtures/BadFileName.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

namespace Symfony\Component\Config\Tests\Fixtures;

class FileNameMismatchOnPurpose
{
}

throw new \RuntimeException('Mismatch between file name and class name.');
19 changes: 19 additions & 0 deletions src/Symfony/Component/Config/Tests/Resource/ClassExistenceResourceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

use PHPUnit\Framework\TestCase;
use Symfony\Component\Config\Resource\ClassExistenceResource;
use Symfony\Component\Config\Tests\Fixtures\BadFileName;
use Symfony\Component\Config\Tests\Fixtures\BadParent;
use Symfony\Component\Config\Tests\Fixtures\Resource\ConditionalClass;

Expand Down Expand Up @@ -90,6 +91,24 @@ public function testBadParentWithNoTimestamp()
$res->isFresh(0);
}

public function testBadFileName()
{
$this->expectException('ReflectionException');
$this->expectExceptionMessage('Mismatch between file name and class name.');

$res = new ClassExistenceResource(BadFileName::class, false);
$res->isFresh(0);
}

public function testBadFileNameBis()
{
$this->expectException('ReflectionException');
$this->expectExceptionMessage('Mismatch between file name and class name.');

$res = new ClassExistenceResource(BadFileName::class, false);
$res->isFresh(0);
}

public function testConditionalClass()
{
$res = new ClassExistenceResource(ConditionalClass::class, false);
Expand Down