Active Record logging includes the tenant name

Author: flavorjones

lib/active_record/tenanted/database_configurations.rb

@@ -19,6 +19,22 @@ def database_path_for(tenant_name)
       end
 
       class TenantConfig < RootConfig
+        def tenant
+          configuration_hash.fetch(:tenant)
+        end
+
+        def new_connection
+          conn = super
+          log_addition = " [tenant=#{tenant}]"
+          conn.instance_eval <<~CODE, __FILE__, __LINE__ + 1
+            def log(sql, name = "SQL", binds = [], type_casted_binds = [], async: false, &block)
+              name ||= ""
+              name += "#{log_addition}"
+              super(sql, name, binds, type_casted_binds, async: async, &block)
+            end
+          CODE
+          conn
+        end
       end
     end
   end

lib/active_record/tenanted/tenant.rb

@@ -57,6 +57,7 @@ def create_tenanted_pool # :nodoc:
           base_config = ActiveRecord::Base.configurations.resolve(tenanted_config_name.to_sym)
           tenant_name = "#{tenanted_config_name}_#{tenant}"
           config_hash = base_config.configuration_hash.dup.tap do |hash|
+            hash[:tenant] = tenant
             hash[:database] = base_config.database_path_for(tenant)
           end
           config = Tenanted::DatabaseConfigurations::TenantConfig.new(base_config.env_name, tenant_name, config_hash)

test/test_helper.rb

@@ -99,6 +99,15 @@ def with_each_scenario(&block)
         end
       end
 
+      def capture_log
+        StringIO.new.tap do |log|
+          logger_was, ActiveRecord::Base.logger = ActiveRecord::Base.logger, ActiveSupport::Logger.new(log)
+          yield
+        ensure
+          ActiveRecord::Base.logger = logger_was
+        end
+      end
+
       private def create_fake_record
         # emulate models like ActiveStorage::Record that inherit directly from AR::Base
         Object.const_set(:FakeRecord, Class.new(ActiveRecord::Base))

test/unit/tenant_test.rb

@@ -69,4 +69,17 @@
       end
     end
   end
+
+  describe "logging" do
+    with_each_scenario do
+      test "database logs should emit the tenant name" do
+        log = capture_log do
+          TenantedApplicationRecord.while_tenanted("foo") do
+            User.count
+          end
+        end
+        assert_includes(log.string, "[tenant=foo]")
+      end
+    end
+  end
 end