autoloading issues since 1.7.x

[staabm]

Bug report

atm we are kind of stuck on phpstan 1.6.8 because with 1.7.x we experience autoloading issues.

I was not yet able to build a small reproducing example, but it seems we see some kind of race conditions on which classes are known to phpstan and when. running in single process --debug mode most of the time works, but running regular multi process phpstan analysis often times crashes like

Uncaught Error: Class "clxElement" not found in C:\dvl\Workspace\motiontm\lib\plugins\clxMobileNet\lib\clxShop.php:3
#0 C:\dvl\Workspace\motiontm\vendor\plugins\rocket\lib\Rocket.php(387): require_once()
#1 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/SourceLocator/AutoloadSourceLocator.php(270): Rocket::autoload()
#2 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/SourceLocator/FileReadTrapStreamWrapper.php(59): PHPStan\Reflection\BetterReflection\SourceLocator\AutoloadSourceLocator::PHPStan\Reflection\BetterReflection\SourceLocator\{closure}()
#3 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/SourceLocator/AutoloadSourceLocator.php(282): PHPStan\Reflection\BetterReflection\SourceLocator\FileReadTrapStreamWrapper::withStreamWrapperOverride()
#4 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/SourceLocator/AutoloadSourceLocator.php(114): PHPStan\Reflection\BetterReflection\SourceLocator\AutoloadSourceLocator->locateClassByName()
#5 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/SourceLocator/Type/AggregateSourceLocator.php(28): PHPStan\Reflection\BetterReflection\SourceLocator\AutoloadSourceLocator->locateIdentifier()
#6 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/SourceLocator/Type/MemoizingSourceLocator.php(33): PHPStan\BetterReflection\SourceLocator\Type\AggregateSourceLocator->locateIdentifier()
#7 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflector/DefaultReflector.php(32): PHPStan\BetterReflection\SourceLocator\Type\MemoizingSourceLocator->locateIdentifier()
#8 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/ReflectionClass.php(871): PHPStan\BetterReflection\Reflector\DefaultReflector->reflectClass()
#9 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/ReflectionClass.php(367): PHPStan\BetterReflection\Reflection\ReflectionClass->getParentClass()
#10 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/ReflectionClass.php(410): PHPStan\BetterReflection\Reflection\ReflectionClass->getParentMethods()
#11 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/ReflectionClass.php(459): PHPStan\BetterReflection\Reflection\ReflectionClass->getMethodsIndexedByName()
#12 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/ReflectionClass.php(674): PHPStan\BetterReflection\Reflection\ReflectionClass->getMethods()
#13 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflection/Adapter/ReflectionClass.php(123): PHPStan\BetterReflection\Reflection\ReflectionClass->getConstructor()
#14 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/ClassReflection.php(440): PHPStan\BetterReflection\Reflection\Adapter\ReflectionClass->getConstructor()
#15 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/ClassReflection.php(428): PHPStan\Reflection\ClassReflection->findConstructor()
#16 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/MutatingScope.php(3301): PHPStan\Reflection\ClassReflection->hasConstructor()
#17 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/MutatingScope.php(1119): PHPStan\Analyser\MutatingScope->exactInstantiation()
#18 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/MutatingScope.php(551): PHPStan\Analyser\MutatingScope->resolveType()
#19 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(1431): PHPStan\Analyser\MutatingScope->getType()
#20 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(2618): PHPStan\Analyser\NodeScopeResolver->PHPStan\Analyser\{closure}()
#21 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(1441): PHPStan\Analyser\NodeScopeResolver->processAssignVar()
#22 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(522): PHPStan\Analyser\NodeScopeResolver->processExprNode()
#23 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(323): PHPStan\Analyser\NodeScopeResolver->processStmtNode()
#24 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(485): PHPStan\Analyser\NodeScopeResolver->processStmtNodes()
#25 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(323): PHPStan\Analyser\NodeScopeResolver->processStmtNode()
#26 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(569): PHPStan\Analyser\NodeScopeResolver->processStmtNodes()
#27 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/NodeScopeResolver.php(294): PHPStan\Analyser\NodeScopeResolver->processStmtNode()
#28 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/FileAnalyser.php(189): PHPStan\Analyser\NodeScopeResolver->processNodes()
#29 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/Analyser.php(61): PHPStan\Analyser\FileAnalyser->analyseFile()
#30 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyserRunner.php(62): PHPStan\Analyser\Analyser->analyse()
#31 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseApplication.php(141): PHPStan\Command\AnalyserRunner->runAnalyser()
#32 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseApplication.php(66): PHPStan\Command\AnalyseApplication->runAnalyser()
#33 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseCommand.php(180): PHPStan\Command\AnalyseApplication->analyse()
#34 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Command/Command.php(259): PHPStan\Command\AnalyseCommand->execute()
#35 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php(856): _PHPStan_0a43b4828\Symfony\Component\Console\Command\Command->run()
#36 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php(259): _PHPStan_0a43b4828\Symfony\Component\Console\Application->doRunCommand()
#37 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php(157): _PHPStan_0a43b4828\Symfony\Component\Console\Application->doRun()
#38 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan(96): _PHPStan_0a43b4828\Symfony\Component\Console\Application->run()
#39 phar://C:/dvl/Workspace/motiontm/vendor-bin/phpstan/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan(97): _PHPStan_0a43b4828\{closure}()
#40 C:\dvl\Workspace\motiontm\vendor-bin\phpstan\vendor\phpstan\phpstan\phpstan(8): require('...')
#41 C:\dvl\Workspace\motiontm\vendor\bin\phpstan(117): include('...')
#42 {main}

