[5.8] Fixed: SoftDelete::runSoftDelete and SoftDelete::performDeleteOnModel did not take into account overwrite Model::setKeysForSaveQuery

[elnur-ibr]

• Laravel Version: 5.8.4
• PHP Version: 7.2.4
• Database Driver & Version: MySql
• Issue: SoftDelete::runSoftDelete does not take into account overridden Model::setKeysForSaveQuery  #28022

Description:

SoftDelete::runSoftDelete and SoftDelete::performDeleteOnModel did not take into account overwrite Model::setKeysForSaveQuery.
I use this for multi-tenancy purposes. Or for use composite primary keys.

Model:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Shop extends Model
{
    use SoftDeletes;

    public $primaryKey= 'shop_id';

    protected function setKeysForSaveQuery(Builder $query) {
        $query
            ->where('user_id', '=', $this->getAttribute('user_id'))
            ->where('shop_id', '=', $this->getAttribute('shop_id'));

        return $query;
    }
}

When running below code:

$shop = Shop::find(1);
$shop->delete();

Expected query:
UPDATE shop SET deleted_at = ?, Shop.updated_at = ? WHERE shop_id = ? AND user_id = ?

Actual query:
UPDATE shop SET deleted_at = ?, SHOP.updated_at = ? WHERE shop_id = ?

Solution is to replace below lines

<?php

namespace Illuminate\Database\Eloquent;

trait SoftDeletes
{
     ...
     protected function performDeleteOnModel()
    {
        ...
            return $this->newModelQuery()->where($this->getKeyName(), $this->getKey())->forceDelete();
        }

        ...
    }
     ...
     protected function runSoftDelete()
    {
        $query = $this->newModelQuery()->where($this->getKeyName(), $this->getKey());
        ...
     }
     ...
}

To
return $this->setKeysForSaveQuery($this->newModelQuery())->forceDelete();
$query = $this->setKeysForSaveQuery($this->newModelQuery());

[driesvints]

@ElnurIbrahimzade this seems to break the tests. Can you also create a regression test for the problem at hand?

[elnur-ibr]

Added DatabaseSoftDeletingTraitStub::setKeysForSaveQuery method to DatabaseSoftDeletingTraitTest

That fixed problem.