Resource discovery: ignore comments/strings when detecting classes

.github/workflows/build.yml

@@ -183,6 +183,7 @@ jobs:
             -
                 name: Create-project with skeleton
                 run: |
+                    set -x
                     composer create-project --ansi "symfony/skeleton:${{ matrix.skeleton }}" skeleton_app
                     cd skeleton_app
                     composer config extra.symfony.allow-contrib true

.github/workflows/upmerge_pr.yaml

@@ -21,8 +21,8 @@ jobs:
             matrix:
                 include:
                     -
-                        base_branch: "1.12"
-                        target_branch: "1.13"
+                        base_branch: "1.13"
+                        target_branch: "1.14"
 
         steps:
             -

composer.json

@@ -60,7 +60,7 @@
         "friendsofsymfony/rest-bundle": "^3.7",
         "jms/serializer-bundle": "^3.5 || ^4.0 || ^5.0",
         "lchrusciel/api-test-case": "^5.0",
-        "matthiasnoback/symfony-dependency-injection-test": "^4.2.1 || ^5.1",
+        "matthiasnoback/symfony-dependency-injection-test": "^6.1.0",
         "pagerfanta/pagerfanta": "^4.4",
         "pamil/phpspec-skip-example-extension": "^4.2",
         "phpspec/phpspec": "^7.5",

phpstan.neon

@@ -62,6 +62,7 @@ parameters:
         - '/Method Sylius\\Bundle\\ResourceBundle\\Event\\ResourceControllerEvent::stop\(\) has no return typehint specified./'
         - '/Method Sylius\\Bundle\\ResourceBundle\\Form\\Extension\\HttpFoundation\\HttpFoundationRequestHandler::handleRequest\(\) has no return typehint specified./'
         - '/Method Sylius\\Bundle\\ResourceBundle\\Grid\\Controller\\ResourcesResolver::getResources\(\) has no return typehint specified./'
+        - '/Method Sylius\\Resource\\Metadata\\Extractor\\AbstractResourceExtractor::getResources\(\) should return array<Sylius\\Resource\\Metadata\\ResourceMetadata> but returns array<Sylius\\Resource\\Metadata\\ResourceMetadata>\|null./'
         - '/Method Sylius\\Resource\\Model\\ResourceInterface::getId\(\) has no return typehint specified./'
         - '/Method Sylius\\Resource\\Model\\TimestampableInterface::setCreatedAt\(\) has no return typehint specified./'
         - '/Method Sylius\\Resource\\Model\\TimestampableInterface::setUpdatedAt\(\) has no return typehint specified./'

psalm.xml

@@ -120,6 +120,7 @@
         <InvalidReturnType>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Doctrine/Persistence/InMemoryRepository.php" />
+                <file name="src/Component/src/Metadata/Extractor/PhpFileResourceExtractor.php" />
             </errorLevel>
         </InvalidReturnType>
 
@@ -173,6 +174,12 @@
             </errorLevel>
         </MoreSpecificImplementedParamType>
 
+        <NullableReturnStatement>
+            <errorLevel type="suppress">
+                <file name="src/Component/src/Metadata/Extractor/PhpFileResourceExtractor.php" />
+            </errorLevel>
+        </NullableReturnStatement>
+
         <NullArgument>
             <errorLevel type="suppress">
                 <directory name="src" />
@@ -188,6 +195,7 @@
         <PossiblyNullArgument>
             <errorLevel type="suppress">
                 <file name="src/Bundle/Grid/Parser/OptionsParser.php" />
+                <file name="src/Component/src/Metadata/Operation/HttpOperationInitiator.php" />
             </errorLevel>
         </PossiblyNullArgument>
 
@@ -321,6 +329,12 @@
             </errorLevel>
         </UnrecognizedStatement>
 
+        <UnresolvableInclude>
+            <errorLevel type="suppress">
+                <file name="src/Component/src/Metadata/Extractor/PhpFileResourceExtractor.php" />
+            </errorLevel>
+        </UnresolvableInclude>
+
         <UnsupportedReferenceUsage>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Doctrine/Persistence/InMemoryRepository.php" />

src/Bundle/Context/Initiator/LegacyRequestContextInitiator.php

@@ -19,6 +19,7 @@
 use Sylius\Resource\Context\Initiator\RequestContextInitiatorInterface;
 use Sylius\Resource\Context\Option\MetadataOption;
 use Sylius\Resource\Metadata\RegistryInterface;
+use Sylius\Resource\Symfony\ExpressionLanguage\VarsResolverInterface;
 use Symfony\Component\HttpFoundation\Request;
 
 final class LegacyRequestContextInitiator implements RequestContextInitiatorInterface
@@ -27,7 +28,17 @@ public function __construct(
         private RegistryInterface $resourceRegistry,
         private RequestConfigurationFactoryInterface $requestConfigurationFactory,
         private RequestContextInitiatorInterface $decorated,
+        private ?VarsResolverInterface $varsResolver = null,
     ) {
+        if (null === $varsResolver) {
+            trigger_deprecation(
+                'sylius/resource-bundle',
+                '1.14',
+                'Not passing an instance of "%s" as the fourth constructor argument for "%s" is deprecated and will not be supported in 2.0.',
+                VarsResolverInterface::class,
+                self::class,
+            );
+        }
     }
 
     public function initializeContext(Request $request): Context
@@ -49,7 +60,19 @@ public function initializeContext(Request $request): Context
         }
 
         $configuration = $this->requestConfigurationFactory->create($metadata, $request);
+        $configurationVars = $this->resolveVars($configuration->getVars());
+
+        $configuration->getParameters()->set('vars', $configurationVars);
 
         return $context->with(new MetadataOption($metadata), new RequestConfigurationOption($configuration));
     }
+
+    private function resolveVars(array $vars): array
+    {
+        if (null === $this->varsResolver) {
+            return $vars;
+        }
+
+        return $this->varsResolver->resolve($vars);
+    }
 }

src/Bundle/DependencyInjection/Configuration.php

@@ -39,6 +39,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->arrayNode('mapping')
                     ->addDefaultsIfNotSet()
                     ->children()
+                        ->arrayNode('imports')
+                            ->prototype('scalar')->end()
+                        ->end()
                         ->arrayNode('paths')
                             ->prototype('scalar')->end()
                         ->end()
@@ -48,6 +51,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->defaultValue('sylius.resource_controller.authorization_checker.disabled')
                     ->cannotBeEmpty()
                 ->end()
+                ->booleanNode('routing_path_bc_layer')
+                    ->defaultTrue()
+                ->end()
             ->end()
         ;
 

src/Bundle/DependencyInjection/SyliusResourceExtension.php

@@ -33,11 +33,14 @@
 use Sylius\Resource\Twig\Context\Factory\ContextFactoryInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\Config\Resource\DirectoryResource;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\Finder\Finder;
 use function Symfony\Component\String\u;
 
 final class SyliusResourceExtension extends Extension implements PrependExtensionInterface
@@ -64,8 +67,10 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $container->setParameter('sylius.resource.mapping', $config['mapping']);
         $container->setParameter('sylius.resource.settings', $config['settings']);
+        $container->setParameter('sylius.routing_path_bc_layer', $config['routing_path_bc_layer']);
         $container->setAlias('sylius.resource_controller.authorization_checker', $config['authorization_checker']);
 
+        $this->registerMetadataConfiguration($container, $config);
         $this->autoRegisterResources($config, $container);
 
         $this->loadPersistence($config['drivers'], $config['resources'], $loader, $container);
@@ -320,4 +325,43 @@ private function loadResources(array $loadedResources, ContainerBuilder $contain
             }
         }
     }
+
+    private function registerMetadataConfiguration(ContainerBuilder $container, array $config): void
+    {
+        $resources = $this->getResourceFilesToWatch($container, $config);
+
+        $container->getDefinition('sylius.metadata.resource_extractor.php_file')->replaceArgument(0, $resources);
+    }
+
+    private function getResourceFilesToWatch(ContainerBuilder $container, array $config): array
+    {
+        $files = [];
+
+        /** @var string $path */
+        foreach ($config['mapping']['imports'] ?? [] as $path) {
+            if (is_dir($path)) {
+                foreach (Finder::create()->followLinks()->files()->in($path)->name('/\.php$/')->sortByName() as $file) {
+                    $files[] = $file->getRealPath();
+                }
+
+                $container->addResource(new DirectoryResource($path, '/\.php$/'));
+
+                continue;
+            }
+
+            if ($container->fileExists($path, false)) {
+                if (!str_ends_with($path, '.php')) {
+                    throw new RuntimeException(\sprintf('Unsupported mapping type in "%s", supported type is PHP.', $path));
+                }
+
+                $files[] = $path;
+
+                continue;
+            }
+
+            throw new RuntimeException(\sprintf('Could not open file or directory "%s".', $path));
+        }
+
+        return $files;
+    }
 }

src/Bundle/Resources/config/services/context.xml

@@ -23,6 +23,7 @@
             <argument type="service" id="sylius.resource_registry" />
             <argument type="service" id="sylius.resource_controller.request_configuration_factory" />
             <argument type="service" id=".inner" />
