feat!: remove cs_comments_service support for forum's vote APIs

This will force the use of the new v2 forum's APIs for voting/unvoting.

Author: Ali-Salman29

lms/djangoapps/discussion/django_comment_client/base/tests.py

@@ -191,17 +191,6 @@ def test_delete(self, mock_is_forum_v2_enabled, mock_request):
         response = self.call_view("delete_thread", mock_is_forum_v2_enabled, mock_request)
         self._assert_json_response_contains_group_info(response)
 
-    def test_vote(self, mock_is_forum_v2_enabled, mock_request):
-        response = self.call_view(
-            "vote_for_thread",
-            mock_is_forum_v2_enabled,
-            mock_request,
-            view_args={"value": "up"}
-        )
-        self._assert_json_response_contains_group_info(response)
-        response = self.call_view("undo_vote_for_thread", mock_is_forum_v2_enabled, mock_request)
-        self._assert_json_response_contains_group_info(response)
-
     def test_openclose(self, mock_is_forum_v2_enabled, mock_request):
         response = self.call_view(
             "openclose_thread",
@@ -791,25 +780,6 @@ def test_update_comment_basic(self, mock_is_forum_v2_enabled, mock_request):
             data={"body": updated_body, "course_id": str(self.course_id)}
         )
 
-    @ddt.data(
-        ('upvote_thread', 'thread_id', 'thread_voted'),
-        ('upvote_comment', 'comment_id', 'comment_voted'),
-        ('downvote_thread', 'thread_id', 'thread_voted'),
-        ('downvote_comment', 'comment_id', 'comment_voted')
-    )
-    @ddt.unpack
-    def test_voting(self, view_name, item_id, signal, mock_is_forum_v2_enabled, mock_request):
-        mock_is_forum_v2_enabled.return_value = False
-        self._setup_mock_request(mock_request)
-        with self.assert_discussion_signals(signal):
-            response = self.client.post(
-                reverse(
-                    view_name,
-                    kwargs={item_id: 'dummy', 'course_id': str(self.course_id)}
-                )
-            )
-        assert response.status_code == 200
-
     def test_endorse_comment(self, mock_is_forum_v2_enabled, mock_request):
         mock_is_forum_v2_enabled.return_value = False
         self._setup_mock_request(mock_request)
@@ -1451,33 +1421,6 @@ def test_create_sub_comment(self, user, commentable_id, status_code, mock_is_for
         )
         assert response.status_code == status_code
 
-    @ddt.data(*ddt_permissions_args)
-    @ddt.unpack
-    def test_comment_actions(self, user, commentable_id, status_code, mock_is_forum_v2_enabled, mock_request):
-        """
-        Verify that voting and flagging of comments is limited to members of the team or users with
-        'edit_content' permission.
-        """
-        commentable_id = getattr(self, commentable_id)
-        self._setup_mock(
-            user, mock_is_forum_v2_enabled, mock_request,
-            {
-                "closed": False,
-                "commentable_id": commentable_id,
-                "thread_id": "dummy_thread",
-                "body": 'dummy body',
-                "course_id": str(self.course.id)
-            },
-        )
-        for action in ["upvote_comment", "downvote_comment"]:
-            response = self.client.post(
-                reverse(
-                    action,
-                    kwargs={"course_id": str(self.course.id), "comment_id": "dummy_comment"}
-                )
-            )
-            assert response.status_code == status_code
-
     @ddt.data(*ddt_permissions_args)
     @ddt.unpack
     def test_threads_actions(self, user, commentable_id, status_code, mock_is_forum_v2_enabled, mock_request):
@@ -1490,7 +1433,7 @@ def test_threads_actions(self, user, commentable_id, status_code, mock_is_forum_
             user, mock_is_forum_v2_enabled, mock_request,
             {"closed": False, "commentable_id": commentable_id, "body": "dummy body", "course_id": str(self.course.id)}
         )
