canvas_sync 0.27.11 → 0.27.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ea16b4fb4ba5a744d39a92d8145e5ebf1123355e5c6562094f91fe5d523176
-  data.tar.gz: 7505711d374c3f86648ce435234668df10a6c032dc6546cdf144c4b6d9d944f9
+  metadata.gz: a0cb609547db9a99f1706791e88585c33a02d1d23d0163550ca042fe7a6fc6c2
+  data.tar.gz: 16685b41f9bbea87d8c3df59e26ede34d1de8d087204727d0a62af4b8ccdc1de
 SHA512:
-  metadata.gz: 9906d9f164b5cdae293e6ca6e249a7793988c951ea7f3d84500364e8e88f2184e8f1fc58d54e762f4854d4fa5f755115a99759fdeea1f3b5d56bde94181aca1a
-  data.tar.gz: a0b592ee83e841af466cd06d66f564d9e731f7398a9f400fa96da4807a0027dd5575163b60cc10351730b017bc15ff18fbbc8f2073ef48a2724d5529d70bbfd4
+  metadata.gz: 7815652b4cfdf053ee6f30e8546af592bf60c4e0c21538667d3608d8dd90557f3b4543552a6ea901a0d2027073fe764f06a014afba5ab72004e50b1fc10da325
+  data.tar.gz: 7db6393f537f9f585086166baf39f988da1f146e0cbf79ada0a7e015734f7e139757593e344940e65160add7efc8090638b1990a1e575ff772ee53c7949f00d5

data/lib/canvas_sync/jobs/report_sync_task.rb

@@ -27,8 +27,10 @@ module CanvasSync
       class << self
         def from_context
           report_batch = JobBatches::Batch.current
-          base_context = report_batch.parent.context
-          state = report_batch.context
+          base_context = report_batch&.parent&.context
+          state = report_batch&.context
+          return nil unless state.present?
+
           cls = state[:report_class].constantize
           cls.new(state[:report_options], base_context, state)
         end

data/lib/canvas_sync/jobs/sync_accounts_job.rb

@@ -10,7 +10,8 @@ module CanvasSync
       # @param options [Hash]
       def perform(options)
         unless options[:root_account] == false
-          accid = report_task.options[:account_id] || batch_context[:account_id] || "self"
+          task = ReportSyncTask.from_context || nil
+          accid = options[:account_id] || task&.options&.dig(:account_id) || batch_context[:account_id] || "self"
           acc_params = CanvasSync.get_canvas_sync_client(batch_context).account(accid)
           update_or_create_model(Account, acc_params)
         end

data/lib/canvas_sync/version.rb

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

data/lib/canvas_sync.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "bearcat"
 
 require "canvas_sync/version"

data/spec/canvas_sync/jobs/begin_sync_chain_job_spec.rb

@@ -170,22 +170,28 @@ RSpec.describe CanvasSync::Jobs::BeginSyncChainJob do
     end
 
     context 'a "<weekday>/<skip weeks>" schedule (e.g. "sunday/2")' do
+      # should_full_sync? asks DateTime.now (the system zone) which weekday it is, so
+      # these travel to local noon. Midnight in any single zone lands on the adjacent
+      # day for someone, which flips the weekday and the assertion with it.
+      let(:sunday) { Time.local(2024, 1, 7, 12, 0, 0) }
+      let(:monday) { Time.local(2024, 1, 8, 12, 0, 0) }
+
       it 'is true only on the matching weekday once the skip period has elapsed' do
-        Timecop.travel(DateTime.new(2024, 1, 7)) do # a Sunday
+        Timecop.travel(sunday) do
           CanvasSync::SyncBatch.create!(status: 'completed', full_sync: true, batch_genre: 'default', started_at: 3.weeks.ago)
           expect(job.should_full_sync?('sunday/2')).to eq(true)
         end
       end
 
       it 'is false on the matching weekday if the skip period has not yet elapsed' do
-        Timecop.travel(DateTime.new(2024, 1, 7)) do # a Sunday
+        Timecop.travel(sunday) do
           CanvasSync::SyncBatch.create!(status: 'completed', full_sync: true, batch_genre: 'default', started_at: 1.week.ago)
           expect(job.should_full_sync?('sunday/2')).to eq(false)
         end
       end
 
       it 'is false on a non-matching weekday even if the skip period has elapsed' do
