ros-apartment 2.7.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ac9b369655818ab39e99d729c9f6af3ce20090e01ba4d0f1fc71a184542f98
-  data.tar.gz: 2c3aacd6fde07e50d9cf0b4344ef10e00cbf08704f1e6d5c71b4415b8c389bfd
+  metadata.gz: e12a4c472f448bc3f74307242fe0fb0929262c2a7fc5780996e8d49aa8421aff
+  data.tar.gz: 6bed24032f44c0669bca2fd92f0cd182f0d410752102493ff900709509d5f22e
 SHA512:
-  metadata.gz: dd38c39ce27e90127acdf7a74ae47922b14e13494943fa8f1f70e7d7fa7db584177ea59a120fd5f7328d63e6c400240e1c566f662b02099bfef7918fc492d6ca
-  data.tar.gz: 676637594e2ab218c24fe04eade88fe6f85ee69a3742ad029b2407e2499be0d22ef110b93075b9f590319e4623623a3390b7cade14e79ee26667fa2f5fed9e73
+  metadata.gz: a8ed3d29e8b56c61e2ca40134a421d7b6921e639e14f12ef492acb94bf7ef6b1df197b5f7f81541da0933acb946e4094080ee20e8b4c77e06e4b299acdb4ef1c
+  data.tar.gz: 18239dac52eb752c5d456c1004fe2f2424fa8dbe85bc20bfb5db45280a6df4948f5ae554f78f847698f74217809da4ebe549da5e91b9c2a69a910ef6a28d7b65

data/.github/workflows/changelog.yml

@@ -35,7 +35,29 @@ jobs:
 
       - name: Push changes
         if: env.push == 1
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
-          branch: development
+        env:
+          # CI_USER: ${{ secrets.YOUR_GITHUB_USER }}
+          CI_TOKEN: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
+        run: |
+          git push "https://$GITHUB_ACTOR:$CI_TOKEN@github.com/$GITHUB_REPOSITORY.git" HEAD:master
+
+      # - name: Push changelog to master
+      #   if: env.push == 1
+      #   uses: ad-m/github-push-action@master
+      #   with:
+      #     github_token: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
+      #     branch: master
+
+      # - name: Cherry-pick changelog to development
+      #   if: env.push == 1
+      #   env:
+      #     ACTION_EMAIL: action@github.com
+      #     ACTION_USERNAME: GitHub Action
+      #   run: |
+      #     git config --local user.email "$ACTION_EMAIL"
+      #     git config --local user.name "$ACTION_USERNAME"
+      #     commit_hash=`git show HEAD | egrep commit\ .+$ | cut -d' ' -f2`
+      #     git checkout development
+      #     git pull
+      #     git cherry-pick $commit_hash
+      #     git push

data/CHANGELOG.md

@@ -2,7 +2,31 @@
 
 ## [Unreleased](https://github.com/rails-on-services/apartment/tree/HEAD)
 
