fix(laravel): query extensions with item operations (#7001)

Author: soyuka

src/Laravel/.php-cs-fixer.cache

@@ -448,7 +448,7 @@ public function register(): void
         $this->app->singleton(ItemProvider::class, function (Application $app) {
             $tagged = iterator_to_array($app->tagged(LinksHandlerInterface::class));
 
-            return new ItemProvider(new LinksHandler($app, $app->make(ResourceMetadataCollectionFactoryInterface::class)), new ServiceLocator($tagged));
+            return new ItemProvider(new LinksHandler($app, $app->make(ResourceMetadataCollectionFactoryInterface::class)), new ServiceLocator($tagged), $app->tagged(QueryExtensionInterface::class));
         });
         $this->app->singleton(CollectionProvider::class, function (Application $app) {
             $tagged = iterator_to_array($app->tagged(LinksHandlerInterface::class));

src/Laravel/ApiPlatformProvider.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Laravel\Eloquent\Extension;
 
 use ApiPlatform\Laravel\Eloquent\Filter\FilterInterface;
+use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ParameterNotFound;
 use Illuminate\Database\Eloquent\Builder;
@@ -36,6 +37,10 @@ public function __construct(
      */
     public function apply(Builder $builder, array $uriVariables, Operation $operation, $context = []): Builder
     {
+        if (!$operation instanceof CollectionOperationInterface) {
+            return $builder;
+        }
+
         $context['uri_variables'] = $uriVariables;
         $context['operation'] = $operation;
 

src/Laravel/Eloquent/Extension/FilterQueryExtension.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Laravel\Eloquent\State;
 
+use ApiPlatform\Laravel\Eloquent\Extension\QueryExtensionInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
 use Illuminate\Database\Eloquent\Model;
@@ -26,11 +27,13 @@ final class ItemProvider implements ProviderInterface
     use LinksHandlerLocatorTrait;
 
     /**
-     * @param LinksHandlerInterface<Model> $linksHandler
+     * @param LinksHandlerInterface<Model>      $linksHandler
+     * @param iterable<QueryExtensionInterface> $queryExtensions
      */
     public function __construct(
         private readonly LinksHandlerInterface $linksHandler,
         ?ContainerInterface $handleLinksLocator = null,
+        private iterable $queryExtensions = [],
     ) {
         $this->handleLinksLocator = $handleLinksLocator;
     }
@@ -45,6 +48,10 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             $query = $this->linksHandler->handleLinks($model->query(), $uriVariables, ['operation' => $operation] + $context);
         }
 
+        foreach ($this->queryExtensions as $extension) {
+            $query = $extension->apply($query, $uriVariables, $operation, $context);
+        }
+
         return $query->first();
     }
 }

src/Laravel/Eloquent/State/ItemProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\Tests\Unit\State;
+
+use ApiPlatform\Laravel\Eloquent\Extension\QueryExtensionInterface;
+use ApiPlatform\Laravel\Eloquent\State\ItemProvider;
+use ApiPlatform\Laravel\Eloquent\State\LinksHandlerInterface;
+use ApiPlatform\Metadata\Get;
+use Orchestra\Testbench\TestCase;
+use Psr\Container\ContainerInterface;
+use Workbench\App\Models\Book;
+
+class ItemProviderTest extends TestCase
+{
+    public function testItemProviderWithQueryExtension(): void
+    {
+        $linksHandler = $this->createMock(LinksHandlerInterface::class);
+        $handleLinksLocator = $this->createMock(ContainerInterface::class);
+        $queryExtension = $this->createMock(QueryExtensionInterface::class);
+        $queryExtension->expects($this->once())->method('apply')->willReturnArgument(0);
+
+        $queryExtensions = [$queryExtension];
+        $itemProvider = new ItemProvider($linksHandler, $handleLinksLocator, $queryExtensions);
+
+        $operation = new Get(class: Book::class);
+        $itemProvider->provide($operation);
+    }
+}