rails_multisite 2.0.7 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a0e0f9bb773343cb717c3342bdba03296eb1d7f298a26527aa435309aba5c71
-  data.tar.gz: 8b2d59de4f66e24d753f72b4bf43618769178191e3b25a1117b8a0fd4460e0a0
+  metadata.gz: 2acf52c9b8002bff6a1590222b85d778cb1ddd9e28de6ac91eed45d5117e30aa
+  data.tar.gz: 3b39a8d9a2d2b70c62e29a0541d585c499a51cb9ac6b8dac2544343b1c22d45c
 SHA512:
-  metadata.gz: 706c6793500ab5a89ceec191519033263f2851c94fb707614b28c1c2da9fee89b274ee268bac880e8893a0f2ad4c24ee86d087894b4a9bec35fd28abe0200312
-  data.tar.gz: a1156c538005d8cd01dfc3994c890a12cf872c4400b9c5e6e0ddcdd1e4d018ab9486edd3227b5c67718b643933258f6c009712e7c1c90b474cdc05c7d6e31a31
+  metadata.gz: f7b8775f143c21083b7141ca6592c5f8d75f12a287f14452a63ff159f0932c0fafe918256d8219431d9d3647b09b340daab747d5b0b10ff3e1c1b1c1f3eeab34
+  data.tar.gz: 81abf0c622d83d541bb0870a7bc2cac379c137ae4057b11a44bc8ab8ff4a6be3e1b730420766b22a55ff3aa7505ef7e9e0ab5494c8c1bdedfc8444e862cf0af0

data/README.md

@@ -35,7 +35,6 @@ mlp:
   host: dbhost
   pool: 5
   timeout: 5000
-  db_id: 1  # ensure db_id is unique for each site
   host_names:
     - discourse.equestria.com
     - discourse.equestria.internal
@@ -48,7 +47,6 @@ drwho:
   host: dbhost
   pool: 5
   timeout: 5000
-  db_id: 2 # ensure db_id is unique for each site
   host_names:
     - discuss.tardis.gallifrey
 ```
@@ -92,7 +90,7 @@ db_two:
 To get a Rails console that is connected to `some_database_1` database:
 
 ```
