maintenance_tasks 1.3.0 → 1.7.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -97,21 +97,24 @@ files:
 - app/jobs/concerns/maintenance_tasks/task_job_concern.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/csv_collection_builder.rb
+- app/models/maintenance_tasks/null_collection_builder.rb
 - app/models/maintenance_tasks/progress.rb
 - app/models/maintenance_tasks/run.rb
 - app/models/maintenance_tasks/runner.rb
 - app/models/maintenance_tasks/runs_page.rb
+- app/models/maintenance_tasks/task.rb
 - app/models/maintenance_tasks/task_data.rb
 - app/models/maintenance_tasks/ticker.rb
-- app/tasks/maintenance_tasks/task.rb
 - 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
+- app/views/maintenance_tasks/runs/info/_custom.html.erb
 - app/views/maintenance_tasks/runs/info/_enqueued.html.erb
 - app/views/maintenance_tasks/runs/info/_errored.html.erb
 - app/views/maintenance_tasks/runs/info/_interrupted.html.erb
@@ -119,12 +122,15 @@ files:
 - app/views/maintenance_tasks/runs/info/_pausing.html.erb
 - app/views/maintenance_tasks/runs/info/_running.html.erb
 - app/views/maintenance_tasks/runs/info/_succeeded.html.erb
+- app/views/maintenance_tasks/tasks/_custom.html.erb
 - app/views/maintenance_tasks/tasks/_task.html.erb
 - app/views/maintenance_tasks/tasks/index.html.erb
 - app/views/maintenance_tasks/tasks/show.html.erb
 - config/routes.rb
 - db/migrate/20201211151756_create_maintenance_tasks_runs.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
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
@@ -135,17 +141,15 @@ files:
 - lib/maintenance_tasks.rb
 - lib/maintenance_tasks/cli.rb
 - lib/maintenance_tasks/engine.rb
+- lib/patches/active_record_batch_enumerator.rb
 - lib/tasks/maintenance_tasks_tasks.rake
 homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.3.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.7.0
   allowed_push_host: https://rubygems.org
-post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.3.0. To complete, please run:
-
-  rails generate maintenance_tasks:install
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -160,7 +164,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/models/maintenance_tasks/csv_collection.rb

@@ -1,33 +0,0 @@
-# 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
-end

data/app/tasks/maintenance_tasks/task.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-module MaintenanceTasks
-  # Base class that is inherited by the host application's task classes.
-  class Task
-    extend ActiveSupport::DescendantsTracker
-
-    class NotFoundError < NameError; end
-
-    # The throttle conditions for a given Task. This is provided as an array of
-    # hashes, with each hash specifying two keys: throttle_condition and
-    # backoff. Note that Tasks inherit conditions from their superclasses.
-    #
-    # @api private
-    class_attribute :throttle_conditions, default: []
-
-    class << self
-      # Finds a Task with the given name.
-      #
-      # @param name [String] the name of the Task to be found.
-      #
-      # @return [Task] the Task with the given name.
-      #
-      # @raise [NotFoundError] if a Task with the given name does not exist.
-      def named(name)
-        task = name.safe_constantize
-        raise NotFoundError.new("Task #{name} not found.", name) unless task
-        unless task.is_a?(Class) && task < Task
-          raise NotFoundError.new("#{name} is not a Task.", name)
-        end
-        task
-      end
-
-      # Returns a list of concrete classes that inherit from the Task
-      # superclass.
-      #
-      # @return [Array<Class>] the list of classes.
-      def available_tasks
-        load_constants
-        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
-        if !defined?(ActiveStorage) || !ActiveStorage::Attachment.table_exists?
-          raise NotImplementedError, "Active Storage needs to be installed\n"\
-            "To resolve this issue run: bin/rails active_storage:install"
-        end
-        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
-
-      # Add a condition under which this Task will be throttled.
-      #
-      # @param backoff [ActiveSupport::Duration] optionally, a custom backoff
-      #   can be specified. This is the time to wait before retrying the Task.
-      #   If no value is specified, it defaults to 30 seconds.
-      # @yieldreturn [Boolean] where the throttle condition is being met,
-      #   indicating that the Task should throttle.
-      def throttle_on(backoff: 30.seconds, &condition)
-        self.throttle_conditions += [
-          { throttle_on: condition, backoff: backoff },
-        ]
-      end
-
-      private
-
-      def load_constants
-        namespace = MaintenanceTasks.tasks_module.safe_constantize
-        return unless namespace
-        namespace.constants.map { |constant| namespace.const_get(constant) }
-      end
-    end
-
-    # Placeholder method to raise in case a subclass fails to implement the
-    # expected instance method.
-    #
-    # @raise [NotImplementedError] with a message advising subclasses to
-    #   implement an override for this method.
-    def collection
-      raise NoMethodError, "#{self.class.name} must implement `collection`."
-    end
-
-    # Placeholder method to raise in case a subclass fails to implement the
-    # expected instance method.
-    #
-    # @param _item [Object] the current item from the enumerator being iterated.
-    #
-    # @raise [NotImplementedError] with a message advising subclasses to
-    #   implement an override for this method.
-    def process(_item)
-      raise NoMethodError, "#{self.class.name} must implement `process`."
-    end
-
-    # Total count of iterations to be performed.
-    #
-    # Tasks override this method to define the total amount of iterations
-    # expected at the start of the run. Return +nil+ if the amount is
-    # undefined, or counting would be prohibitive for your database.
-    #
-    # @return [Integer, nil]
-    def count
-    end
-  end
-end

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 %>