Skip to content

feat(symfony): add routePriority to control route matching order #8309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soyuka wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(symfony): add routePriority to control route matching order #8309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Metadata/Delete.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -176,6 +177,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
1 change: 1 addition & 0 deletions src/Metadata/Extractor/XmlResourceExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ private function buildOperations(\SimpleXMLElement $resource, array $root): ?arr
'serialize' => $this->phpize($operation, 'serialize', 'bool'),
'queryParameterValidate' => $this->phpize($operation, 'queryParameterValidate', 'bool'),
'priority' => $this->phpize($operation, 'priority', 'integer'),
'routePriority' => $this->phpize($operation, 'routePriority', 'integer'),
'name' => $this->phpize($operation, 'name', 'string'),
'routeName' => $this->phpize($operation, 'routeName', 'string'),
]);
Expand Down
1 change: 1 addition & 0 deletions src/Metadata/Extractor/YamlResourceExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ private function buildOperations(array $resource, array $root): ?array
'strictQueryParameterValidation' => $this->phpize($operation, 'strictQueryParameterValidation', 'bool'),
'hideHydraOperation' => $this->phpize($resource, 'hideHydraOperation', 'bool'),
'priority' => $this->phpize($operation, 'priority', 'integer'),
'routePriority' => $this->phpize($operation, 'routePriority', 'integer'),
'name' => $this->phpize($operation, 'name', 'string'),
'class' => (string) $class,
]);
Expand Down
1 change: 1 addition & 0 deletions src/Metadata/Extractor/schema/resources.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
<xsd:attribute type="xsd:boolean" name="serialize"/>
<xsd:attribute type="xsd:boolean" name="openapi"/>
<xsd:attribute type="xsd:positiveInteger" name="priority"/>
<xsd:attribute type="xsd:integer" name="routePriority"/>
<xsd:attribute type="xsd:string" name="name"/>
<xsd:attribute type="xsd:string" name="itemUriTemplate"/>
<xsd:attribute type="xsd:string" name="routeName"/>
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/Get.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -176,6 +177,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/GetCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -177,6 +178,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/HttpOperation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -272,6 +273,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/McpResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
$provider = null,
$processor = null,
?OptionsInterface $stateOptions = null,
Expand Down Expand Up @@ -257,6 +258,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/McpTool.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
$provider = null,
$processor = null,
?OptionsInterface $stateOptions = null,
Expand Down Expand Up @@ -253,6 +254,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/NotExposed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -182,6 +183,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
14 changes: 14 additions & 0 deletions src/Metadata/Operation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,7 @@ public function __construct(
* Sort is ascendant: a lower priority comes first in the list.
*/
protected ?int $priority = null,
protected ?int $routePriority = null,
protected ?string $name = null,
protected $provider = null,
protected $processor = null,
Expand Down Expand Up @@ -965,6 +966,19 @@ public function withPriority(int $priority = 0): static
return $self;
}

public function getRoutePriority(): ?int
{
return $this->routePriority;
}

public function withRoutePriority(int $routePriority): static
{
$self = clone $this;
$self->routePriority = $routePriority;

return $self;
}

public function getName(): ?string
{
return $this->name;
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/Patch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -177,6 +178,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/Post.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -178,6 +179,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 2 additions & 0 deletions src/Metadata/Put.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function __construct(
?bool $fetchPartial = null,
?bool $forceEager = null,
?int $priority = null,
?int $routePriority = null,
?string $name = null,
$provider = null,
$processor = null,
Expand Down Expand Up @@ -178,6 +179,7 @@ class: $class,
fetchPartial: $fetchPartial,
forceEager: $forceEager,
priority: $priority,
routePriority: $routePriority,
name: $name,
provider: $provider,
processor: $processor,
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Routing/ApiLoader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public function load(mixed $data, ?string $type = null): RouteCollection
$operation->getCondition() ?? ''
);

$routeCollection->add($operationName, $route);
$routeCollection->add($operationName, $route, $operation->getRoutePriority() ?? 0);
}
}
}
Expand Down
15 changes: 15 additions & 0 deletions tests/Symfony/Routing/ApiLoaderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,21 @@ public function testApiLoaderIrisTypeRegistersItemRoutesWithNotExposedController
$this->assertNotNull($routeCollection->get('api_genid'));
}

public function testApiLoaderWithRoutePriority(): void
{
$resourceCollection = new ResourceMetadataCollection(Dummy::class, [
(new ApiResource())->withShortName('dummy')->withOperations(new Operations([
'api_dummies_get_item' => (new Get())->withUriTemplate('/dummies/{id}')->withRoutePriority(10),
'api_dummies_get_collection' => (new GetCollection())->withUriTemplate('/dummies'),
])),
]);

$routeCollection = $this->getApiLoaderWithResourceMetadataCollection($resourceCollection)->load(null);

$this->assertSame(10, $routeCollection->getPriority('api_dummies_get_item'));
$this->assertNull($routeCollection->getPriority('api_dummies_get_collection'));
}

public function testApiLoaderWithUndefinedControllerService(): void
{
$this->expectExceptionObject(new \RuntimeException('Operation "api_dummies_my_undefined_controller_method_item" is defining an unknown service as controller "Foo\\Bar\\MyUndefinedController". Make sure it is properly registered in the dependency injection container.'));
Expand Down
Loading