[8.x] Fixed SoftDeletes force deletion sets "exists" property to false only when deletion succeeded

[sancherie]

Hi everybody ✋

This PR fixes the behavior of SoftDeletes::performDeleteOnModel() method in case of forceDeleting.

The Current Issue

Currently, when a model with the SoftDeletes trait is force deleted, the model property $model->exists is set to false before the database is called for deletion.

/** @in Illuminate\Database\Eloquent::performDeleteOnModel() */

$this->exists = false;

return $this->setKeysForSaveQuery($this->newModelQuery())->forceDelete();

This behavior is particularly annoying if an error occurs during the deletion (e.g: foreign key constraint), if we catch the Exception, the $model->exists property will be equal to false whereas the model has not been deleted.

/** @var App\Models\User $user */

try {
    $user->forceDelete(); // this throws an error
} catch (\Exception $e) {
    echo $user->exists; // false

    // fix user deletion
}

// retry will do nothing because $user->exists === false
$user->forceDelete();

The Fix

With this fix, the database deletion call is made before the property setting. This ensure that $model->exists property is set to false only when the deletion succeeded

/** @in Illuminate\Database\Eloquent::performDeleteOnModel() */

 return tap($this->setKeysForSaveQuery($this->newModelQuery())->forceDelete(), function () {
    $this->exists = false;
});