canvas_sync 0.20.5 → 0.21.0

data/lib/canvas_sync/live_events.rb

@@ -0,0 +1,38 @@
+require_relative './live_events/base_handler.rb'
+require_relative './live_events/process_event_job.rb'
+
+module CanvasSync
+  module LiveEvents
+
+    @@registered_handlers = []
+
+    class << self
+      def listen(event_types = nil, &blk)
+        if event_types != nil
+          blk = wrap_method(blk) do |inner, event|
+            meta = event[:metadata]
+            payload = event[:payload]
+
+            if event_types.include?(meta[:event_name])
+              inner.call(*args)
+            end
+          end
+        end
+
+        @@registered_handlers << blk
+      end
+
+      def registered_handlers
+        @@registered_handlers
+      end
+
+      private
+
+      def wrap_method(inner, &outer)
+        ->(*args) {
+          outer.call(inner, *args)
+        }
+      end
+    end
+  end
+end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.20.5".freeze
+  VERSION = "0.21.0".freeze
 end

data/lib/canvas_sync.rb

@@ -8,6 +8,7 @@ require "canvas_sync/job"
 require "canvas_sync/sidekiq_job"
 require "canvas_sync/api_syncable"
 require "canvas_sync/record"
+require "canvas_sync/live_events"
 require "canvas_sync/jobs/report_starter"
 require "canvas_sync/jobs/report_checker"
 require "canvas_sync/jobs/report_processor_job"

data/spec/canvas_sync/live_events/live_event_sync_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Concerns::LiveEventSync do
+  before(:all) do
+    User.include(CanvasSync::Concerns::LiveEventSync)
+  end
+
+  let(:event) {
+    {
+      "metadata" => {
+        event_name: "user_created",
+      },
+      "payload" => {
+        user_id: 124,
+      },
+    }
+  }
+
+  describe "#perform" do
+    it "determines ID from payload" do
+      expect_any_instance_of(User).to receive(:process_live_event).with(:created, event["payload"], event["metadata"]) do |user, *args|
+        expect(user.canvas_id).to eql 124
+      end
+      User.cs_internal_process_live_event(event.with_indifferent_access)
+    end
+  end
+end

data/spec/canvas_sync/live_events/live_events_controller_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "json/jwt"
+
+RSpec.describe CanvasSync::Api::V1::LiveEventsController, type: :controller do
+  routes { CanvasSync::Engine.routes }
+
+  let(:event) {
+    {
+      "metadata" => {
+        event_name: "user_created",
+      },
+      "payload" => {
+        user_id: 42660000000000001,
+      },
+    }.with_indifferent_access
+  }
+
+  describe "#transform_ids!" do
+    it "transforms sharded IDs to local IDs" do
+      controller.send(:transform_ids!, event)
+      expect(event[:payload][:user_id]).to eql 1
+      expect(event[:payload][:sharded_user_id]).to eql 42660000000000001
+    end
+
+    xit "it does not transform cross-shard IDs" do
+      # TODO
+    end
+  end
+
+  describe "#process_dataservices_event" do
+    let(:private_key) { OpenSSL::PKey::RSA.new(2048) }
+    let(:jwk) { JSON::JWK.new(private_key) }
+    let(:jwks) { JSON::JWK::Set.new([jwk]) }
+
+    before :each do
+      allow(controller).to receive(:dataservices_jwks).and_return(jwks)
+    end
+
+    let(:event_data) { event.to_json }
+
+    it "triggers a background job" do
+      expect(controller).to receive(:dispatch_event)
+      expect(controller).to receive(:validate_tenant!)
+      post :process_event, params: { "_json" => JSON::JWT.new(event).sign(jwk).to_s }
+      expect(response).to be_successful
+    end
+
+    it "does not allow unsigned events" do
+      expect(controller).to_not receive(:validate_tenant!)
+      post :process_event, params: { "_json" => event.to_json }
+      expect(response).to_not be_successful
+    end
+  end
+end

data/spec/canvas_sync/live_events/process_event_job_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::LiveEvents::ProcessEventJob do
+  before(:all) do
+    User.include(CanvasSync::Concerns::LiveEventSync)
+  end
+
+  let(:event) {
+    {
+      "metadata" => {
+        event_name: "user_created",
+      },
+      "payload" => {
+        user_id: 1,
+      },
+    }
+  }
+
+  describe "#perform" do
+    it "invokes a legacy handler if present" do
+      expect(LiveEvents::UserCreatedEvent).to receive(:perform_later)
+      described_class.perform_now(event)
+    end
+
+    it "does not invoke new handlers if legacy is present" do
+      expect(CanvasSync::LiveEvents).to_not receive(:registered_handlers)
+      described_class.perform_now(event)
+    end
+
+    it "invokes new handlers" do
+      hide_const("LiveEvents::UserCreatedEvent")
+      expect(CanvasSync::LiveEvents).to receive(:registered_handlers).and_call_original
+      expect(User).to receive(:cs_internal_process_live_event).and_call_original
+      expect_any_instance_of(User).to receive(:process_live_event).with(:created, event["payload"], event["metadata"])
+      described_class.perform_now(event)
+    end
+  end
+end

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

@@ -10,6 +10,7 @@ class Account < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
   # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -9,6 +9,7 @@
 class Assignment < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -9,6 +9,7 @@
 class AssignmentGroup < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -12,6 +12,7 @@
 class ContextModule < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -9,6 +9,7 @@
 class ContextModuleItem < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -12,6 +12,14 @@ class Course < ApplicationRecord
 
   canvas_sync_features :defaults
 
