Skip to content

feat!: throw exception when an operation is not declared in ApiResource for parameter attributes on properties #8552

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
Maxcastel wants to merge 1 commit into
base: main
Choose a base branch
from
+46 −32
Open

feat!: throw exception when an operation is not declared in ApiResource for parameter attributes on properties #8552

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
56 changes: 41 additions & 15 deletions src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,14 @@ public function create(string $resourceClass): ResourceMetadataCollection
{
$resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);

$declaredOperationClasses = $this->getDeclaredOperationClasses($resourceMetadataCollection);

foreach ($resourceMetadataCollection as $i => $resource) {
$operations = $resource->getOperations();

$internalPriority = -1;
foreach ($operations as $operationName => $operation) {
$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority, $declaredOperationClasses);
if (\count($parameters) > 0) {
$operations->add($operationName, $operation->withParameters($parameters));
}
Expand All @@ -88,7 +90,7 @@ public function create(string $resourceClass): ResourceMetadataCollection

$internalPriority = -1;
foreach ($graphQlOperations as $operationName => $operation) {
$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority, $declaredOperationClasses);
if (\count($parameters) > 0) {
$graphQlOperations[$operationName] = $operation->withParameters($parameters);
}
Expand Down Expand Up @@ -229,12 +231,15 @@ private function getProperties(string $resourceClass, ?Parameter $parameter = nu
return $this->localPropertyCache[$k];
}

private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
/**
* @param list<class-string<Operation>> $declaredOperationClasses
*/
private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority, array $declaredOperationClasses): Parameters
{
$propertyNames = $properties = [];
$parameters = $operation->getParameters() ?? new Parameters();

foreach ($this->createParametersFromAttributes($operation) as $key => $parameter) {
foreach ($this->createParametersFromAttributes($operation, $declaredOperationClasses) as $key => $parameter) {
$parameters->add($key, $parameter);
}

Expand Down Expand Up @@ -510,7 +515,10 @@ private function getFilterInstance(object|string|null $filter): ?object
return $this->filterLocator->get($filter);
}

private function createParametersFromAttributes(Operation $operation): Parameters
/**
* @param list<class-string<Operation>> $declaredOperationClasses
*/
private function createParametersFromAttributes(Operation $operation, array $declaredOperationClasses): Parameters
{
$parameters = new Parameters();

Expand All @@ -521,19 +529,22 @@ private function createParametersFromAttributes(Operation $operation): Parameter
foreach ((new \ReflectionClass($resourceClass))->getProperties() as $reflectionProperty) {
foreach ($reflectionProperty->getAttributes(Parameter::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
$parameter = $attribute->newInstance();
$propertyName = $reflectionProperty->getName();

if (
null !== ($parameterOperations = $parameter->getOperations())
&& !\in_array(
$operation::class,
array_map(static fn ($parameterOperation) => $parameterOperation::class, $parameterOperations),
true
)
) {
continue;
if (null !== ($parameterOperations = $parameter->getOperations())) {
$parameterOperationClasses = array_map(static fn ($parameterOperation) => $parameterOperation::class, $parameterOperations);

foreach ($parameterOperationClasses as $parameterOperationClass) {
if (!\in_array($parameterOperationClass, $declaredOperationClasses, true)) {
throw new RuntimeException(\sprintf('Parameter attribute on property "%s" is restricted to the operation "%s" which is not declared on the resource "%s".', $propertyName, $parameterOperationClass, $resourceClass));
}
}

if (!\in_array($operation::class, $parameterOperationClasses, true)) {
continue;
}
}

$propertyName = $reflectionProperty->getName();
$key = $parameter->getKey() ?? $propertyName;

if (null === $parameterPropertyName = $parameter->getProperty()) {
Expand All @@ -554,4 +565,19 @@ private function createParametersFromAttributes(Operation $operation): Parameter

return $parameters;
}

/**
* @return list<class-string<Operation>>
*/
private function getDeclaredOperationClasses(ResourceMetadataCollection $resourceMetadataCollection): array
{
$operationClasses = [];
foreach ($resourceMetadataCollection as $resource) {
foreach ($resource->getOperations() ?? [] as $operation) {
$operationClasses[] = $operation::class;
}
}

return $operationClasses;
}
}
22 changes: 5 additions & 17 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 @@ -819,8 +819,11 @@ public function testHeaderParameterFromPropertyAttributePropertiesHasMultipleInc
$this->assertSame(['authToken'], $authParam->getProperties());
}

public function testQueryParameterOnPropertiesWithOperations(): void
public function testQueryParameterOnPropertiesThrowsExceptionWhenOperationIsNotDeclared(): void
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage(\sprintf('Parameter attribute on property "id" is restricted to the operation "%s" which is not declared on the resource "%s".', Patch::class, QueryParameterOnPropertiesWithOperations::class));

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

Expand All @@ -839,22 +842,7 @@ public function testQueryParameterOnPropertiesWithOperations(): void
$filterLocator
);

$resourceMetadataCollection = $parameterFactory->create(QueryParameterOnPropertiesWithOperations::class);
$operations = array_values(iterator_to_array($resourceMetadataCollection[0]->getOperations()));

$this->assertCount(2, $operations);

$collectionOperation = $operations[0];
$this->assertInstanceOf(GetCollection::class, $collectionOperation);
$collectionParameters = $collectionOperation->getParameters();
$this->assertTrue($collectionParameters->has('search'));
$this->assertFalse($collectionParameters->has('filter_id'));

$getOperation = $operations[1];
$this->assertInstanceOf(Get::class, $getOperation);
$getParameters = $getOperation->getParameters();
$this->assertTrue($getParameters->has('search'));
$this->assertTrue($getParameters->has('filter_id'));
$parameterFactory->create(QueryParameterOnPropertiesWithOperations::class);
}

public function testHeaderParameterOnPropertiesWithOperations(): void
Expand Down
Loading