maintenance_tasks 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5504bbe129c76305465fce6a4cb5310feb2c0fd0fe2516a1896f60615825e183
-  data.tar.gz: 3a1cbf3fc0eef572d7b8e1451331e33618e8a1b888cde2cf8d39e0c6363b6a6a
+  metadata.gz: cd230e758c366ce730cdfdb91a7ba7ae433582d69f01c78c828f22ae756401b7
+  data.tar.gz: fb3dd9d633b907e3ceaae6c7db7ed84c75b033f1832bd175f143fb590fcd0379
 SHA512:
-  metadata.gz: e59152a9747d77adf137470e375ad68d06b07b410c73879f14f3d5cb418f26abe831102b32f6e5868f8824a2999f43ca4fdd0ad6a7eb84e85fbdb9d4e1530db7
-  data.tar.gz: 07bda592ce0919dc2487eb1df8ea585addbdaab8a8bca20c9f67332e3b5f8f04b6b2a66231de112e919a646352453a707f9909d857d5d57c7c58f9c4d46c8337
+  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
@@ -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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.16.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.16.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.11
+rubygems_version: 4.0.12
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []