maintenance_tasks 2.10.1 → 2.13.0

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
 
@@ -48,15 +44,9 @@ module MaintenanceTasks
 
     attr_readonly :task_name
 
-    if Rails.gem_version >= Gem::Version.new("7.1.alpha")
-      serialize :backtrace, coder: YAML
-      serialize :arguments, coder: JSON
-      serialize :metadata, coder: JSON
-    else
-      serialize :backtrace
-      serialize :arguments, JSON
-      serialize :metadata, JSON
-    end
+    serialize :backtrace, coder: YAML
+    serialize :arguments, coder: JSON
+    serialize :metadata, coder: JSON
 
     scope :active, -> { where(status: ACTIVE_STATUSES) }
     scope :completed, -> { where(status: COMPLETED_STATUSES) }
@@ -83,11 +73,10 @@ module MaintenanceTasks
     # Rescues and retries status transition if an ActiveRecord::StaleObjectError
     # is encountered.
     def enqueued!
-      status_will_change!
-      super
-    rescue ActiveRecord::StaleObjectError
-      reload_status
-      retry
+      with_stale_object_retry do
+        status_will_change!
+        super
+      end
     end
 
     CALLBACKS_TRANSITION = {
@@ -96,23 +85,39 @@ module MaintenanceTasks
       paused: :pause,
       succeeded: :complete,
     }.transform_keys(&:to_s)
-    private_constant :CALLBACKS_TRANSITION
+
+    DELAYS_PER_ATTEMPT = [0.1, 0.2, 0.4, 0.8, 1.6]
+    MAX_RETRIES = DELAYS_PER_ATTEMPT.size
+
+    private_constant :CALLBACKS_TRANSITION, :DELAYS_PER_ATTEMPT, :MAX_RETRIES
 
     # Saves the run, persisting the transition of its status, and all other
     # changes to the object.
     def persist_transition
-      save!
+      retry_count = 0
+      begin
+        save!
+      rescue ActiveRecord::StaleObjectError
+        if retry_count < MAX_RETRIES
+          sleep(DELAYS_PER_ATTEMPT[retry_count])
+          retry_count += 1
+
+          success = succeeded?
+          reload_status
+          if success
+            self.status = :succeeded
+          else
+            job_shutdown
+          end
+
+          retry
+        else
+          raise
+        end
+      end
+
       callback = CALLBACKS_TRANSITION[status]
       run_task_callbacks(callback) if callback
-    rescue ActiveRecord::StaleObjectError
-      success = succeeded?
-      reload_status
-      if success
-        self.status = :succeeded
-      else
-        job_shutdown
-      end
-      retry
     end
 
     # Increments +tick_count+ by +number_of_ticks+ and +time_running+ by
@@ -130,29 +135,23 @@ module MaintenanceTasks
         time_running: duration,
         touch: true,
       )
-      if locking_enabled?
-        locking_column = self.class.locking_column
-        self[locking_column] += 1
-        clear_attribute_change(locking_column)
-      end
     end
 
     # Marks the run as errored and persists the error data.
     #
     # @param error [StandardError] the Error being persisted.
     def persist_error(error)
-      self.started_at ||= Time.now
-      update!(
-        status: :errored,
-        error_class: truncate(:error_class, error.class.name),
-        error_message: truncate(:error_message, error.message),
-        backtrace: MaintenanceTasks.backtrace_cleaner.clean(error.backtrace),
-        ended_at: Time.now,
-      )
+      with_stale_object_retry do
+        self.started_at ||= Time.now
+        update!(
+          status: :errored,
+          error_class: truncate(:error_class, error.class.name),
+          error_message: truncate(:error_message, error.message),
+          backtrace: MaintenanceTasks.backtrace_cleaner.clean(error.backtrace),
+          ended_at: Time.now,
+        )
+      end
       run_error_callback
-    rescue ActiveRecord::StaleObjectError
-      reload_status
-      retry
     end
 
     # Refreshes the status and lock version attributes on the Active Record
@@ -245,11 +244,8 @@ module MaintenanceTasks
     # is encountered.
     def running
       if locking_enabled?
-        begin
+        with_stale_object_retry do
           running! unless stopping?
-        rescue ActiveRecord::StaleObjectError
-          reload_status
-          retry
         end
       else
         # Preserve swap-and-replace solution for data races until users
@@ -272,11 +268,11 @@ module MaintenanceTasks
     # @param count [Integer] the total iterations to be performed, as
     #   specified by the Task.
     def start(count)
-      update!(started_at: Time.now, tick_total: count)
+      with_stale_object_retry do
+        update!(started_at: Time.now, tick_total: count)
+      end
+
       task.run_callbacks(:start)