-[Full Changelog](https://github.com/rails-on-services/apartment/compare/v2.7.1...HEAD)
+[Full Changelog](https://github.com/rails-on-services/apartment/compare/v2.7.2...HEAD)
+
+**Implemented enhancements:**
+
+- Uses a transaction to create a tenant [\#66](https://github.com/rails-on-services/apartment/issues/66)
+
+**Fixed bugs:**
+
+- Fix seeding errors [\#86](https://github.com/rails-on-services/apartment/issues/86)
+- When tests run in a transaction, new tenants in tests fail to create [\#123](https://github.com/rails-on-services/apartment/issues/123)
+- Reverted unsafe initializer - introduces the possibility of disabling the initial connection to the database via
+environment variable. Relates to the following tickets/PRs:
+  - [#113](https://github.com/rails-on-services/apartment/issues/113)
+  - [#39](https://github.com/rails-on-services/apartment/pull/39)
+  - [#53](https://github.com/rails-on-services/apartment/pull/53)
+  - [#118](https://github.com/rails-on-services/apartment/pull/118)
+
+**Closed issues:**
+
+- Improve changelog automatic generation [\#98](https://github.com/rails-on-services/apartment/issues/98)
+- Relaxes dependencies to allow rails 6.1 [\#121](https://github.com/rails-on-services/apartment/issues/121)
+
+## [v2.7.2](https://github.com/rails-on-services/apartment/tree/v2.7.2) (2020-07-17)
+
+[Full Changelog](https://github.com/rails-on-services/apartment/compare/v2.7.1...v2.7.2)
 
 **Implemented enhancements:**
 
@@ -19,13 +43,21 @@
 - enhanced db:create task breaks plugins compatibility [\#82](https://github.com/rails-on-services/apartment/issues/82)
 - Support disabling of full\_migration\_on\_create [\#30](https://github.com/rails-on-services/apartment/issues/30)
 
+**Merged pull requests:**
+
+- \[Chore\] Fix Changelog github action [\#97](https://github.com/rails-on-services/apartment/pull/97) ([rpbaltazar](https://github.com/rpbaltazar))
+- Prepare release - 2.7.2 [\#96](https://github.com/rails-on-services/apartment/pull/96) ([rpbaltazar](https://github.com/rpbaltazar))
+- \[Resolves \#92\] tenant switch raises exception on first call [\#95](https://github.com/rails-on-services/apartment/pull/95) ([rpbaltazar](https://github.com/rpbaltazar))
+- Dont use custom rubocop [\#94](https://github.com/rails-on-services/apartment/pull/94) ([rpbaltazar](https://github.com/rpbaltazar))
+- \[Resolves \#80\] added changelog action [\#90](https://github.com/rails-on-services/apartment/pull/90) ([rpbaltazar](https://github.com/rpbaltazar))
+- \[Resolves \#81\] check for var existence before [\#89](https://github.com/rails-on-services/apartment/pull/89) ([rpbaltazar](https://github.com/rpbaltazar))
+
 ## [v2.7.1](https://github.com/rails-on-services/apartment/tree/v2.7.1) (2020-06-27)
 
 [Full Changelog](https://github.com/rails-on-services/apartment/compare/v2.7.0...v2.7.1)
 
 **Merged pull requests:**
 
-- \[Resolves \#80\] added changelog action [\#90](https://github.com/rails-on-services/apartment/pull/90) ([rpbaltazar](https://github.com/rpbaltazar))
 - Prepare Release 2.7.1 [\#84](https://github.com/rails-on-services/apartment/pull/84) ([rpbaltazar](https://github.com/rpbaltazar))
 - \[Resolves \#82\] Enhanced db create task breaks plugins compatibility [\#83](https://github.com/rails-on-services/apartment/pull/83) ([rpbaltazar](https://github.com/rpbaltazar))
 - \[ci\] update rake [\#79](https://github.com/rails-on-services/apartment/pull/79) ([ahorek](https://github.com/ahorek))
@@ -67,6 +99,7 @@
 
 - db:rollback uses second latest migration for tenants [\#56](https://github.com/rails-on-services/apartment/issues/56)
 - rake db:setup tries to seed non existing tenant [\#52](https://github.com/rails-on-services/apartment/issues/52)
+- Custom Console deprecation warning [\#37](https://github.com/rails-on-services/apartment/issues/37)
 
 **Merged pull requests:**
 
@@ -76,7 +109,6 @@
 - \[\#52\] enhance after db create [\#54](https://github.com/rails-on-services/apartment/pull/54) ([rpbaltazar](https://github.com/rpbaltazar))
 - fix init after reload on development [\#53](https://github.com/rails-on-services/apartment/pull/53) ([fsateler](https://github.com/fsateler))
 - fix: reset sequence\_name after tenant switch [\#51](https://github.com/rails-on-services/apartment/pull/51) ([fsateler](https://github.com/fsateler))
-- Add console welcome message [\#47](https://github.com/rails-on-services/apartment/pull/47) ([JeremiahChurch](https://github.com/JeremiahChurch))
 - Avoid early connection [\#39](https://github.com/rails-on-services/apartment/pull/39) ([fsateler](https://github.com/fsateler))
 
 ## [v2.6.0](https://github.com/rails-on-services/apartment/tree/v2.6.0) (2020-05-14)
@@ -88,13 +120,13 @@
 - Error Dropping Tenant [\#46](https://github.com/rails-on-services/apartment/issues/46)
 - After switch callback not working with nil argument [\#42](https://github.com/rails-on-services/apartment/issues/42)
 - Add tenant info to console boot? [\#41](https://github.com/rails-on-services/apartment/issues/41)
-- Custom Console deprecation warning [\#37](https://github.com/rails-on-services/apartment/issues/37)
 - Support configuration for skip checking of schema existence before switching [\#26](https://github.com/rails-on-services/apartment/issues/26)
 
 **Merged pull requests:**
 
 - \[Resolves \#37\] Custom console deprecation warning [\#49](https://github.com/rails-on-services/apartment/pull/49) ([rpbaltazar](https://github.com/rpbaltazar))
 - Prepare Release 2.6.0 [\#48](https://github.com/rails-on-services/apartment/pull/48) ([rpbaltazar](https://github.com/rpbaltazar))
+- Add console welcome message [\#47](https://github.com/rails-on-services/apartment/pull/47) ([JeremiahChurch](https://github.com/JeremiahChurch))
 - \[Resolves \#26\] Support configuration for skip checking of schema existence before switching [\#45](https://github.com/rails-on-services/apartment/pull/45) ([rpbaltazar](https://github.com/rpbaltazar))
 - \[Resolves \#42\] After switch callback not working with nil argument [\#43](https://github.com/rails-on-services/apartment/pull/43) ([rpbaltazar](https://github.com/rpbaltazar))
 

data/README.md

@@ -594,6 +594,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/lib/apartment.rb

@@ -6,7 +6,7 @@ require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-require_relative 'apartment/active_record/log_subscriber'
+require_relative 'apartment/log_subscriber'
 
 if ActiveRecord.version.release >= Gem::Version.new('6.0')
   require_relative 'apartment/active_record/connection_handling'

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 > 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

data/lib/apartment/log_subscriber.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Apartment
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      super(event)
+    end
+
+    private
+
+    def debug(progname = nil, &block)
+      progname = "  #{apartment_log}#{progname}" unless progname.nil?
+
+      super(progname, &block)
+    end
+
+    def apartment_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
+  end
+end

data/lib/apartment/railtie.rb

@@ -6,6 +6,7 @@ require 'apartment/reloader'
 
 module Apartment
   class Railtie < Rails::Railtie
+
     #
     #   Set up our default config options
     #   Do this before the app initializers run so we don't override custom settings
@@ -25,28 +26,32 @@ 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 doens'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.reload!
-    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 |app|
+      # 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,8 +72,7 @@ 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
       console do
         require 'apartment/console'
       end

data/lib/apartment/tasks/task_helper.rb

@@ -29,5 +29,12 @@ module Apartment
         Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
       WARNING
     end
+
+    def self.create_tenant(tenant_name)
+      puts("Creating #{tenant_name} tenant")
+      Apartment::Tenant.create(tenant_name)
+    rescue Apartment::TenantExists => e
+      puts "Tried to create already existing tenant: #{e}"
+    end
   end
 end

data/lib/apartment/tenant.rb

@@ -15,20 +15,6 @@ module Apartment
 
     attr_writer :config
 
-    def init_once
-      return if @already_initialized
-
-      # To avoid infinite loops in work init is doing,
-      # we need to set @already_initialized to true
-      # before init is called
-      @already_initialized = true
-      init
-    end
-
-    def reinitialize
-      @already_initialized = false
-    end
-
     #   Fetch the proper multi-tenant adapter based on Rails config
     #
     #   @return {subclass of Apartment::AbstractAdapter}
@@ -63,7 +49,6 @@ module Apartment
     #
     def reload!(config = nil)
       Thread.current[:apartment_adapter] = nil
-      reinitialize
       @config = config
     end
 

data/lib/apartment/version.rb

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

data/lib/tasks/apartment.rake

@@ -10,12 +10,7 @@ apartment_namespace = namespace :apartment do
     Apartment::TaskHelper.warn_if_tenants_empty
 
     Apartment::TaskHelper.tenants.each do |tenant|
-      begin
-        puts("Creating #{tenant} tenant")
-        Apartment::Tenant.create(tenant)
-      rescue Apartment::TenantExists => e
-        puts e.message
-      end
+      Apartment::TaskHelper.create_tenant(tenant)
     end
   end
 
@@ -36,6 +31,7 @@ apartment_namespace = namespace :apartment do
     Apartment::TaskHelper.warn_if_tenants_empty
     Apartment::TaskHelper.each_tenant do |tenant|
       begin
+        Apartment::TaskHelper.create_tenant(tenant)
         puts("Migrating #{tenant} tenant")
         Apartment::Migrator.migrate tenant
       rescue Apartment::TenantNotFound => e
@@ -45,11 +41,12 @@ apartment_namespace = namespace :apartment do
   end
 
   desc 'Seed all tenants'
-  task seed: :create do
+  task :seed do
     Apartment::TaskHelper.warn_if_tenants_empty
 
     Apartment::TaskHelper.each_tenant do |tenant|
       begin
+        Apartment::TaskHelper.create_tenant(tenant)
         puts("Seeding #{tenant} tenant")
         Apartment::Tenant.switch(tenant) do
           Apartment::Tenant.seed

data/ros-apartment.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
 
-  s.add_dependency 'activerecord',    '>= 5.0.0', '< 6.1'
+  s.add_dependency 'activerecord',    '>= 5.0.0', '< 6.2'
   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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.8.0
 platform: ruby
 authors:
 - Ryan Brunner
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,7 +21,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +255,6 @@ files:
 - lib/apartment.rb
 - lib/apartment/active_record/connection_handling.rb
 - lib/apartment/active_record/internal_metadata.rb
-- lib/apartment/active_record/log_subscriber.rb
 - lib/apartment/active_record/schema_migration.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/abstract_jdbc_adapter.rb
@@ -274,6 +273,7 @@ files:
 - lib/apartment/elevators/host.rb
 - lib/apartment/elevators/host_hash.rb
 - lib/apartment/elevators/subdomain.rb
+- lib/apartment/log_subscriber.rb
 - lib/apartment/migrator.rb
 - lib/apartment/model.rb
 - lib/apartment/railtie.rb

data/lib/apartment/active_record/log_subscriber.rb

@@ -1,44 +0,0 @@
-# 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