CHANGELOG.md

Main (unreleased)

• 367 - Iteration can use multiple Active Job backends simultaneously by inferring the interruption adapter from the job's queue_adapter_name. JobIteration.interruption_adapter and .load_integrations have been removed. JobIteration::Integrations.register has been added.

v1.4.0 (Aug 23, 2023)

Changes

• 338 - All logs are now ActiveSupport::Notifications events and logged using ActiveSupport::LogSubscriber to allow customization. Events now always include the cursor_position tag.
• 418 - Return nil from Iteration#perform, to signal not to rely on return value.

Features

• 240 - Allow setting inheritable per-job job_iteration_max_job_runtime
• 310 - Support nested iteration
• 341 - Add JobIteration.default_retry_backoff, which sets a default delay when jobs are re-enqueued after being interrupted. Defaults to nil, meaning no delay, which matches the current behaviour.
• 365 - Support composite primary key as a cursor

Bug fixes

• 289 - Fix uninitialized constant error when raising ConditionNotSupportedError from ActiveRecordBatchEnumerator
• 346 - Include failed jobs in total_time
• 417 - Ensure that numerical values are deserialized as such and not as strings.

v1.3.6 (Mar 9, 2022)

• 190 - Fix updating times_interrupted and total_time when job is throttled

v1.3.5 (Feb 10, 2022)

• 183 - Add JobIteration::EnumeratorBuilder#build_csv_enumerator

v1.3.4 (Jan 18, 2022)

• 174 - Fix Ruby 3.2 compatibility

v1.3.3 (Nov 17, 2021)

• 153 - Re-enqueue jobs only after shutdown hooks have run

v1.3.2 (Nov 12, 2021)

• 148 - Revert "Do not evaluate enumerator when throttled", due to backwards incompatibility.

v1.3.1 (Nov 11, 2021)

• 87 - Do not evaluate enumerator when throttled (REVERTED)

v1.3.0 (Oct 7, 2021)

• 133 - Moves attributes out of JobIteration::Iteration included block

v1.2.0 (Sept 21, 2021)

• 107 - Remove broken links from README
• 108 - Drop support for ruby 2.5
• 110 - Update rubocop TargetRubyVersion

v1.1.14 (May 28, 2021)

Bug fix

• 84 - Call adjust_total_time before running on_complete callbacks
• 94 - Remove unnecessary break
• 95 - ActiveRecordBatchEnumerator#each should rewind at the end
• 97 - Batch enumerator size returns the number of batches, not records

v1.1.13 (May 20, 2021)

New feature

• 91 - Add enumerator yielding batches as Active Record Relations

v1.1.12 (April 19, 2021)

Bug fix

• 77 - Defer enforce cursor be serializable until 2.0.0

v1.1.11 (April 19, 2021)

Bug fix

• 73 - Enforce cursor be serializable This is reverted in 1.1.12 as it breaks behaviour in some apps.

v1.1.10 (March 30, 2021)

• 69 - Fix memory leak in ActiveRecordCursor

v1.1.9 (January 6, 2021)

• 61 - Call super in method_added

v1.1.8 (June 8, 2020)

• Preserve ruby2_keywords tags in arguments on Ruby 2.7

v1.1.7 (June 4, 2020)

• 54 - Fix warnings on Ruby 2.7

v1.1.6 (May 22, 2020)

• 49 - Log when enumerator has nothing to iterate
• 52 - Fix CSVEnumerator cursor to properly remove already processed rows

v1.1.5 (February 27, 2020)

• 47 - Optional sorbet-runtime support for JobIteration::Iteration interface validation

v1.1.4 (December 13, 2019)

• 45 - Add Throttle enumerator

v1.1.3 (August 20, 2019)

• 36 - Check method validation at job initialization step

v1.1.2 (July 24, 2019)

Bug fix

• 36 - Fix CsvEnumerator for Ruby 2.6.3

v1.1.1 (July 22, 2019)

Bug fix

• 36 - Add case for using default keyword arguments for cursor in #build_enumerator

v1.1.0 (July 17, 2019)

New feature

• 35 - Raise exception if malformed arguments are use in #build_enumerator

v1.0.0 (April 29, 2019)

It’s been in production at Shopify since 2017. It has support for Rails 5 and 6 🎉

Deprecations

• 34 - remove supports_interruption?

Internal

• 30 - Better #each_iteration argument names

v0.9.8 (December 5, 2018)

Bug fix

• 27 - iteration: don't allow double-retrying a job

v0.9.7 (November 30, 2018)

New feature

• 23 - Remove upperbound constraint on ActiveJob