maintenance_tasks 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3c4c94cf355432e0d558e68bfc3f275972164c8ed932d2505b7c6450f0d124
-  data.tar.gz: 1b80ad4b58b9546d5ab2af77d2d0e64f8bd8b72dc6641ff445d33a67dae03860
+  metadata.gz: 8c13ec8d79682d304378d636955e9726cd1d67ebb167a549a2d6479f7eea6712
+  data.tar.gz: bf7026b08f0f442c3c074118dfca1cbae4babd7d234b97dc63cf66cdf94db67b
 SHA512:
-  metadata.gz: 7402e24bfbc370c6af54b441d2b1050f252ee44f51ab11612875fed7fa6822645420422dc33405b1665596e66f85f8fe1f8b1e443d023d451a626913afe6dc98
-  data.tar.gz: 8f4666aba4abc6f01d77b238de6b6d511d24a5d4932f5ec2499f0e91faefe2e8a3b18435109864c821495b2efde464dd3212a76eae5276b4e622eb1cb6f7da3c
+  metadata.gz: 3b41ee8a4ccaf28d590d7acd2a81fd5123dd3e81b552454082313d3a183b5840eb3ff130ab6c0a40c3e05112899680cee03bbec74c39e11bf0f91dff9955edb1
+  data.tar.gz: 42321e823247c83d58ead579070a5b007c7c0089601c7bcf587af311be715eb791102b94c2fdff513010816977c4c318297bb9f946726b3bd08066bc0ce295b2

data/README.md

@@ -537,6 +537,23 @@ MaintenanceTasks.active_storage_service = :internal
 There is no need to configure this option if your application uses only one
 storage service per environment.
 
+#### Customizing the backtrace cleaner
+
+`MaintenanceTasks.backtrace_cleaner` can be configured to specify a backtrace
+cleaner to use when a Task errors and the backtrace is cleaned and persisted.
+An `ActiveSupport::BacktraceCleaner` should be used.
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+cleaner = ActiveSupport::BacktraceCleaner.new
+cleaner.add_silencer { |line| line =~ /ignore_this_dir/ }
+
+MaintenanceTasks.backtrace_cleaner = cleaner
+```
+
+If none is specified, the default `Rails.backtrace_cleaner` will be used to
+clean backtraces.
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new
@@ -548,6 +565,16 @@ $ bin/rails generate maintenance_tasks:install
 
 This ensures that new migrations are installed and run as well.
 
+**What if I've deleted my previous Maintenance Task migrations?**
+
+The install command will attempt to reinstall these old migrations and migrating
+the database will cause problems. Use `bin/rails generate maintenance_tasks:install:migrations`
+to copy the gem's migrations to your `db/migrate` folder. Check the release
+notes to see if any new migrations were added since your last gem upgrade.
+Ensure that these are kept, but remove any migrations that already ran.
+
+Run the migrations using `bin/rails db:migrate`.
+
 ## Contributing
 
 Would you like to report an issue or contribute with code? We accept issues and
@@ -564,6 +591,7 @@ are merged.
 Once a release is ready, follow these steps:
 
 * 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.
 * Deploy via [Shipit][shipit] and see the new version on
   <https://rubygems.org/gems/maintenance_tasks>.

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

@@ -93,7 +93,6 @@ module MaintenanceTasks
       if @task.respond_to?(:csv_content=)
         @task.csv_content = @run.csv_file.download
       end
-      @run.job_id = job_id
 
       @run.running! unless @run.stopping?
 

data/app/models/maintenance_tasks/run.rb

@@ -27,6 +27,7 @@ module MaintenanceTasks
     ]
     COMPLETED_STATUSES = [:succeeded, :errored, :cancelled]
     COMPLETED_RUNS_LIMIT = 10
+    STUCK_TASK_TIMEOUT = 5.minutes
 
     enum status: STATUSES.to_h { |status| [status, status.to_s] }
 
@@ -90,7 +91,7 @@ module MaintenanceTasks
         status: :errored,
         error_class: error.class.to_s,
         error_message: error.message,
-        backtrace: Rails.backtrace_cleaner.clean(error.backtrace),
+        backtrace: MaintenanceTasks.backtrace_cleaner.clean(error.backtrace),
         ended_at: Time.now,
       )
     end
@@ -190,7 +191,7 @@ module MaintenanceTasks
     #
     # @return [Boolean] whether the Run is stuck.
     def stuck?
-      cancelling? && updated_at <= 5.minutes.ago
+      cancelling? && updated_at <= STUCK_TASK_TIMEOUT.ago
     end
 
     # Performs validation on the presence of a :csv_file attachment.

data/app/models/maintenance_tasks/runner.rb

@@ -51,17 +51,18 @@ module MaintenanceTasks
       run = Run.active.find_by(task_name: name) ||
         Run.new(task_name: name, arguments: arguments)
       run.csv_file.attach(csv_file) if csv_file
-
-      run.enqueued!
-      enqueue(run)
+      job = MaintenanceTasks.job.constantize.new(run)
+      run.job_id = job.job_id
       yield run if block_given?
+      run.enqueued!
+      enqueue(run, job)
       Task.named(name)
     end
 
     private
 
-    def enqueue(run)
-      unless MaintenanceTasks.job.constantize.perform_later(run)
+    def enqueue(run, job)
+      unless job.enqueue
         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

@@ -40,7 +40,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)
         )
 

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -48,9 +48,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,16 @@
 <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>
+
+  <%= 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,19 @@
     <%= 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>
+
+    <%= 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,25 @@
   <%= @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>
+
+  <%= 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? %>
@@ -20,8 +35,12 @@
         <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" %>
+              <div class="field">
+                <%= ff.label parameter, parameter, class: "label is-family-monospace" %>
+                <div class="control">
+                  <%= ff.text_area parameter, class: "textarea" %>
+                </div>
+              </div>
             <% end %>
           <% end %>
         </div>

data/lib/maintenance_tasks.rb

@@ -52,6 +52,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)

data/lib/maintenance_tasks/engine.rb

@@ -11,6 +11,10 @@ module MaintenanceTasks
       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?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -108,7 +108,8 @@ files:
 - 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
@@ -142,7 +143,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.5.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -159,7 +160,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/views/maintenance_tasks/runs/_info.html.erb

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