ros-apartment 2.7.1 → 2.8.1

data/README.md

@@ -338,6 +338,23 @@ Apartment.configure do |config|
 end
 ```
 
+### Additional logging information
+
+Enabling this configuration will output the database that the process is currently connected to as well as which
+schemas are in the search path. This can be enabled by setting to true the `active_record_log` configuration.
+
+Please note that our custom logger inherits from `ActiveRecord::LogSubscriber` so this will be required for the configuration to work.
+
+**Example log output:**
+
+<img src="documentation/images/log_example.png">
+
+```ruby
+Apartment.configure do |config|
+  config.active_record_log = true
+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:
@@ -594,6 +611,16 @@ module Apartment
 end
 ```
 
+## Running rails console without a connection to the database
+
+By default, once apartment starts, it establishes a connection to the database. It is possible to
+disable this initial connection, by running with `APARTMENT_DISABLE_INIT` set to something:
+
+```shell
+$ APARTMENT_DISABLE_INIT=true DATABASE_URL=postgresql://localhost:1234/buk_development bin/rails runner 'puts 1'
+# 1
+```
+
 ## Contributing
 
 * In both `spec/dummy/config` and `spec/config`, you will see `database.yml.sample` files

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
 
@@ -63,6 +65,7 @@ namespace :postgres do
     params << "-U#{pg_config['username']}"
     params << "-h#{pg_config['host']}" if pg_config['host']
     params << "-p#{pg_config['port']}" if pg_config['port']
+
     begin
       `createdb #{params.join(' ')}`
     rescue StandardError

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,16 +6,18 @@ require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-# require_relative 'apartment/arel/visitors/postgresql'
+require_relative 'apartment/log_subscriber'
 
-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

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/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
@@ -201,11 +201,13 @@ module Apartment
       #   @param {String}  tenant: Database name
       #   @param {Boolean} with_database: if true, use the actual tenant's db name
       #                                   if false, use the default db name from the db
+      # rubocop:disable Style/OptionalBooleanParameter
       def multi_tenantify(tenant, with_database = true)
         db_connection_config(tenant).tap do |config|
           multi_tenantify_with_tenant_db_name(config, tenant) if with_database
         end
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
         config[:database] = environmentify(tenant)
@@ -240,7 +242,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
@@ -269,5 +272,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)

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

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -97,7 +97,23 @@ module Apartment
       end
 
       def create_tenant_command(conn, tenant)
-        conn.execute(%(CREATE SCHEMA "#{tenant}"))
+        # NOTE: This was causing some tests to fail because of the database strategy for rspec
+        if ActiveRecord::Base.connection.open_transactions.positive?
+          conn.execute(%(CREATE SCHEMA "#{tenant}"))
+        else
+          schema = %(BEGIN;
+          CREATE SCHEMA "#{tenant}";
+          COMMIT;)
+
+          conn.execute(schema)
+        end
+      rescue *rescuable_exceptions => e
+        rollback_transaction(conn)
+        raise e
+      end
+
+      def rollback_transaction(conn)
+        conn.execute('ROLLBACK;')
       end
 
       #   Generate the final search path to set including persistent_schemas
@@ -121,12 +137,17 @@ module Apartment
         # 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
-        ActiveRecord::Base.descendants
-                          .select { |c| c.instance_variable_defined?(:@sequence_name) }
-                          .reject { |c| c.instance_variable_defined?(:@explicit_sequence_name) && c.instance_variable_get(:@explicit_sequence_name) }
-                          .each do |c|
-                            c.remove_instance_variable :@sequence_name
-                          end
+        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
 
@@ -195,9 +216,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
       #

data/lib/apartment/console.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-# A workaraound to get `reload!` to also call Apartment::Tenant.init
+# A workaround to get `reload!` to also call Apartment::Tenant.init
 # This is unfortunate, but I haven't figured out how to hook into the reload process *after* files are reloaded
 
 # reloads the environment
+# rubocop:disable Style/OptionalBooleanParameter
 def reload!(print = true)
-  # rubocop:disable Rails/Output
   puts 'Reloading...' if print
-  # rubocop:enable Rails/Output
 
   # This triggers the to_prepare callbacks
   ActionDispatch::Callbacks.new(proc {}).call({})
@@ -15,18 +14,17 @@ def reload!(print = true)
   Apartment::Tenant.init
   true
 end
+# rubocop:enable Style/OptionalBooleanParameter
 
 def st(schema_name = nil)
   if schema_name.nil?
