aws-activejob-sqs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d637830be5b747a64bf196605511e325d998d43bdd378ce9377a04c4cd0d217
+  data.tar.gz: 3dd1d9a0385451965ef4e4efc9f51c73a9bdc5e896d4a2a9cd65c862319aac8b
+SHA512:
+  metadata.gz: edeeb1caccc5479f6a70bffada55cce0d7a15e70088a3a9f381782be366cf8200e0a16b03291be78c551a54b18192268b32b85f8626b6f0a23cf1b2392cd7da7
+  data.tar.gz: 945cce4e13a9ccf35d5f2521da551dc53dc349bdb1667a20ad7ad7c8d509b97d7892761a418152afafad3656ebdecdfc2d8bee0f1922be54a72d40ea4703218f

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (2024-11-16)
+------------------
+
+* Feature - Initial version of this gem.

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/aws_sqs_active_job

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/aws/active_job/sqs/poller'
+
+require 'rails'
+require File.expand_path("config/environment.rb")
+
+Aws::ActiveJob::SQS::Poller.new(ARGV).run

data/lib/active_job/queue_adapters/sqs_adapter/params.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module QueueAdapters
+    class SqsAdapter
+      # Build request parameter of Aws::SQS::Client
+      # @api private
+      class Params
+        class << self
+          def assured_delay_seconds(timestamp)
+            delay = (timestamp - Time.now.to_f).floor
+            delay = 0 if delay.negative?
+            raise ArgumentError, 'Unable to queue a job with a delay great than 15 minutes' if delay > 15.minutes
+
+            delay
+          end
+        end
+
+        def initialize(job, body)
+          @job = job
+          @body = body || job.serialize
+        end
+
+        def queue_url
+          @queue_url ||= Aws::ActiveJob::SQS.config.queue_url_for(@job.queue_name)
+        end
+
+        def entry
+          if Aws::ActiveJob::SQS.fifo?(queue_url)
+            default_entry.merge(options_for_fifo)
+          else
+            default_entry
+          end
+        end
+
+        private
+
+        def default_entry
+          {
+            message_body: Aws::Json.dump(@body),
+            message_attributes: message_attributes
+          }
+        end
+
+        def message_attributes
+          {
+            'aws_sqs_active_job_class' => {
+              string_value: @job.class.to_s,
+              data_type: 'String'
+            },
+            'aws_sqs_active_job_version' => {
+              string_value: Aws::ActiveJob::SQS::VERSION,
+              data_type: 'String'
+            }
+          }
+        end
+
+        def options_for_fifo
+          options = {}
+          options[:message_deduplication_id] =
+            Digest::SHA256.hexdigest(Aws::Json.dump(deduplication_body))
+
+          message_group_id = @job.message_group_id if @job.respond_to?(:message_group_id)
+          message_group_id ||= Aws::ActiveJob::SQS.config.message_group_id
+
+          options[:message_group_id] = message_group_id
+          options
+        end
+
+        def deduplication_body
+          ex_dedup_keys = @job.excluded_deduplication_keys if @job.respond_to?(:excluded_deduplication_keys)
+          ex_dedup_keys ||= Aws::ActiveJob::SQS.config.excluded_deduplication_keys
+
+          @body.except(*ex_dedup_keys)
+        end
+      end
+    end
+  end
+end

