maintenance_tasks 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d591c21fb76efef72185bf183b0f4b0bc0a5b97a2606e083f6fbfc11325e029b
-  data.tar.gz: 6195855524490ebc663f1970134b6aed2abe7887345b6c17d2d0dccea9d81fb4
+  metadata.gz: 3e274988d4a5facd653134ab4d4f2c51a71957ad8b2e6e1e16958f3726d50bb1
+  data.tar.gz: beae97f203e12ed5017b9a76e1ced6b8d9f3e9e8ca8bc65a85a63d781d150bcf
 SHA512:
-  metadata.gz: 3fa1e498d50830521cabeb8babda612a9762438cd1fdccf5cecf776ae069ec85cdbaedbded208bdfc1e72479b69ffb76a39b999e4c2f8d810811dc8672f0b5cc
-  data.tar.gz: 2d9aa8e0c134baa3864f2cd5e9fe53944a5d13a89c21caab26dcd394b3eb8845af62397f2d1be880c9f27d71cbe77db3865d16c7da53f0b70cc64cc7bf4153a4
+  metadata.gz: 67ed786c6c0281422ef4a10af1167c129cbab7422624656c3cae3eb3fe8f35bc5df00f874f2aee2a1eacf54fe957faccd5a4df12240e3f461b81817cdd5347a7
+  data.tar.gz: 3cf190c896f046accf647b74e6acb58680b9e7eb89d25ea58e1a58e2db48e5437c5a410f2536c440c494efc599ea635a0380fc6a554ae157b53b402efbda4211

data/README.md

@@ -3,11 +3,16 @@
 A Rails engine for queuing and managing maintenance tasks.
 
 ## Table of Contents
