canvas_sync 0.22.4 → 0.22.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b588205886b2732d915af7bd8a4e41fed60dae2593ca824c8fa046410258d6f3
-  data.tar.gz: 9f6a3238ae187f6a9a01135957ef8f769e127fc2870103c1bb7acacae57973ba
+  metadata.gz: 61d4f6b7e0c7f8201ee2dccdeea7e9f3149f112d35ea4ab72903ddbee892c079
+  data.tar.gz: 72a6a5553aa892680ee6ce2dacba9ce98d200cc44bd17a40dc5648b028b63868
 SHA512:
-  metadata.gz: 9bbd02c072cd7f3eadce5f342b40eaa3f15f3a33843a0f93c20ff4afff0f401ae80532eddf99edd236027876bae20b0977cb0f5c10ddab57fb9d89f76c609efb
-  data.tar.gz: fa5845858716a91706e6b08877234635fced66701db9d6fc0e0c8956e3e1bb73e862cf7f69da062ba1823cd7cd8c1d23b66c97f20f51239523eaa8d59adcd9b8
+  metadata.gz: 5eb771935ecaa392a2fd6442136cadbe7972912381de6028c145de4e45419904de56a694a636dde1cabcbfda67fbeedfdcecd38993031194dab85f75ed529b98
+  data.tar.gz: fd8a0c64457a2190783527dcbfff67d34ec17f6f9249b1e0f4147a0e3ef8d5b9ae66ad4e132982b341ace536db78f39b95dbd5c7447f6099d765b83c8ef897ce

data/README.md

@@ -242,6 +242,11 @@ class User < ApplicationRecord
     # If the column name on the report and in the DB are the same, a shorthand can be used:
     link_column :omit_from_final_grade, type: :datetime
 
+    # You can specify a block to pre-transform the value
+    link_column :column_in_report => :column_in_database do |value, row|
+      YAML.parse(value)
+    end
+
     # If the defaults define a column you don't want synced, you can remove it from the mapping:
     unlink_column :column_in_database
   end

data/app/models/canvas_sync/job_log.rb

@@ -3,7 +3,11 @@ module CanvasSync
   #
   # Use this model to track failures, job run times, and metadata about a job.
   class JobLog < ApplicationRecord
-    serialize :job_arguments, Array
+    if Rails.version > '7.0'
+      serialize :job_arguments, type: Array
+    else
+      serialize :job_arguments, Array
+    end
 
     ERROR_STATUS = "error".freeze
     SUCCESS_STATUS = "success".freeze

data/app/models/canvas_sync/sync_batch.rb

@@ -1,5 +1,4 @@
 module CanvasSync
   class SyncBatch < ApplicationRecord
-    serialize :job_arguments, Array
   end
 end

data/lib/canvas_sync/concerns/auto_relations.rb

@@ -0,0 +1,11 @@
+module CanvasSync::Concerns
+  module AutoRelations
+    extend ActiveSupport::Concern
+
+    # CanvasSync::Record.define_feature self, default: true
+
+    included do
+
+    end
+  end
+end

data/lib/canvas_sync/generators/templates/models/course_progress.rb

@@ -3,6 +3,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
 
@@ -11,4 +12,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/lib/canvas_sync/job_batches/batch.rb

@@ -478,20 +478,22 @@ module CanvasSync::JobBatches
 
       # Internal method to cleanup a Redis Hash and related keys
       def cleanup_redis_index_for(key, suffixes = [""])
-        if r.hget(k, "created_at").present?
-          r.multi do |r|
-            suffixes.each do |suffix|
-              r.expire(key + suffix, BID_EXPIRE_TTL)
+        redis do |r|
+          if r.hget(k, "created_at").present?
+            r.multi do |r|
+              suffixes.each do |suffix|
+                r.expire(key + suffix, BID_EXPIRE_TTL)
+              end
             end
-          end
-          false
-        else
-          r.multi do |r|
-            suffixes.each do |suffix|
-              r.unlink(key + suffix)
+            false
+          else
+            r.multi do |r|
+              suffixes.each do |suffix|
+                r.unlink(key + suffix)
+              end
             end
+            true
           end
-          true
         end
       end
 
@@ -499,14 +501,16 @@ module CanvasSync::JobBatches
       def cleanup_redis_index!
         suffixes = ["", "-callbacks-complete", "-callbacks-success", "-failed", "-dead", "-batches-success", "-batches-complete", "-batches-failed", "-bids", "-jids", "-pending_callbacks"]
 