data/lib/active_job/queue_adapters/sqs_adapter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+
+module ActiveJob
+  module QueueAdapters
+    # Synchronous adapter for Amazon SQS ActiveJob. This adapter queues jobs synchronously (ie blocking).
+    #
+    # To use this adapter, set up as:
+    #
+    #     config.active_job.queue_adapter = :sqs_async
+    class SqsAdapter
+      def enqueue_after_transaction_commit?
+        # can be removed after Rails 8
+        true
+      end
+
+      def enqueue(job)
+        _enqueue(job)
+      end
+
+      def enqueue_at(job, timestamp)
+        delay = Params.assured_delay_seconds(timestamp)
+        _enqueue(job, nil, delay_seconds: delay)
+      end
+
+      def enqueue_all(jobs)
+        enqueued_count = 0
+        jobs.group_by(&:queue_name).each do |queue_name, same_queue_jobs|
+          queue_url = Aws::ActiveJob::SQS.config.queue_url_for(queue_name)
+          base_send_message_opts = { queue_url: queue_url }
+
+          same_queue_jobs.each_slice(10) do |chunk|
+            entries = chunk.map do |job|
+              entry = Params.new(job, nil).entry
+              entry[:id] = job.job_id
+              entry[:delay_seconds] = Params.assured_delay_seconds(job.scheduled_at) if job.scheduled_at
+              entry
+            end
+
+            send_message_opts = base_send_message_opts.deep_dup
+            send_message_opts[:entries] = entries
+
+            send_message_batch_result = Aws::ActiveJob::SQS.config.client.send_message_batch(send_message_opts)
+            enqueued_count += send_message_batch_result.successful.count
+          end
+        end
+        enqueued_count
+      end
+
+      private
+
+      def _enqueue(job, body = nil, send_message_opts = {})
+        body ||= job.serialize
+        params = Params.new(job, body)
+        send_message_opts = send_message_opts.merge(params.entry)
+        send_message_opts[:queue_url] = params.queue_url
+        Aws::ActiveJob::SQS.config.client.send_message(send_message_opts)
+      end
+    end
+  end
+end

