Apply EloquentResource scope to related queries

Author: tobyzerner

src/Laravel/Concerns/ScopesRelatedResourceQueries.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Tobyz\JsonApiServer\Laravel\Concerns;
+
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Tobyz\JsonApiServer\Context;
+use Tobyz\JsonApiServer\Laravel\EloquentResource;
+use Tobyz\JsonApiServer\Laravel\Field\ToMany;
+use Tobyz\JsonApiServer\Laravel\Field\ToOne;
+use Tobyz\JsonApiServer\Schema\Field\Relationship;
+
+trait ScopesRelatedResourceQueries
+{
+    protected static function scopeRelatedQuery(
+        Relationship $relationship,
+        object $relation,
+        object $query,
+        Context $context,
+    ): void {
+        $applyRelationshipScope = function () use ($relationship, $relation, $context): void {
+            if (
+                ($relationship instanceof ToMany || $relationship instanceof ToOne) &&
+                $relationship->scope
+            ) {
+                ($relationship->scope)($relation, $context);
+            }
+        };
+
+        $constrain = [];
+
+        foreach ($relationship->collections as $collection) {
+            foreach ($context->api->getCollection($collection)->resources() as $resourceName) {
+                $resource = $context->api->getResource($resourceName);
+
+                if (!$resource instanceof EloquentResource) {
+                    continue;
+                }
+
+                $modelClass = get_class($resource->newModel($context));
+
+                if (isset($constrain[$modelClass])) {
+                    continue;
+                }
+
+                $constrain[$modelClass] = function ($query) use (
+                    $resource,
+                    $context,
+                    $applyRelationshipScope,
+                ) {
+                    $resource->scope($query, $context);
+                    $applyRelationshipScope();
+                };
+            }
+        }
+
+        if ($relation instanceof MorphTo) {
+            $relation->constrain($constrain);
+        } elseif ($constrain) {
+            $relatedModelClass = get_class($query->getModel());
+            ($constrain[$relatedModelClass] ?? reset($constrain))($query);
+        } else {
+            $applyRelationshipScope();
+        }
+    }
+}

src/Laravel/EloquentBuffer.php

@@ -4,14 +4,14 @@
 
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Tobyz\JsonApiServer\Context;
-use Tobyz\JsonApiServer\Laravel\Field\ToMany;
-use Tobyz\JsonApiServer\Laravel\Field\ToOne;
+use Tobyz\JsonApiServer\Laravel\Concerns\ScopesRelatedResourceQueries;
 use Tobyz\JsonApiServer\Schema\Field\Relationship;
 
 abstract class EloquentBuffer
 {
+    use ScopesRelatedResourceQueries;
+
     private static array $buffer = [];
 
     public static function add(Model $model, string $relationName): void
@@ -30,68 +30,12 @@ public static function load(
         }
 
         Collection::make($models)->load([
-            $relationName => function ($relation) use (
-                $model,
-                $relationName,
+            $relationName => fn($relation) => static::scopeRelatedQuery(
                 $relationship,
+                $relation,
+                $relation->getQuery(),
                 $context,
-            ) {
-                $query = $relation->getQuery();
-
-                // When loading the relationship, we need to scope the query
-                // using the scopes defined in the related API resource – there
-                // may be multiple if this is a polymorphic relationship. We
-                // start by getting the resource types this relationship
-                // could possibly contain.
-                $resources = array_merge(
-                    ...array_map(
-                        fn($collection) => array_map(
-                            fn($resource) => $context->api->getResource($resource),
-                            $context->api->getCollection($collection)->resources(),
-                        ),
-                        $relationship->collections,
-                    ),
-                );
-
-                // Now, construct a map of model class names -> scoping
-                // functions. This will be provided to the MorphTo::constrain
-                // method in order to apply type-specific scoping.
-                $constrain = [];
-
-                foreach ($resources as $resource) {
-                    if (!$resource instanceof EloquentResource) {
-                        continue;
-                    }
-
-                    $modelClass = get_class($resource->newModel($context));
-
-                    if (isset($constrain[$modelClass])) {
-                        continue;
-                    }
-
-                    $constrain[$modelClass] = function ($query) use (
-                        $resource,
-                        $context,
-                        $relationship,
-                        $relation,
-                    ) {
-                        $resource->scope($query, $context);
-
-                        if (
-                            ($relationship instanceof ToMany || $relationship instanceof ToOne) &&
-                            $relationship->scope
-                        ) {
-                            ($relationship->scope)($relation, $context);
-                        }
-                    };
-                }
-
-                if ($relation instanceof MorphTo) {
-                    $relation->constrain($constrain);
-                } elseif ($constrain) {
-                    reset($constrain)($query);
-                }
-            },
+            ),
         ]);
 
         static::$buffer[get_class($model)][$relationName] = [];

src/Laravel/EloquentResource.php

@@ -15,7 +15,7 @@
 use Tobyz\JsonApiServer\Context;
 use Tobyz\JsonApiServer\Exception\Pagination\InvalidPageCursorException;
 use Tobyz\JsonApiServer\Exception\Pagination\RangePaginationNotSupportedException;
-use Tobyz\JsonApiServer\Laravel\Field\ToMany as LaravelToMany;
+use Tobyz\JsonApiServer\Laravel\Concerns\ScopesRelatedResourceQueries;
 use Tobyz\JsonApiServer\Pagination\Page;
 use Tobyz\JsonApiServer\Resource\AbstractResource;
 use Tobyz\JsonApiServer\Resource\Attachable;
@@ -49,6 +49,8 @@ abstract class EloquentResource extends AbstractResource implements
     Attachable,
     RelatedListable
 {
+    use ScopesRelatedResourceQueries;
+
     public function resource(object $model, Context $context): ?string
     {
         $eloquentModel = $this->newModel($context);
@@ -137,12 +139,11 @@ public function relatedQuery(object $model, ToMany $relationship, Context $conte
         }
 
         $relation = $model->$method();
+        $query = $relation->getQuery();
 
-        if ($relationship instanceof LaravelToMany && $relationship->scope) {
-            ($relationship->scope)($relation, $context);
-        }
+        static::scopeRelatedQuery($relationship, $relation, $query, $context);
 
-        return $relation->getQuery();
+        return $query;
     }
 
     /**