maintenance_tasks 1.4.0 → 1.8.0

data/app/models/maintenance_tasks/task_data.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module MaintenanceTasks
   # Class that represents the data related to a Task. Such information can be
   # sourced from a Task or from existing Run records for a Task that was since
@@ -40,7 +41,7 @@ module MaintenanceTasks
       def available_tasks
         task_names = Task.available_tasks.map(&:name)
         available_task_runs = Run.where(task_name: task_names)
-        last_runs = Run.where(
+        last_runs = Run.with_attached_csv.where(
           id: available_task_runs.select("MAX(id) as id").group(:task_name)
         )
 
@@ -73,7 +74,11 @@ module MaintenanceTasks
     def code
       return if deleted?
       task = Task.named(name)
-      file = task.instance_method(:process).source_location.first
+      file = if Object.respond_to?(:const_source_location)
+        Object.const_source_location(task.name).first
+      else
+        task.instance_method(:process).source_location.first
+      end
       File.read(file)
     end
 
@@ -129,7 +134,7 @@ module MaintenanceTasks
 
     # @return [Boolean] whether the Task inherits from CsvTask.
     def csv_task?
-      !deleted? && Task.named(name) < CsvCollection
+      !deleted? && Task.named(name).has_csv_content?
     end
 
     # @return [Array<String>] the names of parameters the Task accepts.
@@ -141,6 +146,13 @@ module MaintenanceTasks
       end
     end
 
+    # @return [MaintenanceTasks::Task, nil] an instance of the Task class.
+    # @return [nil] if the Task file was deleted.
+    def new
+      return if deleted?
+      MaintenanceTasks::Task.named(name).new
+    end
+
     private
 
     def runs

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module MaintenanceTasks
   # Custom validator class responsible for ensuring that transitions between
   # Run statuses are valid.
@@ -48,9 +49,8 @@ module MaintenanceTasks
         "errored",
       ],
       # paused -> enqueued occurs when the task is resumed after being paused.
-      # paused -> cancelling when the user cancels the task after it is paused.
       # paused -> cancelled when the user cancels the task after it is paused.
-      "paused" => ["enqueued", "cancelling", "cancelled"],
+      "paused" => ["enqueued", "cancelled"],
       # interrupted -> running occurs when the task is resumed after being
       #   interrupted by the job infrastructure.
       # interrupted -> pausing occurs when the task is paused by the user while

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

@@ -0,0 +1,22 @@
+<% if run.arguments.present? %>
+  <div class="table-container">
+    <h6 class="title is-6">Arguments:</h6>
+    <table class="table">
+      <tbody>
+        <% run.arguments.each do |key, value| %>
+          <tr>
+            <td class="is-family-monospace"><%= key %></td>
+            <td>
+              <% next if value.nil? || value.empty? %>
+              <% if value.include?("\n") %>
+                <pre><%= value %><pre>
+              <% else %>
+                <code><%= value %><code>
+              <% end %>
+            </td>
+          </tr>
+          <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

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

@@ -0,0 +1,5 @@
+<% if run.csv_file.present? %>
+  <div class="block">
+    <%= link_to("Download CSV", csv_file_download_path(run)) %>
+  </div>
+<% end %>

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

@@ -1,3 +1,20 @@
 <div class="box">
-  <%= render 'maintenance_tasks/runs/info', run: run, with_status: true %>
+  <h5 class="title is-5">
+    <%= time_tag run.created_at, title: run.created_at %>
+    <%= status_tag run.status %>
+  </h5>
+
+  <%= progress run %>
+
+  <div class="content">
+    <%= render "maintenance_tasks/runs/info/#{run.status}", run: run %>
+  </div>
+
+  <div class="content" id="custom-content">
+    <%= render "maintenance_tasks/runs/info/custom", run: run %>
+  </div>
+
+  <%= render "maintenance_tasks/runs/csv", run: run %>
+  <%= tag.hr if run.csv_file.present? && run.arguments.present? %>
+  <%= render "maintenance_tasks/runs/arguments", run: run %>
 </div>

data/app/views/maintenance_tasks/runs/info/_errored.html.erb

@@ -3,8 +3,6 @@
   <%= time_ago run.ended_at %>.
 </p>
 
-</p>
-
 <div class="card">
   <header class="card-header">
     <p class="card-header-title">

data/app/views/maintenance_tasks/runs/info/_running.html.erb

@@ -1,5 +1,3 @@
-<p>
-  <% if (time_to_completion = run.time_to_completion) %>
-    <%= distance_of_time_in_words(time_to_completion).capitalize %> remaining.
-  <% end %>
-</p>
+<% if (time_to_completion = run.time_to_completion) %>
+  <p>Running for <%= time_running_in_words(run)  %>. <%= distance_of_time_in_words(time_to_completion).capitalize %> remaining.</p>
+<% end %>

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

@@ -4,5 +4,23 @@
     <%= status_tag(task.status) %>
   </h3>
 
-  <%= render 'maintenance_tasks/runs/info', run: task.last_run, with_status: false if task.last_run %>
+  <% if (run = task.last_run) %>
+    <h5 class="title is-5">
+      <%= time_tag run.created_at, title: run.created_at %>
+    </h5>
+
+    <%= progress run %>
+
+    <div class="content">
+      <%= render "maintenance_tasks/runs/info/#{run.status}", run: run %>
+    </div>
+
+    <div class="content" id="custom-content">
+      <%= render "maintenance_tasks/runs/info/custom", run: run %>
+    </div>
+
+    <%= render "maintenance_tasks/runs/csv", run: run %>
+    <%= tag.hr if run.csv_file.present? && run.arguments.present? %>
+    <%= render "maintenance_tasks/runs/arguments", run: run %>
+  <% end %>
 </div>

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

@@ -4,10 +4,29 @@
   <%= @task %> <%= status_tag(@task.status) %>
 </h1>
 
-<%= render 'maintenance_tasks/runs/info', run: @task.last_run, with_status: false if @task.last_run %>
+<% last_run = @task.last_run %>
+<% if last_run %>
+  <h5 class="title is-5">
+    <%= time_tag last_run.created_at, title: last_run.created_at %>
+  </h5>
+
+  <%= progress last_run %>
+
+  <div class="content">
+    <%= render "maintenance_tasks/runs/info/#{last_run.status}", run: last_run %>
+  </div>
+
+  <div class="content" id="custom-content">
+    <%= render "maintenance_tasks/runs/info/custom", run: last_run %>
+  </div>
+
+  <%= render "maintenance_tasks/runs/csv", run: last_run %>
+  <%= tag.hr if last_run.csv_file.present? %>
+  <%= render "maintenance_tasks/runs/arguments", run: last_run %>
+  <%= tag.hr if last_run.arguments.present? %>
+<% end %>
 
 <div class="buttons">
-  <% last_run = @task.last_run %>
   <% if last_run.nil? || last_run.completed? %>
     <%= form_with url: run_task_path(@task), method: :put do |form| %>
       <% if @task.csv_task? %>
@@ -16,16 +35,22 @@
           <%= form.file_field :csv_file %>
         </div>
       <% end %>
-      <% if @task.parameter_names.any? %>
+      <% parameter_names = @task.parameter_names %>
+      <% if parameter_names.any? %>
         <div class="block">
-          <%= form.fields_for :task_arguments do |ff| %>
-            <% @task.parameter_names.each do |parameter| %>
-              <%= ff.label parameter, "#{parameter}: ", class: "label" %>
-              <%= ff.text_area parameter, class: "textarea" %>
+          <%= form.fields_for :task_arguments, @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>
             <% end %>
           <% end %>
         </div>
       <% end %>
+      <%= render "maintenance_tasks/tasks/custom", form: form %>
       <div class="block">
         <%= form.submit 'Run', class: "button is-success", disabled: @task.deleted? %>
       </div>

data/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 MaintenanceTasks::Engine.routes.draw do
   resources :tasks, only: [:index, :show], format: false do
     member do

data/db/migrate/20201211151756_create_maintenance_tasks_runs.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
   def change
     create_table(:maintenance_tasks_runs) do |t|

data/db/migrate/20210225152418_remove_index_on_task_name.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class RemoveIndexOnTaskName < ActiveRecord::Migration[6.0]
   def up
     change_table(:maintenance_tasks_runs) do |t|

data/db/migrate/20210517131953_add_arguments_to_maintenance_tasks_runs.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class AddArgumentsToMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
   def change
     add_column(:maintenance_tasks_runs, :arguments, :text)

data/db/migrate/20211210152329_add_lock_version_to_maintenance_tasks_runs.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddLockVersionToMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
+  def change
+    add_column(:maintenance_tasks_runs, :lock_version, :integer,
+      default: 0, null: false)
+  end
+end

data/lib/generators/maintenance_tasks/install_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module MaintenanceTasks
   # Generator used to set up the engine in the host application. It handles
   # mounting the engine and installing migrations.

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -12,10 +12,17 @@ module MaintenanceTasks
     class_option :csv, type: :boolean, default: false,
       desc: "Generate a CSV Task."
 
+    class_option :no_collection, type: :boolean, default: false,
+      desc: "Generate a collection-less Task."
+
     check_class_collision suffix: "Task"
 
     # Creates the Task file.
     def create_task_file
