ros-apartment 2.6.1 → 2.8.1.rc1

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|
+  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:
@@ -368,12 +385,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.
@@ -446,7 +463,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
@@ -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
 

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/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 tenant_presence_check].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/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
@@ -54,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
       #
@@ -241,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
@@ -270,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)

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
@@ -93,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 > 0
+          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
@@ -117,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
 
@@ -191,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

@@ -5,9 +5,7 @@
 
 # reloads the environment
 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({})
@@ -18,15 +16,13 @@ end
 
 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 +33,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" \