Can't get the logAttribute of related model in placeholder of getDescriptionForEvent()

[JoaoAntonio2]

I have a Order model that belongsTo a Client model, when logging the Order model i want to retrieve a attribute "name" of the Client model so i made:

. . .
protected static $logAttributes = ['client.name'];
. . . 

and in the getDescriptionForEvent method i have:

public function getDescriptionForEvent(string $eventName): string
{
    if ($eventName == 'created') {
        return ':causer.name registerd the order :subject.code to the client :properties.attributes.client.name';
    }
}

But it simply doesnt bind the client name in the description correctly, the other placeholders works fine, but when i try to return the client.name it doesnt work.

Here is a Model instance of the Activity returned on tinker:

>>> Activity::latest()->first()->properties;
=> Illuminate\Support\Collection {#4360
     all: [
       "attributes" => [
         "id" => 163,
         "code" => "133512a",
         . . . 
         "created_at" => "2020-11-04T00:39:18.000000Z",
         "updated_at" => "2020-11-04T00:39:18.000000Z",
         "client.name" => "John Doe",
       ],
     ],
   }

[Gummibeer]

The issue here is the Arr::get() as it will try to find $activity->properties['attributes']['client']['name'] but it should check for $activity->properties['attributes']['client.name'].

laravel-activitylog/src/ActivityLogger.php

Line 221 in 08a128e

return Arr::get($attributeValue, $propertyName, $match);

To solve this the array should be saved using Arr::set() to transform the dot.notation key to a multi-level array.

laravel-activitylog/src/Traits/DetectsChanges.php

Line 127 in 08a128e

public static function logChanges(Model $model): array

But this would be a BC. 🤔
I would like to ask @freekmurze how he would rate this - as a bug-fix or a breaking-change.

As a temporary fix we could try something like this to prefer an exact key-match in favor of the dot.notation magic.

return $attributeValue[$propertyName] ?? Arr::get($attributeValue, $propertyName, $match);

[JoaoAntonio2]

Maybe a fix could be done replacing the dot with underscore when putting the new attribute to the array of attributes,

So instead of:

 "client.name" => "John Doe",

it could be:

 "client_name" => "John Doe",

and to avoid possibly conflicts with attributes that already exists we could be able to specify the key name in the $logAttributes = ['client.name'] variable, that way:

protected static $logAttributes = ['client_fullname' => 'client.name'];

so this way the key will be named as "client_fullname", but the value will still be the attribute name of the Client related model.

 "client_fullname" => "John Doe",