Introduce reactions feature (so-called "like button") to issues, notes, news, and forums (#42630).HEADmaster

Patch by Katsuya HIDAKA (user:hidakatsuya).


git-svn-id: https://svn.redmine.org/redmine/trunk@23755 e93f8b46-1217-0410-a6f0-8f06a7374b81

3 files changed, 325 insertions, 0 deletions

diff --git a/test/unit/lib/redmine/reaction_test.rb b/test/unit/lib/redmine/reaction_test.rb
new file mode 100644
index 000000000..bed4600d0
--- /dev/null
+++ b/test/unit/lib/redmine/reaction_test.rb
@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+# Redmine - project management software
+# Copyright (C) 2006-  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require_relative '../../../test_helper'
+
+class Redmine::ReactionTest < ActiveSupport::TestCase
+  setup do
+    @user = users(:users_002)
+    @issue = issues(:issues_007)
+    Setting.reactions_enabled = '1'
+  end
+
+  teardown do
+    Setting.clear_cache
+  end
+
+  test 'preload_reaction_details preloads ReactionDetail for all objects in the collection' do
+    User.current = users(:users_002)
+
+    issue1 = issues(:issues_001)
+    issue2 = issues(:issues_002)
+
+    assert_nil issue1.instance_variable_get(:@reaction_detail)
+    assert_nil issue2.instance_variable_get(:@reaction_detail)
+
+    Issue.preload_reaction_details([issue1, issue2])
+
+    expected_issue1_reaction_detail = Reaction::Detail.new(
+      reaction_count: 3,
+      visible_users: [users(:users_003), users(:users_002), users(:users_001)],
+      user_reaction: reactions(:reaction_002)
+    )
+
+    # ReactionDetail is already preloaded, so calling reaction_detail does not execute any query.
+    assert_no_queries do
+      assert_equal expected_issue1_reaction_detail, issue1.reaction_detail
+
+      # Even when an object has no reactions, an empty ReactionDetail is set.
+      assert_equal Reaction::Detail.new(
+        reaction_count: 0,
+        visible_users: [],
+        user_reaction: nil
+      ), issue2.reaction_detail
+    end
+  end
+
+  test 'visible_users in ReactionDetail preloaded by preload_reaction_details does not include non-visible users' do
+    current_user = User.current = User.generate!
+    visible_user = users(:users_002)
+    non_visible_user = User.generate!
+
+    project = Project.generate!
+    role = Role.generate!(users_visibility: 'members_of_visible_projects')
+
+    User.add_to_project(current_user, project, role)
+    User.add_to_project(visible_user, project, roles(:roles_001))
+
+    issue = Issue.generate!(project: project)
+
+    [current_user, visible_user, non_visible_user].each do |user|
+      issue.reactions.create!(user: user)
+    end
+
+    Issue.preload_reaction_details([issue])
+
+    # non_visible_user is not visible to current_user because they do not belong to any project.
+    assert_equal [visible_user, current_user], issue.reaction_detail.visible_users
+  end
+
+  test 'preload_reaction_details does nothing when the reaction feature is disabled' do
+    Setting.reactions_enabled = '0'
+
+    User.current = users(:users_002)
+    news1 = news(:news_001)
+
+    # Stub the Setting to avoid executing queries for retrieving settings,
+    # making it easier to confirm no queries are executed by preload_reaction_details().
+    Setting.stubs(:reactions_enabled?).returns(false)
+
+    assert_no_queries do
+      News.preload_reaction_details([news1])
+    end
+
+    assert_nil news1.instance_variable_get(:@reaction_detail)
+  end
+
+  test 'reaction_detail loads and returns ReactionDetail if it is not preloaded' do
+    message7 = messages(:messages_007)
+
+    User.current = users(:users_002)
+    assert_nil message7.instance_variable_get(:@reaction_detail)
+
+    assert_equal Reaction::Detail.new(
+      reaction_count: 1,
+      visible_users: [users(:users_002)],
+      user_reaction: reactions(:reaction_009)
+    ), message7.reaction_detail
+  end
+
+  test 'load_reaction_detail loads ReactionDetail for the object itself' do
+    comment1 = comments(:comments_001)
+
+    User.current = users(:users_001)
+    assert_nil comment1.instance_variable_get(:@reaction_detail)
+
+    comment1.load_reaction_detail
+
+    assert_equal Reaction::Detail.new(
+      reaction_count: 1,
+      visible_users: [users(:users_002)],
+      user_reaction: nil
+    ), comment1.reaction_detail
+  end
+
+  test 'visible? returns true when reactions are enabled and object is visible to user' do
+    object = issues(:issues_007)
+    user = users(:users_002)
+
+    assert Redmine::Reaction.visible?(object, user)
+  end
+
+  test 'visible? returns false when reactions are disabled' do
+    Setting.reactions_enabled = '0'
+
+    object = issues(:issues_007)
+    user = users(:users_002)
+
+    assert_not Redmine::Reaction.visible?(object, user)
+  end
+
+  test 'visible? returns false when object is not visible to user' do
+    object = issues(:issues_007)
+    user = users(:users_002)
+
+    object.expects(:visible?).with(user).returns(false)
+
+    assert_not Redmine::Reaction.visible?(object, user)
+  end
+
+  test 'writable? returns true for various reactable objects when user is logged in, object is visible, and project is active' do
+    reactable_objects = {
+      issue: issues(:issues_007),
+      message: messages(:messages_001),
+      news: news(:news_001),
+      journal: journals(:journals_001),
+      comment: comments(:comments_002)
+    }
+    user = users(:users_002)
+
+    reactable_objects.each do |type, object|
+      assert Redmine::Reaction.writable?(object, user), "Expected writable? to return true for #{type}"
+    end
+  end
+
+  test 'writable? returns false when user is not logged in' do
+    object = issues(:issues_007)
+    user = User.anonymous
+
+    assert_not Redmine::Reaction.writable?(object, user)
+  end
+
+  test 'writable? returns false when project is inactive' do
+    object = issues(:issues_007)
+    user = users(:users_002)
+    object.project.update!(status: Project::STATUS_ARCHIVED)
+
+    assert_not Redmine::Reaction.writable?(object, user)
+  end
+
+  test 'writable? returns false when project is closed' do
+    object = issues(:issues_007)
+    user = users(:users_002)
+    object.project.update!(status: Project::STATUS_CLOSED)
+
+    assert_not Redmine::Reaction.writable?(object, user)
+  end
+end
diff --git a/test/unit/reaction_test.rb b/test/unit/reaction_test.rb
new file mode 100644
index 000000000..2690da351
--- /dev/null
+++ b/test/unit/reaction_test.rb
@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Redmine - project management software
+# Copyright (C) 2006-  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require_relative '../test_helper'
+
+class ReactionTest < ActiveSupport::TestCase
+  test 'validates :inclusion of reactable_type' do
+    %w(Issue Journal News Comment Message).each do |type|
+      reaction = Reaction.new(reactable_type: type, user: User.new)
+      assert reaction.valid?
+    end
+
+    assert_not Reaction.new(reactable_type: 'InvalidType', user: User.new).valid?
+  end
+
+  test 'scope: by' do
+    user2_reactions = issues(:issues_001).reactions.by(users(:users_002))
+
+    assert_equal [reactions(:reaction_002)], user2_reactions
+  end
+
+  test "should prevent duplicate reactions with unique constraint under concurrent creation" do
+    user = users(:users_001)
+    issue = issues(:issues_004)
+
+    threads = []
+    results = []
+
+    # Ensure both threads start at the same time
+    barrier = Concurrent::CyclicBarrier.new(2)
+
+    # Create two threads to simulate concurrent creation
+    2.times do
+      threads << Thread.new do
+        barrier.wait # Wait for both threads to be ready
+        begin
+          reaction = Reaction.create(
+            reactable: issue,
+            user: user
+          )
+          results << reaction.persisted?
+        rescue ActiveRecord::RecordNotUnique
+          results << false
+        end
+      end
+    end
+
+    # Wait for both threads to finish
+    threads.each(&:join)
+
+    # Ensure only one reaction was created
+    assert_equal 1, Reaction.where(reactable: issue, user: user).count
+    assert_includes results, true
+    assert_equal 1, results.count(true)
+  end
+
+  test 'build_detail_map_for generates a detail map for reactable objects' do
+    result = Reaction.build_detail_map_for([issues(:issues_001), issues(:issues_006)], users(:users_003))
+
+    expected = {
+      1 => Reaction::Detail.new(
+        reaction_count: 3,
+        visible_users: [users(:users_003), users(:users_002), users(:users_001)],
+        user_reaction: reactions(:reaction_003)
+      ),
+      6 => Reaction::Detail.new(
+        reaction_count: 1,
+        visible_users: [users(:users_002)],
+        user_reaction: nil
+      )
+    }
+    assert_equal expected, result
+
+    # When an object have no reactions, the result should be empty.
+    result = Reaction.build_detail_map_for([journals(:journals_002)], users(:users_002))
+
+    assert_empty result
+  end
+
+  test 'build_detail_map_for filters users based on visibility' do
+    current_user = User.generate!
+    visible_user = users(:users_002)
+    non_visible_user = User.generate!
+
+    project = Project.generate!
+    role = Role.generate!(users_visibility: 'members_of_visible_projects')
+
+    User.add_to_project(current_user, project, role)
+    User.add_to_project(visible_user, project, roles(:roles_001))
+
+    issue = Issue.generate!(project: project)
+
+    [current_user, visible_user, non_visible_user].each do |user|
+      issue.reactions.create!(user: user)
+    end
+
+    result = Reaction.build_detail_map_for([issue], current_user)
+
+    assert_equal(
+      [current_user, visible_user].sort_by(&:id),
+      result[issue.id].visible_users.sort_by(&:id)
+    )
+  end
+end
diff --git a/test/unit/user_test.rb b/test/unit/user_test.rb
index ede12e1ce..aeae62df8 100644
--- a/test/unit/user_test.rb
+++ b/test/unit/user_test.rb
@@ -1376,4 +1376,16 @@ class UserTest < ActiveSupport::TestCase
       User.prune(7)
     end
   end
+
+  def test_destroy_should_delete_associated_reactions
+    users(:users_004).reactions.create!(
+      [
+        {reactable: issues(:issues_001)},
+        {reactable: issues(:issues_002)}
+      ]
+    )
+    assert_difference 'Reaction.count', -2 do
+      users(:users_004).destroy
+    end
+  end
 end