Add external PHP file configuration for routing

psalm.xml

@@ -116,6 +116,12 @@
                 <file name="src/Bundle/Grid/Parser/OptionsParser.php" />
             </errorLevel>
         </InvalidReturnStatement>
+
+        <InvalidNullableReturnType>
+            <errorLevel type="suppress">
+                <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+            </errorLevel>
+        </InvalidNullableReturnType>
 
         <InvalidReturnType>
             <errorLevel type="suppress">
@@ -179,6 +185,12 @@
             </errorLevel>
         </NullArgument>
 
+        <NullableReturnStatement>
+            <errorLevel type="suppress">
+                <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+            </errorLevel>
+        </NullableReturnStatement>
+
         <PossiblyFalseOperand>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Reflection/ClassInfoTrait.php" />
@@ -320,6 +332,12 @@
                 <directory name="src/Component/legacy/src/Translation" />
             </errorLevel>
         </UnrecognizedStatement>
+
+        <UnresolvableInclude>
+            <errorLevel type="suppress">
+                <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+            </errorLevel>
+        </UnresolvableInclude>
 
         <UnsupportedReferenceUsage>
             <errorLevel type="suppress">

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()

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.resource.metadata.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,12 +17,29 @@
             <tag name="cache.pool" />
         </service>
 
-        <service id="sylius.resource_metadata_collection.factory.attributes" class="Sylius\Resource\Metadata\Resource\Factory\AttributesResourceMetadataCollectionFactory">
+        <service id="sylius.resource.metadata.extractor.php_file" class="Sylius\Resource\Metadata\Extractor\PhpFileMetadataExtractor">
+            <argument>%sylius.resource.mapping%</argument>
+            <argument type="service" id="service_container" />
+        </service>
+
+        <service id="sylius.resource_metadata_collection.factory" alias="sylius.resource_metadata_collection.factory.php_file" />
+        <service id="Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface" alias="sylius.resource_metadata_collection.factory.php_file" />
+
+        <service id="sylius.resource_metadata_collection.factory.php_file" class="Sylius\Resource\Metadata\Resource\Factory\PhpFileResourceMetadataCollectionFactory">
+            <argument type="service" id="sylius.resource_registry" />
+            <argument type="service" id="sylius.routing.factory.operation_route_name_factory" />
+            <argument type="service" id="sylius.resource.metadata.extractor.php_file" />
+        </service>
+
+        <service id="sylius.resource_metadata_collection.factory.attributes"
+                 class="Sylius\Resource\Metadata\Resource\Factory\AttributesResourceMetadataCollectionFactory"
+                 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=".inner" />
         </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.state_machine"
                  class="Sylius\Resource\Metadata\Resource\Factory\StateMachineResourceMetadataCollectionFactory"

src/Component/spec/Symfony/Routing/Factory/AttributesOperationRouteFactorySpec.php

@@ -42,7 +42,6 @@ function let(
             new AttributesResourceMetadataCollectionFactory(
                 $resourceRegistry->getWrappedObject(),
                 new OperationRouteNameFactory(),
-                'symfony',
             ),
         );
     }

src/Component/src/Metadata/Extractor/MetadataExtractorInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Metadata\Extractor;
+
+use Sylius\Resource\Metadata\ResourceMetadata;
+
+interface MetadataExtractorInterface
+{
+    /**
+     * @return ResourceMetadata[]
+     */
+    public function extract(): array;
+}

src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php

@@ -0,0 +1,158 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Metadata\Extractor;
+
+use Psr\Container\ContainerInterface;
+use Sylius\Resource\Metadata\ResourceMetadata;
+use Symfony\Component\DependencyInjection\ContainerInterface as SymfonyContainerInterface;
+use Symfony\Component\Finder\Finder;
+
+final class PhpFileMetadataExtractor implements MetadataExtractorInterface
+{
+    private array $collectedParameters = [];
+
+    public function __construct(
+        private readonly array $resourceMapping,
+        private readonly ?ContainerInterface $container = null,
+    ) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function extract(): array
+    {
+        $metadata = [];
+
+        foreach ($this->getResourceFilePaths() as $filePath) {
+            if (!is_readable($filePath)) {
+                continue;
+            }
+
+            $resource = $this->getPHPFileClosure($filePath)();
+
+            if (!$resource instanceof ResourceMetadata) {
+                continue;
+            }
+
+            $resourceReflection = new \ReflectionClass($resource);
+
+            foreach ($resourceReflection->getProperties() as $property) {
+                $property->setAccessible(true);
+                $resolvedValue = $this->resolve($property->getValue($resource));
+                $property->setValue($resource, $resolvedValue);
+            }
+
+            $metadata[] = $resource;
+        }
+
+        return $metadata;
+    }
+
+    private function getResourceFilePaths(): iterable
+    {
+        foreach ($this->createFinder() as $file) {
+            yield $file->getPathname();
+        }
+    }
+
+    private function createFinder(): Finder
+    {
+        $finder = (new Finder())->files();
+
+        foreach ($this->resourceMapping['imports'] ?? [] as $path) {
+            $finder->in($path);
+        }
+
+        return $finder->files();
+    }
+
+    /**
+     * Scope isolated include.
+     *
+     * Prevents access to $this/self from included files.
+     */
+    private function getPHPFileClosure(string $filePath): \Closure
+    {
+        return \Closure::bind(function () use ($filePath): mixed {
+            return require $filePath;
+        }, null, null);
+    }
+
+    /**
+     * Recursively replaces placeholders with the service container parameters.
+     *
+     * @see https://github.com/symfony/symfony/blob/6fec32c/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
+     *
+     * @param mixed $value The source which might contain "%placeholders%"
+     *
+     * @throws \RuntimeException When a container value is not a string or a numeric value
+     *
+     * @return mixed The source with the placeholders replaced by the container
+     *               parameters. Arrays are resolved recursively.
+     */
+    private function resolve(mixed $value): mixed
+    {
+        $container = $this->container;
+
+        if (null === $container) {
+            return $value;
+        }
+
+        if (\is_array($value)) {
+            foreach ($value as $key => $val) {
+                $value[$key] = $this->resolve($val);
+            }
+
+            return $value;
+        }
+
+        if (!\is_string($value)) {
+            return $value;
+        }
+
+        $escapedValue = preg_replace_callback('/%%|%([^%\s]++)%/', function ($match) use ($value, $container) {
+            $parameter = $match[1] ?? null;
+
+            // skip %%
+            if (!isset($parameter)) {
+                return '%%';
+            }
+
+            if (preg_match('/^env\(\w+\)$/', $parameter)) {
+                throw new \RuntimeException(\sprintf('Using "%%%s%%" is not allowed in routing configuration.', $parameter));
+            }
+
+            if (\array_key_exists($parameter, $this->collectedParameters)) {
+                return $this->collectedParameters[$parameter];
+            }
+
+            if ($container instanceof SymfonyContainerInterface) {
+                $resolved = $container->getParameter($parameter);
+            } else {
+                $resolved = $container->get($parameter);
+            }
+
+            if (\is_string($resolved) || is_numeric($resolved)) {
+                $this->collectedParameters[$parameter] = $resolved;
+
+                return (string) $resolved;
+            }
+
+            throw new \RuntimeException(\sprintf('The container parameter "%s", used in the resource configuration value "%s", must be a string or numeric, but it is of type %s.', $parameter, $value, \gettype($resolved)));
+        }, $value);
+
+        return str_replace('%%', '%', $escapedValue ?? '');
+    }
+}

src/Component/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php

@@ -29,12 +29,16 @@ final class AttributesResourceMetadataCollectionFactory implements ResourceMetad
     public function __construct(
         private RegistryInterface $resourceRegistry,
         private OperationRouteNameFactory $operationRouteNameFactory,
+        private ?ResourceMetadataCollectionFactoryInterface $decorated = null,
     ) {
     }
 
     public function create(string $resourceClass): ResourceMetadataCollection
     {
         $resourceMetadataCollection = new ResourceMetadataCollection();
+        if ($this->decorated) {
+            $resourceMetadataCollection = $this->decorated->create($resourceClass);
+        }
 
         $attributes = ClassReflection::getClassAttributes($resourceClass);
 

src/Component/src/Metadata/Resource/Factory/PhpFileResourceClassListFactory.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Metadata\Resource\Factory;
+
+use Sylius\Resource\Metadata\Extractor\MetadataExtractorInterface;
+use Sylius\Resource\Metadata\Resource\ResourceClassList;
+
+final class PhpFileResourceClassListFactory implements ResourceClassListFactoryInterface
+{
+    use OperationDefaultsTrait;
+
+    public function __construct(
+        private readonly MetadataExtractorInterface $metadataExtractor,
+        private readonly ?ResourceClassListFactoryInterface $decorated = null,
+    ) {
+    }
+
+    public function create(): ResourceClassList
+    {
+        $classes = [];
+
+        if ($this->decorated) {
+            foreach ($this->decorated->create() as $resourceClass) {
+                $classes[$resourceClass] = true;
+            }
+        }
+
+        foreach ($this->metadataExtractor->extract() as $resource) {
+            $resourceClass = $resource->getClass();
+
+            if (null === $resourceClass) {
+                continue;
+            }
+
+            $classes[$resourceClass] = true;
+        }
+
+        return new ResourceClassList(array_keys($classes));
+    }
+}