acts_as_tenant 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08b36c305d545f35106ccce014d60c77b143f697a219c0eff6fe064b797b45c
-  data.tar.gz: 95c5783b42a93e692594c7593d6e7d8dd31ca131a109a7497b6c79171419d417
+  metadata.gz: 7c0fbfe96e632768ed0f7dfae94d955c791c6ce1b724ef84e0ce6c2ca0fe0d88
+  data.tar.gz: 4294ce8d41e28d09c730f28ef22d2a28aa59ac1a4d4aba8e0b12ea3dea410719
 SHA512:
-  metadata.gz: 25f1ba646a1f44f8071cf4bc03aab45a3464857aa0e79ddb6ae27dfbad4ec61b6241f46c86106b8bae88e45966cf120a4f82854c8e8536630d69ddf7648f41fb
-  data.tar.gz: 3d093c37d7bb737d57a6ec4c4e89aadbd55b23635d34aa70c6b06955933d25189378e1176de05f2d8e27e29632233c6a078c6f4c4687d7a856cba616233ab2ff
+  metadata.gz: 4c41db14ddabafb233b66c0ac39d2fddd4fb03742ed874ca8a8027e3b46927f70e7eef1d2e65b157073e02b79de95f492859449cc6cd45c828cd4590463191b5
+  data.tar.gz: 3e9f92da5f007404e79e0381a8a065f04515b5d96f451ce1d91636a8d2c37bac71a0944d2404d53fde07f01e98b26f194317e5be9fbaf66aac9fc155c4ef4ae6

data/README.md

@@ -128,6 +128,8 @@ end
 This approach is useful when running background processes for a specified tenant. For example, by putting this in your worker's run method,
 any code in this block will be scoped to the current tenant. All methods that set the current tenant are thread safe.
 
+The tenant is stored in `ActiveSupport::CurrentAttributes`, which is isolated per thread. On servers that run requests in fibers, such as Falcon, set `config.active_support.isolation_level = :fiber` so each request keeps its own tenant.
+
 **Note:** If the current tenant is not set by one of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
 
 ### Disabling tenant checking for a block
@@ -197,11 +199,12 @@ Project.tasks.all #  => all tasks with account_id => 3
 
 Acts_as_tenant uses Rails' `default_scope` method to scope models. Rails 3.1 changed the way `default_scope` works in a good way. A user defined `default_scope` should integrate seamlessly with the one added by `acts_as_tenant`.
 
-Because the scoping comes from `default_scope`, queries built from the model are scoped when a tenant is set. This includes `update_all`, `delete_all` and `destroy_all`, and `insert_all` and `upsert_all` set the current tenant. These are **not** scoped or checked:
+Because the scoping comes from `default_scope`, queries built from the model are scoped when a tenant is set. This includes `update_all`, `delete_all` and `destroy_all`. `insert_all` and `upsert_all` set the current tenant on the rows they write, but they skip validations. `upsert_all` also matches existing rows by primary key across all tenants, so passing another tenant's id overwrites that record and moves it to the current tenant. Never pass ids from user input to `upsert_all`. These are **not** scoped or checked:
 
 * Any query when no tenant is set, unless `require_tenant` is enabled
 * Queries that remove the default scope, such as `unscoped`
 * Raw SQL, such as `find_by_sql`, `connection.execute` and `exec_query`
+* `update_counters`, `increment_counter` and `decrement_counter`, which Rails runs without default scopes
 * `update_column` and `update_columns`, which skip the check that prevents changing a record's tenant
 
 New records are assigned the current tenant unless they already have one. A record assigned to a different tenant fails validation, so to create records for another tenant, wrap them in `ActsAsTenant.with_tenant(other_tenant) { ... }`.

data/lib/acts_as_tenant/controller_extensions/subdomain_or_domain.rb

@@ -12,8 +12,16 @@ module ActsAsTenant
 
       def find_tenant_by_subdomain_or_domain
         subdomain = request.subdomains.public_send(subdomain_lookup)
-        query = subdomain.present? ? {tenant_primary_column => subdomain.downcase} : {tenant_second_column => request.domain.downcase}
-        ActsAsTenant.current_tenant = tenant_class.where(query).first
+        domain = request.domain
+
+        # request.domain is nil for IP addresses, so there is no tenant to look up
+        query = if subdomain.present?
+          {tenant_primary_column => subdomain.downcase}
+        elsif domain.present?
+          {tenant_second_column => domain.downcase}
+        end
+
+        ActsAsTenant.current_tenant = query && tenant_class.find_by(query)
       end
     end
   end

data/lib/acts_as_tenant/model_extensions.rb

@@ -16,6 +16,7 @@ module ActsAsTenant
         tenant_reflection = reflect_on_association(tenant)
         fkey = tenant_reflection.foreign_key.to_sym
         polymorphic_type = tenant_reflection.foreign_type&.to_sym
+        tenant_attributes = [fkey, polymorphic_type].compact
 
         # Polymorphic tenants are stored with polymorphic_name, like Rails does. Records saved before
         # that used the class name, which differs for STI tenants, so match both when scoping.
@@ -65,6 +66,13 @@ module ActsAsTenant
           end
         }, on: :create
 
+        # Returns the model class named by a polymorphic type column, or nil when the name
+        # is not a model, such as "Kernel" or "String" submitted in form params
+        polymorphic_class = lambda do |name|
+          klass = name&.safe_constantize
+          klass if klass.is_a?(Class) && klass < ActiveRecord::Base
+        end
+
         # Returns [tenant id, tenant class] for a record, or nil if it has no tenant.
         # Classes are normalized with polymorphic_name so STI tenants compare equal.
         tenant_identity = lambda do |model|
@@ -74,7 +82,7 @@ module ActsAsTenant
           if id
             type = if reflection.polymorphic?
               stored_type = model.read_attribute(reflection.foreign_type)
-              stored_type&.safe_constantize&.polymorphic_name || stored_type
+              polymorphic_class.call(stored_type)&.polymorphic_name || stored_type
             else
               reflection.klass.polymorphic_name
             end
@@ -104,7 +112,6 @@ module ActsAsTenant
           current_id, current_type = current_tenant_identity.call
           next unless current_id
 
-          tenant_attributes = [fkey, polymorphic_type].compact
           next unless record.new_record? || tenant_attributes.any? { |attr| record.will_save_change_to_attribute?(attr) }
 
           record_tenant = tenant_identity.call(record)
@@ -143,8 +150,7 @@ module ActsAsTenant
             next unless record.validate_tenant_association?(association)
 
             klass = if association.polymorphic?
-              type = record.read_attribute(association.foreign_type)&.safe_constantize
-              type if type.is_a?(Class) && type < ActiveRecord::Base
+              polymorphic_class.call(record.read_attribute(association.foreign_type))
             else
               # Raises for composite keys whose column counts don't match, like loading the association would
               association.check_validity! if attrs.size > 1
@@ -166,12 +172,15 @@ module ActsAsTenant
           end
         end
 
-        # Tenant writers raise if the tenant changes on a persisted record
+        # Tenant writers raise if the tenant changes on a persisted record. The change is
+        # undone before raising so it isn't saved later, for example by update_attribute.
         to_include = Module.new {
-          define_method :"#{fkey}=" do |integer|
-            write_attribute(fkey, integer)
-            raise_if_tenant_changed
-            integer
+          tenant_attributes.each do |attr|
+            define_method :"#{attr}=" do |value|
+              write_attribute(attr, value)
+              raise_if_tenant_changed
+              value
+            end
           end
 
           define_method :"#{tenant}=" do |model|
@@ -181,12 +190,15 @@ module ActsAsTenant
           end
 
           define_method :raise_if_tenant_changed do
-            raise ActsAsTenant::Errors::TenantIsImmutable if !ActsAsTenant.mutable_tenant? && tenant_modified?
+            if tenant_modified? && !ActsAsTenant.mutable_tenant?
+              restore_attributes(tenant_attributes)
+              raise ActsAsTenant::Errors::TenantIsImmutable
+            end
           end
           private :raise_if_tenant_changed
 
           define_method :tenant_modified? do
-            will_save_change_to_attribute?(fkey) && persisted? && attribute_in_database(fkey).present?
+            persisted? && attribute_in_database(fkey).present? && tenant_attributes.any? { |attr| will_save_change_to_attribute?(attr) }
           end
         }
         include to_include

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Erwin Matthijssen