Add route condition on new routing system (#1050)

NoResponseMate · web-flow · commit cbc846c1d40f · 2025-07-10T10:27:39.000+02:00
| Q | A | --------------- | ----- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Related tickets | | License | MIT The system works for the bc-layer usage. We just need to have two route names ```php new Index(routeName: '_sylius_admin_product_index', grid: 'sylius_admin_product'), ``` **bc-layer disabled** ![image](https://github.com/user-attachments/assets/b1dca027-fe04-4c8d-b675-6996733cc118) **bc-layer enabled** ![image](https://github.com/user-attachments/assets/e469f043-0bc9-4e0e-a135-7a4e3811fc7b)
diff --git a/src/Component/legacy/tests/Dummy/DummyResourceWithRouteCondition.php b/src/Component/legacy/tests/Dummy/DummyResourceWithRouteCondition.php
@@ -0,0 +1,29 @@
+<?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\Component\Resource\Tests\Dummy;
+
+use Sylius\Resource\Metadata\AsResource;
+use Sylius\Resource\Metadata\Create;
+use Sylius\Resource\Metadata\Index;
+use Sylius\Resource\Metadata\Show;
+use Sylius\Resource\Metadata\Update;
+
+#[AsResource(alias: 'app.dummy', routeCondition: 'custom_condition')]
+#[Create]
+#[Update]
+#[Index]
+#[Show]
+final class DummyResourceWithRouteCondition
+{
+}
diff --git a/src/Component/spec/Symfony/Routing/Factory/OperationRouteFactorySpec.php b/src/Component/spec/Symfony/Routing/Factory/OperationRouteFactorySpec.php
@@ -307,4 +307,22 @@ function it_generates_routes_with_requirements(
 
         $route->getRequirements()->shouldReturn(['type' => 'country|province|zone']);
     }
+
+    function it_generates_routes_with_condition(
+        OperationRoutePathFactoryInterface $routePathFactory,
+    ): void {
+        $operation = new Index(routeCondition: 'custom_condition');
+
+        $metadata = Metadata::fromAliasAndConfiguration('app.dummy', ['driver' => 'dummy_driver']);
+
+        $routePathFactory->createRoutePath($operation, 'dummies')->willReturn('/dummies')->shouldBeCalled();
+
+        $route = $this->create(
+            $metadata,
+            new ResourceMetadata(alias: 'app.dummy'),
+            $operation,
+        );
+
+        $route->getCondition()->shouldReturn('custom_condition');
+    }
 }
diff --git a/src/Component/src/Metadata/Api/Delete.php b/src/Component/src/Metadata/Api/Delete.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'delete',
             name: $name,
diff --git a/src/Component/src/Metadata/Api/Get.php b/src/Component/src/Metadata/Api/Get.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'get',
             name: $name,
diff --git a/src/Component/src/Metadata/Api/GetCollection.php b/src/Component/src/Metadata/Api/GetCollection.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'get_collection',
             name: $name,
diff --git a/src/Component/src/Metadata/Api/Patch.php b/src/Component/src/Metadata/Api/Patch.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'patch',
             name: $name,
diff --git a/src/Component/src/Metadata/Api/Post.php b/src/Component/src/Metadata/Api/Post.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'post',
             name: $name,
diff --git a/src/Component/src/Metadata/Api/Put.php b/src/Component/src/Metadata/Api/Put.php
@@ -27,6 +27,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -58,6 +59,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'put',
             name: $name,
diff --git a/src/Component/src/Metadata/ApplyStateMachineTransition.php b/src/Component/src/Metadata/ApplyStateMachineTransition.php
@@ -24,6 +24,7 @@ public function __construct(
         ?string $path = null,
         ?string $routeName = null,
         ?string $routePrefix = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -53,6 +54,7 @@ public function __construct(
             path: $path,
             routeName: $routeName,
             routePrefix: $routePrefix,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? $stateMachineTransition ?? 'apply_state_machine_transition',
             name: $name,
diff --git a/src/Component/src/Metadata/AsResource.php b/src/Component/src/Metadata/AsResource.php
@@ -22,6 +22,7 @@ public function __construct(
         private ?string $formType = null,
         private ?string $templatesDir = null,
         private ?string $routePrefix = null,
+        private ?string $routeCondition = null,
         private ?string $name = null,
         private ?string $pluralName = null,
         private ?string $applicationName = null,
@@ -44,6 +45,7 @@ public function toMetadata(): ResourceMetadata
             formType: $this->formType,
             templatesDir: $this->templatesDir,
             routePrefix: $this->routePrefix,
+            routeCondition: $this->routeCondition,
             name: $this->name,
             pluralName: $this->pluralName,
             applicationName: $this->applicationName,
diff --git a/src/Component/src/Metadata/BulkDelete.php b/src/Component/src/Metadata/BulkDelete.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -52,6 +53,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'bulk_delete',
             name: $name,
diff --git a/src/Component/src/Metadata/BulkUpdate.php b/src/Component/src/Metadata/BulkUpdate.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -59,6 +60,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'bulk_update',
             name: $name,
diff --git a/src/Component/src/Metadata/Create.php b/src/Component/src/Metadata/Create.php
@@ -28,6 +28,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -66,6 +67,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'create',
             name: $name,
diff --git a/src/Component/src/Metadata/Delete.php b/src/Component/src/Metadata/Delete.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -57,6 +58,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'delete',
             name: $name,
diff --git a/src/Component/src/Metadata/HttpOperation.php b/src/Component/src/Metadata/HttpOperation.php
@@ -27,6 +27,7 @@ public function __construct(
         protected ?string $routeName = null,
         protected ?string $routePrefix = null,
         protected ?array $routeRequirements = null,
+        protected ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -149,6 +150,19 @@ public function withRouteRequirements(array $routeRequirements): self
         return $self;
     }
 
+    public function getRouteCondition(): ?string
+    {
+        return $this->routeCondition;
+    }
+
+    public function withRouteCondition(?string $routeCondition): self
+    {
+        $self = clone $this;
+        $self->routeCondition = $routeCondition;
+
+        return $self;
+    }
+
     public function getTwigContextFactory(): callable|string|null
     {
         return $this->twigContextFactory;
diff --git a/src/Component/src/Metadata/Index.php b/src/Component/src/Metadata/Index.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -57,6 +58,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'index',
             name: $name,
diff --git a/src/Component/src/Metadata/Resource/Factory/OperationDefaultsTrait.php b/src/Component/src/Metadata/Resource/Factory/OperationDefaultsTrait.php
@@ -106,7 +106,11 @@ private function getOperationWithDefaults(
 
         if ($operation instanceof HttpOperation) {
             if (null === $operation->getRoutePrefix()) {
-                $operation = $operation->withRoutePrefix($resource->getRoutePrefix() ?? null);
+                $operation = $operation->withRoutePrefix($resource->getRoutePrefix());
+            }
+
+            if (null === $operation->getRouteCondition()) {
+                $operation = $operation->withRouteCondition($resource->getRouteCondition());
             }
 
             if (null === $operation->getTwigContextFactory()) {
diff --git a/src/Component/src/Metadata/ResourceMetadata.php b/src/Component/src/Metadata/ResourceMetadata.php
@@ -23,6 +23,7 @@ public function __construct(
         private ?string $formType = null,
         private ?string $templatesDir = null,
         private ?string $routePrefix = null,
+        private ?string $routeCondition = null,
         private ?string $name = null,
         private ?string $pluralName = null,
         private ?string $applicationName = null,
@@ -155,6 +156,19 @@ public function withRoutePrefix(string $routePrefix): self
         return $self;
     }
 
+    public function getRouteCondition(): ?string
+    {
+        return $this->routeCondition;
+    }
+
+    public function withRouteCondition(?string $routeCondition): self
+    {
+        $self = clone $this;
+        $self->routeCondition = $routeCondition;
+
+        return $self;
+    }
+
     public function getIdentifier(): ?string
     {
         return $this->identifier;
diff --git a/src/Component/src/Metadata/Show.php b/src/Component/src/Metadata/Show.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -56,6 +57,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'show',
             name: $name,
diff --git a/src/Component/src/Metadata/Update.php b/src/Component/src/Metadata/Update.php
@@ -25,6 +25,7 @@ public function __construct(
         ?string $routeName = null,
         ?string $routePrefix = null,
         ?array $routeRequirements = null,
+        ?string $routeCondition = null,
         ?string $template = null,
         ?string $shortName = null,
         ?string $name = null,
@@ -60,6 +61,7 @@ public function __construct(
             routeName: $routeName,
             routePrefix: $routePrefix,
             routeRequirements: $routeRequirements,
+            routeCondition: $routeCondition,
             template: $template,
             shortName: $shortName ?? 'update',
             name: $name,
diff --git a/src/Component/src/Symfony/Routing/Factory/OperationRouteFactory.php b/src/Component/src/Symfony/Routing/Factory/OperationRouteFactory.php
@@ -46,6 +46,7 @@ public function create(MetadataInterface $metadata, ResourceMetadata $resource,
             ],
             requirements: $operation->getRouteRequirements() ?? [],
             methods: $operation->getMethods() ?? [],
+            condition: $operation->getRouteCondition(),
         );
     }
 
diff --git a/src/Component/tests/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactoryTest.php b/src/Component/tests/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactoryTest.php
diff --git a/tests/Bundle/Command/DebugResourceCommandTest.php b/tests/Bundle/Command/DebugResourceCommandTest.php
