canvas_sync 0.22.0.beta1 → 0.22.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfdaa60184f19d01fd1609144d0b3bf07d4cb0c1f186f4057951a0be52830baa
-  data.tar.gz: 96a9be57f09b9eedaaf03ad1b6470a77f3ff23b6d5368ef728e1185eb649a9fa
+  metadata.gz: f694edf9c88f7441ccdb66d6a58f4ed31701c56682c70af20f5e7fbaf2c829b3
+  data.tar.gz: a3438e037e06694ce521d289cfab8598b9d5fc8c76e2bc553d938f1515287a8e
 SHA512:
-  metadata.gz: b10a559f1afbe287584d82e4a345c2929372327ba719d930f751a0bd03a365e170f11b117cf063eb8d0c816e98a9a8dc2d0bb4271628a9d697511bd062c8011a
-  data.tar.gz: b3a9ef0cbc3234852b4f2a5e6afbb909e2cbc0b184e330f665dda6d1ee8c165fe2f07fc555f0f6e49d65d219da8745ef816eadf1bde4bedf4131c93f2d7a8fb3
+  metadata.gz: 89f0c9f0dc1a0cca1d74771085712e6f6e6a5acf75979beaa06bd2d2e0db2092769547abb8debee12bd98e025bc1b34ef4ebfb75bf991b8bc7ed9ee752d19196
+  data.tar.gz: d7095273e6e299ee1b1d1e6089e451c6a3dd86e37e87e39401c112e91754c708243e226ae7116a768ad868bb54f4ce3aeb9b10d3736b179c6c2e2a67d6e1edf2

data/lib/canvas_sync/job_uniqueness/compat/active_job.rb

@@ -11,7 +11,7 @@ module CanvasSync::JobUniqueness
         def reenqueue(schedule_in:)
           job_class.set(
             queue: job_queue.to_sym,
-            set: schedule_in,
+            wait: schedule_in,
             priortity: job_instance.priority,
           ).perform_later(*job_instance.arguments)
         end

data/lib/canvas_sync/job_uniqueness/on_conflict.rb

@@ -8,9 +8,30 @@ module CanvasSync::JobUniqueness
     autoload :NullStrategy
     autoload :Raise
     autoload :Reject
-    # autoload :Replace
     autoload :Reschedule
 
+    # Replace is... hard. It involves hacking into some of the inner workings of Sidekiq and/or ActiveJob.
+    # The best solution would be to somehow mark the previously-scheduled job as dead and let it be picked up by workers but not invoke
+    #   its perform method (technically this would mess with success numbers, but does anybody really care about those?).
+    # Replace will also conflict with the UntilExecuted strategy as it wouldn't be able to replace a job that has begun executing.
+    #
+    # Replace is useful for two cases:
+    #   1. Moving the job to the back of the queue, eg for debouncing purposes
+    #   2. Replacing non-hashed params with updated values
+    # A solution to (2) would be to store the latest params outside of the Job params - eg in the DB or in Redis directly.
+    # (1) is solvebale in a similar out-of-band way, but other, better solutions may exist as well
+    #
+    # If the param in question is a (eg) a list that you want to append to, you could:
+    #   Push to the list in Redis
+    #   Queue the job
+    #   (Push another param to the list in Redis)
+    #   (Re-enqueue the job, but it won't enqueue because it is locked)
+    #   When the job begins, it pulls all values from the field in Redis an processes
+    #   Adding more params from this point would allow another job to enqueue
+    #
+    # We may implement some tooling for this at some point, but for now the recommendation is to handle this yourself,
+    # autoload :Replace
+
     class << self
       def lookup(strategy)
         matching_strategy(strategy.to_s.camelize) ||

data/lib/canvas_sync/job_uniqueness/unique_job_common.rb

@@ -10,7 +10,7 @@ module CanvasSync::JobUniqueness
     class_methods do
       # ensure_uniqueness(
       #   strategy: :until_executed, # :until_executed, :until_executing, :until_expired, :until_and_while_executing, :while_executing
-      #   on_conflict: :raise, # :raise, :replace, :log, :reject, :reschedule, { enqueue: ..., perform: ... }, proc
+      #   on_conflict: :raise, # :raise, :log, :reject, :reschedule, { enqueue: ..., perform: ... }, proc
       #   lock_ttl: 7.days, # seconds
       #   lock_timeout: 0, # seconds
 
@@ -32,7 +32,7 @@ module CanvasSync::JobUniqueness
         begin
           require "sidekiq_unique_jobs"
         rescue LoadError
-          raise LoadError, "SidekiqUniqueJobs is required for ensure_uniqueness"
+          raise LoadError, "sidekiq-unique-jobs is required for ensure_uniqueness"
         end
 
         OnConflict.validate!(kwargs[:on_conflict], kwargs[:strategy]) if kwargs[:on_conflict].present?

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.22.0.beta1".freeze
+  VERSION = "0.22.0.beta2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.22.0.beta1
+  version: 0.22.0.beta2
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails