Failure with `phpstan/phpstan-phpunit` and PHPStan cache usage

[Wohlie]

Hi, I'm using this extension together with phpstan/phpstan-phpunit.

bitexpert/phpstan-magento         v0.29.0 PHPStan Magento Extension
phpstan/phpstan                   1.10.7  PHPStan - PHP Static Analysis Tool
phpstan/phpstan-phpunit           1.3.10  PHPUnit extensions and rules for PHPStan

Without PHPStan cache, everything works fine. If I enable PHPStan cache, I receive get the following error on the second run, where that cache is used:

In ExtensionInterfaceAutoloader.php line 93:
                                                                                                            
  [InvalidArgumentException]                                                                                
  PHPStan\PhpDoc\PHPUnit\MockObjectTypeNodeResolverInterface does not exist and has no extension interface  
                                                                                                            

Exception trace:
  at /opt/composer/vendor/bitexpert/phpstan-magento/src/bitExpert/PHPStan/Magento/Autoload/ExtensionInterfaceAutoloader.php:93
 bitExpert\PHPStan\Magento\Autoload\ExtensionInterfaceAutoloader->getFileContents() at /opt/composer/vendor/bitexpert/phpstan-magento/src/bitExpert/PHPStan/Magento/Autoload/ExtensionInterfaceAutoloader.php:69
 bitExpert\PHPStan\Magento\Autoload\ExtensionInterfaceAutoloader->autoload() at n/a:n/a
 ReflectionClass->__construct() at /opt/composer/vendor/bitexpert/phpstan-magento/src/bitExpert/PHPStan/Magento/Autoload/ExtensionAutoloader.php:87
 bitExpert\PHPStan\Magento\Autoload\ExtensionAutoloader->getFileContents() at /opt/composer/vendor/bitexpert/phpstan-magento/src/bitExpert/PHPStan/Magento/Autoload/ExtensionAutoloader.php:70
 bitExpert\PHPStan\Magento\Autoload\ExtensionAutoloader->autoload() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/SourceLocator/AutoloadFunctionsSourceLocator.php:41
 PHPStan\Reflection\BetterReflection\SourceLocator\AutoloadFunctionsSourceLocator->locateIdentifier() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/SourceLocator/Type/AggregateSourceLocator.php:26
 PHPStan\BetterReflection\SourceLocator\Type\AggregateSourceLocator->locateIdentifier() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/SourceLocator/Type/MemoizingSourceLocator.php:33
 PHPStan\BetterReflection\SourceLocator\Type\MemoizingSourceLocator->locateIdentifier() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/Reflector/DefaultReflector.php:32
 PHPStan\BetterReflection\Reflector\DefaultReflector->reflectClass() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/Reflector/MemoizingReflector.php:45
 PHPStan\Reflection\BetterReflection\Reflector\MemoizingReflector->reflectClass() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/BetterReflection/BetterReflectionProvider.php:149
 PHPStan\Reflection\BetterReflection\BetterReflectionProvider->hasClass() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Reflection/ReflectionProvider/MemoizingReflectionProvider.php:35
 PHPStan\Reflection\ReflectionProvider\MemoizingReflectionProvider->hasClass() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/ResultCache/ResultCacheManager.php:552
 PHPStan\Analyser\ResultCache\ResultCacheManager->getProjectExtensionFiles() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/ResultCache/ResultCacheManager.php:528
 PHPStan\Analyser\ResultCache\ResultCacheManager->save() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/ResultCache/ResultCacheManager.php:363
 PHPStan\Analyser\ResultCache\ResultCacheManager->PHPStan\Analyser\ResultCache\{closure}() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Analyser/ResultCache/ResultCacheManager.php:386
 PHPStan\Analyser\ResultCache\ResultCacheManager->process() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseApplication.php:108
 PHPStan\Command\AnalyseApplication->analyse() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseCommand.php:173
 PHPStan\Command\AnalyseCommand->execute() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Command/Command.php:259
 _PHPStan_e0e4f009c\Symfony\Component\Console\Command\Command->run() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:870
 _PHPStan_e0e4f009c\Symfony\Component\Console\Application->doRunCommand() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:261
 _PHPStan_e0e4f009c\Symfony\Component\Console\Application->doRun() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:157
 _PHPStan_e0e4f009c\Symfony\Component\Console\Application->run() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan:124
 _PHPStan_e0e4f009c\{closure}() at phar:///opt/composer/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan:125
 require() at /opt/composer/vendor/phpstan/phpstan/phpstan:8
 include() at /usr/local/bin/phpstan:120

analyse [-c|--configuration CONFIGURATION] [-l|--level LEVEL] [--no-progress] [--debug] [-a|--autoload-file AUTOLOAD-FILE] [--error-format ERROR-FORMAT] [-b|--generate-baseline [GENERATE-BASELINE]] [--allow-empty-baseline] [--memory-limit MEMORY-LIMIT] [--xdebug] [--fix] [--watch] [--pro] [--] [<paths>...]

My configuration is the following:

includes:
    - /opt/composer/vendor/bitexpert/phpstan-magento/extension.neon
    - /opt/composer/vendor/phpstan/phpstan-phpunit/extension.neon

parameters:
    level: 7
    checkMissingIterableValueType: false
    tmpDir: ./volumes/phpstan
    bootstrapFiles:
        - ./src/vendor/autoload.php
    magento:
        magentoRoot: ./src

Any thoughts?

[shochdoerfer]

Thanks for opening your first issue here!

Weird problem, not exactly sure what is going on. Somehow the Extension Attribute Autoloaders get triggered even though the classname PHPStan\PhpDoc\PHPUnit\MockObjectTypeNodeResolverInterface does not match the regex in both autoloaders.

