activerecord-multi-tenant 1.0.0 → 1.1.0

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

@@ -18,7 +18,8 @@ module Sidekiq::Middleware::MultiTenant
   class Server
     def call(worker_class, msg, queue)
       if msg.has_key?('multi_tenant')
-        MultiTenant.with(msg['multi_tenant']['id']) do
+        tenant = msg['multi_tenant']['class'].constantize.find(msg['multi_tenant']['id'])
+        MultiTenant.with(tenant) do
           yield
         end
       else

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

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

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

@@ -21,11 +21,7 @@ describe "Controller Extensions", type: :controller do
   describe ApplicationController, type: :controller do
     controller do
       def index
-        if ActionPack::VERSION::MAJOR >= 5
-          render body: 'custom called'
-        else
-          render text: 'custom called'
-        end
+        render body: 'custom called'
       end
     end
 
@@ -35,30 +31,29 @@ describe "Controller Extensions", type: :controller do
     end
   end
 
-  if ActionPack::VERSION::MAJOR >= 5
-    class APIApplicationController < ActionController::API
-      include Rails.application.routes.url_helpers
-      set_current_tenant_through_filter
-      before_action :your_method_that_finds_the_current_tenant
 
-      def your_method_that_finds_the_current_tenant
-        current_account = Account.new
-        current_account.name = 'account1'
-        set_current_tenant(current_account)
-      end
+  class APIApplicationController < ActionController::API
+    include Rails.application.routes.url_helpers
+    set_current_tenant_through_filter
+    before_action :your_method_that_finds_the_current_tenant
+
+    def your_method_that_finds_the_current_tenant
+      current_account = Account.new
+      current_account.name = 'account1'
+      set_current_tenant(current_account)
     end
+  end
 
-    describe APIApplicationController, type: :controller do
-      controller do
-        def index
-          render body: 'custom called'
-        end
+  describe APIApplicationController, type: :controller do
+    controller do
+      def index
+        render body: 'custom called'
       end
+    end
 
-      it 'Finds the correct tenant using the filter command' do
-        get :index
-        expect(MultiTenant.current_tenant.name).to eq 'account1'
-      end
+    it 'Finds the correct tenant using the filter command' do
+      get :index
+      expect(MultiTenant.current_tenant.name).to eq 'account1'
     end
   end
 end

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

@@ -348,40 +348,24 @@ describe MultiTenant do
   end
 
   it "applies the team_id conditions in the where clause" do
-    expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
-                     <<-sql
-                     SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."account_id" = 1 AND "sub_tasks"."account_id" = 1 AND "tasks"."project_id" = $1
-                     sql
-                   elsif uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR == 0
-                     <<-sql
-                     SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."account_id" = 1 AND "tasks"."project_id" = 1
-                     sql
-                   else
-                     <<-sql
+    expected_sql = <<-sql
                      SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."account_id" = 1 AND "sub_tasks"."account_id" = 1 AND "tasks"."project_id" = 1
                      sql
-                   end
+
     account1 = Account.create! name: 'Account 1'
 
     MultiTenant.with(account1) do
       project1 = Project.create! name: 'Project 1'
       task1 = Task.create! name: 'Task 1', project: project1
       subtask1 = SubTask.create! task: task1
-
       expect(project1.sub_tasks.to_sql).to eq(expected_sql.strip)
       expect(project1.sub_tasks).to include(subtask1)
     end
 
     MultiTenant.without do
-      expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
-                       <<-sql
-                     SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."project_id" = $1
-                     sql
-                     else
-                       <<-sql
-                     SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."project_id" = 1
+      expected_sql = <<-sql
+                        SELECT "sub_tasks".* FROM "sub_tasks" INNER JOIN "tasks" ON "sub_tasks"."task_id" = "tasks"."id" AND "sub_tasks"."account_id" = "tasks"."account_id" WHERE "tasks"."project_id" = 1
                      sql
-                     end
 
       project = Project.first
       expect(project.sub_tasks.to_sql).to eq(expected_sql.strip)
@@ -389,43 +373,33 @@ describe MultiTenant do
   end
 
   it "tests joins between distributed and reference table" do