-        cleanup_index = ->(index) {
-          r.zrangebyscore(index, "0", BID_EXPIRE_TTL.seconds.ago.to_i).each do |bid|
-            r.zrem(index, bid) if cleanup_redis_index_for("BID-#{bid}", suffixes)
-          end
-        }
+        redis do |r|
+          cleanup_index = ->(index) {
+            r.zrangebyscore(index, "0", BID_EXPIRE_TTL.seconds.ago.to_i).each do |bid|
+              r.zrem(index, bid) if cleanup_redis_index_for("BID-#{bid}", suffixes)
+            end
+          }
 
-        cleanup_index.call("BID-ROOT-bids")
-        cleanup_index.call("batches")
+          cleanup_index.("BID-ROOT-bids")
+          cleanup_index.("batches")
+        end
       end
 
       def redis(&blk)

data/lib/canvas_sync/job_batches/chain_builder.rb

@@ -4,7 +4,9 @@ module CanvasSync::JobBatches
 
     attr_reader :base_job
 
-    def initialize(base_type = SerialBatchJob)
+    def initialize(base_type = SerialBatchJob, chain_id: nil)
+      @chain_id = chain_id || SecureRandom.urlsafe_base64(10)
+
       if base_type.is_a?(Hash)
         @base_job = base_type
         @base_job[:args] ||= @base_job[:parameters] || []
@@ -109,7 +111,7 @@ module CanvasSync::JobBatches
       return nil if matching_jobs.count == 0
 
       job = matching_jobs[0][0]
-      job = self.class.new(job) unless job.is_a?(ChainBuilder)
+      job = self.class.new(job, chain_id: @chain_id) unless job.is_a?(ChainBuilder)
       job
     end
 
@@ -118,6 +120,7 @@ module CanvasSync::JobBatches
         job_def.normalize!
       else
         job_def[:job] = job_def[:job].to_s
+        job_def[:chain_link] ||= "#{@chain_id}-#{SecureRandom.urlsafe_base64(10)}"
         if (chain = self.class.get_chain_parameter(job_def, raise_error: false)).present?
           chain.map! { |sub_job| normalize!(sub_job) }
         end
@@ -138,7 +141,7 @@ module CanvasSync::JobBatches
         args: args,
         kwargs: kwargs,
       }
-      self.class.new(hsh).apply_block(&blk) if blk.present?
+      self.class.new(hsh, chain_id: @chain_id).apply_block(&blk) if blk.present?
       hsh
     end
 
@@ -239,6 +242,24 @@ module CanvasSync::JobBatches
           job_class.perform_later(*job_args, **job_kwargs)
         end
       end
+
+      def link_to_batch!(chain_link, batch)
+        # Or make chains a separate entity - Chains show batches, but batches don't show chain?
+        # Or "Annotate" a Batch with chain data - could extract chain id from any job entry
+      end
+
+      def annotate_batch!(batch, chain)
+
+      end
+
+      def handle_step_complete(status, opts)
+        chain_link = opts[:chain_link]
+        chain_id, chain_step_id = chain_link.split('-')
+
+        CanvasSync::JobBatches::Batch.redis.multi do |r|
+          r.hset("CHAIN-#{chain_id}-steps", chain_step_id, "complete")
+        end
+      end
     end
   end
 

data/lib/canvas_sync/job_batches/jobs/managed_batch_job.rb

@@ -144,6 +144,10 @@ module CanvasSync::JobBatches
             if next_job[:chain_link].present?
               # Annotate Batch with chain-step info
               batch.context["csb:chain_link"] = next_job[:chain_link]
+              # TODO Add Fiber Batch to chain-link
+              # With the exception of the top of the Chain, all nested ManagedBatch Roots should be within a Fiber,
+              #   so we shouldn't really need to make the Root checkin with the chain
+              #   ...except to cleanup the chain
               batch.on(:complete, "#{ChainBuilder.to_s}.chain_step_complete", chain_link: next_job[:chain_link])
             end
 

data/lib/canvas_sync/job_batches/status.rb

@@ -49,6 +49,7 @@ module CanvasSync::JobBatches
       end
 
       def success?
+        # TODO (Race Condition) This might not be valid if checked from a :complete callback
         'true' == Batch.redis { |r| r.hget("BID-#{bid}", 'success') }
       end