maintenance_tasks 1.7.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6019b1623a8cc72e877154f52e8437339598f0cab121189d78692e0989e86e61
-  data.tar.gz: 21563dc6dffadd2e58dd551fe2b7d71297b2da36500722f5d9fed91892b1fd6e
+  metadata.gz: b11e5edbefa677caf704bd6af59a14185ab89ff29da35d966253b78143a76af1
+  data.tar.gz: a103be6c53d5d6dae55d63f451d293abe1c0a4e763cb1c2bd9e3dcfea3a6bc72
 SHA512:
-  metadata.gz: 93228d08b49fab144297cb44a0aa4b9be53144ff13b88c2eba384ef29fdb47b9a8caefaf94aaf1fbfbf4584f4d544396720c17d86f3bad31508fd66dfd7507b8
-  data.tar.gz: cab4cebb685fddf978eeebd62a5c16867215f849d424b9ba948beba0e93f42a5fe11ee1eccc15174c1494fa16a2fa100d3a7745c5eacef2527d425895805cf29
+  metadata.gz: 3415d87b545e09fc65494cecb03a7cea9a5c84838c66c209a129f8017efc611eee7521852c2460ada50c389b2885bb95dcd2bfe807ea8a84693e9b86e2123409
+  data.tar.gz: 19fce32dfc506afe512ce6ebc2ddfd0a2fd195b61e4611c4a3febae5ad4bfe09d39ac47e902a1c21f830de9e3c5f953379d8011919ba0a381dc6010599eb289e

data/README.md

@@ -160,6 +160,36 @@ 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
+
+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
+collection-less tasks.
+
+Generate a collection-less Task by running:
+
+```bash
+$ bin/rails generate maintenance_tasks:task no_collection_task --no-collection
+```
+
+The generated task is a subclass of `MaintenanceTasks::Task` that implements:
+
+* `process`: do the work of your maintenance task
+
+```ruby
+# app/tasks/maintenance/no_collection_task.rb
+
+module Maintenance
+  class NoCollectionTask < MaintenanceTasks::Task
+    no_collection
+
+    def process
+      SomeAsyncJob.perform_later
+    end
+  end
+end
+```
+
 ### Throttling
 
 Maintenance Tasks often modify a lot of data and can be taxing on your database.

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

@@ -36,6 +36,8 @@ module MaintenanceTasks
       @enumerator = nil
 
       collection_enum = case collection
+      when :no_collection
+        enumerator_builder.build_once_enumerator(cursor: nil)
       when ActiveRecord::Relation
         enumerator_builder.active_record_on_records(collection, cursor: cursor)
       when ActiveRecord::Batches::BatchEnumerator
@@ -45,6 +47,7 @@ module MaintenanceTasks
             a batch enumerator with the "start" or "finish" options.
           MSG
         end
