activerecord-multi-tenant 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ed816e4227187f3f64ae1e1b53471c74f220150
-  data.tar.gz: acd8708805299354b2516a61fe3365f557ac09d4
+  metadata.gz: fc1deedd61a8e692c880e666ccd16542079b3b5a
+  data.tar.gz: e71ddea3d21d23c511e0d85d947b974f5ff40591
 SHA512:
-  metadata.gz: 74c9aa0bba774511e236db9e08f830ebc09703b8f58d3d6f39c97454032ac607a0f5b7050ec24a78a6b3322cc7df9b11f658ef61f8ddbbaf0726c8b73c5b32d0
-  data.tar.gz: b5f1427977dac05e87491fa72e604a6454067d9d8b3742ee5b63f367de0dc6411bf17386e868a5761a3bce1c9df5166ac00eecc0d1e522e52a64397b91cbb73b
+  metadata.gz: c7354a9d0c30caa2264d35739edf4f181945bf035326c13354824fee2eb3d2717804236b412d5f5fa9352a498a62aba7c846b12fcd4b0566e907b0bbca3276a5
+  data.tar.gz: 6d9aaf1c06cc24daf27423eec9fe1c032070f109c06d69c0c915c68ab549da89e37057388a65aed42e400a13abbc206285fa744216fbbed25ee35f2f2a106a05

data/.travis.yml

@@ -14,7 +14,8 @@ gemfile:
   - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
-  - gemfiles/active_record_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/active_record_5.1.gemfile
 
 matrix:
   fast_finish: true
@@ -22,7 +23,9 @@ matrix:
     - rvm: 2.1
       gemfile: gemfiles/rails_5.0.gemfile
     - rvm: 2.1
-      gemfile: gemfiles/active_record_5.0.gemfile
+      gemfile: gemfiles/rails_5.1.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/active_record_5.1.gemfile
     - rvm: 2.4.0
       gemfile: gemfiles/rails_3.2.gemfile
     - rvm: 2.4.0

data/Appraisals

@@ -19,6 +19,10 @@ appraise 'rails-5.0' do
   gem 'rails', '5.0.1'
 end
 
-appraise 'active-record-5.0' do
-  gem 'activerecord', '5.0.2'
+appraise 'rails-5.1' do
+  gem 'rails', '5.1.0'
+end
+
+appraise 'active-record-5.1' do
+  gem 'activerecord', '5.1.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.5.0       2017-05-08
+
+* Write-only mode that enables step-by-step migrations
+* Add tenant_id to queries using rewrite instead of default_scope/unscoped [Ben Olive](https://github.com/sionide21)
+* Query monitor that warns you about missing tenant_id
+* Helper for fast truncation
+* Sidekiq middleware
+
+
 ## 0.4.1       2017-03-23
 
 * Allow use outside of Rails, e.g. when using Sinatra with ActiveRecord [@nathanstitt](https://github.com/nathanstitt) [#5](https://github.com/citusdata/activerecord-multi-tenant/pull/5)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -55,12 +55,12 @@ GEM
     database_cleaner (1.3.0)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
     i18n (0.7.0)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
+    mail (2.6.5)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)

data/README.md

@@ -1,6 +1,10 @@
 # activerecord-multi-tenant [ ![](https://img.shields.io/gem/v/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant) [ ![](https://img.shields.io/gem/dt/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant)
 
-ActiveRecord/Rails integration for multi-tenant databases, in particular the Citus extension for PostgreSQL.
+Introduction Post: https://www.citusdata.com/blog/2017/01/05/easily-scale-out-multi-tenant-apps/
+
+ActiveRecord/Rails integration for multi-tenant databases, in particular the open-source [Citus](https://github.com/citusdata/citus) extension for PostgreSQL.
+
+Enables easy scale-out by adding the tenant context to your queries, enabling the database (e.g. Citus) to efficiently route queries to the right database node.
 
 ## Installation
 
@@ -65,6 +69,21 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Rolling out activerecord-multi-tenant for your application (write-only mode)
+
+The library relies on tenant_id to be present and NOT NULL for all rows. However,
+its often useful to have the library set the tenant_id for new records, and then backfilling
+tenant_id for existing records as a background task.
+
+To support this, there is a write-only mode, in which tenant_id is not included in queries,
+but only set for new records. Include the following in an initializer to enable it:
+
+```ruby
+MultiTenant.enable_write_only_mode
+```
+
+Once you are ready to enforce tenancy, make your tenant_id column NOT NULL and simply remove that line.
+
 ## Frequently Asked Questions
 
 * **What if I have a table that doesn't relate to my tenant?** (e.g. templates that are the same in every account)

data/gemfiles/{active_record_5.0.gemfile → active_record_5.1.gemfile}

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "activerecord", "5.0.2"
+gem "activerecord", "5.1.0"
 
 gemspec :path => "../"

data/gemfiles/{active_record_5.0.gemfile.lock → active_record_5.1.gemfile.lock}

@@ -1,66 +1,66 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.2)
-      actionpack (= 5.0.2)
-      nio4r (>= 1.2, < 3.0)
+    actioncable (5.1.0)
+      actionpack (= 5.1.0)
+      nio4r (~> 2.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.2)
-      actionpack (= 5.0.2)
-      actionview (= 5.0.2)
-      activejob (= 5.0.2)
+    actionmailer (5.1.0)
+      actionpack (= 5.1.0)
+      actionview (= 5.1.0)
+      activejob (= 5.1.0)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.2)
-      actionview (= 5.0.2)
-      activesupport (= 5.0.2)
+    actionpack (5.1.0)
+      actionview (= 5.1.0)
+      activesupport (= 5.1.0)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.2)
-      activesupport (= 5.0.2)
+    actionview (5.1.0)
+      activesupport (= 5.1.0)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
+      erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.0.2)
-      activesupport (= 5.0.2)
+    activejob (5.1.0)
+      activesupport (= 5.1.0)
       globalid (>= 0.3.6)
