ros-apartment 3.1.0 → 3.3.0

data/lib/apartment/adapters/abstract_adapter.rb

@@ -5,6 +5,7 @@ module Apartment
     # Abstract adapter from which all the Apartment DB related adapters will inherit the base logic
     class AbstractAdapter
       include ActiveSupport::Callbacks
+
       define_callbacks :create, :switch
 
       attr_writer :default_tenant
@@ -21,7 +22,7 @@ module Apartment
       #   @param {String} tenant Tenant name
       #
       def create(tenant)
-        run_callbacks :create do
+        run_callbacks(:create) do
           create_tenant(tenant)
 
           switch(tenant) do
@@ -72,7 +73,7 @@ module Apartment
       #   @param {String} tenant name
       #
       def switch!(tenant = nil)
-        run_callbacks :switch do
+        run_callbacks(:switch) do
           connect_to_new(tenant).tap do
             Apartment.connection.clear_query_cache
           end
@@ -88,9 +89,11 @@ module Apartment
         switch!(tenant)
         yield
       ensure
+        # Always attempt rollback to previous tenant, even if block raised
         begin
           switch!(previous_tenant)
         rescue StandardError => _e
+          # If rollback fails (tenant was dropped, connection lost), fall back to default
           reset
         end
       end
@@ -99,7 +102,7 @@ module Apartment
       #
       def each(tenants = Apartment.tenant_names)
         tenants.each do |tenant|
-          switch(tenant) { yield tenant }
+          switch(tenant) { yield(tenant) }
         end
       end
 
@@ -116,7 +119,7 @@ module Apartment
       #   Reset the tenant connection to the default
       #
       def reset
-        Apartment.establish_connection @config
+        Apartment.establish_connection(@config)
       end
 
       #   Load the rails seed file into the db
@@ -147,7 +150,7 @@ module Apartment
       protected
 
       def process_excluded_model(excluded_model)
-        excluded_model.constantize.establish_connection @config
+        excluded_model.constantize.establish_connection(@config)
       end
 
       def drop_command(conn, tenant)
@@ -178,11 +181,14 @@ module Apartment
       def connect_to_new(tenant)
         return reset if tenant.nil?
 
+        # Preserve query cache state across tenant switches
+        # Rails disables it during connection establishment
         query_cache_enabled = ActiveRecord::Base.connection.query_cache_enabled
 
-        Apartment.establish_connection multi_tenantify(tenant)
-        Apartment.connection.active? # call active? to manually check if this connection is valid
+        Apartment.establish_connection(multi_tenantify(tenant))
+        Apartment.connection.verify! # Explicitly validate connection is live
 
+        # Restore query cache if it was previously enabled
         Apartment.connection.enable_query_cache! if query_cache_enabled
       rescue *rescuable_exceptions => e
         Apartment::Tenant.reset if reset_on_connection_exception?
@@ -216,7 +222,7 @@ module Apartment
       #   Load a file or raise error if it doesn't exists
       #
       def load_or_raise(file)
-        raise FileNotFound, "#{file} doesn't exist yet" unless File.exist?(file)
+        raise(FileNotFound, "#{file} doesn't exist yet") unless File.exist?(file)
 
         load(file)
       end
@@ -239,15 +245,16 @@ module Apartment
         Apartment.db_config_for(tenant).dup
       end
 
-      def with_neutral_connection(tenant, &_block)
+      def with_neutral_connection(tenant, &)
         if Apartment.with_multi_server_setup
-          # neutral connection is necessary whenever you need to create/remove a database from a server.
-          # example: when you use postgresql, you need to connect to the default postgresql database before you create
-          # your own.
+          # Multi-server setup requires separate connection handler to avoid polluting
+          # the main connection pool. For example: connecting to postgres 'template1'
+          # database to CREATE/DROP tenant databases without affecting app connections.
           SeparateDbConnectionHandler.establish_connection(multi_tenantify(tenant, false))
           yield(SeparateDbConnectionHandler.connection)
           SeparateDbConnectionHandler.connection.close
         else
+          # Single-server: reuse existing connection (safe for most operations)
           yield(Apartment.connection)
         end
       end
@@ -257,17 +264,19 @@ module Apartment
       end
 
       def raise_drop_tenant_error!(tenant, exception)
-        raise TenantNotFound, "Error while dropping tenant #{environmentify(tenant)}: #{exception.message}"
+        raise(TenantNotFound, "Error while dropping tenant #{environmentify(tenant)}: #{exception.message}")
       end
 
       def raise_create_tenant_error!(tenant, exception)
