panda_pal 5.10.1 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b642b95a1dba629d9af0aa06b0efd5a504f8b056660860a739d1f3ef24878092
-  data.tar.gz: e1f42715850b2677bf0a6266249470bf4708bddd296fd9a54cfcd09659eaac6d
+  metadata.gz: ab899936461dc59208ae6afef28264feda7a75927798e158ca1ee8381b2ea463
+  data.tar.gz: 20424ac6bef9bede8af9e58e8a1393267b0966f96cf56dd8ae8ed0e5b486420a
 SHA512:
-  metadata.gz: e84736bc29c501d19d46e8add102fb926926dbcc1de9502ba08e462619d080374a3af30d83f3978675b733f0e20283ebeea5c27d2d09569eabea1f92504951fd
-  data.tar.gz: d95f8fd1da243a09f58f3fb45b0d04d3ff547cd43dfc91663e204f5bb114aec8d03084514126f471cf521b64dd49d270ae82deff07674331231509818f1b8dc7
+  metadata.gz: 85041955aabe8255fcf0a4e3cbcfce3c55c690e0d66d74ac511d6b4d70825d796a62a18fe3ac3e0b5dc66e9ddc865c5b45f672940d92c15a1cc38a7ac350ad91
+  data.tar.gz: bcbe2513a4b4916af671f5a913036e0154dd474d510351f6325a2f264d03c1dac10adc4c48bc060c40faafdc798268664c48e2c32943dd4ed3d0dcda076b7ff3

data/README.md

@@ -57,34 +57,32 @@ Use one of these 6 options in `PandaPal.lti_options` hash.
 ### Task Scheduling
 `PandaPal` includes an integration with `sidekiq-scheduler`. You can define tasks on an Organization class Stub like so:
 ```ruby
-# <your_app>/app/models/panda_pal/organization.rb
-require File.expand_path('../../app/models/panda_pal/organization.rb', PandaPal::Engine.called_from)
+# <your_app>/app/models/organization_extension.rb
+module OrganizationExtension
+  extend ActiveSupport::Concern
 
-module PandaPal
-  class Organization
-    # Will invoke CanvasSyncStarterWorker.perform_async() according to the cron schedule
-    scheduled_task '0 15 05 * * *', :identifier, worker: CanvasSyncStarterWorker
+  # Will invoke CanvasSyncStarterWorker.perform_async() according to the cron schedule
+  scheduled_task '0 15 05 * * *', :identifier, worker: CanvasSyncStarterWorker
 
-    # Will invoke the method 'organization_method' on the Organization
-    scheduled_task '0 15 05 * * *', :organization_method_and_identifier
+  # Will invoke the method 'organization_method' on the Organization
+  scheduled_task '0 15 05 * * *', :organization_method_and_identifier
 
-    # If you need to invoke the same method on multiple schedules
-    scheduled_task '0 15 05 * * *', :identifier, worker: :organization_method
+  # If you need to invoke the same method on multiple schedules
+  scheduled_task '0 15 05 * * *', :identifier, worker: :organization_method
 
-    # You can also use a block
-    scheduled_task '0 15 05 * * *', :identifier do
-      # Do Stuff
-    end
+  # You can also use a block
+  scheduled_task '0 15 05 * * *', :identifier do
+    # Do Stuff
+  end
 
-    # You can use a Proc (called in the context of the Organization) to determine the schedule
-    scheduled_task -> { settings[:cron] }, :identifier
+  # You can use a Proc (called in the context of the Organization) to determine the schedule
+  scheduled_task -> { settings[:cron] }, :identifier
 
-    # You can specify a timezone. If a TZ is not coded and settings[:timezone] is present, it will be appended automatically
-    scheduled_task '0 15 05 * * * America/Denver', :identifier, worker: :organization_method
+  # You can specify a timezone. If a TZ is not coded and settings[:timezone] is present, it will be appended automatically
+  scheduled_task '0 15 05 * * * America/Denver', :identifier, worker: :organization_method
 
-    # Setting settings[:task_schedules][:identifier] will override the code cron schedule. Setting it to false will disable the Task
-    # :identifer values _must_ be unique, but can be nil, in which case they will be determined by where (lineno etc) scheduled_task is called
-  end
+  # Setting settings[:task_schedules][:identifier] will override the code cron schedule. Setting it to false will disable the Task
+  # :identifer values _must_ be unique, but can be nil, in which case they will be determined by where (lineno etc) scheduled_task is called
 end
 ```
 
