ros-apartment 2.5.0 → 2.7.2

data/README.md

@@ -324,6 +324,20 @@ Apartment.configure do |config|
 end
 ```
 
+### Skip tenant schema check
+
+This is configurable by setting: `tenant_presence_check`. It defaults to true
+in order to maintain the original gem behavior. This is only checked when using one of the PostgreSQL adapters.
+The original gem behavior, when running `switch` would look for the existence of the schema before switching. This adds an extra query on every context switch. While in the default simple scenarios this is a valid check, in high volume platforms this adds some unnecessary overhead which can be detected in some other ways on the application level.
+
+Setting this configuration value to `false` will disable the schema presence check before trying to switch the context.
+
+```ruby
+Apartment.configure do |config|
+  tenant_presence_check = false
+end
+```
+
 ### Excluding models
 
 If you have some models that should always access the 'public' tenant, you can specify this by configuring Apartment using `Apartment.configure`. This will yield a config object for you. You can set excluded models like so:
@@ -354,12 +368,12 @@ Enable this option with:
 config.use_sql = true
 ```
 
-### Providing a Different default_schema
+### Providing a Different default_tenant
 
 By default, ActiveRecord will use `"$user", public` as the default `schema_search_path`. This can be modified if you wish to use a different default schema be setting:
 
 ```ruby
-config.default_schema = "some_other_schema"
+config.default_tenant = "some_other_schema"
 ```
 
 With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Tenant` will return to this schema as well.
@@ -432,7 +446,7 @@ schema_search_path: "public,shared_extensions"
 ...
 ```
 
-This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/426). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
+This would be for a config with `default_tenant` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/426). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
 
 1. Append `?schema_search_path=public,hstore` to your `DATABASE_URL` environment variable, by this you don't have to revise the `database.yml` file (which is impossible since Heroku regenerates a completely different and immutable `database.yml` of its own on each deploy)
 2. Run `heroku pg:psql` from your command line

data/Rakefile

@@ -46,8 +46,10 @@ namespace :db do
     apartment_db_file = 'spec/config/database.yml'
     rails_db_file = 'spec/dummy/config/database.yml'
 
-    FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, verbose: true) unless File.exist?(apartment_db_file)
-    FileUtils.copy(rails_db_file + '.sample', rails_db_file, verbose: true)         unless File.exist?(rails_db_file)
+    unless File.exist?(apartment_db_file)
+      FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, verbose: true)
+    end
+    FileUtils.copy(rails_db_file + '.sample', rails_db_file, verbose: true) unless File.exist?(rails_db_file)
   end
 end
 

data/TODO.md

@@ -46,6 +46,5 @@
 
 Quick TODOs
 
-1. `default_tenant` should be up to the adapter, not the Apartment class, deprecate `default_schema`
 2. deprecation.rb rescues everything, we have a hard dependency on ActiveSupport so this is unnecessary
 3.

data/gemfiles/rails_5_0.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.0.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_5_1.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.1.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_5_2.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.2.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_6_0.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 6.0.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_master.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", git: "https://github.com/rails/rails.git"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/lib/apartment.rb

@@ -6,25 +6,28 @@ require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-# require_relative 'apartment/arel/visitors/postgresql'
+require_relative 'apartment/active_record/log_subscriber'
 
-require_relative 'apartment/active_record/connection_handling' if ActiveRecord.version.release >= Gem::Version.new('6.0')
+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'
 end
 
+# Apartment main definitions
 module Apartment
   class << self
     extend Forwardable
 