-        raise TenantExists, "Error while creating tenant #{environmentify(tenant)}: #{exception.message}"
+        raise(TenantExists, "Error while creating tenant #{environmentify(tenant)}: #{exception.message}")
       end
 
       def raise_connect_error!(tenant, exception)
-        raise TenantNotFound, "Error while connecting to tenant #{environmentify(tenant)}: #{exception.message}"
+        raise(TenantNotFound, "Error while connecting to tenant #{environmentify(tenant)}: #{exception.message}")
       end
 
+      # Dedicated AR connection class for neutral connections (admin operations like CREATE/DROP DATABASE).
+      # Prevents admin commands from polluting the main application connection pool.
       class SeparateDbConnectionHandler < ::ActiveRecord::Base
       end
     end

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -5,7 +5,7 @@ require 'apartment/adapters/abstract_jdbc_adapter'
 module Apartment
   module Tenant
     def self.jdbc_mysql_adapter(config)
-      Adapters::JDBCMysqlAdapter.new config
+      Adapters::JDBCMysqlAdapter.new(config)
     end
   end
 

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -38,12 +38,12 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless schema_exists?(tenant)
+        raise(ActiveRecord::StatementInvalid, "Could not find schema #{tenant}") unless schema_exists?(tenant)
 
         @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
       rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise TenantNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
+        raise(TenantNotFound, "One of the following schema(s) is invalid: #{full_search_path}")
       end
 
       private
@@ -51,7 +51,7 @@ module Apartment
       def tenant_exists?(tenant)
         return true unless Apartment.tenant_presence_check
 
-        Apartment.connection.all_schemas.include? tenant
+        Apartment.connection.all_schemas.include?(tenant)
       end
 
       def rescue_from

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -44,7 +44,7 @@ module Apartment
       def reset
         return unless default_tenant
 
-        Apartment.connection.execute "use `#{default_tenant}`"
+        Apartment.connection.execute("use `#{default_tenant}`")
       end
 
       protected
@@ -54,7 +54,7 @@ module Apartment
       def connect_to_new(tenant)
         return reset if tenant.nil?
 
-        Apartment.connection.execute "use `#{environmentify(tenant)}`"
+        Apartment.connection.execute("use `#{environmentify(tenant)}`")
       rescue ActiveRecord::StatementInvalid => e
         Apartment::Tenant.reset
         raise_connect_error!(tenant, e)

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -57,7 +57,8 @@ module Apartment
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.tap do |klass|
-          # Ensure that if a schema *was* set, we override
+          # Strip any existing schema qualifier (handles "schema.table" → "table")
+          # Then explicitly set to default schema to prevent tenant-based queries
           table_name = klass.table_name.split('.', 2).last
 
           klass.table_name = "#{default_tenant}.#{table_name}"
@@ -72,15 +73,10 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless schema_exists?(tenant)
+        raise(ActiveRecord::StatementInvalid, "Could not find schema #{tenant}") unless schema_exists?(tenant)
 
         @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
-
-        # When the PostgreSQL version is < 9.3,
-        # there is a issue for prepared statement with changing search_path.
-        # https://www.postgresql.org/docs/9.3/static/sql-prepare.html
-        Apartment.connection.clear_cache! if postgresql_version < 90_300
       rescue *rescuable_exceptions => e
         raise_schema_connect_to_new(tenant, e)
       end
@@ -94,7 +90,8 @@ module Apartment
       end
 
       def create_tenant_command(conn, tenant)
-        # NOTE: This was causing some tests to fail because of the database strategy for rspec
+        # Avoid nested transactions: if already in transaction (e.g., RSpec tests),
+        # execute directly. Otherwise, wrap in explicit transaction for atomicity.
         if ActiveRecord::Base.connection.open_transactions.positive?
           conn.execute(%(CREATE SCHEMA "#{tenant}"))
         else
@@ -106,7 +103,7 @@ module Apartment
         end
       rescue *rescuable_exceptions => e
         rollback_transaction(conn)
-        raise e
+        raise(e)
       end
 
       def rollback_transaction(conn)
@@ -136,7 +133,7 @@ module Apartment
       end
 
       def raise_schema_connect_to_new(tenant, exception)
-        raise TenantNotFound, <<~EXCEPTION_MESSAGE
+        raise(TenantNotFound, <<~EXCEPTION_MESSAGE)
           Could not set search path to schemas, they may be invalid: "#{tenant}" #{full_search_path}.
           Original error: #{exception.class}: #{exception}
         EXCEPTION_MESSAGE
