maintenance_tasks 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2869ba1c05cb80edb54803f50037bb45b388a5489bec724a79617d2890e78fdc
-  data.tar.gz: 5a936d433f102642e972f4c04e7fd96817193f0075b252e942c1ff86bb6a0e06
+  metadata.gz: b984293788834b153823e857dad5020b8cca1902037c97fd158401c1da3cfee3
+  data.tar.gz: 0c079b820fbfd3d7e26e7c19585ac8b41199de92f7a71e671a63c7db46b60d06
 SHA512:
-  metadata.gz: 5e054a909fd05bacc7482caa7cba9cc69ed15850bdec1e0bbf09466426ad6bcfadd12c086a4efe185eb5be1edc40b3fbacaca34b555fac39fa0dcfac2df50405
-  data.tar.gz: fa1c8baed4e9cc6b34acd03e9c16ef2266da288293da212fb96c03d6a6be2d87fb5599e167e4d629e80f16a80127b611ffe6b8895867958a92675dca06457e48
+  metadata.gz: f43e5c6535246bf7259bb21cfd1eb3f48f356a9f1f2e83fea19096cdff8610a601d4ea96b623d63bbecbaa593d1022a34fd16210896f83852f64c3e3bf003b41
+  data.tar.gz: a506d5e89ec233e60a59c428801d8e2e79a57f6604f8ab9cf97882b71bf69f4304f7d1fa53ac33ecd4ab5bb76f9de3774cbf9d1bfdd7cdff52af1849379b7e6d

data/README.md

@@ -156,6 +156,32 @@ module Maintenance
 end
 ```
 
+#### Customizing the Batch Size
+
+When processing records from an Active Record Relation, records are fetched in
+batches internally, and then each record is passed to the `#process` method.
+Maintenance Tasks will query the database to fetch records in batches of 100 by
+default, but the batch size can be modified using the `collection_batch_size` macro:
+
+```ruby
+# app/tasks/maintenance/update_posts_task.rb
+
+module Maintenance
+  class UpdatePostsTask < MaintenanceTasks::Task
+    # Fetch records in batches of 1000
+    collection_batch_size(1000)
+
+    def collection
+      Post.all
+    end
+
+    def process(post)
+      post.update!(content: "New content!")
+    end
+  end
+end
+```
+
 ### Creating a CSV Task
 
 You can also write a Task that iterates on a CSV file. Note that writing CSV
@@ -497,7 +523,10 @@ end
 
 ### Subscribing to instrumentation events
 
