maintenance_tasks 2.10.1 → 2.13.0

data/db/migrate/20210517131953_add_arguments_to_maintenance_tasks_runs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddArgumentsToMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
+class AddArgumentsToMaintenanceTasksRuns < ActiveRecord::Migration[7.0]
   def change
     add_column(:maintenance_tasks_runs, :arguments, :text)
   end

data/db/migrate/20211210152329_add_lock_version_to_maintenance_tasks_runs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddLockVersionToMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
+class AddLockVersionToMaintenanceTasksRuns < ActiveRecord::Migration[7.0]
   def change
     add_column(
       :maintenance_tasks_runs,

data/db/migrate/20220706101937_change_runs_tick_columns_to_bigints.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ChangeRunsTickColumnsToBigints < ActiveRecord::Migration[6.0]
+class ChangeRunsTickColumnsToBigints < ActiveRecord::Migration[7.0]
   def up
     change_table(:maintenance_tasks_runs, bulk: true) do |t|
       t.change(:tick_count, :bigint)

data/db/migrate/20220713131925_add_index_on_task_name_and_status_to_runs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddIndexOnTaskNameAndStatusToRuns < ActiveRecord::Migration[6.0]
+class AddIndexOnTaskNameAndStatusToRuns < ActiveRecord::Migration[7.0]
   def change
     remove_index(
       :maintenance_tasks_runs,

data/db/migrate/20230622035229_add_metadata_to_runs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddMetadataToRuns < ActiveRecord::Migration[6.0]
+class AddMetadataToRuns < ActiveRecord::Migration[7.0]
   def change
     add_column(:maintenance_tasks_runs, :metadata, :text)
   end

data/lib/maintenance_tasks/engine.rb

@@ -21,6 +21,10 @@ module MaintenanceTasks
       MaintenanceTasks.backtrace_cleaner = Rails.backtrace_cleaner
     end
 
+    initializer "maintenance_tasks.deprecator" do
+      Rails.application.deprecators[:maintenance_tasks] = MaintenanceTasks.deprecator
+    end
+
     config.to_prepare do
       _ = TaskJobConcern # load this for JobIteration compatibility check
     end

data/lib/maintenance_tasks.rb

@@ -8,8 +8,6 @@ require "active_record"
 require "job-iteration"
 require "maintenance_tasks/engine"
 
-require "patches/active_record_batch_enumerator"
-
 # The engine's namespace module. It provides isolation between the host
 # application's code and the engine-specific code. Top-level engine constants
 # and variables are defined under this module.
@@ -63,16 +61,6 @@ module MaintenanceTasks
   #     use when cleaning a Run's backtrace.
   mattr_accessor :backtrace_cleaner
 
-  # @!attribute error_handler
-  #   @scope class
-  #
-  #   The callback to perform when an error occurs in the Task.  See the
-  #   {file:README#label-Customizing+the+error+handler} for details.
-  #
-  #   @return [Proc] the callback to perform when an error occurs in the Task.
-  mattr_accessor :error_handler, default:
-    ->(_error, _task_context, _errored_element) {}
-
   # @!attribute parent_controller
   #   @scope class
   #
@@ -96,4 +84,54 @@ module MaintenanceTasks
   #
   #  @return [ActiveSupport::Duration] the threshold in seconds after which a task is considered stuck.
   mattr_accessor :stuck_task_duration, default: 5.minutes
+
+  # @!attribute status_reload_frequency
+  #  @scope class
+  #  The frequency at which to reload the run status during iteration.
+  #  Defaults to 1 second, meaning reload status every second.
+  #
+  #  @return [ActiveSupport::Duration, Numeric] the time interval between status reloads.
+  mattr_accessor :status_reload_frequency, default: 1.second
+
+  # @!attribute report_errors_as_handled
+  #  @scope class
+  #  How unexpected errors are reported to Rails.error.report.
+  #
+  #  When an error occurs that isn't explicitly handled (e.g., via `report_on`),
+  #  it gets reported to Rails.error.report. This setting determines whether
+  #  these errors are marked as "handled" or "unhandled".
+  #
+  #  The current default of `true` is for backwards compatibility, but it prevents
+  #  error subscribers from distinguishing between expected and unexpected errors.
+  #  Setting this to `false` provides more accurate error reporting and will become the default in v3.0.
+  #
+  #  @see https://api.rubyonrails.org/classes/ActiveSupport/ErrorReporter.html#method-i-report
+  #  @return [Boolean] whether to report unexpected errors as handled (true) or unhandled (false).
+  mattr_accessor :report_errors_as_handled, default: true
+
+  class << self
+    DEPRECATION_MESSAGE = "MaintenanceTasks.error_handler is deprecated and will be removed in the 3.0 release. " \
+      "Instead, reports will be sent to the Rails error reporter. Do not set a handler and subscribe " \
+      "to the error reporter instead."
+    private_constant :DEPRECATION_MESSAGE
+
+    # @deprecated
+    def error_handler
+      deprecator.warn(DEPRECATION_MESSAGE)
+
+      @error_handler
+    end
+
+    # @deprecated
+    def error_handler=(proc)
+      deprecator.warn(DEPRECATION_MESSAGE)
+
+      @error_handler = proc
+    end
+
+    # @api-private
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("3.0", "MaintenanceTasks")
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.13.0
 platform: ruby
-original_platform: ''
 authors:
 - Shopify Engineering
 bindir: exe
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +85,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -178,13 +177,12 @@ files:
 - lib/maintenance_tasks.rb
 - lib/maintenance_tasks/cli.rb
 - lib/maintenance_tasks/engine.rb
-- lib/patches/active_record_batch_enumerator.rb
 - lib/tasks/maintenance_tasks_tasks.rake
 homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.10.1
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.13.0
   allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
@@ -193,14 +191,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []

data/lib/patches/active_record_batch_enumerator.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.gem_version < Gem::Version.new("7.0")
-  # Add attribute readers.
-  module ActiveRecordBatchEnumerator
-    # The primary key value from which the BatchEnumerator starts,
-    #   inclusive of the value.
-    attr_reader :start
-
-    # The primary key value at which the BatchEnumerator ends,
-    #   inclusive of the value.
-    attr_reader :finish
-
-    # The relation from which the BatchEnumerator yields batches.
-    attr_reader :relation
-
-    # The size of the batches yielded by the BatchEnumerator.
-    def batch_size
-      @of
-    end
-  end
-
-  ActiveRecord::Batches::BatchEnumerator.include(ActiveRecordBatchEnumerator)
-end