activerecord-tenanted 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6045a554346528724708d7acfcefa45c3445f5dd1bbc184426ce13e995bbb83
-  data.tar.gz: 5c752644fcb587efff882e8c117933147dccc5771e74c3ea3d9b967eaa33f5dc
+  metadata.gz: 62c3b9d7f37db44de60c7559e4b10e1407171ab29aa874e2687853e8acc38bb1
+  data.tar.gz: 27b2ee871ff4ce67b60480e83694cf6a2aeac504b3ab39f96ea0eb243b5f3a47
 SHA512:
-  metadata.gz: cb160898373d824906708a959d59b40d1f76fa398b2fcdebadd57b590ddd63a3da2fcbe53eb8787a5af041f108eb27516afb27febe4aa62eb76c9a1cd7cccd4f
-  data.tar.gz: e001ccf67a7e4891df031ee6ceb34c20f227cb3ef3499decf2e5cce59b638a76f9a8b4200c55105910a74c3f7478c11b32aeb34d8f7da481d8b388a51997b899
+  metadata.gz: 7eff54730cbc865dd8ecb1169e146194b0edceaed0527059ed110537aedd57901a5a5af5b85c522bfebcf50714c468984f91ac4f5c8e40077b2e737497eac550
+  data.tar.gz: fafa6f206173a7057e090407f5cf6698bd7f1d34885509793568f1e76baedbe61b7eeea980493b5af0df30c3f5bd20400c799eebecf62785f458e925afbee57f

data/lib/active_record/tenanted/connection_adapter.rb

@@ -2,18 +2,27 @@
 
 module ActiveRecord
   module Tenanted
-    module ConnectionAdapter # :nodoc:
+    #
+    #  Extends ActiveRecord::ConnectionAdapters::AbstractAdapter with a `tenant` attribute.
+    #
+    #  This is useful in conjunction with the `:tenant` query log tag, which configures logging of
+    #  the tenant in SQL query logs (when `config.active_record.query_log_tags_enabled` is set to
+    #  `true`). For example:
+    #
+    #      Rails.application.config.active_record.query_log_tags_enabled = true
+    #      Rails.application.config.active_record.query_log_tags = [ :tenant ]
+    #
+    #  will cause the application to emit logs like:
+    #
+    #      User Load (0.2ms)  SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT 1 /*tenant='foo'*/
+    #
+    module ConnectionAdapter
       extend ActiveSupport::Concern
 
       prepended do
         attr_accessor :tenant
       end
 
-      def log(sql, name = "SQL", binds = [], type_casted_binds = [], async: false, allow_retry: false, &block)
-        name = [ name, "[tenant=#{tenant}]" ].compact.join(" ") if tenanted?
-        super
-      end
-
       def tenanted?
         tenant.present?
       end

data/lib/active_record/tenanted/console.rb

@@ -5,7 +5,11 @@ module ActiveRecord
     module Console # :nodoc:
       module IRBConsole
         def start
-          ActiveRecord::Tenanted::DatabaseTasks.set_current_tenant if Rails.env.local?
+          # TODO: we could be setting the current tenant for all tenanted configs.
+          if Rails.env.local? && ActiveRecord::Tenanted.connection_class
+            config = ActiveRecord::Tenanted.connection_class.connection_pool.db_config
+            ActiveRecord::Tenanted::DatabaseTasks.new(config).set_current_tenant
+          end
           super
         end
       end

data/lib/active_record/tenanted/database_adapter.rb

@@ -2,24 +2,29 @@
 
 module ActiveRecord
   module Tenanted
-    class DatabaseAdapter # :nodoc:
-      ADAPTERS = {
-        "sqlite3" => "ActiveRecord::Tenanted::DatabaseAdapters::SQLite",
-      }.freeze
+    module DatabaseAdapter # :nodoc:
+      # Hash of registered database configuration adapters
+      @adapters = {}
 
       class << self
+        def register(name, class_name)
+          @adapters[name.to_s] = class_name
+        end
+
         def new(db_config)
-          adapter_class_name = ADAPTERS[db_config.adapter]
+          adapter_class_name = @adapters[db_config.adapter]
 
           if adapter_class_name.nil?
             raise ActiveRecord::Tenanted::UnsupportedDatabaseError,
                   "Unsupported database adapter for tenanting: #{db_config.adapter}. " \
-                  "Supported adapters: #{ADAPTERS.keys.join(', ')}"
+                  "Supported adapters: #{@adapters.keys.join(', ')}"
           end
 
           adapter_class_name.constantize.new(db_config)
         end
       end
+
+      register "sqlite3", "ActiveRecord::Tenanted::DatabaseAdapters::SQLite"
     end
   end
 end

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

@@ -18,11 +18,11 @@ module ActiveRecord
         end
 
         def new_connection
-          # TODO: The Rails SQLite adapter doesn't handle directory creation for file: URIs. I would
-          # like to fix that upstream, and remove this line.
+          # TODO: This line can be removed once rails/rails@f1f60dc1 is in a released version of
+          # Rails, and this gem's dependency has been bumped to require that version or later.
           config_adapter.ensure_database_directory_exists
 
-          super.tap { |conn| conn.tenant = tenant }
+          super.tap { |connection| connection.tenant = tenant }
         end
 
         def tenanted_config_name

data/lib/active_record/tenanted/database_tasks.rb

@@ -1,54 +1,63 @@
 # frozen_string_literal: true
 
+require "rake"
+
 module ActiveRecord
   module Tenanted
-    module DatabaseTasks # :nodoc:
-      extend self
-
-      def migrate_all
-        raise ArgumentError, "Could not find a tenanted database" unless config = base_config
+    class DatabaseTasks # :nodoc:
+      include Rake::DSL
 
-        tenants = config.tenants.presence || [ get_current_tenant ].compact
-        tenants.each do |tenant|
-          tenant_config = config.new_tenant_config(tenant)
-          migrate(tenant_config)
+      class << self
+        def verbose?
+          ActiveRecord::Tasks::DatabaseTasks.send(:verbose?)
         end
       end
 
-      def migrate_tenant(tenant_name = set_current_tenant)
-        raise ArgumentError, "Could not find a tenanted database" unless config = base_config
+      attr_reader :config
+
+      def initialize(config)
+        unless config.is_a?(ActiveRecord::Tenanted::DatabaseConfigurations::BaseConfig)
+          raise TypeError, "Argument must be an instance of ActiveRecord::Tenanted::DatabaseConfigurations::BaseConfig"
+        end
+        @config = config
+      end
 
-        tenant_config = config.new_tenant_config(tenant_name)
+      def migrate_all
+        tenants.each do |tenant|
+          migrate_tenant(tenant)
+        end
+      end
 
-        migrate(tenant_config)
+      def migrate_tenant(tenant = set_current_tenant)
+        db_config = config.new_tenant_config(tenant)
+        migrate(db_config)
       end
 
       def drop_all
-        raise ArgumentError, "Could not find a tenanted database" unless config = base_config
-
-        config.tenants.each do |tenant|
-          db_config = config.new_tenant_config(tenant)
-          db_config.config_adapter.drop_database
-          $stdout.puts "Dropped database '#{db_config.database}'" if verbose?
+        tenants.each do |tenant|
+          drop_tenant(tenant)
         end
       end
 
-      def base_config
-        db_configs = ActiveRecord::Base.configurations.configs_for(
-          env_name: ActiveRecord::Tasks::DatabaseTasks.env,
-          include_hidden: true
-        )
-        db_configs.detect { |c| c.configuration_hash[:tenanted] }
+      def drop_tenant(tenant = set_current_tenant)
+        db_config = config.new_tenant_config(tenant)
+        db_config.config_adapter.drop_database
+        $stdout.puts "Dropped database '#{db_config.database}'" if verbose?
+      end
+
+      def tenants
+        config.tenants.presence || [ get_default_tenant ].compact
       end
 
-      def get_current_tenant
+      def get_default_tenant
+        # TODO: needs to work with multiple tenanted configs, maybe using ENV["ARTENANT_#{config.name}"]
         tenant = ENV["ARTENANT"]
 
         if tenant.present?
           $stdout.puts "Setting current tenant to #{tenant.inspect}" if verbose?
         elsif Rails.env.local?
           tenant = Rails.application.config.active_record_tenanted.default_tenant
-          $stdout.puts "Defaulting current tenant to #{tenant.inspect}" if verbose?
+          $stdout.puts "Defaulting current tenant for #{config.name.inspect} to #{tenant.inspect}" if verbose?
         else
           tenant = nil
           $stdout.puts "Cannot determine an implicit tenant: ARTENANT not set, and Rails.env is not local." if verbose?
@@ -64,7 +73,7 @@ module ActiveRecord
         end
 
         if connection_class.current_tenant.nil?
-          connection_class.current_tenant = get_current_tenant
+          connection_class.current_tenant = get_default_tenant
         else
           connection_class.current_tenant
         end
@@ -107,7 +116,49 @@ module ActiveRecord
       end
 
       def verbose?
-        ActiveRecord::Tasks::DatabaseTasks.send(:verbose?)
+        self.class.verbose?
+      end
+
+      def register_rake_tasks
+        name = config.name
+
+        desc "Migrate tenanted #{name} databases for current environment"
+        task "db:migrate:#{name}" => "load_config" do
+          verbose_was = ActiveRecord::Migration.verbose
+          ActiveRecord::Migration.verbose = ActiveRecord::Tenanted::DatabaseTasks.verbose?
+
+          tenant = ENV["ARTENANT"]
+          if tenant.present?
+            migrate_tenant(tenant)
+          else
+            migrate_all
+          end
+        ensure
+          ActiveRecord::Migration.verbose = verbose_was
+        end
+        task "db:migrate" => "db:migrate:#{name}"
+        task "db:prepare" => "db:migrate:#{name}"
+
+        desc "Drop tenanted #{name} databases for current environment"
+        task "db:drop:#{name}" => "load_config" do
+          verbose_was = ActiveRecord::Migration.verbose
+          ActiveRecord::Migration.verbose = ActiveRecord::Tenanted::DatabaseTasks.verbose?
+
+          tenant = ENV["ARTENANT"]
+          if tenant.present?
+            drop_tenant(tenant)
+          else
+            drop_all
+          end
+        ensure
+          ActiveRecord::Migration.verbose = verbose_was
+        end
+        task "db:drop" => "db:drop:#{name}"
+
+        # TODO: Rails' database tasks include "db:seed" in the tasks that "db:reset" runs.
+        desc "Drop and recreate tenanted #{name} database from its schema for the current environment"
+        task "db:reset:#{name}" => [ "db:drop:#{name}", "db:migrate:#{name}" ]
+        task "db:reset" => "db:reset:#{name}"
       end
     end
   end

data/lib/active_record/tenanted/railtie.rb

@@ -148,6 +148,10 @@ module ActiveRecord
       end
 
       config.after_initialize do
+        ActiveRecord::QueryLogs.taggings = ActiveRecord::QueryLogs.taggings.merge(
+          tenant: ->(context) { context[:connection].tenant }
+        )
+
         if defined?(Rails::Console)
           require "rails/commands/console/irb_console"
           Rails::Console::IRBConsole.prepend ActiveRecord::Tenanted::Console::IRBConsole

data/lib/active_record/tenanted/tenant.rb

@@ -120,7 +120,8 @@ module ActiveRecord
 
         def create_tenant(tenant_name, if_not_exists: false, &block)
           created_db = false
-          adapter = tenanted_root_config.new_tenant_config(tenant_name).config_adapter
+          base_config = tenanted_root_config
+          adapter = base_config.new_tenant_config(tenant_name).config_adapter
 
           adapter.acquire_ready_lock do
             unless adapter.database_exist?
@@ -128,7 +129,7 @@ module ActiveRecord
 
               with_tenant(tenant_name) do
                 connection_pool(schema_version_check: false)
-                ActiveRecord::Tenanted::DatabaseTasks.migrate_tenant(tenant_name)
+                ActiveRecord::Tenanted::DatabaseTasks.new(base_config).migrate_tenant(tenant_name)
               end
 
               created_db = true

data/lib/active_record/tenanted/untenanted_connection_pool.rb

@@ -28,6 +28,10 @@ module ActiveRecord
         ActiveRecord::ConnectionAdapters::BoundSchemaReflection.new(schema_reflection, self)
       end
 
+      def size
+        db_config.max_connections
+      end
+
       def lease_connection(...)
         raise Tenanted::NoTenantError, "Cannot connect to a tenanted database while untenanted (#{@model})."
       end

data/lib/active_record/tenanted/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Tenanted
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/active_record/tenanted.rb

@@ -41,10 +41,19 @@ module ActiveRecord
     # Raised when an unsupported database adapter is used.
     class UnsupportedDatabaseError < Error; end
 
+    # Return the constantized connection class configured in `config.active_record_tenanted.connection_class`,
+    # or nil if none is configured.
     def self.connection_class
       # TODO: cache this / speed this up
       Rails.application.config.active_record_tenanted.connection_class&.constantize
     end
+
+    # Return an Array of the tenanted database configurations.
+    def self.base_configs(configurations = ActiveRecord::Base.configurations)
+      configurations
+        .configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env, include_hidden: true)
+        .select { |c| c.configuration_hash[:tenanted] }
+    end
   end
 end
 

data/lib/tasks/active_record/tenanted_tasks.rake

@@ -1,78 +1,20 @@
 # frozen_string_literal: true
 
-namespace :db do
-  desc "Migrate the database for tenant ARTENANT"
-  task "migrate:tenant" => "load_config" do
-    unless ActiveRecord::Tenanted.connection_class
-      warn "ActiveRecord::Tenanted integration is not configured via connection_class"
-      next
-    end
-
-    unless ActiveRecord::Tenanted::DatabaseTasks.base_config
-      warn "WARNING: No tenanted database found, skipping tenanted migration"
-    else
-      begin
-        verbose_was = ActiveRecord::Migration.verbose
-        ActiveRecord::Migration.verbose = ActiveRecord::Tenanted::DatabaseTasks.verbose?
-
-        ActiveRecord::Tenanted::DatabaseTasks.migrate_tenant
-      ensure
-        ActiveRecord::Migration.verbose = verbose_was
-      end
-    end
-  end
-
-  desc "Migrate the database for all existing tenants"
-  task "migrate:tenant:all" => "load_config" do
-    unless ActiveRecord::Tenanted.connection_class
-      warn "ActiveRecord::Tenanted integration is not configured via connection_class"
-      next
-    end
-
-    verbose_was = ActiveRecord::Migration.verbose
-    ActiveRecord::Migration.verbose = ActiveRecord::Tenanted::DatabaseTasks.verbose?
-
-    ActiveRecord::Tenanted::DatabaseTasks.migrate_all
-  ensure
-    ActiveRecord::Migration.verbose = verbose_was
-  end
-
-  desc "Drop and recreate all tenant databases from their schema for the current environment"
-  task "reset:tenant" => [ "db:drop:tenant", "db:migrate:tenant" ]
-
-  desc "Drop all tenanted databases for the current environment"
-  task "drop:tenant" => "load_config" do
-    unless ActiveRecord::Tenanted::DatabaseTasks.base_config
-      warn "WARNING: No tenanted database found, skipping tenanted reset"
-    else
-      begin
-        verbose_was = ActiveRecord::Migration.verbose
-        ActiveRecord::Migration.verbose = ActiveRecord::Tenanted::DatabaseTasks.verbose?
-
-        ActiveRecord::Tenanted::DatabaseTasks.drop_all
-      ensure
-        ActiveRecord::Migration.verbose = verbose_was
-      end
-    end
+# Ensure a default tenant is set for database tasks that may need it.
+desc "Set the current tenant to ARTENANT if present, else the environment default"
+task "db:tenant" => "load_config" do
+  unless ActiveRecord::Tenanted.connection_class
+    warn "ActiveRecord::Tenanted integration is not configured via connection_class"
+    next
   end
 
-  desc "Set the current tenant to ARTENANT if present, else the environment default"
-  task "tenant" => "load_config" do
-    unless ActiveRecord::Tenanted.connection_class
-      warn "ActiveRecord::Tenanted integration is not configured via connection_class"
-      next
-    end
-
-    ActiveRecord::Tenanted::DatabaseTasks.set_current_tenant
-  end
+  config = ActiveRecord::Tenanted.connection_class.connection_pool.db_config
+  ActiveRecord::Tenanted::DatabaseTasks.new(config).set_current_tenant
 end
-
-# Decorate database tasks with the tenanted version.
-task "db:migrate" => "db:migrate:tenant:all"
-task "db:prepare" => "db:migrate:tenant:all"
-task "db:reset"   => "db:reset:tenant"
-task "db:drop"    => "db:drop:tenant"
-
-# Ensure a default tenant is set for database tasks that may need it.
 task "db:fixtures:load" => "db:tenant"
 task "db:seed"          => "db:tenant"
+
+# Create tenanted rake tasks
+ActiveRecord::Tenanted.base_configs(ActiveRecord::DatabaseConfigurations.new(ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml)).each do |config|
+  ActiveRecord::Tenanted::DatabaseTasks.new(config).register_rake_tasks
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-tenanted
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Dalessio