Fix ActiveJob::EnqueueAfterTransactionCommit API
#51525
Merged
+185
−24
Conversation
This file contains 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
casperisfine
force-pushed
the
aj-after-commit-return-value
branch
3 times, most recently
from
05257c6
to
81dcc82
Compare
casperisfine
commented
Apr 9, 2024
| @@ -28,11 +30,15 @@ module EnqueueAfterTransactionCommit # :nodoc: | |||
| end | |||
|
|
|||
| if after_transaction | |||
| ActiveRecord.after_all_transactions_commit(&block) | |||
| self.successfully_enqueued = true | |||
There was a problem hiding this comment.
Dunno if the successfully_enqueued = true is really justified. Maybe what we'd want is to return the job but with successfully_enqueued = false?
Fix: rails#51426 (comment) `perform_later` is supposed to return the Job instance on success, and `false` on error. When the `enqueue` is automatically delayed, it's of course impossible to predict if the actual queueing will succeed, but for backward compatibility reasons, it's best to assume it will. If necessary, you can hold onto the job instance and check for `#successfully_enqueued?` after the transaction has completed.
casperisfine
force-pushed
the
aj-after-commit-return-value
branch
from
81dcc82
to
afa0198
Compare
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.
Fix: #51426 (comment)
perform_lateris supposed to return the Job instance on success, andfalseon error.When the
enqueueis automatically delayed, it's of course impossible to predict if the actual queueing will succeed, but for backward compatibility reasons, it's best to assume it will.If necessary, you can hold onto the job instance and check for
#successfully_enqueued?after the transaction has completed.cc @matthewd @bensheldon