aws-sdk-rails 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b252fc5ed5514c1ab48750fc65acde4008f1f6a8b685bae42903708f7b987a14
-  data.tar.gz: da794888829a46dfeec19350997e753b9858bf07a0668ef603594d9db46bdf9a
+  metadata.gz: 06b6734cbbe89bfbec53e688f583d78fb1a1fed48420c0a6b279d0025c8a65d3
+  data.tar.gz: 6a84d18c8fbb5807bb88e1b3c803ed94a72bb6287abc244341dfb1e05a595923
 SHA512:
-  metadata.gz: 5c5a5f74b8faab027f2d8b3b64e32a4feb2e85c29207d051a66e93424b6b71d8dbdf0dd80ba1baac1b9be66489759c8efba1860fdba7d41990fbd8279d173b08
-  data.tar.gz: 227f06499dbd9a1705eae1ffb00777502cbfa3f512c8e07b1a037d5b04a35afcc651487518ea582e646cf6060682112a85d8baf59e6a9d543eb7beb16c8e3fa7
+  metadata.gz: 339b7acd4cdc666589ec5921ac583b1b8ed17101fedf6637af957ede0863b0aebe025333ddbb8fdb1fe9a491d2f82f76b7cde81d62ad1eab6c58ae34605c8ecf
+  data.tar.gz: c5d8b881c1f5a9521800bc89dd491266088a03dd98845590e5d498e22538baee8f14a014048a3155adcc411a5ded72bc35e02f456097f1d838a4e3cbff905e02

data/VERSION

@@ -1 +1 @@
-3.4.0
+3.5.0

data/lib/active_job/queue_adapters/amazon_sqs_adapter.rb

@@ -11,7 +11,7 @@ module ActiveJob
         _enqueue(job)
       end
 
-      def enqueue_at(job, timestamp)
+      def enqueue_at(job, timestamp, opts={})
         delay = (timestamp - Time.now.to_f).floor
         raise ArgumentError, 'Unable to queue a job with a delay great than 15 minutes' if delay > 15.minutes
         _enqueue(job, delay_seconds: delay)
@@ -25,6 +25,18 @@ module ActiveJob
         send_message_opts[:queue_url] = queue_url
         send_message_opts[:message_body] = Aws::Json.dump(body)
         send_message_opts[:message_attributes] = message_attributes(job)
+
+        if Aws::Rails::SqsActiveJob.fifo?(queue_url)
+          # job_id is unique per initialization of job
+          # Remove it from message dup id to ensure run-once behavior
+          # with ActiveJob retries
+           send_message_opts[:message_deduplication_id] =
+             Digest::SHA256.hexdigest(
+               Aws::Json.dump(body.except('job_id'))
+             )
+
+           send_message_opts[:message_group_id] = Aws::Rails::SqsActiveJob.config.message_group_id
+        end
         Aws::Rails::SqsActiveJob.config.client.send_message(send_message_opts)
       end
 

data/lib/active_job/queue_adapters/amazon_sqs_async_adapter.rb

@@ -19,12 +19,18 @@ module ActiveJob
       private
 
       def _enqueue(job, send_message_opts = {})
-        Concurrent::Promise
-        .execute { super(job, send_message_opts) }
-        .on_error do |e|
-          Rails.logger.error "Failed to queue job #{job}.  Reason: #{e}"
-          error_handler = Aws::Rails::SqsActiveJob.config.async_queue_error_handler
-          error_handler.call(e, job, send_message_opts) if error_handler
+        # FIFO jobs must be queued in order, so do not queue async
+        queue_url = Aws::Rails::SqsActiveJob.config.queue_url_for(job.queue_name)
+        if Aws::Rails::SqsActiveJob.fifo?(queue_url)
+          super(job, send_message_opts)
+        else
+          Concurrent::Promise
+          .execute { super(job, send_message_opts) }
+          .on_error do |e|
+            Rails.logger.error "Failed to queue job #{job}.  Reason: #{e}"
+            error_handler = Aws::Rails::SqsActiveJob.config.async_queue_error_handler
+            error_handler.call(e, job, send_message_opts) if error_handler
+          end
         end
       end
     end

data/lib/aws/rails/sqs_active_job/configuration.rb

@@ -14,6 +14,10 @@ module Aws
         yield(config)
       end
 
+      def self.fifo?(queue_url)
+        queue_url.ends_with? '.fifo'
+      end
+
       # Configuration for AWS SQS ActiveJob.
       # Use +Aws::Rails::SqsActiveJob.config+ to access the singleton config instance.
       class Configuration
@@ -25,12 +29,14 @@ module Aws
           visibility_timeout: 120,
           shutdown_timeout: 15,
           queues: {},
-          logger: ::Rails.logger
+          logger: ::Rails.logger,
+          message_group_id: 'SqsActiveJobGroup'
         }
 
         # @api private
         attr_accessor :queues, :max_messages, :visibility_timeout,
-                      :shutdown_timeout, :client, :logger, :async_queue_error_handler
+                      :shutdown_timeout, :client, :logger,
+                      :async_queue_error_handler, :message_group_id
 
         # Don't use this method directly: Confugration is a singleton class, use
         # +Aws::Rails::SqsActiveJob.config+ to access the singleton config.
@@ -63,6 +69,11 @@ module Aws
         #   Override file to load configuration from.  If not specified will
         #   attempt to load from config/aws_sqs_active_job.yml.
         #
+        # @option options [String] :message_group_id (SqsActiveJobGroup)
+        #  The message_group_id to use for queueing messages on a fifo queues.
+        #  Applies only to jobs queued on FIFO queues.
+        #  See the (SQS FIFO Documentation)[https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html]
+        #
         # @option options [Callable] :async_queue_error_handler An error handler
         #   to be called when the async active job adapter experiances an error
         #   queueing a job.  Only applies when

data/lib/aws/rails/sqs_active_job/poller.rb

@@ -69,12 +69,22 @@ module Aws
           @logger.info "Polling on: #{@options[:queue]} => #{queue_url}"
           client = Aws::Rails::SqsActiveJob.config.client
           @poller = Aws::SQS::QueuePoller.new(queue_url, client: client)
-          single_message = @options[:max_messages] == 1
           poller_options = {
             skip_delete: true,
             max_number_of_messages: @options[:max_messages],
             visibility_timeout: @options[:visibility_timeout]
           }
+          # Limit max_number_of_messages for FIFO queues to 1
+          # this ensures jobs with the same message_group_id are processed
+          # in order
+          # Jobs with different message_group_id will be processed in
+          # parallel and may be out of order.
+          if Aws::Rails::SqsActiveJob.fifo?(queue_url)
+            poller_options[:max_number_of_messages] = 1
+          end
+
+          single_message = poller_options[:max_number_of_messages] == 1
+
           @poller.poll(poller_options) do |msgs|
             msgs = [msgs] if single_message
             @logger.info "Processing batch of #{msgs.length} messages"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rails
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-record