maintenance_tasks 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60d043a961d97e4db5e822b86bf17a29fd409cf14e3951c581ecfb92abc7e2af
-  data.tar.gz: 5170cb9e4bb82c82fe31f07f0dba93ca28caeacffe2b68ec592a092623d6aafd
+  metadata.gz: 2dcb5b54d6f3fd47db28a3f57a487c201e2109b3eb8f78efbe3c972a374999e8
+  data.tar.gz: eeb95960a0cac8de08aa3af7d12d47f6cfbee4d875ab74f8989f4d17ef545f6c
 SHA512:
-  metadata.gz: be30600ed5e353ef1fba3bc484d5349be4567249b0cbb808503e73e0f42af76ae0befe6403fc4bdead3fb3ce0a5cd36e920f427eb013ac5215900571ddbb976a
-  data.tar.gz: 1242c76047b52eae2463ea562c0ac48d09d773f9d4b069a781a140e49c39c9175e25b1eb7d21db5dce6ee96d43844323337761575909db396ccf4bc044a8355b
+  metadata.gz: e99ebde772755c6f3d88d48e65df883805b2ceb4798334f00175bc8e4c83d093bef79931bf0c0c86b303c3d94d2e0b44b3b506b1813ea6e01597ccf47f2c8182
+  data.tar.gz: 58d11ad3fa36721e9f29a49cecf586d2f362aaf155667ce6b7702b7acd7bb43f1defa2a2a4ed1fa259d563876b9cec5d5f7b66f4d5dcf43747009e64552fa804

data/README.md