-    activemodel (5.0.2)
-      activesupport (= 5.0.2)
-    activerecord (5.0.2)
-      activemodel (= 5.0.2)
-      activesupport (= 5.0.2)
-      arel (~> 7.0)
-    activesupport (5.0.2)
+    activemodel (5.1.0)
+      activesupport (= 5.1.0)
+    activerecord (5.1.0)
+      activemodel (= 5.1.0)
+      activesupport (= 5.1.0)
+      arel (~> 8.0)
+    activesupport (5.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    appraisal (2.1.0)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
-    arel (7.1.4)
+    arel (8.0.0)
     builder (3.2.3)
     concurrent-ruby (1.0.5)
     database_cleaner (1.3.0)
     diff-lcs (1.3)
-    erubis (2.7.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
+    erubi (1.6.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
     i18n (0.8.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
+    mail (2.6.5)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)
@@ -75,52 +75,52 @@ GEM
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.2)
-      actioncable (= 5.0.2)
-      actionmailer (= 5.0.2)
-      actionpack (= 5.0.2)
-      actionview (= 5.0.2)
-      activejob (= 5.0.2)
-      activemodel (= 5.0.2)
-      activerecord (= 5.0.2)
-      activesupport (= 5.0.2)
+    rails (5.1.0)
+      actioncable (= 5.1.0)
+      actionmailer (= 5.1.0)
+      actionpack (= 5.1.0)
+      actionview (= 5.1.0)
+      activejob (= 5.1.0)
+      activemodel (= 5.1.0)
+      activerecord (= 5.1.0)
+      activesupport (= 5.1.0)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.2)
+      railties (= 5.1.0)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
       nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.2)
