canvas_sync 0.22.5 → 0.22.8

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -2,6 +2,18 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync do
   describe '.provisioning_sync' do
+    it 'invokes the first job in the queue and passes on the rest of the job chain' do
+      expected_job_chain = CanvasSync.default_provisioning_report_chain(['courses'], term_scope: nil).normalize![:args][0]
+
+      expect(CanvasSync::Jobs::BeginSyncChainJob).to receive(:perform_later)
+        .with(
+          expected_job_chain,
+          anything
+        )
+
+      CanvasSync.provisioning_sync(['courses'])
+    end
+
     context 'an invalid model is passed in' do
       it 'raises a helpful exception' do
         expect {
@@ -18,25 +30,22 @@ RSpec.describe CanvasSync do
           provisioning: { c: 3 },
           global: { d: 4 },
         })
-        expect(chain.normalize!).to match({
+        expect(chain.normalize!).to eq({
           :job => "CanvasSync::Jobs::BeginSyncChainJob",
-          :chain_link=>String,
           :args => [
             [
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[
                   [
-                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users"], :b=>2}},
+                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users"], :b=>2}},
                     {
                       :job=>"CanvasSync::Jobs::SyncTermsJob",
-                      :chain_link=>String,
                       :args=>[],
                       :kwargs=>{
                         :term_scope=>"active",
                         :sub_jobs=>[
-                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"], :c=>3}},
+                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"], :c=>3}},
                         ],
                       },
                     },
@@ -53,23 +62,20 @@ RSpec.describe CanvasSync do
       context 'we are syncing users with a term scope' do
         it 'syncs the users in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[
                   [
-                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users"]}},
+                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users"]}},
                     {
                       :job=>"CanvasSync::Jobs::SyncTermsJob",
-                      :chain_link=>String,
                       :args=>[],
                       :kwargs=>{
                         :sub_jobs=>[
-                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}
+                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}
                         ],
                         :term_scope=>"active",
                       }
@@ -87,20 +93,17 @@ RSpec.describe CanvasSync do
       context 'we are syncing users without a term scope' do
         it 'syncs users along with the rest of the provisioning report' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "courses"]}}],
                       :term_scope=>nil,
                     }
                   }
@@ -116,21 +119,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles with a term scope' do
         it 'syncs the roles in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>"active",
                     }
                   },
@@ -146,21 +146,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles without a term scope' do
         it 'syncs roles separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>nil,
                     }
                   }
@@ -176,21 +173,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins with a term scope' do
         it 'syncs the admins in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>"active"
                     }
                   }
@@ -206,21 +200,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins without a term scope' do
         it 'syncs admins separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>nil
                     }
                   }
@@ -237,22 +228,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignments])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncAssignmentsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncAssignmentsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }
@@ -270,22 +258,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncSubmissionsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments submissions])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncSubmissionsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncSubmissionsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }
@@ -303,22 +288,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentGroupsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignment_groups])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncAssignmentGroupsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncAssignmentGroupsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -12,6 +12,10 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
 
     context "with User#sis_id column" do
       before do
+        # this could be refactored into a method that prevents caching the variables unless the environment is prod
+        CanvasSync::Concerns::SyncMapping::Mapping.instance_variable_set(:@mappings, nil)
+        CanvasSync::Concerns::SyncMapping::Mapping.instance_variable_set(:@legacy_mappings, nil)
+
         self.use_transactional_tests = false
         ActiveRecord::Migration.add_column :users, :sis_id, :string
         User.reset_column_information

data/spec/dummy/app/models/course_progress.rb

@@ -9,6 +9,7 @@
 # CourseProgress is not a Canvas model. It is a table built from the Custom Report
 class CourseProgress < ApplicationRecord
   include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   canvas_sync_features :defaults
 
@@ -17,4 +18,11 @@ class CourseProgress < ApplicationRecord
 
   validates_presence_of :canvas_user_id, :canvas_course_id
   validates_uniqueness_of :canvas_user_id, scope: :canvas_course_id
+
+  api_syncable({
+    requirement_count: :requirement_count,
+    requirement_completed_count: :requirement_completed_count,
+    # provisioning report has completion_date instead of completed_at in the API
+    completion_date: :completed_at
+  }, -> (api) { api.course_progress(canvas_course_id, canvas_user_id) })
 end

data/spec/dummy/db/migrate/20190702203624_create_enrollments.rb

@@ -19,6 +19,7 @@ class CreateEnrollments < ActiveRecord::Migration[5.1]
       t.bigint :canvas_section_id
       t.string :workflow_state
       t.string :base_role_type
+      t.datetime :completed_at
 
       t.timestamps
     end

data/spec/dummy/db/schema.rb

@@ -210,6 +210,7 @@ ActiveRecord::Schema.define(version: 2024_05_23_101010) do
     t.bigint "canvas_section_id"
     t.string "workflow_state"
     t.string "base_role_type"
+    t.datetime "completed_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.index ["canvas_course_id"], name: "index_enrollments_on_canvas_course_id"