@@ -151,11 +148,32 @@ module Apartment
         /SET row_security/i,                          # new in postgresql 9.5
         /SET idle_in_transaction_session_timeout/i,   # new in postgresql 9.6
         /SET default_table_access_method/i,           # new in postgresql 12
-        /CREATE SCHEMA public/i,
-        /COMMENT ON SCHEMA public/i
+        /CREATE SCHEMA/i,
+        /COMMENT ON SCHEMA/i,
+        /SET transaction_timeout/i,                   # new in postgresql 17
+
+      ].freeze
 
+      # PostgreSQL meta-commands (backslash commands) that appear in pg_dump output
+      # but are not valid SQL when passed to ActiveRecord's execute().
+      # These must be filtered out to prevent syntax errors during schema import.
+      PSQL_META_COMMANDS = [
+        /^\\connect/i,
+        /^\\set/i,
+        /^\\unset/i,
+        /^\\copyright/i,
+        /^\\echo/i,
+        /^\\warn/i,
+        /^\\o/i,
+        /^\\t/i,
+        /^\\q/i,
+        /^\\./i, # Catch-all for any backslash command (e.g., \. for COPY delimiter,
+        # \restrict/\unrestrict in PostgreSQL 17.6+, and future meta-commands)
       ].freeze
 
+      # Combined blacklist: SQL statements and psql meta-commands to filter from pg_dump output
+      PSQL_DUMP_GLOBAL_BLACKLIST = (PSQL_DUMP_BLACKLISTED_STATEMENTS + PSQL_META_COMMANDS).freeze
+
       def import_database_schema
         preserving_search_path do
           clone_pg_schema
@@ -165,9 +183,9 @@ module Apartment
 
       private
 
-      # Re-set search path after the schema is imported.
-      # Postgres now sets search path to empty before dumping the schema
-      # and it mut be reset
+      # PostgreSQL's pg_dump clears search_path in the dump output, which would
+      # leave us with an empty path after import. Capture current path, execute
+      # import, then restore it to maintain tenant context.
       #
       def preserving_search_path
         search_path = Apartment.connection.execute('show search_path').first['search_path']
@@ -194,15 +212,13 @@ module Apartment
       #   @return {String} raw SQL contaning only postgres schema dump
       #
       def pg_dump_schema
-        # Skip excluded tables? :/
-        # excluded_tables =
-        #   collect_table_names(Apartment.excluded_models)
-        #   .map! {|t| "-T #{t}"}
-        #   .join(' ')
-
-        # `pg_dump -s -x -O -n #{default_tenant} #{excluded_tables} #{dbname}`
-
-        with_pg_env { `pg_dump -s -x -O -n #{default_tenant} #{dbname}` }
+        exclude_table =
+          if Apartment.pg_exclude_clone_tables
+            excluded_tables.map! { |t| "-T #{t}" }.join(' ')
+          else
+            ''
+          end
+        with_pg_env { `pg_dump -s -x -O -n #{default_tenant} #{dbname} #{exclude_table}` }
       end
 
       #   Dump data from schema_migrations table
@@ -215,13 +231,14 @@ module Apartment
       end
       # rubocop:enable Layout/LineLength
 
-      # Temporary set Postgresql related environment variables if there are in @config
-      #
+      # Temporarily set PostgreSQL environment variables for pg_dump shell commands.
+      # Must preserve and restore existing ENV values to avoid polluting global state.
+      # pg_dump reads these instead of passing connection params as CLI args.
       def with_pg_env
-        pghost = ENV['PGHOST']
-        pgport = ENV['PGPORT']
-        pguser = ENV['PGUSER']
-        pgpassword = ENV['PGPASSWORD']
+        pghost = ENV.fetch('PGHOST', nil)
+        pgport = ENV.fetch('PGPORT', nil)
+        pguser = ENV.fetch('PGUSER', nil)
+        pgpassword = ENV.fetch('PGPASSWORD', nil)
 
         ENV['PGHOST'] = @config[:host] if @config[:host]
         ENV['PGPORT'] = @config[:port].to_s if @config[:port]
@@ -230,6 +247,7 @@ module Apartment
 
         yield
       ensure
+        # Always restore original ENV state (might be nil)
         ENV['PGHOST'] = pghost
         ENV['PGPORT'] = pgport
         ENV['PGUSER'] = pguser
@@ -245,14 +263,15 @@ module Apartment
 
         swap_schema_qualifier(sql)
           .split("\n")
