Skip to content

[12.x] Adds EagerLoad attribute and initializeOnQueue hook #55590

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.

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

Draft
wants to merge 19 commits into
base: 12.x
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
14 changes: 14 additions & 0 deletions src/Illuminate/Queue/Attributes/WithRelations.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace Illuminate\Queue\Attributes;

use Attribute;

#[Attribute(Attribute::TARGET_PROPERTY)]
class WithoutRelations
{
public function __construct(public array $relations)
{
//
}
}
15 changes: 12 additions & 3 deletions src/Illuminate/Queue/SerializesModels.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace Illuminate\Queue;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Queue\Attributes\WithRelations;
use Illuminate\Queue\Attributes\WithoutRelations;
use ReflectionClass;
use ReflectionProperty;
Expand Down Expand Up @@ -89,9 +92,15 @@ public function __unserialize(array $values)
continue;
}

$property->setValue(
$this, $this->getRestoredPropertyValue($values[$name])
);
$value = $this->getRestoredPropertyValue($values[$name]);

$property->setValue($this, $value);

if (($value instanceof Model || $value instanceof Collection) && ($attributes = $property->getAttributes(WithRelations::class))) {
$relations = $attributes[0]->getArguments()[0];

$value->load($relations);
}
}
}

Expand Down
52 changes: 52 additions & 0 deletions tests/Integration/Queue/ModelSerializationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Illuminate\Database\Eloquent\Relations\Pivot;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Queue\Attributes\WithRelations;
use Illuminate\Queue\Attributes\WithoutRelations;
use Illuminate\Queue\SerializesModels;
use LogicException;
Expand Down Expand Up @@ -374,6 +375,45 @@ public function test_serialization_types_empty_custom_eloquent_collection()

$this->assertTrue(true);
}

public function test_it_respects_with_relations_attribute_for_models()
{
$user = User::create([
'email' => '[email protected]',
]);

$serialized = serialize(new ModelSerializationWithRelations($user));
$this->assertSame(
'O:66:"Illuminate\Tests\Integration\Queue\ModelSerializationWithRelations":1:{s:8:"property";O:45:"Illuminate\Contracts\Database\ModelIdentifier":5:{s:5:"class";s:39:"Illuminate\Tests\Integration\Queue\User";s:2:"id";i:1;s:9:"relations";a:0:{}s:10:"connection";s:7:"testing";s:15:"collectionClass";N;}}',
$serialized
);

/** @var ModelSerializationWithRelations $unserialized */
$unserialized = unserialize($serialized);

$this->assertTrue($unserialized->property->relationLoaded('roles'));
}

public function test_it_respects_with_relations_attribute_for_collections()
{
$taylor = User::create([
'email' => '[email protected]',
]);
$tim = User::create([
'email' => '[email protected]',
]);

$serialized = serialize(new ModelSerializationWithRelations(new Collection([$taylor, $tim])));
$this->assertSame(
'O:66:"Illuminate\Tests\Integration\Queue\ModelSerializationWithRelations":1:{s:8:"property";O:45:"Illuminate\Contracts\Database\ModelIdentifier":5:{s:5:"class";s:39:"Illuminate\Tests\Integration\Queue\User";s:2:"id";a:2:{i:0;i:1;i:1;i:2;}s:9:"relations";a:0:{}s:10:"connection";s:7:"testing";s:15:"collectionClass";N;}}',
$serialized,
);

/** @var ModelSerializationWithRelations $unserialized */
$unserialized = unserialize($serialized);

$this->assertTrue($unserialized->property->every->relationLoaded('roles'));
}
}

trait TraitBootsAndInitializersTest
Expand Down Expand Up @@ -567,6 +607,18 @@ public function __construct(public User $user, public DataValueObject $value)
}
}

class ModelSerializationWithRelations
{
use SerializesModels;

public function __construct(
#[WithRelations(['roles'])]
public $property
) {
//
}
}

class ModelRelationSerializationTestClass
{
use SerializesModels;
Expand Down
Loading