canvas_sync 0.22.0.beta8 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d547f65f6811b0e9016de79ad87cff6789a82bc1d02b100c0280a6591a7b44c5
-  data.tar.gz: 12bc5403297ceb4b13b1c29003f7ca8349b2ca4c7f54236fcc44c306d8cd56fc
+  metadata.gz: b659edf35a8c6f427f847142d4627920cc19effabfe7fb5ad2ccb960884cf47c
+  data.tar.gz: 3264f9b298a5fcbf251a6ccd927ce20133598ed1b9fdd8adf3a728ef90a4e080
 SHA512:
-  metadata.gz: f6e4f2cb3de6d071837e29fbdbafa2f628018d82f302658e0a24a181bb2d5c00557372972c77ef924a6243f8e2fd861ef6a9488c25e2018092265398b589d303
-  data.tar.gz: 7b21c43a71b7c44674e89afcd0b55996ccac7dae346fc917304e95be9d01870580a46b117ff241e81fa1fde10594e6fc1c12d8f0b16be7cf6295fa1bebb04461
+  metadata.gz: a9c7add460f50301b9f404880e9f6ac2fc57996f1e4c8928f2c52b9bfa5f4973f6cc3c531729763a40de6cce127b86aed70b88ea11fc2119e9fe1856f81a4996
+  data.tar.gz: 7d5951ebd7f02917344ea94c23d4f7e5d467d7d803be2944ab1d073aa207acca55a065aa8e2b9145f129154c1ed10b9fb2d14b0692c1e1d8ec21a99f042dab8a

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

@@ -45,7 +45,7 @@ module CanvasSync::JobBatches
 
         def call(_worker, msg, _queue, _redis_pool = nil)
           if (batch = Thread.current[CURRENT_BATCH_THREAD_KEY]) && should_handle_batch?(msg)
-            batch.increment_job_queue(msg['jid']) if (msg[:bid] = batch.bid)
+            batch.increment_job_queue(msg['jid']) if (msg['bid'] = batch.bid)
           end
           yield
         end

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

@@ -41,7 +41,7 @@ module CanvasSync::JobUniqueness
 
         def deserialize(data)
           super
-          @uniqueness_cache_data = data['uniqueness_cache_data'].symbolize_keys
+          @uniqueness_cache_data = data['uniqueness_cache_data']&.symbolize_keys
         end
 
         def uniqueness_lock_context

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

@@ -38,7 +38,7 @@ module CanvasSync::JobUniqueness
             queue: msg['queue'],
             args: msg['args'],
             # kwargs: msg['kwargs'],
-            **(msg['uniqueness_cache_data'] || {}),
+            **(msg['uniqueness_cache_data']&.symbolize_keys || {}),
           }, job_instance: msg)
         end
 
@@ -58,7 +58,7 @@ module CanvasSync::JobUniqueness
         def call(_worker, msg, _queue, _redis_pool = nil, &blk)
           ctx = lock_context(msg)
           return blk.call unless ctx
-          msg['uniqueness_cache_data'] = ctx.cache_data
+          msg['uniqueness_cache_data'] = ctx.cache_data.stringify_keys
           ctx.handle_lifecycle!(:enqueue, &blk)
         end
       end

data/lib/canvas_sync/job_uniqueness/lock_context.rb

@@ -15,11 +15,11 @@ module CanvasSync::JobUniqueness
       @job_instance = job_instance
       @config = config || @context_data[:config]
 
+      # TODO Consider (somewhere) updating the lock_id to the BID of the wrapping Batch (when applicable)
       @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,
@@ -44,6 +44,7 @@ module CanvasSync::JobUniqueness
 
     def debug_data
       {
+        lid: lock_id,
         context_class: self.class.to_s,
         job_class: job_class.to_s,
         queue: job_queue,
@@ -152,7 +153,6 @@ module CanvasSync::JobUniqueness
     # @yieldreturn [void] the yield is irrelevant, it only provides a mechanism in
     #   one specific situation to yield back to the middleware.
     def call_conflict_strategy(origin)
-      new_job_id = nil
       strategy = conflict_strategy_for(origin)
 
       strategy.call

data/lib/canvas_sync/job_uniqueness/locksmith.rb

@@ -14,9 +14,7 @@ module CanvasSync::JobUniqueness
 
     def initialize(key, lock_context, redis_pool = nil)
       @lock_context = lock_context
-      # 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
+      @job_id = lock_context.lock_id # Yes, .lock_id is intentional
       @item = lock_context
       @key = SidekiqUniqueJobs::Key.new(key)
 

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

@@ -62,7 +62,7 @@ module CanvasSync::JobUniqueness
           })
         end
 
