activerecord-multi-tenant 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa2e595cc76e33a877613504121106791680118da0a0c4957ff1190e75e99c3a
-  data.tar.gz: 8a232e3431462d5b8b3972f0825664c210cc51729b2e94d08c5529851365d7f8
+  metadata.gz: 457cfac4996b93bb7b0b25cd99c2687f2742a8bc580888008baa4f903255cd74
+  data.tar.gz: 8c369e04a906752deda52d9b7b78a2377551e4b85f74e3b6d4b0742d30147783
 SHA512:
-  metadata.gz: a2df2315ca041de29d2e82786a33904a9ac1dedd3f1ee4a2e470822cff977e9f4548ab0d33bd6eefec8055b9fc74ff8db2fdcf4c93cba4992aaaa681dcd1a695
-  data.tar.gz: 9da5eec93a1bcd33bff29ab1e0035022592802f512d27139608e92988a17365d3fe4cff0a73fc0f83e9513cea9dd2bf6233bb4deac9533320fb0884f7ef8b219
+  metadata.gz: 7715dadcbd9cd13d86135518d3fc62283d9ab85e802016ab1be15fe39d815ec344c1d3e4699f96870b6e50b6d3b66b4a38f780d07ad6d3d4b8e21668deacca18
+  data.tar.gz: d1d364ebde87012cc5b91a6cf812a1a8cc0f89bb5ee8859b3de01ab0392dc5a62b74a3f93ac721d3e583343b703fc872d73c1f301cff9716e686492f06922d36

data/.github/workflows/CI.yml

@@ -19,10 +19,12 @@ jobs:
           - '3.0'
           - '3.1'
         gemfile:
+          - rails_5.2.3
           - rails_5.2
           - rails_6.0
           - rails_6.1
           - rails_7.0
+          - active_record_5.2.3
           - active_record_5.2
           - active_record_6.0
           - active_record_6.1
@@ -47,6 +49,14 @@ jobs:
             gemfile: 'rails_5.2'
           - ruby: '3.1'
             gemfile: 'active_record_5.2'
+          - ruby: '3.0'
+            gemfile: 'rails_5.2.3'
+          - ruby: '3.0'
+            gemfile: 'active_record_5.2.3'
+          - ruby: '3.1'
+            gemfile: 'rails_5.2.3'
+          - ruby: '3.1'
+            gemfile: 'active_record_5.2.3'
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }} ${{ (matrix.prepared_statements && 'w/ prepared statements') || '' }}
     env:
        BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 2.0.0      2022-05-19
