canvas_sync 0.27.13 → 0.27.15

data/spec/canvas_sync/concerns/ability_helper_spec.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+# Focused on what this concern contributes on top of PandaPal: that it asks for
+# INHERITED role labels, and that it keys its Session-persisted cache so the
+# pre-traversal answers don't outlive the change. The traversal itself belongs
+# to (and is tested by) PandaPal::Session#canvas_account_role_labels.
+#
+# panda_pal is not in this gem's bundle, so the session is a hand-rolled double
+# — which is also the only way to assert the exact call that gets made.
+RSpec.describe CanvasSync::Concerns::AbilityHelper do
+  let(:helper_class) do
+    Class.new do
+      include CanvasSync::Concerns::AbilityHelper
+
+      attr_reader :panda_pal_session
+
+      def initialize(session)
+        @panda_pal_session = session
+      end
+    end
+  end
+
+  # Shared bookkeeping: real #cache semantics (memoised into the session under
+  # an arbitrary key), plus a record of every call made.
+  session_base = Class.new do
+    attr_reader :cache_keys, :label_calls
+
+    def initialize(labels: [], site_admin: false, preset_cache: {})
+      @labels = labels
+      @site_admin = site_admin
+      @cache = preset_cache
+      @cache_keys = []
+      @label_calls = []
+    end
+
+    def cache(key)
+      @cache_keys << key
+      return @cache[key] if @cache.key?(key)
+
+      @cache[key] = yield
+    end
+
+    def canvas_site_admin?
+      @site_admin
+    end
+  end
+
+  # Declared exactly as PandaPal >= 5.17 declares it, so keyword detection runs
+  # against a real signature rather than a catch-all that would pass for the
+  # wrong reason.
+  let(:modern_session) do
+    Class.new(session_base) do
+      def canvas_account_role_labels(account = 'self', inherited: false)
+        @label_calls << [account, { inherited: inherited }]
+        @labels
+      end
+    end
+  end
+
+  # PandaPal < 5.17: no keyword at all. Passing one must not reach it.
+  let(:legacy_session) do
+    Class.new(session_base) do
+      def canvas_account_role_labels(account = 'self')
+        @label_calls << [account, {}]
+        @labels
+      end
+    end
+  end
+
+  # A host app decorating the Session and forwarding keywords.
+  let(:forwarding_session) do
+    Class.new(session_base) do
+      def canvas_account_role_labels(account = 'self', **opts)
+        @label_calls << [account, opts]
+        @labels
+      end
+    end
+  end
+
+  def helper_for(klass = nil, **kwargs)
+    helper_class.new((klass || modern_session).new(**kwargs))
+  end
+
+  describe "#canvas_account_admin?" do
+    it "asks PandaPal for inherited role labels" do
+      helper = helper_for(labels: ["AccountAdmin"])
+
+      expect(helper.canvas_account_admin?(300)).to be true
+      expect(helper.panda_pal_session.label_calls).to eq([[300, { inherited: true }]])
+    end
+
+    it "accepts the human-readable \"Account Admin\" label" do
+      expect(helper_for(labels: ["Account Admin"]).canvas_account_admin?(300)).to be true
+    end
+
+    it "is false when the user holds only non-admin roles anywhere in the chain" do
+      expect(helper_for(labels: ["Ops", "Department Admin"]).canvas_account_admin?(300)).to be false
+    end
+
+    it "is true for a Canvas site admin regardless of role labels" do
+      expect(helper_for(labels: [], site_admin: true).canvas_account_admin?(300)).to be true
+    end
+
+    it "keys its cache separately from the pre-traversal answer" do
+      helper = helper_for(labels: ["AccountAdmin"])
+
+      helper.canvas_account_admin?(:root)
+
+      expect(helper.panda_pal_session.cache_keys).to eq([[:canvas_account_admin?, :root, :inherited]])
+    end
+
+    # The regression this guards: a Session launched before the traversal
+    # existed has `false` persisted under the OLD key. Reusing that key would
+    # keep denying an admin who should now pass.
+    it "ignores a stale pre-traversal cache entry" do
+      helper = helper_class.new(
+        modern_session.new(labels: ["AccountAdmin"], preset_cache: { [:canvas_account_admin?, :root] => false })
+      )
+
+      expect(helper.canvas_account_admin?(:root)).to be true
+    end
+
+    it "still memoises within its own key" do
+      helper = helper_for(labels: ["AccountAdmin"])
+
+      helper.canvas_account_admin?(:root)
+      helper.canvas_account_admin?(:root)
+
+      expect(helper.panda_pal_session.label_calls.size).to eq(1)
+    end
+  end
+
+  describe "#canvas_super_user?" do
+    it "delegates to canvas_account_admin? for the install Account" do
+      helper = helper_for(labels: ["AccountAdmin"])
+
+      expect(helper.canvas_super_user?).to be true
+      expect(helper.panda_pal_session.label_calls).to eq([[:root, { inherited: true }]])
+    end
+
+    it "is false for a user with no admin role above or at the install Account" do
+      expect(helper_for(labels: []).canvas_super_user?).to be false
+    end
+  end
+
+  # Upgrade-order safety: an app on a CanvasSync with this change but PandaPal
+  # < 5.17 must not blow up an authorization check with ArgumentError.
+  describe "keyword detection" do
+    it "falls back to the non-inherited call against an older PandaPal" do
+      helper = helper_for(legacy_session, labels: ["AccountAdmin"])
+
+      expect(helper.canvas_account_admin?(300)).to be true
+      expect(helper.panda_pal_session.label_calls).to eq([[300, {}]])
+    end
+
+    it "treats a keyword-forwarding Session as supporting inherited" do
+      helper = helper_for(forwarding_session, labels: ["AccountAdmin"])
+
+      expect(helper.canvas_account_admin?(300)).to be true
+      expect(helper.panda_pal_session.label_calls).to eq([[300, { inherited: true }]])
+    end
+  end
+end

data/spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
             'courses' => true,
             enrollment_term_id: term.canvas_id,
           }
-        })
+        }.with_indifferent_access)
       end
     end
 
@@ -33,7 +33,7 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
             'users' => true,
             'courses' => true,
           }
-        })
+        }.with_indifferent_access)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.27.13
+  version: 0.27.15
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -569,6 +569,7 @@ files:
 - lib/canvas_sync/version.rb
 - lib/tasks/canvas_sync_tasks.rake
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/concerns/ability_helper_spec.rb
 - spec/canvas_sync/concerns/deleted_scoping_spec.rb
 - spec/canvas_sync/concerns/legacy_columns_spec.rb
 - spec/canvas_sync/engine_spec.rb
@@ -636,79 +637,11 @@ files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/internal/app/models/account.rb
-- spec/internal/app/models/admin.rb
 - spec/internal/app/models/application_record.rb
-- spec/internal/app/models/assignment.rb
-- spec/internal/app/models/assignment_group.rb
-- spec/internal/app/models/assignment_override.rb
-- spec/internal/app/models/content_migration.rb
-- spec/internal/app/models/context_module.rb
-- spec/internal/app/models/context_module_item.rb
-- spec/internal/app/models/course.rb
-- spec/internal/app/models/course_nickname.rb
-- spec/internal/app/models/course_progress.rb
-- spec/internal/app/models/enrollment.rb
-- spec/internal/app/models/grading_period.rb
-- spec/internal/app/models/grading_period_group.rb
-- spec/internal/app/models/group.rb
-- spec/internal/app/models/group_membership.rb
-- spec/internal/app/models/learning_outcome.rb
-- spec/internal/app/models/learning_outcome_result.rb
-- spec/internal/app/models/pseudonym.rb
-- spec/internal/app/models/role.rb
-- spec/internal/app/models/rubric.rb
-- spec/internal/app/models/rubric_assessment.rb
-- spec/internal/app/models/rubric_association.rb
-- spec/internal/app/models/score.rb
-- spec/internal/app/models/section.rb
-- spec/internal/app/models/submission.rb
-- spec/internal/app/models/term.rb
-- spec/internal/app/models/user.rb
-- spec/internal/app/models/user_observer.rb
-- spec/internal/app/services/live_events/assignment_event.rb
-- spec/internal/app/services/live_events/course_event.rb
-- spec/internal/app/services/live_events/course_section_event.rb
-- spec/internal/app/services/live_events/enrollment_event.rb
-- spec/internal/app/services/live_events/grade_event.rb
-- spec/internal/app/services/live_events/module_event.rb
-- spec/internal/app/services/live_events/module_item_event.rb
-- spec/internal/app/services/live_events/submission_event.rb
-- spec/internal/app/services/live_events/syllabus_event.rb
-- spec/internal/app/services/live_events/user_event.rb
 - spec/internal/bin/rails
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
 - spec/internal/config/storage.yml
-- spec/internal/db/migrate/20251029222307_create_users.rb
-- spec/internal/db/migrate/20251029222308_create_pseudonyms.rb
-- spec/internal/db/migrate/20251029222309_create_courses.rb
-- spec/internal/db/migrate/20251029222310_create_groups.rb
-- spec/internal/db/migrate/20251029222311_create_group_memberships.rb
-- spec/internal/db/migrate/20251029222312_create_accounts.rb
-- spec/internal/db/migrate/20251029222313_create_terms.rb
-- spec/internal/db/migrate/20251029222314_create_enrollments.rb
-- spec/internal/db/migrate/20251029222315_create_sections.rb
-- spec/internal/db/migrate/20251029222316_create_assignments.rb
-- spec/internal/db/migrate/20251029222317_create_submissions.rb
-- spec/internal/db/migrate/20251029222318_create_roles.rb
-- spec/internal/db/migrate/20251029222319_create_admins.rb
-- spec/internal/db/migrate/20251029222320_create_assignment_groups.rb
-- spec/internal/db/migrate/20251029222321_create_context_modules.rb
-- spec/internal/db/migrate/20251029222322_create_context_module_items.rb
-- spec/internal/db/migrate/20251029222324_create_grading_periods.rb
-- spec/internal/db/migrate/20251029222325_create_grading_period_groups.rb
-- spec/internal/db/migrate/20251029222326_create_content_migrations.rb
-- spec/internal/db/migrate/20251029222327_create_learning_outcomes.rb
-- spec/internal/db/migrate/20251029222328_create_learning_outcome_results.rb
-- spec/internal/db/migrate/20251029222330_create_rubrics.rb
-- spec/internal/db/migrate/20251029222331_create_rubric_associations.rb
-- spec/internal/db/migrate/20251029222332_create_rubric_assessments.rb
-- spec/internal/db/migrate/20251029222334_create_assignment_overrides.rb
-- spec/internal/db/migrate/20251029222335_create_scores.rb
-- spec/internal/db/migrate/20251029223411_create_user_observers.rb
-- spec/internal/db/migrate/20251029224009_create_course_nicknames.rb
-- spec/internal/db/migrate/20251029224010_create_course_progresses.rb
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
@@ -737,8 +670,6 @@ files:
 - spec/support/fixtures/reports/learning_outcome_results.csv
 - spec/support/fixtures/reports/learning_outcomes.csv
 - spec/support/fixtures/reports/provisioning_csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/courses.csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/users.csv
 - spec/support/fixtures/reports/rubric_assessments.csv
 - spec/support/fixtures/reports/rubric_associations.csv
 - spec/support/fixtures/reports/rubrics.csv
@@ -770,6 +701,7 @@ specification_version: 4
 summary: Gem for generating Canvas models and migrations and syncing data from Canvas
 test_files:
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/concerns/ability_helper_spec.rb
 - spec/canvas_sync/concerns/deleted_scoping_spec.rb
 - spec/canvas_sync/concerns/legacy_columns_spec.rb
 - spec/canvas_sync/engine_spec.rb
@@ -837,79 +769,11 @@ test_files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/internal/app/models/account.rb
-- spec/internal/app/models/admin.rb
 - spec/internal/app/models/application_record.rb
-- spec/internal/app/models/assignment.rb
-- spec/internal/app/models/assignment_group.rb
-- spec/internal/app/models/assignment_override.rb
-- spec/internal/app/models/content_migration.rb
-- spec/internal/app/models/context_module.rb
-- spec/internal/app/models/context_module_item.rb
-- spec/internal/app/models/course.rb
-- spec/internal/app/models/course_nickname.rb
-- spec/internal/app/models/course_progress.rb
-- spec/internal/app/models/enrollment.rb
-- spec/internal/app/models/grading_period.rb
-- spec/internal/app/models/grading_period_group.rb
-- spec/internal/app/models/group.rb
-- spec/internal/app/models/group_membership.rb
-- spec/internal/app/models/learning_outcome.rb
-- spec/internal/app/models/learning_outcome_result.rb
-- spec/internal/app/models/pseudonym.rb
-- spec/internal/app/models/role.rb
-- spec/internal/app/models/rubric.rb
-- spec/internal/app/models/rubric_assessment.rb
-- spec/internal/app/models/rubric_association.rb
-- spec/internal/app/models/score.rb
-- spec/internal/app/models/section.rb
-- spec/internal/app/models/submission.rb
-- spec/internal/app/models/term.rb
-- spec/internal/app/models/user.rb
-- spec/internal/app/models/user_observer.rb
-- spec/internal/app/services/live_events/assignment_event.rb
-- spec/internal/app/services/live_events/course_event.rb
-- spec/internal/app/services/live_events/course_section_event.rb
-- spec/internal/app/services/live_events/enrollment_event.rb
-- spec/internal/app/services/live_events/grade_event.rb
-- spec/internal/app/services/live_events/module_event.rb
-- spec/internal/app/services/live_events/module_item_event.rb
-- spec/internal/app/services/live_events/submission_event.rb
-- spec/internal/app/services/live_events/syllabus_event.rb
-- spec/internal/app/services/live_events/user_event.rb
 - spec/internal/bin/rails
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
 - spec/internal/config/storage.yml