-    expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
-                     <<-sql
-                     SELECT "categories".* FROM "categories" INNER JOIN "project_categories" ON "categories"."id" = "project_categories"."category_id" WHERE "project_categories"."account_id" = 1 AND "project_categories"."project_id" = $1
-                     sql
-                   else
-                     <<-sql
+    expected_sql = <<-sql
                      SELECT "categories".* FROM "categories" INNER JOIN "project_categories" ON "categories"."id" = "project_categories"."category_id" WHERE "project_categories"."account_id" = 1 AND "project_categories"."project_id" = 1
-                     sql
-                   end
+                   sql
     account1 = Account.create! name: 'Account 1'
     category1 = Category.create! name: 'Category 1'
 
     MultiTenant.with(account1) do
       project1 = Project.create! name: 'Project 1'
       projectcategory = ProjectCategory.create! name: 'project cat 1', project: project1, category: category1
+
       expect(project1.categories.to_sql).to eq(expected_sql.strip)
       expect(project1.categories).to include(category1)
       expect(project1.project_categories).to include(projectcategory)
     end
 
     MultiTenant.without do
-      expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
-                       <<-sql
-                     SELECT "categories".* FROM "categories" INNER JOIN "project_categories" ON "categories"."id" = "project_categories"."category_id" WHERE "project_categories"."project_id" = $1
-                     sql
-                     else
-                       <<-sql
+      expected_sql = <<-sql
                      SELECT "categories".* FROM "categories" INNER JOIN "project_categories" ON "categories"."id" = "project_categories"."category_id" WHERE "project_categories"."project_id" = 1
                      sql
-                     end
+
       project = Project.first
       expect(project.categories.to_sql).to eq(expected_sql.strip)
       expect(project.categories).to include(category1)
 
       expected_sql = <<-sql
                         SELECT "projects".* FROM "projects" INNER JOIN "project_categories" ON "project_categories"."project_id" = "projects"."id" AND "project_categories"."account_id" = "projects"."account_id" INNER JOIN "categories" ON "categories"."id" = "project_categories"."category_id" WHERE "projects"."account_id" = 1
-                     sql
+                    sql
 
       expect(Project.where(account_id: 1).joins(:categories).to_sql).to eq(expected_sql.strip)
       project = Project.where(account_id: 1).joins(:categories).first
@@ -438,17 +412,13 @@ describe MultiTenant do
     account1 = Account.create! name: 'Account 1'
     category1 = Category.create! name: 'Category 1'
 
-    expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR > 1
+    expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 5
                      <<-sql
                      SELECT "projects"."id" AS t0_r0, "projects"."account_id" AS t0_r1, "projects"."name" AS t0_r2, "categories"."id" AS t1_r0, "categories"."name" AS t1_r1 FROM "projects" LEFT OUTER JOIN "project_categories" ON "project_categories"."project_id" = "projects"."id" AND "project_categories"."account_id" = 1 AND "projects"."account_id" = 1 LEFT OUTER JOIN "categories" ON "categories"."id" = "project_categories"."category_id" AND "project_categories"."account_id" = 1 WHERE "projects"."account_id" = 1
                      sql
-                   elsif uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 0
-                     <<-sql
-                     SELECT "projects".* FROM "projects"  WHERE "projects"."account_id" = 1
-                     sql
                    else
                      <<-sql
-                     SELECT "projects"."id" AS t0_r0, "projects"."account_id" AS t0_r1, "projects"."name" AS t0_r2, "categories"."id" AS t1_r0, "categories"."name" AS t1_r1 FROM "projects" LEFT OUTER JOIN "project_categories" ON "project_categories"."project_id" = "projects"."id" AND "project_categories"."account_id" = "projects"."account_id" AND "project_categories"."account_id" = 1 AND "projects"."account_id" = 1 LEFT OUTER JOIN "categories" ON "categories"."id" = "project_categories"."category_id" AND "project_categories"."account_id" = 1 WHERE "projects"."account_id" = 1
+                     SELECT "projects"."id" AS t0_r0, "projects"."account_id" AS t0_r1, "projects"."name" AS t0_r2, "categories"."id" AS t1_r0, "categories"."name" AS t1_r1 FROM "projects" LEFT OUTER JOIN "project_categories" ON "project_categories"."account_id" = 1 AND "project_categories"."project_id" = "projects"."id" AND "projects"."account_id" = 1 LEFT OUTER JOIN "categories" ON "categories"."id" = "project_categories"."category_id" AND "project_categories"."account_id" = 1 WHERE "projects"."account_id" = 1
                      sql
                    end
 