-        Timecop.travel(DateTime.new(2024, 1, 8)) do # a Monday
+        Timecop.travel(monday) do
           CanvasSync::SyncBatch.create!(status: 'completed', full_sync: true, batch_genre: 'default', started_at: 3.weeks.ago)
           expect(job.should_full_sync?('sunday/2')).to eq(false)
         end

data/spec/canvas_sync/jobs/sync_accounts_job_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::SyncAccountsJob do
+  describe '#perform' do
+    before do
+      allow(CanvasSync::Jobs::SyncAccountsJob::ReportTask).to receive(:perform_later)
+    end
+
+    it 'syncs the root account and then invokes the report task' do
+      expect {
+        described_class.perform_now({})
+      }.to change { Account.count }.by(1)
+
+      expect(a_request(:get, 'http://test.instructure.com/api/v1/accounts/self')).to have_been_made
+      expect(CanvasSync::Jobs::SyncAccountsJob::ReportTask).to have_received(:perform_later).with({})
+    end
+
+    it 'uses account_id from the options when present' do
+      described_class.perform_now({ account_id: 42 })
+
+      expect(a_request(:get, 'http://test.instructure.com/api/v1/accounts/42')).to have_been_made
+    end
+
+    it 'falls back to account_id from the batch context' do
+      set_batch_context(account_id: 7)
+
+      described_class.perform_now({})
+
+      expect(a_request(:get, 'http://test.instructure.com/api/v1/accounts/7')).to have_been_made
+    end
+
+    it 'skips the root account sync when root_account is false' do
+      expect {
+        described_class.perform_now({ root_account: false })
+      }.not_to change { Account.count }
+
+      expect(a_request(:get, %r{/api/v1/accounts/})).not_to have_been_made
+      expect(CanvasSync::Jobs::SyncAccountsJob::ReportTask).to have_received(:perform_later)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -78,7 +78,9 @@ def open_canvas_fixture(name)
   JSON.parse(data)
 end
 
-def canvas_sync_client
+# Mirrors the host-app hook CanvasSync.get_canvas_sync_client calls. It passes an
+# account ID when one is configured, so this has to accept an optional argument.
+def canvas_sync_client(account_id = nil)
   Bearcat::Client.new(token: 'cool-token', prefix: 'http://test.instructure.com')
 end
 

data/spec/support/fake_canvas.rb

@@ -16,6 +16,10 @@ class FakeCanvas < Sinatra::Base
     json_response 200, 'admins.json'
   end
 
+  get '/api/v1/accounts/:id' do
+    json_response 200, 'account.json'
+  end
+
   get '/sample_report_download' do
     json_response 200, 'terms.json'
   end

data/spec/support/fixtures/canvas_responses/account.json

@@ -0,0 +1,12 @@
+{
+  "id": 1,
+  "name": "Test Root Account",
+  "workflow_state": "active",
+  "parent_account_id": null,
+  "root_account_id": null,
+  "uuid": "abcDEF1234567890abcDEF1234567890abcDEF12",
+  "default_storage_quota_mb": 500,
+  "default_user_storage_quota_mb": 50,
+  "default_group_storage_quota_mb": 50,
+  "default_time_zone": "America/Denver"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.27.11
+  version: 0.27.12
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -577,6 +577,7 @@ files:
 - spec/canvas_sync/jobs/job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb
 - spec/canvas_sync/jobs/report_sync_task_spec.rb
+- spec/canvas_sync/jobs/sync_accounts_job_spec.rb
 - spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
 - spec/canvas_sync/jobs/sync_roles_job_spec.rb
@@ -711,6 +712,7 @@ files:
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
+- spec/support/fixtures/canvas_responses/account.json
 - spec/support/fixtures/canvas_responses/admins.json
 - spec/support/fixtures/canvas_responses/module.json
 - spec/support/fixtures/canvas_responses/module_item.json
@@ -776,6 +778,7 @@ test_files:
 - spec/canvas_sync/jobs/job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb
 - spec/canvas_sync/jobs/report_sync_task_spec.rb
+- spec/canvas_sync/jobs/sync_accounts_job_spec.rb
 - spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
 - spec/canvas_sync/jobs/sync_roles_job_spec.rb
@@ -910,6 +913,7 @@ test_files:
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
+- spec/support/fixtures/canvas_responses/account.json
 - spec/support/fixtures/canvas_responses/admins.json
 - spec/support/fixtures/canvas_responses/module.json
 - spec/support/fixtures/canvas_responses/module_item.json