canvas_sync 0.27.12 → 0.27.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0cb609547db9a99f1706791e88585c33a02d1d23d0163550ca042fe7a6fc6c2
-  data.tar.gz: 16685b41f9bbea87d8c3df59e26ede34d1de8d087204727d0a62af4b8ccdc1de
+  metadata.gz: 465e968a497bd2dc0bbba5d978bc37a42257122f74132e2f9d7a72c4ed7f9082
+  data.tar.gz: 113288ee3a4bea44ba48d837f917f111e8e0bb9de2f8e43c0d5e30eb78aa0361
 SHA512:
-  metadata.gz: 7815652b4cfdf053ee6f30e8546af592bf60c4e0c21538667d3608d8dd90557f3b4543552a6ea901a0d2027073fe764f06a014afba5ab72004e50b1fc10da325
-  data.tar.gz: 7db6393f537f9f585086166baf39f988da1f146e0cbf79ada0a7e015734f7e139757593e344940e65160add7efc8090638b1990a1e575ff772ee53c7949f00d5
+  metadata.gz: 2afe2d77cc726e26bdce33058d89bfd279f890dd5832c30c33575960387111f309ac15f6f2632406861cb1f3a4e34ce0ff16509612bb987f3e96974ceabc327b
+  data.tar.gz: 3c926ea08522792eae8fd6daaafcc343888aed77b55e943d1fca08a8ddf174d01db1fc26ebe786cd613eab18dc0d9d15221a2fe739a5a46d4dda4e626e48f498

data/lib/canvas_sync/jobs/report_sync_task.rb

@@ -27,12 +27,15 @@ module CanvasSync
       class << self
         def from_context
           report_batch = JobBatches::Batch.current
-          base_context = report_batch&.parent&.context
           state = report_batch&.context
-          return nil unless state.present?
+
+          # Only a report Batch carries :report_class. Any other Batch in the chain inherits a
+          # context from its parents, so check for the key itself rather than asking whether the
+          # context is present.
+          return nil if state.nil? || state[:report_class].blank?
 
           cls = state[:report_class].constantize
-          cls.new(state[:report_options], base_context, state)
+          cls.new(state[:report_options], report_batch.parent&.context, state)
         end
 
         def perform_later(options)

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.27.12".freeze
+  VERSION = "0.27.13".freeze
 end

data/spec/canvas_sync/jobs/report_sync_task_spec.rb

@@ -86,6 +86,30 @@ RSpec.describe CanvasSync::Jobs::ReportSyncTask do
   end
 
   describe ".from_context" do
+    # Stands in for JobBatches::ContextHash, which reads keys via #[] but routes every other Hash
+    # method through #flatten. Flattening loads (and locks down) the whole ancestor chain, so
+    # from_context has to stay on #[] - anything else costs the Batch the ability to record its
+    # own progress later in the job.
+    class FlattenTattlingContext
+      attr_reader :flatten_count
+
+      def initialize(hash)
+        @hash = hash.with_indifferent_access
+        @flatten_count = 0
+      end
+
+      def [](key)
+        @hash[key]
+      end
+
+      def flatten
+        @flatten_count += 1
+        @hash
+      end
+
+      delegate_missing_to :flatten
+    end
+
     it "reconstructs task from batch context" do
       stub_batch_context({ canvas_term_id: 1 })
       allow(CanvasSync::JobBatches::Batch.current).to receive(:context)
@@ -96,6 +120,38 @@ RSpec.describe CanvasSync::Jobs::ReportSyncTask do
       expect(task).to be_a(SyncSpecsTask)
       expect(task.options).to eq({ include_all: true })
     end
+
+    it "returns nil when the context belongs to a non-report Batch" do
+      # A Batch elsewhere in the sync chain inherits a context from its parents, so the context is
+      # populated - it just has no :report_class.
+      stub_batch_context({ canvas_term_id: 1 })
+      allow(CanvasSync::JobBatches::Batch.current).to receive(:context)
+        .and_return({ sync_batch_id: 42, account_id: 'self' }.with_indifferent_access)
+
+      expect(CanvasSync::Jobs::ReportSyncTask.from_context).to be_nil
+    end
+
+    it "returns nil when there is no current Batch" do
+      allow(CanvasSync::JobBatches::Batch).to receive(:current).and_return(nil)
+
+      expect(CanvasSync::Jobs::ReportSyncTask.from_context).to be_nil
+    end
+
+    it "does not flatten the context, for a report Batch or any other" do
+      report_context = FlattenTattlingContext.new(
+        report_class: 'SyncSpecsTask', report_options: { include_all: true }
+      )
+      other_context = FlattenTattlingContext.new(sync_batch_id: 42)
+
+      [report_context, other_context].each do |context|
+        stub_batch_context({ canvas_term_id: 1 })
+        allow(CanvasSync::JobBatches::Batch.current).to receive(:context).and_return(context)
+
+        CanvasSync::Jobs::ReportSyncTask.from_context
+
+        expect(context.flatten_count).to eq(0)
+      end
+    end
   end
 
   describe described_class::StarterJob do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.27.12
+  version: 0.27.13
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -413,14 +413,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 email:
 - pseng@instructure.com
 executables: []