canvas_sync 0.17.24 → 0.17.26.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1d01575608d114952bb12803cae01cc2f4ff61c8ffeed78f18b247973926fa
-  data.tar.gz: ba3629041f491bb7bac12e03da3c896563c9595c77b58cec0d0c728f97168fcf
+  metadata.gz: ce544260a5cc94f9193cb99da3bc55e06ecd1078e0ef6a5afca282cc4d39169f
+  data.tar.gz: 30a5bccedebde1cb00aeb31219b1d9f605672fa8ea58cb50af483cf8f98d15fb
 SHA512:
-  metadata.gz: 73ef3c21b2bb55276da6d5bd96a13b089117e47a04a117d4533822dc790eb2a62b2f8ac88fbfe122a4292e801542c49facef12554fd9a7c80426f699125d42b2
-  data.tar.gz: 29be22e24cb562c9decae8986b5e8a2b7f09da39a80e019edfe6f3cc994a90a2d53da1c9bae4e3d56640d630d7fbd8abca43e8bf946d35c211dae0a00833ef91
+  metadata.gz: e84bde52492c2276650bd662adff677c0aa6a1c511587886d45fc6d328389af242ade72fe872dda2093df9ebb151aa25a4a353559a31d74330849f0a0c93d159
+  data.tar.gz: 3c30eceedad806932b61abc66456973250c7247ba7431406f1c5440b09b05cc3b7174112e34e78392d8f3e9c89dfcd7eba43377a0f8ee30d6320a00a50303163

data/lib/canvas_sync/job_batches/chain_builder.rb

@@ -37,16 +37,29 @@ module CanvasSync
         insert_at(-1, new_job)
       end
 
-      def insert_at(position, new_jobs)
+      def insert_at(position, new_jobs, *args, &blk)
         chain = self.class.get_chain_parameter(base_job)
+        if new_jobs.is_a?(Class) || new_jobs.is_a?(String)
+          new_jobs = build_job_hash(new_jobs, *args, &blk)
+        elsif args.length > 0
+          raise "Unexpected number of arguments"
+        end
         new_jobs = [new_jobs] unless new_jobs.is_a?(Array)
         chain.insert(position, *new_jobs)
       end
 
-      def insert(new_jobs, **kwargs)
-        invalid_params = kwargs.keys - VALID_PLACEMENT_PARAMETERS
-        raise "Invalid placement parameters: #{invalid_params.map(&:to_s).join(', ')}" if invalid_params.present?
-        raise "At most one placement parameter may be provided" if kwargs.values.compact.length > 1
+      def insert(new_jobs, *args, **kwargs, &blk)
+        if new_jobs.is_a?(Class) || new_jobs.is_a?(String)
+          job_kwargs = kwargs.except(*VALID_PLACEMENT_PARAMETERS)
+          args << job_kwargs if job_kwargs.present?
+          new_jobs = build_job_hash(new_jobs, *args, &blk)
+          kwargs = kwargs.slice(*VALID_PLACEMENT_PARAMETERS)
+        else
+          invalid_params = kwargs.keys - VALID_PLACEMENT_PARAMETERS
+          raise "Invalid placement parameters: #{invalid_params.map(&:to_s).join(', ')}" if invalid_params.present?
+          raise "At most one placement parameter may be provided" if kwargs.values.compact.length > 1
+          raise "Unexpected number of arguments" if args.length > 0
+        end
 
         new_jobs = [new_jobs] unless new_jobs.is_a?(Array)
 
@@ -90,7 +103,6 @@ module CanvasSync
         raise "Found multiple \"#{sub_type}\" jobs in the chain" if matching_jobs.count > 1
         return nil if matching_jobs.count == 0
 
-
         job = matching_jobs[0][0]
         job = self.class.new(job) unless job.is_a?(ChainBuilder)
         job
@@ -116,8 +128,22 @@ module CanvasSync
         end
       end
 
+      def apply_block(&blk)
+        return unless blk.present?
+        instance_exec(&blk)
+      end
+
       private
 
+      def build_job_hash(job, *params, &blk)
+        hsh = {
+          job: job,
+          parameters: params,
+        }
+        self.class.new(hsh).apply_block(&blk) if blk.present?
+        hsh
+      end
+
       def find_matching_jobs(search_job, parent_job = self.base_job)
         return to_enum(:find_matching_jobs, search_job, parent_job) unless block_given?
 
@@ -150,6 +176,13 @@ module CanvasSync
       end
 
       class << self
+        def build(job, *args, &blk)
+          new(job).tap do |ch|
+            ch[:parameters] = args
+            ch.apply_block(&blk)
+          end
+        end
+
         def _job_type_definitions
           @job_type_definitions ||= {}
         end

data/lib/canvas_sync/jobs/begin_sync_chain_job.rb

@@ -14,6 +14,12 @@ module CanvasSync
           globals[:updated_after] = last_batch&.started_at&.iso8601
         end
 
+        # Refuse to run syncs of the same genre if there is a running full sync
+        if last_full_sync_record&.status == 'processing' && last_full_sync > 12.hours.ago
+          Rails.logger.warn("Attempted to start a '#{genre}' sync while a full-sync is still processing.")
+          return
+        end
+
         if should_full_sync?(globals[:full_sync_every])
           globals[:updated_after] = nil
         end
@@ -25,6 +31,8 @@ module CanvasSync
           status: 'processing',
         )
 
+        globals[:sync_batch_id] = sync_batch.id
+
         JobBatches::Batch.new.tap do |b|
           b.description = "CanvasSync Root Batch (SyncBatch##{sync_batch.id})"
           b.on(:complete, "#{self.class.to_s}.batch_completed", sync_batch_id: sync_batch.id)
