canvas_sync 0.22.1 → 0.22.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55ef789158e71984651c554186f25c0206632712483cb1f196f0f772183641f
-  data.tar.gz: e88f323145871f95d6979bd4c089fd9c993a5118e2075feb0e96257b96dad8ed
+  metadata.gz: cc62b25843e2b3e57b83e1ca41b4a0e546666ce6e824a8a799f534ee90fb28c5
+  data.tar.gz: 1fb1747c3882282894b0aa4e6fef9d7240977a453da6415e3a31460c55833306
 SHA512:
-  metadata.gz: 34e5d02b710c1252657dd7d675b85d085a69bc6c03b0e52285f7264f5c7f5119113c6164bb148979eabf8a1c24be6f1f781ff28b61f9faf0aed331321369e598
-  data.tar.gz: 74f7b996899e7e4d45f74f04aabf2d098f0531c0bbae5594cfbc604661d0762aa765a9ea4d94358ebc40cbbfaeef1dfb5219c4ab8eb2be50cd3044290b7139e9
+  metadata.gz: 3ac70536bc476c02ee262487ff7074493e99c05d585cec78a32cddb5569feb9e5ca6407a7104cf7538ed9030e4cb2401be823171de5f5e261de5bd2aeafbc11f
+  data.tar.gz: 31178103ff1168d6a54b622c612260857c4f5841dff32c637a95877a1df3f7c4467221e05c19e7688f1ebf3284d79cc8cf5113208f89ac4299983dcaa2ccf51d

data/lib/canvas_sync/job_batches/batch.rb

@@ -98,30 +98,14 @@ module CanvasSync::JobBatches
     def jobs
       raise NoBlockGivenError unless block_given?
 
-      if !@existing && !@initialized
-        parent_bid = Thread.current[CURRENT_BATCH_THREAD_KEY]&.bid
+      persist!
 
-        redis.multi do |r|
-          r.hset(@bidkey, "parent_bid", parent_bid.to_s) if parent_bid
-          r.expire(@bidkey, BID_EXPIRE_TTL)
-
-          if parent_bid
-            r.hincrby("BID-#{parent_bid}", "children", 1)
-            r.expire("BID-#{parent_bid}", BID_EXPIRE_TTL)
-            r.zadd("BID-#{parent_bid}-bids", created_at, bid)
-          else
-            r.zadd("BID-ROOT-bids", created_at, bid)
-          end
-        end
-
-        flush_pending_attrs
-        @context&.save!
-
-        @initialized = true
-      else
-        assert_batch_is_open
-      end
+      # TODO This keep_open! block is probably desired, but it has some caveats:
+      #  - Old logic didn't auto-clean empty batches
+      #  - Could be an issue if the Thread crashes at a bad moment (do we even need to plan for this?)
+      #  - Technically there could be a race condition without it, but such hasn't been observed
 
+      # keep_open! do
       begin
         parent = Thread.current[CURRENT_BATCH_THREAD_KEY]
         Thread.current[CURRENT_BATCH_THREAD_KEY] = self
@@ -129,13 +113,16 @@ module CanvasSync::JobBatches
       ensure
         Thread.current[CURRENT_BATCH_THREAD_KEY] = parent
       end
+      # end
 
       nil
     end
 
-    def increment_job_queue(jid)
-      assert_batch_is_open
-      append_jobs([jid])
+    # Mark this Batch as a placeholder. It will be persisted to Redis, but no jobs will be added.
+    # From here, you can either use `.jobs` on the batch to add jobs as usual, or call `.let_close!` to allow cleanup to occur.
+    def placeholder!
+      # TODO Provide a stable `let_close!` token?
+      persist!
     end
 
     def invalidate_all
@@ -157,35 +144,36 @@ module CanvasSync::JobBatches
       batch.parent ? valid && valid?(batch.parent) : valid
     end
 
-    def keep_open!
+    def keep_open!(token = SecureRandom.urlsafe_base64(10))
       if block_given?
         begin
-          keep_open!
+          token = keep_open!(token)
           yield
         ensure
-          let_close!
+          let_close!(token)
         end
       else
-        redis.hset(@bidkey, 'keep_open', "true")
-      end
-    end
+        persist!
+
+        redis.multi do |r|
+          r.sadd("#{@bidkey}-holds", token)
+          r.expire("#{@bidkey}-holds", BID_EXPIRE_TTL)
+        end
 
-    def let_close!
-      _, failed, pending, children, complete, success = redis.multi do |r|
-        r.hset(@bidkey, 'keep_open', "false")
+        assert_batch_is_open
 
-        r.scard("BID-#{bid}-failed")
-        r.hincrby("BID-#{bid}", "pending", 0)
-        r.hincrby("BID-#{bid}", "children", 0)
-        r.scard("BID-#{bid}-batches-complete")
-        r.scard("BID-#{bid}-batches-success")
+        token
       end
+    end
 
-      all_success = pending.to_i.zero? && children == success
-      # if complete or successfull call complete callback (the complete callback may then call successful)
-      if (pending.to_i == failed.to_i && children == complete) || all_success
-        self.class.enqueue_callbacks(:complete, bid)
-        self.class.enqueue_callbacks(:success, bid) if all_success
+    def let_close!(token = :unset)
+      self.class.with_callback_check(bid, only: %i[complete success]) do |r|
+        if token == :unset # Legacy
+          r.del("#{@bidkey}-holds")
+          r.hset(@bidkey, 'keep_open', "false")
+        else
+          r.srem("#{@bidkey}-holds", token)
+        end
       end
     end
 
@@ -203,6 +191,23 @@ module CanvasSync::JobBatches
       with_batch(nil, &blk)
     end
 
+    def append_jobs(jids)
+      jids = Array(jids)
+      jids = jids.uniq
+      return unless jids.size > 0
+
+      redis do |r|
+        tme = Time.now.utc.to_f
+        added = r.zadd(@bidkey + "-jids", jids.map{|jid| [tme, jid] }, nx: true)
+        r.multi do |r|
+          r.hincrby(@bidkey, "pending", added)
+          r.hincrby(@bidkey, "job_count", added)
+          r.expire(@bidkey, BID_EXPIRE_TTL)
+          r.expire(@bidkey + "-jids", BID_EXPIRE_TTL)
+        end
+      end
+    end
+
     protected
 
     def redis_key
@@ -214,28 +219,34 @@ module CanvasSync::JobBatches
       redis.zadd("batches", created_at, bid) if INDEX_ALL_BATCHES
     end
 
-    private
-
     def assert_batch_is_open
       unless defined?(@closed)
-        @closed = redis.hget(@bidkey, 'success') == 'true'
+        @closed = redis.hget(@bidkey, 'complete') == 'true'
       end
       raise "Cannot add jobs to Batch #{} bid - it has already entered the callback-stage" if @closed
     end
 
-    def append_jobs(jids)
-      jids = jids.uniq
-      return unless jids.size > 0
+    def persist!
+      if !@existing && !@initialized
+        parent_bid = Thread.current[CURRENT_BATCH_THREAD_KEY]&.bid
 
-      redis do |r|
-        tme = Time.now.utc.to_f
-        added = r.zadd(@bidkey + "-jids", jids.map{|jid| [tme, jid] }, nx: true)
-        r.multi do |r|
-          r.hincrby(@bidkey, "pending", added)
-          r.hincrby(@bidkey, "job_count", added)
+        redis.multi do |r|
+          r.hset(@bidkey, "parent_bid", parent_bid.to_s) if parent_bid
           r.expire(@bidkey, BID_EXPIRE_TTL)
-          r.expire(@bidkey + "-jids", BID_EXPIRE_TTL)
+
+          if parent_bid
+            r.hincrby("BID-#{parent_bid}", "children", 1)
+            r.expire("BID-#{parent_bid}", BID_EXPIRE_TTL)
+            r.zadd("BID-#{parent_bid}-bids", created_at, bid)
+          else
+            r.zadd("BID-ROOT-bids", created_at, bid)
+          end
         end
+
+        flush_pending_attrs
+        @context&.save!
+
+        @initialized = true
       end
     end
 
@@ -269,6 +280,7 @@ module CanvasSync::JobBatches
             # Misc
             r.hget("BID-#{bid}", "parent_bid")
             r.hget("BID-#{bid}", "keep_open")
+            r.scard("BID-#{bid}-holds")
 
             # Jobs
             r.hincrby("BID-#{bid}", "pending", 0)
@@ -295,13 +307,18 @@ module CanvasSync::JobBatches
         # "failed" = dead or retrying
         # "complete" = successful or failed
 
-        parent_bid, keep_open, \
+        parent_bid, keep_open, holds, \
           pending_jobs, failed_jobs, dead_jobs, \
           child_batches, complete_batches, success_batches, failed_batches, stagnated_batches \
           = actual_results
 
         pending_batches = child_batches - success_batches
 