-- spec/internal/db/migrate/20251029222307_create_users.rb
-- spec/internal/db/migrate/20251029222308_create_pseudonyms.rb
-- spec/internal/db/migrate/20251029222309_create_courses.rb
-- spec/internal/db/migrate/20251029222310_create_groups.rb
-- spec/internal/db/migrate/20251029222311_create_group_memberships.rb
-- spec/internal/db/migrate/20251029222312_create_accounts.rb
-- spec/internal/db/migrate/20251029222313_create_terms.rb
-- spec/internal/db/migrate/20251029222314_create_enrollments.rb
-- spec/internal/db/migrate/20251029222315_create_sections.rb
-- spec/internal/db/migrate/20251029222316_create_assignments.rb
-- spec/internal/db/migrate/20251029222317_create_submissions.rb
-- spec/internal/db/migrate/20251029222318_create_roles.rb
-- spec/internal/db/migrate/20251029222319_create_admins.rb
-- spec/internal/db/migrate/20251029222320_create_assignment_groups.rb
-- spec/internal/db/migrate/20251029222321_create_context_modules.rb
-- spec/internal/db/migrate/20251029222322_create_context_module_items.rb
-- spec/internal/db/migrate/20251029222324_create_grading_periods.rb
-- spec/internal/db/migrate/20251029222325_create_grading_period_groups.rb
-- spec/internal/db/migrate/20251029222326_create_content_migrations.rb
-- spec/internal/db/migrate/20251029222327_create_learning_outcomes.rb
-- spec/internal/db/migrate/20251029222328_create_learning_outcome_results.rb
-- spec/internal/db/migrate/20251029222330_create_rubrics.rb
-- spec/internal/db/migrate/20251029222331_create_rubric_associations.rb
-- spec/internal/db/migrate/20251029222332_create_rubric_assessments.rb
-- spec/internal/db/migrate/20251029222334_create_assignment_overrides.rb
-- spec/internal/db/migrate/20251029222335_create_scores.rb
-- spec/internal/db/migrate/20251029223411_create_user_observers.rb
-- spec/internal/db/migrate/20251029224009_create_course_nicknames.rb
-- spec/internal/db/migrate/20251029224010_create_course_progresses.rb
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
@@ -938,8 +802,6 @@ test_files:
 - spec/support/fixtures/reports/learning_outcome_results.csv
 - spec/support/fixtures/reports/learning_outcomes.csv
 - spec/support/fixtures/reports/provisioning_csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/courses.csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/users.csv
 - spec/support/fixtures/reports/rubric_assessments.csv
 - spec/support/fixtures/reports/rubric_associations.csv
 - spec/support/fixtures/reports/rubrics.csv

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

@@ -1,35 +0,0 @@
-# #
-# AUTO GENERATED MODEL
-# This model was auto generated by the CanvasSync Gem.
-# You can customize it as needed, but make sure you test
-# any changes you make to the auto generated methods.
-#
-
-
-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
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  validates :canvas_id, uniqueness: true, presence: true
-
-  has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id
-  belongs_to :canvas_parent, class_name: 'Account', optional: true,
-                             primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
-  has_many :sub_accounts, class_name: 'Account',
-                          primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
-  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_account_id
-
-  scope :active, -> { where.not(workflow_state: 'deleted') }
-  # scope :should_canvas_sync, -> { active } # Optional - uses .active if not given
-
-  api_syncable({
-    name: :name,
-    workflow_state: :workflow_state,
-    canvas_parent_account_id: :parent_account_id,
-  }, -> (api) { api.account(canvas_id) })
-end