[PhpUnitBridge] Fix qualification of deprecations triggered by the debug class loader

fancyweb · fancyweb · commit 2976c0e872f7 · 2020-11-20T18:35:41.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -169,7 +169,7 @@ install:
       # To run a PR with a patched phpunit-bridge, first submit the patch for the
       # phpunit-bridge as a separate PR against the next feature-branch then
       # uncomment and update the following line with that PR number
-      #SYMFONY_PHPUNIT_BRIDGE_PR=32886
+      SYMFONY_PHPUNIT_BRIDGE_PR=38597
 
       if [[ $SYMFONY_PHPUNIT_BRIDGE_PR ]]; then
           git fetch --depth=2 origin refs/pull/$SYMFONY_PHPUNIT_BRIDGE_PR/head
diff --git a/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Deprecation.php b/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Deprecation.php
@@ -13,6 +13,8 @@
 
 use PHPUnit\Util\Test;
 use Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerFor;
+use Symfony\Component\Debug\DebugClassLoader as LegacyDebugClassLoader;
+use Symfony\Component\ErrorHandler\DebugClassLoader;
 
 /**
  * @internal
@@ -53,6 +55,18 @@ class Deprecation
     public function __construct($message, array $trace, $file)
     {
         $this->trace = $trace;
+
+        if ('trigger_error' === ($trace[1]['function'] ?? null)
+            && (DebugClassLoader::class === ($class = $trace[2]['class'] ?? null) || LegacyDebugClassLoader::class === $class)
+            && 'checkClass' === ($trace[2]['function'] ?? null)
+            && null !== ($extraFile = $trace[2]['args'][1] ?? null)
+            && '' !== $extraFile
+            && false !== $extraFile = realpath($extraFile)
+        ) {
+            $this->getOriginalFilesStack();
+            array_splice($this->originalFilesStack, 2, 1, $extraFile);
+        }
+
         $this->message = $message;
         $i = \count($trace);
         while (1 < $i && $this->lineShouldBeSkipped($trace[--$i])) {
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/debug_class_loader_autoload.phpt b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/debug_class_loader_autoload.phpt
@@ -0,0 +1,48 @@
+--TEST--
+Test that a deprecation from the DebugClassLoader on a vendor class autoload triggered by an app class is considered indirect.
+--FILE--
+<?php
+
+$k = 'SYMFONY_DEPRECATIONS_HELPER';
+putenv($k.'='.$_SERVER[$k] = $_ENV[$k] = 'max[total]=0');
+putenv('ANSICON');
+putenv('ConEmuANSI');
+putenv('TERM');
+
+$vendor = __DIR__;
+while (!file_exists($vendor.'/vendor')) {
+    $vendor = dirname($vendor);
+}
+define('PHPUNIT_COMPOSER_INSTALL', $vendor.'/vendor/autoload.php');
+require PHPUNIT_COMPOSER_INSTALL;
+require_once __DIR__.'/../../bootstrap.php';
+eval(<<<'EOPHP'
+namespace PHPUnit\Util;
+
+class Test
+{
+    public static function getGroups()
+    {
+        return array();
+    }
+}
+EOPHP
+);
+require __DIR__.'/fake_vendor/autoload.php';
+
+// We need the real DebugClassLoader FQCN but in a vendor path.
+$realDebugClassLoaderPath = __DIR__.'/../../../../Component/ErrorHandler/DebugClassLoader.php';
+$fakeDebugClassLoadPath = __DIR__.'/fake_vendor/symfony/error-handler/DebugClassLoader.php';
+file_put_contents($fakeDebugClassLoadPath, file_get_contents($realDebugClassLoaderPath));
+require $fakeDebugClassLoadPath;
+
+\Symfony\Component\ErrorHandler\DebugClassLoader::enable();
+
+new \App\Services\BarService();
+
+?>
+--EXPECTF--
+Remaining indirect deprecation notices (1)
+
+  1x: The "acme\lib\ExtendsDeprecatedClassFromOtherVendor" class extends "fcy\lib\DeprecatedClass" that is deprecated.
+    1x in BarService::__construct from App\Services
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_app/BarService.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_app/BarService.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Services;
+
+use acme\lib\ExtendsDeprecatedClassFromOtherVendor;
+
+final class BarService
+{
+    public function __construct()
+    {
+        ExtendsDeprecatedClassFromOtherVendor::FOO;
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/acme/lib/ExtendsDeprecatedClassFromOtherVendor.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/acme/lib/ExtendsDeprecatedClassFromOtherVendor.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace acme\lib;
+
+use fcy\lib\DeprecatedClass;
+
+final class ExtendsDeprecatedClassFromOtherVendor extends DeprecatedClass
+{
+    public const FOO = 'bar';
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/composer/autoload_real.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/composer/autoload_real.php
@@ -12,23 +12,33 @@ public function getPrefixesPsr4()
         return [
             'App\\Services\\' => [__DIR__.'/../../fake_app/'],
             'acme\\lib\\' => [__DIR__.'/../acme/lib/'],
+            'fcy\\lib\\' => [__DIR__.'/../fcy/lib/'],
         ];
     }
 
     public function loadClass($className)
+    {
+        if ($file = $this->findFile($className)) {
+            require $file;
+        }
+    }
+
+    public function findFile($class)
     {
         foreach ($this->getPrefixesPsr4() as $prefix => $baseDirs) {
-            if (strpos($className, $prefix) !== 0) {
+            if (strpos($class, $prefix) !== 0) {
                 continue;
             }
 
             foreach ($baseDirs as $baseDir) {
-                $file = str_replace([$prefix, '\\'], [$baseDir, '/'], $className.'.php');
+                $file = str_replace([$prefix, '\\'], [$baseDir, '/'], $class.'.php');
                 if (file_exists($file)) {
-                    require $file;
+                    return $file;
                 }
             }
         }
+
+        return false;
     }
 }
 
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/fcy/lib/DeprecatedClass.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/fcy/lib/DeprecatedClass.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace fcy\lib;
+
+/**
+ * @deprecated
+ */
+class DeprecatedClass
+{
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/symfony/error-handler/DebugClassLoader.php b/src/Symfony/Bridge/PhpUnit/Tests/DeprecationErrorHandler/fake_vendor/symfony/error-handler/DebugClassLoader.php

Original file line number	Diff line number	Diff line change
`@@ -12,23 +12,33 @@ public function getPrefixesPsr4()`
`12`	`12`	`return [`
`13`	`13`	`'App\\Services\\' => [__DIR__.'/../../fake_app/'],`
`14`	`14`	`'acme\\lib\\' => [__DIR__.'/../acme/lib/'],`
	`15`	`+ 'fcy\\lib\\' => [__DIR__.'/../fcy/lib/'],`
`15`	`16`	`];`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`public function loadClass($className)`
	`20`	`+ {`
	`21`	`+ if ($file = $this->findFile($className)) {`
	`22`	`+ require $file;`
	`23`	`+ }`
	`24`	`+ }`
	`25`	`+`
	`26`	`+ public function findFile($class)`
`19`	`27`	`{`
`20`	`28`	`foreach ($this->getPrefixesPsr4() as $prefix => $baseDirs) {`
`21`		`- if (strpos($className, $prefix) !== 0) {`
	`29`	`+ if (strpos($class, $prefix) !== 0) {`
`22`	`30`	`continue;`
`23`	`31`	`}`
`24`	`32`
`25`	`33`	`foreach ($baseDirs as $baseDir) {`
`26`		`- $file = str_replace([$prefix, '\\'], [$baseDir, '/'], $className.'.php');`
	`34`	`+ $file = str_replace([$prefix, '\\'], [$baseDir, '/'], $class.'.php');`
`27`	`35`	`if (file_exists($file)) {`
`28`		`- require $file;`
	`36`	`+ return $file;`
`29`	`37`	`}`
`30`	`38`	`}`
`31`	`39`	`}`
	`40`	`+`
	`41`	`+ return false;`
`32`	`42`	`}`
`33`	`43`	`}`
`34`	`44`