maintenance_tasks 2.13.0 → 2.15.0

data/app/views/maintenance_tasks/tasks/index.html.erb

@@ -14,9 +14,9 @@
     <% end %>
     <% if new_tasks = @available_tasks[:new] %>
       <h3 class="title is-4 has-text-weight-bold">New Tasks</h3>
-	  <div class="grid is-col-min-20">
+      <div class="grid is-col-min-20">
         <%= render partial: 'task', collection: new_tasks %>
-	  </div>
+      </div>
     <% end %>
     <% if completed_tasks = @available_tasks[:completed] %>
       <h3 class="title is-4 has-text-weight-bold">Completed Tasks</h3>

data/app/views/maintenance_tasks/tasks/show.html.erb

@@ -44,7 +44,7 @@
 
 <%= tag.div(data: { refresh: @task.refresh? || "" }) do %>
   <% if @task.active_runs.any? %>
-    <hr/>
+    <hr>
 
     <h4 class="title is-4">Active Runs</h4>
 
@@ -52,7 +52,7 @@
   <% end %>
 
   <% if @task.runs_page.records.present? %>
-    <hr/>
+    <hr>
 
     <h4 class="title is-5 has-text-weight-bold">Previous Runs</h4>
 

data/db/migrate/20251128180556_add_cursor_is_json_flag_to_runs.rb

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

data/lib/maintenance_tasks.rb

@@ -109,6 +109,42 @@ module MaintenanceTasks
   #  @return [Boolean] whether to report unexpected errors as handled (true) or unhandled (false).
   mattr_accessor :report_errors_as_handled, default: true
 
+  # @!attribute serialize_cursors_as_json
+  #  @scope class
+  #  Controls whether or not cursor values are stored as JSON in the database.
+  #  Defaults to false.
+  #
+  #  Storing cursors as JSON enables more complex cursor structures. For
+  #  example, with JSON cursors a task can iterate over collections using
+  #  multiple fields or columns to track progress. This is particularly useful
+  #  for iterating over models with composite primary keys.
+  #
+  #  Be advised that this feature comes with a few caveats:
+  #
+  #  1. Cursor values must be capable of being serialized to JSON and parsed
+  #     from JSON. If they are not, errors will occur during task execution.
+  #  2. If a cursor contains a value that loses precision when serialized, it
+  #     may lead to unexpected behaviour.
+  #  3. This feature utilizes a string column to store the JSON data. If your
+  #     database has a hard limit on how big a string value can be, be mindful
+  #     that certain cursor structures could result in a value that could exceed
+  #     that limit and cause issues.
+  #
+  #  A new column was added to discern JSON cursors from plain string cursors.
+  #  Make sure you have run the latest database migrations provided by the gem
+  #  before enabling this feature.
+  #
+  #  @return [Boolean] whether or not to store cursor values as JSON.
+  mattr_accessor :serialize_cursors_as_json, default: false
+
+  # @!attribute task_staleness_threshold
+  #  @scope class
+  #  The threshold after which a task is considered stale.
+  #  Defaults to 30 days. Can be disabled by setting this to `false`.
+  #
+  #  @return [ActiveSupport::Duration, false] time interval after which a task is considered stale.
+  mattr_accessor :task_staleness_threshold, default: 30.days
+
   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.13.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Shopify Engineering
@@ -122,6 +122,7 @@ files:
 - app/helpers/maintenance_tasks/tasks_helper.rb
 - app/jobs/concerns/maintenance_tasks/task_job_concern.rb
 - app/jobs/maintenance_tasks/task_job.rb
+- app/models/concerns/maintenance_tasks/run_concern.rb
 - app/models/maintenance_tasks/application_record.rb
 - app/models/maintenance_tasks/batch_csv_collection_builder.rb
 - app/models/maintenance_tasks/csv_collection_builder.rb
@@ -166,6 +167,7 @@ files:
 - db/migrate/20220706101937_change_runs_tick_columns_to_bigints.rb
 - db/migrate/20220713131925_add_index_on_task_name_and_status_to_runs.rb
 - db/migrate/20230622035229_add_metadata_to_runs.rb
+- db/migrate/20251128180556_add_cursor_is_json_flag_to_runs.rb
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
@@ -182,7 +184,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.13.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.15.0
   allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
@@ -198,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []