maintenance_tasks 2.15.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74ab248a9b57875d5e7b47234598a46fbc37033fb7d96c95e26b03c55d83793
-  data.tar.gz: cf2322966430eee4215131e9885aba07591d2e6f5081f6ab1683188ae5be8e80
+  metadata.gz: cd230e758c366ce730cdfdb91a7ba7ae433582d69f01c78c828f22ae756401b7
+  data.tar.gz: fb3dd9d633b907e3ceaae6c7db7ed84c75b033f1832bd175f143fb590fcd0379
 SHA512:
-  metadata.gz: 22bde697fa7b38899ff5dc4c7fc353776a29766f479a3fac4f988b921aaf62bd58534f55a2c9caa1b9bf227ddbbef249c1d521b863afc5ab59527ad32528a4e9
-  data.tar.gz: 1f51f3e1ead4af15d02886b950562e0a103baf055839e1e5e6f661b2dfd29d47626859fbd350e8d311293c88d4b4f59189ae70e32a8dbca54559d75ce5fafaa5
+  metadata.gz: 850d1e302af870bbbd8a83c5a6db4b2080661ddd29d5a56e1f0e77e54e8cab983d56fe43fab39a14cf4031083e1df2345dad4901c035d689e744246d838a98db
+  data.tar.gz: d7bcab900521437f9e2ccf921f4213c28d688bc484a39920f05236184dc0072a5d929fcc81940e708ffeda7ef482e7787d96d52cf495b3f19568fd0058f6c328

data/README.md

@@ -1047,6 +1047,8 @@ Reports to the error reporter will contain the following data:
    * `run_id`: The id of the errored Task run
    * `tick_count`: The tick count at the time of the error
    * `errored_element`: The element, if any, that was being processed when the
+     Task errored. Active Record elements are reported as a hash with
+     `class_name` and `id` keys.
 * `source`: This will be `maintenance-tasks`
 * `handled`: the value of `MaintenanceTasks.report_errors_as_handled` (default `true`, see below)
 

data/app/jobs/concerns/maintenance_tasks/task_job_concern.rb

@@ -42,6 +42,15 @@ module MaintenanceTasks
       @run.cursor
     end
 
+    def serialized_errored_element(errored_element)
+      return errored_element unless errored_element.is_a?(ActiveRecord::Base)
+
+      {
+        class_name: errored_element.class.name,
+        id: errored_element.id,
+      }
+    end
+
     def build_enumerator(_run, cursor:)
       cursor ||= deserialized_run_cursor
       self.cursor_position = cursor
@@ -146,7 +155,7 @@ module MaintenanceTasks
 
     def on_start
       count = @task.count
-      count = @collection_enum.size if count == :no_count
+      count = @collection_enum.size if count == NO_COUNT_DEFINED
       @run.start(count)
     end
 
@@ -206,10 +215,15 @@ module MaintenanceTasks
         errored_element = task_context.delete(:errored_element)
         MaintenanceTasks.error_handler.call(error, task_context.except(:run_id, :tick_count), errored_element)
       else
+        report_context = task_context.dup
+        if report_context.key?(:errored_element)
+          report_context[:errored_element] = serialized_errored_element(report_context[:errored_element])
+        end
+
         Rails.error.report(
           error,
           handled: MaintenanceTasks.report_errors_as_handled,
-          context: task_context,
+          context: report_context,
           source: "maintenance-tasks",
         )
       end

data/app/models/concerns/maintenance_tasks/run_concern.rb

@@ -8,35 +8,36 @@ module MaintenanceTasks
   module RunConcern
     extend ActiveSupport::Concern
 
-    included do
-      # Various statuses a run can be in.
-      STATUSES = [
-        :enqueued,    # The task has been enqueued by the user.
-        :running,     # The task is being performed by a job worker.
-        :succeeded,   # The task finished without error.
-        :cancelling,  # The task has been told to cancel but is finishing work.
-        :cancelled,   # The user explicitly halted the task's execution.
-        :interrupted, # The task was interrupted by the job infrastructure.
-        :pausing,     # The task has been told to pause but is finishing work.
-        :paused,      # The task was paused in the middle of the run by the user.
-        :errored,     # The task code produced an unhandled exception.
-      ]
-
-      ACTIVE_STATUSES = [
-        :enqueued,
-        :running,
-        :paused,
-        :pausing,
-        :cancelling,
-        :interrupted,
-      ]
-      STOPPING_STATUSES = [
-        :pausing,
-        :cancelling,
-        :cancelled,
-      ]
-      COMPLETED_STATUSES = [:succeeded, :errored, :cancelled]
+    STATUSES = [
+      :enqueued,    # The task has been enqueued by the user.
+      :running,     # The task is being performed by a job worker.
+      :succeeded,   # The task finished without error.
+      :cancelling,  # The task has been told to cancel but is finishing work.
+      :cancelled,   # The user explicitly halted the task's execution.
+      :interrupted, # The task was interrupted by the job infrastructure.
+      :pausing,     # The task has been told to pause but is finishing work.
+      :paused,      # The task was paused in the middle of the run by the user.
+      :errored,     # The task code produced an unhandled exception.
+    ].freeze
+
+    ACTIVE_STATUSES = [
+      :enqueued,
+      :running,
+      :paused,
+      :pausing,
+      :cancelling,
+      :interrupted,
+    ].freeze
+
+    STOPPING_STATUSES = [
+      :pausing,
+      :cancelling,
+      :cancelled,
+    ].freeze
+
+    COMPLETED_STATUSES = [:succeeded, :errored, :cancelled].freeze
 
+    included do
       enum :status, STATUSES.to_h { |status| [status, status.to_s] }
 
       after_save :instrument_status_change

data/app/models/maintenance_tasks/null_collection_builder.rb

@@ -22,7 +22,7 @@ module MaintenanceTasks
     #
     # @return [Integer, nil]
     def count(task)
-      :no_count
+      NO_COUNT_DEFINED
     end
 
     # Return that the Task does not process CSV content.

data/app/models/maintenance_tasks/task_data_index.rb

@@ -15,7 +15,9 @@ module MaintenanceTasks
       # Returns a list of sorted Task Data objects that represent the
       # available Tasks.
       #
-      # Tasks are sorted by category, and within a category, by Task name.
+      # Tasks are sorted by category, and within a category, by the most
+      # recent Run's creation time (most recent first). New tasks with no
+      # Run history fall back to alphabetical order by name.
       # Determining a Task's category requires their latest Run records.
       # Two queries are done to get the currently active and completed Run
       # records, and Task Data instances are initialized with these related run
@@ -41,10 +43,13 @@ module MaintenanceTasks
           tasks << TaskDataIndex.new(task_name, last_run)
         end
 
-        # We add an additional sorting key (status) to avoid possible
-        # inconsistencies across database adapters when a Task has
-        # multiple active Runs.
-        tasks.sort_by! { |task| [task.name, task.status] }
+        # Most-recent-first by Run creation time; new tasks (no Run) sort
+        # together by name. Status is a final tiebreaker to keep ordering
+        # stable across database adapters when a Task has multiple active
+        # Runs created at the same time.
+        tasks.sort_by! do |task|
+          [-(task.related_run&.created_at&.to_f || 0), task.name, task.status]
+        end
       end
     end
 

data/db/migrate/20251128180556_add_cursor_is_json_flag_to_runs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddCursorIsJsonFlagToRuns < ActiveRecord::Migration[7.1]
+class AddCursorIsJsonFlagToRuns < ActiveRecord::Migration[7.2]
   def change
     add_column(:maintenance_tasks_runs, :cursor_is_json, :boolean, default: false, null: false)
   end

data/lib/maintenance_tasks.rb

@@ -145,6 +145,11 @@ module MaintenanceTasks
   #  @return [ActiveSupport::Duration, false] time interval after which a task is considered stale.
   mattr_accessor :task_staleness_threshold, default: 30.days
 
+  NO_COUNT_DEFINED = Object.new
+  NO_COUNT_DEFINED.define_singleton_method(:inspect) { "MaintenanceTasks::NO_COUNT_DEFINED" }
+  NO_COUNT_DEFINED.freeze
+  private_constant :NO_COUNT_DEFINED
+
   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 " \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Shopify Engineering
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +184,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.15.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.17.0
   allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.12
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []