aws-sdk-sqs 1.60.0 → 1.93.0

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.**
     #
@@ -135,7 +134,7 @@ module Aws
     # ### `:idle_timeout` Option
     #
     # This is a configurable, maximum number of seconds to wait for a
-    # new message before the polling loop exists. By default, there is
+    # new message before the polling loop exits. By default, there is
     # no idle timeout.
     #
     #     # stops polling after a minute of no received messages
@@ -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/resource.rb

@@ -112,7 +112,6 @@ module Aws::SQS
     #       Default: 10. When the `ReceiveCount` for a message exceeds the
     #       `maxReceiveCount` for a queue, Amazon SQS moves the message to the
     #       dead-letter-queue.
-    #
     #   * `RedriveAllowPolicy` – The string that includes the parameters for
     #     the permissions for the dead-letter queue redrive permission and
     #     which source queues can specify dead-letter queues as a JSON object.
@@ -131,7 +130,6 @@ module Aws::SQS
     #
     #       * `byQueue` – Only queues specified by the `sourceQueueArns`
     #         parameter can specify this queue as the dead-letter queue.
-    #
     #     * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
     #       queues that can specify this queue as the dead-letter queue and
     #       redrive messages. You can specify this parameter only when the
@@ -203,7 +201,6 @@ module Aws::SQS
     #
     #       * If the queue has `ContentBasedDeduplication` set, your
     #         `MessageDeduplicationId` overrides the generated one.
-    #
     #     * When `ContentBasedDeduplication` is in effect, messages with
     #       identical content sent within the deduplication interval are
     #       treated as duplicates and only one copy of the message is
@@ -294,7 +291,7 @@ module Aws::SQS
     #   [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
     # @return [Queue]
     def create_queue(options = {})
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.create_queue(options)
       end
       Queue.new(
@@ -311,17 +308,17 @@ module Aws::SQS
     #   })
     # @param [Hash] options ({})
     # @option options [required, String] :queue_name
-    #   The name of the queue whose URL must be fetched. Maximum 80
-    #   characters. Valid values: alphanumeric characters, hyphens (`-`), and
-    #   underscores (`_`).
-    #
-    #   Queue URLs and names are case-sensitive.
+    #   (Required) The name of the queue for which you want to fetch the URL.
+    #   The name can be up to 80 characters long and can include alphanumeric
+    #   characters, hyphens (-), and underscores (\_). Queue URLs and names
+    #   are case-sensitive.
     # @option options [String] :queue_owner_aws_account_id
-    #   The Amazon Web Services account ID of the account that created the
-    #   queue.
+    #   (Optional) The Amazon Web Services account ID of the account that
+    #   created the queue. This is only required when you are attempting to
+    #   access a queue owned by another Amazon Web Services account.
     # @return [Queue]
     def get_queue_by_name(options = {})
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.get_queue_url(options)
       end
       Queue.new(
@@ -355,7 +352,7 @@ module Aws::SQS
     # @return [Queue::Collection]
     def queues(options = {})
       batches = Enumerator.new do |y|
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_queues(options)
         end
         resp.each_page do |page|