activerecord-tenanted 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8caa70e9efec8b621843583547b9c3b2849bbe6923789c68944bc3dd2de4da8
-  data.tar.gz: 6c6e9bb4e6b7a879c8d6c9ad8e6ee441493aa5b06cbb35f0e3254481555cd3d9
+  metadata.gz: 0c816167bb3121714715c597882f45c9b586ac562545b344417038a7cfcc61f0
+  data.tar.gz: 2f948cd900f8b8728fb02b05209cb85fa1da86340ecd0819de3e56db0ea5f618
 SHA512:
-  metadata.gz: 48772fda086b35feb27532973e33d8284372af39bba95c0e69c8386ac8a8b893d4970d02fd1b47fe5fd76d5af948e845564885c3bcbf6c70ec3dc010952748d7
-  data.tar.gz: 4b0b7cccadd0a5f2acd373b0b152d81c5a632b6ed4bfdf22371300fb5809fccc150202f87fc3b28c05afe50e1c35f3907fcd34b856406d1dff9077fca2d8e180
+  metadata.gz: 29d74ec62e44edbfdd28dbad5a708b5bdd4816e88b758bc48a4b6244f2ca9641138a8ac3d25aeae84b9e901c17ca748d6a42016c3df2ae9d4e6818d0738a4f0e
+  data.tar.gz: ec01de5118d1c22ded517ab0228789664fa6864260c315f1ec4c51f0d198bc3507af7e373bc02e40d8f9fbef5a4d594d9c5609d6dbd435fdbbbd0691422de029

data/Rakefile

@@ -7,3 +7,13 @@ require "bundler/gem_tasks"
 task :clean do
   FileUtils.rm_f(Dir.glob("test/dummy/log/*.log"), verbose: true)
 end
+
+desc "Regenerate tables of contents in some files"
+task "toc" do
+  require "mkmf"
+  if find_executable0("markdown-toc")
+    sh "markdown-toc --maxdepth=3 -i GUIDE.md"
+  else
+    puts "WARN: cannot find markdown-toc, skipping. install with 'npm install markdown-toc'"
+  end
+end

data/lib/active_record/tenanted/base.rb

@@ -8,9 +8,6 @@ module ActiveRecord
       class_methods do
         def initialize(...)
           super
-
-          @tenanted_config_name = nil
-          @tenanted_subtenant_of = nil
         end
 
         def tenanted(config_name = "primary")
@@ -20,7 +17,7 @@ module ActiveRecord
           prepend Tenant
 
           self.connection_class = true
-          @tenanted_config_name = config_name
+          self.tenanted_config_name = config_name
 
           unless tenanted_root_config.configuration_hash[:tenanted]
             raise Error, "The '#{tenanted_config_name}' database is not configured as tenanted."
@@ -30,7 +27,7 @@ module ActiveRecord
         def subtenant_of(class_name)
           prepend Subtenant
 
-          @tenanted_subtenant_of = class_name
+          self.tenanted_subtenant_of_klass_name = class_name
         end
 
         def tenanted?

data/lib/active_record/tenanted/database_configurations/base_config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Tenanted
+    module DatabaseConfigurations
+      class BaseConfig < ActiveRecord::DatabaseConfigurations::HashConfig
+        DEFAULT_MAX_CONNECTION_POOLS = 50
+
+        attr_accessor :test_worker_id
+
+        def initialize(...)
+          super
+          @test_worker_id = nil
+        end
+
+        def database_tasks?
+          false
+        end
+
+        def database_for(tenant_name)
+          tenant_name = tenant_name.to_s
+
+          validate_tenant_name(tenant_name)
+
+          path = sprintf(database, tenant: tenant_name)
+
+          if test_worker_id
+            test_worker_path(path)
+          else
+            path
+          end
+        end
+
+        def database_path_for(tenant_name)
+          coerce_path(database_for(tenant_name))
+        end
+
+        def tenants
+          glob = database_path_for("*")
+          scanner = Regexp.new(database_path_for("(.+)"))
+
+          Dir.glob(glob).map do |path|
+            result = path.scan(scanner).flatten.first
+            if result.nil?
+              warn "WARN: ActiveRecord::Tenanted: Cannot parse tenant name from filename #{path.inspect}. " \
+                   "This is a bug, please report it to https://github.com/basecamp/activerecord-tenanted/issues"
+            end
+            result
+          end
+        end
+
+        def new_tenant_config(tenant_name)
+          config_name = "#{name}_#{tenant_name}"
+          config_hash = configuration_hash.dup.tap do |hash|
+            hash[:tenant] = tenant_name
+            hash[:database] = database_for(tenant_name)
+            hash[:database_path] = database_path_for(tenant_name)
+            hash[:tenanted_config_name] = name
+          end
+          Tenanted::DatabaseConfigurations::TenantConfig.new(env_name, config_name, config_hash)
+        end
+
+        def new_connection
+          raise NoTenantError, "Cannot use an untenanted ActiveRecord::Base connection. " \
+                               "If you have a model that inherits directly from ActiveRecord::Base, " \
+                               "make sure to use 'subtenant_of'. In development, you may see this error " \
+                               "if constant reloading is not being done properly."
+        end
+
+        def max_connection_pools
+          (configuration_hash[:max_connection_pools] || DEFAULT_MAX_CONNECTION_POOLS).to_i
+        end
+
+        private
+          # A sqlite database path can be a file path or a URI (either relative or absolute).
+          # We can't parse it as a standard URI in all circumstances, though, see https://sqlite.org/uri.html
+          def coerce_path(path)
+            if path.start_with?("file:/")
+              URI.parse(path).path
+            elsif path.start_with?("file:")
+              URI.parse(path.sub(/\?.*$/, "")).opaque
+            else
+              path
+            end
+          end
+
+          def validate_tenant_name(tenant_name)
+            if tenant_name.match?(%r{[/'"`]})
+              raise BadTenantNameError, "Tenant name contains an invalid character: #{tenant_name.inspect}"
+            end
+          end
+
+          def test_worker_path(path)
+            test_worker_suffix = "_#{test_worker_id}"
+
+            if path.start_with?("file:") && path.include?("?")
+              path.sub(/(\?.*)$/, "#{test_worker_suffix}\\1")
+            else
+              path + test_worker_suffix
+            end
+          end
+      end
+    end
+  end
+end

data/lib/active_record/tenanted/database_configurations/tenant_config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Tenanted
+    module DatabaseConfigurations
+      class TenantConfig < ActiveRecord::DatabaseConfigurations::HashConfig
+        def tenant
+          configuration_hash.fetch(:tenant)
+        end
+
+        def new_connection
+          ensure_database_directory_exists # adapter doesn't handle this if the database is a URI
+          super.tap { |conn| conn.tenant = tenant }
+        end
+
+        def tenanted_config_name
+          configuration_hash.fetch(:tenanted_config_name)
+        end
+
+        def primary?
+          ActiveRecord::Base.configurations.primary?(tenanted_config_name)
+        end
+
+        def schema_dump(format = ActiveRecord.schema_format)
+          if configuration_hash.key?(:schema_dump) || primary?
+            super
+          else
+            "#{tenanted_config_name}_#{schema_file_type(format)}"
+          end
+        end
+
+        def default_schema_cache_path(db_dir = "db")
+          if primary?
+            super
+          else
+            File.join(db_dir, "#{tenanted_config_name}_schema_cache.yml")
+          end
+        end
+
+        def database_path
+          configuration_hash[:database_path]
+        end
+
+        private
+          def ensure_database_directory_exists
+            return unless database_path
+
+            database_dir = File.dirname(database_path)
+            unless File.directory?(database_dir)
+              FileUtils.mkdir_p(database_dir)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/active_record/tenanted/database_configurations.rb

@@ -5,162 +5,13 @@ require "active_record/database_configurations"
 module ActiveRecord
   module Tenanted
     module DatabaseConfigurations
-      class RootConfig < ActiveRecord::DatabaseConfigurations::HashConfig
-        attr_accessor :test_worker_id
-
-        def initialize(...)
-          super
-          @test_worker_id = nil
-        end
-
-        def database_tasks?
-          false
-        end
-
-        def database_for(tenant_name)
-          tenant_name = tenant_name.to_s
-
-          validate_tenant_name(tenant_name)
-
-          path = sprintf(database, tenant: tenant_name)
-
-          if test_worker_id
-            test_worker_path(path)
-          else
-            path
-          end
-        end
-
-        def database_path_for(tenant_name)
-          coerce_path(database_for(tenant_name))
-        end
-
-        def tenants
-          glob = database_path_for("*")
-          scanner = Regexp.new(database_path_for("(.+)"))
-
-          Dir.glob(glob).map do |path|
-            result = path.scan(scanner).flatten.first
-            if result.nil?
-              warn "WARN: ActiveRecord::Tenanted: Cannot parse tenant name from filename #{path.inspect}. " \
-                   "This is a bug, please report it to https://github.com/basecamp/activerecord-tenanted/issues"
-            end
-            result
-          end
-        end
-
-        def new_tenant_config(tenant_name)
-          config_name = "#{name}_#{tenant_name}"
-          config_hash = configuration_hash.dup.tap do |hash|
-            hash[:tenant] = tenant_name
-            hash[:database] = database_for(tenant_name)
-            hash[:database_path] = database_path_for(tenant_name)
-            hash[:tenanted_config_name] = name
-          end
-          Tenanted::DatabaseConfigurations::TenantConfig.new(env_name, config_name, config_hash)
-        end
-
-        def new_connection
-          raise NoTenantError, "Cannot use an untenanted ActiveRecord::Base connection. " \
-                               "If you have a model that inherits directly from ActiveRecord::Base, " \
-                               "make sure to use 'subtenant_of'. In development, you may see this error " \
-                               "if constant reloading is not being done properly."
-        end
-
-        private
-          # A sqlite database path can be a file path or a URI (either relative or absolute).
-          # We can't parse it as a standard URI in all circumstances, though, see https://sqlite.org/uri.html
-          def coerce_path(path)
-            if path.start_with?("file:/")
-              URI.parse(path).path
-            elsif path.start_with?("file:")
-              URI.parse(path.sub(/\?.*$/, "")).opaque
-            else
-              path
-            end
-          end
-
-          def validate_tenant_name(tenant_name)
-            if tenant_name.match?(%r{[/'"`]})
-              raise BadTenantNameError, "Tenant name contains an invalid character: #{tenant_name.inspect}"
-            end
-          end
-
-          def test_worker_path(path)
-            test_worker_suffix = "_#{test_worker_id}"
-
-            if path.start_with?("file:") && path.include?("?")
-              path.sub(/(\?.*)$/, "#{test_worker_suffix}\\1")
-            else
-              path + test_worker_suffix
-            end
-          end
-      end
-
-      class TenantConfig < ActiveRecord::DatabaseConfigurations::HashConfig
-        def tenant
-          configuration_hash.fetch(:tenant)
-        end
-
-        def new_connection
-          ensure_database_directory_exists # adapter doesn't handle this if the database is a URI
-          super.tap { |conn| conn.tenant = tenant }
-        end
-
-        def tenanted_config_name
-          configuration_hash.fetch(:tenanted_config_name)
-        end
-
-        def primary?
-          ActiveRecord::Base.configurations.primary?(tenanted_config_name)
-        end
-
-        def schema_dump(format = ActiveRecord.schema_format)
-          if configuration_hash.key?(:schema_dump) || primary?
-            super
-          else
-            "#{tenanted_config_name}_#{schema_file_type(format)}"
-          end
-        end
-
-        def default_schema_cache_path(db_dir = "db")
-          if primary?
-            super
-          else
-            File.join(db_dir, "#{tenanted_config_name}_schema_cache.yml")
-          end
-        end
-
-        def database_path
-          configuration_hash[:database_path]
-        end
-
-        private
-          def ensure_database_directory_exists
-            return unless database_path
-
-            database_dir = File.dirname(database_path)
-            unless File.directory?(database_dir)
-              FileUtils.mkdir_p(database_dir)
-            end
-          end
-      end
-
-      # Invoked by the railtie
       def self.register_db_config_handler # :nodoc:
         ActiveRecord::DatabaseConfigurations.register_db_config_handler do |env_name, name, _, config|
           next unless config.fetch(:tenanted, false)
 
-          ActiveRecord::Tenanted::DatabaseConfigurations::RootConfig.new(env_name, name, config)
+          ActiveRecord::Tenanted::DatabaseConfigurations::BaseConfig.new(env_name, name, config)
         end
       end
     end
   end
 end
-
-# Do this here instead of the railtie so we register the handlers before Rails's rake tasks get
-# loaded. If the handler is not present, then the RootConfigs will not return false from
-# `#database_tasks?` and the database tasks will get created anyway.
-#
-# TODO: This can be moved back into the railtie if https://github.com/rails/rails/pull/54959 is merged.
-ActiveRecord::Tenanted::DatabaseConfigurations.register_db_config_handler

data/lib/active_record/tenanted/lru.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Tenanted
+    # Inspired by the lru_redux gem, this LRU queue relies on Concurrent::Hash being ordered
+    class LRU # :nodoc:
+      def initialize
+        @data = Concurrent::Hash.new
+      end
+
+      def [](key)
+        found = true
+        value = @data.delete(key) { found = false }
+        if found
+          @data[key] = value
+        else
+          nil
+        end
+      end
+
+      def []=(key, value)
+        @data.delete key
+        @data[key] = value
+        value
+      end
+
+      def size
+        @data.size
+      end
+
+      def pop
+        key, value = @data.first
+        @data.delete(key)
+        [ key, value ]
+      end
+
+      def keys
+        @data.keys
+      end
+    end
+
+    Lru = LRU
+  end
+end

data/lib/active_record/tenanted/railtie.rb

@@ -57,6 +57,12 @@ module ActiveRecord
       # Defaults to "development-tenant" in development and "test-tenant" in test environments.
       config.active_record_tenanted.default_tenant = Rails.env.local? ? "#{Rails.env}-tenant" : nil
 
+      config.before_configuration do
+        ActiveSupport.on_load(:active_record_database_configurations) do
+          ActiveRecord::Tenanted::DatabaseConfigurations.register_db_config_handler
+        end
+      end
+
       config.before_initialize do
         Rails.application.configure do
           if config.active_record_tenanted.connection_class.present?
@@ -137,6 +143,10 @@ module ActiveRecord
         end
       end
 
+      initializer "active_record_tenanted.action_dispatch", before: "action_dispatch.configure" do
+        config.action_dispatch.rescue_responses["ActiveRecord::Tenanted::TenantDoesNotExistError"] = :not_found
+      end
+
       config.after_initialize do
         if defined?(Rails::Console)
           require "rails/commands/console/irb_console"

data/lib/active_record/tenanted/subtenant.rb

@@ -12,8 +12,7 @@ module ActiveRecord
 
         def tenanted_subtenant_of
           # TODO: cache this / speed this up
-          # but note that we should constantize as late as possible to avoid load order issues
-          klass = @tenanted_subtenant_of&.constantize || superclass.tenanted_subtenant_of
+          klass = tenanted_subtenant_of_klass_name&.constantize
 
           raise Error, "Class #{klass} is not tenanted" unless klass.tenanted?
           raise Error, "Class #{klass} is not a connection class" unless klass.abstract_class?
@@ -26,6 +25,8 @@ module ActiveRecord
 
       prepended do
         prepend TenantCommon
+
+        cattr_accessor :tenanted_subtenant_of_klass_name
       end
 
       def tenanted?

data/lib/active_record/tenanted/tenant.rb

@@ -16,6 +16,10 @@ module ActiveRecord
         tenant ? "#{super}?tenant=#{tenant}" : super
       end
 
+      def inspect
+        tenant ? super.sub(/>$/, ", tenant=#{tenant.inspect}>") : super
+      end
+
       def to_global_id(options = {})
         super(options.merge(tenant: tenant))
       end
@@ -161,7 +165,7 @@ module ActiveRecord
         end
 
         def tenants
-          # DatabaseConfigurations::RootConfig#tenants returns all tenants whose database files
+          # DatabaseConfigurations::BaseConfig#tenants returns all tenants whose database files
           # exist, but some of those may be getting initially migrated, so we perform an additional
           # filter on readiness with `tenant_exist?`.
           tenanted_root_config.tenants.select { |t| tenant_exist?(t) }
@@ -202,10 +206,6 @@ module ActiveRecord
           ActiveRecord::Base.configurations.resolve(tenanted_config_name.to_sym)
         end
 
-        def tenanted_config_name # :nodoc:
-          @tenanted_config_name ||= (superclass.respond_to?(:tenanted_config_name) ? superclass.tenanted_config_name : nil)
-        end
-
         def _create_tenanted_pool(schema_version_check: true) # :nodoc:
           # ensure all classes use the same connection pool
           return superclass._create_tenanted_pool unless connection_class?
@@ -228,10 +228,24 @@ module ActiveRecord
 
         private
           def retrieve_connection_pool(strict:)
-            connection_handler.retrieve_connection_pool(connection_specification_name,
-                                                        role: current_role,
-                                                        shard: current_tenant,
-                                                        strict: strict)
+            role = current_role
+            shard = current_tenant
+            connection_handler.retrieve_connection_pool(connection_specification_name, role:, shard:, strict:).tap do |pool|
+              if pool
+                tenanted_connection_pools[[ shard, role ]] = pool
+                reap_connection_pools
+              end
+            end
+          end
+
+          def reap_connection_pools
+            while tenanted_connection_pools.size > tenanted_root_config.max_connection_pools
+              info, _ = *tenanted_connection_pools.pop
+              shard, role = *info
+
+              connection_handler.remove_connection_pool(connection_specification_name, role:, shard:)
+              Rails.logger.info "  REAPED [tenant=#{shard} role=#{role}] Tenanted connection pool reaped to limit total connection pools"
+            end
           end
 
           def log_tenant_tag(tenant_name, &block)
@@ -247,6 +261,9 @@ module ActiveRecord
         self.default_shard = ActiveRecord::Tenanted::Tenant::UNTENANTED_SENTINEL
 
         prepend TenantCommon
+
+        cattr_accessor :tenanted_config_name
+        cattr_accessor(:tenanted_connection_pools) { LRU.new }
       end
 
       def tenanted?

data/lib/active_record/tenanted/tenant_selector.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "rack/contrib"
-
 module ActiveRecord
   module Tenanted
     #
@@ -34,8 +32,7 @@ module ActiveRecord
         elsif tenanted_class.tenant_exist?(tenant_name)
           tenanted_class.with_tenant(tenant_name) { @app.call(env) }
         else
-          Rails.logger.info("ActiveRecord::Tenanted::TenantSelector: Tenant not found: #{tenant_name.inspect}")
-          Rack::NotFound.new(Rails.root.join("public/404.html")).call(env)
+          raise ActiveRecord::Tenanted::TenantDoesNotExistError, "Tenant not found: #{tenant_name.inspect}"
         end
       end
 

data/lib/active_record/tenanted/testing.rb

@@ -73,9 +73,9 @@ module ActiveRecord
         def transactional_tests_for_pool?(pool)
           config = pool.db_config
 
-          # Prevent the tenanted RootConfig from creating transactional fixtures on an unnecessary
+          # Prevent the tenanted BaseConfig from creating transactional fixtures on an unnecessary
           # database, which would result in sporadic locking errors.
-          is_root_config = config.instance_of?(Tenanted::DatabaseConfigurations::RootConfig)
+          is_root_config = config.instance_of?(Tenanted::DatabaseConfigurations::BaseConfig)
 
           # Any tenanted database that isn't the default test fixture database should not be wrapped
           # in a transaction, for a couple of reasons:

data/lib/active_record/tenanted/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Tenanted
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-tenanted
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Dalessio
@@ -15,42 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.alpha
+        version: 8.1.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.alpha
+        version: 8.1.beta
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.alpha
+        version: 8.1.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.alpha
-- !ruby/object:Gem::Dependency
-  name: rack-contrib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 8.1.beta
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -88,9 +74,12 @@ files:
 - lib/active_record/tenanted/connection_adapter.rb
 - lib/active_record/tenanted/console.rb
 - lib/active_record/tenanted/database_configurations.rb
+- lib/active_record/tenanted/database_configurations/base_config.rb
+- lib/active_record/tenanted/database_configurations/tenant_config.rb
 - lib/active_record/tenanted/database_tasks.rb
 - lib/active_record/tenanted/global_id.rb
 - lib/active_record/tenanted/job.rb
+- lib/active_record/tenanted/lru.rb
 - lib/active_record/tenanted/mailer.rb
 - lib/active_record/tenanted/mutex.rb
 - lib/active_record/tenanted/patches.rb