maintenance_tasks 2.10.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b660fdfcef27420bf9b08ddc50c9cfac5ff0977c4435b54ecd2b468a3e4fde8
-  data.tar.gz: 30bac0da63839406dc623d07c85904b7a727d3af5c177736cbd72ea828ca41c9
+  metadata.gz: d307d92f96c1d1975cc3fbefcddf6ec2e11086097437b63594090c5bc524eea8
+  data.tar.gz: 9176d7a34c4a54f450601ea2748a88b1a9f134c9e416e97978e613bf3fbf1538
 SHA512:
-  metadata.gz: 071dafa23a89bd949e40f10ef199ae892d5ae81ca2ad1e15e6c7de0260dafbd55f735d67c310f5de7ef499991982eb3bad69fce4024f8f8761e4357ac3fdc42b
-  data.tar.gz: 77265626bdeafaa6486a3843846d519168be0712399ebe3cd7a4ecbb42f5888f208f566346d6d628643ee0dcf06ff1c4b914f2ab3ef9ec73f60b9444ef3f05c0
+  metadata.gz: 87d37b437e518c0398023335fe88cb0c7829387142873eeb01aa713df04f397e7711491f0ace1a32baae20f4f1a613313c59e95696deef73d6ecfad24b6fb267
+  data.tar.gz: b0c5fce124651391b77b8f2e5d91f8eb84c0415744fda8429b11a64b730a2e1ef02335c05685a98946fffdfd5042aa3b6f2a23a645a454613acd364af612b09d

data/README.md

@@ -74,9 +74,11 @@ The generator creates and runs a migration to add the necessary table to your
 database. It also mounts Maintenance Tasks in your `config/routes.rb`. By
 default the web UI can be accessed in the new `/maintenance_tasks` path.
 
