panda_pal 5.10.1 → 5.12.0

data/lib/panda_pal/spec_helper.rb

@@ -0,0 +1,82 @@
+module PandaPal::SpecHelper
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def with_multiple_shards(shards:, preclean_schemas: [], determine_shard: nil, transactional: true)
+      self.use_transactional_tests = transactional
+
+      original_settings = {}
+
+      before :all do
+        if defined?(DatabaseCleaner)
+          original_settings[:cleaner_strategy] = DatabaseCleaner.strategy
+          DatabaseCleaner.strategy = :truncation
+        end
+
+        Apartment.configure do |config|
+          original_settings[:with_multi_server_setup] = config.with_multi_server_setup
+          config.with_multi_server_setup = true
+        end
+
+        shards.each do |k, v|
+          Apartment.shard_configurations[k.to_s] = Apartment.connection_config.merge(database: v)
+        end
+
+        @existing_org_ids = PandaPal::Organization.pluck(:id)
+
+        Apartment::Tenant.reload!
+
+        clean_schemas(preclean_schemas)
+      end
+
+      after :all do
+        Apartment::Tenant.reset
+
+        Apartment.configure do |config|
+          config.with_multi_server_setup = false
+        end
+
+        shards.each do |k, _|
+          Apartment.shard_configurations.delete(k.to_s)
+        end
+
+        PandaPal::Organization.where.not(id: @existing_org_ids).delete_all
+
+        if defined?(DatabaseCleaner)
+          DatabaseCleaner.strategy = original_settings[:cleaner_strategy]
+        end
+      end
+
+      before :each do
+        clean_schemas(preclean_schemas) unless transactional
+
+        @each_existing_org_ids = PandaPal::Organization.pluck(:id)
+
+        if determine_shard
+          allow_any_instance_of(PandaPal::Organization).to receive(:tenant_name) do |org|
+            shard = determine_shard.call(org)
+            tenant = org.name
+            tenant = "#{shard}:#{tenant}" if shard.present?
+            tenant
+          end
+        end
+      end
+
+      after :each do
+        Apartment::Tenant.reset
+        PandaPal::Organization.where.not(id: @each_existing_org_ids).destroy_all
+      end
+
+      define_method :clean_schemas do |schemas|
+        PandaPal::Organization.where(name: schemas).delete_all
+
+        schemas.each do |schema|
+          Apartment::Tenant.drop(schema) rescue nil
+          shards.each do |k, v|
+            Apartment::Tenant.drop("#{k}:#{schema}") rescue nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.10.1"
+  VERSION = "5.12.0"
 end

data/lib/panda_pal.rb

@@ -43,7 +43,7 @@ module PandaPal
   end
 
   def self.lti_custom_params=(custom_params)
-    @@lti_custom_params = custom_params
+    @@lti_custom_params = custom_params.with_indifferent_access
   end
 
   def self.lti_custom_params

data/panda_pal.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.test_files = Dir["spec/**/*"].reject{|f| f =~ /\/log\//}
 
   s.add_dependency "rails", ">= 4.2"
-  s.add_dependency 'ros-apartment', '~> 2.2'
+  s.add_dependency 'ros-apartment', '~> 3.0'
   s.add_dependency 'ims-lti', '~> 1.2.4'
   s.add_dependency 'browser', '2.5.0'
   s.add_dependency 'attr_encrypted', '~> 4.0.0'
@@ -30,11 +30,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'jwt'
   s.add_dependency 'httparty'
 
-  s.add_development_dependency "rails", "~> 5.2"
+  s.add_development_dependency "rails", "~> 7.0"
   s.add_development_dependency 'pg'
   s.add_development_dependency 'sidekiq', "< 7.0"
   s.add_development_dependency 'sidekiq-scheduler'
-  s.add_development_dependency 'ros-apartment', '~> 2.11'
+  s.add_development_dependency 'ros-apartment', '~> 3.0'
   s.add_development_dependency 'ros-apartment-sidekiq', '~> 1.2'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'factory_girl_rails'

data/spec/core/apartment_multidb_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe PandaPal::Organization, type: :model do
+  context "across multiple DBs" do
+    with_multiple_shards(
+      shards: { alt: "panda_pal_test2" },
+      preclean_schemas: %w[on_primary on_alt],
+      transactional: false,
+      determine_shard: ->(org) { org.name.include?("alt") ? "alt" : nil }
+    )
+
+    let!(:org1) { create(:panda_pal_organization, name: "on_primary") }
+    let!(:org2) { create(:panda_pal_organization, name: "on_alt") }
+
+    it "successfully creates tenants on multiple shards" do
+      expect(1).to eql(1)
+    end
+
+    it "only creates schemas on the target shard" do
+      org1.switch_tenant do
+        schemas = PandaPal::ApiCall.connection.exec_query("SELECT schema_name FROM information_schema.schemata").pluck("schema_name")
+        expect(schemas).to include("on_primary")
+        expect(schemas).to_not include("on_alt")
+      end
+      org2.switch_tenant do
+        schemas = PandaPal::ApiCall.connection.exec_query("SELECT schema_name FROM information_schema.schemata").pluck("schema_name")
+        expect(schemas).to include("on_alt")
+        expect(schemas).to_not include("on_primary")
+      end
+    end
+
+    context "load_async" do
+      it "works across shards" do
+        qs = []
+        PandaPal::Organization.all.each do |org|
+          org.switch_tenant do
+            PandaPal::ApiCall.create!(logic: org.name)
+            qs << PandaPal::ApiCall.select("logic, pg_sleep(0.5)").load_async
+          end
+        end
+        calls = qs.map(&:to_a).flatten
+        expect(calls.pluck(:logic)).to match_array(["on_primary", "on_alt"])
+      end
+    end
+  end
+end

data/spec/dummy/config/database.yml

@@ -14,8 +14,12 @@ development:
   database: panda_pal_development
 
 test:
-  <<: *default
-  database: panda_pal_test
+  test1:
+    <<: *default
+    database: panda_pal_test1
+  test2:
+    <<: *default
+    database: panda_pal_test2
 
 production:
   <<: *default

data/spec/dummy/config/environments/test.rb

@@ -37,6 +37,11 @@ Rails.application.configure do
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
+  config.log_level = :debug
+  config.active_record.verbose_query_logs = true
+  config.active_record.async_query_executor = :multi_thread_pool
+  # config.active_record.global_executor_concurrency = 4
+
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/db/test2_schema.rb

@@ -0,0 +1,18 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2022_07_21_095653) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+end

data/spec/models/panda_pal/api_call_spec.rb

@@ -17,7 +17,7 @@ module PandaPal
 
     describe "#call" do
       it "calls the function with parameters" do
-        expect(subject.call(foo: 'FOO')).to eq 'FOO_bar'
+        expect(subject.call({ foo: 'FOO' })).to eq 'FOO_bar'
       end
     end
 

data/spec/models/panda_pal/organization/settings_validation_spec.rb

@@ -5,6 +5,10 @@ module PandaPal
   RSpec.describe OrganizationConcerns::SettingsValidation, type: :model do
     let!(:org) { create :panda_pal_organization }
 
+    after :all do
+      PandaPal.lti_options[:settings_structure] = nil
+    end
+
     def set_test_settings_structure
       PandaPal.lti_options = {
         title: 'Test App',

data/spec/rails_helper.rb

@@ -1,6 +1,10 @@
 ActiveRecord::Migration.maintain_test_schema!
 
+require "panda_pal/spec_helper"
+
 RSpec.configure do |config|
+  config.include PandaPal::SpecHelper
+
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"
 

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ require 'factory_girl_rails'
 
 ActiveRecord::Migration.maintain_test_schema!
 ActiveRecord::Schema.verbose = false
-load 'dummy/db/schema.rb' # db agnostic
 
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.10.1
+  version: 5.12.0
 platform: ruby
 authors:
 - Instructure CustomDev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-07 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: ims-lti
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: ros-apartment-sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -282,7 +282,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.7.1
-description: 
+description:
 email:
 - pseng@instructure.com
 executables: []
@@ -311,9 +311,11 @@ files:
 - app/lib/panda_pal/lti_jwt_validator.rb
 - app/models/panda_pal/api_call.rb
 - app/models/panda_pal/organization.rb
+- app/models/panda_pal/organization_concerns/multi_database_sharding.rb
 - app/models/panda_pal/organization_concerns/organization_builder.rb
 - app/models/panda_pal/organization_concerns/settings_validation.rb
 - app/models/panda_pal/organization_concerns/task_scheduling.rb
+- app/models/panda_pal/organization_concerns/tenant_handling.rb
 - app/models/panda_pal/panda_pal_record.rb
 - app/models/panda_pal/platform.rb
 - app/models/panda_pal/platform/canvas.rb
@@ -343,21 +345,23 @@ files:
 - lib/panda_pal/helpers/secure_headers.rb
 - lib/panda_pal/helpers/session_replacement.rb
 - lib/panda_pal/plugins.rb
+- lib/panda_pal/spec_helper.rb
 - lib/panda_pal/version.rb
 - lib/tasks/panda_pal_tasks.rake
 - panda_pal.gemspec
 - spec/controllers/panda_pal/api_call_controller_spec.rb
+- spec/core/apartment_multidb_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/bin/bundle
+- spec/dummy/app/bin/rails
+- spec/dummy/app/bin/rake
+- spec/dummy/app/bin/setup
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/bin/setup
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -377,6 +381,7 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/db/schema.rb
+- spec/dummy/db/test2_schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -394,7 +399,7 @@ homepage: http://instructure.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -409,52 +414,54 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: LTI mountable engine
 test_files:
-- spec/rails_helper.rb
-- spec/models/panda_pal/api_call_spec.rb
-- spec/models/panda_pal/organization_spec.rb
-- spec/models/panda_pal/session_spec.rb
-- spec/models/panda_pal/organization/settings_validation_spec.rb
-- spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/controllers/panda_pal/api_call_controller_spec.rb
-- spec/spec_helper.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/public/422.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/404.html
-- spec/dummy/public/500.html
+- spec/core/apartment_multidb_spec.rb
+- spec/dummy/README.rdoc
 - spec/dummy/Rakefile
-- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/bin/bundle
+- spec/dummy/app/bin/rails
+- spec/dummy/app/bin/rake
+- spec/dummy/app/bin/setup
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/config/secrets.yml
+- spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config/application.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
-- spec/dummy/config/routes.rb
+- spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
-- spec/dummy/README.rdoc
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rake
-- spec/dummy/bin/setup
-- spec/dummy/bin/rails
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test2_schema.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
 - spec/factories/panda_pal_organizations.rb
 - spec/factories/panda_pal_sessions.rb
+- spec/models/panda_pal/api_call_spec.rb
+- spec/models/panda_pal/organization/settings_validation_spec.rb
+- spec/models/panda_pal/organization/task_scheduling_spec.rb
+- spec/models/panda_pal/organization_spec.rb
+- spec/models/panda_pal/session_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb