maintenance_tasks 1.0.0 → 1.2.1

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module <%= tasks_module %>
+<% module_namespacing do -%>
+  class <%= class_name %>Task < MaintenanceTasks::Task
+    csv_collection
+
+    def process(row)
+      # The work to be done on a row of the CSV
+    end
+  end
+<% end -%>
+end

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

@@ -6,7 +6,7 @@ module <%= tasks_module %>
   RSpec.describe <%= class_name %>Task do
     # describe '#process' do
       # it 'performs a task iteration' do
-        # <%= tasks_module %>::<%= class_name %>Task.new.process(element)
+        # <%= tasks_module %>::<%= class_name %>Task.process(element)
       # end
     # end
   end

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

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

data/lib/maintenance_tasks.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
-require 'action_controller'
-require 'action_view'
-require 'active_job'
-require 'active_record'
+require "action_controller"
+require "action_view"
+require "active_job"
+require "active_record"
 
-require 'job-iteration'
-require 'maintenance_tasks/engine'
-require 'pagy'
-require 'pagy/extras/bulma'
+require "job-iteration"
+require "maintenance_tasks/engine"
+
+# Force the TaskJob class to load so we can verify upstream compatibility with
+# the JobIteration gem
+require_relative "../app/jobs/maintenance_tasks/task_job"
 
 # The engine's namespace module. It provides isolation between the host
 # application's code and the engine-specific code. Top-level engine constants
@@ -15,13 +17,13 @@ require 'pagy/extras/bulma'
 module MaintenanceTasks
   # The module to namespace Tasks in, as a String. Defaults to 'Maintenance'.
   # @param [String] the tasks_module value.
-  mattr_accessor :tasks_module, default: 'Maintenance'
+  mattr_accessor :tasks_module, default: "Maintenance"
 
   # Defines the job to be used to perform Tasks. This job must be either
   # `MaintenanceTasks::TaskJob` or a class that inherits from it.
   #
   # @param [String] the name of the job class.
-  mattr_writer :job, default: 'MaintenanceTasks::TaskJob'
+  mattr_accessor :job, default: "MaintenanceTasks::TaskJob"
 
   # After each iteration, the progress of the task may be updated. This duration
   # in seconds limits these updates, skipping if the duration since the last
@@ -32,27 +34,29 @@ module MaintenanceTasks
   #   the ticker during Task iterations.
   mattr_accessor :ticker_delay, default: 1.second
 
-  # Defines a callback to be performed when an error occurs in the task.
-  mattr_accessor :error_handler, default: ->(_error) {}
-
-  class << self
-    # Retrieves the class that is configured as the Task Job to be used to
-    # perform Tasks.
-    #
-    # @return [TaskJob] the job class.
-    def job
-      @@job.constantize
-    end
+  # Specifies which Active Storage service to use for uploading CSV file blobs.
+  #
+  # @param [Symbol] the key for the storage service, as specified in the app's
+  #   config/storage.yml.
+  mattr_accessor :active_storage_service
+
+  # Retrieves the callback to be performed when an error occurs in the task.
+  def self.error_handler
+    return @error_handler if defined?(@error_handler)
+    @error_handler = ->(_error, _task_context, _errored_element) {}
+  end
 
-    # Attempts to configure Bugsnag integration. If the application uses
-    # Bugsnag, it is automatically configured to report on errors raised while
-    # a Task is performing.
-    def configure_bugsnag_integration
-      load('maintenance_tasks/integrations/bugsnag_handler.rb')
-    rescue LoadError
-      nil
+  # Defines a callback to be performed when an error occurs in the task.
+  def self.error_handler=(error_handler)
+    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."
+      )
+      @error_handler = ->(error, _task_context, _errored_element) do
+        error_handler.call(error)
+      end
     end
+    @error_handler = error_handler
   end
 end
-
-MaintenanceTasks.configure_bugsnag_integration

data/lib/maintenance_tasks/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module MaintenanceTasks
   # Defines the command line interface commands exposed by Maintenance Tasks in
@@ -13,7 +13,7 @@ module MaintenanceTasks
       end
     end
 
-    desc 'perform [TASK NAME]', 'Runs the given Maintenance Task'
+    desc "perform [TASK NAME]", "Runs the given Maintenance Task"
 
     long_desc <<-LONGDESC
       `maintenance_tasks perform` will run the Maintenance Task specified by the
@@ -24,17 +24,31 @@ module MaintenanceTasks
       #{MaintenanceTasks::Task.available_tasks.join("\n\n")}
     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"'
+
     # Command to run a Task.
     #
     # It instantiates a Runner and sends a run message with the given Task name.
+    # If a CSV file is supplied using the --csv option, an attachable with the
+    # File IO object is sent along with the Task name to run.
     #
     # @param name [String] the name of the Task to be run.
     def perform(name)
-      task = Runner.new.run(name: name)
+      task = Runner.run(name: name, csv_file: csv_file)
       say_status(:success, "#{task.name} was enqueued.", :green)
     rescue => error
       say_status(:error, error.message, :red)
     end
+
+    private
+
+    def csv_file
+      csv_option = options[:csv]
+      if csv_option
+        { io: File.open(csv_option), filename: File.basename(csv_option) }
+      end
+    end
   end
-  private_constant :CLI
 end

data/lib/maintenance_tasks/engine.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'active_record/railtie'
+require "active_record/railtie"
 
 module MaintenanceTasks
   # The engine's main class, which defines its namespace. The engine is mounted
@@ -7,6 +7,10 @@ module MaintenanceTasks
   class Engine < ::Rails::Engine
     isolate_namespace MaintenanceTasks
 
+    initializer "eager_load_for_classic_autoloader" do
+      eager_load! unless Rails.autoloaders.zeitwerk_enabled?
+    end
+
     config.to_prepare do
       unless Rails.autoloaders.zeitwerk_enabled?
         tasks_module = MaintenanceTasks.tasks_module.underscore
@@ -17,12 +21,11 @@ module MaintenanceTasks
     end
 
     config.after_initialize do
-      eager_load! unless Rails.autoloaders.zeitwerk_enabled?
       JobIteration.max_job_runtime ||= 5.minutes
     end
 
     config.action_dispatch.rescue_responses.merge!(
-      'MaintenanceTasks::Task::NotFoundError' => :not_found,
+      "MaintenanceTasks::Task::NotFoundError" => :not_found,
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -107,12 +93,14 @@ files:
 - app/controllers/maintenance_tasks/runs_controller.rb
 - app/controllers/maintenance_tasks/tasks_controller.rb
 - app/helpers/maintenance_tasks/application_helper.rb
-- app/helpers/maintenance_tasks/task_helper.rb
+- app/helpers/maintenance_tasks/tasks_helper.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/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_data.rb
 - app/models/maintenance_tasks/ticker.rb
 - app/tasks/maintenance_tasks/task.rb
@@ -121,7 +109,6 @@ files:
 - app/views/layouts/maintenance_tasks/application.html.erb
 - app/views/maintenance_tasks/runs/_info.html.erb
 - app/views/maintenance_tasks/runs/_run.html.erb
-- app/views/maintenance_tasks/runs/index.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/_enqueued.html.erb
@@ -132,38 +119,29 @@ files:
 - app/views/maintenance_tasks/runs/info/_running.html.erb
 - app/views/maintenance_tasks/runs/info/_succeeded.html.erb
 - app/views/maintenance_tasks/tasks/_task.html.erb
-- app/views/maintenance_tasks/tasks/actions/_cancelled.html.erb
-- app/views/maintenance_tasks/tasks/actions/_cancelling.html.erb
-- app/views/maintenance_tasks/tasks/actions/_enqueued.html.erb
-- app/views/maintenance_tasks/tasks/actions/_errored.html.erb
-- app/views/maintenance_tasks/tasks/actions/_interrupted.html.erb
-- app/views/maintenance_tasks/tasks/actions/_new.html.erb
-- app/views/maintenance_tasks/tasks/actions/_paused.html.erb
-- app/views/maintenance_tasks/tasks/actions/_pausing.html.erb
-- app/views/maintenance_tasks/tasks/actions/_running.html.erb
-- app/views/maintenance_tasks/tasks/actions/_succeeded.html.erb
 - app/views/maintenance_tasks/tasks/index.html.erb
 - app/views/maintenance_tasks/tasks/show.html.erb
 - config/routes.rb
 - db/migrate/20201211151756_create_maintenance_tasks_runs.rb
+- db/migrate/20210225152418_remove_index_on_task_name.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/task.rb.tt
 - lib/generators/maintenance_tasks/templates/task_spec.rb.tt
 - lib/generators/maintenance_tasks/templates/task_test.rb.tt
 - lib/maintenance_tasks.rb
 - lib/maintenance_tasks/cli.rb
 - lib/maintenance_tasks/engine.rb
-- lib/maintenance_tasks/integrations/bugsnag_handler.rb
 - lib/tasks/maintenance_tasks_tasks.rake
 homepage: https://github.com/Shopify/maintenance_tasks
 licenses: []
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.0.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.2.1
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.0.0. To complete, please run:
+  Thank you for installing Maintenance Tasks 1.2.1. To complete, please run:
 
   rails generate maintenance_tasks:install
 rdoc_options: []

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

@@ -1,15 +0,0 @@
-<div class="block">
-  <%= form_with url: runs_path, method: :get do |form| %>
-    <div class="field has-addons">
-      <div class="control">
-        <%= form.search_field :task_name, value: params[:task_name], placeholder: "Task name", class: "input" %>
-      </div>
-      <div class="control">
-        <%= form.submit "Search", class: "button is-link" %>
-      </div>
-    </div>
-  <% end %>
-</div>
-
-<%= render @runs, with_task_name: true %>
-<%= pagination(@pagy) %>

data/app/views/maintenance_tasks/tasks/actions/_cancelled.html.erb

@@ -1 +0,0 @@
-<%= button_to 'Run', run_task_path(task), method: :put, class: 'button is-success', disabled: task.deleted? %>

data/app/views/maintenance_tasks/tasks/actions/_cancelling.html.erb

@@ -1,4 +0,0 @@
-<%= button_to 'Run', run_task_path(task), method: :put, class: 'button is-success', disabled: true %>
-<% if task.last_run.stuck? %>
-  <%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger', disabled: task.deleted? %>
-<% end %>

data/app/views/maintenance_tasks/tasks/actions/_enqueued.html.erb

@@ -1,2 +0,0 @@
-<%= button_to 'Pause', pause_task_run_path(task, task.last_run), method: :put, class: 'button is-warning', disabled: task.deleted? %>
-<%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger' %>

data/app/views/maintenance_tasks/tasks/actions/_errored.html.erb

@@ -1 +0,0 @@
-<%= button_to 'Run', run_task_path(task), method: :put, class: 'button is-success', disabled: task.deleted? %>

data/app/views/maintenance_tasks/tasks/actions/_interrupted.html.erb

@@ -1,2 +0,0 @@
-<%= button_to 'Pause', pause_task_run_path(task, task.last_run), method: :put, class: 'button is-warning', disabled: task.deleted? %>
-<%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger' %>

data/app/views/maintenance_tasks/tasks/actions/_new.html.erb

@@ -1 +0,0 @@
-<%= button_to 'Run', run_task_path(task), method: :put, class: 'button is-success', disabled: task.deleted? %>

data/app/views/maintenance_tasks/tasks/actions/_paused.html.erb

@@ -1,2 +0,0 @@
-<%= button_to 'Resume', run_task_path(task), method: :put, class: 'button is-primary', disabled: task.deleted? %>
-<%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger' %>

data/app/views/maintenance_tasks/tasks/actions/_pausing.html.erb

@@ -1,2 +0,0 @@
-<%= button_to 'Pausing', pause_task_run_path(task, task.last_run), method: :put, class: 'button is-warning', disabled: true %>
-<%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger', disabled: task.deleted? %>

data/app/views/maintenance_tasks/tasks/actions/_running.html.erb

@@ -1,2 +0,0 @@
-<%= button_to 'Pause', pause_task_run_path(task, task.last_run), method: :put, class: 'button is-warning', disabled: task.deleted? %>
-<%= button_to 'Cancel', cancel_task_run_path(task, task.last_run), method: :put, class: 'button is-danger' %>

data/app/views/maintenance_tasks/tasks/actions/_succeeded.html.erb

@@ -1 +0,0 @@
-<%= button_to 'Run', run_task_path(task), method: :put, class: 'button is-success', disabled: task.deleted? %>

data/lib/maintenance_tasks/integrations/bugsnag_handler.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-require 'bugsnag'
-
-MaintenanceTasks.error_handler = ->(error) { Bugsnag.notify(error) }