-        for action in ["upvote_thread", "downvote_thread", "follow_thread", "unfollow_thread"]:
+        for action in ["follow_thread", "unfollow_thread"]:
             response = self.client.post(
                 reverse(
                     action,
@@ -1690,42 +1633,6 @@ def test_team_events(self, view_name, event_name, view_data, view_kwargs, mock_i
             event_receiver.call_args.kwargs
         )
 
-    @ddt.data(
-        ('vote_for_thread', 'thread_id', 'thread'),
-        ('undo_vote_for_thread', 'thread_id', 'thread'),
-        ('vote_for_comment', 'comment_id', 'response'),
-        ('undo_vote_for_comment', 'comment_id', 'response'),
-    )
-    @ddt.unpack
-    @patch('eventtracking.tracker.emit')
-    @patch('openedx.core.djangoapps.django_comment_common.comment_client.utils.requests.request', autospec=True)
-    @patch('openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', autospec=True)
-    def test_thread_voted_event(self, view_name, obj_id_name, obj_type, mock_is_forum_v2_enabled, mock_request, mock_emit):
-        undo = view_name.startswith('undo')
-
-        mock_is_forum_v2_enabled.return_value = False
-        self._set_mock_request_data(mock_request, {
-            'closed': False,
-            'commentable_id': 'test_commentable_id',
-            'username': 'gumprecht',
-        })
-        request = RequestFactory().post('dummy_url', {})
-        request.user = self.student
-        request.view_name = view_name
-        view_function = getattr(views, view_name)
-        kwargs = dict(course_id=str(self.course.id))
-        kwargs[obj_id_name] = obj_id_name
-        if not undo:
-            kwargs.update(value='up')
-        view_function(request, **kwargs)
-
-        assert mock_emit.called
-        event_name, event = mock_emit.call_args[0]
-        assert event_name == f'edx.forum.{obj_type}.voted'
-        assert event['target_username'] == 'gumprecht'
-        assert event['undo_vote'] == undo
-        assert event['vote_value'] == 'up'
-
     @ddt.data('follow_thread', 'unfollow_thread',)
     @patch('eventtracking.tracker.emit')
     @patch('openedx.core.djangoapps.django_comment_common.comment_client.utils.requests.request', autospec=True)

lms/djangoapps/discussion/django_comment_client/base/tests_v2.py

@@ -155,6 +155,14 @@ def test_pin_thread(self):
         assert response.status_code == 200
         self._assert_json_response_contains_group_info(response)
 
+    def test_vote(self):
+        response = self.call_view(
+            "vote_for_thread", "update_thread_votes", view_args={"value": "up"}
+        )
+        self._assert_json_response_contains_group_info(response)
+        response = self.call_view("undo_vote_for_thread", "delete_thread_vote")
+        self._assert_json_response_contains_group_info(response)
+
 
 class ViewsTestCaseMixin:
 
@@ -214,6 +222,22 @@ def set_up_course(self, block_count=0):
 
             assert self.client.login(username="student", password=self.password)
 
+    def _setup_mock_request(self, mock_function, include_depth=False):
+        """
+        Ensure that mock_request returns the data necessary to make views
+        function correctly
+        """
+        data = {
+            "user_id": str(self.student.id),
+            "closed": False,
+            "commentable_id": "non_team_dummy_id",
+            "thread_id": "dummy",
+            "thread_type": "discussion",
+        }
+        if include_depth:
+            data["depth"] = 0
+        self.set_mock_return_value(mock_function, data)
+
 
 @ddt.ddt
 @disable_signal(views, "comment_flagged")
@@ -549,6 +573,26 @@ def un_flag_comment(self, is_closed):
 
         assert response.status_code == 200
 
+    @ddt.data(
+        ("upvote_thread", "update_thread_votes", "thread_id", "thread_voted"),
+        ("upvote_comment", "update_comment_votes", "comment_id", "comment_voted"),
+        ("downvote_thread", "update_thread_votes", "thread_id", "thread_voted"),
+        ("downvote_comment", "update_comment_votes", "comment_id", "comment_voted"),
+    )
+    @ddt.unpack
+    def test_voting(self, view_name, function_name, item_id, signal):
+        self._setup_mock_request("get_thread")
+        self._setup_mock_request("get_parent_comment")
+        self._setup_mock_request(function_name)
+        with self.assert_discussion_signals(signal):
+            response = self.client.post(
+                reverse(
+                    view_name,
+                    kwargs={item_id: "dummy", "course_id": str(self.course_id)},
+                )
+            )
+        assert response.status_code == 200
+
 
 @disable_signal(views, "comment_endorsed")
 class ViewPermissionsTestCase(
@@ -843,15 +887,22 @@ def test_comment_actions(self, user, commentable_id, status_code):
         commentable_id = getattr(self, commentable_id)
         self._setup_mock(
             user,
-            ["get_parent_comment", "update_comment_flag"],
+            [
+                "get_parent_comment",
+                "update_comment_flag",
+                "update_comment_votes",
+                "delete_comment_vote",
+            ],
             make_minimal_cs_comment(
                 {
+                    "closed": False,
                     "commentable_id": commentable_id,
                     "course_id": str(self.course.id),
                 }
             ),
         )
-        for action in ["un_flag_abuse_for_comment", "flag_abuse_for_comment"]:
+        # "un_flag_abuse_for_comment", "flag_abuse_for_comment",
+        for action in ["upvote_comment", "downvote_comment"]:
             response = self.client.post(
                 reverse(
                     action,
@@ -873,7 +924,12 @@ def test_threads_actions(self, user, commentable_id, status_code):
         commentable_id = getattr(self, commentable_id)
         self._setup_mock(
             user,
-            ["get_thread", "update_thread_flag"],
+            [
+                "get_thread",
+                "update_thread_flag",
+                "update_thread_votes",
+                "delete_thread_vote",
+            ],
             make_minimal_cs_thread(
                 {
                     "commentable_id": commentable_id,
@@ -882,7 +938,12 @@ def test_threads_actions(self, user, commentable_id, status_code):
             ),
         )
 
-        for action in ["un_flag_abuse_for_thread", "flag_abuse_for_thread"]:
+        for action in [
+            "un_flag_abuse_for_thread",
+            "flag_abuse_for_thread",
+            "upvote_thread",
+            "downvote_thread",
+        ]:
             response = self.client.post(
                 reverse(
                     action,
@@ -893,3 +954,87 @@ def test_threads_actions(self, user, commentable_id, status_code):
                 )
             )
             assert response.status_code == status_code
+
+
+@disable_signal(views, "comment_created")
+@ddt.ddt
+class ForumEventTestCase(
+    ForumsEnableMixin, SharedModuleStoreTestCase, MockForumApiMixin
+):
+    """
+    Forum actions are expected to launch analytics events. Test these here.
+    """
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClassAndForumMock()
+        # pylint: disable=super-method-not-called
+        with super().setUpClassAndTestData():
+            cls.course = CourseFactory.create()
+
+    @classmethod
+    def tearDownClass(cls):
+        """Stop patches after tests complete."""
+        super().tearDownClass()
+        super().disposeForumMocks()
+
+    @classmethod
+    def setUpTestData(cls):
+        super().setUpTestData()
+
+        seed_permissions_roles(cls.course.id)
+
+        cls.student = UserFactory.create()
+        CourseEnrollmentFactory(user=cls.student, course_id=cls.course.id)
+        cls.student.roles.add(Role.objects.get(name="Student", course_id=cls.course.id))
+        CourseAccessRoleFactory(
+            course_id=cls.course.id, user=cls.student, role="Wizard"
+        )
+
+    @ddt.data(
+        ("vote_for_thread", "update_thread_votes", "thread_id", "thread"),
+        ("undo_vote_for_thread", "delete_thread_vote", "thread_id", "thread"),
+        ("vote_for_comment", "update_comment_votes", "comment_id", "response"),
+        ("undo_vote_for_comment", "delete_comment_vote", "comment_id", "response"),
+    )
+    @ddt.unpack
+    @patch("eventtracking.tracker.emit")
+    def test_thread_voted_event(
+        self, view_name, function_name, obj_id_name, obj_type, mock_emit
+    ):
+        undo = view_name.startswith("undo")
+        cs_thread = make_minimal_cs_thread(
+            {
+                "commentable_id": "test_commentable_id",
+                "username": "gumprecht",
+            }
+        )
+        cs_comment = make_minimal_cs_comment(
+            {
+                "closed": False,
+                "commentable_id": "test_commentable_id",
+                "username": "gumprecht",
+            }
+        )
+        self.set_mock_return_value("get_thread", cs_thread)
+        self.set_mock_return_value("get_parent_comment", cs_comment)
+        self.set_mock_return_value(
+            function_name, cs_thread if "thread" in view_name else cs_comment
+        )
+
+        request = RequestFactory().post("dummy_url", {})
+        request.user = self.student
+        request.view_name = view_name
+        view_function = getattr(views, view_name)
+        kwargs = dict(course_id=str(self.course.id))
+        kwargs[obj_id_name] = obj_id_name
+        if not undo:
+            kwargs.update(value="up")
+        view_function(request, **kwargs)
+
+        assert mock_emit.called
+        event_name, event = mock_emit.call_args[0]
+        assert event_name == f"edx.forum.{obj_type}.voted"
+        assert event["target_username"] == "gumprecht"
+        assert event["undo_vote"] == undo
+        assert event["vote_value"] == "up"

lms/djangoapps/discussion/django_comment_client/tests/mixins.py

@@ -8,6 +8,8 @@
 class MockForumApiMixin:
     """Mixin to mock forum_api across different test cases with a single mock instance."""
 
+    users_map = {}
+
     @classmethod
     def setUpClassAndForumMock(cls):
         """