-          .select { |line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty? }
+          .grep_v(Regexp.union(PSQL_DUMP_GLOBAL_BLACKLIST))
           .prepend(search_path)
           .join("\n")
       end
 
       def swap_schema_qualifier(sql)
         sql.gsub(/#{default_tenant}\.\w*/) do |match|
-          if Apartment.pg_excluded_names.any? { |name| match.include? name }
+          if Apartment.pg_excluded_names.any? { |name| match.include?(name) } ||
+             (Apartment.pg_exclude_clone_tables && excluded_tables.any?(match))
             match
           else
             match.gsub("#{default_tenant}.", %("#{current}".))
@@ -263,13 +282,13 @@ module Apartment
       #   Checks if any of regexps matches against input
       #
       def check_input_against_regexps(input, regexps)
-        regexps.select { |c| input.match c }
+        regexps.select { |c| input.match(c) }
       end
 
-      #   Collect table names from AR Models
+      # Convenience method for excluded table names
       #
-      def collect_table_names(models)
-        models.map do |m|
+      def excluded_tables
+        Apartment.excluded_models.map do |m|
           m.constantize.table_name
         end
       end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -19,8 +19,8 @@ module Apartment
 
       def drop(tenant)
         unless File.exist?(database_file(tenant))
-          raise TenantNotFound,
-                "The tenant #{environmentify(tenant)} cannot be found."
+          raise(TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found.")
         end
 
         File.delete(database_file(tenant))
@@ -36,17 +36,17 @@ module Apartment
         return reset if tenant.nil?
 
         unless File.exist?(database_file(tenant))
-          raise TenantNotFound,
-                "The tenant #{environmentify(tenant)} cannot be found."
+          raise(TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found.")
         end
 
-        super database_file(tenant)
+        super(database_file(tenant))
       end
 
       def create_tenant(tenant)
         if File.exist?(database_file(tenant))
-          raise TenantExists,
-                "The tenant #{environmentify(tenant)} already exists."
+          raise(TenantExists,
+                "The tenant #{environmentify(tenant)} already exists.")
         end
 
         begin

data/lib/apartment/console.rb

@@ -4,7 +4,7 @@ def st(schema_name = nil)
   if schema_name.nil?
     tenant_list.each { |t| puts t }
 
-  elsif tenant_list.include? schema_name
+  elsif tenant_list.include?(schema_name)
     Apartment::Tenant.switch!(schema_name)
   else
     puts "Tenant #{schema_name} is not part of the tenant list"

data/lib/apartment/custom_console.rb

@@ -5,7 +5,7 @@ require_relative 'console'
 module Apartment
   module CustomConsole
     begin
-      require 'pry-rails'
+      require('pry-rails')
     rescue LoadError
       # rubocop:disable Layout/LineLength
       puts '[Failed to load pry-rails] If you want to use Apartment custom prompt you need to add pry-rails to your gemfile'
@@ -13,17 +13,17 @@ module Apartment
     end
 
     desc = "Includes the current Rails environment and project folder name.\n" \
-          '[1] [project_name][Rails.env][Apartment::Tenant.current] pry(main)>'
+           '[1] [project_name][Rails.env][Apartment::Tenant.current] pry(main)>'
 
     prompt_procs = [
       proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '>') },
-      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '*') }
+      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '*') },
     ]
 
     if Gem::Version.new(Pry::VERSION) >= Gem::Version.new('0.13')
-      Pry.config.prompt = Pry::Prompt.new 'ros', desc, prompt_procs
+      Pry.config.prompt = Pry::Prompt.new('ros', desc, prompt_procs)
     else
-      Pry::Prompt.add 'ros', desc, %w[> *] do |target_self, nest_level, pry, sep|
+      Pry::Prompt.add('ros', desc, %w[> *]) do |target_self, nest_level, pry, sep|
         prompt_contents(pry, target_self, nest_level, sep)
       end
       Pry.config.prompt = Pry::Prompt[:ros][:value]
@@ -35,8 +35,8 @@ module Apartment
 
     def self.prompt_contents(pry, target_self, nest_level, sep)
       "[#{pry.input_ring.size}] [#{PryRails::Prompt.formatted_env}][#{Apartment::Tenant.current}] " \
-      "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})" \
-      "#{":#{nest_level}" unless nest_level.zero?}#{sep} "
+        "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})" \
+        "#{":#{nest_level}" unless nest_level.zero?}#{sep} "
     end
   end
 end

data/lib/apartment/deprecation.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 require 'active_support/deprecation'
+require_relative 'version'
 
 module Apartment
-  module Deprecation
-    def self.warn(message)
-      ActiveSupport::Deprecation.warn message
-    end
-  end
+  DEPRECATOR = ActiveSupport::Deprecation.new(Apartment::VERSION, 'Apartment')
 end