data/lib/active_job/queue_adapters/sqs_async_adapter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+require 'concurrent'
+
+module ActiveJob
+  module QueueAdapters
+    # Asynchronous adapter for Amazon SQS ActiveJob This adapter queues jobs asynchronously (ie non-blocking).
+    #
+    # An error handler can be configured with:
+    #
+    #     Aws::ActiveJob::SQS.config.async_queue_error_handler = ->(error, job, send_message_opts) { ... }
+    #
+    # To use this adapter, set up as:
+    #
+    #     config.active_job.queue_adapter = :sqs_async
+    class SqsAsyncAdapter < SqsAdapter
+      private
+
+      def _enqueue(job, body = nil, send_message_opts = {})
+        # FIFO jobs must be queued in order, so do not queue async
+        queue_url = Aws::ActiveJob::SQS.config.queue_url_for(job.queue_name)
+        if Aws::ActiveJob::SQS.fifo?(queue_url)
+          super
+        else
+          # Serialize is called here because the job’s locale needs to be
+          # determined in this thread and not in some other thread.
+          body = job.serialize
+          Concurrent::Promises
+            .future { super(job, body, send_message_opts) }
+            .rescue do |e|
+              # TODO: should be config logger? fails
+              Rails.logger.error "Failed to queue job #{job}. Reason: #{e}"
+              error_handler = Aws::ActiveJob::SQS.config.async_queue_error_handler
+              error_handler&.call(e, job, send_message_opts)
+            end
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/configuration.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActiveJob
+    module SQS
+      # Use +Aws::ActiveJob::SQS.config+ to access the singleton config instance.
+      class Configuration
+        # Default configuration options
+        # @api private
+        DEFAULTS = {
+          max_messages: 10,
+          shutdown_timeout: 15,
+          retry_standard_errors: true, # TODO: Remove in next MV
+          queues: {},
+          logger: ::Rails.logger,
+          message_group_id: 'SqsActiveJobGroup',
+          excluded_deduplication_keys: ['job_id']
+        }.freeze
+
+        # @api private
+        attr_accessor :queues, :max_messages, :visibility_timeout,
+                      :shutdown_timeout, :client, :logger,
+                      :async_queue_error_handler, :message_group_id
+
+        attr_reader :excluded_deduplication_keys
+
+        # Don't use this method directly: Configuration is a singleton class, use
+        # +Aws::ActiveJob::SQS.config+ to access the singleton config.
+        #
+        # @param [Hash] options
+        # @option options [Hash[Symbol, String]] :queues A mapping between the
+        #   active job queue name and the SQS Queue URL. Note: multiple active
+        #   job queues can map to the same SQS Queue URL.
+        #
+        # @option options  [Integer] :max_messages
+        #    The max number of messages to poll for in a batch.
+        #
+        # @option options [Integer] :visibility_timeout
+        #   If unset, the visibility timeout configured on the
+        #   SQS queue will be used.
+        #   The visibility timeout is the number of seconds
+        #   that a message will not be processable by any other consumers.
+        #   You should set this value to be longer than your expected job runtime
+        #   to prevent other processes from picking up an running job.
+        #   See the (SQS Visibility Timeout Documentation)[https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html]
+        #
+        # @option options [Integer] :shutdown_timeout
+        #   the amount of time to wait
+        #   for a clean shutdown.  Jobs that are unable to complete in this time
+        #   will not be deleted from the SQS queue and will be retryable after
+        #   the visibility timeout.
+        #
+        # @ option options [Boolean] :retry_standard_errors
+        #   If `true`, StandardErrors raised by ActiveJobs are left on the queue
+        #   and will be retried (pending the SQS Queue's redrive/DLQ/maximum receive settings).
+        #   This behavior overrides the standard Rails ActiveJob
+        #   [Retry/Discard for failed jobs](https://guides.rubyonrails.org/active_job_basics.html#retrying-or-discarding-failed-jobs)
+        #   behavior.  When set to `true` the retries provided by this will be
+        #   on top of any retries configured on the job with `retry_on`.
+        #   When `false`, retry behavior is fully configured
+        #   through `retry_on`/`discard_on` on the ActiveJobs.
+        #
+        # @option options [ActiveSupport::Logger] :logger Logger to use
+        #   for the poller.
+        #
+        # @option options [String] :config_file
+        #   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
+        #   +active_job.queue_adapter = :sqs_async+.  Called with:
+        #   [error, job, job_options]
+        #
+        # @option options [SQS::Client] :client SQS Client to use. A default
+        #   client will be created if none is provided.
+        #
+        # @option options [Array] :excluded_deduplication_keys (['job_id'])
+        #   The type of keys stored in the array should be String or Symbol.
+        #   Using this option, job_id is implicitly added to the keys.
+
+        def initialize(options = {})
+          options[:config_file] ||= config_file if File.exist?(config_file)
+          options = DEFAULTS
+                    .merge(file_options(options))
+                    .merge(options)
+          set_attributes(options)
+        end
+
+        def excluded_deduplication_keys=(keys)
+          @excluded_deduplication_keys = keys.map(&:to_s) | ['job_id']
+        end
+
+        def client
+          @client ||= begin
+            client = Aws::SQS::Client.new
+            client.config.user_agent_frameworks << 'aws-activejob-sqs'
+            client
+          end
+        end
+
+        # Return the queue_url for a given job_queue name
+        def queue_url_for(job_queue)
+          job_queue = job_queue.to_sym
+          raise ArgumentError, "No queue defined for #{job_queue}" unless queues.key? job_queue
+
+          queues[job_queue]
+        end
+
+        # @api private
+        def to_s
+          to_h.to_s
+        end
+
+        # @api private
+        def to_h
+          h = {}
+          instance_variables.each do |v|
+            v_sym = v.to_s.delete('@').to_sym
+            val = instance_variable_get(v)
+            h[v_sym] = val
+          end
+          h
+        end
+
+        private
+
+        # Set accessible attributes after merged options.
+        def set_attributes(options)
+          options.each_key do |opt_name|
+            instance_variable_set("@#{opt_name}", options[opt_name])
+            client.config.user_agent_frameworks << 'aws-activejob-sqs' if opt_name == :client
+          end
+        end
+
+        def file_options(options = {})
+          file_path = config_file_path(options)
+          if file_path
+            load_from_file(file_path)
+          else
+            {}
+          end
+        end
+
+        def config_file
+          file = ::Rails.root.join("config/aws_sqs_active_job/#{::Rails.env}.yml")
+          file = ::Rails.root.join('config/aws_sqs_active_job.yml') unless File.exist?(file)
+          file
+        end
+
+        # Load options from YAML file
+        def load_from_file(file_path)
+          opts = load_yaml(file_path) || {}
+          opts.deep_symbolize_keys
+        end
+
+        # @return [String] Configuration path found in environment or YAML file.
+        def config_file_path(options)
+          options[:config_file] || ENV.fetch('AWS_SQS_ACTIVE_JOB_CONFIG_FILE', nil)
+        end
+
+        def load_yaml(file_path)
+          require 'erb'
+          source = ERB.new(File.read(file_path)).result
+
+          # Avoid incompatible changes with Psych 4.0.0
+          # https://bugs.ruby-lang.org/issues/17866
+          begin
+            YAML.safe_load(source, aliases: true) || {}
+          rescue ArgumentError
+            YAML.safe_load(source) || {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/deduplication.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActiveJob
+    module SQS
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :excluded_deduplication_keys
+      end
+
+      # class methods for SQS ActiveJob.
+      module ClassMethods
+        def deduplicate_without(*keys)
+          self.excluded_deduplication_keys = keys.map(&:to_s) | ['job_id']
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/executor.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+module Aws
+  module ActiveJob
+    module SQS
+      # CLI runner for polling for SQS ActiveJobs
+      class Executor
+        DEFAULTS = {
+          min_threads: 0,
+          max_threads: Integer(Concurrent.available_processor_count || Concurrent.processor_count),
+          auto_terminate: true,
+          idletime: 60, # 1 minute
+          fallback_policy: :abort # Concurrent::RejectedExecutionError must be handled
+        }.freeze
+
+        def initialize(options = {})
+          @executor = Concurrent::ThreadPoolExecutor.new(DEFAULTS.merge(options))
+          @retry_standard_errors = options[:retry_standard_errors]
+          @logger = options[:logger] || ActiveSupport::Logger.new($stdout)
+          @task_complete = Concurrent::Event.new
+        end
+
+        def execute(message)
+          post_task(message)
+        rescue Concurrent::RejectedExecutionError
+          # no capacity, wait for a task to complete
+          @task_complete.reset
+          @task_complete.wait
+          retry
+        end
+
+        def shutdown(timeout = nil)
+          @executor.shutdown
+          clean_shutdown = @executor.wait_for_termination(timeout)
+          if clean_shutdown
+            @logger.info 'Clean shutdown complete.  All executing jobs finished.'
+          else
+            @logger.info "Timeout (#{timeout}) exceeded.  Some jobs may not have " \
+                         'finished cleanly.  Unfinished jobs will not be removed from ' \
+                         'the queue and can be ru-run once their visibility timeout ' \
+                         'passes.'
+          end
+        end
+
+        private
+
+        def post_task(message)
+          @executor.post(message) do |message|
+            job = JobRunner.new(message)
+            @logger.info("Running job: #{job.id}[#{job.class_name}]")
+            job.run
+            message.delete
+          rescue Aws::Json::ParseError => e
+            @logger.error "Unable to parse message body: #{message.data.body}. Error: #{e}."
+          rescue StandardError => e
+            job_msg = job ? "#{job.id}[#{job.class_name}]" : 'unknown job'
+            @logger.info "Error processing job #{job_msg}: #{e}"
+            @logger.debug e.backtrace.join("\n")
+
+            if @retry_standard_errors && !job.exception_executions?
+              @logger.info(
+                'retry_standard_errors is enabled and job has not ' \
+                "been retried by Rails.  Leaving #{job_msg} in the queue."
+              )
+            else
+              message.delete
+            end
+          ensure
+            @task_complete.set
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/job_runner.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActiveJob
+    module SQS
+      # @api private
+      class JobRunner
+        attr_reader :id, :class_name
+
+        def initialize(message)
+          @job_data = Aws::Json.load(message.data.body)
+          @class_name = @job_data['job_class'].constantize
+          @id = @job_data['job_id']
+        end
+
+        def run
+          ::ActiveJob::Base.execute @job_data
+        end
+
+        def exception_executions?
+          @job_data['exception_executions'] &&
+            !@job_data['exception_executions'].empty?
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/lambda_handler.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+
+module Aws
+  module ActiveJob
+    module SQS
+      class << self
+        # A lambda event handler to run jobs from an SQS queue trigger.
+        # Configure the entrypoint to: +config/environment.Aws::ActiveJob::SQS.lambda_job_handler+
+        # This will load your Rails environment, and then use this method as the handler.
+        def lambda_job_handler(event:, context:)
+          return 'no records to process' unless event['Records']
+
+          event['Records'].each do |record|
+            sqs_msg = to_sqs_msg(record)
+            job = Aws::ActiveJob::SQS::JobRunner.new(sqs_msg)
+            puts("Running job: #{job.id}[#{job.class_name}]")
+            job.run
+            sqs_msg.delete
+          end
+          "Processed #{event['Records'].length} jobs."
+        end
+
+        private
+
+        def to_sqs_msg(record)
+          msg = Aws::SQS::Types::Message.new(
+            body: record['body'],
+            md5_of_body: record['md5OfBody'],
+            message_attributes: to_message_attributes(record),
+            message_id: record['messageId'],
+            receipt_handle: record['receiptHandle']
+          )
+          Aws::SQS::Message.new(
+            queue_url: to_queue_url(record),
+            receipt_handle: msg.receipt_handle,
+            data: msg,
+            client: Aws::ActiveJob::SQS.config.client
+          )
+        end
+
+        def to_message_attributes(record)
+          record['messageAttributes'].transform_values do |value|
+            {
+              string_value: value['stringValue'],
+              binary_value: value['binaryValue'],
+              string_list_values: ['stringListValues'],
+              binary_list_values: value['binaryListValues'],
+              data_type: value['dataType']
+            }
+          end
+        end
+
+        def to_queue_url(record)
+          source_arn = record['eventSourceARN']
+          raise ArgumentError, "Invalid queue arn: #{source_arn}" unless Aws::ARNParser.arn?(source_arn)
+
+          arn = Aws::ARNParser.parse(source_arn)
+          sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(arn.region)
+          "https://sqs.#{arn.region}.#{sfx}/#{arn.account_id}/#{arn.resource}"
+        end
+      end
+    end
+  end
+end

data/lib/aws/active_job/sqs/poller.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+require 'optparse'
+require 'concurrent'
+
+module Aws
+  module ActiveJob
+    module SQS
+      # CLI runner for polling for SQS ActiveJobs
+      # Use `aws_sqs_active_job --help` for detailed usage
+      class Poller
+        class Interrupt < StandardError; end
+
+        DEFAULT_OPTS = {
+          threads: 2 * Concurrent.processor_count,
+          max_messages: 10,
+          shutdown_timeout: 15,
+          backpressure: 10,
+          retry_standard_errors: true
+        }.freeze
+
+        def initialize(args = ARGV)
+          @options = parse_args(args)
+          # Set_environment must be run before we boot_rails
+          set_environment
+        end
+
+        def set_environment
+          @environment = @options[:environment] || ENV['APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+        end
+
+        def run
+          # exit 0
+          boot_rails
+
+          # cannot load config (from file or initializers) until after
+          # rails has been booted.
+          @options = DEFAULT_OPTS
+                     .merge(Aws::ActiveJob::SQS.config.to_h)
+                     .merge(@options.to_h)
+          validate_config
+          # ensure we have a logger configured
+          @logger = @options[:logger] || ActiveSupport::Logger.new($stdout)
+          @logger.info("Starting Poller with options=#{@options}")
+
+          Signal.trap('INT') { raise Interrupt }
+          Signal.trap('TERM') { raise Interrupt }
+          @executor = Executor.new(
+            max_threads: @options[:threads],
+            logger: @logger,
+            max_queue: @options[:backpressure],
+            retry_standard_errors: @options[:retry_standard_errors]
+          )
+
+          poll
+        rescue Interrupt
+          @logger.info 'Process Interrupted or killed - attempting to shutdown cleanly.'
+          shutdown
+          exit
+        end
+
+        private
+
+        def shutdown
+          @executor.shutdown(@options[:shutdown_timeout])
+        end
+
+        def poll
+          queue_url = Aws::ActiveJob::SQS.config.queue_url_for(@options[:queue])
+          @logger.info "Polling on: #{@options[:queue]} => #{queue_url}"
+          client = Aws::ActiveJob::SQS.config.client
+          @poller = Aws::SQS::QueuePoller.new(queue_url, client: client)
+          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.
+          poller_options[:max_number_of_messages] = 1 if Aws::ActiveJob::SQS.fifo?(queue_url)
+
+          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"
+            msgs.each do |msg|
+              @executor.execute(Aws::SQS::Message.new(
+                                  queue_url: queue_url,
+                                  receipt_handle: msg.receipt_handle,
+                                  data: msg,
+                                  client: client
+                                ))
+            end
+          end
+        end
+
+        def boot_rails
+          ENV['RACK_ENV'] = ENV['RAILS_ENV'] = @environment
+          require 'rails'
+          require File.expand_path('config/environment.rb')
+        end
+
+        # rubocop:disable Metrics
+        def parse_args(argv)
+          out = {}
+          parser = ::OptionParser.new do |opts|
+            opts.on('-q', '--queue STRING', '[Required] Queue to poll') { |a| out[:queue] = a }
+            opts.on('-e', '--environment STRING',
+                    'Rails environment (defaults to development). You can also use the APP_ENV or RAILS_ENV environment variables to specify the environment.') do |a|
+              out[:environment] = a
+            end
+            opts.on('-t', '--threads INTEGER', Integer,
+                    'The maximum number of worker threads to create.  Defaults to 2x the number of processors available on this system.') do |a|
+              out[:threads] = a
+            end
+            opts.on('-b', '--backpressure INTEGER', Integer,
+                    'The maximum number of messages to have waiting in the Executor queue. This should be a low, but non zero number.  Messages in the Executor queue cannot be picked up by other processes and will slow down shutdown.') do |a|
+              out[:backpressure] = a
+            end
+            opts.on('-m', '--max_messages INTEGER', Integer,
+                    'Max number of messages to receive in a batch from SQS.') do |a|
+              out[:max_messages] = a
+            end
+            opts.on('-v', '--visibility_timeout INTEGER', Integer,
+                    'The visibility timeout is the number of seconds that a message will not be processable by any other consumers. You should set this value to be longer than your expected job runtime to prevent other processes from picking up an running job.  See the SQS Visibility Timeout Documentation at https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html.') do |a|
+              out[:visibility_timeout] = a
+            end
+            opts.on('-s', '--shutdown_timeout INTEGER', Integer,
+                    'The amount of time to wait for a clean shutdown.  Jobs that are unable to complete in this time will not be deleted from the SQS queue and will be retryable after the visibility timeout.') do |a|
+              out[:shutdown_timeout] = a
+            end
+            opts.on('--[no-]retry_standard_errors [FLAG]', TrueClass,
+                    'When set, retry all StandardErrors (leaving failed messages on the SQS Queue). These retries are ON TOP of standard Rails ActiveJob retries set by retry_on in the ActiveJob.') do |a|
+              out[:retry_standard_errors] = a.nil? ? true : a
+            end
+          end
+
+          parser.banner = 'aws_sqs_active_job [options]'
+          parser.on_tail '-h', '--help', 'Show help' do
+            puts parser
+            exit 1
+          end
+
+          parser.parse(argv)
+          out
+        end
+        # rubocop:enable Metrics
+
+        def validate_config
+          raise ArgumentError, 'You must specify the name of the queue to process jobs from' unless @options[:queue]
+        end
+      end
+    end
+  end
+end

data/lib/aws-activejob-sqs.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'active_job/queue_adapters/sqs_adapter'
+require_relative 'active_job/queue_adapters/sqs_adapter/params'
+require_relative 'active_job/queue_adapters/sqs_async_adapter'
+require_relative 'aws/active_job/sqs/configuration'
+require_relative 'aws/active_job/sqs/deduplication'
+require_relative 'aws/active_job/sqs/executor'
+require_relative 'aws/active_job/sqs/job_runner'
+require_relative 'aws/active_job/sqs/lambda_handler'
+
+module Aws
+  module ActiveJob
+    module SQS
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+
+      # @return [Configuration] the (singleton) Configuration
+      def self.config
+        @config ||= Configuration.new
+      end
+
+      # @yield Configuration
+      def self.configure
+        yield(config)
+      end
+
+      # @param queue_url [String]
+      # @return [Boolean] true if the queue_url is a FIFO queue
+      def self.fifo?(queue_url)
+        queue_url.end_with?('.fifo')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: aws-activejob-sqs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.56.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.56.0
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Amazon Simple Queue Service as an ActiveJob adapter
+email:
+- aws-dr-rubygems@amazon.com
+executables:
+- aws_sqs_active_job
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- VERSION
+- bin/aws_sqs_active_job
+- lib/active_job/queue_adapters/sqs_adapter.rb
+- lib/active_job/queue_adapters/sqs_adapter/params.rb
+- lib/active_job/queue_adapters/sqs_async_adapter.rb
+- lib/aws-activejob-sqs.rb
+- lib/aws/active_job/sqs/configuration.rb
+- lib/aws/active_job/sqs/deduplication.rb
+- lib/aws/active_job/sqs/executor.rb
+- lib/aws/active_job/sqs/job_runner.rb
+- lib/aws/active_job/sqs/lambda_handler.rb
+- lib/aws/active_job/sqs/poller.rb
+homepage: https://github.com/aws/aws-activejob-sqs-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActiveJob integration with SQS
+test_files: []