@@ -62,7 +70,7 @@ module CanvasSync
       end
 
       def last_full_sync_record
-        @last_full_sync_record ||= SyncBatch.where(status: 'completed', full_sync: true, batch_genre: genre).last
+        @last_full_sync_record ||= SyncBatch.where(status: ['completed', 'processing'], full_sync: true, batch_genre: genre).last
       end
 
       def last_full_sync

data/lib/canvas_sync/jobs/sync_terms_job.rb

@@ -23,23 +23,7 @@ module CanvasSync
           end
         end
 
-        if (jobs = options[:sub_jobs]).present?
-          context = options[:context] || {}
-          if options[:term_scope]
-            Term.send(options[:term_scope]).find_each.map do |term|
-              local_context = context.merge(canvas_term_id: get_term_id(term))
-              JobBatches::ConcurrentBatchJob.perform_now(jobs, context: local_context)
-            end
-          else
-            JobBatches::ConcurrentBatchJob.perform_now(jobs, context: context)
-          end
-        end
-      end
-
-      protected
-
-      def get_term_id(term)
-        term.try(:canvas_id) || term.canvas_term_id
+        TermBatchesJob.perform_now(options)
       end
     end
   end

data/lib/canvas_sync/jobs/term_batches_job.rb

@@ -0,0 +1,23 @@
+module CanvasSync
+  module Jobs
+    class TermBatchesJob < CanvasSync::Job
+      def perform(options)
+        if (jobs = options[:sub_jobs]).present?
+          context = options[:context] || {}
+          if options[:term_scope]
+            Term.send(options[:term_scope]).find_each.map do |term|
+              local_context = context.merge(canvas_term_id: get_term_id(term))
+              JobBatches::ConcurrentBatchJob.perform_now(jobs, context: local_context)
+            end
+          else
+            JobBatches::ConcurrentBatchJob.perform_now(jobs, context: context)
+          end
+        end
+      end
+
+      def get_term_id(term)
+        term.try(:canvas_id) || term.canvas_term_id
+      end
+    end
+  end
+end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.24".freeze
+  VERSION = "0.17.26.beta1".freeze
 end

data/lib/canvas_sync.rb

@@ -80,6 +80,7 @@ module CanvasSync
   ].freeze
 
   JobBatches::ChainBuilder.register_chain_job(CanvasSync::Jobs::SyncTermsJob, :sub_jobs)
+  JobBatches::ChainBuilder.register_chain_job(CanvasSync::Jobs::TermBatchesJob, :sub_jobs)
   JobBatches::ChainBuilder.register_chain_job(CanvasSync::Jobs::BeginSyncChainJob, 0)
 
   class << self
@@ -130,12 +131,8 @@ module CanvasSync
       models,
       term_scope: nil,
       term_scoped_models: DEFAULT_TERM_SCOPE_MODELS,
-      legacy_support: false,
-      account_id: nil,
-      updated_after: nil,
-      full_sync_every: nil,
-      batch_genre: nil,
-      options: {}
+      options: {},
+      **kwargs
     ) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
       return unless models.present?
       models.map! &:to_s
@@ -155,7 +152,7 @@ module CanvasSync
         context_module_items: CanvasSync::Jobs::SyncContextModuleItemsJob,
       }.with_indifferent_access
 
-      root_chain = JobBatches::ChainBuilder.new(CanvasSync::Jobs::BeginSyncChainJob)
+      root_chain = base_canvas_sync_chain(**kwargs, globals: options[:global] || kwargs[:globals])
       concurrent_root_chain = JobBatches::ChainBuilder.new(JobBatches::ConcurrentBatchJob)
       root_chain << concurrent_root_chain
       current_chain = concurrent_root_chain
@@ -211,6 +208,20 @@ module CanvasSync
       # Wrap it all up
       ###############################
 
+      root_chain
+    end
+
+    def base_canvas_sync_chain(
+      legacy_support: false, # Import records 1 by 1 instead of with bulk upserts
+      account_id: nil, # legacy/non PandaPal apps
+      updated_after: nil,
+      full_sync_every: nil,
+      batch_genre: nil,
+      globals: {},
+      &blk
+    )
+      root_chain = JobBatches::ChainBuilder.new(CanvasSync::Jobs::BeginSyncChainJob)
+
       global_options = {
         legacy_support: legacy_support,
         updated_after: updated_after,
@@ -218,10 +229,12 @@ module CanvasSync
         batch_genre: batch_genre,
       }
       global_options[:account_id] = account_id if account_id.present?
-      global_options.merge!(options[:global]) if options[:global].present?
+      global_options.merge!(globals) if globals
 
       root_chain.params[1] = global_options
 
+      root_chain.apply_block(&blk)
+
       root_chain
     end
 

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -35,11 +35,18 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
     end
 
     it 'processes xlist' do
+      subject.process('spec/support/fixtures/reports/sections.csv', { models: ['sections'] }, 1)
+      expect(Section.find_by(canvas_id: 2).name).to eq "Lame Section"
+
       subject.process('spec/support/fixtures/reports/xlist.csv', { models: ['xlist'] }, 1)
+
       expect(Section.where.not(canvas_nonxlist_course_id: nil).count).to eq 1
       cross_listed_section = Section.where.not(canvas_nonxlist_course_id: nil).first
       expect(cross_listed_section.canvas_id).to eq 2
-      expect(cross_listed_section.canvas_nonxlist_course_id).to eq 2
+      expect(cross_listed_section.canvas_nonxlist_course_id).to eq 3
+
+      expect(cross_listed_section.canvas_course_id).to eq 2
+      expect(cross_listed_section.name).to eq "Lame Section"
     end
 
     it 'processes groups' do