@@ -464,15 +434,9 @@ describe MultiTenant do
     end
 
     MultiTenant.without do
-      expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 0
-                       <<-sql
-                       SELECT "projects".* FROM "projects"  WHERE "projects"."account_id" = 1
-                       sql
-                     else
-                       <<-sql
+      expected_sql = <<-sql
                      SELECT "projects"."id" AS t0_r0, "projects"."account_id" AS t0_r1, "projects"."name" AS t0_r2, "categories"."id" AS t1_r0, "categories"."name" AS t1_r1 FROM "projects" LEFT OUTER JOIN "project_categories" ON "project_categories"."project_id" = "projects"."id" AND "project_categories"."account_id" = "projects"."account_id" LEFT OUTER JOIN "categories" ON "categories"."id" = "project_categories"."category_id" WHERE "projects"."account_id" = 1
-                       sql
-                     end
+                     sql
 
       expect(Project.where(account_id: 1).eager_load(:categories).to_sql).to eq(expected_sql.strip)
 
@@ -487,13 +451,13 @@ describe MultiTenant do
     category1 = Category.create! name: 'Category 1'
 
     MultiTenant.with(account1) do
-      expected_sql =  if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR > 1
+      expected_sql =  if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 5
                         <<-sql
                         SELECT "tasks".* FROM "tasks" INNER JOIN "projects" ON "projects"."id" = "tasks"."project_id" AND "projects"."account_id" = 1 LEFT JOIN project_categories pc ON project.category_id = pc.id WHERE "tasks"."account_id" = 1
                         sql
                       else
                         <<-sql
-                        SELECT "tasks".* FROM "tasks" INNER JOIN "projects" ON "projects"."id" = "tasks"."project_id" AND "projects"."account_id" = "tasks"."account_id" LEFT JOIN project_categories pc ON project.category_id = pc.id WHERE "projects"."account_id" = 1 AND "tasks"."account_id" = 1
+                        SELECT "tasks".* FROM "tasks" INNER JOIN "projects" ON "projects"."account_id" = 1 AND "projects"."id" = "tasks"."project_id" LEFT JOIN project_categories pc ON project.category_id = pc.id WHERE "tasks"."account_id" = 1
                         sql
                       end
 
@@ -501,7 +465,6 @@ describe MultiTenant do
       projectcategory = ProjectCategory.create! name: 'project cat 1', project: project1, category: category1
 
       project1.tasks.create! name: 'baz'
-
       expect(Task.joins(:project).joins('LEFT JOIN project_categories pc ON project.category_id = pc.id').to_sql).to eq(expected_sql.strip)
     end
 
@@ -509,73 +472,60 @@ describe MultiTenant do
       expected_sql = <<-sql
                      SELECT "tasks".* FROM "tasks" INNER JOIN "projects" ON "projects"."id" = "tasks"."project_id" AND "projects"."account_id" = "tasks"."account_id" LEFT JOIN project_categories pc ON project.category_id = pc.id WHERE "tasks"."account_id" = 1
                      sql
+
       expect(Task.where(account_id: 1).joins(:project).joins('LEFT JOIN project_categories pc ON project.category_id = pc.id').to_sql).to eq(expected_sql.strip)
 
     end
 
   end
 
+  it "only applies clauses when a tenant is set" do
+    account = Account.create! name: 'Account 1'
+    project = Project.create! name: 'Project 1', account: account
+    project2 = Project.create! name: 'Project 2', account: Account.create!(name: 'Account2')
 