+      if options[:csv] && options[:no_collection]
+        raise "Multiple Task type options provided. Please use either "\
+          "--csv or --no-collection."
+      end
       template_file = File.join(
         "app/tasks/#{tasks_module_file_path}",
         class_path,
@@ -23,6 +30,8 @@ module MaintenanceTasks
       )
       if options[:csv]
         template("csv_task.rb", template_file)
+      elsif no_collection?
+        template("no_collection_task.rb", template_file)
       else
         template("task.rb", template_file)
       end
@@ -76,5 +85,9 @@ module MaintenanceTasks
     def test_framework
       Rails.application.config.generators.options[:rails][:test_framework]
     end
+
+    def no_collection?
+      options[:no_collection]
+    end
   end
 end

data/lib/generators/maintenance_tasks/templates/no_collection_task.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module <%= tasks_module %>
+<% module_namespacing do -%>
+  class <%= class_name %>Task < MaintenanceTasks::Task
+    no_collection
+
+    def process
+      # The work to be done
+    end
+  end
+<% end -%>
+end

data/lib/generators/maintenance_tasks/templates/no_collection_task_test.rb.tt

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module <%= tasks_module %>
+<% module_namespacing do -%>
+  class <%= class_name %>TaskTest < ActiveSupport::TestCase
+    # test "#process performs a task iteration" do
+    #   <%= tasks_module %>::<%= class_name %>Task.process
+    # end
+  end
+<% end -%>
+end

data/lib/generators/maintenance_tasks/templates/task.rb.tt

@@ -9,7 +9,9 @@ module <%= tasks_module %>
     end
 
     def process(element)
-      # The work to be done in a single iteration of the task
+      # The work to be done in a single iteration of the task.
+      # This should be idempotent, as the same element may be processed more
+      # than once if the task is interrupted and resumed.
     end
 
     def count

data/lib/generators/maintenance_tasks/templates/task_test.rb.tt

@@ -5,7 +5,11 @@ module <%= tasks_module %>
 <% module_namespacing do -%>
   class <%= class_name %>TaskTest < ActiveSupport::TestCase
     # test "#process performs a task iteration" do
+    <%- if no_collection? -%>
+    #   <%= tasks_module %>::<%= class_name %>Task.process
+    <%- else -%>
     #   <%= tasks_module %>::<%= class_name %>Task.process(element)
+    <%- end -%>
     # end
   end
 <% end -%>

data/lib/maintenance_tasks/cli.rb

@@ -25,12 +25,13 @@ module MaintenanceTasks
     LONGDESC
 
     # Specify the CSV file to process for CSV Tasks
-    option :csv, desc: "Supply a CSV file to be processed by a CSV Task, "\
-      '--csv "path/to/csv/file.csv"'
-
+    desc = "Supply a CSV file to be processed by a CSV Task, "\
+      "--csv path/to/csv/file.csv"
+    option :csv, desc: desc
     # Specify arguments to supply to a Task supporting parameters
-    option :arguments, type: :hash, desc: "Supply arguments for a Task that "\
-      "accepts parameters as a set of <key>:<value> pairs."
+    desc = "Supply arguments for a Task that accepts parameters as a set of "\
+      "<key>:<value> pairs."
+    option :arguments, type: :hash, desc: desc
 
     # Command to run a Task.
     #

data/lib/maintenance_tasks/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "active_record/railtie"
 
 module MaintenanceTasks
@@ -7,10 +8,23 @@ module MaintenanceTasks
   class Engine < ::Rails::Engine
     isolate_namespace MaintenanceTasks
 
-    initializer "eager_load_for_classic_autoloader" do
+    initializer "maintenance_tasks.warn_classic_autoloader" do
+      unless Rails.autoloaders.zeitwerk_enabled?
+        ActiveSupport::Deprecation.warn(<<~MSG.squish)
+          Autoloading in classic mode is deprecated and support will be removed in the next
+          release of Maintenance Tasks. Please use Zeitwerk to autoload your application.
+        MSG
+      end
+    end
+
+    initializer "maintenance_tasks.eager_load_for_classic_autoloader" do
       eager_load! unless Rails.autoloaders.zeitwerk_enabled?
     end
 
+    initializer "maintenance_tasks.configs" do
+      MaintenanceTasks.backtrace_cleaner = Rails.backtrace_cleaner
+    end
+
     config.to_prepare do
       _ = TaskJobConcern # load this for JobIteration compatibility check
       unless Rails.autoloaders.zeitwerk_enabled?

data/lib/maintenance_tasks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "action_controller"
 require "action_view"
 require "active_job"
@@ -52,6 +53,16 @@ module MaintenanceTasks
   #     app's config/storage.yml.
   mattr_accessor :active_storage_service
 