-    # rubocop:disable Rails/Output
     tenant_list.each { |t| puts t }
-    # rubocop:enable Rails/Output
+
   elsif tenant_list.include? schema_name
     Apartment::Tenant.switch!(schema_name)
   else
-    # rubocop:disable Rails/Output
     puts "Tenant #{schema_name} is not part of the tenant list"
-    # rubocop:enable Rails/Output
+
   end
 end
 
@@ -37,8 +35,6 @@ def tenant_list
 end
 
 def tenant_info_msg
-  # rubocop:disable Rails/Output
   puts "Available Tenants: #{tenant_list}\n"
   puts "Use `st 'tenant'` to switch tenants & `tenant_list` to see list\n"
-  # rubocop:enable Rails/Output
 end

data/lib/apartment/custom_console.rb

@@ -7,9 +7,9 @@ module Apartment
     begin
       require 'pry-rails'
     rescue LoadError
-      # rubocop:disable Rails/Output
+      # 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'
-      # rubocop:enable Rails/Output
+      # rubocop:enable Layout/LineLength
     end
 
     desc = "Includes the current Rails environment and project folder name.\n" \

data/lib/apartment/log_subscriber.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_record/log_subscriber'
+
+module Apartment
+  # Custom Log subscriber to include database name and schema name in sql logs
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    # 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)
+    end
+    # rubocop:enable Lint/UselessMethodDefinition
+
+    private
+
+    def debug(progname = nil, &block)
+      progname = "  #{apartment_log}#{progname}" unless progname.nil?
+
+      super(progname, &block)
+    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}#{schema}"
+    end
+  end
+end

data/lib/apartment/railtie.rb

@@ -25,28 +25,33 @@ module Apartment
       ActiveRecord::Migrator.migrations_paths = Rails.application.paths['db/migrate'].to_a
     end
 
-    # Make sure Apartment is reconfigured when the code is reloaded
+    #   Hook into ActionDispatch::Reloader to ensure Apartment is properly initialized
+    #   Note that this doesn't entirely work as expected in Development,
+    #   because this is called before classes are reloaded
+    #   See the middleware/console declarations below to help with this. Hope to fix that soon.
+    #
     config.to_prepare do
-      Apartment::Tenant.reinitialize
-    end
+      next if ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
+      next if ARGV.any? { |arg| arg == 'webpacker:compile' }
+      next if ENV['APARTMENT_DISABLE_INIT']
 
-    #
-    # Ensure that Apartment::Tenant.init is called when
-    # a new connection is requested.
-    #
-    module ApartmentInitializer
-      def connection
-        super.tap do
-          Apartment::Tenant.init_once
+      begin
+        Apartment.connection_class.connection_pool.with_connection do
+          Apartment::Tenant.init
         end
+      rescue ::ActiveRecord::NoDatabaseError
+        # Since `db:create` and other tasks invoke this block from Rails 5.2.0,
+        # we need to swallow the error to execute `db:create` properly.
       end
+    end
 
-      def arel_table
-        Apartment::Tenant.init_once
-        super
+    config.after_initialize do
+      # NOTE: Load the custom log subscriber if enabled
+      if Apartment.active_record_log
+        ActiveSupport::Notifications.unsubscribe 'sql.active_record'
+        Apartment::LogSubscriber.attach_to :active_record
       end
     end
-    ActiveRecord::Base.singleton_class.prepend ApartmentInitializer
 
     #
     #   Ensure rake tasks are loaded
@@ -57,10 +62,8 @@ module Apartment
     end
 
     #
-    #   The following initializers are a workaround to the fact that I can't
-    #   properly hook into the rails reloader
-    #   Note this is technically valid for any environment where cache_classes
-    #   is false, for us, it's just development
+    #   The following initializers are a workaround to the fact that I can't properly hook into the rails reloader
+    #   Note this is technically valid for any environment where cache_classes is false, for us, it's just development
     #
     if Rails.env.development?
 
@@ -69,11 +72,13 @@ module Apartment
         app.config.middleware.use Apartment::Reloader
       end
 
-      # Overrides reload! to also call Apartment::Tenant.init as well so that the
-      # reloaded classes have the proper table_names
+      # Overrides reload! to also call Apartment::Tenant.init as well
+      # so that the reloaded classes have the proper table_names
+      # rubocop:disable Lint/Debugger
       console do
         require 'apartment/console'
       end
+      # rubocop:enable Lint/Debugger
     end
   end
 end