@@ -181,6 +179,18 @@ Rails.application.config.middleware.use 'Apartment::Elevators::Generic', lambda
 It is also possible to switch tenants by implementing `around_action :switch_tenant` in the controller.
 However, it should be noted that calling `switch_tenant` must be used in an `around_action` hook (or given a block), and is only intended to be used for LTI launches, and not subsequent requests.
 
+### Sharding
+PandaPal 5.12 added support for multi-DB sharding. If you wish to use this, add a `shard` column to the `PandaPal::Organization` model. The implementation should be fairly transparent and should behave as normal PandaPal/Apartment - the only difference is that tenants can be created on different DB shards.
+
+The list of available shards is computed from the Environment variables. On startup, the application looks for variables with the following formats:
+- `SHARD_DB_XYZ_URL`
+- `HEROKU_POSTGRESQL_XYZ_URL`
+(where `XYZ` is the shard identifier)
+
+When an `Organization` is created, it is assigned to a random shard (or if no shards were discovered, it is placed in the default database as normal). Alternatively, a specific shard can be specified: `PandaPal::Organization.new(shard: "shard_a")`. An `Organization` can be added to the primary shard with `shard: "default"`
+
+The `PandaPal::Organization` record is still created in the `public` schema of the default database, as per usual.
+
 ### Rake tasks and jobs
 **Delayed Job Support has been removed. This allows each project to assess it's need to handle background jobs.**
 

data/app/controllers/panda_pal/lti_v1_p3_controller.rb

@@ -10,6 +10,7 @@ module PandaPal
 
     before_action :validate_launch!, only: [:resource_link_request]
     around_action :switch_tenant, only: [:resource_link_request]
+    before_action :enforce_environment!, only: [:resource_link_request]
 
     # Redirect to beta/test as necessary
     before_action :forward_to_env_and_region, only: [:login]
@@ -19,6 +20,8 @@ module PandaPal
 
       current_session_data[:lti_platform] = @current_lti_platform&.serialize
       current_session_data[:lti_oauth_nonce] = SecureRandom.uuid
+      current_session_data[:canvas_environment] = params['canvas_environment']
+      current_session_data[:canvas_region] = params['canvas_region']
       current_session.panda_pal_organization_id = -1
 
       @form_action = current_lti_platform.authentication_redirect_url
@@ -136,6 +139,17 @@ module PandaPal
       url
     end
 
+    def enforce_environment!
+      canvas_env = current_session_data[:canvas_environment]
+      return unless canvas_env.present?
+
+      org_canvas_url = current_organization.canvas_url
+
+      if (canvas_env == 'beta' || canvas_env == 'test') && org_canvas_url.present && !org_canvas_url.include?(".#{canvas_env}.")
+        render plain: "This tool is not properly configured for use in #{canvas_env}", status: 400
+      end
+    end
+
     private
 
     def auth_redirect_query

data/app/models/panda_pal/organization.rb

@@ -41,6 +41,9 @@ module PandaPal
     include OrganizationConcerns::OrganizationBuilder if $stdin&.tty?
     include OrganizationConcerns::TaskScheduling if defined?(Sidekiq.schedule)
 
+    include OrganizationConcerns::TenantHandling
+    include OrganizationConcerns::MultiDatabaseSharding if (column_names rescue []).include?('shard')
+
     attr_encrypted :settings, marshal: true, key: :encryption_key, marshaler: SettingsMarshaler
     before_save {|a| a.settings = a.settings} # this is a hacky work-around to a bug where attr_encrypted is not saving settings in place
 
@@ -56,9 +59,6 @@ module PandaPal
     validates :canvas_account_id, presence: true
     validates :salesforce_id, presence: true, uniqueness: true
 
-    after_create :create_schema
-    after_commit :destroy_schema, on: :destroy
-
     define_setting("lti", {
       type: 'Hash',
       required: false,
@@ -71,10 +71,6 @@ module PandaPal
       end
     end
 
-    before_validation on: [:update] do
-      errors.add(:name, 'should not be changed after creation') if name_changed?
-    end
-
     def encryption_key
       # production environment might not have loaded secret_key_base yet.
       # In that case, just read it from env.
@@ -85,18 +81,6 @@ module PandaPal
       end
     end
 
-    def switch_tenant(&block)
-      if block_given?
-        Apartment::Tenant.switch(name, &block)
-      else
-        Apartment::Tenant.switch!(name)
-      end
-    end
-
-    def self.current
-      find_by_name(Apartment::Tenant.current)
-    end
-
     def create_api(logic, expiration: nil, uses: nil, host: nil)
       switch_tenant do
         logic = "current_organization.#{logic}" if logic.is_a?(Symbol)
@@ -109,16 +93,6 @@ module PandaPal
       end
     end
 
-    def rename!(new_name)
-      do_switch = Apartment::Tenant.current == name
-      ActiveRecord::Base.connection.execute(
-        "ALTER SCHEMA \"#{name}\" RENAME TO \"#{new_name}\";"
-      )
-      self.class.where(id: id).update_all(name: new_name)
-      reload
-      switch_tenant if do_switch
-    end
-
     if !PandaPal.lti_options[:platform].present? || PandaPal.lti_options[:platform].is_a?(String)
       CONST_PLATFORM_TYPE = Platform.resolve_platform_class(nil) rescue nil
     else
@@ -192,16 +166,6 @@ module PandaPal
       CONST_PLATFORM_TYPE
     end
 
-    private
-
-    def create_schema
-      Apartment::Tenant.create name
-    end
-
-    def destroy_schema
-      Apartment::Tenant.drop name
-    end
-
     public
 
     PandaPal.resolved_extensions_for(self).each do |ext|

data/app/models/panda_pal/organization_concerns/multi_database_sharding.rb

@@ -0,0 +1,22 @@
+module PandaPal
+  module OrganizationConcerns
+    module MultiDatabaseSharding
+      extend ActiveSupport::Concern
+
+      included do
+        if column_names.include?('shard')
+          validates :shard, format: { with: /\A[a-z0-9_]+\z/i }, allow_blank: true
+
+          before_validation on: [:update] do
+            errors.add(:shard, 'should not be changed after creation') if shard_changed?
+          end
+        end
+      end
+
+      def tenant_name
+        return "#{shard}:#{name}" if shard.present?
+        super
+      end
+    end
+  end
+end

data/app/models/panda_pal/organization_concerns/tenant_handling.rb

@@ -0,0 +1,54 @@
+module PandaPal
+  module OrganizationConcerns
+    module TenantHandling
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def current
+          find_by_name(Apartment::Tenant.current)
+        end
+      end
+
+      included do
+        after_create :create_schema
+        after_commit :destroy_schema, on: :destroy
+
+        before_validation on: [:update] do
+          errors.add(:name, 'should not be changed after creation') if name_changed?
+        end
+      end
+
+      def tenant_name
+        name
+      end
+
+      def switch_tenant(&block)
+        if block_given?
+          Apartment::Tenant.switch(tenant_name, &block)
+        else
+          Apartment::Tenant.switch!(tenant_name)
+        end
+      end
+
+      def rename!(new_name)
+        do_switch = Apartment::Tenant.current == name
+        ActiveRecord::Base.connection.execute(
+          "ALTER SCHEMA \"#{name}\" RENAME TO \"#{new_name}\";"
+        )
+        self.class.where(id: id).update_all(name: new_name)
+        reload
+        switch_tenant if do_switch
+      end
+
+      private
+
+      def create_schema
+        Apartment::Tenant.create tenant_name
+      end
+
+      def destroy_schema
+        Apartment::Tenant.drop tenant_name
+      end
+    end
+  end
+end

data/app/models/panda_pal/session.rb

@@ -42,24 +42,39 @@ module PandaPal
     end
 
     def custom_lti_params
-      # LT 1.3
-      custom_params = launch_params["https://purl.imsglobal.org/spec/lti/claim/custom"]
-      return custom_params if custom_params.present?
-
-      # LTI 1.0/1.1
-      custom_params = {}
-      launch_params.each do |k, v|
-        next unless k.start_with?("custom_")
-        custom_params[k[7..-1]] = v
-      end
+      @custom_lti_params ||= begin
+        # LT 1.3
+        custom_params = launch_params["https://purl.imsglobal.org/spec/lti/claim/custom"]
+        return custom_params if custom_params.present?
+
+        # LTI 1.0/1.1
+        custom_params = {}
+        launch_params.each do |k, v|
+          next unless k.start_with?("custom_")
+          custom_params[k[7..-1]] = v
+        end
 
-      custom_params.with_indifferent_access
+        custom_params.with_indifferent_access
+      end
     end
 
-    def get_lti_cust_param(key)
+    def get_lti_cust_param(key, default: :if_not_var)
       nkey = key.to_s.gsub(/^custom_/, '')
+      default_value = ->() { PandaPal.lti_custom_params[nkey] || PandaPal.lti_custom_params["custom_#{nkey}"] }
+
+      val = launch_params.dig("https://purl.imsglobal.org/spec/lti/claim/custom", nkey) || launch_params[nkey] || launch_params["custom_#{nkey}"]
+
+      if default == :if_not_var
+        if val.is_a?(String) && /\$[\.\w]+/.match?(val) && val == default_value[]
+          return nil
+        end
+      elsif default && !val.present?
+        return default_value[]
+      elsif !default && val == default_value[]
+        return nil
+      end
 
-      launch_params.dig("https://purl.imsglobal.org/spec/lti/claim/custom", nkey) || launch_params[nkey] || launch_params["custom_#{nkey}"]
+      val
     end
 
     def canvas_role_labels

data/config/initializers/apartment.rb

@@ -5,13 +5,212 @@ begin
 rescue LoadError
 end
 
+require "apartment/adapters/postgresql_adapter"
+
+module Apartment
+  SHARD_PREFIXES = ["SHARD_DB", "HEROKU_POSTGRESQL"]
+
+  def self.shard_configurations
+    $shard_configurations ||= begin
+      shard_to_env = {}
+
+      ENV.keys.each do |k|
+        m = /^(#{SHARD_PREFIXES.join("|")})_(\w+)_URL$/.match(k)
+        next unless m
+
+        url = ENV[k]
+        shard_to_env[m[2].downcase] = ActiveRecord::Base.configurations.resolve(url).configuration_hash
+      end
+
+      shard_to_env.freeze unless Rails.env.test?
+
+      shard_to_env
+    end
+  end
+
+  module Tenant
+    self.singleton_class.send(:alias_method, :original_postgresql_adapter, :postgresql_adapter)
+
+    def self.postgresql_adapter(config)
+      if Apartment.with_multi_server_setup
+        adapter = Adapters::PostgresMultiDBSchemaAdapter
+        adapter.new(config)
+      else
+        original_postgresql_adapter(config)
+      end
+    end
+
+    def self.split_tenant(tenant)
+      bits = tenant.split(":", 2)
+      bits.unshift(nil) if bits.length == 1
+      bits[0] = "default" if bits[0].nil? || bits[0].empty?
+      bits
+    end
+  end
+
+  module Adapters
+    class PostgresMultiDBSchemaAdapter < Apartment::Adapters::PostgresqlSchemaAdapter
+      def initialize(*args, **kwargs)
+        super
+        @excluded_model_set = Set.new(Apartment.excluded_models)
+      end
+
+      def process_excluded_model(excluded_model)
+        @excluded_model_set << excluded_model
+        super
+      end
+
+      def is_excluded_model?(model)
+        @excluded_model_set.include?(model.to_s)
+      end
+
+      def db_connection_config(tenant)
+        shard, schema = Tenant.split_tenant(tenant)
+        if shard == "default"
+          @config
+        else
+          Apartment.shard_configurations[shard.downcase]
+        end
+      end
+
+      def drop_command(conn, tenant)
+        shard, schema = Tenant.split_tenant(tenant)
+        conn.execute(%(DROP SCHEMA "#{schema}" CASCADE))
+      end
+
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+        shard, schema = Tenant.split_tenant(tenant)
+
+        Apartment.connection.schema_exists?(schema)
+      end
+
+      def create_tenant_command(conn, tenant)
+        shard, schema = Tenant.split_tenant(tenant)
+        # NOTE: This was causing some tests to fail because of the database strategy for rspec
+        if conn.open_transactions.positive?
+          conn.execute(%(CREATE SCHEMA "#{schema}")).inspect
+        else
+          schema = %(BEGIN;
+          CREATE SCHEMA "#{schema}";
+          COMMIT;)
+
+          conn.execute(schema)
+        end
+      rescue *rescuable_exceptions => e
+        rollback_transaction(conn)
+        raise e
+      end
+
+      def connect_to_new(tenant = nil)
+        return reset if tenant.nil?
+
+        current_tenant = @current
+        tenants_array = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
+        tenant_schemas = map_to_schemas(Array(tenants_array))
+        query_cache_enabled = ActiveRecord::Base.connection.query_cache_enabled
+
+        @current = tenants_array
+
+        raise ActiveRecord::StatementInvalid, "PandaPal/Apartment Mutli-DB support does not currently support DB roles" if ActiveRecord::Base.current_role != ActiveRecord::Base.default_role
+
+        unless ActiveRecord::Base.connected?
+          Apartment.establish_connection multi_tenantify(tenant, false)
+          Apartment.connection.verify!
+        end
+
+        Apartment.connection.enable_query_cache! if query_cache_enabled
+
+        raise ActiveRecord::StatementInvalid, "Could not find schema for tenant #{tenant} (#{tenant_schemas.inspect})" unless schema_exists?(tenant_schemas)
+
+        Apartment.connection.schema_search_path = full_search_path
+      rescue *rescuable_exceptions => e
+        @current = current_tenant
+        raise_schema_connect_to_new(tenant, e)
+      end
+
+      protected
+
+      def persistent_schemas
+        map_to_schemas(super)
+      end
+
+      def map_to_schemas(tenants)
+        all_shard = nil
+        tenants.map do |schema|
+          shard, schema = Tenant.split_tenant(schema)
+          all_shard ||= shard
+          raise "Cannot mix shards in persistent_schemas" if shard != all_shard
+          schema
+        end
+      end
+    end
+  end
+
+  module CorePatches
+    module ActiveRecord
+      module FutureResult
+        # called in the original thread that knows the tenant
+        def initialize(_pool, *_args, **_kwargs)
+          @tenant = Apartment::Tenant.current
+          super
+        end
+
+        # called in the new thread with a connection that needs switching
+        def exec_query(_conn, *_args, **_kwargs)
+          Apartment::Tenant.switch!(@tenant) unless Apartment::Tenant.current == @tenant
+          super
+        end
+      end
+
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          self.singleton_class.send(:alias_method, :pre_apartment_current_shard, :current_shard)
+
+          def self.current_shard
+            # This implementation is definitely a hack, but it should be fairly compatible. If you need to leverage
+            #   Rails' sharding natively - you should just need to add models to the excluded_models list in Apartment
+            #   to effectively disable this patch for that model.
+            if (adapter = Thread.current[:apartment_adapter]) && adapter.is_a?(Apartment::Adapters::PostgresMultiDBSchemaAdapter) && !adapter.is_excluded_model?(self)
+              shard, schema = Apartment::Tenant.split_tenant(adapter.current)
+              return "apt:#{shard}" unless shard == "default"
+            end
+
+            pre_apartment_current_shard
+          end
+        end
+      end
+    end
+  end
+
+  # Fix Apartment's lack of support for load_async
+  ::ActiveRecord::FutureResult.prepend CorePatches::ActiveRecord::FutureResult
+
+  # Hack ActiveRecord shards/connection_pooling to support our multi-DB approach
+  ::ActiveRecord::Base.include CorePatches::ActiveRecord::Base
+end
+
 Apartment.configure do |config|
   config.excluded_models ||= []
   config.excluded_models |= ['PandaPal::Organization', 'PandaPal::Session']
 
-  config.tenant_names = lambda {
-    PandaPal::Organization.pluck(:name)
-  }
+  config.with_multi_server_setup = true unless Rails.env.test?
+
+  config.tenant_names = lambda do
+    if PandaPal::Organization < PandaPal::OrganizationConcerns::MultiDatabaseSharding
+      base_config = Apartment.connection_config
+      shard_configurations = Apartment.shard_configurations
+
+      PandaPal::Organization.all.to_a.each_with_object({}) do |org, hash|
+        shard = org.shard || "default"
+        hash[org.tenant_name] = shard == "default" ? base_config : shard_configurations[shard.downcase]
+      end
+    else
+      PandaPal::Organization.pluck(:name)
+    end
+  end
 end
 
 Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|

data/lib/panda_pal/engine.rb

@@ -7,8 +7,6 @@ require_relative './helpers/console_helpers'
 
 module PandaPal
   class Engine < ::Rails::Engine
-    config.autoload_once_paths += Dir["#{config.root}/lib/**/"]
-
     isolate_namespace PandaPal
 
     config.generators do |g|