Unable to disable eager loading for relations specified via $with using without()

[spaceemotion]

• Laravel Version: 6.0.3
• PHP Version: 7.1.24 (also with 7.3)
• Database Driver & Version: MySQL 5.7.24

Description:

When eager loading a relationship (see example below), I am unable to disable this behavior using:

->without('items.event')

A "fix" that works, but is counter-intuitive is:

->with(['items' => function ($related) {
  $related->without('event');
}])

It looks like the nested, eager loaded query does not take the parent scope into account when deciding which relationships to query.

Steps To Reproduce:

Given the following setup:

class Event extends Model {
  public function items() {
    return $this->hasMany(Item::class);
  }
}

class Item extends Model {
  protected $with = ['event'];

  public function event() {
    return $this->belongsTo(Event::class);
  }
}

and the following query:

$items = Event::query()->with('item')->get();

It will create an additional query to load the event data back into the items.

SELECT * FROM `events`
SELECT * FROM `items` WHERE `items`.`event_id` in (1, 2)
SELECT * FROM `events` WHERE `events`.`id` in (1, 2) # <- Additional, unnecessary query

[staudenmeir]

Have you looked into a fix? I don't think it's possible to support nested relationships here.

[spaceemotion]

I've indeed looked into a fix and there are two things that make this quite difficult:

1. There are no parent references. Not required, but may have made things easier.
2. without() simply removes the elements you don't want from the eagerLoad array.

In order to really know which resources should not be loaded, an array of "unwanted" relations would have to be passed to the parseWithRelations() method. From there a nested without() could be called automatically.

---

Edit, I've just noticed that there seems to be some additional weird behavior with eager loading that might confuse people. Given the following query:

->with('foo.bar.baz')
->without('foo.bar')

it will still load the relationships since it only looks for exact string matches and not by starts-with.

[spaceemotion]

Here's a small proof of concept that works when you just pass strings to without():

diff --git a/src/Illuminate/Database/Eloquent/Builder.php b/src/Illuminate/Database/Eloquent/Builder.php
index b165a205b..45f37f2e1 100755
--- a/src/Illuminate/Database/Eloquent/Builder.php
+++ b/src/Illuminate/Database/Eloquent/Builder.php
@@ -44,6 +44,8 @@ class Builder
      */
     protected $eagerLoad = [];
 
+    protected $eagerLoadWithout = [];
+
     /**
      * All of the globally registered builder macros.
      *
@@ -598,6 +600,12 @@ class Builder
             $relation->getQuery()->with($nested);
         }
 
+        $without = $this->withoutRelationsNestedUnder($name);
+
+        if (count($without) > 0) {
+            $relation->getQuery()->without($without);
+        }
+
         return $relation;
     }
 
@@ -623,6 +631,28 @@ class Builder
         return $nested;
     }
 
+    /**
+     * Get the deeply nested relations for a given top-level relation.
+     *
+     * @param  string  $relation
+     * @return array
+     */
+    protected function withoutRelationsNestedUnder($relation)
+    {
+        $nested = [];
+
+        // We are basically looking for any relationships that are nested deeper than
+        // the given top-level relationship. We will just check for any relations
+        // that start with the given top relations and adds them to our arrays.
+        foreach ($this->eagerLoadWithout as $name) {
+            if ($this->isNestedUnder($relation, $name)) {
+                $nested[] = substr($name, strlen($relation.'.'));
+            }
+        }
+
+        return $nested;
+    }
+
     /**
      * Determine if the relationship is nested.
      *
@@ -1051,9 +1081,11 @@ class Builder
      */
     public function without($relations)
     {
-        $this->eagerLoad = array_diff_key($this->eagerLoad, array_flip(
-            is_string($relations) ? func_get_args() : $relations
-        ));
+        $relations = is_string($relations) ? func_get_args() : $relations;
+
+        $this->eagerLoadWithout = array_merge($this->eagerLoadWithout, $relations);
+
+        $this->eagerLoad = array_diff_key($this->eagerLoad, array_flip($relations));
 
         return $this;
     }

[driesvints]

Laravel Version: 6.0.3
PHP Version: 7.1.24

Laravel 6.0 doesn't even runs on PHP 7.1

Can you first please try one of the support channels below? If you can actually identify this as a bug, feel free to report back and I'll gladly help you out and re-open this issue.

• Laracasts Forums
• Laravel.io Forums
• StackOverflow
• Discord
• Larachat
• IRC

Thanks!

[spaceemotion]

Hey, @driesvints. The version used in my container is 7.1. I've tried it with 7.3 as well, same issue. It's not something that has to do with the language version.

[driesvints]

I'll leave this open for further investigation but appreciating if anyone can help out with this.

[tansautn]

On Laravel 5.6.

I've use following way to avoid this issue. You can try, might be it still work with 6.x

class Event extends Model {
  public function items() {
    return $this->hasMany(Item::class)->setEagerLoads([]);
  }
}

class Item extends Model {
// Same as your
}

$items = Event::query()->with('item')->get();

[driesvints]

@spaceemotion have you tried the suggestion from @tansautn?

[driesvints]

Closing this issue because it's inactive, already solved, old or not relevant anymore. Feel free to reply if you're still experiencing this issue and we'll re-open this issue.

[RobQuistNL]

I've tried ->setEagerLoads([]) but that doesn't work.

$entity = Gpu::whereRigId($rig_id)->without('rig')->get(); // Returns Rig entity within
$entity = Gpu::whereRigId($rig_id)->get(); // Returns Rig entity within
$entity = Gpu::whereRigId($rig_id)->get(); // Returns Rig entity within
return response()->json($entity);

They all return the rig entity embedded, meaning it was loaded :/

Lumen v8.2.2 @ PHP 7.4

[Chris1234567899]

I still encounter this issue, laravel 9.2
Is that supposed to be fixed already?