Module: Shoryuken::ActiveJob::SQSSendMessageParametersSupport

Defined in:
lib/active_job/extensions.rb

Overview

Initializes SQS SendMessage parameters on instances of ActiveJob::Base to the empty hash, and populates it whenever ‘#enqueue` is called, such as when using ActiveJob::Base.set.

Instance Method Summary collapse

Instance Method Details

#enqueue(options = {}) ⇒ Object

Enqueues the job with optional SQS-specific parameters

Parameters:

  • options (Hash) (defaults to: {}) —

    enqueue options

Options Hash (options):

  • :message_attributes (Hash) —

    custom SQS message attributes

  • :message_system_attributes (Hash) —

    system attributes

  • :message_deduplication_id (String) —

    FIFO deduplication ID

  • :message_group_id (String) —

    FIFO message group ID

Returns:

  • (Object) —

    the enqueue result



38
39
40
41
42
43
44
45
46
 
# File 'lib/active_job/extensions.rb', line 38

def enqueue(options = {})
  sqs_options = options.extract! :message_attributes,
                                 :message_system_attributes,
                                 :message_deduplication_id,
                                 :message_group_id
  sqs_send_message_parameters.merge! sqs_options

  super
end

#initialize ⇒ Object

Initializes a new ActiveJob instance with empty SQS parameters

Uses argument forwarding (…) to properly pass all arguments including keyword arguments to the base class.



25
26
27
28
 
# File 'lib/active_job/extensions.rb', line 25

def initialize(...)
  super(...)
  self.sqs_send_message_parameters = {}
end