panda_pal 5.16.2 → 5.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c39df6be8d76f63ab12597a80696f629aac5da4a400adfa30119f303177251c
-  data.tar.gz: 2ab2639ea53d3e698244d65313f94b5ebc6c5edcb5039efc0b7dd801658a1603
+  metadata.gz: a2c0409f3edd41806fcd606b52eb0c6441c43dac7b9e1eeb89c1871b6e08525f
+  data.tar.gz: 14b3313348391ab1c364ee9bb404af319bf93b831fc5bd552059faf41a179b71
 SHA512:
-  metadata.gz: '06705595bcabf1959f7a2d72e7174d6944acc0876770878aa700d926d5b4beefdbb4a8af9462009a253d6eaf4a3fc3870f915291baa6490f5d2ecd756f84a275'
-  data.tar.gz: dac25e88efe02b2982e6441506e5d17328b3ee4500627d400523f37da6f7e6093c2a5d85492a73eb5946e616bc0ae7839730620ed66deb8986c952e416fc8f83
+  metadata.gz: e2c460dd7ac5ff05da55ef6db233f0d266983927e6a295b469d1d19002ea833b26479c5b7db53fb6306761afc683bf3494fc07c63f1ac401f736d73ad803248b
+  data.tar.gz: bcccc2e5ad50d546f3258e513118e97a37f8104901436b3b3920d64986ad83159034a905cce7ded7b81529989d16d8151f0583ec7b273732e2d38be443a6dc8e

data/config/initializers/apartment.rb

@@ -250,94 +250,71 @@ module PandaPal::Plugins::ApartmentCache
 end
 ActiveSupport::Cache::Store.send(:prepend, PandaPal::Plugins::ApartmentCache)
 
-if defined?(ActionCable)
-  module PandaPal::Plugins::ActionCableApartment
-    module Connection
-      def tenant=(name)
-        @tenant = name
-      end
-
-      def tenant
-        @tenant || 'public'
-      end
+ActiveSupport.on_load(:action_cable) do
+  ActionCable::Connection::Base.module_eval do
+    def tenant=(name)
+      @tenant = name
     end
-  end
 
-  if Rails.version < '7.0'
-    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
-
-          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
-            end
-          end
-        end
-      end
+    def tenant
+      @tenant || 'public'
     end
+  end
 
-    module PandaPal::Plugins::ActionCableApartment::Connection
-      def dispatch_websocket_message(*args, **kwargs)
-        Apartment::Tenant.switch(tenant) do
-          super
-        end
-      end
+  # 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 self.broadcasting_for(*args)
-            cconn = ActionCable.server.worker_pool.connection
-            items = [cconn&.tenant || Apartment::Tenant.current, channel_name, *args]
-            serialize_broadcasting(items)
+          def broadcasting_for(model)
+            super([ Apartment::Tenant.current, model ])
           end
         end
       end
     end
+  end
 
-    ActionCable::Server::Worker.set_callback :work, :around do |_, blk|
-      pten = Thread.current[:cable_tenant]
-      Thread.current[:cable_tenant] = connection.tenant
-      blk.call
-    ensure
-      Thread.current[:cable_tenant] = pten
-    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
 
+  ActiveSupport.on_load(:active_record) do
     if Apartment::Tenant.adapter.is_a?(Apartment::Adapters::PostgresqlSchemaAdapter)
-      module ApartmentConnPoolMixin
-        # Allows cable channels to lazy-load the tenant schema on first use
-        #   (Using `switch` will ping the DB even if no queries are made)
-        def acquire_connection(...)
-          super.tap do |conn|
-            if ct = Thread.current[:cable_tenant]
-              Thread.current[:cable_tenant] = nil
-              adapter = Apartment::Tenant.adapter
-              # Apartment::Tenant.switch!(ct)
-              Thread.current[:cable_tenant] = ct
-              adapter.instance_variable_set(:@current, ct)
-              conn.schema_search_path = adapter.send :full_search_path
-            end
-          end
+      ActiveRecord::Base.connection.class.set_callback :checkout, :after do |conn|
+        next unless conn.pool == Apartment.connection_class.connection_pool
+
+        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
-
-      ActiveRecord::ConnectionAdapters::ConnectionPool.prepend(ApartmentConnPoolMixin)
     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.2"
+  VERSION = "5.16.3"
 end

metadata

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