-
-  # Versions earlier than 4.2 pass an arel object to find_by_sql(...) and it would make
-  # this test unnecesssarily complicated to support that
-  if ActiveRecord::VERSION::MAJOR > 4 || (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2)
-    it "only applies clauses when a tenant is set" do
-      account = Account.create! name: 'Account 1'
-      project = Project.create! name: 'Project 1', account: account
-      project2 = Project.create! name: 'Project 2', account: Account.create!(name: 'Account2')
-
-      MultiTenant.with(account) do
-        expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR > 4
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."account_id" = #{account.id} AND "projects"."id" = $1 LIMIT $2
+    MultiTenant.with(account) do
+      expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR > 5
+                       <<-sql.strip
+                                SELECT "projects".* FROM "projects" WHERE "projects"."account_id" = #{account.id} AND "projects"."id" = $1 LIMIT $2
                          sql
-                       elsif uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."account_id" = #{account.id} AND "projects"."id" = $1 LIMIT 1
-                         sql
-                       else
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."account_id" = #{account.id} AND "projects"."id" = #{project.id} LIMIT 1
+                     else
+                       <<-sql.strip
+                         SELECT  "projects".* FROM "projects" WHERE "projects"."account_id" = #{account.id} AND "projects"."id" = $1 LIMIT $2
                          sql
-                       end
-        expect(Project).to receive(:find_by_sql).with(expected_sql, any_args).and_call_original
-        expect(Project.find(project.id)).to eq(project)
-      end
+                     end
 
-      MultiTenant.without do
-        expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR > 4
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."id" = $1 LIMIT $2
-                         sql
-                       elsif uses_prepared_statements? && ActiveRecord::VERSION::MAJOR == 4
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."id" = $1 LIMIT 1
+      expect(Project).to receive(:find_by_sql).with(expected_sql, any_args).and_call_original
+      expect(Project.find(project.id)).to eq(project)
+    end
+
+    MultiTenant.without do
+      expected_sql = if uses_prepared_statements? && ActiveRecord::VERSION::MAJOR > 5
+                       <<-sql.strip
+                         SELECT "projects".* FROM "projects" WHERE "projects"."id" = $1 LIMIT $2
                          sql
-                       else
-                         <<-sql.strip
-                         SELECT  "projects".* FROM "projects" WHERE "projects"."id" = #{project2.id} LIMIT 1
+                     else
+                       <<-sql.strip
+                         SELECT  "projects".* FROM "projects" WHERE "projects"."id" = $1 LIMIT $2
                          sql
-                       end
-        expect(Project).to receive(:find_by_sql).with(expected_sql, any_args).and_call_original
-        expect(Project.find(project2.id)).to eq(project2)
-      end
+                     end
+
+      expect(Project).to receive(:find_by_sql).with(expected_sql, any_args).and_call_original
+      expect(Project.find(project2.id)).to eq(project2)
     end
   end
 
-  # Versions earlier than 4.1 have a different behaviour regarding unsaved associations
-  if ActiveRecord::VERSION::MAJOR > 4 || (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 1)
-    describe 'with unsaved association' do
-      before do
-        @account = Account.create!(name: 'reflection tenant')
-        @manager = Manager.new(account: @account)
-        MultiTenant.current_tenant = @account
-        @account.update! name: 'reflection tenant update'
-      end
 
-      it 'persists the reflected association' do
-        expect(@manager.persisted?).to eq(true)
-      end
+  describe 'with unsaved association' do
+    before do
+      @account = Account.create!(name: 'reflection tenant')
+      @manager = Manager.new(account: @account)
+      MultiTenant.current_tenant = @account
+      @account.update! name: 'reflection tenant update'
+    end
+
+    it 'persists the reflected association' do
+      expect(@manager.persisted?).to eq(true)
     end
   end
 

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

@@ -15,6 +15,12 @@ describe "Query Rewriter" do
       }.to change { project.reload.name }.from("Project 1").to("New Name")
     end
 
+    it "updates the records without a current tenant" do
+      expect {
+        Project.joins(:manager).update_all(name: "New Name")
+      }.to change { project.reload.name }.from("Project 1").to("New Name")
+    end
+
     it "update the record" do
       expect {
         MultiTenant.with(account) do
@@ -22,6 +28,12 @@ describe "Query Rewriter" do
         end
       }.to change { project.reload.name }.from("Project 1").to("New Name")
     end
