rails_multisite 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3fe0041751b722c29731d43407a107d44873642fa1166d8c28f15a776c35ac9
-  data.tar.gz: ed8fedef6ee6ae4e11725f88d0375f17abe62a94a04bb99417b69daad3a2887c
+  metadata.gz: ee4885d481591f47f16a367e206e103af5ef3ea1504d65e0c34f97fa8766b91f
+  data.tar.gz: b6dc6f7d07e5ced80e7da754f5940b30a42a60d02e859afc8c949ffdf24f8b60
 SHA512:
-  metadata.gz: b17dd4868f46d9cddf9a7ec2156d0d7aacc1e359673440e15b723b26ec67750fac5f3da2028e2d1d31f9234979dbe3ef3bd03511d1ea19ecb7c9ec40f10c5fca
-  data.tar.gz: e3de9e44f8f4a04b0be895472ad360a32877644f1c7ce2939a674556965070908c5b0dd65d70c7b2ea3962490d4fcccfbd2781798d928d3387c84395426ec2f8
+  metadata.gz: c9d34362e98ddce5e8f771233ad43a803cf66e71bcd546dedaee3ae4a06991149f2e07d9e6024cbc111ee3166db7c193772cfdf7c78bec729da772b5db06a5bf
+  data.tar.gz: 4c9fdee8046e62e40be983d6f28f8e0fc703f89129e3d41d7ee9003aefa1c344bd170b7d4a5c1575729b80363ee2a7cfb48ad6a299564db3aa52da2fef0090c4

data/README.md

@@ -93,6 +93,19 @@ To get a Rails console that is connected to `some_database_1` database:
 RAILS_DB=db_one rails console
 ```
 
+### CDN origin support
+
+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.
+
+Example:
+
+- Multisite serves `sub.example.com` and `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`
+
 
 ## Contributing
 

data/lib/rails_multisite/connection_management.rb

@@ -1,16 +1,24 @@
 # 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")
     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
 
@@ -31,6 +39,14 @@ module RailsMultisite
       end
     end
 
+    def self.asset_hostnames
+      @asset_hostnames
+    end
+
+    def self.asset_hostnames=(h)
+      @asset_hostnames = h
+    end
+
     def self.config_filename
       @instance.config_filename
     end
@@ -92,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
 
@@ -109,7 +120,7 @@ module RailsMultisite
       if @instance
         @instance.connection_spec(opts)
       else
-        ActiveRecord::Base.connection_pool.spec
+        ConnectionSpecification.current
       end
     end
 
@@ -121,17 +132,45 @@ 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
 
-      @connection_handlers = {}
-      @db_spec_cache = {}
+      @connection_handlers = begin
+        if ActiveRecord::Base.respond_to?(:connection_handlers)
+          ActiveRecord::Base.connection_handlers
+        else
+          {}
+        end
+      end
 
-      @default_spec = SPEC_KLASS::Resolver.new(ActiveRecord::Base.configurations).spec(Rails.env.to_sym)
+      @db_spec_cache = {}
+      @default_spec = ConnectionSpecification.default
       @default_connection_handler = ActiveRecord::Base.connection_handler
-      @established_default = false
 
       @reload_mutex = Mutex.new
 
@@ -141,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
@@ -149,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
@@ -177,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
 
@@ -188,8 +218,7 @@ module RailsMultisite
       @db_spec_cache = new_db_spec_cache
 
       # Clean up connection handler cache.
-      # (@connection_handlers is a hash of spec => handler)
-      removed_specs.each { |s| @connection_handlers.delete(s) }
+      removed_specs.each { |s| @connection_handlers.delete(handler_key(s)) }
     end
 
     def reload
@@ -217,18 +246,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
@@ -330,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
@@ -343,7 +368,14 @@ module RailsMultisite
       end
 
       request = Rack::Request.new(env)
-      host = request['__ws'] || request.host
+
+      host =
+        if request['__ws'] && self.class.asset_hostnames&.include?(request.host)
+          request.cookies.clear
+          request['__ws']
+        else
+          request.host
+        end
 
       env["RAILS_MULTISITE_HOST"] = host
     end
@@ -362,5 +394,9 @@ module RailsMultisite
       handler.establish_connection(spec.config)
     end
 
+    def handler_key(spec)
+      self.class.handler_key(spec)
+    end
+
   end
 end

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -61,6 +61,8 @@ 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/formatter.rb
 - lib/rails_multisite/middleware.rb
 - lib/rails_multisite/railtie.rb
@@ -70,7 +72,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Multi tenancy support for Rails
 test_files: []