+
+* Replace RequestStore with CurrentAttributes [#139](https://github.com/citusdata/activerecord-multi-tenant/pull/139)
+* Support changing table_name after calling multi_tenant [#128](https://github.com/citusdata/activerecord-multi-tenant/pull/128)
+* Allow to use uuid as primary key on partition table [#112](https://github.com/citusdata/activerecord-multi-tenant/pull/112)
+* Support latest Rails 5.2 [#145](https://github.com/citusdata/activerecord-multi-tenant/pull/145)
+* Support optional: true for belongs_to [#147](https://github.com/citusdata/activerecord-multi-tenant/pull/147)
+
+
 ## 1.2.0      2022-03-29
 
 * Test Rails 7 & Ruby 3

data/activerecord-multi-tenant.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/citusdata/activerecord-multi-tenant'
   s.license       = 'MIT'
 
-  s.add_runtime_dependency('request_store', '>= 1.0.5')
-  s.add_dependency('rails','>= 4.2')
+  s.add_dependency 'rails', '>= 5.2'
 
   s.add_development_dependency 'rspec', '>= 3.0'
   s.add_development_dependency 'rspec-rails'

data/gemfiles/active_record_5.2.3.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activerecord", "~> 5.2.0", "< 5.2.4" # FIXME
+gem "i18n", "~> 0.9.5"
+gem "nokogiri", "~> 1.7.1"
+gem "nio4r", "~> 2.3.1"
+gem "sprockets", "~> 3.7.1"
+gem "byebug", "~> 11.0"
+gem "rake", "12.0.0"
+gem "redis", "3.3.3"
+gem "pry-byebug", "3.9.0"
+
+gemspec path: "../"

data/gemfiles/active_record_5.2.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "activerecord", "~> 5.2.0", "< 5.2.4" # FIXME
+gem "activerecord", "~> 5.2.0"
 gem "i18n", "~> 0.9.5"
 gem "nokogiri", "~> 1.7.1"
 gem "nio4r", "~> 2.3.1"

data/gemfiles/rails_5.2.3.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 5.2.0", "< 5.2.4" # FIXME
+gem "i18n", "~> 0.9.5"
+gem "nokogiri", "~> 1.7.1"
+gem "nio4r", "~> 2.3.1"
+gem "sprockets", "~> 3.7.1"
+gem "byebug", "~> 11.0"
+gem "rake", "12.0.0"
+gem "redis", "3.3.3"
+gem "pry-byebug", "3.9.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 5.2.0", "< 5.2.4" # FIXME
+gem "rails", "~> 5.2.0"
 gem "i18n", "~> 0.9.5"
 gem "nokogiri", "~> 1.7.1"
 gem "nio4r", "~> 2.3.1"

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

@@ -6,7 +6,13 @@ module MultiTenant
       if to_s.underscore.to_sym == tenant_name
         unless MultiTenant.with_write_only_mode_enabled?
           # This is the tenant model itself. Workaround for https://github.com/citusdata/citus/issues/687
-          before_create -> { self.id ||= self.class.connection.select_value("SELECT nextval('" + [self.class.table_name, self.class.primary_key, 'seq'].join('_') + "'::regclass)") }
+          before_create -> do
+           if self.class.columns_hash[self.class.primary_key].type == :uuid
+             self.id ||= SecureRandom.uuid
+           else
+             self.id ||= self.class.connection.select_value("SELECT nextval('#{self.class.table_name}_#{self.class.primary_key}_seq'::regclass)")
+           end
+          end
         end
       else
         class << self
@@ -38,18 +44,18 @@ module MultiTenant
 
           def inherited(subclass)
             super
-            MultiTenant.register_multi_tenant_model(subclass.table_name, subclass) if subclass.table_name
+            MultiTenant.register_multi_tenant_model(subclass)
           end
         end
 
-        MultiTenant.register_multi_tenant_model(table_name, self) if table_name
+        MultiTenant.register_multi_tenant_model(self)
 
         @partition_key = options[:partition_key] || MultiTenant.partition_key(tenant_name)
         partition_key = @partition_key
 
         # 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, :optional).merge(foreign_key: options[:partition_key])
         end
 
         # New instances should have the tenant set

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

@@ -1,6 +1,10 @@
-require 'request_store'
+require 'active_support/current_attributes'
 
 module MultiTenant
+  class Current < ::ActiveSupport::CurrentAttributes
+    attribute :tenant
+  end
+
   def self.tenant_klass_defined?(tenant_name)
     !!tenant_name.to_s.classify.safe_constantize
   end
@@ -24,13 +28,23 @@ module MultiTenant
   def self.with_lock_workaround_enabled?; @@enable_with_lock_workaround; end
 
   # Registry that maps table names to models (used by the query rewriter)
-  def self.register_multi_tenant_model(table_name, model_klass)
-    @@multi_tenant_models ||= {}
-    @@multi_tenant_models[table_name.to_s] = model_klass
+  def self.register_multi_tenant_model(model_klass)
+    @@multi_tenant_models ||= []
+    @@multi_tenant_models.push(model_klass)
+
+    remove_class_variable(:@@multi_tenant_model_table_names) if defined?(@@multi_tenant_model_table_names)
   end
+
   def self.multi_tenant_model_for_table(table_name)
-    @@multi_tenant_models ||= {}
-    @@multi_tenant_models[table_name.to_s]
+    @@multi_tenant_models ||= []
+
+    if !defined?(@@multi_tenant_model_table_names)
+      @@multi_tenant_model_table_names = @@multi_tenant_models.map { |model|
+        [model.table_name, model] if model.table_name
+      }.compact.to_h
+    end
+
+    @@multi_tenant_model_table_names[table_name.to_s]
   end
 
   def self.multi_tenant_model_for_arel(arel)
@@ -43,11 +57,11 @@ module MultiTenant
   end
 
   def self.current_tenant=(tenant)
-    RequestStore.store[:current_tenant] = tenant
+    Current.tenant = tenant
   end
 
   def self.current_tenant
-    RequestStore.store[:current_tenant]
+    Current.tenant
   end
 
   def self.current_tenant_id

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

@@ -295,12 +295,9 @@ module ActiveRecord
               end
 
               node_list.select{ |n| n.is_a? Arel::Nodes::Join }.each do |node_join|
-                if (!node_join.right ||
-                    (ActiveRecord::VERSION::MAJOR == 5 &&
-                     !node_join.right.expr.right.is_a?(Arel::Attributes::Attribute)))
+                if !node_join.right
                   next
                 end
-
                 relation_right, relation_left = relations_from_node_join(node_join)
 
                 next unless relation_right && relation_left
@@ -322,13 +319,13 @@ module ActiveRecord
 
     private
     def relations_from_node_join(node_join)
-      if ActiveRecord::VERSION::MAJOR == 5 || node_join.right.expr.is_a?(Arel::Nodes::Equality)
+      if node_join.right.expr.is_a?(Arel::Nodes::Equality)
         return node_join.right.expr.right.relation, node_join.right.expr.left.relation
       end
 
-      children = node_join.right.expr.children
+      children = [node_join.right.expr.children].flatten
 
-      tenant_applied = children.any?(MultiTenant::TenantEnforcementClause) || children.any?(MultiTenant::TenantJoinEnforcementClause)
+      tenant_applied = children.any?{|c| c.is_a?(MultiTenant::TenantEnforcementClause) || c.is_a?(MultiTenant::TenantJoinEnforcementClause)}
       if tenant_applied || children.empty?
         return nil, nil
       end

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

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/spec/activerecord-multi-tenant/model_extensions_spec.rb

@@ -70,6 +70,47 @@ describe MultiTenant do
     it { expect(@partition_key_not_model_task.non_model_id).to be 77 }
   end
 
+  describe 'Changes table_name after multi_tenant called' do
+    before do
+      account_klass.has_many(:posts, anonymous_class: post_klass)
+      post_klass.belongs_to(:account, anonymous_class: account_klass)
+
+      @account1 = account_klass.create! name: 'foo'
+      @account2 = account_klass.create! name: 'bar'
+
+      @post1 = @account1.posts.create! name: 'foobar'
+      @post2 = @account2.posts.create! name: 'baz'
+
+      MultiTenant.current_tenant = @account1
+      @posts = post_klass.all
+    end
+
+    let(:account_klass) do
+      Class.new(Account) do
+        def self.name
+          'Account'
+        end
+      end
+    end
+
+    let(:post_klass) do
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'unknown'
+
+        multi_tenant(:account)
+
+        self.table_name = 'posts'
+
+        def self.name
+          'Post'
+        end
+      end
+    end
+
+    it { expect(@posts.length).to eq(1) }
+    it { expect(@posts).to eq([@post1]) }
+  end
+
   # Scoping models
   describe 'Project.all should be scoped to the current tenant if set' do
     before do
@@ -144,6 +185,16 @@ describe MultiTenant do
       end
     end
 
+    it 'handles belongs_to with optional: true' do
+      MultiTenant.with(account) do
+        sub_task
+      end
+
+      record = sub_task.optional_sub_tasks.create!
+      expect(record.reload.sub_task).to eq(sub_task)
+      expect(record.account_id).to eq(nil)
+    end
+
     it 'handles has_many through' do
       MultiTenant.with(account) do
         expect(project.sub_tasks).to eq [sub_task]

data/spec/schema.rb

@@ -34,6 +34,13 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
     t.column :type, :string
   end
 
+  create_table :optional_sub_tasks, force: true do |t|
+    t.references :account, :integer
+    t.column :sub_task_id, :integer
+    t.column :name, :string
+    t.column :type, :string
+  end
+
   create_table :countries, force: true do |t|
     t.column :name, :string
   end
@@ -106,6 +113,11 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
     t.column :domain_id, :integer
   end
 
+  create_table :posts, force: true, partition_key: :account_id do |t|
+    t.column :account_id, :integer
+    t.column :name, :string
+  end
+
   create_distributed_table :accounts, :id
   create_distributed_table :projects, :account_id
   create_distributed_table :managers, :account_id
@@ -121,6 +133,7 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
   create_distributed_table :allowed_places, :account_id
   create_distributed_table :domains, :account_id
   create_distributed_table :pages, :account_id
+  create_distributed_table :posts, :account_id
   create_reference_table :categories
 end
 
@@ -128,6 +141,7 @@ class Account < ActiveRecord::Base
   multi_tenant :account
   has_many :projects
   has_one :manager, inverse_of: :account
+  has_many :optional_sub_tasks
 end
 
 class Project < ActiveRecord::Base
@@ -159,6 +173,15 @@ class SubTask < ActiveRecord::Base
   multi_tenant :account
   belongs_to :task
   has_one :project, through: :task
+  has_many :optional_sub_tasks
+end
+
+with_belongs_to_required_by_default do
+  class OptionalSubTask < ActiveRecord::Base
+    multi_tenant :account, optional: true
+    belongs_to :account, optional: true
+    belongs_to :sub_task
+  end
 end
 
 class StiSubTask < SubTask
@@ -198,6 +221,7 @@ class Comment < ActiveRecord::Base
 end
 
 class Organization < ActiveRecord::Base
+  multi_tenant :organization
   has_many :uuid_records
 end
 

data/spec/spec_helper.rb

@@ -46,4 +46,11 @@ def uses_prepared_statements?
   ActiveRecord::Base.connection.prepared_statements
 end
 
+def with_belongs_to_required_by_default(&block)
+  default_value = ActiveRecord::Base.belongs_to_required_by_default
+  ActiveRecord::Base.belongs_to_required_by_default = true
+  yield
+ensure
+  ActiveRecord::Base.belongs_to_required_by_default = default_value
+end
 require 'schema'

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Citus Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: request_store
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -168,10 +154,12 @@ files:
 - activerecord-multi-tenant.gemspec
 - docker-compose.yml
 - gemfiles/.bundle/config
+- gemfiles/active_record_5.2.3.gemfile
 - gemfiles/active_record_5.2.gemfile
 - gemfiles/active_record_6.0.gemfile
 - gemfiles/active_record_6.1.gemfile
 - gemfiles/active_record_7.0.gemfile
+- gemfiles/rails_5.2.3.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile