maintenance_tasks 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c395c28308277378c5ac627845abc512bba455e11e085558aa4ef106f73b1130
-  data.tar.gz: 7e44c8b5c484aa44008e2ebd3dd35458f84dec2be2741c20cc1ae20871c10f48
+  metadata.gz: a14c442d683123d8aabb30db8c73c15a31ddd24852356aa64b0255b1cb2312e0
+  data.tar.gz: d5df5cbfa0cf9feab143ae2ea15cb5a0013978b552a068d9a588fed4e04178bd
 SHA512:
-  metadata.gz: 825418a040b4b15f0a98c5e28b06c553e240ec7b0ba10b2adec7b28180203d3e7094cb4e4b2933076d7564050b42f33504ede5b830e1819274393cf9d574f058
-  data.tar.gz: d2d7aa0c97a37851d8540edea5a4e890b1eeb9fbfc740c157070558fbc51e60ef9d3ff882b5ab21cd9b80481f7b2692d9a3f8fbaa03bbdcd4256f1b51aa669ce
+  metadata.gz: 528669b01c611fe0e502683665182bddb2a98f2a74911c5d957f3868fca2ff57323a07eb2093acdfedc39e44057f8346702f70fc67cf027f59a32b985a6f7cea
+  data.tar.gz: bb00d7ef688b49ad9ae295650eea0b57718ea95aea6b341780011d882ae2b0f9ac830241cd9663d3bd7c9b9e08b3ee9bf6daa91a4ef2e4c53b69a15350c2da06

data/README.md

@@ -804,6 +804,47 @@ MaintenanceTasks.backtrace_cleaner = cleaner
 If none is specified, the default `Rails.backtrace_cleaner` will be used to
 clean backtraces.
 
+#### Customizing the parent controller for the web UI
+
+`MaintenanceTasks.parent_controller` can be configured to specify a controller class for all of the web UI engine's
+controllers to inherit from.
+
+This allows applications with common logic in their `ApplicationController` (or
+any other controller) to optionally configure the web UI to inherit that logic
+with a simple assignment in the initializer.
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+
+MaintenanceTasks.parent_controller = "Services::CustomController"
+
+# app/controllers/services/custom_controller.rb
+
+class Services::CustomController < ActionController::Base
+  include CustomSecurityThings
+  include CustomLoggingThings
+  ...
+end
+```
+
+The parent controller value **must** be a string corresponding to an existing
+controller class which **must inherit** from `ActionController::Base`.
+
+If no value is specified, it will default to `"ActionController::Base"`.
+
+### Metadata
+
+`MaintenanceTasks.metadata` can be configured to specify a proc from which to get extra information about the run.
+Since this proc will be ran in the context of the `MaintenanceTasks.parent_controller`, it can be used to keep the id
+or email of the user who performed the maintenance task.
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+MaintenanceTasks.metadata = -> do
+ { user_email: current_user.email }
+end
+```
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -4,7 +4,7 @@ module MaintenanceTasks
   # Base class for all controllers used by this engine.
   #
   # Can be extended to add different authentication and authorization code.
-  class ApplicationController < ActionController::Base
+  class ApplicationController < MaintenanceTasks.parent_controller.constantize
     BULMA_CDN = "https://cdn.jsdelivr.net"
 
     content_security_policy do |policy|
@@ -20,11 +20,6 @@ module MaintenanceTasks
       policy.frame_ancestors(:self)
     end
 
-    before_action do
-      request.content_security_policy_nonce_generator ||= ->(_request) { SecureRandom.base64(16) }
-      request.content_security_policy_nonce_directives = ["style-src"]
-    end
-
     protect_from_forgery with: :exception
   end
 end

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -14,13 +14,14 @@ module MaintenanceTasks
         name: params.fetch(:task_id),
         csv_file: params[:csv_file],
         arguments: params.fetch(:task_arguments, {}).permit!.to_h,
+        metadata: MaintenanceTasks.metadata&.call,
         &block
       )
       redirect_to(task_path(task))
     rescue ActiveRecord::RecordInvalid => error
       redirect_to(task_path(error.record.task_name), alert: error.message)
     rescue ActiveRecord::ValueTooLong => error
-      task_name = params.fetch(:id)
+      task_name = params.fetch(:task_id)
       redirect_to(task_path(task_name), alert: error.message)
     rescue Runner::EnqueuingError => error
       redirect_to(task_path(error.run.task_name), alert: error.message)

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -109,7 +109,7 @@ module MaintenanceTasks
       when ActiveModel::Type::Decimal, ActiveModel::Type::Float
         form_builder.number_field(parameter_name, { step: "any" })
       when ActiveModel::Type::DateTime
-        form_builder.datetime_field(parameter_name)
+        form_builder.datetime_field(parameter_name) + datetime_field_help_text
       when ActiveModel::Type::Date
         form_builder.date_field(parameter_name)
       when ActiveModel::Type::Time
@@ -120,5 +120,19 @@ module MaintenanceTasks
         form_builder.text_area(parameter_name, class: "textarea")
       end
     end
+
+    # Return helper text for the datetime-local form field.
+    def datetime_field_help_text
+      text =
+        if Time.zone_default.nil? || Time.zone_default.name == "UTC"
+          "Timezone: UTC."
+        else
+          "Timezone: #{Time.now.zone}."
+        end
+      tag.div(
+        tag.p(text),
+        class: "content is-small",
+      )
+    end
   end
 end

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

@@ -56,14 +56,14 @@ module MaintenanceTasks
           batch_size: collection.batch_size,
         )
       when Array
