panda_pal 5.16.1 → 5.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b33c2970defb1a7405a8482186720ab63a05b10db522e4c39ce56b9aa38c1b9
-  data.tar.gz: 6a44dc5db6d135882e4c2aefe8b7872ea87ccd066fe329b0764e2f8564694800
+  metadata.gz: a2c0409f3edd41806fcd606b52eb0c6441c43dac7b9e1eeb89c1871b6e08525f
+  data.tar.gz: 14b3313348391ab1c364ee9bb404af319bf93b831fc5bd552059faf41a179b71
 SHA512:
-  metadata.gz: 589b2581d892bca49ba635d01a70b9db1f6044b9c885758fdbfb6d483ca3c91861bc22515fdbde2086499c7d380b96f199f8dd26e44e1cd900f2a3c3c72fc53a
-  data.tar.gz: 330d2c17013313a47f361f12709acd99291fe918cdea00405b7f76d55925557000c66b0eee08ea68049ece4acd77e86db1fd3acec73ccacaa3165e235cadcafa
+  metadata.gz: e2c460dd7ac5ff05da55ef6db233f0d266983927e6a295b469d1d19002ea833b26479c5b7db53fb6306761afc683bf3494fc07c63f1ac401f736d73ad803248b
+  data.tar.gz: bcccc2e5ad50d546f3258e513118e97a37f8104901436b3b3920d64986ad83159034a905cce7ded7b81529989d16d8151f0583ec7b273732e2d38be443a6dc8e

data/config/initializers/apartment.rb

@@ -250,49 +250,71 @@ module PandaPal::Plugins::ApartmentCache
 end
 ActiveSupport::Cache::Store.send(:prepend, PandaPal::Plugins::ApartmentCache)
 
-if defined?(ActionCable)
-  module ActionCable
-    module Channel
-      class Base
-        def self.broadcasting_for(model)
-          # Rails 5 #stream_for passes #channel_name as part of model. Rails 6 doesn't and includes it via #broadcasting_for.
-          model = [channel_name, model] unless model.is_a?(Array)
-          serialize_broadcasting([ Apartment::Tenant.current, model ])
-        end
+ActiveSupport.on_load(:action_cable) do
+  ActionCable::Connection::Base.module_eval do
+    def tenant=(name)
+      @tenant = name
+    end
+
+    def tenant
+      @tenant || 'public'
+    end
+  end
 
-        def self.serialize_broadcasting(object)
-          case
-          when object.is_a?(Array)
-            object.map { |m| serialize_broadcasting(m) }.join(":")
-          when object.respond_to?(:to_gid_param)
-            object.to_gid_param
-          else
-            object.to_param
+  # Include the Current Tenant in any broadcastings
+  if Rails.version >= '6.0'
+    ActionCable::Channel::Base.define_singleton_method(:broadcasting_for) do |*args|
+      cconn = ActionCable.server.worker_pool.connection
+      items = [cconn&.tenant || Apartment::Tenant.current, channel_name, *args]
+      serialize_broadcasting(items)
+    end
+  else
+    module ActionCable
+      module Channel
+        class Base
+          def broadcasting_for(model)
+            super([ Apartment::Tenant.current, model ])
           end
         end
       end
     end
   end
 
-  module PandaPal::Plugins::ActionCableApartment
-    module Connection
-      def tenant=(name)
-        @tenant = name
-      end
+  # Lazily switch any worker threads to the correct tenant when they are working
+  #   Actively calling `switch_tenant` for checks out a DB connection and calls `SET search_path`.
+  #   The message processing may not interface with the DB, so this would be a huge waste.
+  #   Instead, we ensure that the thread will trigger a :checkout if it needs a connection,
+  #     at which time we hack-in the correct tenant/schema.
+
+  ActionCable::Server::Worker.set_callback :work, :around do |_, blk|
+    # Bit of a hack, but ensures the adapter is initialized (since such may incur DB calls (requiring a connection)
+    #   which would then cause `checkout` to recurse)
+    Apartment::Tenant.adapter
+
+    # If the current thread already has a connection checked out, release it back to the pool so that the later after_checkout
+    #   callback can set the schema properly.
+    pool = Apartment.connection_class.connection_pool
+    pool.release_connection if pool.active_connection?
+
+    Thread.current[:cable_tenant] = connection.tenant
+    blk.call
+  ensure
+    Thread.current[:cable_tenant] = nil
+  end
 
-      def tenant
-        @tenant || 'public'
-      end
+  ActiveSupport.on_load(:active_record) do
+    if Apartment::Tenant.adapter.is_a?(Apartment::Adapters::PostgresqlSchemaAdapter)
+      ActiveRecord::Base.connection.class.set_callback :checkout, :after do |conn|
+        next unless conn.pool == Apartment.connection_class.connection_pool
 
-      def dispatch_websocket_message(*args, **kwargs)
-        Apartment::Tenant.switch(tenant) do
-          super
+        if (ct = Thread.current[:cable_tenant]).present?
+          adapter = Apartment::Tenant.adapter
+          adapter.instance_variable_set(:@current, ct)
+          conn.schema_search_path = adapter.send :full_search_path
         end
       end
     end
   end
-
-  ActionCable::Connection::Base.prepend(PandaPal::Plugins::ActionCableApartment::Connection)
 end
 
 if defined?(Delayed)

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.16.1"
+  VERSION = "5.16.3"
 end

data/spec/core/apartment_multidb_spec.rb

@@ -31,6 +31,28 @@ RSpec.describe PandaPal::Organization, type: :model do
       end
     end
 
+    it "creates records on the target shard and schema" do
+      org1.switch_tenant
+      PandaPal::ApiCall.create!(logic: "from_primary")
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_primary")
+
+      org2.switch_tenant
+      PandaPal::ApiCall.create!(logic: "from_alt")
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_alt")
+
+      org1.switch_tenant
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_primary")
+      expect(PandaPal::ApiCall.connection.exec_query("SELECT current_database()").pluck("current_database")[0]).to eq("panda_pal_test1")
+
+      org2.switch_tenant
+      expect(PandaPal::ApiCall.count).to eq(1)
+      expect(PandaPal::ApiCall.first.logic).to eq("from_alt")
+      expect(PandaPal::ApiCall.connection.exec_query("SELECT current_database()").pluck("current_database")[0]).to eq("panda_pal_test2")
+    end
+
     context "load_async" do
       it "works across shards" do
         qs = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.16.1
+  version: 5.16.3
 platform: ruby
 authors:
 - Instructure CustomDev