Add opt-in unique indexing jobs to prevent Scout reindexing already queued models#996
Merged
Merged
Conversation
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.
Description:
I recently discovered that every time
$model->save()is called on a searchable model (regardless of whether the model actually changed), Scout dispatches aMakeSearchablejob. In write-heavy applications this means the queue fills with tons ofMakeSearchablejobs for the same records, causing the same documents to be re-indexed more often than necessary. The same applies toRemoveFromSearch.Because these jobs use
SerializesModels, a queued job always re-fetches the latest model state when it runs -- so collapsing redundant jobs for the same records has no effect on what ultimately gets indexed. It just removes wasted work.This PR adds opt-in unique variants of both indexing jobs:
Laravel\Scout\Jobs\MakeSearchableUniqueLaravel\Scout\Jobs\RemoveFromSearchUniqueBoth extend their base job and implement
ShouldBeUniqueUntilProcessing, sharing aUniqueByScoutKeystrait that derives the job's unique identity from the queueable model class plus its (sorted) Scout keys.Usage:
Developers can opt-in by pointing Scout at the unique jobs (ex. in a service provider):
I've made this opt-in since this
ShouldBeUniqueassumes that the developer has a default cache store set up.Let me know your thoughts! ❤️