Allow access to computed SQS SendMessage parameters when using ActiveJob #651
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
This'll help ensure that the ActiveJob adapters continue to work with
all supporter versions of ActiveJob.
The `require` order is unfortunately very sensitive here: it's important
to force the `:autoload` of `ActiveJob::QueueAdapters` (for example, by
defining a subclass of `ActiveJob::Base`) before defining our own
`ActiveJob::QueueAdapters::Shoryuken{Adapter,ConcurrentSendAdapter}`.
Otherwise, we end up in a situation where class methods on
`ActiveJob::QueueAdapters` are not defined.
When enqueuing a message with ActiveJob, the SQS SendMessage parameters
undergo several important transformations:
* The `shoryuken_class` :message_attribute is added
* Client middleware is applied
* :message_group_id and :message_deduplication_id are set for FIFO
queues if those options were unspecified
Since we store SQS SendMessage parameters on the ActiveJob job instance
itself, they're accessible to the caller:
```ruby
job = AddJob.set(queue: 'shoryuken_test.fifo')
.perform_later(123, 321)
job.sqs_send_message_parameters
```
This change modifies the `sqs_send_message_parameters` reference to be
the same object that's sent into `Shoryuken::Queue#send_message`. That
way, the caller has access to the complete set of computed SQS
SendMessage parameters, not just the ones that were specified by the
caller (for example, when using `.set`).
This makes it possible, for instance, to log important information like
the `message_deduplication_id` on the enqueuer side. It also gives
important feedback to users so that they know exactly what parameters
were sent to SQS.
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.
When enqueuing a message with ActiveJob, the SQS SendMessage parameters undergo several important transformations:
shoryuken_class:message_attributeis added:message_group_idand:message_deduplication_idare set for FIFO queues if those options were unspecifiedSince we store SQS SendMessage parameters on the ActiveJob job instance itself, they're accessible to the caller:
This change modifies the
sqs_send_message_parametersreference to be the same object that's sent intoShoryuken::Queue#send_message. That way, the caller has access to the complete set of computed SQSSendMessage parameters, not just the ones that were specified by the caller (for example, when using
.set).This makes it possible, for instance, to log important information like the
message_deduplication_idon the enqueuer side. It also gives important feedback to users so that they know exactly what parameters were sent to SQS.Related: #646