Skip to content

fix(metadata): sort parameters by priority after pattern expansion #7788

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: 4.2
Choose a base branch
from
+66 −0
Open

fix(metadata): sort parameters by priority after pattern expansion #7788

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/Resource/Factory/ParameterResourceMetadataCollectionFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ private function getDefaultParameters(Operation $operation, string $resourceClas
$parameters->add($key, $parameter->withPriority($priority));
}

$parameters->sort();

return $parameters;
}

Expand Down
64 changes: 64 additions & 0 deletions src/Metadata/Tests/Resource/Factory/ParameterResourceMetadataCollectionFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,49 @@ public function testParameterFactoryNoFilter(): void
$this->assertInstanceOf(Parameters::class, $parameters = $operation->getParameters());
}

public function testPatternParameterPriorityIsPreserved(): void
{
$nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
$nameCollection->method('create')->willReturn(new PropertyNameCollection(['id', 'name', 'description']));

$propertyMetadata = $this->createStub(PropertyMetadataFactoryInterface::class);
$propertyMetadata->method('create')->willReturn(new ApiProperty(readable: true));

$filterLocator = $this->createStub(ContainerInterface::class);
$filterLocator->method('has')->willReturn(false);

$parameterFactory = new ParameterResourceMetadataCollectionFactory(
$nameCollection,
$propertyMetadata,
new AttributesResourceMetadataCollectionFactory(),
$filterLocator
);

$resourceMetadataCollection = $parameterFactory->create(HasPatternParameterWithPriority::class);
$operation = $resourceMetadataCollection->getOperation(forceCollection: true);
$parameters = $operation->getParameters();

$this->assertInstanceOf(Parameters::class, $parameters);

$expandedParam = $parameters->get('order[name]');
$this->assertNotNull($expandedParam);
$this->assertSame(10, $expandedParam->getPriority(), 'Expanded pattern parameter must inherit parent priority');

$qParam = $parameters->get('q');
$this->assertNotNull($qParam);
$this->assertSame(0, $qParam->getPriority());

// Parameters must be iterated in priority order (highest first)
$iteratedKeys = [];
foreach ($parameters as $key => $parameter) {
$iteratedKeys[] = $key;
}

$qIndex = array_search('q', $iteratedKeys, true);
$orderNameIndex = array_search('order[name]', $iteratedKeys, true);
$this->assertLessThan($qIndex, $orderNameIndex, 'Pattern parameter with priority 10 must be iterated before parameter with priority 0');
}

public function testParameterFactoryWithLimitedProperties(): void
{
$nameCollection = $this->createMock(PropertyNameCollectionFactoryInterface::class);
Expand Down Expand Up @@ -220,3 +263,24 @@ class HasParameterAttribute
public $name;
public $description;
}

#[ApiResource(
operations: [
new GetCollection(
parameters: [
'order[:property]' => new QueryParameter(
properties: ['name'],
priority: 10,
),
'q' => new QueryParameter(
priority: 0,
),
]
),
]
)]
class HasPatternParameterWithPriority
{
public $id;
public $name;
}
Loading