maintenance_tasks 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dcb5b54d6f3fd47db28a3f57a487c201e2109b3eb8f78efbe3c972a374999e8
-  data.tar.gz: eeb95960a0cac8de08aa3af7d12d47f6cfbee4d875ab74f8989f4d17ef545f6c
+  metadata.gz: 04c33ddef00ee39487f42a7275fd3b11367bc16f32007a607e2d6fd7a9b3b55d
+  data.tar.gz: 841a336d86ce65e52d2ddee9cef746f9a448664328213056ea8c7a9f0d861b76
 SHA512:
-  metadata.gz: e99ebde772755c6f3d88d48e65df883805b2ceb4798334f00175bc8e4c83d093bef79931bf0c0c86b303c3d94d2e0b44b3b506b1813ea6e01597ccf47f2c8182
-  data.tar.gz: 58d11ad3fa36721e9f29a49cecf586d2f362aaf155667ce6b7702b7acd7bb43f1defa2a2a4ed1fa259d563876b9cec5d5f7b66f4d5dcf43747009e64552fa804
+  metadata.gz: cefc3a619d3d3aec10c6104cf227c33558e1d30146f0d9338706eb30c4e21f58bda704905c85a8faa87bc4735d5255b714c8690b6b733f9dcde42216231abc3d
+  data.tar.gz: 4f23532262622d91da4065926f19e96bb22788877acc10e1e7a0ce327e7136a2c24905e9a29aacbbdbe380c39dc58e593a0254e6bfec2b1c6d929f8e5fe13304

data/README.md

@@ -696,6 +696,26 @@ MaintenanceTasks.tasks_module = "TaskModule"
 
 If no value is specified, it will default to `Maintenance`.
 
+#### Organizing tasks using namespaces
+
+Tasks may be nested arbitrarily deeply under `app/tasks/maintenance`, for example given a
+task file `app/tasks/maintenance/team_name/service_name/update_posts_task.rb` we
+can define the task as:
+
+```ruby
+module Maintenance
+  module TeamName
+    module ServiceName
+      class UpdatePostsTask < MaintenanceTasks::Task
+        def process(rows)
+          # ...
+        end
+      end
+    end
+  end
+end
+```
+
 #### Customizing the underlying job class
 
 `MaintenanceTasks.job` can be configured to define a Job class for your tasks to
@@ -784,6 +804,34 @@ MaintenanceTasks.backtrace_cleaner = cleaner
 If none is specified, the default `Rails.backtrace_cleaner` will be used to
 clean backtraces.
 