+
+    it "update the record without a current tenant" do
+      expect {
+        project.update(name: "New Name")
+      }.to change { project.reload.name }.from("Project 1").to("New Name")
+    end
   end
 
   context "when bulk deleting" do
@@ -40,6 +52,12 @@ describe "Query Rewriter" do
       }.to change { Project.count }.from(3).to(1)
     end
 
+    it "delete_all the records without a current tenant" do
+      expect {
+        Project.joins(:manager).delete_all
+      }.to change { Project.count }.from(3).to(1)
+    end
+
     it "delete the record" do
       expect {
         MultiTenant.with(account) do
@@ -49,6 +67,13 @@ describe "Query Rewriter" do
       }.to change { Project.count }.from(3).to(1)
     end
 
+    it "delete the record without a current tenant" do
+      expect {
+        project1.delete
+        Project.delete(project2.id)
+      }.to change { Project.count }.from(3).to(1)
+    end
+
     it "destroy the record" do
       expect {
         MultiTenant.with(account) do
@@ -57,5 +82,20 @@ describe "Query Rewriter" do
         end
       }.to change { Project.count }.from(3).to(1)
     end
+
+    it "destroy the record without a current tenant" do
+      expect {
+        project1.destroy
+        Project.destroy(project2.id)
+      }.to change { Project.count }.from(3).to(1)
+    end
+  end
+
+  context "when update without arel" do
+    it "can call method" do
+      expect {
+        ActiveRecord::Base.connection.update("SELECT 1")
+      }.not_to raise_error
+    end
   end
 end

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

@@ -2,13 +2,70 @@ require 'spec_helper'
 
 describe MultiTenant, 'Record modifications' do
   let(:account) { Account.create! name: 'test' }
-  let(:project) { account.projects.create! name: 'something' }
+  let(:account2) { Account.create! name: 'test2' }
+  let(:project) { Project.create! name: 'something', account: account }
+  let(:project2) { Project.create! name: 'something2', account: account2, id: project.id }
+
+
+  it 'includes the tenant_id in DELETEs when using object.destroy' do
+    # two records with same id but different account_id
+    # when doing project.destroy it should delete only the current one
+    # by adding account_id to the destroy
+
+    expect(project.account).to eq(account)
+    expect(project2.account).to eq(account2)
+    expect(project.id).to eq(project2.id)
+
+    MultiTenant.without() do
+      expect(Project.count).to eq(2)
+      project.destroy
+      expect(Project.count).to eq(1)
+    end
 
-  it 'includes the tenant_id in DELETEs' do
-    project.destroy
     MultiTenant.with(account) do
       expect(Project.where(id: project.id).first).not_to be_present
     end
+    MultiTenant.with(account2) do
+      expect(Project.where(id: project2.id).first).to be_present
+    end
+
+  end
+
+  it 'includes the tenant_id in DELETEs when using object.delete' do
+    # two records with same id but different account_id
+    # when project.delete it should delete only the current one
+    # by adding account_id to the destroy
+
+    expect(project.account).to eq(account)
+    expect(project2.account).to eq(account2)
+    expect(project.id).to eq(project2.id)
+
+    MultiTenant.without() do
+      expect(Project.count).to eq(2)
+      project.delete
+      expect(Project.count).to eq(1)
+    end
+
+    MultiTenant.with(account) do
+      expect(Project.where(id: project.id).first).not_to be_present
+    end
+    MultiTenant.with(account2) do
+      expect(Project.where(id: project2.id).first).to be_present
+    end
+  end
+
+  it 'test delete for reference tables' do
+    category1 = Category.create! name: 'Category 1'
+    expect(Category.count).to eq(1)
+    category1.delete
+    expect(Category.count).to eq(0)
+  end
+
+  it 'test delete for non distributed tables' do
+    unscoped = UnscopedModel.create! name: 'Canada'
+    expect(UnscopedModel.count).to eq(1)
+    unscoped.delete
+    expect(UnscopedModel.count).to eq(0)
   end
 
   it 'includes the tenant_id in UPDATEs' do