rails_multisite 2.3.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2acf52c9b8002bff6a1590222b85d778cb1ddd9e28de6ac91eed45d5117e30aa
-  data.tar.gz: 3b39a8d9a2d2b70c62e29a0541d585c499a51cb9ac6b8dac2544343b1c22d45c
+  metadata.gz: 99ce217ca2700339f5e12dbe053a99c982e371984d7b52341939c4af8c8dd8f2
+  data.tar.gz: d653055f22c50b36201509cb9112a2dde807290bce92e8ccf7d4d53fcfe56628
 SHA512:
-  metadata.gz: f7b8775f143c21083b7141ca6592c5f8d75f12a287f14452a63ff159f0932c0fafe918256d8219431d9d3647b09b340daab747d5b0b10ff3e1c1b1c1f3eeab34
-  data.tar.gz: 81abf0c622d83d541bb0870a7bc2cac379c137ae4057b11a44bc8ab8ff4a6be3e1b730420766b22a55ff3aa7505ef7e9e0ab5494c8c1bdedfc8444e862cf0af0
+  metadata.gz: 401d946022e824da7e263da2d8717af89d944bbf7c35ce4e7eab6e64643fdb0a402df73586d2df0e16a3bcb2e4a56f906a7e55f29e5ff496db25df108cc7bda9
+  data.tar.gz: e073dbde5eb080f4d78db98c4842cbeafc22c58c4df6e41933321553327e0bdeffad0cd08d3c09d1f35193550b1d38a5814ee5e70125f28a5bbe98cb6839135c

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/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,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
@@ -96,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
 
@@ -113,7 +120,7 @@ module RailsMultisite
       if @instance
         @instance.connection_spec(opts)
       else
-        ActiveRecord::Base.connection_pool.spec
+        ConnectionSpecification.current
       end
     end
 
@@ -162,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
@@ -173,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
@@ -181,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
@@ -209,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
 
@@ -357,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
@@ -370,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

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.3.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2021-09-10 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
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Multi tenancy support for Rails