-If you are interested in actioning a specific task event, please refer to the [Using Task Callbacks](#using-task-callbacks) section below. However, if you want to subscribe to all events, irrespective of the task, you can use the following Active Support notifications:
+If you are interested in actioning a specific task event, please refer to the
+[Using Task Callbacks](#using-task-callbacks) section below. However, if you
+want to subscribe to all events, irrespective of the task, you can use the
+following Active Support notifications:
 
 ```ruby
 enqueued.maintenance_tasks    # This event is published when a task has been enqueued by the user.
@@ -507,7 +536,8 @@ paused.maintenance_tasks      # This event is published when a task is paused by
 errored.maintenance_tasks     # This event is published when the task's code produces an unhandled exception.
 ```
 
-These notifications offer a way to monitor the lifecycle of maintenance tasks in your application.
+These notifications offer a way to monitor the lifecycle of maintenance tasks in
+your application.
 
 Usage example:
 
@@ -723,9 +753,9 @@ end
 ### Writing tests for a Task that uses a custom enumerator
 
 Tests for tasks that use custom enumerators need to instantiate the task class
-in order to call `#build_enumerator`. Once the task instance is set up, validate
-that `#build_enumerator` returns an enumerator yielding pairs of [item, cursor]
-as expected.
+in order to call `#enumerator_builder`. Once the task instance is set up,
+validate that `#enumerator_builder` returns an enumerator yielding pairs of
+`[item, cursor]` as expected.
 
 ```ruby
 # test/tasks/maintenance/custom_enumerating_task.rb
@@ -738,8 +768,8 @@ module Maintenance
       @task = CustomEnumeratingTask.new
     end
 
-    test "#build_enumerator returns enumerator yielding pairs of [item, cursor]" do
-      enum = @task.build_enumerator(cursor: 0)
+    test "#enumerator_builder returns enumerator yielding pairs of [item, cursor]" do
+      enum = @task.enumerator_builder(cursor: 0)
       expected_items = [:b, :c]
 
       assert_equal 2, enum.size

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

@@ -32,13 +32,16 @@ module MaintenanceTasks
 
     def build_enumerator(_run, cursor:)
       cursor ||= @run.cursor
+      self.cursor_position = cursor
       @collection_enum = @task.enumerator_builder(cursor: cursor)
 
       @collection_enum ||= case (collection = @task.collection)
       when :no_collection
         enumerator_builder.build_once_enumerator(cursor: nil)
       when ActiveRecord::Relation
-        enumerator_builder.active_record_on_records(collection, cursor: cursor, columns: @task.cursor_columns)
+        options = { cursor: cursor, columns: @task.cursor_columns }
+        options[:batch_size] = @task.active_record_enumerator_batch_size if @task.active_record_enumerator_batch_size
+        enumerator_builder.active_record_on_records(collection, **options)
       when ActiveRecord::Batches::BatchEnumerator
         if collection.start || collection.finish
           raise ArgumentError, <<~MSG.squish
@@ -163,6 +166,7 @@ module MaintenanceTasks
     end
 
     def on_error(error)
+      task_context = {}
       @ticker.persist if defined?(@ticker)
 
       if defined?(@run)
@@ -174,8 +178,6 @@ module MaintenanceTasks
           started_at: @run.started_at,
           ended_at: @run.ended_at,
         }
-      else
-        task_context = {}
       end
       errored_element = @errored_element if defined?(@errored_element)
     ensure

data/app/models/maintenance_tasks/task.rb

@@ -18,6 +18,12 @@ module MaintenanceTasks
     # @api private
     class_attribute :throttle_conditions, default: []
 
+    # The number of active records to fetch in a single query when iterating
+    # over an Active Record collection task.
+    #
+    # @api private
+    class_attribute :active_record_enumerator_batch_size
+
     # @api private
     class_attribute :collection_builder_strategy, default: NullCollectionBuilder.new
 
@@ -79,6 +85,7 @@ module MaintenanceTasks
         end
 
         csv_options[:headers] = true unless csv_options.key?(:headers)
+        csv_options[:encoding] ||= Encoding.default_external
         self.collection_builder_strategy = if in_batches
           BatchCsvCollectionBuilder.new(in_batches, **csv_options)
         else
@@ -137,6 +144,14 @@ module MaintenanceTasks
         self.throttle_conditions += [{ throttle_on: condition, backoff: backoff_as_proc }]
       end
 
+      # Limit the number of records that will be fetched in a single query when
+      # iterating over an Active Record collection task.
+      #
+      # @param size [Integer] the number of records to fetch in a single query.
+      def collection_batch_size(size)
+        self.active_record_enumerator_batch_size = size
+      end
+
       # Initialize a callback to run after the task starts.
       #
       # @param filter_list apply filters to the callback

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

@@ -44,7 +44,7 @@
 
     <h4 class="title is-4">Active Runs</h4>
 
-    <%= render @task.active_runs %>
+    <%= render partial: "maintenance_tasks/runs/run", collection: @task.active_runs %>
   <% end %>
 
   <% if @runs_page.records.present? %>
@@ -52,7 +52,7 @@
 
     <h4 class="title is-4">Previous Runs</h4>
 
-    <%= render @runs_page.records %>
+    <%= render partial: "maintenance_tasks/runs/run", collection: @runs_page.records %>
 
     <%= link_to "Next page", task_path(@task, cursor: @runs_page.next_cursor) unless @runs_page.last? %>
   <% end %>

data/lib/generators/maintenance_tasks/install_generator.rb

@@ -10,7 +10,7 @@ module MaintenanceTasks
 
     # Mounts the engine in the host application's config/routes.rb
     def mount_engine
-      route("mount MaintenanceTasks::Engine => \"/maintenance_tasks\"")
+      route("mount MaintenanceTasks::Engine, at: \"/maintenance_tasks\"")
     end
 
     # Copies engine migrations to host application and migrates the database

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Shopify Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: job-iteration
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.2
-description: 
+description:
 email: gems@shopify.com
 executables:
 - maintenance_tasks
@@ -171,9 +185,9 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.7.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.8.0
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks
 test_files: []