Retrieved event and setAttribute update the value on database while log out

[4msar]

Laravel Version

11

PHP Version

8.3

Database Driver & Version

MySQL 8

Description

I have a traits namely CleanStorage which is handle the file upload update and delete action and clear the file from storage, and also it has a retrieved event which is update the specified attributes with storage URL.

But the problem is while I used this trait in User model and tried to log-out and login the attribute is update with like this in the database /storage/users/[random-string].png every time I login and logged out it's update in the database with prefix of /storage/[rest-of-the-path]

I don't know this is an issue or not but this issue takes me here from a production application, if there are any better approach to do that then suggest me. 👍

I have attached the trait screenshot and also the usages.

Steps To Reproduce

Just use the traits and login then upload a image or update the DB columns with a local image path like this users/user.png and log out and login again check the DB or dump the user.

[4msar]

BTW I have solved the issue for myself by using this.

static::retrieved(function (Model $model) {
    foreach ($model->columnsForStorageItems() as $column) {
        // update the attribute
        $model->setAttribute(
            $column,
            $model->getStorageUrl($model->getRawOriginal($column))
        );

        // Sync the original attribute
        $model->syncOriginalAttribute($column);
    }
});

but maybe I'm doing it in a wrong way and it make me a wrong feeling.

[4msar]

This issue also occurred when I use the retrieved in the model directly.

IT UPDATING THE COLUMN WHEN I TRIGGER THE LOG OUT. BUT NO-WHERE I CALL THE save()/update() METHOD.

<?php

namespace App\Models;

// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Facades\Storage;

class User extends Authenticatable
{
    use HasFactory, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name',
        'email',
        'password',
        'image'
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * Get the attributes that should be cast.
     *
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'email_verified_at' => 'datetime',
            'password' => 'hashed',
        ];
    }

    function columnsForStorageItems():array     {
        return ['image'];
    }
    
    public static function boot()
    {
        parent::boot();
        
        static::retrieved(function ($model) {
            foreach ($model->columnsForStorageItems() as $column) {
                // Append the attribute
                $model->{$column} = \Storage::url($model->getRawOriginal($column));
            }
        });
    }

}

[4msar]

For now, the solution I used by updating the traits with this method implementation.

/**
     * Get the value of the appended attribute.
     *
     * @return string
     */
    public function getAttribute($key)
    {
        $value = parent::getAttribute($key);

        if (in_array($key, $this->columnsForStorageItems())) {
            return $this->getStorageUrl($value);
        }

        return $value;
    }

    /**
     * Get the value of the appended attribute.
     *
     * @return string
     */
    public function toArray()
    {
        $array = parent::toArray();

        foreach ($this->columnsForStorageItems() as $column) {
            if (isset($array[$column])) {
                $array[$column] = $this->getStorageUrl($array[$column]);
            }
        }

        return $array;
    }

[4msar]

The issue occurred when the remember token is updating using the save method in the Auth/EloquentUserProvider.

But the updateRememberToken method should only responsible for the remember token update not the whole model update.