+  # @!attribute backtrace_cleaner
+  #   @scope class
+  #
+  #   The Active Support backtrace cleaner that will be used to clean the
+  #   backtrace of a Task that errors.
+  #
+  #   @return [ActiveSupport::BacktraceCleaner, nil] the backtrace cleaner to
+  #     use when cleaning a Run's backtrace.
+  mattr_accessor :backtrace_cleaner
+
   # @private
   def self.error_handler
     return @error_handler if defined?(@error_handler)
@@ -63,7 +74,7 @@ module MaintenanceTasks
     unless error_handler.arity == 3
       ActiveSupport::Deprecation.warn(
         "MaintenanceTasks.error_handler should be a lambda that takes three "\
-         "arguments: error, task_context, and errored_element."
+          "arguments: error, task_context, and errored_element."
       )
       @error_handler = ->(error, _task_context, _errored_element) do
         error_handler.call(error)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -97,21 +97,25 @@ files:
 - app/jobs/concerns/maintenance_tasks/task_job_concern.rb
 - app/jobs/maintenance_tasks/task_job.rb
 - app/models/maintenance_tasks/application_record.rb
-- app/models/maintenance_tasks/csv_collection.rb
+- app/models/maintenance_tasks/csv_collection_builder.rb
+- app/models/maintenance_tasks/no_collection_builder.rb
+- app/models/maintenance_tasks/null_collection_builder.rb
 - app/models/maintenance_tasks/progress.rb
 - app/models/maintenance_tasks/run.rb
 - app/models/maintenance_tasks/runner.rb
 - app/models/maintenance_tasks/runs_page.rb
+- app/models/maintenance_tasks/task.rb
 - app/models/maintenance_tasks/task_data.rb
 - app/models/maintenance_tasks/ticker.rb
-- app/tasks/maintenance_tasks/task.rb
 - app/validators/maintenance_tasks/run_status_validator.rb
 - app/views/layouts/maintenance_tasks/_navbar.html.erb
 - app/views/layouts/maintenance_tasks/application.html.erb
-- app/views/maintenance_tasks/runs/_info.html.erb
+- app/views/maintenance_tasks/runs/_arguments.html.erb
+- app/views/maintenance_tasks/runs/_csv.html.erb
 - app/views/maintenance_tasks/runs/_run.html.erb
 - app/views/maintenance_tasks/runs/info/_cancelled.html.erb
 - app/views/maintenance_tasks/runs/info/_cancelling.html.erb
+- app/views/maintenance_tasks/runs/info/_custom.html.erb
 - app/views/maintenance_tasks/runs/info/_enqueued.html.erb
 - app/views/maintenance_tasks/runs/info/_errored.html.erb
 - app/views/maintenance_tasks/runs/info/_interrupted.html.erb
@@ -119,6 +123,7 @@ files:
 - app/views/maintenance_tasks/runs/info/_pausing.html.erb
 - app/views/maintenance_tasks/runs/info/_running.html.erb
 - app/views/maintenance_tasks/runs/info/_succeeded.html.erb
+- app/views/maintenance_tasks/tasks/_custom.html.erb
 - app/views/maintenance_tasks/tasks/_task.html.erb
 - app/views/maintenance_tasks/tasks/index.html.erb
 - app/views/maintenance_tasks/tasks/show.html.erb
@@ -126,10 +131,13 @@ files:
 - db/migrate/20201211151756_create_maintenance_tasks_runs.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
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
 - lib/generators/maintenance_tasks/templates/csv_task.rb.tt
+- lib/generators/maintenance_tasks/templates/no_collection_task.rb.tt
+- lib/generators/maintenance_tasks/templates/no_collection_task_test.rb.tt
 - lib/generators/maintenance_tasks/templates/task.rb.tt
 - lib/generators/maintenance_tasks/templates/task_spec.rb.tt
 - lib/generators/maintenance_tasks/templates/task_test.rb.tt
@@ -142,7 +150,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.4.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.8.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -159,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks

data/app/models/maintenance_tasks/csv_collection.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "csv"
-
-module MaintenanceTasks
-  # Module that is included into Task classes by Task.csv_collection for
-  # processing CSV files.
-  #
-  # @api private
-  module CsvCollection
-    # The contents of a CSV file to be processed by a Task.
-    #
-    # @return [String] the content of the CSV file to process.
-    attr_accessor :csv_content
-
-    # Defines the collection to be iterated over, based on the provided CSV.
-    #
-    # @return [CSV] the CSV object constructed from the specified CSV content,
-    #   with headers.
-    def collection
-      CSV.new(csv_content, headers: true)
-    end
-
-    # The number of rows to be processed. Excludes the header row from the count
-    # and assumed a trailing new line in the CSV file. Note that this number is
-    # an approximation based on the number of new lines.
-    #
-    # @return [Integer] the approximate number of rows to process.
-    def count
-      csv_content.count("\n") - 1
-    end
-  end
-end