Skip to content

[12.x] Add Support for Selective Relationship Autoloading in withRelationshipAutoloading #55673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

[12.x] Add Support for Selective Relationship Autoloading in withRelationshipAutoloading #55673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
25878e3
feat: selective loading added to withRelationshipAutoloading
moe-mizrak May 7, 2025
87a2a13
fix: autoloadRelationsUsing context is added back
moe-mizrak May 7, 2025
ac53b69
fix: test is fixed to be mass-assignable by adding fillable title
moe-mizrak May 7, 2025
294228d
fix: test is fixed by removing unnecessary columns added
moe-mizrak May 7, 2025
ed33041
fix: simplified test is added
moe-mizrak May 7, 2025
359a6bb
fix: missing realtions property is added to withRelationshipAutoloadi…
moe-mizrak May 7, 2025
ac55447
fix: tests for selective relationship autoloading is fixed and more t…
moe-mizrak May 7, 2025
3019fb1
fix: styleci suggestion is applied regarding indentation
moe-mizrak May 7, 2025
76c717f
fix: test assertion for polymorphic relationship is fixed
moe-mizrak May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 45 additions & 5 deletions src/Illuminate/Database/Eloquent/Collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,13 +256,29 @@ public function loadMissing($relations)
*/
public function loadMissingRelationshipChain(array $tuples)
{
[$relation, $class] = array_shift($tuples);
[$relationData, $class] = array_shift($tuples);

$this->filter(function ($model) use ($relation, $class) {
$relation = $relationData;
$columns = null;

if (is_string($relation) && str_contains($relation, ':')) {
[$relation, $columnString] = explode(':', $relationData, 2);
$columns = explode(',', $columnString);
}

$filtered = $this->filter(function ($model) use ($relation, $class) {
return ! is_null($model) &&
! $model->relationLoaded($relation) &&
$model::class === $class;
})->load($relation);
});

if ($columns) {
$filtered->load([$relation => function ($query) use ($columns) {
$query->select($columns);
}]);
} else {
$filtered->load($relation);
}

if (empty($tuples)) {
return;
Expand Down Expand Up @@ -753,11 +769,35 @@ protected function duplicateComparator($strict)
/**
* Enable relationship autoloading for all models in this collection.
*
* @param array|string|null $relations
* @return $this
*/
public function withRelationshipAutoloading()
public function withRelationshipAutoloading($relations = null)
{
$callback = fn ($tuples) => $this->loadMissingRelationshipChain($tuples);
$relationMap = [];

if (! is_null($relations)) {
if (is_string($relations)) {
$relations = [$relations];
}

foreach ($relations as $relation) {
$baseName = explode(':', $relation)[0];
$relationMap[$baseName] = $relation;
}
}

$callback = function ($tuples) use ($relationMap) {
if (! empty($relationMap)) {
$relationName = explode(':', $tuples[0][0])[0];

if (isset($relationMap[$relationName])) {
$tuples[0][0] = $relationMap[$relationName];
}
}

$this->loadMissingRelationshipChain($tuples);
Copy link
Author

@moe-mizrak moe-mizrak May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

todo: this part will be modified, can be improved overall

};

foreach ($this as $model) {
if (! $model->hasRelationAutoloadCallback()) {
Expand Down
5 changes: 3 additions & 2 deletions src/Illuminate/Database/Eloquent/Concerns/HasRelationships.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1129,11 +1129,12 @@ public function setRelations(array $relations)
/**
* Enable relationship autoloading for this model.
*
* @param array|string|null $relations
* @return $this
*/
public function withRelationshipAutoloading()
public function withRelationshipAutoloading($relations = null)
{
$this->newCollection([$this])->withRelationshipAutoloading();
$this->newCollection([$this])->withRelationshipAutoloading($relations);

return $this;
}
Expand Down
98 changes: 98 additions & 0 deletions tests/Integration/Database/EloquentModelRelationAutoloadTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,104 @@ public function testRelationAutoloadForSingleModel()
DB::disableQueryLog();
}

public function testWithRelationshipAutoloadingSelectiveColumnsLoadsOnlySpecifiedColumns()
{
$post = Post::create();
$post->comments()->create([
'parent_id' => 123,
]);

DB::enableQueryLog();

$post->withRelationshipAutoloading([
'comments:id,commentable_id',
]);

$this->assertNotNull($post->comments[0]->id);
$this->assertFalse(array_key_exists('parent_id', $post->comments[0]->getAttributes()));
$this->assertTrue($post->relationLoaded('comments'));

DB::disableQueryLog();
}

public function testWithRelationshipAutoloadingSelectiveColumns()
{
$post = Post::create();
$comment1 = $post->comments()->create([
'parent_id' => null,
]);
$comment2 = $post->comments()->create([
'parent_id' => $comment1->id,
]);
$comment2->likes()->create();
$comment2->likes()->create();

$likes = [];

DB::enableQueryLog();

$post->withRelationshipAutoloading([
'comments:id,commentable_id',
]);

foreach ($post->comments as $comment) {
$likes = array_merge($likes, $comment->likes->all());
}

$this->assertCount(2, DB::getQueryLog());
$this->assertNotNull($post->comments[0]->id);
$this->assertFalse(array_key_exists('parent_id', $post->comments[0]->getAttributes()));
$this->assertTrue($post->relationLoaded('comments'));
$this->assertCount(2, $likes);
$this->assertTrue($post->comments[0]->relationLoaded('likes'));

DB::disableQueryLog();
}

public function testWithRelationshipAutoloadingSelectiveColumnsAcrossPolymorphicTypes()
{
$post = Post::create();
$video = Video::create();

$postComment1 = $post->comments()->create([
'parent_id' => null,
]);
$postComment2 = $post->comments()->create([
'parent_id' => $postComment1->id,
]);
$videoComment1 = $video->comments()->create([
'parent_id' => null,
]);
$videoComment2 = $video->comments()->create([
'parent_id' => $videoComment1->id,
]);

DB::enableQueryLog();

$post->withRelationshipAutoloading([
'comments:id,commentable_id,commentable_type',
]);
$video->withRelationshipAutoloading([
'comments:id,commentable_id,commentable_type,parent_id',
]);

$this->assertNotNull($post->comments[0]->id);
$this->assertNotNull($video->comments[0]->id);

$this->assertTrue($post->relationLoaded('comments'));
$this->assertTrue($video->relationLoaded('comments'));
$this->assertFalse(array_key_exists('parent_id', $post->comments[0]->getAttributes()));
$this->assertFalse(array_key_exists('parent_id', $post->comments[1]->getAttributes()));
$this->assertTrue(array_key_exists('parent_id', $video->comments[0]->getAttributes()));
$this->assertTrue(array_key_exists('parent_id', $video->comments[1]->getAttributes()));
$this->assertSame(Post::class, $post->comments[0]->commentable_type);
$this->assertSame(Video::class, $video->comments[0]->commentable_type);
$this->assertEquals($post->id, $post->comments[0]->commentable_id);
$this->assertEquals($video->id, $video->comments[0]->commentable_id);

DB::disableQueryLog();
}

public function testRelationAutoloadWithSerialization()
{
Model::automaticallyEagerLoadRelationships();
Expand Down