+#### Customizing the parent controller for the web UI
+
+`MaintenanceTasks.parent_controller` can be configured to specify a controller class for all of the web UI engine's
+controllers to inherit from.
+
+This allows applications with common logic in their `ApplicationController` (or
+any other controller) to optionally configure the web UI to inherit that logic
+with a simple assignment in the initializer.
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+
+MaintenanceTasks.parent_controller = "Services::CustomController"
+
+# app/controllers/services/custom_controller.rb
+
+class Services::CustomController < ActionController::Base
+  include CustomSecurityThings
+  include CustomLoggingThings
+  ...
+end
+```
+
+The parent controller value **must** be a string corresponding to an existing
+controller class which **must inherit** from `ActionController::Base`.
+
+If no value is specified, it will default to `"ActionController::Base"`.
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -4,7 +4,7 @@ module MaintenanceTasks
   # Base class for all controllers used by this engine.
   #
   # Can be extended to add different authentication and authorization code.
-  class ApplicationController < ActionController::Base
+  class ApplicationController < MaintenanceTasks.parent_controller.constantize
     BULMA_CDN = "https://cdn.jsdelivr.net"
 
     content_security_policy do |policy|
@@ -15,16 +15,11 @@ module MaintenanceTasks
       )
       policy.script_src(
         # page refresh script
-        "'sha256-2RPaBS4XCMLp0JJ/sW407W9l4qjC+WQAHmTOFJTGfqo='",
+        "'sha256-NiHKryHWudRC2IteTqmY9v1VkaDUA/5jhgXkMTkgo2w='",
       )
       policy.frame_ancestors(:self)
     end
 
-    before_action do
-      request.content_security_policy_nonce_generator ||= ->(_request) { SecureRandom.base64(16) }
-      request.content_security_policy_nonce_directives = ["style-src"]
-    end
-
     protect_from_forgery with: :exception
   end
 end

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -20,7 +20,7 @@ module MaintenanceTasks
     rescue ActiveRecord::RecordInvalid => error
       redirect_to(task_path(error.record.task_name), alert: error.message)
     rescue ActiveRecord::ValueTooLong => error
-      task_name = params.fetch(:id)
+      task_name = params.fetch(:task_id)
       redirect_to(task_path(task_name), alert: error.message)
     rescue Runner::EnqueuingError => error
       redirect_to(task_path(error.run.task_name), alert: error.message)

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -109,7 +109,7 @@ module MaintenanceTasks
       when ActiveModel::Type::Decimal, ActiveModel::Type::Float
         form_builder.number_field(parameter_name, { step: "any" })
       when ActiveModel::Type::DateTime
-        form_builder.datetime_field(parameter_name)
+        form_builder.datetime_field(parameter_name) + datetime_field_help_text
       when ActiveModel::Type::Date
         form_builder.date_field(parameter_name)
       when ActiveModel::Type::Time
@@ -120,5 +120,19 @@ module MaintenanceTasks
         form_builder.text_area(parameter_name, class: "textarea")
       end
     end
+
+    # Return helper text for the datetime-local form field.
+    def datetime_field_help_text
+      text =
+        if Time.zone_default.nil? || Time.zone_default.name == "UTC"
+          "Timezone: UTC."
+        else
+          "Timezone: #{Time.now.zone}."
+        end
+      tag.div(
+        tag.p(text),
+        class: "content is-small",
+      )
+    end
   end
 end

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

@@ -56,14 +56,14 @@ module MaintenanceTasks
           batch_size: collection.batch_size,
         )
       when Array
-        enumerator_builder.build_array_enumerator(collection, cursor: cursor)
+        enumerator_builder.build_array_enumerator(collection, cursor: cursor&.to_i)
       when BatchCsvCollectionBuilder::BatchCsv
         JobIteration::CsvEnumerator.new(collection.csv).batches(
           batch_size: collection.batch_size,
-          cursor: cursor,
+          cursor: cursor&.to_i,
         )
       when CSV
-        JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor)
+        JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor&.to_i)
       else
         raise ArgumentError, <<~MSG.squish
           #{@task.class.name}#collection must be either an

data/app/models/maintenance_tasks/run.rb

@@ -32,7 +32,6 @@ module MaintenanceTasks
       :cancelled,
     ]
     COMPLETED_STATUSES = [:succeeded, :errored, :cancelled]
-    COMPLETED_RUNS_LIMIT = 10
     STUCK_TASK_TIMEOUT = 5.minutes
 
     enum status: STATUSES.to_h { |status| [status, status.to_s] }

data/app/models/maintenance_tasks/task.rb

@@ -175,7 +175,13 @@ module MaintenanceTasks
         namespace = MaintenanceTasks.tasks_module.safe_constantize
         return unless namespace
 
-        namespace.constants.map { |constant| namespace.const_get(constant) }
+        load_const = lambda do |root|
+          root.constants.each do |name|
+            object = root.const_get(name)
+            load_const.call(object) if object.instance_of?(Module)
+          end
+        end
+        load_const.call(namespace)
       end
     end
 

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

@@ -33,17 +33,19 @@
 
     <script>
       function refresh() {
-        if (!("refresh" in document.body.dataset)) return
+        const target = document.querySelector("[data-refresh]")
+        if (!target || !target.dataset.refresh) return
         window.setTimeout(() => {
           document.body.style.cursor = "wait"
           fetch(document.location, { headers: { "X-Requested-With": "XMLHttpRequest" } }).then(
             async response => {
               const text = await response.text()
               const newDocument = new DOMParser().parseFromString(text, "text/html")
-              document.body.replaceWith(newDocument.body)
-              <%# force a redraw for Safari %>
-              window.scrollTo({ top: document.documentElement.scrollTop + 1 })
-              window.scrollTo({ top: document.documentElement.scrollTop - 1 })
+              const newTarget = newDocument.querySelector("[data-refresh]")
+              if (newTarget) {
+                target.replaceWith(newTarget)
+              }
+              document.body.style.cursor = ""
               refresh()
             },
             error => location.reload()
@@ -54,7 +56,7 @@
     </script>
   </head>
 
-  <%= tag.body(data: { refresh: defined?(@refresh) && @refresh }) do %>
+  <body>
     <%= render 'layouts/maintenance_tasks/navbar' %>
 
     <section class="section">
@@ -68,5 +70,5 @@
         <%= yield %>
       </div>
     </div>
-  <% end %>
+  </body>
 </html>

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

@@ -9,9 +9,9 @@
             <td>
               <% next if value.empty? %>
               <% if value.include?("\n") %>
-                <pre><%= value %><pre>
+                <pre><%= value %></pre>
               <% else %>
-                <code><%= value %><code>
+                <code><%= value %></code>
               <% end %>
             </td>
           </tr>

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

@@ -1,6 +1,6 @@
 <div class="box">
   <h5 class="title is-5">
-    <%= time_tag run.created_at, title: run.created_at %>
+    <%= time_tag run.created_at, title: run.created_at.utc.iso8601 %>
     <%= status_tag run.status %>
   </h5>
 

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

@@ -1,22 +1,24 @@
-<% if @available_tasks.empty? %>
-  <div class="content is-large">
-    <h3 class="title is-3"> The MaintenanceTasks gem has been successfully installed! </h3>
-    <p>
-      Any new Tasks will show up here. To start writing your first Task,
-      run <code>bin/rails generate maintenance_tasks:task my_task</code>.
-    </p>
-  </div>
-<% else %>
-  <% if active_tasks = @available_tasks[:active] %>
-    <h3 class="title is-3">Active Tasks</h3>
-    <%= render partial: 'task', collection: active_tasks %>
-  <% end %>
-  <% if new_tasks = @available_tasks[:new] %>
-    <h3 class="title is-3">New Tasks</h3>
-    <%= render partial: 'task', collection: new_tasks %>
-  <% end %>
-  <% if completed_tasks = @available_tasks[:completed] %>
-    <h3 class="title is-3">Completed Tasks</h3>
-    <%= render partial: 'task', collection: completed_tasks %>
+<%= tag.div(data: { refresh: (defined?(@refresh) && @refresh) || "" }) do %>
+  <% if @available_tasks.empty? %>
+    <div class="content is-large">
+      <h3 class="title is-3"> The MaintenanceTasks gem has been successfully installed! </h3>
+      <p>
+        Any new Tasks will show up here. To start writing your first Task,
+        run <code>bin/rails generate maintenance_tasks:task my_task</code>.
+      </p>
+    </div>
+  <% else %>
+    <% if active_tasks = @available_tasks[:active] %>
+      <h3 class="title is-3">Active Tasks</h3>
+      <%= render partial: 'task', collection: active_tasks %>
+    <% end %>
+    <% if new_tasks = @available_tasks[:new] %>
+      <h3 class="title is-3">New Tasks</h3>
+      <%= render partial: 'task', collection: new_tasks %>
+    <% end %>
+    <% if completed_tasks = @available_tasks[:completed] %>
+      <h3 class="title is-3">Completed Tasks</h3>
+      <%= render partial: 'task', collection: completed_tasks %>
+    <% end %>
   <% end %>
 <% end %>

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

@@ -38,20 +38,22 @@
   <pre><code><%= highlight_code(code) %></code></pre>
 <% end %>
 
-<% if @task.active_runs.any? %>
-  <hr/>
+<%= tag.div(data: { refresh: (defined?(@refresh) && @refresh) || "" }) do %>
+  <% if @task.active_runs.any? %>
+    <hr/>
 
-  <h4 class="title is-4">Active Runs</h4>
+    <h4 class="title is-4">Active Runs</h4>
 
-  <%= render @task.active_runs %>
-<% end %>
+    <%= render @task.active_runs %>
+  <% end %>
 
-<% if @runs_page.records.present? %>
-  <hr/>
+  <% if @runs_page.records.present? %>
+    <hr/>
 
-  <h4 class="title is-4">Previous Runs</h4>
+    <h4 class="title is-4">Previous Runs</h4>
 
-  <%= render @runs_page.records %>
+    <%= render @runs_page.records %>
 
-  <%= link_to "Next page", task_path(@task, cursor: @runs_page.next_cursor) unless @runs_page.last? %>
+    <%= link_to "Next page", task_path(@task, cursor: @runs_page.next_cursor) unless @runs_page.last? %>
+  <% end %>
 <% end %>

data/db/migrate/20210219212931_change_cursor_to_string.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ChangeCursorToString < ActiveRecord::Migration[6.0]
+  # This migration will clear all existing data in the cursor column with MySQL.
+  # Ensure no Tasks are paused when this migration is deployed, or they will be resumed from the start.
+  # Running tasks are able to gracefully handle this change, even if interrupted.
+  def up
+    change_table(:maintenance_tasks_runs) do |t|
+      t.change(:cursor, :string)
+    end
+  end
+
+  def down
+    change_table(:maintenance_tasks_runs) do |t|
+      t.change(:cursor, :bigint)
+    end
+  end
+end

data/lib/maintenance_tasks.rb

@@ -72,4 +72,14 @@ module MaintenanceTasks
   #   @return [Proc] the callback to perform when an error occurs in the Task.
   mattr_accessor :error_handler, default:
     ->(_error, _task_context, _errored_element) {}
+
+  # @!attribute parent_controller
+  #   @scope class
+  #
+  #   The parent controller all web UI controllers will inherit from.
+  #   Must be a class that inherits from `ActionController::Base`.
+  #   Defaults to `"ActionController::Base"`
+  #
+  #   @return [String] the name of the parent controller for web UI.
+  mattr_accessor :parent_controller, default: "ActionController::Base"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -131,6 +131,7 @@ files:
 - app/views/maintenance_tasks/tasks/show.html.erb
 - config/routes.rb
 - db/migrate/20201211151756_create_maintenance_tasks_runs.rb
+- db/migrate/20210219212931_change_cursor_to_string.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
@@ -154,7 +155,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.1.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.2.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -164,14 +165,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks