Make PHPStan DI-Container available in bootstrap files

.github/workflows/e2e.yaml

@@ -44,6 +44,7 @@ jobs:
                     - 'e2e/parallel-reflection-resolver'
                     - 'e2e/parallel with space'
                     - 'e2e/print-new-node'
+                    - 'e2e/phpstan-container-bootstrap'
 
         name: End to end test - ${{ matrix.directory }}
 

bin/rector.php

@@ -6,10 +6,12 @@
 use Rector\Bootstrap\AutoloadFileParameterResolver;
 use Rector\Bootstrap\RectorConfigsResolver;
 use Rector\ChangesReporting\Output\JsonOutputFormatter;
+use Rector\Config\RectorConfig;
 use Rector\Configuration\Option;
 use Rector\Console\Style\SymfonyStyleFactory;
 use Rector\DependencyInjection\LazyContainerFactory;
 use Rector\DependencyInjection\RectorContainerFactory;
+use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
 use Rector\Util\Reflection\PrivatesAccessor;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;

e2e/phpstan-container-bootstrap/bootstrap.php

@@ -0,0 +1,12 @@
+<?php
+
+if (!isset($container)) {
+    echo 'missing global $container variable';
+} elseif (get_class($container) === 'PHPStan\DependencyInjection\MemoizingContainer') {
+    echo "working as expected\n";
+    exit(0);
+} else {
+    echo '$container has wrong class ' . get_class($container);
+}
+
+exit(1);

e2e/phpstan-container-bootstrap/composer.json

@@ -0,0 +1,7 @@
+{
+    "require": {
+        "php": "^8.1"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

e2e/phpstan-container-bootstrap/rector.php

@@ -0,0 +1,12 @@
+<?php
+
+use Rector\Config\RectorConfig;
+use Rector\Php80\Rector\ClassMethod\AddParamBasedOnParentClassMethodRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([__DIR__ . '/src']);
+
+    $rectorConfig->bootstrapFiles(['bootstrap.php']);
+
+    $rectorConfig->rule(AddParamBasedOnParentClassMethodRector::class);
+};

e2e/phpstan-container-bootstrap/src/test.php

@@ -0,0 +1,3 @@
+<?php
+
+echo "hello world";

phpstan.neon

@@ -379,6 +379,13 @@ parameters:
             identifier: offsetAccess.nonArray
             path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
 
+        # variable is expected in included/required file
+        -
+            identifier: closure.unusedUse
+            message: '#Anonymous function has an unused use \$container#'
+            paths:
+                - src/Autoloading/BootstrapFilesIncluder.php
+
         # false positive
         -
             message: '#Method (.*?)refactor\(\) (never returns|should return) (.*?)#'

src/Autoloading/BootstrapFilesIncluder.php

@@ -11,6 +11,7 @@
 use RecursiveIteratorIterator;
 use SplFileInfo;
 use Webmozart\Assert\Assert;
+use PHPStan\DependencyInjection\Container;
 
 /**
  * @see \Rector\Tests\Autoloading\BootstrapFilesIncluderTest
@@ -21,7 +22,7 @@ final class BootstrapFilesIncluder
      * Inspired by
      * @see https://github.com/phpstan/phpstan-src/commit/aad1bf888ab7b5808898ee5fe2228bb8bb4e4cf1
      */
-    public function includeBootstrapFiles(): void
+    public function includeBootstrapFiles(Container $container): void
     {
         $bootstrapFiles = SimpleParameterProvider::provideArrayParameter(Option::BOOTSTRAP_FILES);
 
@@ -33,7 +34,10 @@ public function includeBootstrapFiles(): void
                 throw new ShouldNotHappenException(sprintf('Bootstrap file "%s" does not exist.', $bootstrapFile));
             }
 
-            require $bootstrapFile;
+            // mimic PHPStan bootstrap file inclusion (bootstrap files have access to the global $container variable)
+            (static function (string $file) use ($container): void {
+                require $file;
+            })($bootstrapFile);
         }
 
         $this->requireRectorStubs();

src/DependencyInjection/RectorContainerFactory.php

@@ -7,6 +7,7 @@
 use Rector\Autoloading\BootstrapFilesIncluder;
 use Rector\Caching\Detector\ChangedFilesDetector;
 use Rector\Config\RectorConfig;
+use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
 use Rector\ValueObject\Bootstrap\BootstrapConfigs;
 
 final class RectorContainerFactory
@@ -25,7 +26,7 @@ public function createFromBootstrapConfigs(BootstrapConfigs $bootstrapConfigs):
 
         /** @var BootstrapFilesIncluder $bootstrapFilesIncluder */
         $bootstrapFilesIncluder = $rectorConfig->get(BootstrapFilesIncluder::class);
-        $bootstrapFilesIncluder->includeBootstrapFiles();
+        $bootstrapFilesIncluder->includeBootstrapFiles($rectorConfig->get(PHPStanServicesFactory::class)->getContainer());
 
         return $rectorConfig;
     }

src/NodeTypeResolver/DependencyInjection/PHPStanServicesFactory.php

@@ -144,6 +144,14 @@ public function createDynamicSourceLocatorProvider(): DynamicSourceLocatorProvid
         return $this->container->getByType(DynamicSourceLocatorProvider::class);
     }
 
+    /**
+     * @api
+     */
+    public function getContainer(): Container
+    {
+        return $this->container;
+    }
+
     /**
      * @return string[]
      */

src/Testing/PHPUnit/AbstractRectorTestCase.php

@@ -19,6 +19,7 @@
 use Rector\Contract\Rector\RectorInterface;
 use Rector\DependencyInjection\Laravel\ContainerMemento;
 use Rector\Exception\ShouldNotHappenException;
+use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
 use Rector\NodeTypeResolver\Reflection\BetterReflection\SourceLocatorProvider\DynamicSourceLocatorProvider;
 use Rector\PhpParser\NodeTraverser\RectorNodeTraverser;
 use Rector\Rector\AbstractRector;
@@ -116,7 +117,7 @@ protected function setUp(): void
 
         /** @var BootstrapFilesIncluder $bootstrapFilesIncluder */
         $bootstrapFilesIncluder = $this->make(BootstrapFilesIncluder::class);
-        $bootstrapFilesIncluder->includeBootstrapFiles();
+        $bootstrapFilesIncluder->includeBootstrapFiles($rectorConfig->get(PHPStanServicesFactory::class)->getContainer());
     }
 
     protected function tearDown(): void

tests/Autoloading/BootstrapFilesIncluderTest.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use Rector\Autoloading\BootstrapFilesIncluder;
+use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
 use Rector\Testing\PHPUnit\AbstractLazyTestCase;
 
 final class BootstrapFilesIncluderTest extends AbstractLazyTestCase
@@ -14,6 +15,6 @@ final class BootstrapFilesIncluderTest extends AbstractLazyTestCase
     public function test(): void
     {
         $bootstrapFilesIncluder = $this->make(BootstrapFilesIncluder::class);
-        $bootstrapFilesIncluder->includeBootstrapFiles();
+        $bootstrapFilesIncluder->includeBootstrapFiles($this->getContainer()->get(PHPStanServicesFactory::class)->getContainer());
     }
 }