+        if keep_open == 'true' || (holds && holds > 0)
+          except << :complete
+          except << :success
+        end
+
         trigger_callback = ->(callback) {
           next if except.include?(callback.to_sym)
           next unless only.include?(callback.to_sym)
@@ -360,11 +377,10 @@ module CanvasSync::JobBatches
         batch_key = "BID-#{bid}"
         callback_key = "#{batch_key}-callbacks-#{event}"
 
-        callbacks, queue, parent_bid, callback_params = redis do |r|
-          return unless r.exists?(batch_key)
-          return if r.hget(batch_key, 'keep_open') == 'true'
-
+        exists, callbacks, queue, parent_bid, callback_params = redis do |r|
           r.multi do |r|
+            r.exists?(batch_key)
+
             r.smembers(callback_key)
             r.hget(batch_key, "callback_queue")
             r.hget(batch_key, "parent_bid")
@@ -372,6 +388,8 @@ module CanvasSync::JobBatches
           end
         end
 
+        return unless exists
+
         queue ||= "default"
         parent_bid = !parent_bid || parent_bid.empty? ? nil : parent_bid # Basically parent_bid.blank?
 
@@ -460,20 +478,22 @@ module CanvasSync::JobBatches
 
       # Internal method to cleanup a Redis Hash and related keys
       def cleanup_redis_index_for(key, suffixes = [""])
-        if r.hget(k, "created_at").present?
-          r.multi do |r|
-            suffixes.each do |suffix|
-              r.expire(key + suffix, BID_EXPIRE_TTL)
+        redis do |r|
+          if r.hget(k, "created_at").present?
+            r.multi do |r|
+              suffixes.each do |suffix|
+                r.expire(key + suffix, BID_EXPIRE_TTL)
+              end
             end
-          end
-          false
-        else
-          r.multi do |r|
-            suffixes.each do |suffix|
-              r.unlink(key + suffix)
+            false
+          else
+            r.multi do |r|
+              suffixes.each do |suffix|
+                r.unlink(key + suffix)
+              end
             end
+            true
           end
-          true
         end
       end
 
@@ -481,14 +501,16 @@ module CanvasSync::JobBatches
       def cleanup_redis_index!
         suffixes = ["", "-callbacks-complete", "-callbacks-success", "-failed", "-dead", "-batches-success", "-batches-complete", "-batches-failed", "-bids", "-jids", "-pending_callbacks"]
 
-        cleanup_index = ->(index) {
-          r.zrangebyscore(index, "0", BID_EXPIRE_TTL.seconds.ago.to_i).each do |bid|
-            r.zrem(index, bid) if cleanup_redis_index_for("BID-#{bid}", suffixes)
-          end
-        }
+        redis do |r|
+          cleanup_index = ->(index) {
+            r.zrangebyscore(index, "0", BID_EXPIRE_TTL.seconds.ago.to_i).each do |bid|
+              r.zrem(index, bid) if cleanup_redis_index_for("BID-#{bid}", suffixes)
+            end
+          }
 
-        cleanup_index.call("BID-ROOT-bids")
-        cleanup_index.call("batches")
+          cleanup_index.("BID-ROOT-bids")
+          cleanup_index.("batches")
+        end
       end
 
       def redis(&blk)

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

@@ -28,7 +28,7 @@ module CanvasSync::JobBatches
           around_enqueue do |job, block|
             if (batch = Thread.current[CURRENT_BATCH_THREAD_KEY])
               @bid = batch.bid
-              batch.increment_job_queue(job_id) if @bid
+              batch.append_jobs(job_id) if @bid
             end
             block.call
           end

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.append_jobs(msg['jid']) if (msg['bid'] = batch.bid)
           end
           yield
         end

data/lib/canvas_sync/job_batches/jobs/managed_batch_job.rb

@@ -54,7 +54,7 @@ module CanvasSync::JobBatches
       root_batch.context["managed_batch_bid"] = man_batch_id if man_batch_id
 
       if concurrency < sub_jobs.count
-        root_batch.jobs {}
+        root_batch.placeholder!
         concurrency.times do
           perform_next_sequence_job(man_batch_id, skip_preflight: true)
         end
@@ -140,6 +140,13 @@ module CanvasSync::JobBatches
           Batch.new.tap do |batch|
             batch.description = "Managed Batch Fiber (#{man_batch_id})"
             batch.on(:success, "#{self.to_s}.job_succeeded_callback", managed_batch_id: man_batch_id)
+
+            if next_job[:chain_link].present?
+              # Annotate Batch with chain-step info
+              batch.context["csb:chain_link"] = next_job[:chain_link]
+              batch.on(:complete, "#{ChainBuilder.to_s}.chain_step_complete", chain_link: next_job[:chain_link])
+            end
+
             batch.jobs do
               ChainBuilder.enqueue_job(next_job)
             end

data/lib/canvas_sync/job_batches/pool.rb

@@ -42,7 +42,7 @@ module CanvasSync::JobBatches
         wrapper.description = "Pool Job Wrapper (PID: #{pid})"
         checkin_event = (on_failed_job == :wait) ? :success : :complete
         wrapper.on(checkin_event, "#{self.class.to_s}.job_checked_in", pool_id: pid)
-        wrapper.jobs {}
+        wrapper.placeholder!
 
         job_desc = job_desc.symbolize_keys
         job_desc = job_desc.merge!(
@@ -55,21 +55,31 @@ module CanvasSync::JobBatches
       refill_allotment unless skip_refill
     end
 
-    def keep_open!
+    def keep_open!(token = SecureRandom.urlsafe_base64(10))
       if block_given?
         begin
-          keep_open!
+          token = keep_open!(token)
           yield
         ensure
-          let_close!
+          let_close!(token)
         end
       else
-        redis.hset(redis_key, 'keep_open', 'true')
+        redis.multi do |r|
+          r.sadd("#{redis_key}-holds", token)
+          r.expire("#{redis_key}-holds", Batch::BID_EXPIRE_TTL)
+        end
+        token
       end
     end
 
-    def let_close!
-      redis.hset(redis_key, 'keep_open', 'false')
+    def let_close!(token = :unset)
+      if token == :unset # Legacy
+        redis.del("#{redis_key}-holds")
+        redis.hset(redis_key, 'keep_open', 'false')
+      else
+        redis.srem("#{redis_key}-holds", token)
+      end
+
       cleanup_if_empty
     end
 
@@ -87,15 +97,16 @@ module CanvasSync::JobBatches
     def cleanup_if_empty
       self.order
 
-      activec, pactivec, pendingc, clean_when_empty, keep_open = redis.multi do |r|
+      activec, pactivec, pendingc, clean_when_empty, keep_open, holds = redis.multi do |r|
         r.hlen("#{redis_key}-active")
         r.hget(redis_key, "_active_count")
         pending_count(r)
         r.hget(redis_key, 'clean_when_empty')
         r.hget(redis_key, 'keep_open')
+        r.scard("#{redis_key}-holds")
       end
 
-      return if keep_open == 'true' || clean_when_empty == 'false'
+      return if keep_open == 'true' || clean_when_empty == 'false' || (holds && holds > 0)
 
       if activec <= 0 && (pactivec.try(:to_i) || 0) <= 0 && pendingc <= 0
         cleanup_redis

data/lib/canvas_sync/job_uniqueness/lock_context.rb

@@ -122,14 +122,27 @@ module CanvasSync::JobUniqueness
 
         args = @context_data[:args] || []
         kwargs = @context_data[:kwargs] || {}
+        hash = config[:hash]
         if config[:hash].is_a?(Proc)
-          base_key << config[:hash].call(*args, **kwargs)
+          hash = config[:hash].call(*args, **kwargs)
         elsif config[:hash].nil?
-          base_key << OpenSSL::Digest::MD5.hexdigest(JSON.dump([ args, kwargs.sort]))
-        else
-          base_key << config[:hash]
+          hash = [*args, kwargs]
         end
 
+        hash = ":#{hash}" if hash.is_a?(Symbol)
+
+        if hash && !hash.is_a?(String)
+          hash = Array(hash)
+
+          # Normalize the hash to ensure that the order of any Hash keys don't matter
+          hash = normalize_hash_chunk(hash)
+
+          normalized = ActiveJob::Arguments.serialize(hash)
+          hash = OpenSSL::Digest::MD5.hexdigest(JSON.dump(normalized))
+        end
+
+        base_key << hash if hash
+
         base_key.join(":")
       end
     end
@@ -173,5 +186,14 @@ module CanvasSync::JobUniqueness
 
     private
 
+    def normalize_hash_chunk(chunk)
+      if chunk.is_a?(Hash)
+        chunk.map { |k, v| [k, normalize_hash_chunk(v)] }.sort.to_h
+      elsif chunk.is_a?(Array)
+        chunk.map { |c| normalize_hash_chunk(c) }
+      else
+        chunk
+      end
+    end
   end
 end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.22.1".freeze
+  VERSION = "0.22.3".freeze
 end

data/spec/canvas_sync/jobs/sync_admins_job_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::SyncAdminsJob do
   describe '#perform' do
-    let!(:account) { FactoryGirl.create(:account, canvas_id: 1) }
+    let!(:account) { FactoryBot.create(:account, canvas_id: 1) }
     let(:admin_params) { open_canvas_fixture('admins') }
 
     it 'retrieves all admins from the Canvas API and then invokes the next job' do

data/spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
   describe '#perform' do
     context 'a term scope is specified' do
-      let!(:term) { FactoryGirl.create(:term) }
+      let!(:term) { FactoryBot.create(:term) }
 
       it 'enqueues a ReportStarter for a provisioning report for the specified models for each term' do
           expect_any_instance_of(CanvasSync::Jobs::ReportStarter).to receive(:start_report)

data/spec/canvas_sync/jobs/sync_roles_job_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::SyncRolesJob do
   describe '#perform' do
-    let!(:account) { FactoryGirl.create(:account, canvas_id: 1) }
+    let!(:account) { FactoryBot.create(:account, canvas_id: 1) }
     let(:role_params) { open_canvas_fixture('roles') }
 
     it 'retrieves all roles from the Canvas API and then invokes the next job' do

data/spec/canvas_sync/jobs/sync_simple_table_job_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe CanvasSync::Jobs::SyncSimpleTableJob do
   describe '#perform' do
     context 'Simple report' do
-      let!(:term) { FactoryGirl.create(:term) }
+      let!(:term) { FactoryBot.create(:term) }
 
       it 'enqueues a ReportStarter for a provisioning report for the specified model for a term' do
         expect(CanvasSync::Jobs::ReportStarter).to receive(:perform_later)

data/spec/canvas_sync/models/accounts_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Account, type: :model do
-  let(:subject) { FactoryGirl.create(:account) }
+  let(:subject) { FactoryBot.create(:account) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/admins_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Admin, type: :model do
-  let(:subject) { FactoryGirl.create(:admin) }
+  let(:subject) { FactoryBot.create(:admin) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }
@@ -26,7 +26,7 @@ RSpec.describe Admin, type: :model do
     end
 
     context 'the admin already exists' do
-      let!(:existing_admin) { FactoryGirl.create(:admin, canvas_id: admin_params['id']) }
+      let!(:existing_admin) { FactoryBot.create(:admin, canvas_id: admin_params['id']) }
 
       it 'updates it' do
         expect {

data/spec/canvas_sync/models/assignment_group_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe AssignmentGroup, type: :model do
-  let(:subject) { FactoryGirl.create(:assignment_group) }
+  let(:subject) { FactoryBot.create(:assignment_group) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/assignment_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe Assignment, type: :model do
-  let(:subject) { FactoryGirl.create(:assignment) }
+  let(:subject) { FactoryBot.create(:assignment) }
 
   describe "validations" do
     it { should validate_presence_of(:canvas_id) }
@@ -31,8 +31,8 @@ RSpec.describe Assignment, type: :model do
     it { should have_many(:context_modules).through(:context_module_items) }
 
     describe "context" do
-      let!(:other_course) { FactoryGirl.create(:course) }
-      let!(:matching_course) { FactoryGirl.create(:course) }
+      let!(:other_course) { FactoryBot.create(:course) }
+      let!(:matching_course) { FactoryBot.create(:course) }
 
       before do
         subject.update(canvas_context_type: "Course", canvas_context_id: matching_course.canvas_id)

data/spec/canvas_sync/models/context_module_item_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe ContextModuleItem, type: :model do
-  let(:subject) { FactoryGirl.create(:context_module_item) }
+  let(:subject) { FactoryBot.create(:context_module_item) }
 
   describe "associations" do
     it { should belong_to(:context_module) }

data/spec/canvas_sync/models/context_module_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe ContextModule, type: :model do
-  let(:subject) { FactoryGirl.create(:context_module) }
+  let(:subject) { FactoryBot.create(:context_module) }
 
   describe "associations" do
     it do

data/spec/canvas_sync/models/course_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Course, type: :model do
-  let(:subject) { FactoryGirl.create(:course) }
+  let(:subject) { FactoryBot.create(:course) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/enrollment_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Enrollment, type: :model do
-  let(:subject) { FactoryGirl.create(:enrollment) }
+  let(:subject) { FactoryBot.create(:enrollment) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/group_membership_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe GroupMembership, type: :model do
   let(:subject) {
-    FactoryGirl.create(:group_membership, group: FactoryGirl.create(:group), user: FactoryGirl.create(:user))
+    FactoryBot.create(:group_membership, group: FactoryBot.create(:group), user: FactoryBot.create(:user))
   }
 
   describe 'validations' do

data/spec/canvas_sync/models/group_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Group, type: :model do
-  let(:subject) { FactoryGirl.create(:group) }
+  let(:subject) { FactoryBot.create(:group) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/roles_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Role, type: :model do
-  let(:subject) { FactoryGirl.create(:role) }
+  let(:subject) { FactoryBot.create(:role) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }
@@ -27,7 +27,7 @@ RSpec.describe Role, type: :model do
     end
 
     context 'the role already exists' do
-      let!(:existing_role) { FactoryGirl.create(:role, canvas_id: role_params['id']) }
+      let!(:existing_role) { FactoryBot.create(:role, canvas_id: role_params['id']) }
 
       it 'updates it' do
         expect {

data/spec/canvas_sync/models/section_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Section, type: :model do
-  let(:subject) { FactoryGirl.create(:section) }
+  let(:subject) { FactoryBot.create(:section) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/submission_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe Submission, type: :model do
-  let(:subject) { FactoryGirl.create(:submission) }
+  let(:subject) { FactoryBot.create(:submission) }
 
   describe "validations" do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/models/term_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Term, type: :model do
-  let(:subject) { FactoryGirl.create(:term) }
+  let(:subject) { FactoryBot.create(:term) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }
@@ -18,10 +18,10 @@ RSpec.describe Term, type: :model do
 
   describe 'scopes' do
     describe '.active' do
-      let!(:active_term) { FactoryGirl.create(:term, workflow_state: 'active', start_at: 2.days.ago, end_at: 3.days.from_now) }
-      let!(:inactive_term) { FactoryGirl.create(:term, workflow_state: 'inactive') }
-      let!(:completed_term) { FactoryGirl.create(:term, start_at: 2.months.ago, end_at: 1.month.ago) }
-      let!(:unstarted_term) { FactoryGirl.create(:term, start_at: 6.months.from_now, end_at: 1.year.from_now) }
+      let!(:active_term) { FactoryBot.create(:term, workflow_state: 'active', start_at: 2.days.ago, end_at: 3.days.from_now) }
+      let!(:inactive_term) { FactoryBot.create(:term, workflow_state: 'inactive') }
+      let!(:completed_term) { FactoryBot.create(:term, start_at: 2.months.ago, end_at: 1.month.ago) }
+      let!(:unstarted_term) { FactoryBot.create(:term, start_at: 6.months.from_now, end_at: 1.year.from_now) }
 
       it 'returns terms with an active workflow_state that have a start_at 15 days in the future or earlier and an end_at 15 days in the past or later' do
         expect(Term.active).to match_array([active_term])
@@ -50,7 +50,7 @@ RSpec.describe Term, type: :model do
     end
 
     context 'the term already exists' do
-      let!(:existing_term) { FactoryGirl.create(:term, canvas_id: term_params['id']) }
+      let!(:existing_term) { FactoryBot.create(:term, canvas_id: term_params['id']) }
 
       it 'updates it' do
         expect {

data/spec/canvas_sync/models/user_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe User, type: :model do
-  let(:subject) { FactoryGirl.create(:user) }
+  let(:subject) { FactoryBot.create(:user) }
 
   describe 'validations' do
     it { should validate_presence_of(:canvas_id) }

data/spec/canvas_sync/services/module_event_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe LiveEvents::ModuleEvent do
 
   describe "#perform" do
     context "the module already exists" do
-      let!(:context_module) { FactoryGirl.create(:context_module, canvas_id: payload["body"][:module_id]) }
+      let!(:context_module) { FactoryBot.create(:context_module, canvas_id: payload["body"][:module_id]) }
 
       xit "updates it" do
         expect {

data/spec/canvas_sync/services/module_item_event_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe LiveEvents::ModuleItemEvent do
 
   describe "#perform" do
     context "the module item already exists" do
-      let!(:cmi) { FactoryGirl.create(:context_module_item, canvas_id: payload["body"][:module_item_id]) }
+      let!(:cmi) { FactoryBot.create(:context_module_item, canvas_id: payload["body"][:module_item_id]) }
 
       xit "updates it" do
         expect {

data/spec/factories/account_factory.rb

@@ -1,10 +1,10 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :account do
     canvas_id { SecureRandom.random_number(100_000_000) }
     sis_id { SecureRandom.hex }
-    canvas_parent_account_id 1
+    canvas_parent_account_id { 1 }
     sis_parent_account_id { SecureRandom.hex }
-    name "Account name"
-    workflow_state "active"
+    name { "Account name" }
+    workflow_state { "active" }
   end
 end

data/spec/factories/admin_factory.rb

@@ -1,9 +1,9 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :admin do
     canvas_id { SecureRandom.random_number(100_000_000) }
-    role_name 'Cool Role'
+    role_name { 'Cool Role' }
     canvas_role_id { SecureRandom.random_number(100_000_000) }
-    canvas_user_id 1
-    workflow_state 'active'
+    canvas_user_id { 1 }
+    workflow_state { 'active' }
   end
 end

data/spec/factories/assignment_factory.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :assignment do
     sequence(:canvas_id) { |n| n }
     sequence(:title) { |n| "Assignment #{n}" }

data/spec/factories/assignment_group_factory.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :assignment_group do
     sequence(:canvas_id) { |n| n }
-    name 'Dummy Assignment Group'
-    workflow_state 'available'
+    name { 'Dummy Assignment Group' }
+    workflow_state { 'available' }
     canvas_created_at {1.week.ago}
     canvas_updated_at {1.day.ago}
   end

data/spec/factories/context_module_factory.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :context_module do
     sequence(:canvas_id) { |n| n }
-    name "Context Module"
-    workflow_state "available"
-    context { FactoryGirl.create(:course) }
+    name { "Context Module" }
+    workflow_state { "available" }
+    context { FactoryBot.create(:course) }
   end
 end

data/spec/factories/context_module_item_factory.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :context_module_item do
     sequence(:canvas_id) { |n| n }
     assignment
-    workflow_state "active"
+    workflow_state { "active" }
   end
 end

data/spec/factories/course_factory.rb

@@ -1,9 +1,9 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :course do
     canvas_id { SecureRandom.random_number(100_000_000) }
     sis_id { SecureRandom.hex }
-    course_code 'Cool Course'
-    name 'Really Really Cool Course'
+    course_code { 'Cool Course' }
+    name { 'Really Really Cool Course' }
     start_at { 3.days.ago }
     end_at { 3.weeks.from_now }
   end

data/spec/factories/enrollment_factory.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :enrollment do
     canvas_id { SecureRandom.random_number(100_000_000) }
   end

data/spec/factories/group_factory.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :group do
     canvas_id { SecureRandom.random_number(100_000_000) }
     sis_id { SecureRandom.hex }
-    name 'Some User Group'
-    workflow_state 'available'
+    name { 'Some User Group' }
+    workflow_state { 'available' }
   end
 end

data/spec/factories/group_membership_factory.rb

@@ -1,6 +1,6 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :group_membership do
     canvas_id { SecureRandom.random_number(100_000_000) }
-    workflow_state 'accepted'
+    workflow_state { 'accepted' }
   end
 end

data/spec/factories/role_factory.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :role do
-    label 'Cool Role'
-    base_role_type 'AccountMembership'
+    label { 'Cool Role' }
+    base_role_type { 'AccountMembership' }
     canvas_id { SecureRandom.random_number(100_000_000) }
-    workflow_state 'active'
+    workflow_state { 'active' }
   end
 end

data/spec/factories/section_factory.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :section do
     canvas_id { SecureRandom.random_number(100_000_000) }
   end

data/spec/factories/submission_factory.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :submission do
     sequence(:canvas_id) { |n| n }
     submitted_at { 1.week.ago }

data/spec/factories/term_factory.rb

@@ -1,10 +1,10 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :term do
-    name 'Cool Term'
-    start_at 3.days.ago
-    end_at 3.days.from_now
+    name { 'Cool Term' }
+    start_at { 3.days.ago }
+    end_at { 3.days.from_now }
     canvas_id { SecureRandom.random_number(100_000_000) }
-    workflow_state 'active'
+    workflow_state { 'active' }
     sis_id { SecureRandom.hex }
   end
 end

data/spec/factories/user_factory.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :user do
     canvas_id { SecureRandom.random_number(100_000_000) }
-    email "cooldude@coolsite.com"
-    first_name "Cool"
-    last_name "Dude"
+    email { "cooldude@coolsite.com" }
+    first_name { "Cool" }
+    last_name { "Dude" }
   end
 end

data/spec/job_batching/batch_spec.rb

@@ -223,7 +223,7 @@ RSpec.describe CanvasSync::JobBatches::Batch do
 
     context 'complete' do
       before { batch.on(:complete, Object) }
-      # before { batch.increment_job_queue(bid) }
+      # before { batch.append_jobs(bid) }
       # before { batch.jobs do BatchTestWorker.perform_async end }
       # before { CanvasSync::JobBatches::Batch.process_failed_job(bid, 'failed-job-id') }
 
@@ -341,7 +341,7 @@ RSpec.describe CanvasSync::JobBatches::Batch do
     end
   end
 
-  describe '#increment_job_queue' do
+  describe '#append_jobs' do
     let(:batch) { CanvasSync::JobBatches::Batch.new }
 
     it 'increments pending' do

data/spec/job_batching/compat/active_job_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe CanvasSync::JobBatches::Compat::ActiveJob do
     context "When Enqueueing" do
       context 'when without batch' do
         it 'just yields' do
-          expect(CanvasSync::JobBatches::Batch).not_to receive(:increment_job_queue)
+          expect(CanvasSync::JobBatches::Batch).not_to receive(:append_jobs)
           BatchTestJobBase.perform_later
           expect(BatchTestJobBase).to have_been_enqueued
         end

data/spec/job_batching/compat/sidekiq_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe CanvasSync::JobBatches::Compat::Sidekiq do
     context 'when without batch' do
       it 'just yields' do
         yielded = false
-        expect(CanvasSync::JobBatches::Batch).not_to receive(:increment_job_queue)
+        expect(CanvasSync::JobBatches::Batch).not_to receive(:append_jobs)
         subject.call(nil, {}, nil) { yielded = true }
         expect(yielded).to be_truthy
       end
@@ -67,7 +67,7 @@ RSpec.describe CanvasSync::JobBatches::Compat::Sidekiq do
       end
 
       it 'increments job queue' do
-        # expect(CanvasSync::JobBatches::Batch).to receive(:increment_job_queue).with(bid)
+        # expect(CanvasSync::JobBatches::Batch).to receive(:append_jobs).with(bid)
         # subject.call(nil, { 'jid' => jid }, nil) {}
       end
 

data/spec/job_batching/status_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe CanvasSync::JobBatches::Batch::Status do
     end
 
     context 'when more than 0' do
-      before { batch.increment_job_queue(bid) }
+      before { batch.append_jobs(bid) }
       before { CanvasSync::JobBatches::Batch.process_failed_job(bid, 'FAILEDID') }
 
       it 'returns failed jobs' do

data/spec/job_uniqueness/lock_context_spec.rb

@@ -24,6 +24,17 @@ RSpec.describe CanvasSync::JobUniqueness::LockContext do
       TestWorker.unique_job_options[:scope] = scope
     end
 
+    it 'returns matching keys for equal hashes' do
+      context_data[:args] = [{ foo: 'bar', bar: 'foo' }]
+      key1 = lock_context.base_key
+      lock_context.instance_variable_set(:@base_key, nil)
+
+      context_data[:args] = [{ bar: 'foo', foo: 'bar' }]
+      key2 = lock_context.base_key
+
+      expect(key1).to eq key2
+    end
+
     context 'when scope is a Proc' do
       let(:scope) { ->(queue:) { "blob" } }
 

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require "bundler/setup"
 require 'rspec/rails'
 require 'spec_helper'
-require 'factory_girl_rails'
+require 'factory_bot_rails'
 require 'timecop'
 require 'webmock/rspec'
 require 'support/fake_canvas'
@@ -16,6 +16,9 @@ require 'pry'
 require 'pry-nav'
 require 'with_model'
 
+require 'redis'
+Redis.silence_deprecations = true
+
 require 'sidekiq/testing'
 Sidekiq::Testing.fake!
 Sidekiq::Testing.server_middleware do |chain|
@@ -29,7 +32,7 @@ ActiveRecord::Migration.maintain_test_schema!
 RSpec.configure do |config|
   config.extend WithModel
 
-  config.include FactoryGirl::Syntax::Methods
+  config.include FactoryBot::Syntax::Methods
   config.use_transactional_fixtures = true
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.22.3
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="