-        CanvasSync::JobUniqueness.logger.debug("Wrapped job in Locking Batch #{batch.bid} for #{key}")
+        CanvasSync::JobUniqueness.logger.debug("Wrapped job (#{lock_context.lock_id}) in Locking Batch #{batch.bid} for #{key}")
 
         batch.jobs do
           return blk.call
@@ -83,12 +83,7 @@ module CanvasSync::JobUniqueness
       def lock!(purpose, wait: nil)
         locked = nil
         if purpose == :enqueue
-          # 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.lock_id }
         end

data/lib/canvas_sync/version.rb

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

data/spec/job_batching/compat/sidekiq_spec.rb

@@ -74,7 +74,7 @@ RSpec.describe CanvasSync::JobBatches::Compat::Sidekiq do
       it 'assigns bid to msg' do
         msg = { 'jid' => jid }
         subject.call(nil, msg, nil) {}
-        expect(msg[:bid]).to eq(bid)
+        expect(msg['bid']).to eq(bid)
       end
     end
   end

data/spec/job_uniqueness/on_conflict/reschedule_spec.rb

@@ -21,4 +21,43 @@ RSpec.describe CanvasSync::JobUniqueness::OnConflict::Reschedule do
     lock_context2.handle_lifecycle!(:enqueue) {}
     lock_context2.handle_lifecycle!(:perform) {}
   end
+
+  it "maintains a consistent lock_id" do
+    TestWorker.clear
+    TestWorker.unique_job_options.merge!({ strategy: :while_executing, on_conflict: :reschedule })
+
+    lock_context.handle_lifecycle!(:enqueue) {}
+    lock_context.handle_lifecycle!(:perform) {}
+
+    TestWorker.perform_async
+    j1 = TestWorker.jobs[0]
+    TestWorker.perform_one
+    j2 = TestWorker.jobs[0]
+
+    expect(j1).not_to eq(j2)
+    expect(j1['uniqueness_cache_data']['lid']).to be_present
+    expect(j1['uniqueness_cache_data']['lid']).to eq(j2['uniqueness_cache_data']['lid'])
+  end
+
+  it "unlocks after rescheduling" do
+    TestWorker.clear
+    TestWorker.unique_job_options.merge!({ strategy: :while_executing, on_conflict: :reschedule })
+
+    lock_context.handle_lifecycle!(:enqueue) {}
+    lock_context.handle_lifecycle!(:perform) {}
+
+    TestWorker.perform_async
+    expect(TestWorker.jobs.size).to eq(1)
+    TestWorker.perform_one
+    expect(TestWorker.jobs.size).to eq(1)
+
+    lock_context.lock_strategy.send(:unlock)
+    Sidekiq::Worker.drain_all
+    expect(TestWorker.jobs.size).to eq(0)
+
+    # Run another worker to validate that the lock was released
+    TestWorker.perform_async
+    TestWorker.perform_one
+    expect(TestWorker.jobs.size).to eq(0)
+  end
 end

data/spec/job_uniqueness/spec_helper.rb

@@ -7,7 +7,7 @@ Redis.silence_deprecations = true
 Dir[File.join(File.dirname(__FILE__), "./support/**/*.rb")].sort.each { |f| require f }
 
 Sidekiq::Testing.server_middleware do |chain|
-  chain.insert_before CanvasSync::JobBatches::Compat::Sidekiq::ServerMiddleware, CanvasSync::JobUniqueness::Compat::Sidekiq::ServerMiddleware
+  chain.insert_after CanvasSync::JobBatches::Compat::Sidekiq::ServerMiddleware, CanvasSync::JobUniqueness::Compat::Sidekiq::ServerMiddleware
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.22.0.beta8
+  version: 0.22.0
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -870,9 +870,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: