Merge pull request #523 from kakubin/interruption_adapter_aws_activej…

…ob_sqs

Add interruption adapter for aws-activejob-sqs

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - [340](https://github.com/Shopify/job-iteration/pull/340) Add `cursor.iteration` instrumentation for the query to fetch the next batch of records for the Active Record cursor.
 - [513](https://github.com/Shopify/job-iteration/pull/513) Deprecate returning enumerators from `build_enumerator` that are not wrapped with `enumerator_builder.wrap`. The built-in enumerator builders now always wrap.
+- [523](https://github.com/Shopify/job-iteration/pull/523) Add interruption adapter for [aws-activejob-sqs](https://github.com/aws/aws-activejob-sqs-ruby).
 
 ## v1.7.0 (Oct 11, 2024)
 

lib/job-iteration/interruption_adapters.rb

@@ -4,7 +4,7 @@
 
 module JobIteration
   module InterruptionAdapters
-    BUNDLED_ADAPTERS = [:good_job, :resque, :sidekiq, :solid_queue].freeze # @api private
+    BUNDLED_ADAPTERS = [:good_job, :resque, :sidekiq, :solid_queue, :sqs].freeze # @api private
 
     class << self
       # Returns adapter for specified name.

lib/job-iteration/interruption_adapters/sqs_adapter.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+begin
+  require "aws-activejob-sqs"
+rescue LoadError
+  # Aws::ActiveJob::SQS is not available, no need to load the adapter
+  return
+end
+
+begin
+  # Aws::ActiveJob::SQS.on_worker_stop was introduced in Aws::ActiveJob::SQS 0.1.1
+  gem("aws-activejob-sqs", ">= 0.1.1")
+rescue Gem::LoadError
+  warn("job-iteration's interruption adapter for SQS requires aws-activejob-sqs 0.1.1 or newer")
+  return
+end
+
+module JobIteration
+  module InterruptionAdapters
+    module SqsAdapter
+      class << self
+        attr_accessor :stopping
+
+        def call
+          stopping
+        end
+      end
+
+      Aws::ActiveJob::SQS.on_worker_stop do
+        SqsAdapter.stopping = true
+      end
+    end
+
+    register(:sqs, SqsAdapter)
+  end
+end

test/integration/interruption_adapters_test.rb

@@ -37,7 +37,7 @@ class InterruptionAdaptersTest < ActiveSupport::TestCase
       require 'bundler/setup'
       require 'job-iteration'
 
-      adapters_to_exclude = [:good_job, :solid_queue] # These require a Rails app to be loaded
+      adapters_to_exclude = [:good_job, :solid_queue, :sqs] # These require a Rails app to be loaded
       adapters_to_test = JobIteration::InterruptionAdapters::BUNDLED_ADAPTERS - adapters_to_exclude
 
       adapters_to_test.each do |name|