+
+* [Demo](#demo)
 * [Installation](#installation)
+  * [Active Job Dependency](#active-job-dependency)
 * [Usage](#usage)
   * [Creating a Task](#creating-a-task)
-    * [Considerations when writing Tasks](#considerations-when-writing-tasks)
+  * [Creating a CSV Task](#creating-a-csv-task)
+  * [Considerations when writing Tasks](#considerations-when-writing-tasks)
   * [Writing tests for a Task](#writing-tests-for-a-task)
+  * [Writing tests for a CSV Task](#writing-tests-for-a-csv-task)
   * [Running a Task](#running-a-task)
   * [Monitoring your Task's status](#monitoring-your-tasks-status)
   * [How Maintenance Tasks runs a Task](#how-maintenance-tasks-runs-a-task)
@@ -21,18 +26,18 @@ A Rails engine for queuing and managing maintenance tasks.
 * [Contributing](#contributing)
 * [Releasing new versions](#releasing-new-versions)
 
-## Installation
+## Demo
 
-Add this line to your application's Gemfile:
+Watch this demo video to see the gem in action:
 
-```ruby
-gem 'maintenance_tasks'
-```
+[![Link to demo video](static/demo.png)](https://www.youtube.com/watch?v=BTuvTQxlFzs)
 
-And then execute:
+## Installation
+
+To install the gem and run the install generator, execute:
 
 ```bash
-$ bundle
+$ bundle add maintenance_tasks
 $ rails generate maintenance_tasks:install
 ```
 
@@ -40,6 +45,22 @@ The generator creates and runs a migration to add the necessary table to your
 database. It also mounts Maintenance Tasks in your `config/routes.rb`. By
 default the web UI can be accessed in the new `/maintenance_tasks` path.
 
+In case you use an exception reporting service (e.g. Bugsnag) you might want to
+define an error handler. See [Customizing the error
+handler](#customizing-the-error-handler) for more information.
+
+### Active Job Dependency
+
+The Maintenance Tasks framework relies on ActiveJob behind the scenes to run
+Tasks. The default queuing backend for ActiveJob is
+[asynchronous][async-adapter]. It is **strongly recommended** to change this to
+a persistent backend so that Task progress is not lost during code or
+infrastructure changes. For more information on configuring a queuing backend,
+take a look at the [ActiveJob documentation][active-job-docs].
+
+[async-adapter]: https://api.rubyonrails.org/classes/ActiveJob/QueueAdapters/AsyncAdapter.html
+[active-job-docs]: https://guides.rubyonrails.org/active_job_basics.html#setting-the-backend
+
 ## Usage
 
 ### Creating a Task
@@ -81,7 +102,45 @@ module Maintenance
 end
 ```
 
-#### Considerations when writing Tasks
+### Creating a CSV Task
+
+You can also write a Task that iterates on a CSV file. Note that writing CSV
+Tasks **requires ActiveStorage to be configured**. Ensure that the dependency
+is specified in your application's Gemfile, and that you've followed the
+[setup instuctions][setup].
+
+[setup]: https://edgeguides.rubyonrails.org/active_storage_overview.html#setup
+
+Generate a CSV Task by running:
+
+```bash
+$ rails generate maintenance_tasks:task import_posts --csv
+```
+
+The generated task is a subclass of `MaintenanceTasks::Task` that implements:
+
+* `process`: do the work of your maintenance task on a `CSV::Row`
+
+```ruby
+# app/tasks/maintenance/import_posts_task.rb
+module Maintenance
+  class ImportPostsTask < MaintenanceTasks::Task
+    csv_collection
+
+    def process(row)
+      Post.create!(title: row["title"], content: row["content"])
+    end
+  end
+end
+```
+
+```csv
+# posts.csv
+title,content
+My Title,Hello World!
+```
+
+### Considerations when writing Tasks
 
 MaintenanceTasks relies on the queue adapter configured for your application to
 run the job which is processing your Task. The guidelines for writing Task may
@@ -120,7 +179,7 @@ module Maintenance
     test "#process performs a task iteration" do
       post = Post.new
 
-      Maintenance::UpdatePostsTask.new.process(post)
+      Maintenance::UpdatePostsTask.process(post)
 
       assert_equal 'New content!', post.content
     end
@@ -128,6 +187,32 @@ module Maintenance
 end
 ```
 
+### Writing tests for a CSV Task
+
+You should write tests for your `#process` method in a CSV Task as well. It
+takes a `CSV::Row` as an argument. You can pass a row, or a hash with string
+keys to `#process` from your test.
+
+```ruby
+# app/tasks/maintenance/import_posts_task_test.rb
+module Maintenance
+  class ImportPostsTaskTest < ActiveSupport::TestCase
+    test "#process performs a task iteration" do
+      assert_difference -> { Post.count } do
+        Maintenance::UpdatePostsTask.process({
+          'title' => 'My Title',
+          'content' => 'Hello World!',
+        })
+      end
+
+      post = Post.last
+      assert_equal 'My Title', post.title
+      assert_equal 'Hello World!', post.content
+    end
+  end
+end
+```
+
 ### Running a Task
 
 You can run your new Task by accessing the Web UI and clicking on "Run".
@@ -138,11 +223,26 @@ Alternatively, you can run your Task in the command line:
 $ bundle exec maintenance_tasks perform Maintenance::UpdatePostsTask
 ```
 
-You can also run a Task in Ruby by sending `run` with a Task name to a Runner
-instance:
+To run a Task that processes CSVs from the command line, use the --csv option:
+
+```bash
+$ bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv 'path/to/my_csv.csv'
+```
+
+You can also run a Task in Ruby by sending `run` with a Task name to Runner:
 
 ```ruby
-MaintenanceTasks::Runner.new.run('Maintenance::UpdatePostsTask')
+MaintenanceTasks::Runner.run(name: 'Maintenance::UpdatePostsTask')
+```
+
+To run a Task that processes CSVs using the Runner, provide a Hash containing an
+open IO object and a filename to `run`:
+
+```ruby
+MaintenanceTasks::Runner.run(
+  name: 'Maintenance::ImportPostsTask'
+  csv_file: { io: File.open('path/to/my_csv.csv'), filename: 'my_csv.csv' }
+)
 ```
 
 ### Monitoring your Task's status
@@ -224,17 +324,36 @@ be placed in a `maintenance_tasks.rb` initializer.
 Exceptions raised while a Task is performing are rescued and information about
 the error is persisted and visible in the UI.
 
-If your application uses Bugsnag to monitor errors, the gem will automatically
-notify Bugsnag of any errors raised while a Task is performing.
-
-If you want to integrate with another exception monitoring service or customize
-error handling, a callback can be defined:
+If you want to integrate with an exception monitoring service (e.g. Bugsnag),
+you can define an error handler:
 
 ```ruby
 # config/initializers/maintenance_tasks.rb
-MaintenanceTasks.error_handler = ->(error) { MyErrorMonitor.notify(error) }
+MaintenanceTasks.error_handler = ->(error, task_context, _errored_element) do
+  Bugsnag.notify(error) do |notification|
+    notification.add_tab(:task, task_context)
+  end
+end
 ```
 
+The error handler should be a lambda that accepts three arguments:
+
+* `error`: The object containing the exception that was raised.
+* `task_context`: A hash with additional information about the Task and the
+  error:
+  * `task_name`: The name of the Task that errored
+  * `started_at`: The time the Task started
+  * `ended_at`: The time the Task errored
+* `errored_element`: The element, if any, that was being processed when the
+  Task raised an exception. If you would like to pass this object to your
+  exception monitoring service, make sure you **sanitize the object** to avoid
+  leaking sensitive data and **convert it to a format** that is compatible with
+  your bug tracker. For example, Bugsnag only sends the id and class name of
+  ActiveRecord objects in order to protect sensitive data. CSV rows, on the
+  other hand, are converted to strings and passed raw to Bugsnag, so make sure
+  to filter any personal data from these objects before adding them to a
+  report.
+
 #### Customizing the maintenance tasks module
 
 `MaintenanceTasks.tasks_module` can be configured to define the module in which
@@ -302,8 +421,6 @@ pull requests. You can find the contribution guidelines on
 
 ## Releasing new versions
 
-This gem is published to packagecloud. The procedure to publish a new version:
-
 * Update `spec.version` in `maintenance_tasks.gemspec`.
 * Run `bundle install` to bump the `Gemfile.lock` version of the gem.
 * Open a PR and merge on approval.

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -6,17 +6,7 @@ module MaintenanceTasks
   #
   # @api private
   class RunsController < ApplicationController
-    before_action :set_run, except: :index
-
-    # Shows a full list of Runs.
-    def index
-      query = Run.all.order(id: :desc)
-      if params[:task_name].present?
-        task_name = Run.sanitize_sql_like(params[:task_name])
-        query = query.where('task_name LIKE ?', "%#{task_name}%")
-      end
-      @pagy, @runs = pagy(query)
-    end
+    before_action :set_run
 
     # Updates a Run status to paused.
     def pause

data/app/controllers/maintenance_tasks/tasks_controller.rb

@@ -7,7 +7,7 @@ module MaintenanceTasks
   #
   # @api private
   class TasksController < ApplicationController
-    before_action :set_refresh, only: [:index, :show]
+    before_action :set_refresh, only: [:index]
 
     # Renders the maintenance_tasks/tasks page, displaying
     # available tasks to users, grouped by category.
@@ -19,12 +19,16 @@ module MaintenanceTasks
     # Shows running and completed instances of the Task.
     def show
       @task = TaskData.find(params.fetch(:id))
+      set_refresh if @task.last_run&.active?
       @pagy, @previous_runs = pagy(@task.previous_runs)
     end
 
     # Runs a given Task and redirects to the Task page.
     def run
-      task = Runner.new.run(name: params.fetch(:id))
+      task = Runner.run(
+        name: params.fetch(:id),
+        csv_file: params[:csv_file]
+      )
       redirect_to(task_path(task))
     rescue ActiveRecord::RecordInvalid => error
       redirect_to(task_path(error.record.task_name), alert: error.message)

data/app/helpers/maintenance_tasks/application_helper.rb

@@ -28,40 +28,6 @@ module MaintenanceTasks
         time_ago_in_words(datetime) + ' ago'
       end
     end
-
-    # Fix stylesheet_link_tag to handle integrity when preloading.
-    # To be reverted once fixed upstream in Rails.
-    def stylesheet_link_tag(*sources)
-      return super unless respond_to?(:send_preload_links_header, true)
-      options = sources.extract_options!.stringify_keys
-      path_options = options.extract!('protocol', 'host', 'skip_pipeline')
-        .symbolize_keys
-      preload_links = []
-      crossorigin = options.delete('crossorigin')
-      crossorigin = 'anonymous' if crossorigin == true
-      nopush = options['nopush'].nil? ? true : options.delete('nopush')
-      integrity = options['integrity']
-
-      sources_tags = sources.uniq.map do |source|
-        href = path_to_stylesheet(source, path_options)
-        preload_link = "<#{href}>; rel=preload; as=style"
-        preload_link += "; crossorigin=#{crossorigin}" unless crossorigin.nil?
-        preload_link += "; integrity=#{integrity}" unless integrity.nil?
-        preload_link += '; nopush' if nopush
-        preload_links << preload_link
-        tag_options = {
-          'rel' => 'stylesheet',
-          'media' => 'screen',
-          'crossorigin' => crossorigin,
-          'href' => href,
-        }.merge!(options)
-        tag(:link, tag_options)
-      end
-
-      send_preload_links_header(preload_links)
-
-      safe_join(sources_tags)
-    end
   end
   private_constant :ApplicationHelper
 end

data/app/helpers/maintenance_tasks/task_helper.rb

@@ -105,6 +105,14 @@ module MaintenanceTasks
       end
       safe_join(tokens)
     end
+
+    # Returns a download link for a Run's CSV attachment
+    def csv_file_download_path(run)
+      Rails.application.routes.url_helpers.rails_blob_path(
+        run.csv_file,
+        only_path: true
+      )
+    end
   end
   private_constant :TaskHelper
 end

data/app/jobs/maintenance_tasks/task_job.rb

@@ -34,9 +34,11 @@ module MaintenanceTasks
         enumerator_builder.active_record_on_records(collection, cursor: cursor)
       when Array
         enumerator_builder.build_array_enumerator(collection, cursor: cursor)
+      when CSV
+        JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor)
       else
         raise ArgumentError, "#{@task.class.name}#collection must be either "\
-          'an Active Record Relation or an Array.'
+          'an Active Record Relation, Array, or CSV.'
       end
     end
 
@@ -47,14 +49,24 @@ module MaintenanceTasks
     # @param _run [Run] the current Run, passed as an argument by Job Iteration.
     def each_iteration(input, _run)
       throw(:abort, :skip_complete_callbacks) if @run.stopping?
-      @task.process(input)
+      task_iteration(input)
       @ticker.tick
       @run.reload_status
     end
 
+    def task_iteration(input)
+      @task.process(input)
+    rescue => error
+      @errored_element = input
+      raise error
+    end
+
     def before_perform
       @run = arguments.first
       @task = Task.named(@run.task_name).new
+      if @task.respond_to?(:csv_content=)
+        @task.csv_content = @run.csv_file.download
+      end
       @run.job_id = job_id
 
       @run.running! unless @run.stopping?
@@ -90,9 +102,16 @@ module MaintenanceTasks
     end
 
     def on_error(error)
-      @ticker.persist
+      @ticker.persist if defined?(@ticker)
       @run.persist_error(error)
-      MaintenanceTasks.error_handler.call(error)
+
+      task_context = {
+        task_name: @run.task_name,
+        started_at: @run.started_at,
+        ended_at: @run.ended_at,
+      }
+      errored_element = @errored_element if defined?(@errored_element)
+      MaintenanceTasks.error_handler.call(error, task_context, errored_element)
     end
   end
 end

data/app/models/maintenance_tasks/csv_collection.rb

@@ -0,0 +1,34 @@
+# 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
+  private_constant :CsvCollection
+end

data/app/models/maintenance_tasks/run.rb

@@ -33,6 +33,8 @@ module MaintenanceTasks
     validates :task_name, on: :create, inclusion: { in: ->(_) {
       Task.available_tasks.map(&:to_s)
     } }
+    validate :csv_attachment_presence, on: :create
+
     attr_readonly :task_name
 
     serialize :backtrace
@@ -41,6 +43,8 @@ module MaintenanceTasks
 
     validates_with RunStatusValidator, on: :update
 
+    has_one_attached :csv_file
+
     # Sets the run status to enqueued, making sure the transition is validated
     # in case it's already enqueued.
     def enqueued!
@@ -175,6 +179,21 @@ module MaintenanceTasks
     def stuck?
       cancelling? && updated_at <= 5.minutes.ago
     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
+    # should not have an attachment to be valid. The appropriate error is added
+    # if the Run does not meet the above criteria.
+    def csv_attachment_presence
+      if Task.named(task_name) < CsvCollection && !csv_file.attached?
+        errors.add(:csv_file, 'must be attached to CSV Task.')
+      elsif !(Task.named(task_name) < CsvCollection) && csv_file.attached?
+        errors.add(:csv_file, 'should not be attached to non-CSV Task.')
+      end
+    rescue Task::NotFoundError
+      nil
+    end
   end
   private_constant :Run
 end

data/app/models/maintenance_tasks/runner.rb

@@ -2,7 +2,17 @@
 
 module MaintenanceTasks
   # This class is responsible for running a given Task.
-  class Runner
+  module Runner
+    extend self
+
+    # @deprecated Use {Runner} directly instead.
+    def new
+      ActiveSupport::Deprecation.warn(
+        'Use Runner.run instead of Runner.new.run'
+      )
+      self
+    end
+
     # Exception raised when a Task Job couldn't be enqueued.
     class EnqueuingError < StandardError
       # Initializes a Enqueuing Error.
@@ -20,17 +30,22 @@ module MaintenanceTasks
     # Runs a Task.
     #
     # This method creates a Run record for the given Task name and enqueues the
-    # Run.
+    # Run. If a CSV file is provided, it is attached to the Run record.
     #
     # @param name [String] the name of the Task to be run.
+    # @param csv_file [attachable, nil] a CSV file that provides the collection
+    #   for the Task to iterate over when running, in the form of an attachable
+    #   (see https://edgeapi.rubyonrails.org/classes/ActiveStorage/Attached/One.html#method-i-attach).
+    #   Value is nil if the Task does not use CSV iteration.
     #
     # @return [Task] the Task that was run.
     #
     # @raise [EnqueuingError] if an error occurs while enqueuing the Run.
     # @raise [ActiveRecord::RecordInvalid] if validation errors occur while
     #   creating the Run.
-    def run(name:)
+    def run(name:, csv_file: nil)
       run = Run.active.find_by(task_name: name) || Run.new(task_name: name)
+      run.csv_file.attach(csv_file) if csv_file
 
       run.enqueued!
       enqueue(run)
@@ -40,7 +55,7 @@ module MaintenanceTasks
     private
 
     def enqueue(run)
-      unless MaintenanceTasks.job.perform_later(run)
+      unless MaintenanceTasks.job.constantize.perform_later(run)
         raise "The job to perform #{run.task_name} could not be enqueued. "\
           'Enqueuing has been prevented by a callback.'
       end

data/app/models/maintenance_tasks/task_data.rb

@@ -73,7 +73,7 @@ module MaintenanceTasks
     def code
       return if deleted?
       task = Task.named(name)
-      file = task.instance_method(:collection).source_location.first
+      file = task.instance_method(:process).source_location.first
       File.read(file)
     end
 
@@ -127,10 +127,15 @@ module MaintenanceTasks
       end
     end
 
+    # @return [Boolean] whether the Task inherits from CsvTask.
+    def csv_task?
+      !deleted? && Task.named(name) < CsvCollection
+    end
+
     private
 
     def runs
-      Run.where(task_name: name).order(created_at: :desc)
+      Run.where(task_name: name).with_attached_csv_file.order(created_at: :desc)
     end
   end
   private_constant :TaskData

data/app/tasks/maintenance_tasks/task.rb

@@ -30,6 +30,41 @@ module MaintenanceTasks
         descendants
       end
 
+      # Make this Task a task that handles CSV.
+      #
+      # An input to upload a CSV will be added in the form to start a Run. The
+      # collection and count method are implemented.
+      def csv_collection
+        include(CsvCollection)
+      end
+
+      # Processes one item.
+      #
+      # Especially useful for tests.
+      #
+      # @param item the item to process.
+      def process(item)
+        new.process(item)
+      end
+
+      # Returns the collection for this Task.
+      #
+      # Especially useful for tests.
+      #
+      # @return the collection.
+      def collection
+        new.collection
+      end
+
+      # Returns the count of items for this Task.
+      #
+      # Especially useful for tests.
+      #
+      # @return the count of items.
+      def count
+        new.count
+      end
+
       private
 
       def load_constants
@@ -45,8 +80,7 @@ module MaintenanceTasks
     # @raise [NotImplementedError] with a message advising subclasses to
     #   implement an override for this method.
     def collection
-      raise NotImplementedError,
-        "#{self.class.name} must implement `collection`."
+      raise NoMethodError, "#{self.class.name} must implement `collection`."
     end
 
     # Placeholder method to raise in case a subclass fails to implement the
@@ -57,8 +91,7 @@ module MaintenanceTasks
     # @raise [NotImplementedError] with a message advising subclasses to
     #   implement an override for this method.
     def process(_item)
-      raise NotImplementedError,
-        "#{self.class.name} must implement `process`."
+      raise NoMethodError, "#{self.class.name} must implement `process`."
     end
 
     # Total count of iterations to be performed.
@@ -70,14 +103,5 @@ module MaintenanceTasks
     # @return [Integer, nil]
     def count
     end
-
-    # Convenience method to allow tasks define enumerators with cursors for
-    # compatibility with Job Iteration.
-    #
-    # @return [JobIteration::EnumeratorBuilder] instance of an enumerator
-    #   builder available to tasks.
-    def enumerator_builder
-      JobIteration.enumerator_builder.new(nil)
-    end
   end
 end

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -11,7 +11,8 @@ module MaintenanceTasks
       # enqueued -> pausing occurs when the task is paused before starting.
       # enqueued -> cancelling occurs when the task is cancelled
       #   before starting.
-      # enqueued -> errored occurs when the task job fails to be enqueued.
+      # enqueued -> errored occurs when the task job fails to be enqueued, or
+      #   if the Task is deleted before is starts running.
       'enqueued' => ['running', 'pausing', 'cancelling', 'errored'],
       # pausing -> paused occurs when the task actually halts performing and
       #   occupies a status of paused.
@@ -56,7 +57,9 @@ module MaintenanceTasks
       #   it is interrupted.
       # interrupted -> cancelling occurs when the task is cancelled by the user
       #   while it is interrupted.
-      'interrupted' => ['running', 'pausing', 'cancelling'],
+      # interrupted -> errored occurs when the task is deleted while it is
+      #   interrupted.
+      'interrupted' => ['running', 'pausing', 'cancelling', 'errored'],
     }
 
     # Validate whether a transition from one Run status

data/app/views/layouts/maintenance_tasks/_navbar.html.erb

@@ -2,10 +2,4 @@
   <div class="navbar-brand">
     <%= link_to 'Maintenance Tasks', root_path, class: 'navbar-item is-size-4 has-text-weight-semibold has-text-danger' %>
   </div>
-
-  <div id="navbarMenu" class="navbar-menu is-active">
-    <div class="navbar-start">
-      <%= link_to "Runs", runs_path, class: 'navbar-item' %>
-    </div>
-  </div>
 </nav>

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

@@ -1,6 +1,5 @@
 <h5 class="title is-5">
   <%= time_tag run.created_at, title: run.created_at %>
-  <%= status_tag run.status if with_status %>
 </h5>
 
 <%= progress run %>
@@ -8,3 +7,9 @@
 <div class="content">
   <%= render "maintenance_tasks/runs/info/#{run.status}", run: run %>
 </div>
+
+<% if run.csv_file.attached? %>
+  <div class="block">
+    <%= link_to('Download CSV', csv_file_download_path(run)) %>
+  </div>
+<% end %>

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

@@ -1,11 +1,8 @@
 <div class="box">
-  <% if with_task_name %>
-    <h3 class="title is-3">
-      <%= link_to run.task_name, task_path(run.task_name) %>
-      <%= status_tag run.status %>
-    </h3>
-    <%= render 'maintenance_tasks/runs/info', run: run, with_status: false %>
-  <% else %>
-    <%= render 'maintenance_tasks/runs/info', run: run, with_status: true %>
-  <% end %>
+  <h5 class="title is-5">
+    <%= time_tag run.created_at, title: run.created_at %>
+    <%= status_tag run.status %>
+  </h5>
+
+  <%= render 'maintenance_tasks/runs/info', run: run %>
 </div>

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

@@ -7,7 +7,34 @@
 <%= render 'maintenance_tasks/runs/info', run: @task.last_run, with_status: false if @task.last_run %>
 
 <div class="buttons">
-  <%= render "maintenance_tasks/tasks/actions/#{@task.status}", task: @task %>
+  <% 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? %>
+        <div class="block">
+          <%= form.label :csv_file %>
+          <%= form.file_field :csv_file %>
+        </div>
+      <% end %>
+      <div class="block">
+        <%= form.submit 'Run', class: "button is-success", disabled: @task.deleted? %>
+      </div>
+    <% end %>
+  <% elsif last_run.cancelling? %>
+    <%= button_to 'Run', run_task_path(@task), method: :put, class: 'button is-success', disabled: true %>
+    <% if last_run.stuck? %>
+      <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger', disabled: @task.deleted? %>
+    <% end %>
+  <% elsif last_run.pausing? %>
+    <%= button_to 'Pausing', pause_task_run_path(@task, last_run), method: :put, class: 'button is-warning', disabled: true %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% elsif last_run.paused? %>
+    <%= button_to 'Resume', run_task_path(@task), method: :put, class: 'button is-primary', disabled: @task.deleted? %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% else %>
+    <%= button_to 'Pause', pause_task_run_path(@task, last_run), method: :put, class: 'button is-warning', disabled: @task.deleted? %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% end%>
 </div>
 
 <% if (code = @task.code) %>
@@ -19,7 +46,7 @@
 
   <h4 class="title is-4">Previous Runs</h4>
 
-  <%= render @previous_runs, with_task_name: false %>
+  <%= render @previous_runs %>
 
   <%= pagination(@pagy) %>
 <% end %>

data/config/routes.rb

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

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -9,6 +9,9 @@ module MaintenanceTasks
     desc 'This generator creates a task file at app/tasks and a corresponding '\
       'test.'
 
+    class_option :csv, type: :boolean, default: false,
+      desc: 'Generate a CSV Task.'
+
     check_class_collision suffix: 'Task'
 
     # Creates the Task file.
@@ -18,7 +21,11 @@ module MaintenanceTasks
         class_path,
         "#{file_name}_task.rb"
       )
-      template('task.rb', template_file)
+      if options[:csv]
+        template('csv_task.rb', template_file)
+      else
+        template('task.rb', template_file)
+      end
     end
 
     # Creates the Task test file, according to the app's test framework.

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

@@ -21,7 +21,7 @@ module MaintenanceTasks
   # `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 +32,23 @@ 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
+  # 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

@@ -24,17 +24,32 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -110,6 +110,7 @@ files:
 - app/helpers/maintenance_tasks/task_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
@@ -121,7 +122,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,16 +132,6 @@ 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
@@ -149,21 +139,21 @@ files:
 - 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.1.0
   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.1.0. 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) }