the symbols phpstan is not able to find are those which it was able to autoload on 1.6.x with the registered autoloader using bootstrapFiles.

especially interessting is, that when running on xdebug it seems most of the time the autoloading problems are not reproducible.

the autoloader we are using cannot be expressed with simple scanDirectory configs, because of some logic involved (legacy app with certain directory layout requirements)

[mergeable]

This bug report is missing a link to reproduction at phpstan.org/try.

It will most likely be closed after manual review.

[staabm]

hmm it seems the error is only reproducible on my machine... need to investigate further..

[ondrejmirtes]

Don't close it if it's not solved 😊 What's your reasoning behing the autoloader? Could you make it work with scanDirectories/scanFiles instead?

[staabm]

our autoloader contains some logic which cannot be expressed with a list of file paths.

additionally, I think its not a good idea to mimic already existing autoloader logic - of your framework of choice - again on a phpstan-config level. this will easily drift in different directions or at least needs to be kept in sync

[Bl00D4NGEL]

Just to chime in on this:
We also have a custom autoloader that is loaded using the bootstrapFiles parameter of the phpstan.neon file that is used to autoload https://github.com/zetacomponents (previously known as eZ components) which caused the following error for us:

-- --------------------------------------------------------------------------- 
     Error                                                                      
 -- --------------------------------------------------------------------------- 
     Internal error: Internal error: Class 'ezcBaseRepositoryDirectory' not     
     found in file                                                              
     <redacted>
     Run PHPStan with -v option and post the stack trace to:                    
     https://github.com/phpstan/phpstan/issues/new?template=Bug_report.md       
     Internal error: Internal error: Class 'ezcBaseRepositoryDirectory' not     
     found in file                                                              
     <redacted>
     Run PHPStan with -v option and post the stack trace to:                    
     https://github.com/phpstan/phpstan/issues/new?template=Bug_report.md       
     Child process error (exit code 1):                                         
     Child process error (exit code 1):                                         
 -- --------------------------------------------------------------------------- 

Unfortunately I cannot easily reproduce this on my local/docker environment, although it happens in our CI/CD pipeline with Version 1.7.0 and 1.7.1. Adding --debug to phpstan seems to not cause any errors.

[ondrejmirtes]

@Bl00D4NGEL How does your custom autoloader look like?

[ondrejmirtes]

@Bl00D4NGEL Also it'd be nice to run it with -v in CI.

[ondrejmirtes]

FYI I updated documentation on custom autoloaders, make sure that your autoloaders do not do these things: f447463

[ondrejmirtes]

First and foremost, I'm sorry for the trouble. With this static-only reflection functionality released in 1.6.x with bleedingEdge, I thought it's tested enough it's not going to cause this much trouble.

Right now PHPStan uses custom registered autoloaders in AutoloadSourceLocator to figure out which file contains the requested class. This means that it does some black magic in https://github.com/phpstan/phpstan-src/blob/1.7.x/src/Reflection/BetterReflection/SourceLocator/FileReadTrapStreamWrapper.php to observe which file gets required by the autoloader. It means that all file operations are broken when executed within the autoloader. It supports and understands a lot of use-cases but apparently not all of them which is news to me.

[luigi-belli]

I'm experiencing similar issues with an application based OroCRM. What ORO does is dynamically create so-called "extended" classes: you can add a property to a class via the CRM UI, the framework will then take care of creating in a cache directory a new class based on the original one that also contains the new property. It then class_aliases it to to the original one. This aliases must be loaded, in phpstan 1.6 I could use this as a bootstrap file:

<?php

use Oro\Bundle\EntityExtendBundle\Tools\ExtendClassLoadingUtils;

require_once __DIR__.'/../vendor/autoload.php';

$cacheDir = __DIR__.'/../var/cache/testlcl';

ExtendClassLoadingUtils::registerClassLoader($cacheDir);
ExtendClassLoadingUtils::setAliases($cacheDir);

ExtendClassLoadingUtils is located on GitHub at https://github.com/oroinc/platform/blob/master/src/Oro/Bundle/EntityExtendBundle/Tools/ExtendClassLoadingUtils.php

This bootstrap file apparently has no effect on phpstan 1.7.1, as all accesses to "extended" properties are reported as accesses to non-existent properties.

[ondrejmirtes]

Can you please reproduce that in a small repository? @luigi-belli ? I'm trying to understand what people do in their autoloaders and why it might not work.

[luigi-belli]

Here you go: https://github.com/Cube-Solutions/orocrm-phpstan-bugreport
Readme included for setup, thanks!

[ondrejmirtes]

@luigi-belli Requiring me to set up a database and have NodeJS installed really isn't minimal, I'm unable to get the application working. Could you please commit the results of symfony console oro:install and symfony console c:c --env=dev into the repository so that all I have to do is composer install && bin/phpstan? Thanks!