@@ -33,12 +33,13 @@ take a look at the [Active Job 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
 
-
 ### Autoloading
 
 The Maintenance Tasks framework does not support autoloading in `:classic` mode.
-Please ensure your application is using [Zeitwerk](https://github.com/fxn/zeitwerk) to load your code.
-For more information, please consult the [Rails guides on autoloading and reloading constants](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html).
+Please ensure your application is using
+[Zeitwerk](https://github.com/fxn/zeitwerk) to load your code.  For more
+information, please consult the [Rails guides on autoloading and reloading
+constants](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html).
 
 ## Usage
 
@@ -51,7 +52,7 @@ The typical Maintenance Tasks workflow is as follows:
     - or by [using Ruby](#running-a-task-from-ruby).
 3. [Monitor the Task](#monitoring-your-tasks-status)
     - either by using the included web UI,
-    - or by manually checking your task's run's status in your database.
+    - or by manually checking your task’s run’s status in your database.
 4. Optionally, delete the Task code if you no longer need it.
 
 ### Creating a Task
@@ -70,11 +71,12 @@ The generated task is a subclass of `MaintenanceTasks::Task` that implements:
   over.
 * `process`: do the work of your maintenance task on a single record
 
-Optionally, tasks can also implement a custom `#count` method, defining the number
-of elements that will be iterated over. Your task's `tick_total` will be calculated
-automatically based on the collection size, but this value may be overriden if desired
-using the `#count` method (this might be done, for example, to avoid the query that would
-be produced to determine the size of your collection).
+Optionally, tasks can also implement a custom `#count` method, defining the
+number of elements that will be iterated over. Your task’s `tick_total` will be
+calculated automatically based on the collection size, but this value may be
+overridden if desired using the `#count` method (this might be done, for
+example, to avoid the query that would be produced to determine the size of your
+collection).
 
 Example:
 
@@ -98,10 +100,12 @@ end
 
 You can also write a Task that iterates on a CSV file. Note that writing CSV
 Tasks **requires Active Storage to be configured**. Ensure that the dependency
-is specified in your application's Gemfile, and that you've followed the [setup
-instuctions][setup].
+is specified in your application’s Gemfile, and that you’ve followed the [setup
+instructions][storage-setup]. See also [Customizing which Active Storage service
+to use][storage-customizing].
 
-[setup]: https://edgeguides.rubyonrails.org/active_storage_overview.html#setup
+[storage-setup]: https://edgeguides.rubyonrails.org/active_storage_overview.html#setup
+[storage-customizing]: #customizing-which-active-storage-service-to-use
 
 Generate a CSV Task by running:
 
@@ -134,12 +138,12 @@ My Title,Hello World!
 ```
 
 The files uploaded to your Active Storage service provider will be renamed
-to include an ISO8601 timestamp and the Task name in snake case format.
+to include an ISO 8601 timestamp and the Task name in snake case format.
 The CSV is expected to have a trailing newline at the end of the file.
 
 #### Batch CSV Tasks
 
-Tasks can process CSVs in batches. Add the `in_batches` option to your task's
+Tasks can process CSVs in batches. Add the `in_batches` option to your task’s
 `csv_collection` macro:
 
 ```ruby
@@ -156,12 +160,12 @@ module Maintenance
 end
 ```
 
-As with a regular CSV task, ensure you've implemented the following method:
+As with a regular CSV task, ensure you’ve implemented the following method:
 
 * `process`: do the work of your Task on a batch (array of `CSV::Row` objects).
 
 Note that `#count` is calculated automatically based on the number of batches in
-your collection, and your Task's progress will be displayed in terms of batches
+your collection, and your Task’s progress will be displayed in terms of batches
 (not the total number of rows in your CSV).
 
 ### Processing Batch Collections
@@ -188,13 +192,13 @@ module Maintenance
 end
 ```
 
-Ensure that you've implemented the following methods:
+Ensure that you’ve implemented the following methods:
 
 * `collection`: return an `ActiveRecord::Batches::BatchEnumerator`.
 * `process`: do the work of your Task on a batch (`ActiveRecord::Relation`).
 
 Note that `#count` is calculated automatically based on the number of batches in
-your collection, and your Task's progress will be displayed in terms of batches
+your collection, and your Task’s progress will be displayed in terms of batches
 (not the number of records in the relation).
 
 **Important!** Batches should only be used if `#process` is performing a batch
@@ -206,7 +210,7 @@ primary keys of the records of the batch first, and then perform an additional
 query to load the records when calling `each` (or any `Enumerable` method)
 inside `#process`.
 
-### Tasks that don't need a Collection
+### Tasks that don’t need a Collection
 
 Sometimes, you might want to run a Task that performs a single operation, such
 as enqueuing another background job or hitting an external API. The gem supports
@@ -264,7 +268,7 @@ module Maintenance
 end
 ```
 
-Note that it's up to you to define a throttling condition that makes sense for
+Note that it’s up to you to define a throttling condition that makes sense for
 your app. Shopify implements `DatabaseStatus.healthy?` to check various MySQL
 metrics such as replication lag, DB threads, whether DB writes are available,
 etc.
@@ -273,7 +277,7 @@ Tasks can define multiple throttle conditions. Throttle conditions are inherited
 by descendants, and new conditions will be appended without impacting existing
 conditions.
 
-The backoff can also be specified as a proc:
+The backoff can also be specified as a Proc:
 
 ```ruby
 # app/tasks/maintenance/update_posts_throttled_task.rb
@@ -287,11 +291,12 @@ module Maintenance
   end
 end
 ```
+
 ### Custom Task Parameters
 
 Tasks may need additional information, supplied via parameters, to run.
 Parameters can be defined as Active Model Attributes in a Task, and then become
-accessible to any of Task's methods: `#collection`, `#count`, or `#process`.
+accessible to any of Task’s methods: `#collection`, `#count`, or `#process`.
 
 ```ruby
 # app/tasks/maintenance/update_posts_via_params_task.rb
@@ -315,7 +320,7 @@ end
 Tasks can leverage Active Model Validations when defining parameters. Arguments
 supplied to a Task accepting parameters will be validated before the Task starts
 to run. Since arguments are specified in the user interface via text area
-inputs, it's important to check that they conform to the format your Task
+inputs, it’s important to check that they conform to the format your Task
 expects, and to sanitize any inputs if necessary.
 
 ### Using Task Callbacks
@@ -348,7 +353,7 @@ end
 Note: The `after_error` callback is guaranteed to complete,
 so any exceptions raised in your callback code are ignored.
 If your `after_error` callback code can raise an exception,
-you'll need to rescue it and handle it appropriately
+you’ll need to rescue it and handle it appropriately
 within the callback.
 
 ```ruby
@@ -397,7 +402,7 @@ depend on the queue adapter but in general, you should follow these rules:
   safely interrupted and resumed.
 * Idempotency of `Task#process`: it should be safe to run `process` multiple
   times for the same element of the collection. Read more in [this Sidekiq best
-  practice][sidekiq-idempotent]. It's important if the Task errors and you run
+  practice][sidekiq-idempotent]. It’s important if the Task errors and you run
   it again, because the same element that errored the Task may well be processed
   again. It especially matters in the situation described above, when the
   iteration duration exceeds the timeout: if the job is re-enqueued, multiple
@@ -422,7 +427,7 @@ callbacks](#using-task-callbacks) to persist or log a report for example.
 ### Writing tests for a Task
 
 The task generator will also create a test file for your task in the folder
-`test/tasks/maintenance/`. At a minimum, it's recommended that the `#process`
+`test/tasks/maintenance/`. At a minimum, it’s recommended that the `#process`
 method in your task be tested. You may also want to test the `#collection` and
 `#count` methods for your task if they are sufficiently complex.
 
@@ -477,7 +482,7 @@ end
 
 ### Writing tests for a Task with parameters
 
-Tests for tasks with parameters need to instatiate the task class in order to
+Tests for tasks with parameters need to instantiate the task class in order to
 assign attributes. Once the task instance is setup, you may test `#process`
 normally.
 
@@ -525,7 +530,8 @@ bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv "path/t
 The `--csv` option also works with CSV content coming from the standard input:
 
 ```sh-session
-curl "some/remote/csv" | bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv
+curl "some/remote/csv" |
+  bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv
 ```
 
 To run a Task that takes arguments from the command line, use the `--arguments`
@@ -564,7 +570,7 @@ MaintenanceTasks::Runner.run(
 )
 ```
 
-### Monitoring your Task's status
+### Monitoring your Task’s status
 
 The web UI will provide updates on the status of your Task. Here are the states
 a Task can be in:
@@ -620,11 +626,11 @@ When Sidekiq is stopping, it will give workers 25 seconds to finish before
 forcefully terminating them (this is the default but can be configured with the
 `--timeout` option). Before the worker threads are terminated, Sidekiq will try
 to re-enqueue the job so your Task will be resumed. However, the position in
-the collection won't be persisted so at least one iteration may run again.
+the collection won’t be persisted so at least one iteration may run again.
 
 #### Help! My Task is stuck
 
-Finally, if the queue adapter configured for your application doesn't have this
+Finally, if the queue adapter configured for your application doesn’t have this
 property, or if Sidekiq crashes, is forcefully terminated, or is unable to
 re-enqueue the jobs that were in progress, the Task may be in a seemingly stuck
 situation where it appears to be running but is not. In that situation, pausing
@@ -699,7 +705,7 @@ maintenance tasks in your application.
 ```ruby
 # config/initializers/maintenance_tasks.rb
 
-MaintenanceTasks.job = 'CustomTaskJob'
+MaintenanceTasks.job = "CustomTaskJob"
 
 # app/jobs/custom_task_job.rb
 
@@ -730,9 +736,9 @@ If no value is specified, it will default to 1 second.
 #### Customizing which Active Storage service to use
 
 The Active Storage framework in Rails 6.1 and up supports multiple storage
-services per environment. To specify which service to use,
-`MaintenanceTasks.active_storage_service` can be configured with the service's
-key, as specified in your application's `config/storage.yml`:
+services. To specify which service to use,
+`MaintenanceTasks.active_storage_service` can be configured with the service’s
+key, as specified in your application’s `config/storage.yml`:
 
 ```yaml
 # config/storage.yml
@@ -757,7 +763,8 @@ MaintenanceTasks.active_storage_service = :internal
 ```
 
 There is no need to configure this option if your application uses only one
-storage service per environment.
+storage service. `Rails.configuration.active_storage.service` is used by
+default.
 
 #### Customizing the backtrace cleaner
 
@@ -788,11 +795,11 @@ 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?**
+**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
-maintenance_tasks:install:migrations` to copy the gem's migrations to your
+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.
@@ -820,8 +827,8 @@ Once a release is ready, follow these steps:
 * Deploy via [Shipit][shipit] and see the new version on
   <https://rubygems.org/gems/maintenance_tasks>.
 * Ensure the release has documented all changes and publish it.
-* Create a new [draft release on GitHub][release] with the title 'Upcoming
-  Release'. The tag version can be left blank. This will be the starting point
+* Create a new [draft release on GitHub][release] with the title “Upcoming
+  Release”. The tag version can be left blank. This will be the starting point
   for documenting changes related to the next release.
 
 [release]: https://help.github.com/articles/creating-releases/

data/app/controllers/maintenance_tasks/tasks_controller.rb

@@ -18,10 +18,14 @@ module MaintenanceTasks
     # Renders the page responsible for providing Task actions to users.
     # Shows running and completed instances of the Task.
     def show
-      @task = TaskDataShow.find(params.fetch(:id))
-      @active_runs = @task.active_runs
-      set_refresh if @active_runs.any?
+      task_name = params.fetch(:id)
+      @task = TaskDataShow.new(task_name)
+      @task.active_runs.load
+      set_refresh if @task.active_runs.any?
       @runs_page = RunsPage.new(@task.completed_runs, params[:cursor])
+      if @task.active_runs.none? && @runs_page.records.none?
+        Task.named(task_name)
+      end
     end
 
     private

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -104,9 +104,10 @@ module MaintenanceTasks
     # Return the appropriate field tag for the parameter
     def parameter_field(form_builder, parameter_name)
       case form_builder.object.class.attribute_types[parameter_name]
-      when ActiveModel::Type::Integer, ActiveModel::Type::Decimal,
-           ActiveModel::Type::Float
+      when ActiveModel::Type::Integer
         form_builder.number_field(parameter_name)
+      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)
       when ActiveModel::Type::Date

data/app/models/maintenance_tasks/run.rb

@@ -37,17 +37,22 @@ module MaintenanceTasks
 
     enum status: STATUSES.to_h { |status| [status, status.to_s] }
 
-    validates :task_name, on: :create, inclusion: { in: ->(_) {
-      Task.available_tasks.map(&:to_s)
-    } }
+    validates :task_name, on: :create, inclusion: {
+      in: ->(_) { Task.available_tasks.map(&:to_s) },
+    }
     validate :csv_attachment_presence, on: :create
     validate :csv_content_type, on: :create
     validate :validate_task_arguments, on: :create
 
     attr_readonly :task_name
 
-    serialize :backtrace
-    serialize :arguments, JSON
+    if Rails.gem_version >= Gem::Version.new("7.1.alpha")
+      serialize :backtrace, coder: YAML
+      serialize :arguments, coder: JSON
+    else
+      serialize :backtrace
+      serialize :arguments, JSON
+    end
 
     scope :active, -> { where(status: ACTIVE_STATUSES) }
     scope :completed, -> { where(status: COMPLETED_STATUSES) }

data/app/models/maintenance_tasks/task_data_show.rb

@@ -11,26 +11,6 @@ module MaintenanceTasks
   #
   # @api private
   class TaskDataShow
-    class << self
-      # Initializes a Task Data by name, raising if the Task does not exist.
-      #
-      # For the purpose of this method, a Task does not exist if it's deleted
-      # and doesn't have a Run. While technically, it could have existed and
-      # been deleted since, if it never had a Run we may as well consider it
-      # non-existent since we don't have interesting data to show.
-      #
-      # @param name [String] the name of the Task subclass.
-      # @return [TaskDataShow] a Task Data instance.
-      # @raise [Task::NotFoundError] if the Task does not exist and doesn't have
-      #   a Run.
-      def find(name)
-        task_data = new(name)
-        task_data.active_runs.load
-        task_data.has_any_run? || Task.named(name)
-        task_data
-      end
-    end
-
     # Initializes a Task Data with a name and optionally a related run.
     #
     # @param name [String] the name of the Task subclass.
@@ -107,12 +87,6 @@ module MaintenanceTasks
       MaintenanceTasks::Task.named(name).new
     end
 
-    # @return [Boolean] whether the Task has any Run.
-    # @api private
-    def has_any_run?
-      active_runs.any? || completed_runs.any?
-    end
-
     private
 
     def runs

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

@@ -15,9 +15,9 @@
     <%= csrf_meta_tags %>
 
     <%=
-      stylesheet_link_tag(URI.join(controller.class::BULMA_CDN, 'npm/bulma@0.9.3/css/bulma.css'),
+      stylesheet_link_tag(URI.join(controller.class::BULMA_CDN, 'npm/bulma@0.9.4/css/bulma.css'),
         media: :all,
-        integrity: 'sha384-Zkr9rpl37lclZu6AwYQZZm0CxiMqLZFiibodW+UXLnAWPBr6qgIzPpcmHkpwnyWD',
+        integrity: 'sha384-qQlNh1kc0FyhUqUDXKkl5wpiiSm8PXQw2ZWhAVfU46tmdMDfq2vXG2CXWYT+Dls3',
         crossorigin: 'anonymous') unless request.xhr?
     %>
 

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

@@ -38,12 +38,12 @@
   <pre><code><%= highlight_code(code) %></code></pre>
 <% end %>
 
-<% if @active_runs.any? %>
+<% if @task.active_runs.any? %>
   <hr/>
 
   <h4 class="title is-4">Active Runs</h4>
 
-  <%= render @active_runs %>
+  <%= render @task.active_runs %>
 <% end %>
 
 <% if @runs_page.records.present? %>

data/db/migrate/20211210152329_add_lock_version_to_maintenance_tasks_runs.rb

@@ -2,7 +2,12 @@
 
 class AddLockVersionToMaintenanceTasksRuns < ActiveRecord::Migration[6.0]
   def change
-    add_column(:maintenance_tasks_runs, :lock_version, :integer,
-      default: 0, null: false)
+    add_column(
+      :maintenance_tasks_runs,
+      :lock_version,
+      :integer,
+      default: 0,
+      null: false,
+    )
   end
 end

data/db/migrate/20220713131925_add_index_on_task_name_and_status_to_runs.rb

@@ -2,12 +2,18 @@
 
 class AddIndexOnTaskNameAndStatusToRuns < ActiveRecord::Migration[6.0]
   def change
-    remove_index(:maintenance_tasks_runs,
-      column: [:task_name, :created_at], order: { created_at: :desc },
-      name: :index_maintenance_tasks_runs_on_task_name_and_created_at)
+    remove_index(
+      :maintenance_tasks_runs,
+      column: [:task_name, :created_at],
+      order: { created_at: :desc },
+      name: :index_maintenance_tasks_runs_on_task_name_and_created_at,
+    )
 
-    add_index(:maintenance_tasks_runs, [:task_name, :status, :created_at],
+    add_index(
+      :maintenance_tasks_runs,
+      [:task_name, :status, :created_at],
       name: :index_maintenance_tasks_runs,
-      order: { created_at: :desc })
+      order: { created_at: :desc },
+    )
   end
 end

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -9,10 +9,14 @@ module MaintenanceTasks
     desc "This generator creates a task file at app/tasks and a corresponding "\
       "test."
 
-    class_option :csv, type: :boolean, default: false,
+    class_option :csv,
+      type: :boolean,
+      default: false,
       desc: "Generate a CSV Task."
 
-    class_option :no_collection, type: :boolean, default: false,
+    class_option :no_collection,
+      type: :boolean,
+      default: false,
       desc: "Generate a collection-less Task."
 
     check_class_collision suffix: "Task"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -154,7 +154,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.0.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.1.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []