rails_multisite 2.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c423a9ad1f1506b7278fdad487f740236f6241a5cfced260e135cc4392f0f24d
-  data.tar.gz: 3da1e820fedb5a8ec1c7c34c41668cf62d8891bab765f554e54186688fe27464
+  metadata.gz: c629d2dc8da503bfa856a639b4462108d15f776554dca35dd2d02545bc0e2793
+  data.tar.gz: a8199f54a9af9b8fea60e9c772d845944925499067d3ce29d362ab4ad68f13fe
 SHA512:
-  metadata.gz: 68717b4c14ccf6586de353e1e455aa948e931a498fcb5816008f5f6655e6d8c896793ef635532cc056073f917f7ea6e7205e7f5bc9b4a5a581e574cee76cd47b
-  data.tar.gz: 68779aedd6acb814e8401226ef67ad9636abf3ca71c954cef89226199fd754a34f78c84c5340af2bc2216f9e560d410867837a3fd3d221c53b08449ed60ceb68
+  metadata.gz: 14ea81350cad5b028a1d6558525d350b1dac376168249cb2fdcce148055fe7b86a53b3e4472815567f626025420dfd40156b84a0f6eb80ff714725df3a20d4bc
+  data.tar.gz: b68b07d983452e6b1d785f6e927450cfe761983123408fcc0e7cb4589c4be2d4855a0351964ce497a278c17c5ffcc378a57bbfb55bfdf8a4059466f438d03646

data/README.md

@@ -95,7 +95,7 @@ RAILS_DB=db_one rails console
 
 ### CDN origin support
 
-To avoid needing to configure many origins you can consider using `RailsMultisite::ConnectionManagement.asset_hostname`
+To avoid needing to configure many origins you can consider using `RailsMultisite::ConnectionManagement.asset_hostnames`
 
 When configured, requests to `asset_hostname`?__ws=another.host.name will be re-routed to the correct site. Cookies will
 be stripped on all incoming requests.
@@ -103,7 +103,7 @@ be stripped on all incoming requests.
 Example:
 
 - Multisite serves `sub.example.com` and `assets.example.com`
-- `RailsMultisite::ConnectionManagement.asset_hostname = 'assets.example.com'`
+- `RailsMultisite::ConnectionManagement.asset_hostnames = ['assets.example.com']`
 - Requests to `https://assets.example.com/route/?__ws=sub.example.com` will be routed to the `sub.example.com`
 
 

data/lib/rails_multisite/connection_management/rails_60_compat.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RailsMultisite
+  class ConnectionManagement
+    class ConnectionSpecification
+      class << self
+        def current
+          ActiveRecord::Base.connection_pool.spec
+        end
+
+        def db_spec_cache(configs)
+          resolve_configs = configs
+          # rails 6 needs to use a proper object for the resolver
+          if defined?(ActiveRecord::DatabaseConfigurations)
+            resolve_configs = ActiveRecord::DatabaseConfigurations.new(configs)
+          end
+          resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(resolve_configs)
+          configs.map { |k, _| [k, resolver.spec(k.to_sym)] }.to_h
+        end
+
+        def default
+          ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver
+            .new(ActiveRecord::Base.configurations)
+            .spec(Rails.env.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/rails_multisite/connection_management/rails_61_compat.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RailsMultisite
+  class ConnectionManagement
+    class ConnectionSpecification
+      class << self
+        def current
+          new(ActiveRecord::Base.connection_pool.db_config)
+        end
+
+        def db_spec_cache(configs)
+          resolve_configs = ActiveRecord::DatabaseConfigurations.new(configs)
+          configs.map { |k, _| [k, new(resolve_configs.resolve(k.to_sym))] }.to_h
+        end
+
+        def default
+          new(ActiveRecord::Base.configurations.resolve(Rails.env.to_sym))
+        end
+      end
+
+      attr_reader :spec
+
+      def initialize(spec)
+        @spec = spec
+      end
+
+      def name
+        spec.env_name
+      end
+
+      def to_hash
+        spec.configuration_hash
+      end
+      alias config to_hash
+    end
+  end
+end

data/lib/rails_multisite/connection_management.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
-#
+
+if Rails.version >= '6.1'
+  require 'rails_multisite/connection_management/rails_61_compat'
+else
+  require 'rails_multisite/connection_management/rails_60_compat'
+end
+
 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")
@@ -35,12 +39,12 @@ module RailsMultisite
       end
     end
 
-    def self.asset_hostname
-      @asset_hostname
+    def self.asset_hostnames
+      @asset_hostnames
     end
 
-    def self.asset_hostname=(h)
-      @asset_hostname = h
+    def self.asset_hostnames=(h)
+      @asset_hostnames = h
     end
 
     def self.config_filename
@@ -104,16 +108,11 @@ module RailsMultisite
     end
 
     def self.current_hostname
-      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].first
+      current_db_hostnames.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 = (@instance&.connection_spec(db: current_db) || ConnectionSpecification.current).config
       config[:host_names].nil? ? [config[:host]] : config[:host_names]
     end
 
@@ -121,7 +120,7 @@ module RailsMultisite
       if @instance
         @instance.connection_spec(opts)
       else
-        ActiveRecord::Base.connection_pool.spec
+        ConnectionSpecification.current
       end
     end
 
@@ -170,7 +169,7 @@ module RailsMultisite
       end
 
       @db_spec_cache = {}
-      @default_spec = SPEC_KLASS::Resolver.new(ActiveRecord::Base.configurations).spec(Rails.env.to_sym)
+      @default_spec = ConnectionSpecification.default
       @default_connection_handler = ActiveRecord::Base.connection_handler
 
       @reload_mutex = Mutex.new
@@ -181,7 +180,7 @@ module RailsMultisite
     def load_config!
       configs = YAML::load(File.open(@config_filename))
 
-      no_prepared_statements = ActiveRecord::Base.configurations[Rails.env]["prepared_statements"] == false
+      no_prepared_statements = @default_spec.config[:prepared_statements] == false
 
       configs.each do |k, v|
         raise ArgumentError.new("Please do not name any db default!") if k == DEFAULT
@@ -189,17 +188,8 @@ module RailsMultisite
         v[:prepared_statements] = false if no_prepared_statements
       end
 
-      resolve_configs = configs
-
-      # rails 6 needs to use a proper object for the resolver
-      if defined?(ActiveRecord::DatabaseConfigurations)
-        resolve_configs = ActiveRecord::DatabaseConfigurations.new(configs)
-      end
-
-      resolver = SPEC_KLASS::Resolver.new(resolve_configs)
-
       # 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 = ConnectionSpecification.db_spec_cache(configs)
       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
@@ -217,7 +207,7 @@ module RailsMultisite
       end
 
       # Add the default hostnames as well
-      ActiveRecord::Base.configurations[Rails.env]["host_names"].each do |host|
+      @default_spec.config[:host_names].each do |host|
         new_host_spec_cache[host] = @default_spec
       end
 
@@ -365,7 +355,7 @@ module RailsMultisite
     end
 
     def current_db
-      ActiveRecord::Base.connection_pool.spec.config[:db_key] || DEFAULT
+      ConnectionSpecification.current.config[:db_key] || DEFAULT
     end
 
     def current_hostname
@@ -380,7 +370,7 @@ module RailsMultisite
       request = Rack::Request.new(env)
 
       host =
-        if request['__ws'] && request.host == self.class.asset_hostname
+        if request['__ws'] && self.class.asset_hostnames&.include?(request.host)
           request.cookies.clear
           request['__ws']
         else

data/lib/rails_multisite/cookie_salt.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsMultisite
+  class CookieSalt
+    COOKIE_SALT_KEYS = [
+      "action_dispatch.signed_cookie_salt",
+      "action_dispatch.encrypted_cookie_salt",
+      "action_dispatch.encrypted_signed_cookie_salt",
+      "action_dispatch.authenticated_encrypted_cookie_salt"
+    ]
+
+    def self.update_cookie_salts(env:, host:)
+      COOKIE_SALT_KEYS.each { |key| env[key] = "#{env[key]} #{host}" }
+    end
+  end
+end

data/lib/rails_multisite/middleware.rb

@@ -22,6 +22,7 @@ module RailsMultisite
 
         ActiveRecord::Base.connection_handler.clear_active_connections!
         ConnectionManagement.establish_connection(host: host, db: db)
+        CookieSalt.update_cookie_salts(env: env, host: host)
         @app.call(env)
       ensure
         ActiveRecord::Base.connection_handler.clear_active_connections!

data/lib/rails_multisite/railtie.rb

@@ -9,9 +9,14 @@ module RailsMultisite
     initializer "RailsMultisite.init" do |app|
       app.config.multisite = false
 
-      config_file = ConnectionManagement.default_config_filename
+      config_file =
+        app.config.respond_to?(:multisite_config_path) &&
+        app.config.multisite_config_path.presence
+
+      config_file ||= ConnectionManagement.default_config_filename
+
       if File.exist?(config_file)
-        ConnectionManagement.config_filename = ConnectionManagement.default_config_filename
+        ConnectionManagement.config_filename = config_file
         app.config.multisite = true
         Rails.logger.formatter = RailsMultisite::Formatter.new
 

data/lib/rails_multisite/version.rb

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

data/lib/rails_multisite.rb

@@ -7,3 +7,4 @@ require 'rails_multisite/railtie'
 require 'rails_multisite/formatter'
 require 'rails_multisite/connection_management'
 require 'rails_multisite/middleware'
+require 'rails_multisite/cookie_salt'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -61,6 +61,9 @@ files:
 - README.md
 - lib/rails_multisite.rb
 - lib/rails_multisite/connection_management.rb
+- lib/rails_multisite/connection_management/rails_60_compat.rb
+- lib/rails_multisite/connection_management/rails_61_compat.rb
+- lib/rails_multisite/cookie_salt.rb
 - lib/rails_multisite/formatter.rb
 - lib/rails_multisite/middleware.rb
 - lib/rails_multisite/railtie.rb
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Multi tenancy support for Rails