fix(laravel): property filter and _format

Author: soyuka

src/Laravel/ApiPlatformMiddleware.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Laravel;
 
+use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactory;
 use Illuminate\Http\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -30,10 +31,19 @@ public function __construct(
     public function handle(Request $request, \Closure $next, ?string $operationName = null): Response
     {
         if ($operationName) {
-            $request->attributes->set('_api_operation', $this->operationMetadataFactory->create($operationName));
+            $request->attributes->set('_api_operation', $operation = $this->operationMetadataFactory->create($operationName));
         }
 
-        $request->attributes->set('_format', str_replace('.', '', $request->route('_format') ?? ''));
+        if (!($format = $request->route('_format')) && $operation instanceof HttpOperation && str_ends_with($operation->getUriTemplate(), '{._format}')) {
+            $matches = [];
+            if (preg_match('/\.[a-zA-Z]+$/', $request->getPathInfo(), $matches)) {
+                $format = $matches[0];
+            }
+        }
+
+        if ($format) {
+            $request->attributes->set('_format', substr($format, 1, \strlen($format) - 1));
+        }
 
         return $next($request);
     }

src/Laravel/ApiPlatformProvider.php

@@ -443,6 +443,7 @@ public function register(): void
 
             return new SerializerFilterParameterProvider(new ServiceLocator($tagged));
         });
+        $this->app->alias(SerializerFilterParameterProvider::class, 'api_platform.serializer.filter_parameter_provider');
 
         $this->app->tag([SerializerFilterParameterProvider::class], ParameterProviderInterface::class);
 
@@ -455,6 +456,7 @@ public function register(): void
 
         $this->app->singleton(ParameterProvider::class, function (Application $app) {
             $tagged = iterator_to_array($app->tagged(ParameterProviderInterface::class));
+            $tagged['api_platform.serializer.filter_parameter_provider'] = $app->make(SerializerFilterParameterProvider::class);
 
             return new ParameterProvider(
                 new ParameterValidatorProvider(

src/Laravel/Controller/ApiPlatformController.php

@@ -104,7 +104,12 @@ private function getUriVariables(Request $request, HttpOperation $operation): ar
     {
         $uriVariables = [];
         foreach ($operation->getUriVariables() ?? [] as $parameterName => $_) {
-            $uriVariables[(string) $parameterName] = $request->route($parameterName);
+            $parameter = $request->route($parameterName);
+            if (\is_string($parameter) && ($format = $request->attributes->get('_format')) && str_contains($parameter, $format)) {
+                $parameter = substr($parameter, 0, \strlen($parameter) - (\strlen($format) + 1));
+            }
+
+            $uriVariables[(string) $parameterName] = $parameter;
         }
 
         return $uriVariables;

src/Laravel/Eloquent/Serializer/SerializerContextBuilder.php

@@ -37,8 +37,10 @@ public function createFromRequest(Request $request, bool $normalization, ?array
             return $context;
         }
 
-        // isWritable/isReadable is checked later on
-        $context[AbstractNormalizer::ATTRIBUTES] = iterator_to_array($this->propertyNameCollectionFactory->create($context['resource_class'], ['serializer_groups' => $context['groups'] ?? null]));
+        if (!isset($context[AbstractNormalizer::ATTRIBUTES])) {
+            // isWritable/isReadable is checked later on
+            $context[AbstractNormalizer::ATTRIBUTES] = iterator_to_array($this->propertyNameCollectionFactory->create($context['resource_class'], ['serializer_groups' => $context['groups'] ?? null]));
+        }
 
         return $context;
     }

src/Laravel/Tests/EloquentTest.php

@@ -33,6 +33,19 @@ public function testSearchFilter(): void
         $this->assertSame($response->json()['member'][0], $book);
     }
 
+    public function testPropertyFilter(): void
+    {
+        $response = $this->get('/api/books', ['accept' => ['application/ld+json']]);
+        $book = $response->json()['member'][0];
+
+        $response = $this->get(\sprintf('%s.jsonld?properties[]=author', $book['@id']));
+        $book = $response->json();
+
+        $this->assertArrayHasKey('@id', $book);
+        $this->assertArrayHasKey('author', $book);
+        $this->assertArrayNotHasKey('name', $book);
+    }
+
     public function testPartialSearchFilter(): void
     {
         $response = $this->get('/api/books', ['accept' => ['application/ld+json']]);

src/Laravel/workbench/app/Models/Book.php

@@ -25,6 +25,7 @@
 use ApiPlatform\Metadata\Post;
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\Serializer\Filter\PropertyFilter;
 use Illuminate\Database\Eloquent\Concerns\HasUlids;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
@@ -52,6 +53,7 @@
     filter: new OrFilter(new EqualsFilter()),
     property: 'name'
 )]
+#[QueryParameter(key: 'properties', filter: PropertyFilter::class)]
 class Book extends Model
 {
     use HasFactory;

src/Serializer/Filter/PropertyFilter.php

@@ -13,6 +13,9 @@
 
 namespace ApiPlatform\Serializer\Filter;
 
+use ApiPlatform\Metadata\HasOpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Parameter as MetadataParameter;
+use ApiPlatform\Metadata\QueryParameter;
 use ApiPlatform\OpenApi\Model\Parameter;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
@@ -114,7 +117,7 @@
  *
  * @author Baptiste Meyer <[email protected]>
  */
-final class PropertyFilter implements FilterInterface
+final class PropertyFilter implements FilterInterface, HasOpenApiParameterFilterInterface
 {
     private ?array $whitelist;
 
@@ -246,4 +249,9 @@ private function denormalizePropertyName($property): string
     {
         return null !== $this->nameConverter ? $this->nameConverter->denormalize($property) : $property;
     }
+
+    public function getOpenApiParameter(MetadataParameter $parameter): Parameter
+    {
+        return new Parameter(name: $parameter->getKey().'[]', in: $parameter instanceof QueryParameter ? 'query' : 'header');
+    }
 }

src/Serializer/Parameter/SerializerFilterParameterProvider.php

@@ -45,7 +45,7 @@ public function provide(Parameter $parameter, array $parameters = [], array $con
             return null;
         }
 
-        $context = $operation->getNormalizationContext();
+        $context = $operation->getNormalizationContext() ?? [];
         $request->attributes->set('_api_parameter', $parameter);
         $filter->apply($request, true, RequestAttributesExtractor::extractAttributes($request), $context);