devise_invitable 3.0.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bcb44af270be6f5192f01771df589f95045ee16206315e7784c16c49d93df5
-  data.tar.gz: 74fea42d1bae1ec385ca62291817679a59c3430fc6f4e609c966ee08db17c2d3
+  metadata.gz: 1d7694e9f3f376c8f60a5d426144eebe986967f33b6ea016ca1f01c65fa19e32
+  data.tar.gz: 40faca7611e16510fe0d45f886e35f6622eb7d1cefe9016be0e93ba6d272e2e4
 SHA512:
-  metadata.gz: dd0dbba52b99e4117a02072d3f48fbb3623614697a5e972a4f99081351479c9a2846696752a112ffd63d9528631ef196763146af5cc2792996246bcdaa755a97
-  data.tar.gz: 406bdf51f7114cc26354cf682658a3f44cb192db2f94cb45d0c7fd72384774d1464678275aac671a973b1660031084c21b4a290279e8e52a9ea69109a8186068
+  metadata.gz: aab0c7da6b34b49475014c55ace27804cff1c95b15012a3209c0cf7f7e42e6612647dbdeb0ddacd8fd6e26353b2617355f8c4e2f25a3dd8a2e4aaf9aa0b89d7e
+  data.tar.gz: 2d7873782c77d7c9076312eea7a57cb8cfc4e54874dbd4705e6133d1a5ed92f981291ec8bc7bd81cf4570836059c2b2aff6fffdf01b54f0056d67e62467a5a50

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## Unreleased
+## 3.0.4
+
+- Avoid using distinct which may fail in postgresql if the model has json column ([935](https://github.com/scambra/devise_invitable/issues/935))
+- Use scoped preloaded invitations when checking whether an invitation is
+  pending, avoiding per-resource queries in listings
+  ([#937](https://github.com/scambra/devise_invitable/issues/937))
+
+## 3.0.3
+
+- Check invitation token uniqueness against the invitations store instead of
+  the resource table, which no longer has an `invitation_token` column after
+  running `devise_invitable:upgrade` ([#933](https://github.com/scambra/devise_invitable/issues/933))
 
 ## 3.0.2
 

data/lib/devise_invitable/invitation.rb

@@ -38,7 +38,13 @@ module DeviseInvitable
       index({ invitable_type: 1, invite_key_digest: 1 })
     end
 
-    belongs_to :invitable, polymorphic: true, optional: true
+    invitable_options = { polymorphic: true, optional: true }
+    if defined?(Mongoid::Document) && !defined?(ActiveRecord::Base)
+      # Mongoid cannot infer a polymorphic inverse when the parent exposes both
+      # the complete and scoped invitation associations.
+      invitable_options[:inverse_of] = false
+    end
+    belongs_to :invitable, **invitable_options
     invited_by_options = { polymorphic: true, optional: true, autosave: true }
     if defined?(ActiveRecord::Base) && Devise.invited_by_counter_cache
       invited_by_options[:counter_cache] = Devise.invited_by_counter_cache

data/lib/devise_invitable/models.rb

@@ -35,11 +35,25 @@ module Devise
       included do
         include ::DeviseInvitable::Inviter
         has_many :devise_invitations,
-          as: :invitable,
-          class_name: 'DeviseInvitable::Invitation',
-          dependent: :nullify,
-          autosave: true
-
+                 as: :invitable,
+                 class_name: 'DeviseInvitable::Invitation',
+                 dependent: :nullify,
+                 autosave: true
+        if defined?(Mongoid::Document) && self < Mongoid::Document
+          has_many :pending_invitations,
+                   as: :invitable,
+                   class_name: 'DeviseInvitable::Invitation',
+                   foreign_key: :invitable_id,
+                   inverse_of: false,
+                   scope: -> { pending.provisioning }
+        else
+          has_many :pending_invitations,
+                   -> { pending.provisioning },
+                   as: :invitable,
+                   class_name: 'DeviseInvitable::Invitation',
+                   foreign_key: :invitable_id,
+                   inverse_of: false
+        end
         extend ActiveModel::Callbacks
         define_model_callbacks :invitation_created
         define_model_callbacks :invitation_accepted
@@ -68,14 +82,22 @@ module Devise
           }
         elsif defined?(ActiveRecord) && defined?(ActiveRecord::Base) && self < ActiveRecord::Base
           scope :created_by_invite, lambda {
-            joins(:devise_invitations).merge(DeviseInvitable::Invitation.provisioning).distinct
+            invitation_ids = DeviseInvitable::Invitation.provisioning
+              .where(invitable_type: devise_invitable_base_class.name)
+              .select(:invitable_id)
+            where(id: invitation_ids)
           }
           scope :invitation_not_accepted, lambda {
-            joins(:devise_invitations).merge(DeviseInvitable::Invitation.pending)
-              .merge(DeviseInvitable::Invitation.provisioning).distinct
+            invitation_ids = DeviseInvitable::Invitation.pending.provisioning
+              .where(invitable_type: devise_invitable_base_class.name)
+              .select(:invitable_id)
+            where(id: invitation_ids)
           }
           scope :invitation_accepted, lambda {
-            joins(:devise_invitations).merge(DeviseInvitable::Invitation.accepted).distinct
+            invitation_ids = DeviseInvitable::Invitation.accepted
+              .where(invitable_type: devise_invitable_base_class.name)
+              .select(:invitable_id)
+            where(id: invitation_ids)
           }
           scope :no_active_invitation, lambda {
             invitation_ids = DeviseInvitable::Invitation.pending
@@ -195,6 +217,7 @@ module Devise
               current_invitation.invitation_token = nil
               current_invitation.save!
               supersede_other_invitations!(accepted_at)
+              reset_devise_invitation_associations
               true
             else
               false
@@ -222,7 +245,12 @@ module Devise
       def invitation_pending?
         return false unless persisted?
 
-        devise_invitations.pending.provisioning.exists?
+        invitations = pending_invitations
+        if devise_invitable_association_loaded?(invitations)
+          return invitations.any?
+        end
+
+        invitations.exists?
       end
 
       def invited_to_sign_up?
@@ -276,6 +304,7 @@ module Devise
               invitation.resource_created_at = now if resource_was_new
             end
             invitation.save!
+            reset_devise_invitation_associations
             invitation.invited_by.decrement_invitation_limit! if invitation.invited_by.present?
             deliver_invitation(options) unless skip_invitation
           end
@@ -371,24 +400,39 @@ module Devise
         invitation = current_invitation
         return unless invitation&.pending?
 
-        remove_placeholder = invitation.provisioning? && invitation_pending?
+        remove_placeholder = invitation.provisioning?
         invitation.update!(revoked_at: Time.now.utc, invitation_token: nil)
+        reset_devise_invitation_associations
         destroy if remove_placeholder
       end
 
       protected
 
+        def devise_invitable_association_loaded?(association)
+          return association.loaded? if association.respond_to?(:loaded?)
+
+          association._loaded?
+        end
+
         def assign_invitation_attribute(attribute, value)
           return unless current_invitation
 
           current_invitation.public_send("#{attribute}=", value)
-          current_invitation.save! if current_invitation.persisted?
+          if current_invitation.persisted?
+            current_invitation.save!
+            reset_devise_invitation_associations
+          end
         end
 
         def block_from_invitation?
           invitation_pending?
         end
 
+        def reset_devise_invitation_associations
+          devise_invitations.reset
+          pending_invitations.reset
+        end
+
         # Checks if the invitation for the user is within the limit time.
         # We do this by calculating if the difference between today and the
         # invitation sent date does not exceed the invite for time configured.
@@ -415,7 +459,9 @@ module Devise
         # Generates a new random token for invitation, and stores the time
         # this token is being generated
         def generate_invitation_token
-          raw, enc = Devise.token_generator.generate(self.class, :invitation_token)
+          # Tokens live in the invitations store, so check uniqueness there
+          # instead of on the resource, which may no longer have the column
+          raw, enc = Devise.token_generator.generate(DeviseInvitable::Invitation, :invitation_token)
           @raw_invitation_token = raw
           current_invitation.invitation_token = enc
         end
@@ -462,6 +508,7 @@ module Devise
               superseded_reason: 'registered'
             )
           end
+          reset_devise_invitation_associations
           self.registering_directly = false
         end
 

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.0.4'.freeze
 end

data/test/models/invitable_test.rb

@@ -88,7 +88,7 @@ class InvitableTest < ActiveSupport::TestCase
 
   test 'should return the correct raw_invitation_token ' do
     user = new_user
-    raw, enc = Devise.token_generator.generate(user.class, :invitation_token)
+    raw, enc = Devise.token_generator.generate(DeviseInvitable::Invitation, :invitation_token)
     # stub the generator so the tokens are the same
     Devise.token_generator.stubs(:generate).returns([raw, enc])
     user.invite!
@@ -839,6 +839,16 @@ class InvitableTest < ActiveSupport::TestCase
     assert_equal 3, User.created_by_invite.count
   end
 
+  test 'invitation scopes do not use distinct with json columns' do
+    skip unless defined?(ActiveRecord)
+
+    assert_equal :json, User.type_for_attribute('options').type
+
+    [:created_by_invite, :invitation_not_accepted, :invitation_accepted].each do |scope|
+      refute_match(/\bSELECT\s+DISTINCT\b/i, User.public_send(scope).to_sql)
+    end
+  end
+
   test "should preserve return values of Devise::Recoverable#reset_password" do
     user = new_user
     retval = user.reset_password('anewpassword', 'anewpassword')

data/test/models/separate_invitations_test.rb

@@ -48,6 +48,20 @@ class SeparateInvitationsTest < ActiveSupport::TestCase
     end
   end
 
+  test 'invitation token uniqueness is checked against the invitations store' do
+    User.create_resource_on_invitation = false
+    Devise.stubs(:friendly_token).returns('taken-token', 'taken-token', 'free-token')
+
+    User.invite!(email: 'first@example.com')
+    User.invite!(email: 'second@example.com')
+
+    tokens = DeviseInvitable::Invitation.all.map(&:invitation_token)
+    assert_equal [
+      Devise.token_generator.digest(User, :invitation_token, 'taken-token'),
+      Devise.token_generator.digest(User, :invitation_token, 'free-token')
+    ].sort, tokens.sort
+  end
+
   test 'a failed later delivery remains unsent and can be retried' do
     User.create_resource_on_invitation = false
     invited = User.invite!(email: 'retry@example.com', skip_invitation: true)
@@ -124,6 +138,7 @@ class SeparateInvitationsTest < ActiveSupport::TestCase
 
     user = User.invite!(email: 'placeholder@example.com')
     user.update!(confirmed_at: Time.now.utc)
+    user.pending_invitations.to_a
 
     assert_predicate user, :invitation_pending?
     refute_predicate user, :active_for_authentication?
@@ -135,6 +150,34 @@ class SeparateInvitationsTest < ActiveSupport::TestCase
     assert_predicate user, :active_for_authentication?
   end
 
+  test 'invitation pending uses preloaded invitations' do
+    pending_user = User.invite!(email: 'pending@example.com')
+    active_user = User.create!(email: 'active@example.com', password: '123456789')
+    DeviseInvitable::Invitation.create!(
+      invitable: active_user,
+      invitation_accepted_at: Time.now.utc,
+      resource_created_at: Time.now.utc,
+      invite_key: { email: active_user.email }
+    )
+    users = User.includes(:pending_invitations).index_by(&:email)
+
+    users.each_value do |user|
+      assert association_loaded?(user.pending_invitations)
+    end
+    check_statuses = proc do
+      assert_equal 1, users[pending_user.email].pending_invitations.size
+      assert_empty users[active_user.email].pending_invitations
+      assert_predicate users[pending_user.email], :invitation_pending?
+      refute_predicate users[active_user.email], :invitation_pending?
+    end
+
+    if respond_to?(:assert_no_queries)
+      assert_no_queries(&check_statuses)
+    else
+      check_statuses.call
+    end
+  end
+
   test 'resource attributes raise when placeholder creation is disabled' do
     User.create_resource_on_invitation = false
 
@@ -210,4 +253,12 @@ class SeparateInvitationsTest < ActiveSupport::TestCase
     refute first.reload.attributes.key?('invitation_created_at')
     refute second.reload.attributes.key?('invitation_created_at')
   end
+
+  private
+
+    def association_loaded?(association)
+      return association.loaded? if association.respond_to?(:loaded?)
+
+      association._loaded?
+    end
 end

data/test/rails_app/app/models/user.rb

@@ -18,13 +18,7 @@ class User < PARENT_MODEL_CLASS
     field :unconfirmed_email,    type: String # Only if using reconfirmable
 
     ## Invitable
-    field :invitation_token,       type: String
-    field :invitation_created_at,  type: Time
-    field :invitation_sent_at,     type: Time
-    field :invitation_accepted_at, type: Time
-    field :invitation_limit,       type: Integer
-    field :invited_by_id,          type: Integer
-    field :invited_by_type,        type: String
+    field :invitation_limit, type: Integer
 
     field :username
     field :profile_id

data/test/rails_app/db/migrate/20100401102949_create_tables.rb

@@ -20,18 +20,11 @@ class CreateTables < (Rails.version < '5.1' ? ActiveRecord::Migration : ActiveRe
       t.boolean :active
 
       ## Invitable
-      t.string   :invitation_token, :limit => 60
-      t.datetime :invitation_created_at
-      t.datetime :invitation_sent_at
-      t.datetime :invitation_accepted_at
       t.integer  :invitation_limit
-      t.integer  :invited_by_id
-      t.string   :invited_by_type
       t.integer :invitations_count, :default => 0
 
       t.timestamps :null => false
     end
-    add_index :users, :invitation_token, :unique => true
 
     create_table :devise_invitations do |t|
       t.string :invitation_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.4
 platform: ruby
 authors:
 - Sergio Cambra