Skip deleted handler during force delete on SoftDeletes models#984
Merged
taylorotwell merged 1 commit intoMay 13, 2026
Merged
Conversation
Contributor
Author
|
My first contribution to Laravel (or a Laravel Package)! I hope this is the correct way of doing so, if not, please let me know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Calling
forceDelete()on a Searchable model that usesSoftDeletescurrently dispatchesRemoveFromSearchtwice.SoftDeletes::forceDelete()delegates toModel::delete(), which always fires thedeletedevent after performing the delete. Scout'sModelObserver::deleted()calls$model->unsearchable(). Immediately after,SoftDeletes::forceDelete()firesforceDeleted, andModelObserver::forceDeleted()callsunsearchable()again.For bulk delete operations (for example tenant/account purges with large amounts of records), this doubles the load on the search index queue.
Event flow on
$model->forceDelete()(SoftDeletes)SoftDeletes::forceDelete()firesforceDeleting$this->forceDeleting = trueModel::delete():deletingdeleted→ firstunsearchable()SoftDeletes::forceDelete()firesforceDeleted→ secondunsearchable()Fix
Skip the
deletedhandler when the soft-deletes model is currently being force deleted.The subsequent
forceDeletedhandler still dispatchesunsearchable(), so the index is correctly cleaned.Unchanged behaviour
SoftDeletesare unaffected (usesSoftDelete($model)check)delete()calls on a SoftDeletes model still behave as before (isForceDeleting()returnsfalse)scout.soft_delete = true, the force delete path still correctly removes the model viaforceDeletedThis also avoids the unnecessary re-index/removal work in
deleted, where the model is about to be hard-deleted anyway.Reproduction