maintenance_tasks 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c33ddef00ee39487f42a7275fd3b11367bc16f32007a607e2d6fd7a9b3b55d
-  data.tar.gz: 841a336d86ce65e52d2ddee9cef746f9a448664328213056ea8c7a9f0d861b76
+  metadata.gz: dadbcebb3f103324f6dd5d4319777ffbb5caa5c935912f092299275d27c40f58
+  data.tar.gz: a58d54eed126d14c9e3e036cc76238f3c738de40c66038882f4824230137c791
 SHA512:
-  metadata.gz: cefc3a619d3d3aec10c6104cf227c33558e1d30146f0d9338706eb30c4e21f58bda704905c85a8faa87bc4735d5255b714c8690b6b733f9dcde42216231abc3d
-  data.tar.gz: 4f23532262622d91da4065926f19e96bb22788877acc10e1e7a0ce327e7136a2c24905e9a29aacbbdbe380c39dc58e593a0254e6bfec2b1c6d929f8e5fe13304
+  metadata.gz: d0ffc76f0c5a2b7a3520ac7e8ae5f41e346f03eb84500238c1e73fec7dfea11586aa6d6b2c44841b72b550c023f3e7f4926dab686b823e475a22ec31e1b513ae
+  data.tar.gz: ac810b5fd6f1a9965bdf9556035196d4603bf84dd03297fb1f02ba5aa31c38935db9bca1d8195dc0950875083d0e372a0c540226bf80b9beb4986624072f71d6

data/README.md

@@ -832,6 +832,19 @@ 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 = ->(context) do
+ { user_email: context.current_user.email }
+end
+```
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -14,6 +14,7 @@ module MaintenanceTasks
         name: params.fetch(:task_id),
         csv_file: params[:csv_file],
         arguments: params.fetch(:task_arguments, {}).permit!.to_h,
+        metadata: instance_exec(&MaintenanceTasks.metadata || -> {}),
         &block
       )
       redirect_to(task_path(task))

data/app/models/maintenance_tasks/run.rb

@@ -36,9 +36,7 @@ module MaintenanceTasks
 
     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
@@ -48,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) }
@@ -337,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/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

@@ -82,4 +82,11 @@ module MaintenanceTasks
   #
   #   @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.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -137,6 +137,7 @@ files:
 - 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
@@ -155,7 +156,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.2.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.3.1
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks