[5.7] Sync changes before firing updated event

[Dylan-DutchAndBold]

! Contains breaking change

Problem

1. Logic: Since the updated events suggests the model is now saved (which it is). We should be using the ->wasChanged function instead of the ->isDirty functions within this function.

2. Unwanted behaviour: In my case I now check if a value is dirty and then save another. But it will create an infinite loop when you save the model, because the dirty values are still there when you update again. Instead of just that second new value.

Code example

This is my code example which creates an infinite loop, which it wouldn't when using ->wasChanged.

HasLocationObserver

public function updated(HasLocation $model)
    {
        if ($model->needsLocationUpdate()) {
            FetchLatLong::dispatchNow($model);
        }
    }

Model function ->needsLocationUpdate()

public function needsLocationUpdate(): bool
    {
        return $this->isDirty(['city', 'country_code']);
    }

The FetchLatLong job sets the spatial point value and saves again. But since the dirty values from the previous update still are set on the model, it will always return true on the ->needsLocationUpdate function

[taylorotwell]

Merged to 5.7 branch.

[taylorotwell]

What exactly is the breaking change with this method? It seems more like a bug fix? Would you expect this to have a large impact on existing applications?

[Dylan-DutchAndBold]

@taylorotwell If someone has been using isDirty function within the updated model event, it will no longer work. It should now be swapped with wasChanged

[andrewsuzuki]

@taylorotwell I think the upgrade guide should mention isDirty no longer working in updated model events. Of the two updated model events I have in my app, I was using isDirty in both of them (watching for changes to User->email and updating third-party services).