-    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment
-                          append_environment with_multi_server_setup].freeze
+    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
 
     WRITER_METHODS = %i[tenant_names database_schema_file excluded_models
-                        default_schema persistent_schemas connection_class
-                        tld_length db_migrate_tenants seed_data_file
+                        persistent_schemas connection_class
+                        db_migrate_tenants seed_data_file
                         parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
@@ -53,6 +56,10 @@ module Apartment
       extract_tenant_config
     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')
+    end
+
     def db_config_for(tenant)
       (tenants_with_config[tenant] || connection_config)
     end
@@ -70,15 +77,9 @@ module Apartment
       @excluded_models || []
     end
 
-    def default_schema
-      @default_schema || 'public' # TODO: 'public' is postgres specific
-    end
-
     def parallel_migration_threads
       @parallel_migration_threads || 0
     end
-    alias default_tenant default_schema
-    alias default_tenant= default_schema=
 
     def persistent_schemas
       @persistent_schemas || []

data/lib/apartment/active_record/connection_handling.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module ActiveRecord
+  # This is monkeypatching activerecord 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

data/lib/apartment/active_record/internal_metadata.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Rails/ApplicationRecord
 class InternalMetadata < ActiveRecord::Base # :nodoc:
   class << self
     def table_exists?
@@ -8,4 +7,3 @@ class InternalMetadata < ActiveRecord::Base # :nodoc:
     end
   end
 end
-# rubocop:enable Rails/ApplicationRecord

data/lib/apartment/active_record/log_subscriber.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # Supports the logging configuration to prepend the database and schema in the ActiveRecord log
+  class LogSubscriber
+    def apartment_log
+      return unless Apartment.active_record_log
+
+      database = color("[#{Apartment.connection.current_database}] ", 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}#{schema}"
+    end
+
+    def payload_binds(binds, type_casted_binds)
+      return unless (binds || []).empty?
+
+      casted_params = type_casted_binds(type_casted_binds)
+      '  ' + binds.zip(casted_params).map { |attr, value| render_bind(attr, value) }.inspect
+    end
+
+    def sql(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+      name  = "CACHE #{name}" if payload[:cached]
+      sql = payload[:sql]
+      binds = payload_binds(payload[:binds], payload[:type_casted_binds])
+
+      name = colorize_payload_name(name, payload[:name])
+      sql  = color(sql, sql_color(sql), true) if colorize_logging
+
+      debug "    #{apartment_log}#{name} #{sql}#{binds}"
+    end
+  end
+end

data/lib/apartment/active_record/schema_migration.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  # rubocop:disable Rails/ApplicationRecord
   class SchemaMigration < ActiveRecord::Base # :nodoc:
     class << self
       def table_exists?
@@ -9,5 +8,4 @@ module ActiveRecord
       end
     end
   end
-  # rubocop:enable Rails/ApplicationRecord
 end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -2,7 +2,7 @@
 
 module Apartment
   module Adapters
-    # rubocop:disable Metrics/ClassLength
+    # Abstract adapter from which all the Apartment DB related adapters will inherit the base logic
     class AbstractAdapter
       include ActiveSupport::Callbacks
       define_callbacks :create, :switch
@@ -35,6 +35,12 @@ module Apartment
         end
       end
 
+      #   Initialize Apartment config options such as excluded_models
+      #
+      def init
+        process_excluded_models
+      end
+
       #   Note alias_method here doesn't work with inheritence apparently ??
       #
       def current
@@ -48,7 +54,6 @@ module Apartment
       def default_tenant
         @default_tenant || Apartment.default_tenant
       end
-      alias default_schema default_tenant # TODO: deprecate default_schema
 
       #   Drop the tenant
       #
@@ -68,8 +73,6 @@ module Apartment
       #
       def switch!(tenant = nil)
         run_callbacks :switch do
-          return reset if tenant.nil?
-
           connect_to_new(tenant).tap do
             Apartment.connection.clear_query_cache
           end
@@ -130,14 +133,12 @@ module Apartment
       #   @return {String} tenant name with Rails environment *optionally* prepended
       #
       def environmentify(tenant)
-        if !tenant.include?(Rails.env)
-          if Apartment.prepend_environment
-            "#{Rails.env}_#{tenant}"
-          elsif Apartment.append_environment
-            "#{tenant}_#{Rails.env}"
-          else
-            tenant
-          end
+        return tenant if tenant.nil? || tenant.include?(Rails.env)
+
+        if Apartment.prepend_environment
+          "#{Rails.env}_#{tenant}"
+        elsif Apartment.append_environment
+          "#{tenant}_#{Rails.env}"
         else
           tenant
         end
@@ -175,6 +176,8 @@ module Apartment
       #   @param {String} tenant Database name
       #
       def connect_to_new(tenant)
+        return reset if tenant.nil?
+
         query_cache_enabled = ActiveRecord::Base.connection.query_cache_enabled
 
         Apartment.establish_connection multi_tenantify(tenant)
@@ -237,7 +240,8 @@ module Apartment
       def with_neutral_connection(tenant, &_block)
         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.
+          # example: when you use postgresql, you need to connect to the default postgresql database before you create
+          # your own.
           SeparateDbConnectionHandler.establish_connection(multi_tenantify(tenant, false))
           yield(SeparateDbConnectionHandler.connection)
           SeparateDbConnectionHandler.connection.close
@@ -266,5 +270,4 @@ module Apartment
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -4,11 +4,12 @@ require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Adapters
+    # JDBC Abstract adapter
     class AbstractJDBCAdapter < AbstractAdapter
       private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def rescue_from

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -3,6 +3,7 @@
 require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
+  # JDBC helper to decide wether to use JDBC Postgresql Adapter or JDBC Postgresql Adapter with Schemas
   module Tenant
     def self.jdbc_postgresql_adapter(config)
       if Apartment.use_schemas
@@ -19,7 +20,7 @@ module Apartment
       private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def create_tenant_command(conn, tenant)
@@ -37,12 +38,11 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        # rubocop:disable Style/RaiseArgs
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.all_schemas.include? tenant.to_s
 
-        # rubocop:enable Style/RaiseArgs
+        tenant = tenant.to_s
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless tenant_exists?(tenant)
 
-        @current = tenant.to_s
+        @current = tenant
         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}"
@@ -50,6 +50,12 @@ module Apartment
 
       private
 
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.all_schemas.include? tenant
+      end
+
       def rescue_from
         ActiveRecord::JDBCError
       end

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -3,6 +3,7 @@
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
+  # Helper module to decide wether to use mysql2 adapter or mysql2 adapter with schemas
   module Tenant
     def self.mysql2_adapter(config)
       if Apartment.use_schemas
@@ -14,6 +15,7 @@ module Apartment
   end
 
   module Adapters
+    # Mysql2 Adapter
     class Mysql2Adapter < AbstractAdapter
       def initialize(config)
         super
@@ -28,6 +30,7 @@ module Apartment
       end
     end
 
+    # Mysql2 Schemas Adapter
     class Mysql2SchemaAdapter < AbstractAdapter
       def initialize(config)
         super
@@ -39,6 +42,8 @@ module Apartment
       #   Reset current tenant to the default_tenant
       #
       def reset
+        return unless default_tenant
+
         Apartment.connection.execute "use `#{default_tenant}`"
       end
 

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -30,6 +30,10 @@ module Apartment
         reset
       end
 
+      def default_tenant
+        @default_tenant = Apartment.default_tenant || 'public'
+      end
+
       #   Reset schema search path to the default schema_search_path
       #
       #   @return {String} default schema search path
@@ -37,6 +41,12 @@ module Apartment
       def reset
         @current = default_tenant
         Apartment.connection.schema_search_path = full_search_path
+        reset_sequence_names
+      end
+
+      def init
+        super
+        Apartment.connection.schema_search_path = full_search_path
       end
 
       def current
@@ -62,24 +72,30 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        # rubocop:disable Style/RaiseArgs
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists?(tenant.to_s)
 
-        # rubocop:enable Style/RaiseArgs
+        tenant = tenant.to_s
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless tenant_exists?(tenant)
 
-        @current = tenant.to_s
+        @current = tenant
         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
+        reset_sequence_names
       rescue *rescuable_exceptions
         raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
 
       private
 
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.schema_exists?(tenant)
+      end
+
       def create_tenant_command(conn, tenant)
         conn.execute(%(CREATE SCHEMA "#{tenant}"))
       end
@@ -99,6 +115,24 @@ module Apartment
         # public from Rails 5.0.
         Apartment.connection.send(:postgresql_version)
       end
+
+      def reset_sequence_names
+        # sequence_name contains the schema, so it must be reset after switch
+        # There is `reset_sequence_name`, but that method actually goes to the database
+        # to find out the new name. Therefore, we do this hack to only unset the name,
+        # and it will be dynamically found the next time it is needed
+        descendants_to_unset = ActiveRecord::Base.descendants
+                                                 .select { |c| c.instance_variable_defined?(:@sequence_name) }
+                                                 .reject do |c|
+                                                   c.instance_variable_defined?(:@explicit_sequence_name) &&
+                                                     c.instance_variable_get(:@explicit_sequence_name)
+                                                 end
+        descendants_to_unset.each do |c|
+          # NOTE: due to this https://github.com/rails-on-services/apartment/issues/81
+          # unreproduceable error we're checking before trying to remove it
+          c.remove_instance_variable :@sequence_name if c.instance_variable_defined?(:@sequence_name)
+        end
+      end
     end
 
     # Another Adapter for Postgresql when using schemas and SQL
@@ -166,9 +200,11 @@ module Apartment
       #
       #   @return {String} raw SQL contaning inserts with data from schema_migrations
       #
+      # rubocop:disable Layout/LineLength
       def pg_dump_schema_migrations_data
         with_pg_env { `pg_dump -a --inserts -t #{default_tenant}.schema_migrations -t #{default_tenant}.ar_internal_metadata #{dbname}` }
       end
+      # rubocop:enable Layout/LineLength
 
       # Temporary set Postgresql related environment variables if there are in @config
       #