+  # include CanvasSync::Concerns::LiveEventSync
+  # after_process_live_event do
+  #   if account.nil?
+  #     acc = Account.new(canvas_id: canvas_account_id)
+  #     acc.sync_from_api
+  #   end
+  # end
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_id, optional: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_course_id

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

@@ -12,6 +12,18 @@ class Enrollment < ApplicationRecord
 
   canvas_sync_features :defaults
 
+  # include CanvasSync::Concerns::LiveEventSync
+  # after_process_live_event do
+  #   if user.nil?
+  #     u = User.new(canvas_id: canvas_user_id)
+  #     u.sync_from_api
+  #   end
+  #   if course.nil?
+  #     c = Course.new(canvas_id: canvas_course_id)
+  #     c.sync_from_api
+  #   end
+  # end
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :role, primary_key: :canvas_id, foreign_key: :canvas_role_id, optional: true

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

@@ -12,6 +12,13 @@ class Section < ApplicationRecord
 
   canvas_sync_features :defaults
 
+  # include CanvasSync::Concerns::LiveEventSync
+  # after_process_live_event do
+  #   # A section change could constitute a crosslisting change, which means
+  #   # we need to make sure all our enrollments are pointing to the correct course
+  #   enrollments.update_all(canvas_course_id: canvas_course_id)
+  # end
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_section_id

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

@@ -9,6 +9,7 @@
 class Submission < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::LiveEventSync
 
   canvas_sync_features :defaults
 

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

@@ -12,6 +12,14 @@ class User < ApplicationRecord
 
   canvas_sync_features :defaults
 
+  # include CanvasSync::Concerns::LiveEventSync
+  # around_process_live_event do |user, blk|
+  #   blk.call
+  # rescue Footrest::HttpError::Unauthorized => e
+  #   # This can happen when a new user is created, but hasn't setup a login on Canvas yet.
+  #   Rails.logger.info("Failed to fetch user #{canvas_user_id}: #{e.backtrace}")
+  # end
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :pseudonyms, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id

data/spec/dummy/app/services/live_events/assignment_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class AssignmentEvent < LiveEvents::BaseEvent
+  class AssignmentEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       canvas_assignment_id = local_canvas_id(payload[:assignment_id])

data/spec/dummy/app/services/live_events/course_event.rb

@@ -11,8 +11,7 @@
 
 
 module LiveEvents
-  class CourseEvent < LiveEvents::BaseEvent
-
+  class CourseEvent < CanvasSync::LiveEvents::BaseHandler
     def process
       course = Course.where(canvas_id: local_canvas_id(payload[:course_id])).first_or_initialize
       course.canvas_account_id = local_canvas_id(payload[:account_id])
@@ -22,7 +21,6 @@ module LiveEvents
       end
       course.sync_from_api
     end
-
   end
 
   class CourseCreatedEvent < LiveEvents::CourseEvent; end

data/spec/dummy/app/services/live_events/course_section_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class CourseSectionEvent < LiveEvents::BaseEvent
+  class CourseSectionEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       section = Section.where(canvas_id: local_canvas_id(payload[:course_section_id])).first_or_initialize

data/spec/dummy/app/services/live_events/enrollment_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class EnrollmentEvent < LiveEvents::BaseEvent
+  class EnrollmentEvent < CanvasSync::LiveEvents::BaseHandler
     attr_accessor :enrollment
 
     def process()

data/spec/dummy/app/services/live_events/grade_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class GradeEvent < LiveEvents::BaseEvent
+  class GradeEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       raise "process must be implemented in your subclass"

data/spec/dummy/app/services/live_events/module_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class ModuleEvent < LiveEvents::BaseEvent
+  class ModuleEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       return unless payload["context_type"] == "Course"

data/spec/dummy/app/services/live_events/module_item_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class ModuleItemEvent < LiveEvents::BaseEvent
+  class ModuleItemEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       context_module_item = ContextModuleItem.find_or_initialize_by(canvas_id: payload["module_item_id"])

data/spec/dummy/app/services/live_events/submission_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class SubmissionEvent < LiveEvents::BaseEvent
+  class SubmissionEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       submission = Submission.where(canvas_id: local_canvas_id(payload["submission_id"])).first_or_initialize

data/spec/dummy/app/services/live_events/syllabus_event.rb

@@ -11,7 +11,7 @@
 
 
 module LiveEvents
-  class SyllabusEvent < LiveEvents::BaseEvent
+  class SyllabusEvent < CanvasSync::LiveEvents::BaseHandler
 
     def process
       # syllabus = Syllabus.where(course_id: attrs[:course_id]).first_or_initialize

data/spec/dummy/app/services/live_events/user_event.rb

@@ -11,8 +11,7 @@
 
 
 module LiveEvents
-  class UserEvent < LiveEvents::BaseEvent
-
+  class UserEvent < CanvasSync::LiveEvents::BaseHandler
     def process
       canvas_user_id = local_canvas_id(payload[:user_id])
       user = User.where(canvas_id: canvas_user_id).first_or_initialize
@@ -21,7 +20,6 @@ module LiveEvents
       # This can happen when a new user is created, but hasn't setup a login on Canvas yet.
       Rails.logger.info("Failed to fetch user #{canvas_user_id}: #{e.backtrace}")
     end
-
   end
 
   class UserCreatedEvent < LiveEvents::UserEvent; end

data/spec/dummy/config/routes.rb

@@ -1,2 +1,3 @@
 Rails.application.routes.draw do
+  mount CanvasSync::Engine, at: '/canvas_sync'
 end