[12.x] Improve circular relation check in Automatic Relation Loading (#55542)

* [12.x] Improve circular relation check in Automatic Relation Loading

* [12.x] Improve circular relation check in Automatic Relation Loading

* Remove unnecesary argument

* Add more tests

* Fix cs

* update tests

* Update HasRelationships.php

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: litvinchuk

src/Illuminate/Database/Eloquent/Collection.php

@@ -761,7 +761,7 @@ public function withRelationshipAutoloading()
 
         foreach ($this as $model) {
             if (! $model->hasRelationAutoloadCallback()) {
-                $model->autoloadRelationsUsing($callback);
+                $model->autoloadRelationsUsing($callback, $this);
             }
         }
 

src/Illuminate/Database/Eloquent/Concerns/HasRelationships.php

@@ -46,6 +46,13 @@ trait HasRelationships
      */
     protected $relationAutoloadCallback = null;
 
+    /**
+     * The relationship autoloader callback context.
+     *
+     * @var mixed
+     */
+    protected $relationAutoloadContext = null;
+
     /**
      * The many to many relationship methods.
      *
@@ -118,10 +125,16 @@ public function hasRelationAutoloadCallback()
      */
     public function autoloadRelationsUsing(Closure $callback, $context = null)
     {
+        // Prevent circular relation autoloading...
+        if ($context && $this->relationAutoloadContext === $context) {
+            return $this;
+        }
+
         $this->relationAutoloadCallback = $callback;
+        $this->relationAutoloadContext = $context;
 
         foreach ($this->relations as $key => $value) {
-            $this->propagateRelationAutoloadCallbackToRelation($key, $value, $context);
+            $this->propagateRelationAutoloadCallbackToRelation($key, $value);
         }
 
         return $this;
@@ -163,10 +176,9 @@ protected function invokeRelationAutoloadCallbackFor($key, $tuples)
      *
      * @param  string  $key
      * @param  mixed  $models
-     * @param  mixed  $context
      * @return void
      */
-    protected function propagateRelationAutoloadCallbackToRelation($key, $models, $context = null)
+    protected function propagateRelationAutoloadCallbackToRelation($key, $models)
     {
         if (! $this->hasRelationAutoloadCallback() || ! $models) {
             return;
@@ -183,10 +195,7 @@ protected function propagateRelationAutoloadCallbackToRelation($key, $models, $c
         $callback = fn (array $tuples) => $this->invokeRelationAutoloadCallbackFor($key, $tuples);
 
         foreach ($models as $model) {
-            // Check if relation autoload contexts are different to avoid circular relation autoload...
-            if ((is_null($context) || $context !== $model) && is_object($model) && method_exists($model, 'autoloadRelationsUsing')) {
-                $model->autoloadRelationsUsing($callback, $context);
-            }
+            $model->autoloadRelationsUsing($callback, $this->relationAutoloadContext);
         }
     }
 
@@ -1086,7 +1095,7 @@ public function setRelation($relation, $value)
     {
         $this->relations[$relation] = $value;
 
-        $this->propagateRelationAutoloadCallbackToRelation($relation, $value, $this);
+        $this->propagateRelationAutoloadCallbackToRelation($relation, $value);
 
         return $this;
     }

tests/Integration/Database/EloquentModelRelationAutoloadTest.php

@@ -61,6 +61,8 @@ public function testRelationAutoloadForCollection()
         $this->assertCount(2, DB::getQueryLog());
         $this->assertCount(3, $likes);
         $this->assertTrue($posts[0]->comments[0]->relationLoaded('likes'));
+
+        DB::disableQueryLog();
     }
 
     public function testRelationAutoloadForSingleModel()
@@ -84,6 +86,8 @@ public function testRelationAutoloadForSingleModel()
         $this->assertCount(2, DB::getQueryLog());
         $this->assertCount(2, $likes);
         $this->assertTrue($post->comments[0]->relationLoaded('likes'));
+
+        DB::disableQueryLog();
     }
 
     public function testRelationAutoloadWithSerialization()
@@ -109,6 +113,50 @@ public function testRelationAutoloadWithSerialization()
         $this->assertCount(2, DB::getQueryLog());
 
         Model::automaticallyEagerLoadRelationships(false);
+
+        DB::disableQueryLog();
+    }
+
+    public function testRelationAutoloadWithCircularRelations()
+    {
+        $post = Post::create();
+        $comment1 = $post->comments()->create(['parent_id' => null]);
+        $comment2 = $post->comments()->create(['parent_id' => $comment1->id]);
+        $post->likes()->create();
+
+        DB::enableQueryLog();
+
+        $post->withRelationshipAutoloading();
+        $comment = $post->comments->first();
+        $comment->setRelation('post', $post);
+
+        $this->assertCount(1, $post->likes);
+
+        $this->assertCount(2, DB::getQueryLog());
+
+        DB::disableQueryLog();
+    }
+
+    public function testRelationAutoloadWithChaperoneRelations()
+    {
+        Model::automaticallyEagerLoadRelationships();
+
+        $post = Post::create();
+        $comment1 = $post->comments()->create(['parent_id' => null]);
+        $comment2 = $post->comments()->create(['parent_id' => $comment1->id]);
+        $post->likes()->create();
+
+        DB::enableQueryLog();
+
+        $post->load('commentsWithChaperone');
+
+        $this->assertCount(1, $post->likes);
+
+        $this->assertCount(2, DB::getQueryLog());
+
+        Model::automaticallyEagerLoadRelationships(false);
+
+        DB::disableQueryLog();
     }
 
     public function testRelationAutoloadVariousNestedMorphRelations()
@@ -163,6 +211,8 @@ public function testRelationAutoloadVariousNestedMorphRelations()
         $this->assertCount(2, $videos);
         $this->assertTrue($videoLike->relationLoaded('likeable'));
         $this->assertTrue($videoLike->likeable->relationLoaded('commentable'));
+
+        DB::disableQueryLog();
     }
 }
 
@@ -197,6 +247,11 @@ public function comments()
         return $this->morphMany(Comment::class, 'commentable');
     }
 
+    public function commentsWithChaperone()
+    {
+        return $this->morphMany(Comment::class, 'commentable')->chaperone();
+    }
+
     public function likes()
     {
         return $this->morphMany(Like::class, 'likeable');