feat: autoload relations when include

Ark4ne · Ark4ne · commit 9fa16f7ad24f · 2022-12-26T11:02:44.000+01:00
diff --git a/src/Descriptors/Relations/Relation.php b/src/Descriptors/Relations/Relation.php
@@ -4,6 +4,7 @@
 
 use Ark4ne\JsonApi\Descriptors\Describer;
 use Ark4ne\JsonApi\Resources\Relationship;
+use Ark4ne\JsonApi\Traits\HasRelationLoad;
 use Ark4ne\JsonApi\Support\Config;
 use Closure;
 use Illuminate\Database\Eloquent\Model;
@@ -16,6 +17,8 @@
  */
 abstract class Relation extends Describer
 {
+    use HasRelationLoad;
+
     protected ?Closure $links = null;
     protected ?Closure $meta = null;
     protected bool $whenIncluded;
diff --git a/src/Descriptors/Resolver.php b/src/Descriptors/Resolver.php
@@ -9,7 +9,7 @@ trait Resolver
 {
     /**
      * @param \Illuminate\Http\Request $request
-     * @param iterable<mixed>|null            $values
+     * @param iterable<mixed>|null $values
      *
      * @return array<mixed>|null
      */
@@ -31,6 +31,6 @@ protected function resolveValues(Request $request, ?iterable $values): ?array
 
                 return $fields;
             }, new Collection)
-            ->toArray();
+            ->all();
     }
 }
diff --git a/src/Resources/Concerns/Relationships.php b/src/Resources/Concerns/Relationships.php
@@ -6,6 +6,7 @@
 use Ark4ne\JsonApi\Resources\Relationship;
 use Ark4ne\JsonApi\Support\Includes;
 use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 trait Relationships
@@ -34,6 +35,40 @@ protected function toRelationships(Request $request): iterable
         return [];
     }
 
+    /**
+     * @internal
+     *
+     * @return array<string, string|callable>
+     */
+    public function requestedRelationshipsLoad(Request $request): array
+    {
+        $schema = self::schema($request);
+
+        $walk = static function ($schema) use (&$walk, $request) {
+            $loads = [];
+
+            foreach ($schema->loads as $name => $load) {
+                if ($load && Includes::include($request, $name)) {
+                    $include = Includes::through($name, static fn() => $walk($schema->relationships[$name]));
+                    foreach ((array)$load as $key => $value) {
+                        if (is_string($value)) {
+                            $loads[$value] = $include;
+                        } elseif (is_string($key)) {
+                            $loads[$key] = $value;
+                            foreach (Arr::dot(Arr::undot($include), "$key.") as $inc => $item) {
+                                $loads[$inc] = $item;
+                            }
+                        }
+                    }
+                }
+            }
+
+            return $loads;
+        };
+
+        return Arr::dot($walk($schema));
+    }
+
     /**
      * @param \Illuminate\Http\Request $request
      *
@@ -63,15 +98,15 @@ private function requestedRelationships(Request $request): array
     }
 
     /**
-     * @param bool                                   $included
-     * @param \Illuminate\Http\Request               $request
+     * @param bool $included
+     * @param \Illuminate\Http\Request $request
      * @param \Ark4ne\JsonApi\Resources\Relationship $relationship
      *
      * @return array{data?: mixed, links?: mixed, meta?: mixed}
      */
     private function mapRelationship(
-        bool $included,
-        Request $request,
+        bool         $included,
+        Request      $request,
         Relationship $relationship
     ): array {
         $resource = $relationship->toArray($request, $included);
diff --git a/src/Resources/Concerns/Schema.php b/src/Resources/Concerns/Schema.php
@@ -6,6 +6,7 @@
 use Ark4ne\JsonApi\Descriptors\Relations\Relation;
 use Ark4ne\JsonApi\Descriptors\Resolver;
 use Ark4ne\JsonApi\Resources\Skeleton;
+use Ark4ne\JsonApi\Support\Arr;
 use Ark4ne\JsonApi\Support\FakeModel;
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
@@ -48,6 +49,23 @@ public static function schema(Request $request = null): Skeleton
                 $relationship = $relation->getResource();
             }
             $schema->relationships[$name] = $relationship::schema();
+
+            $load = $relation->load();
+
+            if ($load === false) {
+                $schema->loads[$name] = false;
+            }
+            elseif ($load === true) {
+                $schema->loads[$name] = $name;
+            }
+            elseif (is_string($load)) {
+                $schema->loads[$name] = $load;
+            }
+            elseif (is_array($load)) {
+                foreach ($load as $key => $value) {
+                    $schema->loads[$name][$key] = $value;
+                }
+            }
         }
 
         return self::$schemas[static::class];
diff --git a/src/Resources/JsonApiCollection.php b/src/Resources/JsonApiCollection.php
@@ -3,6 +3,8 @@
 namespace Ark4ne\JsonApi\Resources;
 
 use Ark4ne\JsonApi\Support\Arr;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Http\Resources\Json\ResourceCollection;
 
@@ -23,7 +25,7 @@ class JsonApiCollection extends ResourceCollection implements Resourceable
     /**
      * Create a new anonymous resource collection.
      *
-     * @param mixed                $resource
+     * @param mixed $resource
      * @param null|class-string<T> $collects
      *
      * @return void
@@ -37,12 +39,26 @@ public function __construct($resource, ?string $collects = null)
 
     /**
      * @param \Illuminate\Http\Request $request
-     * @param bool                     $included
+     * @param bool $included
      *
      * @return array<int, array{id: int|string}>
      */
     public function toArray(mixed $request, bool $included = true): array
     {
+        if (collect($this->collection)->every(fn($value) => $value instanceof JsonApiResource)) {
+            $collection = collect($this->collection);
+
+            // @phpstan-ignore-next-line
+            $loads = array_merge(...$collection->map->requestedRelationshipsLoad($request));
+
+            // @phpstan-ignore-next-line
+            $resources = $collection->map->resource;
+
+            if (!empty($loads) && $resources->every(fn($resource) => $resource instanceof Model)) {
+                (new Collection($resources))->loadMissing($loads);
+            }
+        }
+
         $data = [];
 
         $base = $this->with;
diff --git a/src/Resources/JsonApiResource.php b/src/Resources/JsonApiResource.php
@@ -5,6 +5,7 @@
 use Ark4ne\JsonApi\Resources\Concerns;
 use Ark4ne\JsonApi\Descriptors\Descriptors;
 use Ark4ne\JsonApi\Support\Arr;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
@@ -35,6 +36,12 @@ abstract class JsonApiResource extends JsonResource implements Resourceable
      */
     public function toArray(mixed $request, bool $included = true): array
     {
+        $loads = $this->requestedRelationshipsLoad($request);
+
+        if (!empty($loads) && $this->resource instanceof Model) {
+            $this->resource->loadMissing($loads);
+        }
+
         $data = [
             'id' => $this->toIdentifier($request),
             'type' => $this->toType($request),
diff --git a/src/Resources/Relationship.php b/src/Resources/Relationship.php
@@ -2,6 +2,7 @@
 
 namespace Ark4ne\JsonApi\Resources;
 
+use Ark4ne\JsonApi\Traits\HasRelationLoad;
 use Closure;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Http\Resources\Json\ResourceCollection;
@@ -16,6 +17,8 @@
  */
 class Relationship implements Resourceable
 {
+    use HasRelationLoad;
+
     protected string $relation;
 
     protected bool $asCollection = false;
@@ -24,13 +27,13 @@ class Relationship implements Resourceable
 
     /**
      * @param class-string<T> $resource
-     * @param Closure         $value
-     * @param Closure|null    $links
-     * @param Closure|null    $meta
+     * @param Closure $value
+     * @param Closure|null $links
+     * @param Closure|null $meta
      */
     public function __construct(
-        protected string $resource,
-        protected Closure $value,
+        protected string   $resource,
+        protected Closure  $value,
         protected ?Closure $links = null,
         protected ?Closure $meta = null
     ) {
@@ -115,7 +118,7 @@ public function forRelation(string $relation): self
 
     /**
      * @param \Illuminate\Http\Request $request
-     * @param bool                     $included
+     * @param bool $included
      *
      * @return array{data?: array{data?:mixed, links?:mixed, meta?:mixed}, included?: mixed, with?: mixed}
      */
diff --git a/src/Resources/Skeleton.php b/src/Resources/Skeleton.php
@@ -8,16 +8,18 @@
 class Skeleton
 {
     /**
-     * @param class-string<T>     $for
-     * @param string              $type
-     * @param string[]            $fields
+     * @param class-string $for
+     * @param string $type
+     * @param string[] $fields
      * @param array<string, self> $relationships
+     * @param array<string, false|string|mixed> $loads
      */
     public function __construct(
         public string $for,
         public string $type,
         public array $fields = [],
         public array $relationships = [],
+        public array $loads = [],
     ) {
     }
 }
diff --git a/src/Traits/HasRelationLoad.php b/src/Traits/HasRelationLoad.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Ark4ne\JsonApi\Traits;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\Relation;
+
+trait HasRelationLoad
+{
+    /** @var bool|string|array<string, callable(Builder|Relation):mixed>|array<array-key, string> */
+    protected bool|string|array $load = false;
+
+    /**
+     * @param bool|string|array<string, callable(Builder|Relation):mixed>|array<array-key, string> $load
+     * @return $this
+     */
+    public function withLoad(bool|string|array $load): static
+    {
+        $this->load = $load;
+        return $this;
+    }
+
+    /**
+     * @return bool|string|array<string, callable(Builder|Relation):mixed>|array<array-key, string>
+     */
+    public function load(): bool|string|array
+    {
+        return $this->load;
+    }
+}
diff --git a/tests/Feature/SchemaTest.php b/tests/Feature/SchemaTest.php
@@ -4,6 +4,7 @@
 
 use Ark4ne\JsonApi\Resources\JsonApiCollection;
 use Ark4ne\JsonApi\Resources\Skeleton;
+use Illuminate\Database\Eloquent\Builder;
 use Test\app\Http\Resources\CommentResource;
 use Test\app\Http\Resources\PostResource;
 use Test\app\Http\Resources\UserResource;
@@ -18,12 +19,20 @@ public function testSchema()
 
         $user->relationships['posts'] = $post;
         $user->relationships['comments'] = $comment;
+        $user->loads['posts'] = 'posts';
+        $user->loads['comments'] = [
+            'comments' => fn(Builder $q) => $q->where('content', 'like', '%e%')
+        ];
 
         $post->relationships['user'] = $user;
         $post->relationships['comments'] = $comment;
+        $post->loads['user'] = 'user';
+        $post->loads['comments'] = 'comments';
 
         $comment->relationships['user'] = $user;
         $comment->relationships['post'] = $post;
+        $comment->loads['user'] = 'user';
+        $comment->loads['post'] = 'post';
 
         $this->assertEquals($user, UserResource::schema());
         $this->assertEquals($post, PostResource::schema());
diff --git a/tests/app/Http/Controllers/AsApiController.php b/tests/app/Http/Controllers/AsApiController.php
@@ -26,7 +26,6 @@ public function index(Request $request): JsonApiCollection
         $modelClass = $this->getModelClass();
 
         $models = $modelClass::query()
-            ->with(array_filter(explode(',', $request->input('include', ''))))
             ->paginate();
 
         $resourceClass = $this->getResourceClass();
@@ -53,8 +52,7 @@ public function show(Request $request, string $id): JsonApiResource
     {
         $modelClass = $this->getModelClass();
 
-        $model = $modelClass
-            ::with(array_filter(explode(',', $request->input('include', ''))))
+        $model = $modelClass::query()
             ->find($id);
 
         $resourceClass = $this->getResourceClass();
diff --git a/tests/app/Http/Resources/CommentResource.php b/tests/app/Http/Resources/CommentResource.php
@@ -39,13 +39,14 @@ protected function toRelationships(Request $request): iterable
                     'self' => "https://api.example.com/comment/{$this->resource->id}/relationships/user",
                     'related' => "https://api.example.com/comment/{$this->resource->id}/user",
                 ])
-                ->whenIncluded()),
+                ->whenIncluded()->withLoad(true)),
             'post' => PostResource::relationship(fn() => $this->resource->post)
                 ->withLinks(fn() => [
                     'self' => "https://api.example.com/comment/{$this->resource->id}/relationships/post",
                     'related' => "https://api.example.com/comment/{$this->resource->id}/post",
                 ])
-                ->whenIncluded(),
+                ->whenIncluded()
+                ->withLoad(true),
         ];
     }
 }