-In case you use an exception reporting service (e.g. Bugsnag) you might want to
-define an error handler. See [Customizing the error
-handler](#customizing-the-error-handler) for more information.
+This gem uses the [Rails Error Reporter][rails-error-reporting] to report errors.
+If you are using a bug tracking service you may want to subscribe to the
+reporter. See [Reporting Errors](#reporting-errors) for more information.
+
+[rails-error-reporting]: https://guides.rubyonrails.org/error_reporting.html
 
 ### Active Job Dependency
 
@@ -114,12 +116,12 @@ The typical Maintenance Tasks workflow is as follows:
 1. [Generate a class describing the Task](#creating-a-task) and the work to be
    done.
 2. Run the Task
-    - either by [using the included web UI](#running-a-task-from-the-web-ui),
-    - or by [using the command line](#running-a-task-from-the-command-line),
-    - or by [using Ruby](#running-a-task-from-ruby).
+   - either by [using the included web UI](#running-a-task-from-the-web-ui),
+   - or by [using the command line](#running-a-task-from-the-command-line),
+   - or by [using Ruby](#running-a-task-from-ruby).
 3. [Monitor the Task](#monitoring-your-tasks-status)
-    - either by using the included web UI,
-    - or by manually checking your task’s run’s status in your database.
+   - either by using the included web UI,
+   - or by manually checking your task’s run’s status in your database.
 4. Optionally, delete the Task code if you no longer need it.
 
 ### Creating a Task
@@ -168,7 +170,8 @@ end
 When processing records from an Active Record Relation, records are fetched in
 batches internally, and then each record is passed to the `#process` method.
 Maintenance Tasks will query the database to fetch records in batches of 100 by
-default, but the batch size can be modified using the `collection_batch_size` macro:
+default, but the batch size can be modified using the `collection_batch_size`
+macro:
 
 ```ruby
 # app/tasks/maintenance/update_posts_task.rb
@@ -502,13 +505,44 @@ set of values will be used to populate a dropdown in the user interface. The
 following types are supported:
 
 * Arrays
-* Procs and lambdas that optionally accept the Task instance, and return an Array.
-* Callable objects that receive one argument, the Task instance, and return an Array.
+* Procs and lambdas that optionally accept the Task instance, and return an
+  Array.
+* Callable objects that receive one argument, the Task instance, and return an
+  Array.
 * Methods that return an Array, called on the Task instance.
 
 For enumerables that don't match the supported types, a text field will be
 rendered instead.
 
+### Masking Task Parameters
+
+Task attributes can be masked in the UI by adding `mask_attribute` class method
+in the task class. This will replace the value in the arguments list with
+`[FILTERED]` in the UI.
+
+```ruby
+# app/tasks/maintenance/sensitive_params_task.rb
+
+module Maintenance
+  class SensitiveParamsTask < MaintenanceTasks::Task
+    attribute :sensitive_content, :string
+
+    mask_attribute :sensitive_content
+  end
+end
+```
+
+If you have any filtered parameters in the global [Rails parameter
+filter][rails-parameter-filter], they will be automatically taken into account
+when masking the parameters, which means that you can mask parameters across all
+tasks by adding them to the global rails parameters filter.
+
+[rails-parameter-filter]:https://guides.rubyonrails.org/configuring.html#config-filter-parameters
+
+```ruby
+Rails.application.config.filter_parameters += %i[token]
+```
+
 ### Custom cursor columns to improve performance
 
 The [job-iteration gem][job-iteration], on which this gem depends, adds an
@@ -899,10 +933,10 @@ a Task can be in:
 
 The Maintenance Tasks engine uses Rails sessions for flash messages and storing
 the CSRF token. For the engine to work in an API-only Rails application, you
-need to add a [session middleware][] and the `ActionDispatch::Flash`
-middleware. The engine also defines a strict [Content Security Policy][], make
-sure to include `ActionDispatch::ContentSecurityPolicy::Middleware` in your
-app's middleware stack to ensure the CSP is delivered to the user's browser.
+need to add a [session middleware][] and the `ActionDispatch::Flash` middleware.
+The engine also defines a strict [Content Security Policy][], make sure to
+include `ActionDispatch::ContentSecurityPolicy::Middleware` in your app's
+middleware stack to ensure the CSP is delivered to the user's browser.
 
 [session middleware]: https://guides.rubyonrails.org/api_app.html#using-session-middlewares
 [Content Security Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
@@ -926,8 +960,8 @@ module YourApplication
 end
 ```
 
-You can read more in the [Using Rails for API-only Applications][rails api] Rails
-guide.
+You can read more in the [Using Rails for API-only Applications][rails api]
+Rails guide.
 
 [rails api]: https://guides.rubyonrails.org/api_app.html
 
@@ -944,9 +978,9 @@ infrastructure or code changes.
 This means a Task can safely be interrupted, re-enqueued and resumed without any
 intervention at the end of an iteration, after the `process` method returns.
 
-By default, a running Task will be interrupted after running for more 5 minutes.
-This is [configured in the `job-iteration` gem][max-job-runtime] and can be
-tweaked in an initializer if necessary.
+By default, a running Task will be interrupted after running for more than 5
+minutes. This is [configured in the `job-iteration` gem][max-job-runtime] and
+can be tweaked in an initializer if necessary.
 
 [max-job-runtime]: https://github.com/Shopify/job-iteration/blob/-/guides/best-practices.md#max-job-runtime
 
@@ -988,44 +1022,58 @@ If you are stuck in `pausing` and wish to preserve your tasks's position
 There are a few configurable options for the gem. Custom configurations should
 be placed in a `maintenance_tasks.rb` initializer.
 
-#### Customizing the error handler
+#### Reporting errors
 
 Exceptions raised while a Task is performing are rescued and information about
 the error is persisted and visible in the UI.
 
-If you want to integrate with an exception monitoring service (e.g. Bugsnag),
-you can define an error handler:
+Errors are also sent to the `Rails.error.reporter`, which can be configured by
+your application. See the [Error Reporting in Rails
+Applications][rails-error-reporting] guide for more details.
 
-```ruby
-# config/initializers/maintenance_tasks.rb
+Reports to the error reporter will contain the following data:
 
-MaintenanceTasks.error_handler = ->(error, task_context, _errored_element) do
-  Bugsnag.notify(error) do |notification|
-    notification.add_metadata(:task, task_context)
-  end
+* `error`: The exception that was raised.
+* `context`: A hash with additional information about the Task and the error:
+   * `task_name`: The name of the Task that errored
+   * `started_at`: The time the Task started
+   * `ended_at`: The time the Task errored
+   * `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
+* `source`: This will be `maintenance-tasks`
+
+Note that `context` may be empty if the Task produced an error before any
+context could be gathered (for example, if deserializing the job to process your
+Task failed).
+
+#### Reporting errors during iteration
+
+By default, errors raised during task iteration will be raised to the
+application and iteration will stop. However, you may want to handle some errors
+and continue iteration. `MaintenanceTasks::Task.report_on` can be used to rescue
+certain exceptions and report them to the Rails error reporter. Any keyword
+arguments are passed to
+[ActiveSupport::ErrorReporter#report][as-error-reporter-report]:
+
+[as-error-reporter-report]: https://api.rubyonrails.org/classes/ActiveSupport/ErrorReporter.html#method-i-report
+
+```ruby
+class MyTask < MaintenanceTasks::Task
+  report_on(MyException, OtherException, severity: :info, context: {task_name: "my_task"})
 end
 ```
 
-The error handler should be a lambda that accepts three arguments:
+`MaintenanceTasks::Task` also includes `ActiveSupport::Rescuable` which you can
+use to implement custom error handling.
 
-* `error`: The exception that was raised.
-* `task_context`: A hash with additional information about the Task and the
-  error:
-  * `task_name`: The name of the Task that errored
-  * `started_at`: The time the Task started
-  * `ended_at`: The time the Task errored
-
-  Note that `task_context` may be empty if the Task produced an error before any
-  context could be gathered (for example, if deserializing the job to process
-  your Task failed).
-* `errored_element`: The element, if any, that was being processed when the Task
-  raised an exception. If you would like to pass this object to your exception
-  monitoring service, make sure you **sanitize the object** to avoid leaking
-  sensitive data and **convert it to a format** that is compatible with your bug
-  tracker. For example, Bugsnag only sends the id and class name of Active
-  Record objects in order to protect sensitive data. CSV rows, on the other
-  hand, are converted to strings and passed raw to Bugsnag, so make sure to
-  filter any personal data from these objects before adding them to a report.
+```ruby
+class MyTask < MaintenanceTasks::Task
+  rescue_from(MyException) do |exception|
+    handle(exception)
+  end
+end
+```
 
 #### Customizing the maintenance tasks module
 

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -8,16 +8,20 @@ module MaintenanceTasks
     BULMA_CDN = "https://cdn.jsdelivr.net"
 
     content_security_policy do |policy|
-      policy.style_src(
+      policy.style_src_elem(
         BULMA_CDN,
-        # ruby syntax highlighting
-        "'sha256-y9V0na/WU44EUNI/HDP7kZ7mfEci4PAOIjYOOan6JMA='",
+        # <style> tag in app/views/layouts/maintenance_tasks/application.html.erb
+        "'sha256-WHHDQLdkleXnAN5zs0GDXC5ls41CHUaVsJtVpaNx+EM='",
       )
-      policy.script_src(
-        # page refresh script
+      policy.script_src_elem(
+        # <script> tag in app/views/layouts/maintenance_tasks/application.html.erb
         "'sha256-NiHKryHWudRC2IteTqmY9v1VkaDUA/5jhgXkMTkgo2w='",
       )
+
+      policy.require_trusted_types_for # disable because we use new DOMParser().parseFromString
       policy.frame_ancestors(:self)
+      policy.connect_src(:self)
+      policy.form_action(:self)
     end
 
     protect_from_forgery with: :exception

data/app/helpers/maintenance_tasks/application_helper.rb

@@ -14,7 +14,7 @@ module MaintenanceTasks
     # @param datetime [ActiveSupport::TimeWithZone] the time to be presented.
     # @return [String] the HTML to render with the relative datetime in words.
     def time_ago(datetime)
-      time_tag(datetime, title: datetime.utc.iso8601, class: "is-clickable") do
+      time_tag(datetime, title: datetime.utc, class: "is-clickable") do
         time_ago_in_words(datetime) + " ago"
       end
     end

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -47,7 +47,7 @@ module MaintenanceTasks
       progress_bar = tag.progress(
         value: progress.value,
         max: progress.max,
-        class: ["progress"] + STATUS_COLOURS.fetch(run.status),
+        class: ["progress", "mt-4"] + STATUS_COLOURS.fetch(run.status),
       )
       progress_text = tag.p(tag.i(progress.text))
       tag.div(progress_bar + progress_text, class: "block")
@@ -60,7 +60,10 @@ module MaintenanceTasks
     # @return [String] the span element containing the status, with the
     #   appropriate tag class attached.
     def status_tag(status)
-      tag.span(status.capitalize, class: ["tag"] + STATUS_COLOURS.fetch(status))
+      tag.span(
+        status.capitalize,
+        class: ["tag", "has-text-weight-medium", "pr-2", "mr-4"] + STATUS_COLOURS.fetch(status),
+      )
     end
 
     # Reports the approximate elapsed time a Run has been processed so far based
@@ -101,7 +104,7 @@ module MaintenanceTasks
       )
     end
 
-    # Resolves values covered by the inclusion validator for a task attribute.
+    # Resolves values covered by the inclusion validator for a Task attribute.
     # Supported option types:
     # - Arrays
     # - Procs and lambdas that optionally accept the Task instance, and return an Array.
@@ -112,7 +115,7 @@ module MaintenanceTasks
     #
     # Returned values are used to populate a dropdown list of options.
     #
-    # @param task_class [Class<Task>] The task class for which the value needs to be resolved.
+    # @param task [Task] The Task for which the value needs to be resolved.
     # @param parameter_name [String] The parameter name.
     #
     # @return [Array] value of the resolved inclusion option.
@@ -149,24 +152,27 @@ module MaintenanceTasks
     # If the parameter has a `validates_inclusion_of` validator, return a dropdown list of options instead.
     def parameter_field(form_builder, parameter_name)
       inclusion_values = resolve_inclusion_value(form_builder.object, parameter_name)
-      return form_builder.select(parameter_name, inclusion_values, prompt: "Select a value") if inclusion_values
+      if inclusion_values
+        return tag.div(form_builder.select(parameter_name, inclusion_values, prompt: "Select a value"), class: "select")
+      end
 
       case form_builder.object.class.attribute_types[parameter_name]
       when ActiveModel::Type::Integer
-        form_builder.number_field(parameter_name)
+        form_builder.number_field(parameter_name, class: "input")
       when ActiveModel::Type::Decimal, ActiveModel::Type::Float
-        form_builder.number_field(parameter_name, { step: "any" })
+        form_builder.number_field(parameter_name, { step: "any", class: "input" })
       when ActiveModel::Type::DateTime
-        form_builder.datetime_field(parameter_name) + datetime_field_help_text
+        form_builder.datetime_field(parameter_name, class: "input") + datetime_field_help_text
       when ActiveModel::Type::Date
-        form_builder.date_field(parameter_name)
+        form_builder.date_field(parameter_name, class: "input")
       when ActiveModel::Type::Time
-        form_builder.time_field(parameter_name)
+        form_builder.time_field(parameter_name, class: "input")
       when ActiveModel::Type::Boolean
-        form_builder.check_box(parameter_name)
+        form_builder.check_box(parameter_name, class: "checkbox")
       else
         form_builder.text_area(parameter_name, class: "textarea")
       end
+        .then { |input| tag.div(input, class: "control") }
     end
 
     # Return helper text for the datetime-local form field.
@@ -182,5 +188,16 @@ module MaintenanceTasks
         class: "content is-small",
       )
     end
+
+    # Checks if an attribute is required for a given Task.
+    #
+    # @param task [MaintenanceTasks::TaskDataShow] The TaskDataShow instance.
+    # @param parameter_name [Symbol] The name of the attribute to check.
+    # @return [Boolean] Whether the attribute is required.
+    def attribute_required?(task, parameter_name)
+      task.class.validators_on(parameter_name).any? do |validator|
+        validator.kind == :presence
+      end
+    end
   end
 end

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

@@ -112,7 +112,7 @@ module MaintenanceTasks
       end
     rescue => error
       @errored_element = input
-      raise error
+      raise error unless @task.rescue_with_handler(error)
     end
 
     def before_perform
@@ -181,11 +181,20 @@ module MaintenanceTasks
           task_name: @run.task_name,
           started_at: @run.started_at,
           ended_at: @run.ended_at,
+          run_id: @run.id,
+          tick_count: @run.tick_count,
         }
       end
-      errored_element = @errored_element if defined?(@errored_element)
+      task_context[:errored_element] = @errored_element if defined?(@errored_element)
     ensure
-      MaintenanceTasks.error_handler.call(error, task_context, errored_element)
+      if MaintenanceTasks.instance_variable_get(:@error_handler)
+        errored_element = task_context.delete(:errored_element)
+        MaintenanceTasks.error_handler.call(error, task_context.except(:run_id, :tick_count), errored_element)
+      elsif Rails.gem_version >= Gem::Version.new("7.1")
+        Rails.error.report(error, context: task_context, source: "maintenance-tasks")
+      else
+        Rails.error.report(error, handled: true, context: task_context)
+      end
     end
   end
 end

data/app/models/maintenance_tasks/run.rb

@@ -33,11 +33,7 @@ module MaintenanceTasks
     ]
     COMPLETED_STATUSES = [:succeeded, :errored, :cancelled]
 
-    if Rails.gem_version >= Gem::Version.new("7.0.alpha")
-      enum :status, STATUSES.to_h { |status| [status, status.to_s] }
-    else
-      enum status: STATUSES.to_h { |status| [status, status.to_s] }
-    end
+    enum :status, STATUSES.to_h { |status| [status, status.to_s] }
 
     after_save :instrument_status_change
 
@@ -426,12 +422,23 @@ module MaintenanceTasks
         if task.attribute_names.any? && arguments.present?
           task.assign_attributes(arguments)
         end
+
+        task.metadata = metadata
         task
       rescue ActiveModel::UnknownAttributeError
         task
       end
     end
 
+    # Returns all the run arguments with sensitive information masked.
+    #
+    # @return [Hash] The masked arguments.
+    def masked_arguments
+      return unless arguments.present?
+
+      argument_filter.filter(arguments)
+    end
+
     private
 
     def instrument_status_change
@@ -486,5 +493,11 @@ module MaintenanceTasks
 
       value&.first(limit)
     end
+
+    def argument_filter
+      @argument_filter ||= ActiveSupport::ParameterFilter.new(
+        Rails.application.config.filter_parameters + task.masked_arguments,
+      )
+    end
   end
 end

data/app/models/maintenance_tasks/task.rb

@@ -8,6 +8,7 @@ module MaintenanceTasks
     include ActiveModel::Attributes
     include ActiveModel::AttributeAssignment
     include ActiveModel::Validations
+    include ActiveSupport::Rescuable
 
     class NotFoundError < NameError; end
 
@@ -27,8 +28,15 @@ module MaintenanceTasks
     # @api private
     class_attribute :collection_builder_strategy, default: NullCollectionBuilder.new
 
+    # The sensitive attributes that will be filtered when fetching a run.
+    #
+    # @api private
+    class_attribute :masked_arguments, default: []
+
     define_callbacks :start, :complete, :error, :cancel, :pause, :interrupt
 
+    attr_accessor :metadata
+
     class << self
       # Finds a Task with the given name.
       #
@@ -152,6 +160,13 @@ module MaintenanceTasks
         self.active_record_enumerator_batch_size = size
       end
 
+      # Adds attribute names to sensitive arguments list.
+      #
+      # @param attributes [Array<Symbol>] the attribute names to filter.
+      def mask_attribute(*attributes)
+        self.masked_arguments += attributes
+      end
+
       # Initialize a callback to run after the task starts.
       #
       # @param filter_list apply filters to the callback
@@ -200,6 +215,22 @@ module MaintenanceTasks
         set_callback(:error, :after, *filter_list, &block)
       end
 
+      # Rescue listed exceptions during an iteration and report them to the error reporter, then
+      # continue iteration.
+      #
+      # @param exceptions list of exceptions to rescue and report
+      # @param report_options [Hash] optionally, supply additional options for `Rails.error.report`.
+      #   By default: <code>{ source: "maintenance_tasks" }</code> or (Rails <v7.1) <code>{ handled: true }</code>.
+      def report_on(*exceptions, **report_options)
+        rescue_from(*exceptions) do |exception|
+          if Rails.gem_version >= Gem::Version.new("7.1")
+            Rails.error.report(exception, source: "maintenance_tasks", **report_options)
+          else
+            Rails.error.report(exception, handled: true, **report_options)
+          end
+        end
+      end
+
       private
 
       def load_constants

data/app/models/maintenance_tasks/task_data_index.rb

@@ -34,7 +34,8 @@ module MaintenanceTasks
         end
 
         completed_runs = Run.completed.where(task_name: task_names)
-        last_runs = Run.with_attached_csv.where(id: completed_runs.select("MAX(id) as id").group(:task_name))
+        last_runs = Run.with_attached_csv
+          .where(created_at: completed_runs.select("MAX(created_at) as created_at").group(:task_name))
         task_names.map do |task_name|
           last_run = last_runs.find { |run| run.task_name == task_name }
           tasks << TaskDataIndex.new(task_name, last_run)

data/app/views/layouts/maintenance_tasks/_navbar.html.erb

@@ -1,4 +1,4 @@
-<nav class="navbar is-dark is-spaced" role="navigation" aria-label="main navigation">
+<nav class="navbar is-light" role="navigation" aria-label="main navigation">
   <div class="navbar-brand">
     <%= link_to 'Maintenance Tasks', root_path, class: 'navbar-item is-size-4 has-text-weight-semibold has-text-danger' %>
   </div>

data/app/views/layouts/maintenance_tasks/application.html.erb

@@ -15,10 +15,10 @@
     <%= csrf_meta_tags %>
 
     <%=
-      stylesheet_link_tag(URI.join(controller.class::BULMA_CDN, 'npm/bulma@0.9.4/css/bulma.css'),
+      stylesheet_link_tag(URI.join(controller.class::BULMA_CDN, "npm/bulma@1.0.3/css/versions/bulma-no-dark-mode.min.css"),
         media: :all,
-        integrity: 'sha384-qQlNh1kc0FyhUqUDXKkl5wpiiSm8PXQw2ZWhAVfU46tmdMDfq2vXG2CXWYT+Dls3',
-        crossorigin: 'anonymous') unless request.xhr?
+        integrity: "sha256-HCNMQcqH/4MnGR0EYg2S3/BXYMM1z9lrFV10ANRd79o",
+        crossorigin: "anonymous") unless request.xhr?
     %>
 
     <style>
@@ -29,6 +29,36 @@
       .ruby-ivar, .ruby-cvar, .ruby-gvar, .ruby-int, .ruby-imaginary, .ruby-float, .ruby-rational { color: #005cc5; }
       .ruby-kw { color: #d73a49; }
       .ruby-label, .ruby-tstring-beg, .ruby-tstring-content, .ruby-tstring-end { color: #032f62; }
+
+      .select, select { width: 100%; }
+      summary { cursor: pointer; }
+      input[type="datetime-local"], input[type="date"], input[type="time"] {
+        width: fit-content;
+      }
+	  details > summary {
+        list-style: none;
+      }
+      summary::-webkit-details-marker {
+        display: none
+      }
+      summary::before {
+        content: '► ';
+        position:absolute;
+        font-size: 16px
+      }
+      details[open] summary:before {
+        content: "▼ ";
+      }
+
+      .box {
+        box-shadow: 0 4px 6px -1px #0000001a,
+                    0 2px 4px -2px #0000001a;
+      }
+      .label.is-required:after {
+        content: " (required)";
+        color: #ff6685;
+        font-size: 12px;
+      }
     </style>
 
     <script>

data/app/views/maintenance_tasks/runs/_arguments.html.erb

@@ -1,4 +1,4 @@
 <% if arguments.present? %>
-  <h6 class="title is-6">Arguments:</h6>
+  <h6 class="title is-6 has-text-weight-medium">Arguments:</h6>
   <%= render "maintenance_tasks/runs/serializable", serializable: arguments %>
 <% end %>

data/app/views/maintenance_tasks/runs/_run.html.erb

@@ -1,9 +1,15 @@
-<div class="box">
-  <h5 class="title is-5">
-    <%= time_tag run.created_at, title: run.created_at.utc.iso8601 %>
-    <%= status_tag run.status %>
-    <span class="is-pulled-right" title="Run ID">#<%= run.id %></span>
-  </h5>
+<details class="box" open id="run_<%= run.id %>">
+  <summary class="is-flex is-justify-content-space-between is-align-items-center">
+    <div class="is-flex is-align-items-center">
+      <h5 class="title is-5 has-text-weight-medium pl-5 pr-5 mb-0">
+        <%= time_tag run.created_at, title: run.created_at.utc %>
+      </h5>
+      <%= status_tag run.status %>
+    </div>
+    <div>
+      <a href="#run_<%= run.id %>" class="is-pulled-right" title="Run ID">#<%= run.id %></a>
+    </div>
+  </summary>
 
   <%= progress run %>
 
@@ -17,7 +23,7 @@
 
   <%= render "maintenance_tasks/runs/csv", run: run %>
   <%= tag.hr if run.csv_file.present? && run.arguments.present? %>
-  <%= render "maintenance_tasks/runs/arguments", arguments: run.arguments %>
+  <%= render "maintenance_tasks/runs/arguments", arguments: run.masked_arguments %>
   <%= tag.hr if run.csv_file.present? || run.arguments.present? && run.metadata.present? %>
   <%= render "maintenance_tasks/runs/metadata", metadata: run.metadata %>
 
@@ -42,4 +48,4 @@
       <%= button_to 'Cancel', cancel_task_run_path(@task, run), class: 'button is-danger' %>
     <% end%>
   </div>
-</div>
+</details>

data/app/views/maintenance_tasks/runs/_serializable.html.erb

@@ -1,24 +1,21 @@
 <% if serializable.present? %>
   <% case serializable %>
   <% when Hash %>
-    <div class="table-container">
-      <table class="table">
-        <tbody>
-          <% serializable.transform_values(&:to_s).each do |key, value| %>
-            <tr>
-              <td class="is-family-monospace"><%= key %></td>
-              <td>
-                <% next if value.empty? %>
-                <% if value.include?("\n") %>
-                  <pre><%= value %></pre>
-                <% else %>
-                  <code><%= value %></code>
-                <% end %>
-              </td>
-            </tr>
-          <% end %>
-        </tbody>
-      </table>
+    <div class="arguments-container grid is-col-min-15">
+      <% serializable.transform_values(&:to_s).each do |key, value| %>
+        <div class="cell mb-4">
+          <div class="is-family-monospace mb-2"><%= key %></div>
+          <div class="is-flex justify-content">
+            <% if !value.empty? %>
+              <% if value.include?("\n") %>
+                <pre><%= value %></pre>
+              <% else %>
+                <code><%= value %></code>
+              <% end %>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
     </div>
   <% else %>
     <code><%= serializable.inspect %></code>

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

@@ -1,12 +1,12 @@
-<div class="box">
-  <h3 class="title is-3">
+<div class="cell box">
+  <h3 class="title is-5 has-text-weight-medium">
     <%= link_to task, task_path(task) %>
     <%= status_tag(task.status) %>
   </h3>
 
   <% if (run = task.related_run) %>
-    <h5 class="title is-5">
-      <%= time_tag run.created_at, title: run.created_at %>
+    <h5 class="title is-5 has-text-weight-medium">
+      <%= time_tag run.created_at, title: run.created_at.utc %>
     </h5>
 
     <%= progress run %>
@@ -21,7 +21,7 @@
 
     <%= render "maintenance_tasks/runs/csv", run: run %>
     <%= tag.hr if run.csv_file.present? && run.arguments.present? %>
-    <%= render "maintenance_tasks/runs/arguments", arguments: run.arguments %>
+    <%= render "maintenance_tasks/runs/arguments", arguments: run.masked_arguments %>
     <%= tag.hr if run.csv_file.present? || run.arguments.present? && run.metadata.present? %>
     <%= render "maintenance_tasks/runs/metadata", metadata: run.metadata %>
   <% end %>

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

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

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

@@ -1,27 +1,25 @@
 <% content_for :page_title, @task %>
 
-<h1 class="title is-1">
+<h1 class="title is-3 has-text-weight-bold">
   <%= @task %>
 </h1>
 
-<div class="buttons">
+<div class="container">
   <%= form_with url: task_runs_path(@task), method: :post do |form| %>
     <% if @task.csv_task? %>
-      <div class="block">
-        <%= form.label :csv_file %>
+      <div class="container mb-4">
+        <%= form.label :csv_file, class: "label" %>
         <%= form.file_field :csv_file, accept: "text/csv" %>
       </div>
     <% end %>
     <% parameter_names = @task.parameter_names %>
     <% if parameter_names.any? %>
-      <div class="block">
+      <div class="grid is-col-min-15">
         <%= fields_for :task, @task.new do |ff| %>
           <% parameter_names.each do |parameter_name| %>
-            <div class="field">
-              <%= ff.label parameter_name, parameter_name, class: "label is-family-monospace" %>
-              <div class="control">
-                <%= parameter_field(ff, parameter_name) %>
-              </div>
+            <div class="cell">
+              <%= ff.label parameter_name, parameter_name, class: ["label", "is-family-monospace", { "is-required": attribute_required?(ff.object, parameter_name) }] %>
+              <%= parameter_field(ff, parameter_name) %>
             </div>
           <% end %>
         <% end %>
@@ -29,13 +27,19 @@
     <% end %>
     <%= render "maintenance_tasks/tasks/custom", form: form %>
     <div class="block">
-      <%= form.submit 'Run', class: "button is-success", disabled: @task.deleted? %>
+      <%= form.submit 'Run', class: "button is-success is-rounded mb-4 has-text-white-ter", disabled: @task.deleted? %>
     </div>
   <% end %>
 </div>
 
 <% if (code = @task.code) %>
+
+<details class="box">
+  <summary class="is-size-5 is-flex is-align-items-center">
+    <h5 class="pl-5">Source code</h5>
+  </summary>
   <pre><code><%= highlight_code(code) %></code></pre>
+</details>
 <% end %>
 
 <%= tag.div(data: { refresh: @task.refresh? || "" }) do %>
@@ -50,7 +54,7 @@
   <% if @task.runs_page.records.present? %>
     <hr/>
 
-    <h4 class="title is-4">Previous Runs</h4>
+    <h4 class="title is-5 has-text-weight-bold">Previous Runs</h4>
 
     <%= render partial: "maintenance_tasks/runs/run", collection: @task.runs_page.records %>
 

data/db/migrate/20201211151756_create_maintenance_tasks_runs.rb

@@ -2,7 +2,7 @@
 
 class CreateMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
   def change
-    create_table(:maintenance_tasks_runs) do |t|
+    create_table(:maintenance_tasks_runs, id: primary_key_type) do |t|
       t.string(:task_name, null: false)
       t.datetime(:started_at)
       t.datetime(:ended_at)
@@ -20,4 +20,12 @@ class CreateMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
       t.index([:task_name, :created_at], order: { created_at: :desc })
     end
   end
+
+  private
+
+  def primary_key_type
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    setting || :primary_key
+  end
 end

data/lib/maintenance_tasks/engine.rb

@@ -21,6 +21,12 @@ module MaintenanceTasks
       MaintenanceTasks.backtrace_cleaner = Rails.backtrace_cleaner
     end
 
+    if Rails.gem_version >= Gem::Version.new("7.1")
+      initializer "maintenance_tasks.deprecator" do
+        Rails.application.deprecators[:maintenance_tasks] = MaintenanceTasks.deprecator
+      end
+    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,30 @@ module MaintenanceTasks
   #
   #  @return [ActiveSupport::Duration] the threshold in seconds after which a task is considered stuck.
   mattr_accessor :stuck_task_duration, default: 5.minutes
+
+  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.12.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.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !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.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !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.12.0
   allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
@@ -200,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.1
+rubygems_version: 3.6.8
 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