maintenance_tasks 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74ab248a9b57875d5e7b47234598a46fbc37033fb7d96c95e26b03c55d83793
-  data.tar.gz: cf2322966430eee4215131e9885aba07591d2e6f5081f6ab1683188ae5be8e80
+  metadata.gz: 5504bbe129c76305465fce6a4cb5310feb2c0fd0fe2516a1896f60615825e183
+  data.tar.gz: 3a1cbf3fc0eef572d7b8e1451331e33618e8a1b888cde2cf8d39e0c6363b6a6a
 SHA512:
-  metadata.gz: 22bde697fa7b38899ff5dc4c7fc353776a29766f479a3fac4f988b921aaf62bd58534f55a2c9caa1b9bf227ddbbef249c1d521b863afc5ab59527ad32528a4e9
-  data.tar.gz: 1f51f3e1ead4af15d02886b950562e0a103baf055839e1e5e6f661b2dfd29d47626859fbd350e8d311293c88d4b4f59189ae70e32a8dbca54559d75ce5fafaa5
+  metadata.gz: e59152a9747d77adf137470e375ad68d06b07b410c73879f14f3d5cb418f26abe831102b32f6e5868f8824a2999f43ca4fdd0ad6a7eb84e85fbdb9d4e1530db7
+  data.tar.gz: 07bda592ce0919dc2487eb1df8ea585addbdaab8a8bca20c9f67332e3b5f8f04b6b2a66231de112e919a646352453a707f9909d857d5d57c7c58f9c4d46c8337

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

@@ -146,7 +146,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
 

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/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.16.0
 platform: ruby
 authors:
 - Shopify Engineering
@@ -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.16.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.11
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []