[6.x] Eager Loading Improvements (#418)

* Eager loading should be its own setting

During my v6 refactoring, I had merged the "eloquent relationship discovery" stuff with the eager loading relationships setting.

* `with` should still be an option

* Swap the method used for eager loading

Author: duncanmcclean

docs/upgrade-guides/v5-x-to-v6-0.md

@@ -85,21 +85,6 @@ If you were using the Table mode on any of your Has Many fields, you should swit
 * `mode: table`
 * `'mode' => 'table'`
 
-### Low: Changes to overriding eager loaded relationships.
-If you were previously overriding the "eager loaded relationships" in your resource's config array, you should change the key from `with` to `relationships`:
-
-```php
-\App\Models\Product::class => [
-    // ...
-
-    // Previously...
-    'with' => ['tags', 'manufacturer'],
-
-    // Now...
-    'relationships' => ['tags', 'manufacturer'],
-],
-```
-
 ## Previous upgrade guides
 
 -   [v3.x to v4.0](/upgrade-guides/v3-x-to-v4-0)

src/GraphQL/ResourceIndexQuery.php

@@ -39,7 +39,7 @@ public function resolve($root, $args)
     {
         $query = $this->resource->model()
             ->newQuery()
-            ->with($this->resource->eloquentRelationships()->values()->all());
+            ->with($this->resource->eagerLoadingRelationships());
 
         $this->filterQuery($query, $args['filter'] ?? []);
         $this->sortQuery($query, $args['sort'] ?? []);

src/Http/Controllers/CP/ResourceListingController.php

@@ -25,7 +25,7 @@ public function index(FilteredRequest $request, Resource $resource)
         $sortDirection = $request->input('order', $resource->orderByDirection());
 
         $query = $resource->model()
-            ->with($resource->eloquentRelationships()->values()->all())
+            ->with($resource->eagerLoadingRelationships())
             ->orderBy($sortField, $sortDirection);
 
         $query->when($query->hasNamedScope('runwayListing'), fn ($query) => $query->runwayListing());

src/Resource.php

@@ -132,14 +132,10 @@ public function titleField()
     }
 
     /**
-     * Automatically maps Eloquent relationships to their respective blueprint fields.
+     * Maps Eloquent relationships to their respective blueprint fields.
      */
     public function eloquentRelationships(): Collection
     {
-        if ($eloquentRelationships = $this->config->get('relationships')) {
-            return collect($eloquentRelationships);
-        }
-
         return $this->blueprint()->fields()->all()
             ->filter(function (Field $field) {
                 return $field->fieldtype() instanceof BelongsToFieldtype
@@ -172,6 +168,18 @@ public function eloquentRelationships(): Collection
             ->filter(fn ($eloquentRelationship) => method_exists($this->model(), $eloquentRelationship));
     }
 
+    /**
+     * Defines the relationships which should be eager loaded when querying the model.
+     */
+    public function eagerLoadingRelationships(): array
+    {
+        if ($eagerLoadingRelationships = $this->config->get('with')) {
+            return $eagerLoadingRelationships;
+        }
+
+        return $this->eloquentRelationships()->values()->toArray();
+    }
+
     public function listableColumns(): Collection
     {
         return $this->blueprint()->fields()->all()

tests/ResourceTest.php

@@ -55,18 +55,36 @@ public function can_get_eloquent_relationships_for_runway_uri_routing()
     }
 
     /** @test */
-    public function can_get_eloquent_relationships_as_defined_in_config()
+    public function can_get_eager_loading_relationships()
     {
-        Config::set('runway.resources.StatamicRadPack\Runway\Tests\Fixtures\Models\Post.relationships', ['author']);
+        Runway::discoverResources();
+
+        $resource = Runway::findResource('post');
+
+        $eagerLoadingRelationships = $resource->eagerLoadingRelationships();
+
+        $this->assertEquals([
+            'author',
+            'runwayUri',
+        ], $eagerLoadingRelationships);
+    }
+
+    /** @test */
+    public function can_get_eager_loading_relationships_from_config()
+    {
+        Config::set('runway.resources.StatamicRadPack\Runway\Tests\Fixtures\Models\Post.with', [
+            'author',
+        ]);
 
         Runway::discoverResources();
 
         $resource = Runway::findResource('post');
 
-        $eloquentRelationships = $resource->eloquentRelationships();
+        $eagerLoadingRelationships = $resource->eagerLoadingRelationships();
 
-        $this->assertContains('author', $eloquentRelationships->toArray());
-        $this->assertNotContains('runwayUri', $eloquentRelationships->toArray());
+        $this->assertEquals([
+            'author',
+        ], $eagerLoadingRelationships);
     }
 
     /** @test */