+
         # For now, only support automatic count based on the enumerator for
         # batches
         @enumerator = enumerator_builder.active_record_on_batch_relations(
@@ -89,7 +92,11 @@ module MaintenanceTasks
     end
 
     def task_iteration(input)
-      @task.process(input)
+      if @task.no_collection?
+        @task.process
+      else
+        @task.process(input)
+      end
     rescue => error
       @errored_element = input
       raise error
@@ -145,7 +152,7 @@ module MaintenanceTasks
     def after_perform
       @run.persist_transition
       if defined?(@reenqueue_iteration_job) && @reenqueue_iteration_job
-        reenqueue_iteration_job(should_ignore: false)
+        reenqueue_iteration_job(should_ignore: false) unless @run.stopped?
       end
     end
 

data/app/models/maintenance_tasks/csv_collection_builder.rb

@@ -29,5 +29,10 @@ module MaintenanceTasks
     def has_csv_content?
       true
     end
+
+    # Returns that the Task processes a collection.
+    def no_collection?
+      false
+    end
   end
 end

data/app/models/maintenance_tasks/no_collection_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MaintenanceTasks
+  # Strategy for building a Task that has no collection. These Tasks
+  # consist of a single iteration.
+  #
+  # @api private
+  class NoCollectionBuilder
+    # Specifies that this task does not process a collection.
+    def collection(_task)
+      :no_collection
+    end
+
+    # The number of rows to be processed. Always returns 1.
+    def count(_task)
+      1
+    end
+
+    # Return that the Task does not process CSV content.
+    def has_csv_content?
+      false
+    end
+
+    # Returns that the Task is collection-less.
+    def no_collection?
+      true
+    end
+  end
+end

data/app/models/maintenance_tasks/null_collection_builder.rb

@@ -2,6 +2,8 @@
 
 module MaintenanceTasks
   # Base strategy for building a collection-based Task to be performed.
+  #
+  # @api private
   class NullCollectionBuilder
     # Placeholder method to raise in case a subclass fails to implement the
     # expected instance method.
@@ -27,5 +29,10 @@ module MaintenanceTasks
     def has_csv_content?
       false
     end
+
+    # Returns that the Task processes a collection.
+    def no_collection?
+      false
+    end
   end
 end

data/app/models/maintenance_tasks/run.rb

@@ -52,6 +52,7 @@ module MaintenanceTasks
     # Ensure ActiveStorage is in use before preloading the attachments
     scope :with_attached_csv, -> do
       return unless defined?(ActiveStorage)
+
       with_attached_csv_file if ActiveStorage::Attachment.table_exists?
     end
 
@@ -131,8 +132,8 @@ module MaintenanceTasks
       self.started_at ||= Time.now
       update!(
         status: :errored,
-        error_class: error.class.to_s,
-        error_message: error.message,
+        error_class: truncate(:error_class, error.class.name),
+        error_message: truncate(:error_message, error.message),
         backtrace: MaintenanceTasks.backtrace_cleaner.clean(error.backtrace),
         ended_at: Time.now,
       )
@@ -240,6 +241,7 @@ module MaintenanceTasks
         # Preserve swap-and-replace solution for data races until users
         # run migration to upgrade to optimistic locking solution
         return if stopping?
+
         updated = self.class.where(id: id).where.not(status: STOPPING_STATUSES)
           .update_all(status: :running, updated_at: Time.now) > 0
         if updated
@@ -384,6 +386,7 @@ module MaintenanceTasks
     def csv_file
       return unless defined?(ActiveStorage)
       return unless ActiveStorage::Attachment.table_exists?
+
       super
     end
 
@@ -422,5 +425,12 @@ module MaintenanceTasks
         errors.add(:base, error_message)
       end
     end
+
+    def truncate(attribute_name, value)
+      limit = self.class.column_for_attribute(attribute_name).limit
+      return value unless limit
+
+      value&.first(limit)
+    end
   end
 end

data/app/models/maintenance_tasks/task.rb

@@ -18,6 +18,7 @@ module MaintenanceTasks
     # @api private
     class_attribute :throttle_conditions, default: []
 
+    # @api private
     class_attribute :collection_builder_strategy,
       default: NullCollectionBuilder.new
 
@@ -37,6 +38,7 @@ module MaintenanceTasks
         unless task.is_a?(Class) && task < Task
           raise NotFoundError.new("#{name} is not a Task.", name)
         end
+
         task
       end
 
@@ -63,20 +65,23 @@ module MaintenanceTasks
           MaintenanceTasks::CsvCollectionBuilder.new
       end
 
-      # Returns whether the Task handles CSV.
-      #
-      # @return [Boolean] whether the Task handles CSV.
-      def has_csv_content?
-        collection_builder_strategy.has_csv_content?
+      # Make this a Task that calls #process once, instead of iterating over
+      # a collection.
+      def no_collection
+        self.collection_builder_strategy =
+          MaintenanceTasks::NoCollectionBuilder.new
       end
 
+      delegate :has_csv_content?, :no_collection?,
+        to: :collection_builder_strategy
+
       # Processes one item.
       #
       # Especially useful for tests.
       #
-      # @param item the item to process.
-      def process(item)
-        new.process(item)
+      # @param args [Object, nil] the item to process
+      def process(*args)
+        new.process(*args)
       end
 
       # Returns the collection for this Task.
@@ -168,6 +173,7 @@ module MaintenanceTasks
       def load_constants
         namespace = MaintenanceTasks.tasks_module.safe_constantize
         return unless namespace
+
         namespace.constants.map { |constant| namespace.const_get(constant) }
       end
     end
@@ -197,6 +203,13 @@ module MaintenanceTasks
       self.class.has_csv_content?
     end
 
+    # Returns whether the Task is collection-less.
+    #
+    # @return [Boolean] whether the Task is collection-less.
+    def no_collection?
+      self.class.no_collection?
+    end
+
     # The collection to be processed, delegated to the strategy.
     #
     # @return the collection.

data/app/models/maintenance_tasks/task_data.rb

@@ -73,6 +73,7 @@ module MaintenanceTasks
     # @return [nil] if the Task file was deleted.
     def code
       return if deleted?
+
       task = Task.named(name)
       file = if Object.respond_to?(:const_source_location)
         Object.const_source_location(task.name).first
@@ -88,6 +89,7 @@ module MaintenanceTasks
     # @return [nil] if there are no Runs associated with the Task.
     def last_run
       return @last_run if defined?(@last_run)
+
       @last_run = runs.first
     end
 
@@ -100,6 +102,7 @@ module MaintenanceTasks
     #   record previous to the last Run.
     def previous_runs
       return Run.none unless last_run
+
       runs.where.not(id: last_run.id)
     end
 
@@ -150,6 +153,7 @@ module MaintenanceTasks
     # @return [nil] if the Task file was deleted.
     def new
       return if deleted?
+
       MaintenanceTasks::Task.named(name).new
     end
 

data/app/models/maintenance_tasks/ticker.rb

@@ -41,6 +41,7 @@ module MaintenanceTasks
     # row will call the block at most once (if it had been throttled).
     def persist
       return if @ticks_recorded == 0
+
       now = Time.now
       duration = now - @last_persisted
       @last_persisted = now

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -12,10 +12,17 @@ module MaintenanceTasks
     class_option :csv, type: :boolean, default: false,
       desc: "Generate a CSV Task."
 
+    class_option :no_collection, type: :boolean, default: false,
+      desc: "Generate a collection-less Task."
+
     check_class_collision suffix: "Task"
 
     # Creates the Task file.
     def create_task_file
+      if options[:csv] && options[:no_collection]
+        raise "Multiple Task type options provided. Please use either "\
+          "--csv or --no-collection."
+      end
       template_file = File.join(
         "app/tasks/#{tasks_module_file_path}",
         class_path,
@@ -23,6 +30,8 @@ module MaintenanceTasks
       )
       if options[:csv]
         template("csv_task.rb", template_file)
+      elsif no_collection?
+        template("no_collection_task.rb", template_file)
       else
         template("task.rb", template_file)
       end
@@ -76,5 +85,9 @@ module MaintenanceTasks
     def test_framework
       Rails.application.config.generators.options[:rails][:test_framework]
     end
+
+    def no_collection?
+      options[:no_collection]
+    end
   end
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module <%= tasks_module %>
+<% module_namespacing do -%>
+  class <%= class_name %>Task < MaintenanceTasks::Task
+    no_collection
+
+    def process
+      # The work to be done
+    end
+  end
+<% end -%>
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module <%= tasks_module %>
+<% module_namespacing do -%>
+  class <%= class_name %>TaskTest < ActiveSupport::TestCase
+    # test "#process performs a task iteration" do
+    #   <%= tasks_module %>::<%= class_name %>Task.process
+    # end
+  end
+<% end -%>
+end

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

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

data/lib/maintenance_tasks.rb

@@ -66,6 +66,7 @@ module MaintenanceTasks
   # @private
   def self.error_handler
     return @error_handler if defined?(@error_handler)
+
     @error_handler = ->(_error, _task_context, _errored_element) {}
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - app/jobs/maintenance_tasks/task_job.rb
 - app/models/maintenance_tasks/application_record.rb
 - app/models/maintenance_tasks/csv_collection_builder.rb
+- app/models/maintenance_tasks/no_collection_builder.rb
 - app/models/maintenance_tasks/null_collection_builder.rb
 - app/models/maintenance_tasks/progress.rb
 - app/models/maintenance_tasks/run.rb
@@ -135,6 +136,8 @@ files:
 - 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/no_collection_task.rb.tt
+- lib/generators/maintenance_tasks/templates/no_collection_task_test.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
@@ -147,7 +150,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.7.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.8.2
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []