activerecord-multi-tenant 1.0.0 → 1.1.0

data/gemfiles/{rails_5.0.gemfile → rails_6.0.gemfile}

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "5.0.1"
+gem "rails", "~> 6.0.3"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile.lock

@@ -0,0 +1,198 @@
+PATH
+  remote: ..
+  specs:
+    activerecord-multi-tenant (1.1.0)
+      rails (>= 4.2)
+      request_store (>= 1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activestorage (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    connection_pool (2.2.2)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.1)
+      actioncable (= 6.0.3.1)
+      actionmailbox (= 6.0.3.1)
+      actionmailer (= 6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actiontext (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    redis (4.1.4)
+    request_store (1.5.0)
+      rack (>= 1.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-multi-tenant!
+  appraisal
+  pg
+  pry
+  pry-byebug
+  rails (~> 6.0.3)
+  rake
+  rspec (>= 3.0)
+  rspec-rails
+  sidekiq
+  thor
+
+BUNDLED WITH
+   2.1.4

data/lib/activerecord-multi-tenant.rb

@@ -10,3 +10,4 @@ require_relative 'activerecord-multi-tenant/query_rewriter'
 require_relative 'activerecord-multi-tenant/query_monitor'
 require_relative 'activerecord-multi-tenant/version'
 require_relative 'activerecord-multi-tenant/with_lock'
+require_relative 'activerecord-multi-tenant/persistence_extension'

data/lib/activerecord-multi-tenant/controller_extensions.rb

@@ -20,10 +20,6 @@ module MultiTenant
   end
 end
 
-if defined?(ActionController::Base)
-  ActionController::Base.extend MultiTenant::ControllerExtensions
-end
-
-if defined?(ActionController::API)
-  ActionController::API.extend MultiTenant::ControllerExtensions
+ActiveSupport.on_load(:action_controller) do |base|
+  base.extend MultiTenant::ControllerExtensions
 end

data/lib/activerecord-multi-tenant/copy_from_client.rb

@@ -28,6 +28,6 @@ module MultiTenant
   end
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend(MultiTenant::CopyFromClient)
+ActiveSupport.on_load(:active_record) do |base|
+  base.extend(MultiTenant::CopyFromClient)
 end

data/lib/activerecord-multi-tenant/migrations.rb

@@ -44,10 +44,10 @@ module ActiveRecord
     module SchemaStatements
       alias :orig_create_table :create_table
       def create_table(table_name, options = {}, &block)
-        ret = orig_create_table(table_name, options.except(:partition_key), &block)
+        ret = orig_create_table(table_name, **options.except(:partition_key), &block)
         if options[:partition_key] && options[:partition_key].to_s != 'id'
           execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{table_name}_pkey"
-          execute "ALTER TABLE #{table_name} ADD PRIMARY KEY(id, \"#{options[:partition_key]}\")"
+          execute "ALTER TABLE #{table_name} ADD PRIMARY KEY(\"#{options[:partition_key]}\", id)"
         end
         ret
       end

data/lib/activerecord-multi-tenant/model_extensions.rb

@@ -24,11 +24,6 @@ module MultiTenant
           def primary_key
             return @primary_key if @primary_key
 
-            if ::ActiveRecord::VERSION::MAJOR < 5
-              @primary_key = super || DEFAULT_ID_FIELD
-              return @primary_key if connection.schema_cache.columns_hash(table_name).include? @primary_key
-            end
-
             primary_object_keys = Array.wrap(connection.schema_cache.primary_keys(table_name)) - [partition_key]
 
             if primary_object_keys.size == 1
@@ -54,7 +49,7 @@ module MultiTenant
 
         # Create an implicit belongs_to association only if tenant class exists
         if MultiTenant.tenant_klass_defined?(tenant_name)
-          belongs_to tenant_name, options.slice(:class_name, :inverse_of).merge(foreign_key: options[:partition_key])
+          belongs_to tenant_name, **options.slice(:class_name, :inverse_of).merge(foreign_key: options[:partition_key])
         end
 
         # New instances should have the tenant set
@@ -126,16 +121,14 @@ module MultiTenant
   end
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend(MultiTenant::ModelExtensionsClassMethods)
+ActiveSupport.on_load(:active_record) do |base|
+  base.extend MultiTenant::ModelExtensionsClassMethods
 end
 
-if ActiveRecord::VERSION::MAJOR > 4 || (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2)
-  class ActiveRecord::Associations::Association
-    alias skip_statement_cache_orig skip_statement_cache?
-    def skip_statement_cache?(*scope)
-      return true if klass.respond_to?(:scoped_by_tenant?) && klass.scoped_by_tenant?
-      skip_statement_cache_orig(*scope)
-    end
+class ActiveRecord::Associations::Association
+  alias skip_statement_cache_orig skip_statement_cache?
+  def skip_statement_cache?(*scope)
+    return true if klass.respond_to?(:scoped_by_tenant?) && klass.scoped_by_tenant?
+    skip_statement_cache_orig(*scope)
   end
 end

data/lib/activerecord-multi-tenant/multi_tenant.rb

@@ -33,6 +33,15 @@ module MultiTenant
     @@multi_tenant_models[table_name.to_s]
   end
 
+  def self.multi_tenant_model_for_arel(arel)
+    return nil unless arel.respond_to?(:ast)
+    if arel.ast.relation.is_a? Arel::Nodes::JoinSource
+      MultiTenant.multi_tenant_model_for_table(arel.ast.relation.left.table_name)
+    else
+      MultiTenant.multi_tenant_model_for_table(arel.ast.relation.table_name)
+    end
+  end
+
   def self.current_tenant=(tenant)
     RequestStore.store[:current_tenant] = tenant
   end

data/lib/activerecord-multi-tenant/persistence_extension.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module Persistence
+    alias :delete_orig :delete
+
+    def delete
+      if MultiTenant.multi_tenant_model_for_table(self.class.table_name).present? && persisted? && MultiTenant.current_tenant_id.nil?
+        MultiTenant.with(self.public_send(self.class.partition_key)) { delete_orig }
+      else
+        delete_orig
+      end
+    end
+  end
+end

data/lib/activerecord-multi-tenant/query_rewriter.rb

@@ -149,21 +149,27 @@ module MultiTenant
     end
   end
 
-  class TenantEnforcementClause < Arel::Nodes::Node
+  class BaseTenantEnforcementClause < Arel::Nodes::Node
     attr_reader :tenant_attribute
     def initialize(tenant_attribute)
       @tenant_attribute = tenant_attribute
+      @tenant_model = MultiTenant.multi_tenant_model_for_table(tenant_attribute.relation.table_name)
     end
 
     def to_s; to_sql; end
     def to_str; to_sql; end
 
     def to_sql(*)
-      tenant_arel.to_sql
+      collector = Arel::Collectors::SQLString.new
+      collector = @tenant_model.connection.visitor.accept tenant_arel, collector
+      collector.value
     end
 
-    private
 
+  end
+
+  class TenantEnforcementClause < BaseTenantEnforcementClause
+    private
     def tenant_arel
       if defined?(Arel::Nodes::Quoted)
         @tenant_attribute.eq(Arel::Nodes::Quoted.new(MultiTenant.current_tenant_id))
@@ -174,24 +180,15 @@ module MultiTenant
   end
 
 
-  class TenantJoinEnforcementClause < Arel::Nodes::Node
-    attr_reader :tenant_attribute
+  class TenantJoinEnforcementClause < BaseTenantEnforcementClause
     attr_reader :table_left
     def initialize(tenant_attribute, table_left)
+      super(tenant_attribute)
       @table_left = table_left
       @model_left = MultiTenant.multi_tenant_model_for_table(table_left.table_name)
-      @tenant_attribute = tenant_attribute
-    end
-
-    def to_s; to_sql; end
-    def to_str; to_sql; end
-
-    def to_sql(*)
-      tenant_arel.to_sql
     end
 
     private
-
     def tenant_arel
       @tenant_attribute.eq(@table_left[@model_left.partition_key])
     end
@@ -199,23 +196,12 @@ module MultiTenant
 
 
   module TenantValueVisitor
-    if ActiveRecord::VERSION::MAJOR > 4 || (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2)
-      def visit_MultiTenant_TenantEnforcementClause(o, collector)
-        collector << o
-      end
-
-      def visit_MultiTenant_TenantJoinEnforcementClause(o, collector)
-        collector << o
-      end
-
-    else
-      def visit_MultiTenant_TenantEnforcementClause(o, a = nil)
-        o
-      end
+    def visit_MultiTenant_TenantEnforcementClause(o, collector)
+      collector << o
+    end
 
-      def visit_MultiTenant_TenantJoinEnforcementClause(o, a = nil)
-        o
-      end
+    def visit_MultiTenant_TenantJoinEnforcementClause(o, collector)
+      collector << o
     end
   end
 
@@ -223,7 +209,7 @@ module MultiTenant
     def join_to_update(update, *args)
       update = super(update, *args)
       model = MultiTenant.multi_tenant_model_for_table(update.ast.relation.table_name)
-      if model.present? && !MultiTenant.with_write_only_mode_enabled?
+      if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
         update.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
       update
@@ -232,28 +218,26 @@ module MultiTenant
     def join_to_delete(delete, *args)
       delete = super(delete, *args)
       model = MultiTenant.multi_tenant_model_for_table(delete.ast.left.table_name)
-      if model.present? && !MultiTenant.with_write_only_mode_enabled?
+      if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
         delete.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
       delete
     end
 
-    if ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 2
-      def update(arel, name = nil, binds = [])
-        model = MultiTenant.multi_tenant_model_for_table(arel.ast.relation.table_name)
-        if model.present? && !MultiTenant.with_write_only_mode_enabled?
-          arel.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
-        end
-        super(arel, name, binds)
+    def update(arel, name = nil, binds = [])
+      model = MultiTenant.multi_tenant_model_for_arel(arel)
+      if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
+        arel.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
+      super(arel, name, binds)
+    end
 
-      def delete(arel, name = nil, binds = [])
-        model = MultiTenant.multi_tenant_model_for_table(arel.ast.left.table_name)
-        if model.present? && !MultiTenant.with_write_only_mode_enabled?
-          arel.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
-        end
-        super(arel, name, binds)
+    def delete(arel, name = nil, binds = [])
+      model = MultiTenant.multi_tenant_model_for_arel(arel)
+      if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
+        arel.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
+      super(arel, name, binds)
     end
   end
 end
@@ -296,7 +280,6 @@ module ActiveRecord
             end
 
             if node.is_a?(Arel::Nodes::SelectCore) || node.is_a?(Arel::Nodes::Join)
-
               if node.is_a?Arel::Nodes::Join
                 node_list = [node]
               else
@@ -304,14 +287,18 @@ module ActiveRecord
               end
 
               node_list.select{ |n| n.is_a? Arel::Nodes::Join }.each do |node_join|
-                if !node_join.right || !node_join.right.expr.right.is_a?(Arel::Attributes::Attribute)
+                if (!node_join.right ||
+                    (ActiveRecord::VERSION::MAJOR == 5 &&
+                     !node_join.right.expr.right.is_a?(Arel::Attributes::Attribute)))
                   next
                 end
 
-                relation_right = node_join.right.expr.right.relation
-                relation_left = node_join.right.expr.left.relation
-                model_left = MultiTenant.multi_tenant_model_for_table(relation_right.table_name)
+                relation_right, relation_left = relations_from_node_join(node_join)
+
+                next unless relation_right && relation_left
+
                 model_right = MultiTenant.multi_tenant_model_for_table(relation_left.table_name)
+                model_left = MultiTenant.multi_tenant_model_for_table(relation_right.table_name)
                 if model_right && model_left
                   join_enforcement_clause = MultiTenant::TenantJoinEnforcementClause.new(relation_left[model_left.partition_key], relation_right)
                   node_join.right.expr = node_join.right.expr.and(join_enforcement_clause)
@@ -324,69 +311,36 @@ module ActiveRecord
 
       arel
     end
-  end
-end
-
-require 'active_record/base'
-module MultiTenantFindBy
-  if ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2
-    # Disable caching for find and find_by in Rails 4.2 - we don't have a good
-    # way to prevent caching problems here when prepared statements are enabled
-    def find_by(*args)
-      return super unless respond_to?(:scoped_by_tenant?) && scoped_by_tenant?
-
-      # This duplicates a bunch of code from AR's find() method
-      return super if current_scope || !(Hash === args.first) || reflect_on_all_aggregations.any?
-      return super if default_scopes.any?
 
-      hash = args.first
+    private
+    def relations_from_node_join(node_join)
+      if ActiveRecord::VERSION::MAJOR == 5 || node_join.right.expr.is_a?(Arel::Nodes::Equality)
+        return node_join.right.expr.right.relation, node_join.right.expr.left.relation
+      end
 
-      return super if hash.values.any? { |v| v.nil? || Array === v || Hash === v }
-      return super unless hash.keys.all? { |k| columns_hash.has_key?(k.to_s) }
+      children = node_join.right.expr.children
 
-      key = hash.keys
+      tenant_applied = children.any?(MultiTenant::TenantEnforcementClause) || children.any?(MultiTenant::TenantJoinEnforcementClause)
+      if tenant_applied || children.empty?
+        return nil, nil
+      end
 
-      # Ensure we never use the cached version
-      find_by_statement_cache.synchronize { find_by_statement_cache[key] = nil }
+      if children[0].right.respond_to?('relation') && children[0].left.respond_to?('relation')
+        return children[0].right.relation, children[0].left.relation
+      end
 
-      super
+      return nil, nil
     end
+  end
+end
 
-    def find(*ids)
-      return super unless respond_to?(:scoped_by_tenant?) && scoped_by_tenant?
-
-      # This duplicates a bunch of code from AR's find() method
-      return super unless ids.length == 1
-      return super if ids.first.kind_of?(Symbol)
-      return super if block_given? ||
-                      primary_key.nil? ||
-                      default_scopes.any? ||
-                      current_scope ||
-                      columns_hash.include?(inheritance_column) ||
-                      ids.first.kind_of?(Array)
-
-      id = ids.first
-        if ActiveRecord::Base === id
-          id = id.id
-          ActiveSupport::Deprecation.warn(<<-MSG.squish)
-            You are passing an instance of ActiveRecord::Base to `find`.
-            Please pass the id of the object by calling `.id`
-          MSG
-        end
-      key = primary_key
-
-      # Ensure we never use the cached version
-      find_by_statement_cache.synchronize { find_by_statement_cache[key] = nil }
-
-      super
-    end
-  elsif ActiveRecord::VERSION::MAJOR > 4
-    def cached_find_by_statement(key, &block)
-      return super unless respond_to?(:scoped_by_tenant?) && scoped_by_tenant?
+require 'active_record/base'
+module MultiTenantFindBy
+  def cached_find_by_statement(key, &block)
+    return super unless respond_to?(:scoped_by_tenant?) && scoped_by_tenant?
 
-      key = Array.wrap(key) + [MultiTenant.current_tenant_id.to_s]
-      super(key, &block)
-    end
+    key = Array.wrap(key) + [MultiTenant.current_tenant_id.to_s]
+    super(key, &block)
   end
 end