canvas_sync 0.22.3 → 0.22.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc62b25843e2b3e57b83e1ca41b4a0e546666ce6e824a8a799f534ee90fb28c5
-  data.tar.gz: 1fb1747c3882282894b0aa4e6fef9d7240977a453da6415e3a31460c55833306
+  metadata.gz: 6fbc16dd889dae43881098a80d91c68ec64412b1ce872b51f176f89a0d2ce8fe
+  data.tar.gz: f202ff4cae0337f6a34872654b55371b5fdfabdccd1358fc7fceb14397549425
 SHA512:
-  metadata.gz: 3ac70536bc476c02ee262487ff7074493e99c05d585cec78a32cddb5569feb9e5ca6407a7104cf7538ed9030e4cb2401be823171de5f5e261de5bd2aeafbc11f
-  data.tar.gz: 31178103ff1168d6a54b622c612260857c4f5841dff32c637a95877a1df3f7c4467221e05c19e7688f1ebf3284d79cc8cf5113208f89ac4299983dcaa2ccf51d
+  metadata.gz: 35c21c3717c63c372fd840b511b2b51161f1114b4e9f8a8140d38ee0d4ca6393950d842b9619ded9731ae32b0abda8ef147ceaacba76f8bcc77d5b6966898b9f
+  data.tar.gz: a1b9a4f2129f9f441786237ed2bc69ff58009343d67d74f5724376f2fc77c0797fd3f932ea404d6b993d26ba210beeeafc1a9b0ad1025ad11169ebf7767f84af

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/generators/templates/migrations/create_context_modules.rb

@@ -11,6 +11,8 @@ class CreateContextModules < ActiveRecord::Migration[5.1]
       t.string :workflow_state
       t.datetime :deleted_at
       t.datetime :unlock_at
+      t.text :completion_requirements
+      t.text :prerequisites
       t.timestamps
     end
 

data/lib/canvas_sync/generators/templates/migrations/create_course_progresses.rb

@@ -0,0 +1,20 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateCourseProgresses < ActiveRecord::Migration[5.1]
+  def change
+    create_table :course_progresses do |t|
+      t.bigint :canvas_course_id, null: false
+      t.bigint :canvas_user_id, null: false
+      t.integer :requirement_count
+      t.integer :requirement_completed_count
+      t.datetime :completion_date
+
+      t.timestamps
+    end
+
+    add_index :course_progresses, :canvas_user_id
+    add_index :course_progresses, :canvas_course_id
+    add_index :course_progresses, [:canvas_user_id, :canvas_course_id], unique: true
+  end
+end
+

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

@@ -14,8 +14,42 @@ class ContextModule < ApplicationRecord
   has_many :context_module_items, primary_key: :canvas_id, foreign_key: :canvas_context_module_id
   has_many :assignments, through: :context_module_items
 
+  serialize :completion_requirements
+  serialize :prerequisites
+
   api_syncable({
-    # TODO If your tool Syncs ContextModules, please complete this and merge it into CanvasSync
-  }, -> (api) { api.course_module(canvas_context_id, canvas_id) })
+    canvas_id: :id,
+    canvas_context_id: :context_id,
+    canvas_context_type: :context_type,
+    position: :position,
+    name: :name,
+    workflow_state: :workflow_state,
+    unlock_at: :unlock_at,
+    completion_requirements: :completion_requirements,
+    prerequisites: :prerequisites,
+    requirement_count: :requirement_count
+  }, lambda { |api|
+    course_modules = api.course_modules(canvas_context_id, { include: ['items'] }) # avoids having 2 API calls for modules as we reuse this data
+    context_module = course_modules&.detect { |course_module| course_module['id'] == canvas_id }
+
+    if context_module.nil? # no context_module here means it is deleted in Canvas
+      self.workflow_state = :deleted
+      return self
+    end
+
+    # The ContextModule model in Canvas has the 'completion_requirements' and 'prerequisites' fields that are not returned directly from the API
+    # We need to compute them here based on data that we receive from course_modules in the API
+    context_module['prerequisites'] = course_modules.map do |course_module|
+      next unless context_module['prerequisite_module_ids']&.include?(course_module['id'])
+
+      {
+        id: course_module['id'],
+        name: course_module['name'],
+        type: 'context_module'
+      }.with_indifferent_access
+    end.compact
 
+    context_module['completion_requirements'] = context_module['items']&.map { |item| item['completion_requirement'] }&.compact
+    context_module
+  })
 end

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

@@ -12,7 +12,15 @@ class ContextModuleItem < ApplicationRecord
   belongs_to :assignment, foreign_key: :canvas_assignment_id, primary_key: :canvas_id
 
   api_syncable({
-    # TODO If your tool Syncs ContextModuleItems, please complete this and merge it into CanvasSync
-  }, -> (api) { api.module_item(context_module.context.canvas_id, context_module.canvas_id, canvas_id) })
-
+    canvas_id: :id,
+    canvas_context_module_id: :module_id,
+    position: :position,
+    canvas_content_type: :type,
+    canvas_content_id: :content_id,
+    canvas_assignment_id: :assignment_id
+  }, lambda { |api|
+    module_item = api.module_item(context_module.context.canvas_id, context_module.canvas_id, canvas_id)
+    module_item['assignment_id'] = api.assignment(context_module.context.canvas_id, module_item['content_id'])['id'] if module_item['type'] == 'Assignment'
+    module_item
+  })
 end

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

@@ -0,0 +1,14 @@
+# <%= autogenerated_model_warning %>
+
+# CourseProgress is not a Canvas model. It is a table built from the Custom Report
+class CourseProgress < ApplicationRecord
+  include CanvasSync::Record
+
+  canvas_sync_features :defaults
+
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+
+  validates_presence_of :canvas_user_id, :canvas_course_id
+  validates_uniqueness_of :canvas_user_id, scope: :canvas_course_id
+end

data/lib/canvas_sync/importers/bulk_importer.rb

@@ -53,6 +53,9 @@ module CanvasSync
                 # TODO: add some timezone config to the mapping.
                 # In cases where the timestamp or date doesn't include a timezone, you should be able to specify one
                 value = DateTime.parse(value).utc rescue nil # rubocop:disable Style/RescueModifier
+              elsif col_def[:type].to_sym == :yaml
+                # CSV parse from reading the report escapes the new lines and YAML throws an error with double backslashes
+                value = YAML.load(value.gsub("\\n", "\n")) rescue nil # rubocop:disable Style/RescueModifier
               end
             end
 

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
 

data/lib/canvas_sync/job_uniqueness/lock_context.rb

@@ -6,8 +6,6 @@ module CanvasSync::JobUniqueness
       context_class.new(data, **kwargs)
     end
 
-    attr_reader :lock_id
-
     # { job_clazz, jid, queue, args?, kwargs?, base_key? }
     def initialize(data, job_instance: nil, config: nil)
       @base_key = data[:base_key]
@@ -16,7 +14,9 @@ module CanvasSync::JobUniqueness
       @config = config || @context_data[:config]
 
       # TODO Consider (somewhere) updating the lock_id to the BID of the wrapping Batch (when applicable)
-      @lock_id ||= data[:lid] || Thread.current[:unique_jobs_previous_context]&.lock_id || job_id
+      @lock_id ||= data[:lid] || Thread.current[:unique_jobs_previous_context]&.lock_id
+      @lock_id_locked = @lock_id.present?
+      @lock_id ||= job_id
     end
 
     # This is primarily for rehydrating in a Batch Callback, so it is unlikely that args and kwargs are needed.
@@ -84,6 +84,18 @@ module CanvasSync::JobUniqueness
       end
     end
 
+    def lock_id
+      @lock_id_locked = true
+      @lock_id
+    end
+
+    def lock_id=(new_id)
+      raise "Lock ID already set" if @lock_id_locked
+      return unless new_id.present?
+      @lock_id = new_id
+      @lock_id_locked = true
+    end
+
     def job_id
       @context_data[:jid]
     end