aws-sdk-sqs 1.63.0 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 771f111abb0e80c50cdd2604ffccc623e3b857f71397e148cf39c86a6f4b3b01
-  data.tar.gz: d1de38807484a6e474286728326789343c99d96a4e9f691d6e1c95d7f41c4fd1
+  metadata.gz: deb95ba88a1099fdc9be73f1cdcc07f050abcb43d14f3b12d7ef4e0eeba718a3
+  data.tar.gz: a55887d771d042ad936392d196a251e9a41a4635dc0b54ff5ac5f11baf749ada
 SHA512:
-  metadata.gz: 77abf6cf9210bbbd454e584381e1f1c64e60c03b15de297f9a76808cab68485454cdb750984510c4c2e5c58632766b951852916c97f1ad5dad487f1de2e8f2ed
-  data.tar.gz: d226ea4308c28634f4a09b1d5ecf4eac09cb4beaa4c3567269c026c2ba9430af36414261b551aadfcfda4b5723ad86f89329750756b674c28da74821ab90c14b
+  metadata.gz: 1fee7c9e83c30cc4cdc66d2a73edb2e23cfa418b3ad7ba500cbc690eb507532c03085efcb224d3c0ffe75c1a6fc534c900b52bb2c7942127e2564919c175fd13
+  data.tar.gz: d4cac974b7077791b7ea7cfd3f72b240d7eb50c7b3c323ac545279f75bd265aa1bdeb05fdc1db164709c9e91701787657b7cb261f250df9951c024e2d0e98969

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.65.0 (2023-10-31)
+------------------
+
+* Feature - Update `QueuePoller` to allow for the definition of an `after_empty_receive` callback which is triggered when a polling request returns no records.
+
+1.64.0 (2023-10-02)
+------------------
+
+* Feature - Update QueuePoller to handle duplicate messages before yielding. Fixes bug in (#2913).
+
 1.63.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.63.0
+1.65.0

data/lib/aws-sdk-sqs/client.rb

@@ -2786,7 +2786,7 @@ module Aws::SQS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sqs'
-      context[:gem_version] = '1.63.0'
+      context[:gem_version] = '1.65.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-sqs/queue_poller.rb

@@ -4,7 +4,6 @@ require 'set'
 
 module Aws
   module SQS
-
     # A utility class for long polling messages in a loop. **Messages are
     # automatically deleted from the queue at the end of the given block.**
     #
@@ -181,6 +180,16 @@ module Aws
     #   end
     #   ```
     #
+    # * Configure an {#after_empty_receive} callback.
+    #
+    #   ```
+    #   poller.after_empty_receive do |stats|
+    #     logger.info("requests: #{stats.request_count}")
+    #     logger.info("messages: #{stats.received_message_count}")
+    #     logger.info("last-timestamp: #{stats.last_message_received_at}")
+    #   end
+    #   ```
+    #
     # * Accept a 2nd argument in the poll block, for example:
     #
     #   ```
@@ -203,7 +212,6 @@ module Aws
     #   ```
     #
     class QueuePoller
-
       # @param [String] queue_url
       # @option options [Client] :client
       # @option (see #poll)
@@ -258,6 +266,21 @@ module Aws
         @default_config = @default_config.with(before_request: block) if block_given?
       end
 
+      # Registers a callback that is invoked when the poll requests returns with no messages.
+      # This callback is invoked after the idle timeout is checked.
+      #
+      #     poller.after_empty_receive do |stats|
+      #       # Handle empty receive
+      #     end
+      #
+      # @yieldparam [PollerStats] stats An object that tracks a few
+      #   client-side statistics about the queue polling.
+      #
+      # @return [void]
+      def after_empty_receive(&block)
+        @default_config = @default_config.with(after_empty_receive: block) if block_given?
+      end
+
       # Polls the queue, yielded a message, or an array of messages.
       # Messages are automatically deleted from the queue at the
       # end of the given block. See the class documentation on
@@ -333,7 +356,8 @@ module Aws
           loop do
             messages = get_messages(config, stats)
             if messages.empty?
-              check_idle_timeout(config, stats, messages)
+              check_idle_timeout(config, stats)
+              config.after_empty_receive&.call(stats)
             else
               process_messages(config, stats, messages, &block)
             end
@@ -348,21 +372,21 @@ module Aws
       #   `#receipt_handle`.
       # @param [Integer] seconds
       def change_message_visibility_timeout(message, seconds)
-        @client.change_message_visibility({
+        @client.change_message_visibility(
           queue_url: @queue_url,
           receipt_handle: message.receipt_handle,
-          visibility_timeout: seconds,
-        })
+          visibility_timeout: seconds
+        )
       end
 
       # @note This method should be called from inside a {#poll} block.
       # @param [#receipt_handle] message An object that responds to
       #   `#receipt_handle`.
       def delete_message(message)
-        @client.delete_message({
+        @client.delete_message(
           queue_url: @queue_url,
-          receipt_handle: message.receipt_handle,
-        })
+          receipt_handle: message.receipt_handle
+        )
       end
 
       # @note This method should be called from inside a {#poll} block.
@@ -372,16 +396,16 @@ module Aws
       def delete_messages(messages)
         @client.delete_message_batch(
           queue_url: @queue_url,
-          entries: messages.map { |msg|
+          entries: messages.map do |msg|
             { id: msg.message_id, receipt_handle: msg.receipt_handle }
-          }
+          end
         )
       end
 
       private
 
       def get_messages(config, stats)
-        config.before_request.call(stats) if config.before_request
+        config.before_request&.call(stats)
         messages = send_request(config).messages
         stats.request_count += 1
         messages
@@ -392,17 +416,22 @@ module Aws
         @client.receive_message(params)
       end
 
-      def check_idle_timeout(config, stats, messages)
-        if config.idle_timeout
-          since = stats.last_message_received_at || stats.polling_started_at
-          idle_time = Time.now - since
-          throw :stop_polling if idle_time > config.idle_timeout
-        end
+      def check_idle_timeout(config, stats)
+        return unless config.idle_timeout
+
+        since = stats.last_message_received_at || stats.polling_started_at
+        idle_time = Time.now - since
+        throw :stop_polling if idle_time > config.idle_timeout
       end
 
       def process_messages(config, stats, messages, &block)
         stats.received_message_count += messages.count
         stats.last_message_received_at = Time.now
+
+        # duplicated messages will have a different receipt handle
+        # so we need to provide the most recent receipt to
+        # delete a batch - thus, filtering below by message_id
+        messages = messages.reverse.uniq(&:message_id).reverse!
         catch(:skip_delete) do
           yield_messages(config, messages, stats, &block)
           delete_messages(messages) unless config.skip_delete
@@ -421,7 +450,6 @@ module Aws
 
       # Statistics tracked client-side by the {QueuePoller}.
       class PollerStats
-
         def initialize
           @request_count = 0
           @received_message_count = 0
@@ -444,27 +472,26 @@ module Aws
 
         # @return [Time,nil]
         attr_accessor :polling_stopped_at
-
       end
 
       # A read-only set of configuration used by the QueuePoller.
       class PollerConfig
-
         # @api private
-        CONFIG_OPTIONS = Set.new([
-          :idle_timeout,
-          :skip_delete,
-          :before_request,
-        ])
+        CONFIG_OPTIONS = Set.new %i[
+          idle_timeout
+          skip_delete
+          before_request
+          after_empty_receive
+        ]
 
         # @api private
-        PARAM_OPTIONS = Set.new([
-          :wait_time_seconds,
-          :max_number_of_messages,
-          :visibility_timeout,
-          :attribute_names,
-          :message_attribute_names,
-        ])
+        PARAM_OPTIONS = Set.new %i[
+          wait_time_seconds
+          max_number_of_messages
+          visibility_timeout
+          attribute_names
+          message_attribute_names
+        ]
 
         # @return [Integer,nil]
         attr_reader :idle_timeout
@@ -475,6 +502,9 @@ module Aws
         # @return [Proc,nil]
         attr_reader :before_request
 
+        # @return [Proc,nil]
+        attr_reader :after_empty_receive
+
         # @return [Hash]
         attr_reader :request_params
 
@@ -482,12 +512,13 @@ module Aws
           @idle_timeout = nil
           @skip_delete = false
           @before_request = nil
+          @after_empty_receive = nil
           @request_params = {
             wait_time_seconds: 20,
             max_number_of_messages: 1,
             visibility_timeout: nil,
             attribute_names: ['All'],
-            message_attribute_names: ['All'],
+            message_attribute_names: ['All']
           }
           options.each do |opt_name, value|
             if CONFIG_OPTIONS.include?(opt_name)
@@ -522,7 +553,6 @@ module Aws
           PARAM_OPTIONS.each { |key| hash[key] = @request_params[key] }
           hash
         end
-
       end
     end
   end

data/lib/aws-sdk-sqs.rb

@@ -54,6 +54,6 @@ require_relative 'aws-sdk-sqs/customizations'
 # @!group service
 module Aws::SQS
 
-  GEM_VERSION = '1.63.0'
+  GEM_VERSION = '1.65.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sqs
 version: !ruby/object:Gem::Version
-  version: 1.63.0
+  version: 1.65.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core