job-iteration 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32eb2fd6eb2dc54f59eff462a3cde3882192134c2964ffc05b737957e3d4abb
-  data.tar.gz: 255864c2fac9d3cc0f75da1929d18c1aeb8e63ff83ea3dc6c19038c0e4894e54
+  metadata.gz: 4470d17b555f82240c1849477ebfb46d7385c27524748072c0dcf93af588d9eb
+  data.tar.gz: 1dc09430105ac34917aace4451c2ec7255cca9319a5ada563ed840857add81b6
 SHA512:
-  metadata.gz: 7c241d626e4c92c4424dd08745feab35f1606fafbf6f0d610f34a704d16702a52623f646e5715925b331509257c737053b25bf90091f61a948b6fba2315cc659
-  data.tar.gz: 19b821e84f93954cea21b0709455ac5ad12b2633f70c2182ae93e75d2e883a0985dda1cf7c56ac89295caab1720ef3508857201d0c33f18b35ffad76996f093b
+  metadata.gz: d1c25928d819bcff005e83e8cc7183e323a4e69d74b16b43884b1a1c1b8f531b54a8ece05004e7a6dfe28c94542454fefa11ff239b16e8c92cdb9d1508a3fd79
+  data.tar.gz: 3a8bfcfd03312d82be3ba3974fceecac5d8c53aa9129cb59f9321875ec10a448ffe4cd50b9949cf9da79a6f47c7e586fe266356c9e20111f8f60d48f775ed5a1

data/.github/workflows/ci.yml

@@ -15,51 +15,30 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
-        rails: ["5.2", "6.0", "6.1", "7.0", "7.1", "7.2", "edge"]
+        ruby: ["3.0", "3.1", "3.2", "3.3", "3.4"]
+        rails: ["6.1", "7.0", "7.1", "7.2", "8.0", "edge"]
         gemfile: [rails_gems]
         exclude:
-          - ruby: "2.6"
-            rails: "7.0"
-          - ruby: "2.6"
-            rails: "7.1"
-          - ruby: "2.6"
-            rails: "7.2"
-          - ruby: "2.6"
-            rails: "edge"
-          - ruby: "2.7"
-            rails: "7.1"
-          - ruby: "2.7"
-            rails: "7.2"
-          - ruby: "2.7"
-            rails: "edge"
-          - ruby: "3.0"
-            rails: "5.2"
           - ruby: "3.0"
             rails: "7.1"
           - ruby: "3.0"
             rails: "7.2"
+          - ruby: "3.0"
+            rails: "8.0"
           - ruby: "3.0"
             rails: "edge"
           - ruby: "3.1"
-            rails: "5.2"
-          - ruby: "3.1"
-            rails: "6.0"
+            rails: "8.0"
           - ruby: "3.1"
             rails: "edge"
-          - ruby: "3.2"
-            rails: "5.2"
-          - ruby: "3.2"
-            rails: "6.0"
           - ruby: "3.2"
             rails: "6.1"
-          - ruby: "3.3"
-            rails: "5.2"
-          - ruby: "3.3"
-            rails: "6.0"
           - ruby: "3.3"
             rails: "6.1"
-
+          - ruby: "3.4"
+            rails: "6.1"
+          - ruby: "3.4"
+            rails: "7.0"
         include:
           - ruby: head
             rails: "edge"

data/.ruby-version

@@ -1 +1 @@
-3.3.3
+3.4.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Main (unreleased)
 
+### Breaking Changes
+
+nil
+
 ### Changes
 
 nil
@@ -12,7 +16,18 @@ nil
 
 nil
 
-## v1.9.0 (Feb 3, 2024)
+## v1.10.0 (Mar 20, 2025)
+
+### Breaking Changes
+
+- [544](https://github.com/Shopify/job-iteration/pull/544) - Drop support for Ruby 2.6 and 2.7, and Rails 5.2 and 6.0. The minimum supported Ruby version is now 3.0, and the minimum supported Rails version is 6.1.
+
+### Features
+
+- [547](https://github.com/Shopify/job-iteration/pull/547) Add interruption adapter for [DelayedJob](https://github.com/collectiveidea/delayed_job).
+- [556](https://github.com/Shopify/job-iteration/pull/556) Add support for generic job classes in the Tapioca Sorbet compiler.
+
+## v1.9.0 (Feb 3, 2025)
 
 ### Features
 

data/Gemfile

@@ -10,16 +10,19 @@ gemspec
 # for integration testing
 gem "sidekiq"
 gem "resque"
+gem "delayed_job"
 
 if defined?(@rails_gems_requirements) && @rails_gems_requirements
   # We avoid the `gem "..."` syntax here so Dependabot doesn't try to update these gems.
   [
     "activejob",
     "activerecord",
+    "railties",
   ].each { |name| gem name, @rails_gems_requirements }
 else
   # gem "activejob" # Set in gemspec
   gem "activerecord"
+  gem "railties"
 end
 
 gem "mysql2", github: "brianmario/mysql2"

data/Gemfile.lock

@@ -8,12 +8,28 @@ GIT
 PATH
   remote: .
   specs:
-    job-iteration (1.9.0)
-      activejob (>= 5.2)
+    job-iteration (1.10.0)
+      activejob (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.1)
+      activesupport (= 8.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
     activejob (8.0.1)
       activesupport (= 8.0.1)
       globalid (>= 0.3.6)
@@ -40,19 +56,33 @@ GEM
     base64 (0.2.0)
     benchmark (0.4.0)
     bigdecimal (3.1.9)
+    builder (3.3.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.0)
+    crass (1.0.6)
     csv (3.3.2)
+    date (3.4.1)
+    delayed_job (4.1.13)
+      activesupport (>= 3.0, < 9.0)
     drb (2.2.1)
     erubi (1.13.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.9.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.1)
     language_server-protocol (3.17.0.4)
-    logger (1.6.5)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
     method_source (1.1.0)
     minitest (5.25.4)
     mocha (2.7.1)
@@ -62,16 +92,28 @@ GEM
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     netrc (0.11.0)
+    nokogiri (1.18.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.3-x86_64-linux-gnu)
+      racc (~> 1.4)
     parallel (1.26.3)
-    parser (3.3.7.0)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.3.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (5.2.3)
+      date
+      stringio
     racc (1.8.1)
-    rack (3.1.8)
+    rack (3.1.12)
     rack-protection (4.1.1)
       base64 (>= 0.1.0)
       logger (>= 1.6.0)
@@ -79,46 +121,73 @@ GEM
     rack-session (2.1.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbi (0.2.4)
+    rbi (0.3.0)
       prism (~> 1.0)
+      rbs (>= 3.4.4)
       sorbet-runtime (>= 0.5.9204)
-    redis (5.3.0)
+    rbs (3.8.1)
+      logger
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    redis (5.4.0)
       redis-client (>= 0.22.0)
-    redis-client (0.23.2)
+    redis-client (0.24.0)
       connection_pool
     redis-namespace (1.11.0)
       redis (>= 4)
     regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
     resque (2.7.0)
       mono_logger (~> 1)
       multi_json (~> 1.0)
       redis-namespace (~> 1.6)
       sinatra (>= 0.9.2)
-    rubocop (1.71.0)
+    rubocop (1.73.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.36.2, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
-    rubocop-shopify (2.15.1)
-      rubocop (~> 1.51)
+    rubocop-shopify (2.16.0)
+      rubocop (~> 1.62)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     securerandom (0.4.1)
-    sidekiq (7.3.8)
-      base64
-      connection_pool (>= 2.3.0)
-      logger
-      rack (>= 2.2.4)
-      redis-client (>= 0.22.2)
+    sidekiq (8.0.1)
+      connection_pool (>= 2.5.0)
+      json (>= 2.9.0)
+      logger (>= 1.6.2)
+      rack (>= 3.1.0)
+      redis-client (>= 0.23.2)
     sinatra (4.1.1)
       logger (>= 1.6.0)
       mustermann (~> 3.0)
@@ -126,21 +195,22 @@ GEM
       rack-protection (= 4.1.1)
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    sorbet (0.5.11787)
-      sorbet-static (= 0.5.11787)
-    sorbet-runtime (0.5.11787)
-    sorbet-static (0.5.11787-universal-darwin)
-    sorbet-static (0.5.11787-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11787)
-      sorbet (= 0.5.11787)
-      sorbet-runtime (= 0.5.11787)
-    spoom (1.5.2)
+    sorbet (0.5.11915)
+      sorbet-static (= 0.5.11915)
+    sorbet-runtime (0.5.11915)
+    sorbet-static (0.5.11915-universal-darwin)
+    sorbet-static (0.5.11915-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11915)
+      sorbet (= 0.5.11915)
+      sorbet-runtime (= 0.5.11915)
+    spoom (1.6.0)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
       rbi (>= 0.2.3)
       sorbet-static-and-runtime (>= 0.5.10187)
       thor (>= 0.19.2)
-    tapioca (0.16.8)
+    stringio (3.1.5)
+    tapioca (0.16.11)
       benchmark
       bundler (>= 2.2.25)
       netrc (>= 0.11.0)
@@ -158,11 +228,13 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
+    useragent (0.16.11)
     yard (0.9.37)
     yard-sorbet (0.9.0)
       sorbet-runtime
       yard
+    zeitwerk (2.7.2)
 
 PLATFORMS
   arm64-darwin
@@ -172,6 +244,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord
   csv
+  delayed_job
   globalid
   i18n
   job-iteration!
@@ -179,6 +252,7 @@ DEPENDENCIES
   mocha
   mysql2!
   pry
+  railties
   rake
   redis
   resque

data/README.md

@@ -151,7 +151,25 @@ class NestedIterationJob < ApplicationJob
 end
 ```
 
-Iteration hooks into Sidekiq and Resque out of the box to support graceful interruption. No extra configuration is required.
+Iteration hooks into most popular queue adapters out of the box to support graceful interruption. No extra configuration is required.
+
+## Supported dependencies
+
+Job-iteration currently supports the following queue adapters (in order of implementation):
+
+- [Resque](https://github.com/resque/resque)
+- [Sidekiq](https://github.com/sidekiq/sidekiq/)
+- [GoodJob](https://github.com/bensheldon/good_job)
+- [Solid Queue](https://github.com/rails/solid_queue)
+- [Amazon SQS](https://github.com/aws/aws-activejob-sqs-ruby)
+- [Delayed::Job](https://github.com/collectiveidea/delayed_job)
+
+It supports the following platforms:
+
+- Ruby 3.0 and later
+- Rails 6.1 and later
+
+Support for older platforms that have reached end of life may occasionally be dropped if maintaining backwards compatibility is cumbersome.
 
 ## Guides
 

data/job-iteration.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "job-iteration/version"
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.0"
   spec.name          = "job-iteration"
   spec.version       = JobIteration::VERSION
   spec.authors       = ["Shopify"]
@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "https://github.com/Shopify/job-iteration/blob/main/CHANGELOG.md"
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.add_dependency("activejob", ">= 5.2")
+  spec.add_dependency("activejob", ">= 6.1")
 end

data/lib/job-iteration/interruption_adapters/delayed_job_adapter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+begin
+  require "delayed_job"
+rescue LoadError
+  # DelayedJobb is not available, no need to load the adapter
+  return
+end
+
+begin
+  # Delayed::Worker#stop? was introduced in DelayedJob 3.0.3
+  gem("delayed_job", ">= 3.0.3")
+rescue Gem::LoadError
+  warn("job-iteration's interruption adapter for DelayedJob requires DelayedJob 3.0.3 or newer")
+  return
+end
+
+module JobIteration
+  module InterruptionAdapters
+    module DelayedJobAdapter
+      class << self
+        attr_accessor :delayed_worker, :delayed_worker_started
+
+        def call
+          if delayed_worker_started
+            delayed_worker.nil? || delayed_worker.stop?
+          else
+            false
+          end
+        end
+      end
+
+      self.delayed_worker_started = false
+
+      class DelayedJobPlugin < Delayed::Plugin
+        callbacks do |lifecycle|
+          lifecycle.before(:execute) do |worker|
+            DelayedJobAdapter.delayed_worker = worker
+            DelayedJobAdapter.delayed_worker_started = true
+          end
+
+          lifecycle.after(:execute) do |_worker|
+            DelayedJobAdapter.delayed_worker = nil
+          end
+        end
+      end
+      private_constant :DelayedJobPlugin
+
+      Delayed::Worker.plugins << DelayedJobPlugin
+    end
+
+    register(:delayed_job, DelayedJobAdapter)
+  end
+end

data/lib/job-iteration/interruption_adapters.rb

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

data/lib/job-iteration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobIteration
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end

data/lib/tapioca/dsl/compilers/job_iteration.rb

@@ -55,10 +55,18 @@ module Tapioca
             # Sorbet expects optional keyword arguments to be after required keyword arguments.
             expanded_parameters.sort_by! { |typed_param| PARAM_TYPES_IN_ORDER.index(typed_param.param.class) }
 
+            number_of_generic_type_members = Tapioca::Runtime::GenericTypeRegistry.lookup_type_variables(constant)&.size
+
+            returned_job_class = if number_of_generic_type_members&.nonzero?
+              "#{constant_name}[#{number_of_generic_type_members.times.map { "T.untyped" }.join(", ")}]"
+            else
+              constant_name
+            end
+
             job.create_method(
               "perform_later",
-              parameters: perform_later_parameters(expanded_parameters, constant_name),
-              return_type: "T.any(#{constant_name}, FalseClass)",
+              parameters: perform_later_parameters(expanded_parameters, returned_job_class),
+              return_type: "T.any(#{returned_job_class}, FalseClass)",
               class_method: true,
             )
 
@@ -83,15 +91,15 @@ module Tapioca
         sig do
           params(
             parameters: T::Array[RBI::TypedParam],
-            constant_name: T.nilable(String),
+            returned_job_class: String,
           ).returns(T::Array[RBI::TypedParam])
         end
-        def perform_later_parameters(parameters, constant_name)
+        def perform_later_parameters(parameters, returned_job_class)
           if ::Gem::Requirement.new(">= 7.0").satisfied_by?(::ActiveJob.gem_version)
             parameters.reject! { |typed_param| RBI::BlockParam === typed_param.param }
             parameters + [create_block_param(
               "block",
-              type: "T.nilable(T.proc.params(job: #{constant_name}).void)",
+              type: "T.nilable(T.proc.params(job: #{returned_job_class}).void)",
             )]
           else
             parameters

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Shopify
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description: Makes your background jobs interruptible and resumable.
 email:
 - ops-accounts+shipit@shopify.com
@@ -61,6 +61,7 @@ files:
 - lib/job-iteration/csv_enumerator.rb
 - lib/job-iteration/enumerator_builder.rb
 - lib/job-iteration/interruption_adapters.rb
+- lib/job-iteration/interruption_adapters/delayed_job_adapter.rb
 - lib/job-iteration/interruption_adapters/good_job_adapter.rb
 - lib/job-iteration/interruption_adapters/null_adapter.rb
 - lib/job-iteration/interruption_adapters/resque_adapter.rb
@@ -88,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Makes your background jobs interruptible and resumable.
 test_files: []