-        enumerator_builder.build_array_enumerator(collection, cursor: cursor)
+        enumerator_builder.build_array_enumerator(collection, cursor: cursor&.to_i)
       when BatchCsvCollectionBuilder::BatchCsv
         JobIteration::CsvEnumerator.new(collection.csv).batches(
           batch_size: collection.batch_size,
-          cursor: cursor,
+          cursor: cursor&.to_i,
         )
       when CSV
-        JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor)
+        JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor&.to_i)
       else
         raise ArgumentError, <<~MSG.squish
           #{@task.class.name}#collection must be either an

data/app/models/maintenance_tasks/run.rb

@@ -32,14 +32,11 @@ module MaintenanceTasks
       :cancelled,
     ]
     COMPLETED_STATUSES = [:succeeded, :errored, :cancelled]
-    COMPLETED_RUNS_LIMIT = 10
     STUCK_TASK_TIMEOUT = 5.minutes
 
     enum status: STATUSES.to_h { |status| [status, status.to_s] }
 
-    validates :task_name, on: :create, inclusion: {
-      in: ->(_) { Task.available_tasks.map(&:to_s) },
-    }
+    validate :task_name_belongs_to_a_valid_task, on: :create
     validate :csv_attachment_presence, on: :create
     validate :csv_content_type, on: :create
     validate :validate_task_arguments, on: :create
@@ -49,9 +46,11 @@ module MaintenanceTasks
     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
 
     scope :active, -> { where(status: ACTIVE_STATUSES) }
@@ -338,6 +337,15 @@ module MaintenanceTasks
       cancelling? && updated_at <= STUCK_TASK_TIMEOUT.ago
     end
 
+    # Performs validation on the task_name attribute.
+    # A Run must be associated with a valid Task to be valid.
+    # In order to confirm that, the Task is looked up by name.
+    def task_name_belongs_to_a_valid_task
+      Task.named(task_name)
+    rescue Task::NotFoundError
+      errors.add(:task_name, "must be the name of an existing Task.")
+    end
+
     # Performs validation on the presence of a :csv_file attachment.
     # A Run for a Task that uses CsvCollection must have an attached :csv_file
     # to be valid. Conversely, a Run for a Task that doesn't use CsvCollection

data/app/models/maintenance_tasks/runner.rb

@@ -39,8 +39,8 @@ module MaintenanceTasks
     #   creating the Run.
     # @raise [ActiveRecord::ValueTooLong] if the creation of the Run fails due
     #   to a value being too long for the column type.
-    def run(name:, csv_file: nil, arguments: {}, run_model: Run)
-      run = run_model.new(task_name: name, arguments: arguments)
+    def run(name:, csv_file: nil, arguments: {}, run_model: Run, metadata: nil)
+      run = run_model.new(task_name: name, arguments: arguments, metadata: metadata)
       if csv_file
         run.csv_file.attach(csv_file)
         run.csv_file.filename = filename(name)

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

@@ -9,9 +9,9 @@
             <td>
               <% next if value.empty? %>
               <% if value.include?("\n") %>
-                <pre><%= value %><pre>
+                <pre><%= value %></pre>
               <% else %>
-                <code><%= value %><code>
+                <code><%= value %></code>
               <% end %>
             </td>
           </tr>

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

@@ -1,6 +1,6 @@
 <div class="box">
   <h5 class="title is-5">
-    <%= time_tag run.created_at, title: run.created_at %>
+    <%= time_tag run.created_at, title: run.created_at.utc.iso8601 %>
     <%= status_tag run.status %>
   </h5>
 

data/db/migrate/20210219212931_change_cursor_to_string.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ChangeCursorToString < ActiveRecord::Migration[6.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.
+  def up
+    change_table(:maintenance_tasks_runs) do |t|
+      t.change(:cursor, :string)
+    end
+  end
+
+  def down
+    change_table(:maintenance_tasks_runs) do |t|
+      t.change(:cursor, :bigint)
+    end
+  end
+end

data/db/migrate/20230622035229_add_metadata_to_runs.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddMetadataToRuns < ActiveRecord::Migration[6.0]
+  def change
+    add_column(:maintenance_tasks_runs, :metadata, :text)
+  end
+end

data/lib/maintenance_tasks.rb

@@ -72,4 +72,21 @@ module MaintenanceTasks
   #   @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
+  #
+  #   The parent controller all web UI controllers will inherit from.
+  #   Must be a class that inherits from `ActionController::Base`.
+  #   Defaults to `"ActionController::Base"`
+  #
+  #   @return [String] the name of the parent controller for web UI.
+  mattr_accessor :parent_controller, default: "ActionController::Base"
+
+  # @!attribute metadata
+  #  @scope class
+  #   The Proc to call from the controller to generate metadata that will be persisted on the Run.
+  #
+  #   @return [Proc] generates a hash containing the metadata to be stored on the Run
+  mattr_accessor :metadata, default: nil
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -131,11 +131,13 @@ files:
 - app/views/maintenance_tasks/tasks/show.html.erb
 - config/routes.rb
 - db/migrate/20201211151756_create_maintenance_tasks_runs.rb
+- db/migrate/20210219212931_change_cursor_to_string.rb
 - db/migrate/20210225152418_remove_index_on_task_name.rb
 - db/migrate/20210517131953_add_arguments_to_maintenance_tasks_runs.rb
 - db/migrate/20211210152329_add_lock_version_to_maintenance_tasks_runs.rb
 - 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
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
@@ -154,7 +156,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.1.1
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.3.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -164,14 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks