Improve extension attribute handling for standalone modules about phpstan-magento HOT 4 CLOSED

Makes sense and I am still surprised that my tests with the magento/module-inventory-api did seem to work fine. I manually disabled the extension interface autoloader and all the extension attribute errors popped up. After enabling the autoloader, the errors are gone. Not exactly sure what I did wrong, will try to replicate your tests.

How to solve this? I basically see 3 options:

• come up with an automated solution to guess if we have to deal with a Magento application project or a Magento module project. Not sure how that could look like, though
• add a configuration setting to "enable" the lookup via the component registrar
• maybe we could register the project root as a fake module to make the component registrar believe a module is installed

from phpstan-magento.

I found out why my tests have been misleading: The magento/module-inventory-api uses the extension attribute interface but it does not define extension attributes via an extension_attributes.xml file.

I tested it with a different Magento module and can confirm your findings.

I am thinking to fix this with the 2nd solution proposed: By default, the PHPStan extension will scan for all extension_attributes.xml files in the project and take all of them into account. If the user wants to restrict this to only taking enabled modules into account, a configuration flag will be introduced to enable this feature.

from phpstan-magento.

I believe we can use the magentoRoot parameter. Standalone modules do not employ this concept (no Magento application!), so we can make that parameter nullable and set the default to null.

If we use magento root, here's how the constructor would change:

    public function __construct(Cache $cache, ?string $magentoRoot = null)
    {
        $this->cache = $cache;
        $this->componentRegistrar = new ComponentRegistrar();
        if ($magentoRoot !== null) {
            $this->moduleList = new ModuleList(
                new DeploymentConfig(
                    new DeploymentConfigReader(
                        new DirectoryList($magentoRoot),
                        new Filesystem\DriverPool(),
                        new ConfigFilePool()
                    )
                ),
                new Loader(
                    new ModuleDeclarationDom(),
                    new XmlParser(),
                    $this->componentRegistrar,
                    new FileDriver()
                )
            );
        }
    }

and then when finding module dirs we'd do this:

        $moduleDirs = $this->componentRegistrar->getPaths(ComponentRegistrar::MODULE);

        // If magentoRoot was specified, only extract extension attributes from enabled modules
        if ($this->moduleList !== null) {
            $moduleDirs = array_filter(
                $moduleDirs,
                function ($moduleName) {
                    return $this->moduleList->has($moduleName);
                },
                ARRAY_FILTER_USE_KEY
            );
        }

from phpstan-magento.

Regardless of the method we choose to switch between standalone and application module discovery, what should the default be (null Magento root or cwd)?

from phpstan-magento.