canvas_sync 0.26.0.beta2 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913868034039ed594b3f1808512d6346887d1a0a5935fe13d250ea2a9a109df5
-  data.tar.gz: e6fc6a923d7f298926312ece015a94df39c9a543954e4c38197eaf7abdadfbd3
+  metadata.gz: de18757d9f34a2b87abf23c01b530ec430c9b062076807fdfc0a7998275f32fd
+  data.tar.gz: 23d760b8d2321535b13f54bd180127da73b850208b9fe8c290c3df104c8bd87c
 SHA512:
-  metadata.gz: 2616055d4f7fad53ff118b9f5ec0cb1948f316e8f8c9a40df8cbea780c4992aa1c6d7545c4149e46f5aec230e892227b543b664407f044a799e66deb248aea75
-  data.tar.gz: cb9ec962cda4fc4561c98fa96c4443e8bd745156c28ff99c5d45ddebc4e6e82582d551c649cc90c6b11c333e11f522d9da40d9bf5cc38afa72217609285448ea
+  metadata.gz: 7550620a27aaf21ef46781f6aa1f13019b5fca01740e1042a84f382617d4ebe685663a3351ddb3672dc4ec04b0690a313a7d0ffa797a3346f80cee36c0f87a4d
+  data.tar.gz: 2ddf86c553495b781a7023ad6171f1594c19def1bdfee9fe17dbd1160741f06c229b75d728c3161a4d36bbd34ce1bfc86a6d1ab91e4b2f0b15f5f382e10be2c0

data/README.md

