canvas_sync 0.17.35 → 0.17.36

data/spec/job_batching/active_job_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::JobBatches::ActiveJob do
+  describe CanvasSync::JobBatches::ActiveJob::BatchAwareJob do
+    include ActiveJob::TestHelper
+
+    after do
+      clear_enqueued_jobs
+      clear_performed_jobs
+    end
+
+    context "When Performing" do
+      context 'when without batch' do
+        it 'just yields' do
+          expect(CanvasSync::JobBatches::Batch).not_to receive(:process_successful_job)
+          expect(CanvasSync::JobBatches::Batch).not_to receive(:process_failed_job)
+          expect_any_instance_of(BatchTestJobBase).to receive(:perform)
+
+          BatchTestJobBase.perform_now
+        end
+      end
+
+      context 'when in batch' do
+        let(:bid) { 'SAMPLEBID' }
+
+        context 'when successful' do
+          it 'yields' do
+            expect_any_instance_of(BatchTestJobBase).to receive(:perform)
+            BatchTestJobBase.perform_now
+          end
+
+          it 'calls process_successful_job' do
+            job = BatchTestJobBase.new
+            job.instance_variable_set(:@bid, bid)
+            expect(CanvasSync::JobBatches::Batch).to receive(:process_successful_job).with(bid, job.job_id)
+            job.perform_now
+          end
+        end
+
+        context 'when failed' do
+          it 'calls process_failed_job and reraises exception' do
+            reraised = false
+            job = FailingBatchTestJobBase.new
+            job.instance_variable_set(:@bid, bid)
+            expect(CanvasSync::JobBatches::Batch).to receive(:process_failed_job)
+            begin
+              job.perform_now
+            rescue
+              reraised = true
+            end
+            expect(reraised).to be_truthy
+          end
+        end
+      end
+    end
+
+    context "When Enqueueing" do
+      context 'when without batch' do
+        it 'just yields' do
+          expect(CanvasSync::JobBatches::Batch).not_to receive(:increment_job_queue)
+          BatchTestJobBase.perform_later
+          expect(BatchTestJobBase).to have_been_enqueued
+        end
+      end
+
+      context 'when in batch' do
+        let(:bid) { 'SAMPLEBID' }
+
+        before do
+          Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY] = CanvasSync::JobBatches::Batch.new(bid)
+          Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY].instance_variable_set(:@open, true)
+        end
+        after { Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY] = nil }
+
+        it 'yields' do
+          expect {
+            BatchTestJobBase.perform_later
+          }.to enqueue_job(BatchTestJobBase)
+        end
+
+        it 'assigns bid to job metadata' do
+          job = BatchTestJobBase.perform_later
+          expect(job.bid).to eq bid
+          expect(job.serialize['batch_id']).to eq bid
+        end
+      end
+    end
+
+    context 'worker' do
+      it 'defines method bid' do
+        expect(ActiveJob::Base.instance_methods).to include(:bid)
+      end
+
+      it 'defines method batch' do
+        expect(ActiveJob::Base.instance_methods).to include(:batch)
+      end
+
+      it 'defines method valid_within_batch?' do
+        expect(ActiveJob::Base.instance_methods).to include(:valid_within_batch?)
+      end
+    end
+  end
+
+  describe ".handle_job_death" do
+
+  end
+end

data/spec/job_batching/batch_spec.rb

@@ -338,7 +338,7 @@ RSpec.describe CanvasSync::JobBatches::Batch do
 
     context 'With ActiveJob Adapter' do
       around(:all) do |block|
-        CanvasSync::JobBatches::Batch::Callback.worker_class = CanvasSync::JobBatches::Batch::Callback::ActiveJobCallbackWorker
+        CanvasSync::JobBatches::Batch::Callback.worker_class = CanvasSync::JobBatches::ActiveJob::ActiveJobCallbackWorker
         block.run
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.17.35
+  version: 0.17.36
 platform: ruby
 authors:
 - Nate Collings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -434,8 +434,8 @@ files:
 - lib/canvas_sync/importers/bulk_importer.rb
 - lib/canvas_sync/importers/legacy_importer.rb
 - lib/canvas_sync/job.rb
+- lib/canvas_sync/job_batches/active_job.rb
 - lib/canvas_sync/job_batches/batch.rb
-- lib/canvas_sync/job_batches/batch_aware_job.rb
 - lib/canvas_sync/job_batches/callback.rb
 - lib/canvas_sync/job_batches/chain_builder.rb
 - lib/canvas_sync/job_batches/context_hash.rb
@@ -642,7 +642,7 @@ files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/job_batching/batch_aware_job_spec.rb
+- spec/job_batching/active_job_spec.rb
 - spec/job_batching/batch_spec.rb
 - spec/job_batching/callback_spec.rb
 - spec/job_batching/context_hash_spec.rb
@@ -853,7 +853,7 @@ test_files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/job_batching/batch_aware_job_spec.rb
+- spec/job_batching/active_job_spec.rb
 - spec/job_batching/batch_spec.rb
 - spec/job_batching/callback_spec.rb
 - spec/job_batching/context_hash_spec.rb

data/lib/canvas_sync/job_batches/batch_aware_job.rb

@@ -1,63 +0,0 @@
-module CanvasSync
-  module JobBatches
-    module BatchAwareJob
-      extend ActiveSupport::Concern
-
-      included do
-        around_perform do |job, block|
-          if (@bid) # This _must_ be @bid - not just bid
-            prev_batch = Thread.current[CURRENT_BATCH_THREAD_KEY]
-            begin
-              Thread.current[CURRENT_BATCH_THREAD_KEY] = Batch.new(@bid)
-              block.call
-              Thread.current[CURRENT_BATCH_THREAD_KEY].save_context_changes
-              Batch.process_successful_job(@bid, job_id)
-            rescue
-              Batch.process_failed_job(@bid, job_id)
-              raise
-            ensure
-              Thread.current[CURRENT_BATCH_THREAD_KEY] = prev_batch
-            end
-          else
-            block.call
-          end
-        end
-
-        around_enqueue do |job, block|
-          if (batch = Thread.current[CURRENT_BATCH_THREAD_KEY])
-            @bid = batch.bid
-            batch.increment_job_queue(job_id) if @bid
-          end
-          block.call
-        end
-      end
-
-      def bid
-        @bid || Thread.current[CURRENT_BATCH_THREAD_KEY]&.bid
-      end
-
-      def batch
-        Thread.current[CURRENT_BATCH_THREAD_KEY]
-      end
-
-      def batch_context
-        batch&.context || {}
-      end
-
-      def valid_within_batch?
-        batch.valid?
-      end
-
-      def serialize
-        super.tap do |data|
-          data['batch_id'] = @bid # This _must_ be @bid - not just bid
-        end
-      end
-
-      def deserialize(data)
-        super
-        @bid = data['batch_id']
-      end
-    end
-  end
-end

data/spec/job_batching/batch_aware_job_spec.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe CanvasSync::JobBatches::BatchAwareJob do
-  include ActiveJob::TestHelper
-
-  after do
-    clear_enqueued_jobs
-    clear_performed_jobs
-  end
-
-  context "When Performing" do
-    context 'when without batch' do
-      it 'just yields' do
-        expect(CanvasSync::JobBatches::Batch).not_to receive(:process_successful_job)
-        expect(CanvasSync::JobBatches::Batch).not_to receive(:process_failed_job)
-        expect_any_instance_of(BatchTestJobBase).to receive(:perform)
-
-        BatchTestJobBase.perform_now
-      end
-    end
-
-    context 'when in batch' do
-      let(:bid) { 'SAMPLEBID' }
-
-      context 'when successful' do
-        it 'yields' do
-          expect_any_instance_of(BatchTestJobBase).to receive(:perform)
-          BatchTestJobBase.perform_now
-        end
-
-        it 'calls process_successful_job' do
-          job = BatchTestJobBase.new
-          job.instance_variable_set(:@bid, bid)
-          expect(CanvasSync::JobBatches::Batch).to receive(:process_successful_job).with(bid, job.job_id)
-          job.perform_now
-        end
-      end
-
-      context 'when failed' do
-        it 'calls process_failed_job and reraises exception' do
-          reraised = false
-          job = FailingBatchTestJobBase.new
-          job.instance_variable_set(:@bid, bid)
-          expect(CanvasSync::JobBatches::Batch).to receive(:process_failed_job)
-          begin
-            job.perform_now
-          rescue
-            reraised = true
-          end
-          expect(reraised).to be_truthy
-        end
-      end
-    end
-  end
-
-  context "When Enqueueing" do
-    context 'when without batch' do
-      it 'just yields' do
-        expect(CanvasSync::JobBatches::Batch).not_to receive(:increment_job_queue)
-        BatchTestJobBase.perform_later
-        expect(BatchTestJobBase).to have_been_enqueued
-      end
-    end
-
-    context 'when in batch' do
-      let(:bid) { 'SAMPLEBID' }
-
-      before do
-        Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY] = CanvasSync::JobBatches::Batch.new(bid)
-        Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY].instance_variable_set(:@open, true)
-      end
-      after { Thread.current[CanvasSync::JobBatches::CURRENT_BATCH_THREAD_KEY] = nil }
-
-      it 'yields' do
-        expect {
-          BatchTestJobBase.perform_later
-        }.to enqueue_job(BatchTestJobBase)
-      end
-
-      it 'assigns bid to job metadata' do
-        job = BatchTestJobBase.perform_later
-        expect(job.bid).to eq bid
-        expect(job.serialize['batch_id']).to eq bid
-      end
-    end
-  end
-
-  context 'worker' do
-    it 'defines method bid' do
-      expect(ActiveJob::Base.instance_methods).to include(:bid)
-    end
-
-    it 'defines method batch' do
-      expect(ActiveJob::Base.instance_methods).to include(:batch)
-    end
-
-    it 'defines method valid_within_batch?' do
-      expect(ActiveJob::Base.instance_methods).to include(:valid_within_batch?)
-    end
-  end
-end