Let me try to run a few tests to see if I can reproduce the problem somehow.

[shochdoerfer]

Sadly, I can't reproduce your issue so far. I installed the PHPUnit extension in a test project and with or without the tmpDir setting, PHPStan works fine when I execute it multiple times in a row.

What confuses me a bit is that you write it fails when you enable the cache. PHPStan always uses a file cache. If you do not define the tmpDir setting it will default to /tmp. Could this be a problem with your ./volumes/phpstan path?

Any chance that you can share a reproducible test case with me?

[Wohlie]

Hi @shochdoerfer, thanks for your hint about ./volumes/phpstan and caching behavior about PHPStan. But the default caching behavior of PHPStan will not take into account, because it will run in docker. So I need to change the cache path. But I can try, what's happened, if I use a volume on PHPStan default cache folder. I will also check the behavior without docker.

[shochdoerfer]

@Wohlie have you been able to figure out why things are failing?

[Wohlie]

Hi @shochdoerfer, I have tested without overriding the cache directory and have the same problem. If I change the config magentoRoot to a path that not exists, I don't get this error, but PHPStan also will not understand Magento framework.

Here is my example. Make sure you mount Magento root folder to /var/www/default/src.

docker-entrypoint.sh

#!/usr/bin/env bash
phpstan analyze vendor/magento/language-de_de
phpstan analyze vendor/magento/language-de_de

Dockerfile

FROM composer:2.2 as composer
FROM php:8.1-alpine

COPY --from=composer /usr/bin/composer /usr/local/bin/composer

ARG COMPOSER_ALLOW_SUPERUSER=1
ARG COMPOSER_HOME="/opt/composer"
ARG COMPOSER_BIN_DIR="/usr/local/bin"
ARG COMPOSER_CACHE_DIR="/var/cache/composer"

RUN echo 'memory_limit = 1G' > /usr/local/etc/php/conf.d/99-memory-limit.ini

RUN --mount=target=/var/cache,type=cache,sharing=locked \
    apk add bash git

RUN --mount=target=/var/cache,type=cache,sharing=locked \
    composer global require \
      phpstan/phpstan \
      bitexpert/phpstan-magento \
      phpstan/phpstan-phpunit

RUN mkdir -p "/var/www/default/src"
WORKDIR /var/www/default/src

COPY docker-entrypoint.sh /docker-entrypoint.sh
ENTRYPOINT ["/docker-entrypoint.sh"]

RUN addgroup -g 1000 -S non-root \
    && adduser -u 1000 -S non-root -G non-root -s /bin/bash
USER non-root

Place this phpstan.neon in the Magento root folder.

includes:
    - /opt/composer/vendor/bitexpert/phpstan-magento/extension.neon
    - /opt/composer/vendor/phpstan/phpstan-phpunit/extension.neon

parameters:
    level: 7
    checkMissingIterableValueType: false
    magento:
        magentoRoot: .

[rommelfreddy]

can confirm this issue by using rector/rector and symplify/easy-coding-standard.

Also debugged a little bit, but didn't find the issue.

i'll have another look into this issue, if i'll find the time for it.

[shochdoerfer]

@rommelfreddy please provide a proper test case so that I can reproduce the issue and debug it.

[rommelfreddy]

digged a little bit deeper.
found out that the error got triggered by
/vendor/rector/rector/vendor/phpstan/phpstan/phpstan.phar/vendor/ondrejmirtes/better-reflection/src/SourceLocator/SourceStubber/PhpStormStubs/CachingVisitor.php Line 159

but do not have any idea what the context is. and also no clue who is calling this.
maybe it is a issue in rector. The same error has been already reported in the rector repo: rectorphp/rector#7430
but they already closed the issue.

i am using the latest versions of

• bitExpert/phpstan-magento
• rector/rector/
• phpstan/phpstan
• magento/ce

[rommelfreddy]

The issue which will happen is that the cache-folder can not created.
The error, which got printed is not the actual error.
The printed error does already occurs before trying to create the cache-dir (Class FileStorageCache).
The method error_get_last will return the printed error, but this is not the error, why the cache-folder got not created.
Sadly i didn't figured out why the cache-folder got not created.

But maybe by the following issue:

If I have the following class, the error exists for me.

<?php

class MyClass
{
    /**
     * @var StoreFactory
     */
    private $myFactory;
}

Please notice, that i missed the import or the FQCN for the factory.

If I have the following class, the error disappears.

<?php

class MyClass
{
    /**
     * @var \Magento\Store\Model\StoreFactory
     */
    private $myFactory;
}

In my case the missing import is in a third-party package, so i only could fix the issue via composer-patches.

One addition:
it seems like that there are also general problems with the factory an bitexpert/phpstan-magento.
Did not figured out yet.

[shochdoerfer]

@rommelfreddy thx for digging deeper, "interesting" behavior. Not exactly sure why the cache file can't get written in your case. Maybe it's an idea to do an additional file_exists() check before requiring the file.

[rommelfreddy]

already tried this :D

[rommelfreddy]

need to correct me. The factory in my example does already exist as defined class (not autogenerated) in the same namespace (so also in the same folder).

It seems like, that there is something wrong with generating the factories.

Sadly i am not able to use xdebug within this scope. don't know why.

[rommelfreddy]

will you investigate more into this to fix this issue? it is a very annoying bug

[shochdoerfer]

@rommelfreddy my bad was quite busy with other stuff and lost track of this issue. Any chance you can provide me with a simple demo project to be able to reproduce the issue?