+            <argument type="service" id="sylius.expression_language.vars_resolver.metadata" />
         </service>
     </services>
 </container>

src/Bundle/Resources/config/services/expression_language.xml

@@ -13,23 +13,36 @@
 
 <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
+        <service id="sylius.metadata.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" />
         <service id="sylius.resource_factory.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" />
         <service id="sylius.repository.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" />
         <service id="sylius.routing.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" />
 
         <service id="sylius.expression_language.variables.token" class="Sylius\Resource\Symfony\ExpressionLanguage\TokenVariables">
             <argument type="service" id="security.token_storage" on-invalid="null" />
+            <tag name="sylius.metadata_variables" />
             <tag name="sylius.resource_factory_variables" />
             <tag name="sylius.repository_variables" />
         </service>
 
         <service id="sylius.expression_language.variables.request" class="Sylius\Resource\Symfony\ExpressionLanguage\RequestVariables">
             <argument type="service" id="request_stack" />
+            <tag name="sylius.metadata_variables" />
             <tag name="sylius.resource_factory_variables" />
             <tag name="sylius.repository_variables" />
             <tag name="sylius.routing_variables" />
         </service>
 
+        <service id="sylius.expression_language.variables.sylius_repositories" class="Sylius\Resource\Symfony\ExpressionLanguage\SyliusRepositoriesVariables">
+            <argument type="tagged_locator" tag="sylius.repository" />
+            <tag name="sylius.metadata_variables" />
+            <tag name="sylius.resource_factory_variables" />
+        </service>
+
+        <service id="sylius.expression_language.variables_collection.metadata" class="Sylius\Resource\Symfony\ExpressionLanguage\VariablesCollection">
+            <argument type="tagged_iterator" tag="sylius.metadata_variables" />
+        </service>
+
         <service id="sylius.expression_language.variables_collection.factory" class="Sylius\Resource\Symfony\ExpressionLanguage\VariablesCollection">
             <argument type="tagged_iterator" tag="sylius.resource_factory_variables" />
         </service>
@@ -42,19 +55,37 @@
             <argument type="tagged_iterator" tag="sylius.routing_variables" />
         </service>
 
+        <service id="sylius.expression_language.providers.throw_not_found_on_null" class="Sylius\Resource\Symfony\ExpressionLanguage\Provider\ThrowNotFoundOnNullExpressionFunctionProvider">
+            <tag name="sylius.metadata_providers" />
+            <tag name="sylius.resource_factory_providers" />
+        </service>
+
+        <service id="sylius.expression_language.vars_resolver.metadata" class="Sylius\Resource\Symfony\ExpressionLanguage\VarsResolver">
+            <argument type="service" id="sylius.expression_language.argument_parser.metadata" />
+        </service>
+
+        <service id="sylius.expression_language.argument_parser.metadata" class="Sylius\Resource\Symfony\ExpressionLanguage\ArgumentParser">
+            <argument type="service" id="sylius.metadata.expression_language" />
+            <argument type="service" id="sylius.expression_language.variables_collection.metadata"  />
+            <argument type="tagged_iterator" tag="sylius.metadata_providers" />
+        </service>
+
         <service id="sylius.expression_language.argument_parser.factory" class="Sylius\Resource\Symfony\ExpressionLanguage\ArgumentParser">
             <argument type="service" id="sylius.resource_factory.expression_language" />
             <argument type="service" id="sylius.expression_language.variables_collection.factory"  />
+            <argument type="tagged_iterator" tag="sylius.resource_factory_providers" />
         </service>
 
         <service id="sylius.expression_language.argument_parser.repository" class="Sylius\Resource\Symfony\ExpressionLanguage\ArgumentParser">
             <argument type="service" id="sylius.repository.expression_language" />
             <argument type="service" id="sylius.expression_language.variables_collection.repository"  />
+            <argument type="tagged_iterator" tag="sylius.repository_providers" />
         </service>
 
         <service id="sylius.expression_language.argument_parser.routing" class="Sylius\Resource\Symfony\ExpressionLanguage\ArgumentParser">
             <argument type="service" id="sylius.routing.expression_language" />
             <argument type="service" id="sylius.expression_language.variables_collection.routing"  />
+            <argument type="tagged_iterator" tag="sylius.routing_providers" />
         </service>
     </services>
 </container>

src/Bundle/Resources/config/services/metadata/extractor.xml

@@ -0,0 +1,8 @@
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="sylius.metadata.resource_extractor.php_file" class="Sylius\Resource\Metadata\Extractor\PhpFileResourceExtractor" public="false">
+            <argument type="collection" />
+            <argument type="service" id="service_container" />
+        </service>
+    </services>
+</container>