diff --git a/tests/app/Http/Resources/PostResource.php b/tests/app/Http/Resources/PostResource.php
@@ -37,13 +37,15 @@ protected function toRelationships(Request $request): iterable
         return [
             'user' => $this->one(UserResource::class)->links(fn() => [
                 'self' => "https://api.example.com/posts/{$this->resource->id}/relationships/user",
-            ]),
+            ])->withLoad(true),
             'comments' => $this->many(CommentResource::class)->links(fn() => [
                 'self' => "https://api.example.com/posts/{$this->resource->id}/relationships/comments",
                 'related' => "https://api.example.com/posts/{$this->resource->id}/comments",
             ])->meta(fn() => [
-                'total' => $this->resource->comments()->getQuery()->count(),
-            ]),
+                'total' => $this->resource->relationLoaded('comments')
+                    ? $this->resource->comments->count()
+                    : $this->resource->comments()->getQuery()->count(),
+            ])->withLoad('comments'),
         ];
     }
 }
diff --git a/tests/app/Http/Resources/UserResource.php b/tests/app/Http/Resources/UserResource.php

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ trait Resolver`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`	`11`	`* @param \Illuminate\Http\Request $request`
`12`		`- * @param iterable<mixed>\|null $values`
	`12`	`+ * @param iterable<mixed>\|null $values`
`13`	`13`	`*`
`14`	`14`	`* @return array<mixed>\|null`
`15`	`15`	`*/`
`@@ -31,6 +31,6 @@ protected function resolveValues(Request $request, ?iterable $values): ?array`
`31`	`31`
`32`	`32`	`return $fields;`
`33`	`33`	`}, new Collection)`
`34`		`- ->toArray();`
	`34`	`+ ->all();`
`35`	`35`	`}`
`36`	`36`	`}`