Skip to content

Only merge cached casts for accessed attribute #57627

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

Open
ug-christoph wants to merge 9 commits into
base: 12.x
Choose a base branch
from
Open

Only merge cached casts for accessed attribute #57627

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
faf2ab8
Only merge cached casts for accessed attribute
ug-christoph Nov 1, 2025
8c2a6fb
Fix formatting of conditional statements
ug-christoph Nov 1, 2025
4026ff4
remove extra space
ug-christoph Nov 1, 2025
3ad3900
Remove blank line in HasAttributes.php
ug-christoph Nov 1, 2025
391dc21
fix test: The affected tests are quite brittle (they do an assertion …
Nov 1, 2025
98fa005
break code into functions to preserve the original signatures
Nov 2, 2025
a09a642
fix styling
Nov 2, 2025
f9fed57
add test for mutator - cast dependency
Nov 4, 2025
cca9ca9
fix styling
Nov 4, 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
22 changes: 14 additions & 8 deletions src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ public function getAttributeValue($key)
*/
protected function getAttributeFromArray($key)
Copy link
Author

@ug-christoph ug-christoph Nov 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Instead of calling

return $this->getAttributes()[$key] ?? null;

I do exactly what getAttributes does, but instead of calling mergeAttributesFromCachedCasts
I call the new
mergeAttributeFromCachedCasts($key) so it only does it for the attribute I am currently trying to get

{
return $this->getAttributes()[$key] ?? null;
return $this->getAttributes($key)[$key] ?? null;
}

/**
Expand Down Expand Up @@ -1890,20 +1890,23 @@ protected function parseCasterClass($class)
*
* @return void
*/
protected function mergeAttributesFromCachedCasts()
protected function mergeAttributesFromCachedCasts(?string $onlyMergeCachedCastsForThisKey = null)
{
$this->mergeAttributesFromClassCasts();
$this->mergeAttributesFromAttributeCasts();
$this->mergeAttributesFromClassCasts($onlyMergeCachedCastsForThisKey);
$this->mergeAttributesFromAttributeCasts($onlyMergeCachedCastsForThisKey);
}

/**
* Merge the cast class attributes back into the model.
*
* @return void
*/
protected function mergeAttributesFromClassCasts()
protected function mergeAttributesFromClassCasts(?string $onlyMergeCachedCastsForThisKey = null)
{
foreach ($this->classCastCache as $key => $value) {
if (! is_null($onlyMergeCachedCastsForThisKey) && $key !== $onlyMergeCachedCastsForThisKey) {
continue;
}
$caster = $this->resolveCasterClass($key);

$this->attributes = array_merge(
Expand All @@ -1920,9 +1923,12 @@ protected function mergeAttributesFromClassCasts()
*
* @return void
*/
protected function mergeAttributesFromAttributeCasts()
protected function mergeAttributesFromAttributeCasts(?string $onlyMergeCachedCastsForThisKey = null)
{
foreach ($this->attributeCastCache as $key => $value) {
if (! is_null($onlyMergeCachedCastsForThisKey) && $key !== $onlyMergeCachedCastsForThisKey) {
continue;
}
$attribute = $this->{Str::camel($key)}();

if ($attribute->get && ! $attribute->set) {
Expand Down Expand Up @@ -1959,9 +1965,9 @@ protected function normalizeCastClassResponse($key, $value)
*
* @return array<string, mixed>
*/
public function getAttributes()
public function getAttributes(?string $onlyMergeCachedCastsForThisKey = null)
{
$this->mergeAttributesFromCachedCasts();
$this->mergeAttributesFromCachedCasts($onlyMergeCachedCastsForThisKey);

return $this->attributes;
}
Expand Down
6 changes: 3 additions & 3 deletions tests/Integration/Database/EloquentModelEncryptedCastingTest.php
View file
Open in desktop
Copy link
Author

@ug-christoph ug-christoph Nov 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The affected tests are quite brittle (they do an assertions on the exact call count to a method). The PRs goal is to directly reduce those calls. The test is a good example of where the optimization helps. In these tests $subject->id is called which causes mergeAttributesFromCachedCasts to run for the encrypted/casted columns (secret_array, secret_collection). This is now expectedly not happening anymore and I have therefore just reduced the call count in the assertion by one to reflect this improvement

Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ public function testAsEncryptedCollection()
->with('{"key1":"value1"}')
->andReturn('encrypted-secret-collection-string-1');
$this->encrypter->expects('encryptString')
->times(10)
->times(9)
->with('{"key1":"value1","key2":"value2"}')
->andReturn('encrypted-secret-collection-string-2');
$this->encrypter->expects('decryptString')
Expand Down Expand Up @@ -239,7 +239,7 @@ public function testAsEncryptedCollectionMap()
->with('[{"key1":"value1"}]')
->andReturn('encrypted-secret-collection-string-1');
$this->encrypter->expects('encryptString')
->times(12)
->times(11)
->with('[{"key1":"value1"},{"key2":"value2"}]')
->andReturn('encrypted-secret-collection-string-2');
$this->encrypter->expects('decryptString')
Expand Down Expand Up @@ -295,7 +295,7 @@ public function testAsEncryptedArrayObject()
->with('encrypted-secret-array-string-1')
->andReturn('{"key1":"value1"}');
$this->encrypter->expects('encryptString')
->times(10)
->times(9)
->with('{"key1":"value1","key2":"value2"}')
->andReturn('encrypted-secret-array-string-2');
$this->encrypter->expects('decryptString')
Expand Down