-    rescue ActiveRecord::StaleObjectError
-      reload_status
-      retry
     end
 
     # Handles transitioning the status on a Run when the job shuts down.
@@ -311,16 +307,15 @@ module MaintenanceTasks
     # minutes ago, it will transition to cancelled, and the ended_at timestamp
     # will be updated.
     def cancel
-      if paused? || stuck?
-        self.status = :cancelled
-        self.ended_at = Time.now
-        persist_transition
-      else
-        cancelling!
+      with_stale_object_retry do
+        if paused? || stuck?
+          self.status = :cancelled
+          self.ended_at = Time.now
+          persist_transition
+        else
+          cancelling!
+        end
       end
-    rescue ActiveRecord::StaleObjectError
-      reload_status
-      retry
     end
 
     # Marks a Run as pausing.
@@ -331,15 +326,14 @@ module MaintenanceTasks
     # Rescues and retries status transition if an ActiveRecord::StaleObjectError
     # is encountered.
     def pause
-      if stuck?
-        self.status = :paused
-        persist_transition
-      else
-        pausing!
+      with_stale_object_retry do
+        if stuck?
+          self.status = :paused
+          persist_transition
+        else
+          pausing!
+        end
       end
-    rescue ActiveRecord::StaleObjectError
-      reload_status
-      retry
     end
 
     # Returns whether a Run is stuck, which is defined as having a status of
@@ -426,12 +420,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 +491,32 @@ module MaintenanceTasks
 
       value&.first(limit)
     end
+
+    def argument_filter
+      @argument_filter ||= ActiveSupport::ParameterFilter.new(
+        Rails.application.config.filter_parameters + task.masked_arguments,
+      )
+    end
+
+    def with_stale_object_retry(retry_count = 0)
+      yield
+    rescue ActiveRecord::StaleObjectError
+      if retry_count < MAX_RETRIES
+        sleep(stale_object_retry_delay(retry_count))
+        retry_count += 1
+        reload_status
+
+        retry
+      else
+        raise
+      end
+    end
+
+    def stale_object_retry_delay(retry_count)
+      delay = DELAYS_PER_ATTEMPT[retry_count]
+      # Add jitter (±25% randomization) to prevent thundering herd
+      jitter = delay * 0.25
+      delay + (rand * 2 - 1) * jitter
+    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,21 @@ 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: []
+
+    # The frequency at which to reload the run status during iteration.
+    # Defaults to the global MaintenanceTasks.status_reload_frequency setting.
+    #
+    # @api private
+    class_attribute :status_reload_frequency, default: MaintenanceTasks.status_reload_frequency
+
     define_callbacks :start, :complete, :error, :cancel, :pause, :interrupt
 
+    attr_accessor :metadata
+
     class << self
       # Finds a Task with the given name.
       #
@@ -152,6 +166,22 @@ 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
+
+      # Configure how frequently the run status should be reloaded during iteration.
+      # Use this to reduce database queries when processing large collections.
+      #
+      # @param frequency [ActiveSupport::Duration, Numeric] reload status every N seconds (default: 1 second).
+      #   Setting this to 10.seconds means status will be reloaded every 10 seconds.
+      def reload_status_every(frequency)
+        self.status_reload_frequency = frequency
+      end
+
       # Initialize a callback to run after the task starts.
       #
       # @param filter_list apply filters to the callback
@@ -200,6 +230,18 @@ 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>{ handled: true, source: "maintenance-tasks" }</code>.
+      def report_on(*exceptions, **report_options)
+        rescue_from(*exceptions) do |exception|
+          Rails.error.report(exception, source: "maintenance-tasks", **report_options)
+        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

@@ -3,6 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+    <%= capybara_lockstep if defined?(Capybara::Lockstep) %>
 
     <title>
       <% if content_for?(:page_title) %>
@@ -15,10 +16,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 +30,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>
@@ -69,6 +100,6 @@
 
         <%= yield %>
       </div>
-    </div>
+    </section>
   </body>
 </html>

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class CreateMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
+class CreateMaintenanceTasksRuns < ActiveRecord::Migration[7.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/db/migrate/20210219212931_change_cursor_to_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ChangeCursorToString < ActiveRecord::Migration[6.0]
+class ChangeCursorToString < ActiveRecord::Migration[7.0]
   # This migration will clear all existing data in the cursor column with MySQL.
   # Ensure no Tasks are paused when this migration is deployed, or they will be resumed from the start.
   # Running tasks are able to gracefully handle this change, even if interrupted.

data/db/migrate/20210225152418_remove_index_on_task_name.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class RemoveIndexOnTaskName < ActiveRecord::Migration[6.0]
+class RemoveIndexOnTaskName < ActiveRecord::Migration[7.0]
   def up
     change_table(:maintenance_tasks_runs) do |t|
       t.remove_index(:task_name)