src/Bundle/Resources/config/services/metadata/resource_class_list.xml

@@ -22,5 +22,15 @@
             <argument>%sylius.resource.mapping%</argument>
         </service>
         <service id="Sylius\Resource\Metadata\Resource\Factory\AttributesResourceClassListFactory" alias="sylius.metadata.resource_class_list.factory.attributes" />
+
+        <service id="sylius.metadata.resource_class_list.factory.php_file"
+                 class="Sylius\Resource\Metadata\Resource\Factory\PhpFileResourceClassListFactory"
+                 decorates="sylius.metadata.resource_class_list.factory"
+                 decoration-priority="100"
+        >
+            <argument type="service" id="sylius.metadata.resource_extractor.php_file" />
+            <argument type="service" id=".inner" />
+        </service>
+        <service id="Sylius\Resource\Metadata\Resource\Factory\PhpFileResourceClassListFactory" alias="sylius.metadata.resource_class_list.factory.php_file" />
     </services>
 </container>

src/Bundle/Resources/config/services/metadata/resource_metadata_collection.xml

@@ -17,16 +17,28 @@
             <tag name="cache.pool" />
         </service>
 
+        <service id="sylius.resource_metadata_collection.factory" alias="sylius.resource_metadata_collection.factory.attributes" />
+        <service id="Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface" alias="sylius.resource_metadata_collection.factory.attributes" />
+
         <service id="sylius.resource_metadata_collection.factory.attributes" class="Sylius\Resource\Metadata\Resource\Factory\AttributesResourceMetadataCollectionFactory">
             <argument type="service" id="sylius.resource_registry" />
             <argument type="service" id="sylius.routing.factory.operation_route_name_factory" />
         </service>
-        <service id="Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface" alias="sylius.resource_metadata_collection.factory.attributes" />
-        <service id="sylius.resource_metadata_collection.factory" alias="sylius.resource_metadata_collection.factory.attributes" />
+
+        <service id="sylius.resource_metadata_collection.factory.php_file"
+                 class="Sylius\Resource\Metadata\Resource\Factory\PhpFileResourceMetadataCollectionFactory"
+                 decorates="sylius.resource_metadata_collection.factory"
+                 decoration-priority="400"
+        >
+            <argument type="service" id="sylius.resource_registry" />
+            <argument type="service" id="sylius.routing.factory.operation_route_name_factory" />
+            <argument type="service" id="sylius.metadata.resource_extractor.php_file" />
+            <argument type="service" id=".inner" />
+        </service>
 
         <service id="sylius.resource_metadata_collection.factory.state_machine"
                  class="Sylius\Resource\Metadata\Resource\Factory\StateMachineResourceMetadataCollectionFactory"
-                 decorates="sylius.resource_metadata_collection.factory.attributes"
+                 decorates="sylius.resource_metadata_collection.factory"
                  decoration-priority="300"
         >
             <argument type="service" id="sylius.resource_registry" />
@@ -83,15 +95,15 @@
 
         <service id="sylius.resource_metadata_collection.factory.templates_dir"
                  class="Sylius\Resource\Metadata\Resource\Factory\TemplatesDirResourceMetadataCollectionFactory"
-                 decorates="sylius.resource_metadata_collection.factory.attributes"
+                 decorates="sylius.resource_metadata_collection.factory"
         >
             <argument type="service" id=".inner" />
             <argument>%sylius.resource.settings%</argument>
         </service>
 
         <service id="sylius.resource_metadata_collection.factory.cached"
                  class="Sylius\Resource\Metadata\Resource\Factory\CachedResourceMetadataCollectionFactory"
-                 decorates="sylius.resource_metadata_collection.factory.attributes"
+                 decorates="sylius.resource_metadata_collection.factory"
                  decoration-priority="-10"
         >
             <argument type="service" id="sylius.cache.metadata.resource_collection" />

src/Bundle/Resources/config/services/metadata/resource_metadata_operation.xml

@@ -16,6 +16,7 @@
         <service id="sylius.resource_metadata_operation.initiator.http_operation" class="Sylius\Resource\Metadata\Operation\HttpOperationInitiator">
             <argument type="service" id="sylius.resource_registry" />
             <argument type="service" id="sylius.resource_metadata_collection.factory" />
+            <argument type="service" id="sylius.expression_language.vars_resolver.metadata" />
         </service>
         <service id="Sylius\Resource\Metadata\Operation\HttpOperationInitiatorInterface" alias="sylius.resource_metadata_operation.initiator.http_operation" />
     </services>