-      actionpack (= 5.0.2)
-      activesupport (= 5.0.2)
+    railties (5.1.0)
+      actionpack (= 5.1.0)
+      activesupport (= 5.1.0)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (12.0.0)
     request_store (1.3.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-rails (3.5.2)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -130,7 +130,7 @@ GEM
       sprockets (>= 3.0.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
@@ -140,7 +140,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 5.0.2)
+  activerecord (= 5.1.0)
   activerecord-multi-tenant!
   appraisal
   database_cleaner (~> 1.3.0)
@@ -151,4 +151,4 @@ DEPENDENCIES
   thor
 
 BUNDLED WITH
-   1.14.5
+   1.12.5

data/gemfiles/rails_3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/gemfiles/rails_4.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/gemfiles/rails_4.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.4.1)
+    activerecord-multi-tenant (0.5.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "5.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.1.gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: ../
+  specs:
+    activerecord-multi-tenant (0.5.0)
+      rails (>= 3.1)
+      request_store (>= 1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.0)
+      actionpack (= 5.1.0)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.0)
+      actionpack (= 5.1.0)
+      actionview (= 5.1.0)
+      activejob (= 5.1.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.0)
+      actionview (= 5.1.0)
+      activesupport (= 5.1.0)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.0)
+      activesupport (= 5.1.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.0)
+      activesupport (= 5.1.0)
+      globalid (>= 0.3.6)
+    activemodel (5.1.0)
+      activesupport (= 5.1.0)
+    activerecord (5.1.0)
+      activemodel (= 5.1.0)
+      activesupport (= 5.1.0)
+      arel (~> 8.0)
+    activesupport (5.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.3.0)
+    diff-lcs (1.3)
+    erubi (1.6.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.5)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    pg (0.20.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.0)
+      actioncable (= 5.1.0)
+      actionmailer (= 5.1.0)
+      actionpack (= 5.1.0)
+      actionview (= 5.1.0)
+      activejob (= 5.1.0)
+      activemodel (= 5.1.0)
+      activerecord (= 5.1.0)
+      activesupport (= 5.1.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.1.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.0)
+      actionpack (= 5.1.0)
+      activesupport (= 5.1.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    request_store (1.3.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-multi-tenant!
+  appraisal
+  database_cleaner (~> 1.3.0)
+  pg
+  rails (= 5.1.0)
+  rake
+  rspec (>= 3.0)
+  rspec-rails
+  thor
+
+BUNDLED WITH
+   1.12.5

data/lib/activerecord-multi-tenant.rb

@@ -2,10 +2,12 @@ if Object.const_defined?(:ActionController)
   require_relative 'activerecord-multi-tenant/controller_extensions'
 end
 require_relative 'activerecord-multi-tenant/copy_from_client'
-require_relative 'activerecord-multi-tenant/default_scope'
+require_relative 'activerecord-multi-tenant/fast_truncate'
 require_relative 'activerecord-multi-tenant/migrations'
 require_relative 'activerecord-multi-tenant/model_extensions'
 require_relative 'activerecord-multi-tenant/multi_tenant'
+require_relative 'activerecord-multi-tenant/query_rewriter'
+require_relative 'activerecord-multi-tenant/query_monitor'
 require_relative 'activerecord-multi-tenant/referential_integrity'
 require_relative 'activerecord-multi-tenant/version'
 require_relative 'activerecord-multi-tenant/with_lock'

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

@@ -0,0 +1,32 @@
+# Truncates only the tables that have been modified, according to sequence
+# values
+module MultiTenant
+  module FastTruncate
+    def self.run(exclude: ['schema_migrations'])
+      # This is a slightly faster version of DatabaseCleaner.clean_with(:truncation, pre_count: true)
+      ActiveRecord::Base.connection.execute format(%(
+      DO LANGUAGE plpgsql $$
+      DECLARE
+        t record;
+        tables text[];
+        seq_exists boolean;
+        needs_truncate boolean;
+      BEGIN
+        FOR t IN SELECT schemaname, tablename FROM pg_tables WHERE schemaname = 'public' AND tablename NOT IN (%s) LOOP
+          EXECUTE 'SELECT EXISTS (SELECT * from pg_class c WHERE c.relkind = ''S'' AND c.relname=''' || t.tablename || '_id_seq'')' into seq_exists;
+          IF seq_exists THEN
+            EXECUTE 'SELECT last_value != start_value FROM ' || t.tablename || '_id_seq' INTO needs_truncate;
+          ELSE
+            needs_truncate := true;
+          END IF;
+
+          IF needs_truncate THEN
+            tables := array_append(tables, quote_ident(t.schemaname) || '.' || quote_ident(t.tablename));
+          END IF;
+        END LOOP;
+
+        EXECUTE 'TRUNCATE TABLE ' || array_to_string(tables, ', ') || ' RESTART IDENTITY CASCADE';
+      END$$;), exclude.map { |t| "'" + t + "'" }.join('\n'))
+    end
+  end
+end

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

@@ -4,8 +4,10 @@ module MultiTenant
 
     def multi_tenant(tenant_name, options = {})
       if to_s.underscore.to_sym == tenant_name
-        # 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)") }
+        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)") }
+        end
       else
         class << self
           def scoped_by_tenant?
@@ -21,9 +23,9 @@ module MultiTenant
           # Avoid primary_key errors when using composite primary keys (e.g. id, tenant_id)
           def primary_key
             return @primary_key if @primary_key
-            return @primary_key = super || DEFAULT_ID_FIELD if Rails::VERSION::MAJOR < 5
+            return @primary_key = super || DEFAULT_ID_FIELD if ActiveRecord::VERSION::MAJOR < 5
 
-            primary_object_keys = (connection.schema_cache.primary_keys(table_name) || []) - [partition_key]
+            primary_object_keys = Array.wrap(connection.schema_cache.primary_keys(table_name)) - [partition_key]
             if primary_object_keys.size == 1
               @primary_key = primary_object_keys.first
             else
@@ -40,21 +42,12 @@ module MultiTenant
           belongs_to tenant_name, options.slice(:class_name, :inverse_of).merge(foreign_key: partition_key)
         end
 
-        # Ensure all queries include the partition key
-        default_scope lambda {
-          if MultiTenant.current_tenant_id
-            where(arel_table[partition_key].eq(MultiTenant.current_tenant_id))
-          else
-            ActiveRecord::VERSION::MAJOR < 4 ? scoped : all
-          end
-        }
-
         # New instances should have the tenant set
-        before_validation Proc.new { |record|
+        after_initialize Proc.new { |record|
           if MultiTenant.current_tenant_id && record.public_send(partition_key.to_sym).nil?
             record.public_send("#{partition_key}=".to_sym, MultiTenant.current_tenant_id)
           end
-        }, on: :create
+        }
 
         to_include = Module.new do
           define_method "#{partition_key}=" do |tenant_id|

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

@@ -9,6 +9,15 @@ module MultiTenant
     "#{tenant_name.to_s}_id"
   end
 
+  # In some cases we only have an ID - if defined we'll return the default tenant class in such cases
+  def self.default_tenant_class=(tenant_class); @@default_tenant_class = tenant_class; end
+  def self.default_tenant_class; @@default_tenant_class; end
+
+  # Write-only Mode - this only adds the tenant_id to new records, but doesn't
+  # require its presence for SELECTs/UPDATEs/DELETEs
+  def self.enable_write_only_mode; @@enable_write_only_mode = true; end
+  def self.with_write_only_mode_enabled?; @@enable_write_only_mode ||= false; end
+
   # Workaroud to make "with_lock" work until https://github.com/citusdata/citus/issues/1236 is fixed
   @@enable_with_lock_workaround = false
   def self.enable_with_lock_workaround; @@enable_with_lock_workaround = true; end
@@ -30,6 +39,14 @@ module MultiTenant
     current_tenant.is_a?(String) || current_tenant.is_a?(Integer)
   end
 
+  def self.current_tenant_class
+    if current_tenant_is_id?
+      MultiTenant.default_tenant_class || fail('Only have tenant id, and no default tenant class set')
+    elsif current_tenant
+      MultiTenant.current_tenant.class.name
+    end
+  end
+
   def self.with(tenant, &block)
     return block.call if self.current_tenant == tenant
     old_tenant = self.current_tenant

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

@@ -0,0 +1,18 @@
+# Add generic warning when queries fail and there is no tenant set
+module MultiTenant
+  # Option to enable query monitor
+  @@enable_query_monitor = false
+  def self.enable_query_monitor; @@enable_query_monitor = true; end
+  def self.query_monitor_enabled?; @@enable_query_monitor; end
+
+  class QueryMonitor
+    def start(name, id, payload); end
+    def finish(name, id, payload)
+      return unless MultiTenant.query_monitor_enabled?
+      return unless payload[:exception].present? && MultiTenant.current_tenant_id.nil?
+      Rails.logger.info 'WARNING: Tenant not present - make sure to add MultiTenant.with(tenant) { ... }'
+    end
+  end
+end
+
+ActiveSupport::Notifications.subscribe('sql.active_record', MultiTenant::QueryMonitor.new) if ActiveRecord::VERSION::MAJOR >= 4

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

@@ -0,0 +1,47 @@
+require 'active_record'
+
+class TTTenantVisitor < Arel::Visitors::DepthFirst
+  def initialize(arel)
+    super(Proc.new {})
+    @tenant_relations = []
+
+    accept(arel.ast)
+  end
+
+  def tenant_relations
+    @tenant_relations.uniq
+  end
+
+  def visit_Arel_Table(table, _collector = nil)
+    @tenant_relations << table if tenant_relation?(table)
+  end
+
+  def visit_Arel_Nodes_TableAlias(table_alias, _collector = nil)
+    @tenant_relations << table_alias if tenant_relation?(table_alias.left)
+  end
+
+  private
+
+  def tenant_relation?(table)
+    model = table.name.classify.constantize
+    model && model.respond_to?(:scoped_by_tenant?) && model.scoped_by_tenant?
+  end
+end
+
+module ActiveRecord
+  module QueryMethods
+    alias :build_arel_orig :build_arel
+    def build_arel
+      arel = build_arel_orig
+
+      if MultiTenant.current_tenant_id && !MultiTenant.with_write_only_mode_enabled?
+        relations_needing_tenant_id = TTTenantVisitor.new(arel).tenant_relations
+        arel = relations_needing_tenant_id.reduce(arel) do |arel, relation|
+          arel.where(relation[self.partition_key].eq(MultiTenant.current_tenant_id))
+        end
+      end
+
+      arel
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'sidekiq/client'
+
+module Sidekiq::Middleware::MultiTenant
+  # Get the current tenant and store in the message to be sent to Sidekiq.
+  class Client
+    def call(worker_class, msg, queue, redis_pool)
+      msg['multi_tenant'] ||=
+        {
+          'class' => MultiTenant.current_tenant_class,
+          'id' => MultiTenant.current_tenant_id
+        } if MultiTenant.current_tenant.present?
+
+      yield
+    end
+  end
+
+  # Pull the tenant out and run the current thread with it.
+  class Server
+    def call(worker_class, msg, queue)
+      if msg.has_key?('multi_tenant')
+        tenant = msg['multi_tenant']['class'].constantize.find(msg['multi_tenant']['id'])
+        MultiTenant.with(tenant) do
+          yield
+        end
+      else
+        Rails.logger.warn("Running #{worker_class} without tenant.")
+        yield
+      end
+    end
+  end
+end
+
+module Sidekiq
+  class Client
+    def push_bulk_with_tenants(items)
+      job = items['jobs'].first
+      return [] unless job # no jobs to push
+      raise ArgumentError, "Bulk arguments must be an Array of Hashes: [{ 'args' => [1], 'tenant_id' => 1 }, ...]" if !job.is_a?(Hash)
+
+      normed = normalize_item(items.except('jobs').merge('args' => []))
+      payloads = items['jobs'].map do |job|
+        MultiTenant.with(job['tenant_id']) do
+          copy = normed.merge('args' => job['args'], 'jid' => SecureRandom.hex(12), 'enqueued_at' => Time.now.to_f)
+          result = process_single(items['class'], copy)
+          result ? result : nil
+        end
+      end.compact
+
+      raw_push(payloads) if !payloads.empty?
+      payloads.collect { |payload| payload['jid'] }
+    end
+
+    class << self
+      def push_bulk_with_tenants(items)
+        new.push_bulk_with_tenants(items)
+      end
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/spec_helper.rb

@@ -25,7 +25,7 @@ RSpec.configure do |config|
     DatabaseCleaner[:active_record].strategy = :truncation
     DatabaseCleaner[:active_record].clean
 
-    # Keep this here until https://github.com/citusdata/citus/issues/1236 is fixed in a patch release we can run tests with
+    # Keep this here until https://github.com/citusdata/citus/issues/1236 is fixed
     MultiTenant.enable_with_lock_workaround
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Citus Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -138,8 +138,8 @@ files:
 - Rakefile
 - activerecord-multi-tenant.gemspec
 - docker-compose.yml
-- gemfiles/active_record_5.0.gemfile
-- gemfiles/active_record_5.0.gemfile.lock
+- gemfiles/active_record_5.1.gemfile
+- gemfiles/active_record_5.1.gemfile.lock
 - gemfiles/rails_3.2.gemfile
 - gemfiles/rails_3.2.gemfile.lock
 - gemfiles/rails_4.0.gemfile
@@ -150,14 +150,19 @@ files:
 - gemfiles/rails_4.2.gemfile.lock
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.0.gemfile.lock
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.1.gemfile.lock
 - lib/activerecord-multi-tenant.rb
 - lib/activerecord-multi-tenant/controller_extensions.rb
 - lib/activerecord-multi-tenant/copy_from_client.rb
-- lib/activerecord-multi-tenant/default_scope.rb
+- lib/activerecord-multi-tenant/fast_truncate.rb
 - lib/activerecord-multi-tenant/migrations.rb
 - lib/activerecord-multi-tenant/model_extensions.rb
 - lib/activerecord-multi-tenant/multi_tenant.rb
+- lib/activerecord-multi-tenant/query_monitor.rb
+- lib/activerecord-multi-tenant/query_rewriter.rb
 - lib/activerecord-multi-tenant/referential_integrity.rb
+- lib/activerecord-multi-tenant/sidekiq.rb
 - lib/activerecord-multi-tenant/version.rb
 - lib/activerecord-multi-tenant/with_lock.rb
 - spec/activerecord-multi-tenant/controller_extensions_spec.rb
@@ -188,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: ActiveRecord/Rails integration for multi-tenant databases, in particular

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

@@ -1,16 +0,0 @@
-require 'active_record'
-
-class ActiveRecord::Base
-  class << self
-    alias :unscoped_orig :unscoped
-    def unscoped
-      scope = if respond_to?(:scoped_by_tenant?) && MultiTenant.current_tenant_id
-        unscoped_orig.where(arel_table[self.partition_key].eq(MultiTenant.current_tenant_id))
-      else
-        unscoped_orig
-      end
-
-      block_given? ? scope.scoping { yield } : scope
-    end
-  end
-end