job-iteration 1.12.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a851271cdcba188da01fad33b65fa92cdbbe27d6515c44ee950d27d761e1519
-  data.tar.gz: e15477e57d43194a00067d026dc445c9edbc9225ba4bef2b0de60f91618d9874
+  metadata.gz: e8e5e3fa1240a67b88f2b83290f7b01fcadb28b4a7be257f646d199cff9c2e97
+  data.tar.gz: 6a2130de073c8c5eb29c13934f7e4bb73af31cf15fc33af74b5738b420a9b38b
 SHA512:
-  metadata.gz: a7abcf968843fcfc5c260adae6998f905398308acdd3b42fd8a4208556e3207c1cd0650724b2f48f07a7d23f84cc1740ede0fc6066ee8c211109de556b83357d
-  data.tar.gz: d8ebd653153f30e87d91951be33b38a7c8644a58865e7bff1c76603cd5287301fe596116c9eac412cd93a5b571e1062e6ef766b38b8debd6d93c20b44f9af4b8
+  metadata.gz: b6316aa38f0e6f7df7874a478253b6e285db61c6077089c43ef1edfce408ec1835cdd7d50d4ccf257e096677cc4fcdb23e67cc609efc48998ae91a0667a8974a
+  data.tar.gz: ac9fdbf6afeb440010323c70aa1fcdf60288460788893b0a0dbc536684caeca3291a0e90c80142439c7aac4efbf4853039b482ae37078d2b2c69ab2d565680be

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## Main (unreleased)
-
+ 
 ### Breaking Changes
 
 nil
@@ -16,6 +16,30 @@ nil
 
 nil
 
+## v1.13.1 (Apr 28, 2026)
+
+### Bug fixes
+
+- [#699](https://github.com/Shopify/job-iteration/pull/699) - Fix tapioca compiler dropping empty FixedHash `{}` params.
+
+## v1.13.0 (Mar 23, 2026)
+
+### Breaking Changes
+
+- [673](https://github.com/Shopify/job-iteration/pull/673) - Drop support for Ruby 3.0 and Rails 6.1. The minimum supported Ruby version is now 3.1 and the minimum supported Rails version is now 7.0.
+
+### Changes
+
+nil
+
+### Features
+
+- [683](https://github.com/Shopify/job-iteration/pull/683) Add support for logging interruption reasons from the interruption_adapters and job_should_exit? hooks
+
+### Bug fixes
+
+nil
+
 ## v1.12.0 (Jan 16, 2026)
 
 ### Features

data/README.md

@@ -166,8 +166,8 @@ Job-iteration currently supports the following queue adapters (in order of imple
 
 It supports the following platforms:
 
-- Ruby 3.0 and later
-- Rails 6.1 and later
+- Ruby 3.1 and later
+- Rails 7.0 and later
 
 Support for older platforms that have reached end of life may occasionally be dropped if maintaining backwards compatibility is cumbersome.
 

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 = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
   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", ">= 6.1")
+  spec.add_dependency("activejob", ">= 7.0")
 end

data/lib/job-iteration/interruption_adapters.rb

@@ -25,6 +25,11 @@ module JobIteration
 
       # Registers adapter for specified name.
       #
+      # The adapter must respond to +call+ and return a falsy value to continue iterating,
+      # or a truthy value to signal interruption. If the adapter returns a String, it will
+      # be used as the interruption reason in logs and the +interrupted.iteration+
+      # notification. Otherwise, the reason defaults to +"interrupted"+.
+      #
       #   JobIteration::InterruptionAdapters.register(:sidekiq, MyCustomSidekiqAdapter)
       def register(name, adapter)
         raise ArgumentError, "adapter must be callable" unless adapter.respond_to?(:call)

data/lib/job-iteration/iteration.rb

@@ -188,10 +188,12 @@ module JobIteration
           self.cursor_position = cursor_from_enumerator
         end
 
-        next unless job_should_exit?
+        reason = job_should_exit?
+        next unless reason
 
         self.executions -= 1 if executions > 1
         @needs_reenqueue = true
+        @interrupt_reason = reason.is_a?(String) ? reason : "unknown"
         return false
       end
 
@@ -206,7 +208,10 @@ module JobIteration
     end
 
     def reenqueue_iteration_job
-      ActiveSupport::Notifications.instrument("interrupted.iteration", instrumentation_tags)
+      ActiveSupport::Notifications.instrument(
+        "interrupted.iteration",
+        instrumentation_tags.merge(reason: @interrupt_reason),
+      )
 
       self.times_interrupted += 1
 
@@ -289,9 +294,14 @@ module JobIteration
 
     def job_should_exit?
       max_job_runtime = job_iteration_max_job_runtime
-      return true if max_job_runtime && start_time && (Time.now.utc - start_time) > max_job_runtime
+      if max_job_runtime && start_time && (Time.now.utc - start_time) > max_job_runtime
+        return "max_job_runtime_exceeded"
+      end
+
+      result = interruption_adapter.call
+      return (result.is_a?(String) ? result : "interrupted") if result
 
-      interruption_adapter.call || (defined?(super) && super)
+      (defined?(super) && super) || false
     end
 
     def job_iteration_max_job_runtime

data/lib/job-iteration/log_subscriber.rb

@@ -22,7 +22,7 @@ module JobIteration
     def interrupted(event)
       info do
         "[JobIteration::Iteration] Interrupting and re-enqueueing the job " \
-          "cursor_position=#{event.payload[:cursor_position]}"
+          "cursor_position=#{event.payload[:cursor_position]} reason=#{event.payload[:reason] || "nil"}"
       end
     end
 

data/lib/job-iteration/version.rb

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

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

@@ -38,13 +38,7 @@ module Tapioca
               fixed_hash_args = signature.arg_types.select { |arg_type| T::Types::FixedHash === arg_type[1] }.to_h
               expanded_parameters = parameters.flat_map do |typed_param|
                 if (hash_type = fixed_hash_args[typed_param.param.name.to_sym])
-                  hash_type.types.map do |key, value|
-                    if value.name.start_with?("T.nilable")
-                      create_kw_opt_param(key.to_s, type: value.to_s, default: "nil")
-                    else
-                      create_kw_param(key.to_s, type: value.to_s)
-                    end
-                  end
+                  expand_fixed_hash(typed_param, hash_type)
                 else
                   typed_param
                 end
@@ -89,6 +83,21 @@ module Tapioca
 
         private
 
+        sig { params(typed_param: RBI::TypedParam, hash_type: T::Types::FixedHash).returns(T.any(RBI::TypedParam, T::Array[RBI::TypedParam])) }
+        def expand_fixed_hash(typed_param, hash_type)
+          if hash_type.types.empty?
+            typed_param
+          else
+            hash_type.types.map do |key, value|
+              if value.name.start_with?("T.nilable")
+                create_kw_opt_param(key.to_s, type: value.to_s, default: "nil")
+              else
+                create_kw_param(key.to_s, type: value.to_s)
+              end
+            end
+          end
+        end
+
         sig do
           params(
             parameters: T::Array[RBI::TypedParam],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Shopify
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 description: Makes your background jobs interruptible and resumable.
 email:
 - ops-accounts+shipit@shopify.com
@@ -70,14 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Makes your background jobs interruptible and resumable.
 test_files: []