ros-apartment 2.11.0 → 3.2.0

data/lib/apartment/active_record/connection_handling.rb

@@ -1,16 +1,27 @@
 # frozen_string_literal: true
 
-module ActiveRecord
-  # This is monkeypatching activerecord to ensure that whenever a new connection is established it
+module ActiveRecord # :nodoc:
+  # This is monkeypatching Active Record to ensure that whenever a new connection is established it
   # switches to the same tenant as before the connection switching. This problem is more evident when
   # using read replica in Rails 6
   module ConnectionHandling
-    def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
-      current_tenant = Apartment::Tenant.current
+    if ActiveRecord.version.release <= Gem::Version.new('6.2')
+      def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
+        current_tenant = Apartment::Tenant.current
 
-      connected_to_without_tenant(database: database, role: role, prevent_writes: prevent_writes) do
-        Apartment::Tenant.switch!(current_tenant)
-        yield(blk)
+        connected_to_without_tenant(database: database, role: role, prevent_writes: prevent_writes) do
+          Apartment::Tenant.switch!(current_tenant)
+          yield(blk)
+        end
+      end
+    else
+      def connected_to_with_tenant(role: nil, shard: nil, prevent_writes: false, &blk)
+        current_tenant = Apartment::Tenant.current
+
+        connected_to_without_tenant(role: role, shard: shard, prevent_writes: prevent_writes) do
+          Apartment::Tenant.switch!(current_tenant)
+          yield(blk)
+        end
       end
     end
 

data/lib/apartment/active_record/postgres/schema_dumper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This patch prevents `create_schema` from being added to db/schema.rb as schemas are managed by Apartment
+# not ActiveRecord like they would be in a vanilla Rails setup.
+
+require 'active_record/connection_adapters/abstract/schema_dumper'
+require 'active_record/connection_adapters/postgresql/schema_dumper'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module PostgreSQL
+      class SchemaDumper
+        alias _original_schemas schemas
+        def schemas(stream)
+          _original_schemas(stream) unless Apartment.use_schemas
+        end
+      end
+    end
+  end
+end

data/lib/apartment/active_record/postgresql_adapter.rb

@@ -8,23 +8,42 @@
 module Apartment::PostgreSqlAdapterPatch
   def default_sequence_name(table, _column)
     res = super
-    schema_prefix = "#{Apartment::Tenant.current}."
-    default_tenant_prefix = "#{Apartment::Tenant.default_tenant}."
+
+    # for JDBC driver, if rescued in super_method, trim leading and trailing quotes
+    res.delete!('"') if defined?(JRUBY_VERSION)
+
+    schema_prefix = "#{sequence_schema(res)}."
 
     # NOTE: Excluded models should always access the sequence from the default
     # tenant schema
     if excluded_model?(table)
-      res.sub!(schema_prefix, default_tenant_prefix) if schema_prefix != default_tenant_prefix
+      default_tenant_prefix = "#{Apartment::Tenant.default_tenant}."
+
+      # Unless the res is already prefixed with the default_tenant_prefix
+      # we should delete the schema_prefix and add the default_tenant_prefix
+      unless res&.starts_with?(default_tenant_prefix)
+        res&.delete_prefix!(schema_prefix)
+        res = default_tenant_prefix + res
+      end
+
       return res
     end
 
-    res.delete_prefix!(schema_prefix) if res&.starts_with?(schema_prefix)
+    # Delete the schema_prefix from the res if it is present
+    res&.delete_prefix!(schema_prefix)
 
     res
   end
 
   private
 
+  def sequence_schema(sequence_name)
+    current = Apartment::Tenant.current
+    return current unless current.is_a?(Array)
+
+    current.find { |schema| sequence_name.starts_with?("#{schema}.") }
+  end
+
   def excluded_model?(table)
     Apartment.excluded_models.any? { |m| m.constantize.table_name == table }
   end

data/lib/apartment/active_record/schema_migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  class SchemaMigration < ActiveRecord::Base # :nodoc:
+  class SchemaMigration # :nodoc:
     class << self
       def table_exists?
         connection.table_exists?(table_name)

data/lib/apartment/adapters/abstract_adapter.rb

@@ -181,7 +181,7 @@ module Apartment
         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.connection.verify! # call active? to manually check if this connection is valid
 
         Apartment.connection.enable_query_cache! if query_cache_enabled
       rescue *rescuable_exceptions => e

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -76,11 +76,6 @@ module Apartment
 
         @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
@@ -151,8 +146,9 @@ 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
 
@@ -194,15 +190,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
@@ -254,6 +248,8 @@ module Apartment
         sql.gsub(/#{default_tenant}\.\w*/) do |match|
           if Apartment.pg_excluded_names.any? { |name| match.include? name }
             match
+          elsif Apartment.pg_exclude_clone_tables && excluded_tables.any?(match)
+            match
           else
             match.gsub("#{default_tenant}.", %("#{current}".))
           end
@@ -266,10 +262,10 @@ module Apartment
         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/trilogy_adapter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'apartment/adapters/mysql2_adapter'
+
+module Apartment
+  # Helper module to decide wether to use trilogy adapter or trilogy adapter with schemas
+  module Tenant
+    def self.trilogy_adapter(config)
+      if Apartment.use_schemas
+        Adapters::TrilogySchemaAdapter.new(config)
+      else
+        Adapters::TrilogyAdapter.new(config)
+      end
+    end
+  end
+
+  module Adapters
+    class TrilogyAdapter < Mysql2Adapter
+      protected
+
+      def rescue_from
+        Trilogy::Error
+      end
+    end
+
+    class TrilogySchemaAdapter < Mysql2SchemaAdapter
+    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

data/lib/apartment/log_subscriber.rb

@@ -8,26 +8,38 @@ module Apartment
     # NOTE: for some reason, if the method definition is not here, then the custom debug method is not called
     # rubocop:disable Lint/UselessMethodDefinition
     def sql(event)
-      super(event)
+      super
     end
     # rubocop:enable Lint/UselessMethodDefinition
 
     private
 
-    def debug(progname = nil, &block)
+    def debug(progname = nil, &blk)
       progname = "  #{apartment_log}#{progname}" unless progname.nil?
 
-      super(progname, &block)
+      super
     end
 
     def apartment_log
-      database = color("[#{Apartment.connection.raw_connection.db}] ", ActiveSupport::LogSubscriber::MAGENTA, true)
-      schema = nil
-      unless Apartment.connection.schema_search_path.nil?
-        schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ",
-                       ActiveSupport::LogSubscriber::YELLOW, true)
-      end
+      database = color("[#{database_name}] ", ActiveSupport::LogSubscriber::MAGENTA, bold: true)
+      schema = current_search_path
+      schema = color("[#{schema.tr('"', '')}] ", ActiveSupport::LogSubscriber::YELLOW, bold: true) unless schema.nil?
       "#{database}#{schema}"
     end
+
+    def current_search_path
+      if Apartment.connection.respond_to?(:schema_search_path)
+        Apartment.connection.schema_search_path
+      else
+        Apartment::Tenant.current # all others
+      end
+    end
+
+    def database_name
+      db_name = Apartment.connection.raw_connection.try(:db) # PostgreSQL, PostGIS
+      db_name ||= Apartment.connection.raw_connection.try(:query_options)&.dig(:database) # Mysql
+      db_name ||= Apartment.connection.current_database # Failover
+      db_name
+    end
   end
 end

data/lib/apartment/migrator.rb

@@ -13,8 +13,8 @@ module Apartment
 
         migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
 
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version, &migration_scope_block)
+        if ActiveRecord.version >= Gem::Version.new('7.2.0')
+          ActiveRecord::Base.connection_pool.migration_context.migrate(version, &migration_scope_block)
         else
           ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
         end
@@ -24,8 +24,8 @@ module Apartment
     # Migrate up/down to a specific version
     def run(direction, database, version)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
+        if ActiveRecord.version >= Gem::Version.new('7.2.0')
+          ActiveRecord::Base.connection_pool.migration_context.run(direction, version)
         else
           ActiveRecord::Base.connection.migration_context.run(direction, version)
         end
@@ -35,18 +35,12 @@ module Apartment
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
+        if ActiveRecord.version >= Gem::Version.new('7.2.0')
+          ActiveRecord::Base.connection_pool.migration_context.rollback(step)
         else
           ActiveRecord::Base.connection.migration_context.rollback(step)
         end
       end
     end
-
-    private
-
-    def activerecord_below_5_2?
-      ActiveRecord.version.release < Gem::Version.new('5.2.0')
-    end
   end
 end

data/lib/apartment/railtie.rb

@@ -47,7 +47,12 @@ module Apartment
     config.after_initialize do
       # NOTE: Load the custom log subscriber if enabled
       if Apartment.active_record_log
-        ActiveSupport::Notifications.unsubscribe 'sql.active_record'
+        ActiveSupport::Notifications.notifier.listeners_for('sql.active_record').each do |listener|
+          next unless listener.instance_variable_get('@delegate').is_a?(ActiveRecord::LogSubscriber)
+
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+
         Apartment::LogSubscriber.attach_to :active_record
       end
     end

data/lib/apartment/tasks/task_helper.rb

@@ -4,7 +4,9 @@ module Apartment
   module TaskHelper
     def self.each_tenant(&block)
       Parallel.each(tenants_without_default, in_threads: Apartment.parallel_migration_threads) do |tenant|
-        block.call(tenant)
+        Rails.application.executor.wrap do
+          block.call(tenant)
+        end
       end
     end
 

data/lib/apartment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apartment
-  VERSION = '2.11.0'
+  VERSION = '3.2.0'
 end

data/lib/apartment.rb

@@ -5,16 +5,15 @@ require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
+require 'apartment/deprecation'
 
 require_relative 'apartment/log_subscriber'
+require_relative 'apartment/active_record/connection_handling'
+require_relative 'apartment/active_record/schema_migration'
+require_relative 'apartment/active_record/internal_metadata'
 
-if ActiveRecord.version.release >= Gem::Version.new('6.0')
-  require_relative 'apartment/active_record/connection_handling'
-end
-
-if ActiveRecord.version.release >= Gem::Version.new('6.1')
-  require_relative 'apartment/active_record/schema_migration'
-  require_relative 'apartment/active_record/internal_metadata'
+if ActiveRecord.version.release >= Gem::Version.new('7.1')
+  require_relative 'apartment/active_record/postgres/schema_dumper'
 end
 
 # Apartment main definitions
@@ -23,7 +22,8 @@ module Apartment
     extend Forwardable
 
     ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment default_tenant
-                          append_environment with_multi_server_setup tenant_presence_check active_record_log].freeze
+                          append_environment with_multi_server_setup tenant_presence_check
+                          active_record_log pg_exclude_clone_tables].freeze
 
     WRITER_METHODS = %i[tenant_names database_schema_file excluded_models
                         persistent_schemas connection_class
@@ -33,14 +33,10 @@ module Apartment
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    if ActiveRecord.version.release >= Gem::Version.new('6.1')
-      def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
+    def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
 
-      def connection_config
-        connection_db_config.configuration_hash
-      end
-    else
-      def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    def connection_config
+      connection_db_config.configuration_hash
     end
 
     # configure apartment with available options
@@ -57,7 +53,7 @@ module Apartment
     end
 
     def tld_length=(_)
-      Apartment::Deprecation.warn('`config.tld_length` have no effect because it was removed in https://github.com/influitive/apartment/pull/309')
+      Apartment::DEPRECATOR.warn('`config.tld_length` have no effect because it was removed in https://github.com/influitive/apartment/pull/309')
     end
 
     def db_config_for(tenant)

data/ros-apartment.gemspec

@@ -7,53 +7,34 @@ Gem::Specification.new do |s|
   s.name = 'ros-apartment'
   s.version = Apartment::VERSION
 
-  s.authors       = ['Ryan Brunner', 'Brad Robertson', 'Rui Baltazar']
+  s.authors       = ['Ryan Brunner', 'Brad Robertson', 'Rui Baltazar', 'Mauricio Novelo']
   s.summary       = 'A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement'
   s.description   = 'Apartment allows Rack applications to deal with database multitenancy through ActiveRecord'
-  s.email         = ['ryan@influitive.com', 'brad@influitive.com', 'rui.p.baltazar@gmail.com']
+  s.email         = ['ryan@influitive.com', 'brad@influitive.com', 'rui.p.baltazar@gmail.com', 'mauricio@campusesp.com']
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been
   # added into git.
   s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       # NOTE: ignore all test related
-      f.match(%r{^(test|spec|features|documentation)/})
+      f.match(%r{^(test|spec|features|documentation|gemfiles|.github)/})
     end
   end
   s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
+  s.metadata = {
+    'github_repo' => 'ssh://github.com/rails-on-services/apartment',
+    'rubygems_mfa_required' => 'true',
+  }
 
-  s.add_dependency 'activerecord', '>= 5.0.0', '< 7.1'
-  s.add_dependency 'parallel', '< 2.0'
-  s.add_dependency 'public_suffix', '>= 2.0.5', '< 5.0'
-  s.add_dependency 'rack', '>= 1.3.6', '< 3.0'
+  s.required_ruby_version = '>= 3.1'
 
-  s.add_development_dependency 'appraisal', '~> 2.2'
-  s.add_development_dependency 'bundler', '>= 1.3', '< 3.0'
-  s.add_development_dependency 'guard-rspec', '~> 4.2'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3.4'
-  s.add_development_dependency 'rspec_junit_formatter'
-  s.add_development_dependency 'rspec-rails', '~> 3.4'
-  s.add_development_dependency 'rubocop', '~> 0.93'
-  s.add_development_dependency 'rubocop-performance', '~> 1.10'
-  s.add_development_dependency 'rubocop-rails', '~> 2.1'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.44'
-
-  if defined?(JRUBY_VERSION)
-    s.add_development_dependency 'activerecord-jdbc-adapter'
-    s.add_development_dependency 'activerecord-jdbcmysql-adapter'
-    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
-    s.add_development_dependency 'jdbc-mysql'
-    s.add_development_dependency 'jdbc-postgres'
-  else
-    s.add_development_dependency 'mysql2',  '~> 0.5'
-    s.add_development_dependency 'pg',      '~> 1.2'
-    s.add_development_dependency 'sqlite3', '~> 1.3.6'
-  end
+  s.add_dependency('activerecord', '>= 6.1.0', '< 8.1')
+  s.add_dependency('activesupport', '>= 6.1.0', '< 8.1')
+  s.add_dependency('parallel', '< 2.0')
+  s.add_dependency('public_suffix', '>= 2.0.5', '<= 6.0.1')
+  s.add_dependency('rack', '>= 1.3.6', '< 4.0')
 end