canvas_sync 0.22.0.beta7 → 0.22.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460a37fe879ff078150579638df606c33dfd35870b69955c42dc7bee7afb4833
-  data.tar.gz: e02f9568f6d80f0f0bf4ab6ff21800ed8bcd36d5cd1803f03cf6a186b3fda690
+  metadata.gz: d547f65f6811b0e9016de79ad87cff6789a82bc1d02b100c0280a6591a7b44c5
+  data.tar.gz: 12bc5403297ceb4b13b1c29003f7ca8349b2ca4c7f54236fcc44c306d8cd56fc
 SHA512:
-  metadata.gz: 1a08031744764b9f14a8da562ffee5ca83a85e4efa9b5a5b9725605cce53853b90d3dfd9b01bb5ec5ac5aeb248bc6be88fe07b1de9b5b2e5b0b6c4d25d8cd942
-  data.tar.gz: a71f36915f50bbb74dc746ac2f9c7a8f3489995f8dc67648a58ceb20e85cd71c17072b7b967e415c1be4d3f349c378afcc7b1ed132e2682711cca1c98958d7bc
+  metadata.gz: f6e4f2cb3de6d071837e29fbdbafa2f628018d82f302658e0a24a181bb2d5c00557372972c77ef924a6243f8e2fd861ef6a9488c25e2018092265398b589d303
+  data.tar.gz: 7b21c43a71b7c44674e89afcd0b55996ccac7dae346fc917304e95be9d01870580a46b117ff241e81fa1fde10594e6fc1c12d8f0b16be7cf6295fa1bebb04461

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

@@ -19,7 +19,7 @@ module CanvasSync::JobUniqueness
 
       class SidekiqLockContext < LockContext
         def job_scheduled_at
-          @job_instance["at"]
+          @job_instance&.[]("at")
         end
 
         def reenqueue(schedule_in:)

data/lib/canvas_sync/job_uniqueness/lock_context.rb

@@ -6,18 +6,23 @@ module CanvasSync::JobUniqueness
       context_class.new(data, **kwargs)
     end
 
+    attr_reader :lock_id
+
     # { job_clazz, jid, queue, args?, kwargs?, base_key? }
     def initialize(data, job_instance: nil, config: nil)
       @base_key = data[:base_key]
       @context_data = data
       @job_instance = job_instance
       @config = config || @context_data[:config]
+
+      @lock_id ||= data[:lid] || Thread.current[:unique_jobs_previous_context]&.lock_id || job_id
     end
 
     # This is primarily for rehydrating in a Batch Callback, so it is unlikely that args and kwargs are needed.
     # Honestly, base_key and job_clazz are probably the only needed values
     def serialize
       {
+        lid: lock_id,
         clazz: self.class.to_s,
         job_clazz: @context_data[:job_clazz].to_s,
         jid: @context_data[:jid],
@@ -29,6 +34,7 @@ module CanvasSync::JobUniqueness
     # Properties to cache on the serialized Job object to prevent issues arising from code changes between enqueue and perform
     def cache_data
       {
+        lid: lock_id,
         base_key: base_key,
         job_score: job_score,
         # TODO Should config also be cached on the Job at time of enqueue?

data/lib/canvas_sync/job_uniqueness/locksmith.rb

@@ -14,7 +14,9 @@ module CanvasSync::JobUniqueness
 
     def initialize(key, lock_context, redis_pool = nil)
       @lock_context = lock_context
-      @job_id = lock_context.job_id
+      # We use the "lock_id" (which is just the first JID that a job appeared as) so that Unlock batches may properly unlock the batch
+      # TODO For locks that do use a wrapping Batch, it may be nice to use the BID here instead
+      @job_id = lock_context.lock_id
       @item = lock_context
       @key = SidekiqUniqueJobs::Key.new(key)
 
@@ -28,7 +30,7 @@ module CanvasSync::JobUniqueness
         :"limit" => lcfg[:limit],
       })
 
-      @redis_pool  = redis_pool
+      @redis_pool = redis_pool
     end
 
     def locked_jids

data/lib/canvas_sync/job_uniqueness/on_conflict/reschedule.rb

@@ -4,12 +4,12 @@ module CanvasSync::JobUniqueness
       valid_for :perform
 
       def call
-        Thread.current[:unique_jobs_previous_jid] = lock_context.job_id
+        Thread.current[:unique_jobs_previous_context] = lock_context
         rescheduled = lock_context.reenqueue(
           schedule_in: schedule_in,
         )
       ensure
-        Thread.current[:unique_jobs_previous_jid] = nil
+        Thread.current[:unique_jobs_previous_context] = nil
       end
 
       def schedule_in

data/lib/canvas_sync/job_uniqueness/strategy/base.rb

@@ -43,7 +43,7 @@ module CanvasSync::JobUniqueness
       end
 
       def wrap_in_batch(&blk)
-        if Thread.current[:unique_jobs_previous_jid] # Ensure we don't re-wrap in a batch when rescheduling
+        if Thread.current[:unique_jobs_previous_context] # Ensure we don't re-wrap in a batch when rescheduling
           return blk.call
         end
 
@@ -74,7 +74,7 @@ module CanvasSync::JobUniqueness
         CanvasSync::JobUniqueness.logger.debug("Context data: #{opts[:lock_context]}")
         strategy_class = opts[:lock_strategy].constantize
         lock_context = LockContext.from_serialized(opts[:lock_context])
-        CanvasSync::JobUniqueness.logger.debug("Rehydrated LockContext: #{lock_context.job_id} #{lock_context.debug_data}")
+        CanvasSync::JobUniqueness.logger.debug("Rehydrated LockContext: #{lock_context.lock_id} #{lock_context.debug_data}")
         strategy = strategy_class.new(lock_context)
         # TODO Should this route through LockContext#handle_lifecycle!?
         strategy.batch_callback(opts[:event].to_sym, batch_status)
@@ -83,13 +83,14 @@ module CanvasSync::JobUniqueness
       def lock!(purpose, wait: nil)
         locked = nil
         if purpose == :enqueue
-          if Thread.current[:unique_jobs_previous_jid].present?
-            locked = locksmith.swap_locks(Thread.current[:unique_jobs_previous_jid])
-          else
-            locked = locksmith.lock()
-          end
+          # We don't need to swap_locks anymore because we maintain a consistent lock_id across re-enqueues
+          # if Thread.current[:unique_jobs_previous_context].present?
+            # locked = locksmith.swap_locks(Thread.current[:unique_jobs_previous_context].job_id)
+          # else
+          locked = locksmith.lock()
+          # end
         elsif purpose == :perform
-          locked = locksmith.execute { lock_context.job_id }
+          locked = locksmith.execute { lock_context.lock_id }
         end
 
         CanvasSync::JobUniqueness.logger.debug { "Requested lock of #{key} for #{purpose} - (#{locked || 'Not Obtained!'})" }
@@ -98,7 +99,7 @@ module CanvasSync::JobUniqueness
       end
 
       def unlock()
-        CanvasSync::JobUniqueness.logger.debug { "Trying to unlock #{key} for JID #{lock_context.job_id}" }
+        CanvasSync::JobUniqueness.logger.debug { "Trying to unlock #{key} for LID #{lock_context.lock_id}" }
         result = locksmith.unlock
         CanvasSync::JobUniqueness.logger.debug { "Unlocked #{key} - (#{result || 'Not Unlocked!'})" }
       end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.22.0.beta7".freeze
+  VERSION = "0.22.0.beta8".freeze
 end

data/spec/job_uniqueness/on_conflict/reschedule_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe CanvasSync::JobUniqueness::OnConflict::Reschedule do
 
   it "calls reenqueue" do
     expect(lock_context).to receive(:reenqueue) do |*args, **kwargs|
-      expect(Thread.current[:unique_jobs_previous_jid]).to be_present
+      expect(Thread.current[:unique_jobs_previous_context]).to be_present
     end
     on_conflict.call
   end

data/spec/job_uniqueness/spec_helper.rb

@@ -1,6 +1,9 @@
 require_relative "../spec_helper"
 require "canvas_sync/job_uniqueness/job_uniqueness"
 
+require 'redis'
+Redis.silence_deprecations = true
+
 Dir[File.join(File.dirname(__FILE__), "./support/**/*.rb")].sort.each { |f| require f }
 
 Sidekiq::Testing.server_middleware do |chain|

data/spec/job_uniqueness/strategy/base_spec.rb

@@ -9,11 +9,11 @@ RSpec.describe CanvasSync::JobUniqueness::Strategy::Base do
 
   describe '#wrap_in_batch' do
     it 'does not wrap if re-enqueuing' do
-      Thread.current[:unique_jobs_previous_jid] = "j100"
+      Thread.current[:unique_jobs_previous_context] = context
       expect(CanvasSync::JobBatches::Batch).not_to receive(:new)
       strategy.send(:wrap_in_batch, &->{ })
     ensure
-      Thread.current[:unique_jobs_previous_jid] = nil
+      Thread.current[:unique_jobs_previous_context] = nil
     end
 
     context 'when the job fails' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.22.0.beta7
+  version: 0.22.0.beta8
 platform: ruby
 authors:
 - Instructure CustomDev