-RAILS_ENV=db_one rails console
+RAILS_DB=db_one rails console
 ```
 
 

data/lib/rails_multisite/connection_management.rb

@@ -4,12 +4,17 @@ module RailsMultisite
   class ConnectionManagement
 
     DEFAULT = 'default'
+    SPEC_KLASS = ActiveRecord::ConnectionAdapters::ConnectionSpecification
 
     def self.default_config_filename
       File.absolute_path(Rails.root.to_s + "/config/multisite.yml")
     end
 
     def self.clear_settings!
+      @instance&.db_spec_cache&.each do |key, spec|
+        @instance.connection_handlers.delete(self.handler_key(spec))
+      end
+
       @instance = nil
     end
 
@@ -35,7 +40,7 @@ module RailsMultisite
     end
 
     def self.reload
-      @instance = new(instance.config_filename)
+      @instance.reload
     end
 
     def self.has_db?(db)
@@ -97,6 +102,13 @@ module RailsMultisite
       config[:host_names].nil? ? config[:host] : config[:host_names].first
     end
 
+    def self.current_db_hostnames
+      spec = @instance.connection_spec(db: self.current_db) if @instance
+      spec ||= ActiveRecord::Base.connection_pool.spec
+      config = spec.config
+      config[:host_names].nil? ? [config[:host]] : config[:host_names]
+    end
+
     def self.connection_spec(opts)
       if @instance
         @instance.connection_spec(opts)
@@ -113,12 +125,52 @@ module RailsMultisite
       end
     end
 
-    attr_reader :config_filename
+    def self.handler_key(spec)
+      @handler_key_suffix ||= begin
+        if ActiveRecord::Base.respond_to?(:writing_role)
+          "_#{ActiveRecord::Base.writing_role}"
+        else
+          ""
+        end
+      end
+
+      :"#{spec.name}#{@handler_key_suffix}"
+    end
+
+    def self.default_connection_handler=(connection_handler)
+      if @instance
+        unless connection_handler.is_a?(ActiveRecord::ConnectionAdapters::ConnectionHandler)
+          raise ArgumentError.new("Invalid connection handler")
+        end
+
+        @instance.default_connection_handler = connection_handler
+      end
+    end
+
+    attr_reader :config_filename, :db_spec_cache, :connection_handlers
+    attr_writer :default_connection_handler
 
     def initialize(config_filename)
       @config_filename = config_filename
 
-      spec_klass = ActiveRecord::ConnectionAdapters::ConnectionSpecification
+      @connection_handlers = begin
+        if ActiveRecord::Base.respond_to?(:connection_handlers)
+          ActiveRecord::Base.connection_handlers
+        else
+          {}
+        end
+      end
+
+      @db_spec_cache = {}
+      @default_spec = SPEC_KLASS::Resolver.new(ActiveRecord::Base.configurations).spec(Rails.env.to_sym)
+      @default_connection_handler = ActiveRecord::Base.connection_handler
+
+      @reload_mutex = Mutex.new
+
+      load_config!
+    end
+
+    def load_config!
       configs = YAML::load(File.open(@config_filename))
 
       no_prepared_statements = ActiveRecord::Base.configurations[Rails.env]["prepared_statements"] == false
@@ -136,27 +188,45 @@ module RailsMultisite
         resolve_configs = ActiveRecord::DatabaseConfigurations.new(configs)
       end
 
-      resolver = spec_klass::Resolver.new(resolve_configs)
-      @db_spec_cache = Hash[*configs.map { |k, _| [k, resolver.spec(k.to_sym)] }.flatten]
+      resolver = SPEC_KLASS::Resolver.new(resolve_configs)
 
-      @host_spec_cache = {}
+      # Build a hash of db name => spec
+      new_db_spec_cache = Hash[*configs.map { |k, _| [k, resolver.spec(k.to_sym)] }.flatten]
+      new_db_spec_cache.each do |k, v|
+        # If spec already existed, use the old version
+        if v&.to_hash == @db_spec_cache[k]&.to_hash
+          new_db_spec_cache[k] = @db_spec_cache[k]
+        end
+      end
 
+      # Build a hash of hostname => spec
+      new_host_spec_cache = {}
       configs.each do |k, v|
         next unless v["host_names"]
         v["host_names"].each do |host|
-          @host_spec_cache[host] = @db_spec_cache[k]
+          new_host_spec_cache[host] = new_db_spec_cache[k]
         end
       end
 
-      @default_spec = spec_klass::Resolver.new(ActiveRecord::Base.configurations).spec(Rails.env.to_sym)
+      # Add the default hostnames as well
       ActiveRecord::Base.configurations[Rails.env]["host_names"].each do |host|
-        @host_spec_cache[host] = @default_spec
+        new_host_spec_cache[host] = @default_spec
       end
 
-      @default_connection_handler = ActiveRecord::Base.connection_handler
+      removed_dbs = @db_spec_cache.keys - new_db_spec_cache.keys
+      removed_specs = @db_spec_cache.values_at(*removed_dbs)
+
+      @host_spec_cache = new_host_spec_cache
+      @db_spec_cache = new_db_spec_cache
 
-      @connection_handlers = {}
-      @established_default = false
+      # Clean up connection handler cache.
+      removed_specs.each { |s| @connection_handlers.delete(handler_key(s)) }
+    end
+
+    def reload
+      @reload_mutex.synchronize do
+        load_config!
+      end
     end
 
     def has_db?(db)
@@ -178,18 +248,14 @@ module RailsMultisite
       spec ||= @default_spec
       handler = nil
       if spec != @default_spec
-        handler = @connection_handlers[spec]
+        handler = @connection_handlers[handler_key(spec)]
         unless handler
           handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
           handler_establish_connection(handler, spec)
-          @connection_handlers[spec] = handler
+          @connection_handlers[handler_key(spec)] = handler
         end
       else
         handler = @default_connection_handler
-        if !@established_default
-          handler_establish_connection(handler, spec)
-          @established_default = true
-        end
       end
 
       ActiveRecord::Base.connection_handler = handler
@@ -320,11 +386,11 @@ module RailsMultisite
     private
 
     def handler_establish_connection(handler, spec)
-      if Rails::VERSION::MAJOR >= 5
-        handler.establish_connection(spec.config)
-      else
-        handler.establish_connection(ActiveRecord::Base, spec)
-      end
+      handler.establish_connection(spec.config)
+    end
+
+    def handler_key(spec)
+      self.class.handler_key(spec)
     end
 
   end

data/lib/rails_multisite/middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RailsMultisite
   class Middleware
     def initialize(app, config = nil)

data/lib/rails_multisite/railtie.rb

@@ -7,20 +7,28 @@ module RailsMultisite
     end
 
     initializer "RailsMultisite.init" do |app|
-      Rails.configuration.multisite = false
+      app.config.multisite = false
 
       config_file = ConnectionManagement.default_config_filename
       if File.exist?(config_file)
         ConnectionManagement.config_filename = ConnectionManagement.default_config_filename
-        Rails.configuration.multisite = true
+        app.config.multisite = true
         Rails.logger.formatter = RailsMultisite::Formatter.new
-        app.middleware.insert_after(ActionDispatch::Executor, RailsMultisite::Middleware)
-        app.middleware.delete(ActionDispatch::Executor)
+
+        if !skip_middleware?(app.config)
+          app.middleware.insert_after(ActionDispatch::Executor, RailsMultisite::Middleware)
+          app.middleware.delete(ActionDispatch::Executor)
+        end
 
         if ENV['RAILS_DB'].present?
           ConnectionManagement.establish_connection(db: ENV['RAILS_DB'], raise_on_missing: true)
         end
       end
     end
+
+    def skip_middleware?(config)
+      return false if !config.respond_to?(:skip_multisite_middleware)
+      config.skip_multisite_middleware
+    end
   end
 end

data/lib/rails_multisite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 #
 module RailsMultisite
-  VERSION = "2.0.7"
+  VERSION = "2.3.0"
 end

data/lib/tasks/db.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 desc "migrate all sites in tier"
 task "multisite:migrate" => :environment do
   RailsMultisite::ConnectionManagement.each_connection do |db|

data/lib/tasks/generators.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 desc "generate multisite config file (if missing)"
 task "multisite:generate:config" => :environment do
   filename = RailsMultisite::ConnectionManagement.config_filename
@@ -14,7 +15,6 @@ task "multisite:generate:config" => :environment do
 #   host: localhost
 #   pool: 5
 #   timeout: 5000
-#   db_id: 1           # optionally include other settings you need
 #   host_names:
 #     - www.mysite.com
 #     - www.anothersite.com

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.3.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -78,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Multi tenancy support for Rails