fix(metadata): convert composite uri variables w/ proper type

api-platform · May 23, 2023 · 8901d04 · 8901d04
1 parent eacaf9f
commit 8901d04
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/src/Api/UriVariablesConverter.php b/src/Api/UriVariablesConverter.php
@@ -35,6 +35,10 @@ public function __construct(private readonly PropertyMetadataFactoryInterface $p
 
     /**
      * {@inheritdoc}
+     *
+     * To handle the composite identifiers type correctly, use an `uri_variables_map` that maps uriVariables to their uriVariablesDefinition.
+     * Indeed, a composite identifier will already be parsed, and their corresponding properties will be the parameterName and not the defined
+     * identifiers.
      */
     public function convert(array $uriVariables, string $class, array $context = []): array
     {
@@ -43,10 +47,15 @@ public function convert(array $uriVariables, string $class, array $context = [])
         $uriVariablesDefinitions = $operation->getUriVariables() ?? [];
 
         foreach ($uriVariables as $parameterName => $value) {
-            $uriVariableDefinition = $uriVariablesDefinitions[$parameterName] ?? $uriVariablesDefinitions['id'] ?? new Link();
+            $uriVariableDefinition = $context['uri_variables_map'][$parameterName] ?? $uriVariablesDefinitions[$parameterName] ?? $uriVariablesDefinitions['id'] ?? new Link();
 
-            $identifierTypes = $this->getIdentifierTypes($uriVariableDefinition->getFromClass() ?? $class, $uriVariableDefinition->getIdentifiers() ?? [$parameterName]);
-            if (!($types = $identifierTypes[$parameterName] ?? false)) {
+            // When a composite identifier is used, we assume that the parameterName is the property to find our type
+            $properties = $uriVariableDefinition->getIdentifiers() ?? [$parameterName];
+            if ($uriVariableDefinition->getCompositeIdentifier()) {
+                $properties = [$parameterName];
+            }
+
+            if (!$types = $this->getIdentifierTypes($uriVariableDefinition->getFromClass() ?? $class, $properties)) {
                 continue;
             }
 
@@ -73,7 +82,7 @@ private function getIdentifierTypes(string $resourceClass, array $properties): a
         foreach ($properties as $property) {
             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);
             foreach ($propertyMetadata->getBuiltinTypes() as $type) {
-                $types[$property][] = Type::BUILTIN_TYPE_OBJECT === ($builtinType = $type->getBuiltinType()) ? $type->getClassName() : $builtinType;
+                $types[] = Type::BUILTIN_TYPE_OBJECT === ($builtinType = $type->getBuiltinType()) ? $type->getClassName() : $builtinType;
             }
         }
 

diff --git a/src/State/UriVariablesResolverTrait.php b/src/State/UriVariablesResolverTrait.php
@@ -33,6 +33,7 @@ private function getOperationUriVariables(?HttpOperation $operation = null, arra
             return $identifiers;
         }
 
+        $uriVariablesMap = [];
         foreach ($operation->getUriVariables() ?? [] as $parameterName => $uriVariableDefinition) {
             if (!isset($parameters[$parameterName])) {
                 if (!isset($parameters['id'])) {
@@ -51,16 +52,18 @@ private function getOperationUriVariables(?HttpOperation $operation = null, arra
 
                 foreach ($currentIdentifiers as $key => $value) {
                     $identifiers[$key] = $value;
+                    $uriVariableMap[$key] = $uriVariableDefinition;
                 }
 
                 continue;
             }
 
             $identifiers[$parameterName] = $parameters[$parameterName];
+            $uriVariableMap[$parameterName] = $uriVariableDefinition;
         }
 
         if ($this->uriVariablesConverter) {
-            $context = ['operation' => $operation];
+            $context = ['operation' => $operation, 'uri_variables_map' => $uriVariablesMap];
             $identifiers = $this->uriVariablesConverter->convert($identifiers, $operation->getClass() ?? $resourceClass, $context);
         }
 

diff --git a/tests/Fixtures/TestBundle/ApiResource/Issue5396/CompositeKeyWithDifferentType.php b/tests/Fixtures/TestBundle/ApiResource/Issue5396/CompositeKeyWithDifferentType.php
@@ -28,6 +28,10 @@ class CompositeKeyWithDifferentType
 
     public static function provide(Operation $operation, array $uriVariables = [], array $context = []): array
     {
+        if (!\is_string($uriVariables['verificationKey'])) {
+            throw new \RuntimeException('verificationKey should be a string.');
+        }
+
         return $context;
     }
 }