maintenance_tasks 2.13.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8402f1f4b8919e892a6334373ad397d49b5c6c78893f2f107b990b90653435d1
-  data.tar.gz: 1459d5b92233a1196aeb83c80bec9da525f04e975a50f6a415cdcd8dc647bd59
+  metadata.gz: f74ab248a9b57875d5e7b47234598a46fbc37033fb7d96c95e26b03c55d83793
+  data.tar.gz: cf2322966430eee4215131e9885aba07591d2e6f5081f6ab1683188ae5be8e80
 SHA512:
-  metadata.gz: 3dff16b85a650f4d73cf79df20267d1278b1181f2ba6717742581909ebfd39145dfdd9b9cf1453edaa785474fb6f7dda87af2bad534e6398bf010945b02f2da3
-  data.tar.gz: c7b75c1edc684fad66c5080ee3642fe469038e1f4ab2329ead0fd3c65e5f0ca2a940250dc988658dce672e2de0d056741b9a317310afa23165ba27794722ce1d
+  metadata.gz: 22bde697fa7b38899ff5dc4c7fc353776a29766f479a3fac4f988b921aaf62bd58534f55a2c9caa1b9bf227ddbbef249c1d521b863afc5ab59527ad32528a4e9
+  data.tar.gz: 1f51f3e1ead4af15d02886b950562e0a103baf055839e1e5e6f661b2dfd29d47626859fbd350e8d311293c88d4b4f59189ae70e32a8dbca54559d75ce5fafaa5

data/README.md

@@ -242,8 +242,8 @@ seconds to process. Consider skipping the count (defining a `count` that returns
 `nil`) or use an approximation, eg: count the number of new lines:
 
 ```ruby
-def count(task)
-  task.csv_content.count("\n") - 1
+def count
+  csv_content.count("\n") - 1
 end
 ```
 
@@ -391,7 +391,10 @@ This method should return an `Enumerator`, yielding pairs of `[item, cursor]`.
 Maintenance Tasks takes care of persisting the current cursor position and will
 provide it as the `cursor` argument if your task is interrupted or resumed. The
 `cursor` is stored as a `String`, so your custom enumerator should handle
-serializing/deserializing the value if required.
+serializing/deserializing the value if required. Note that if you've enabled
+[JSON cursors](#json-cursors), the cursor will be automatically serialized and
+deserialized. However for this to work, the cursor values must be
+JSON-serializable.
 
 ```ruby
 # app/tasks/maintenance/custom_enumerator_task.rb
@@ -561,6 +564,9 @@ control the cursor columns, through the `cursor_columns` method in the
 the query is ordered by the primary key. If cursor columns values change during
 an iteration, records may be skipped or yielded multiple times.
 
+Note that in order to use this feature, you must first enable
+[JSON cursors](#json-cursors).
+
 ```ruby
 module Maintenance
   class UpdatePostsTask < MaintenanceTasks::Task
@@ -1317,6 +1323,46 @@ MaintenanceTasks.metadata = ->() do
 end
 ```
 
+#### JSON Cursors
+
+By default, cursor values are persisted in the database as a string. If you
+want to iterate over collections that require multiple values to keep track of
+the position, you can enable JSON cursors. This will cause the cursor to be
+serialized as JSON when persisted, and deserialized when read back.
+
+This is especially useful when you need to iterate over a model that uses a
+composite primary key.
+
+Be advised that this feature comes with a few caveats:
+
+1. Cursor values must be capable of being serialized to JSON and parsed from
+   JSON. If they are not, errors will occur during task execution.
+2. If a cursor contains a value that loses precision when serialized, it may
+   lead to unexpected behaviour.
+3. This feature utilizes a string column to store the JSON data. If your
+   database has a hard limit on how big a string value can be, be mindful that
+   certain cursor structures could result in a value that could exceed that
+   limit and cause issues.
+
+A new column was added to discern JSON cursors from plain string cursors. Make
+sure you have run the latest database migrations provided by the gem before
+enabling this feature. See [upgrading](#upgrading) for more information.
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+MaintenanceTasks.serialize_cursors_as_json = true
+```
+
+#### Configure staleness threshold
+
+To specify a staleness threshold date interval which will mark task runs as stale, you can
+configure `MaintenanceTasks.task_staleness_threshold`. Tasks that have last run
+successfully after this threshold will be marked stale.
+
+The value for `MaintenanceTasks.task_staleness_threshold` must be an
+`ActiveSupport::Duration`. If no value is specified, it will default to 30 days. This can be disabled
+by setting `MaintenanceTasks.task_staleness_threshold` to `false`.
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -11,7 +11,7 @@ module MaintenanceTasks
       policy.style_src_elem(
         BULMA_CDN,
         # <style> tag in app/views/layouts/maintenance_tasks/application.html.erb
-        "'sha256-WHHDQLdkleXnAN5zs0GDXC5ls41CHUaVsJtVpaNx+EM='",
+        "'sha256-b9tTK1UaF0U8792/A1vIUkeZwjPgECIOeKJdhYED06A='",
       )
       capybara_lockstep_scripts = [
         "'sha256-1AoN3ZtJC5OvqkMgrYvhZjp4kI8QjJjO7TAyKYiDw+U='",

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -62,7 +62,7 @@ module MaintenanceTasks
     def status_tag(status)
       tag.span(
         status.capitalize,
-        class: ["tag", "has-text-weight-medium", "pr-2", "mr-4"] + STATUS_COLOURS.fetch(status),
+        class: ["tag", "has-text-weight-medium", "px-2", "mx-4"] + STATUS_COLOURS.fetch(status),
       )
     end
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 module MaintenanceTasks
   # Concern that holds the behaviour of the job that runs the tasks. It is
   # included in {TaskJob} and if MaintenanceTasks.job is overridden, it must be
@@ -30,8 +32,18 @@ module MaintenanceTasks
 
     private
 
+    def serialized_cursor_position
+      cursor_position && @run.cursor_is_json? ? cursor_position.to_json : cursor_position
+    end
+
+    def deserialized_run_cursor
+      return JSON.parse(@run.cursor) if @run.cursor && @run.cursor_is_json?
+
+      @run.cursor
+    end
+
     def build_enumerator(_run, cursor:)
-      cursor ||= @run.cursor
+      cursor ||= deserialized_run_cursor
       self.cursor_position = cursor
       enumerator_builder = self.enumerator_builder
       @collection_enum = @task.enumerator_builder(cursor: cursor)
@@ -140,7 +152,7 @@ module MaintenanceTasks
 
     def on_shutdown
       @run.job_shutdown
-      @run.cursor = cursor_position
+      @run.cursor = serialized_cursor_position
       @ticker.persist
     end
 
@@ -177,7 +189,7 @@ module MaintenanceTasks
       @ticker.persist if defined?(@ticker)
 
       if defined?(@run)
-        @run.cursor = cursor_position
+        @run.cursor = serialized_cursor_position
         @run.persist_error(error)
 
         task_context = {