@@ -302,6 +302,26 @@ class CanvasSyncModel < ApplicationRecord
 end
 ```
 
+### AbilityHelper + JIT Sync
+`CanvasSync` includes the `CanvasSync::Concerns::AbilityHelper` Concern. It provides helper methods to access `User` `Role`s and permissions, as well as to map LTI launch parameters to `CanvasSync`-synced records. (See the Concern for all available methods).
+
+The built-in implementation assumes the use of `PandaPal` and our the CustomDev-typical launch_param naming:
+- `custom_canvas_user_id`
+- `custom_canvas_course_id`
+- `custom_canvas_account_id`
+
+Additionally, if and `_id` is present but the record can't be found, CanvasSync will attempt to perform Just-in-Time syncing via the Canvas API and `api_syncable`.
+
+If you need to sync some extra data after the sync of the record itself (eg the Sections w/i a Course), a callback is provided:
+```ruby
+after_jit_sync do
+  sections_response = canvas_sync_client.course_sections(canvas_id)
+  Section.bulk_sync_from_api_result(sections_response)
+end
+```
+
+`before_jit_sync` is provided as well, but it's use case in niche. It can `throw :jit_found, record` to abort the rest of the JIT process and instead return a specific record. Again, should be quite niche.
+
 ### Job Batching
 CanvasSync adds a `CanvasSync::JobBatches` module. It adds Sidekiq/sidekiq-batch like support for Job Batches.
 It integrates automatically with both Sidekiq and ActiveJob. The API is highly similar to the Sidekiq-batch implementation,

data/lib/canvas_sync/concerns/ability_helper.rb

@@ -18,7 +18,17 @@ module CanvasSync::Concerns
 
     # Middle Domain
 
+    def user
+      return @user if defined?(@user)
+
+      canvas_user_id = panda_pal_session.get_lti_cust_param('custom_canvas_user_id')
+      @user = load_canvas_model(::User, canvas_user_id) if canvas_user_id.present?
+      @user
+    end
+
     def launch_context
+      return nil unless panda_pal_session.present?
+
       @launch_context ||= begin
         if panda_pal_session.lti_launch_placement == "global_navigation"
           :global
@@ -46,9 +56,13 @@ module CanvasSync::Concerns
     # CanvasSync Domain
 
     def load_canvas_model(model, canvas_id)
-      record = model.find_or_fetch(canvas_id, save: true) if model.respond_to?(:find_or_fetch)
-      record ||= model.find_by(canvas_id: canvas_id)
-      record
+      return nil unless model < CanvasSync::Record
+
+      if model.respond_to?(:find_or_jit_sync)
+        model.find_or_jit_sync(canvas_id)
+      else
+        model.find_by(canvas_id: canvas_id)
+      end
     end
 
     def canvas_permissions

data/lib/canvas_sync/concerns/api_syncable.rb

@@ -30,7 +30,7 @@ module CanvasSync::Concerns
       end
 
       def bulk_sync_from_api_result(api_array, conflict_target: :canvas_id, import_args: {}, all_pages: true, batch_size: 1000)
-        columns = api_sync_options[:field_map].keys
+        columns = api_sync_options[:field_map].keys + [:canvas_id]
 
         update_conditions = {
           condition: CanvasSync::Importers::BulkImporter.condition_sql(self, columns),
@@ -39,12 +39,12 @@ module CanvasSync::Concerns
         update_conditions[:conflict_target] = conflict_target if conflict_target.present?
         options = { validate: false, on_duplicate_key_update: update_conditions }.merge(import_args)
 
-        if all_pages
+        if all_pages && api_array.respond_to?(:all_pages_each)
           enumer = api_array.all_pages_each.lazy
 
           # Map the API response to instances of this model
           enumer = enumer.map do |api_item|
-            new.assign_from_api_params(api_item)
+            new(canvas_id: api_item[:id]).assign_from_api_params(api_item)
           end
 
           # Import in batches
@@ -53,9 +53,9 @@ module CanvasSync::Concerns
           end
         else
           items = api_array.map do |api_item|
-            new.assign_from_api_params(api_item)
+            new(canvas_id: api_item[:id]).assign_from_api_params(api_item)
           end
-          import(columns, batch, options)
+          import(columns, items, options)
         end
       end
 

data/lib/canvas_sync/concerns/jit_syncing.rb

@@ -0,0 +1,59 @@
+module CanvasSync::Concerns
+  module JitSyncing
+    extend ActiveSupport::Concern
+
+    CanvasSync::Record.define_feature self, default: true
+
+    class_methods do
+      def find_or_jit_sync(canvas_id)
+        transaction do
+          rec = find_or_initialize_by(canvas_id: canvas_id)
+          return rec if rec.persisted?
+
+          catch :jit_found do
+            context = JitContext.new
+            rec.instance_variable_set(:@_canvas_sync_jit_context, context)
+
+            rec.run_callbacks(:jit_sync) do
+              api_response = rec.request_from_api(retries: 1)
+              context.instance_variable_set(:@api_response, api_response)
+
+              api_sync_race_create!(rec, save: true) do |inst2|
+                # Some other thread ended up creating the record before us, so assume that it handled
+                #   everything beyond this point, including the after_jit_sync hooks
+                throw :jit_found, inst2 unless inst2 === rec
+
+                inst2.assign_from_api_params(api_response)
+              end
+
+              ActiveSupport::Notifications.instrument("record_jit_sync.canvas_sync", {
+                record: rec,
+              })
+
+              rec
+            end
+          ensure
+            rec.instance_variable_set(:@_canvas_sync_jit_context, nil)
+          end
+        end
+      end
+    end
+
+    included do
+      define_model_callbacks :jit_sync
+    end
+
+    protected
+
+    def jit_context
+      @_canvas_sync_jit_context
+    end
+
+    class JitContext
+      attr_reader :api_response
+
+      def initialize
+      end
+    end
+  end
+end

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

@@ -36,8 +36,12 @@ class Course < ApplicationRecord
     end_at: :end_at,
     # If opting in the public_description, make sure to also add the 'include' array in the api call
     # public_description: :public_description,
+    # }, -> (api) { api.course(canvas_id, { include: ['public_description'] }) })
   }, -> (api) { api.course(canvas_id) })
-  # }, -> (api) { api.course(canvas_id, { include: ['public_description'] }) })
+
+  # after_jit_sync do
+  #   Section.bulk_sync_from_api_result(canvas_sync_client.course_sections(canvas_id))
+  # end
 
   scope :active, -> { where(workflow_state: 'active') }
 

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.26.0.beta2".freeze
+  VERSION = "0.26.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.26.0.beta2
+  version: 0.26.0
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -450,6 +450,7 @@ files:
 - lib/canvas_sync/concerns/api_syncable.rb
 - lib/canvas_sync/concerns/canvas_id_as_primary.rb
 - lib/canvas_sync/concerns/deleted_scoping.rb
+- lib/canvas_sync/concerns/jit_syncing.rb
 - lib/canvas_sync/concerns/legacy_columns.rb
 - lib/canvas_sync/concerns/live_event_sync.rb
 - lib/canvas_sync/concerns/role/base.rb