mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	Adding a reaction is now a PUT request to /messages/<message_id>/emoji_reactions/<emoji_name> Similarly, removing a reaction is now a DELETE request to /messages/<message_id>/emoji_reactions/<emoji_name> This commit changes the url and updates the views and tests. This commit also adds a test for invalid emoji when removing reaction.
		
			
				
	
	
		
			251 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			251 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
# -*- coding: utf-8 -*-
 | 
						|
from __future__ import absolute_import
 | 
						|
 | 
						|
import ujson
 | 
						|
from typing import Any, Dict, List
 | 
						|
from six import string_types
 | 
						|
 | 
						|
from zerver.lib.test_helpers import tornado_redirected_to_list, get_display_recipient
 | 
						|
from zerver.lib.test_classes import ZulipTestCase
 | 
						|
from zerver.models import get_user_profile_by_email
 | 
						|
 | 
						|
class ReactionEmojiTest(ZulipTestCase):
 | 
						|
    def test_missing_emoji(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Sending reaction without emoji fails
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_put('/api/v1/messages/1/emoji_reactions',
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assertEquals(result.status_code, 404)
 | 
						|
 | 
						|
    def test_add_invalid_emoji(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Sending invalid emoji fails
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_put('/api/v1/messages/1/emoji_reactions/foo',
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assert_json_error(result, "Emoji 'foo' does not exist")
 | 
						|
 | 
						|
    def test_remove_invalid_emoji(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Removing invalid emoji fails
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_delete('/api/v1/messages/1/emoji_reactions/foo',
 | 
						|
                                    **self.api_auth(sender))
 | 
						|
        self.assert_json_error(result, "Emoji 'foo' does not exist")
 | 
						|
 | 
						|
    def test_valid_emoji(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Reacting with valid emoji succeeds
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_put('/api/v1/messages/1/emoji_reactions/smile',
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        self.assertEqual(200, result.status_code)
 | 
						|
 | 
						|
    def test_valid_realm_emoji(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Reacting with valid realm emoji succeeds
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        emoji_name = 'my_emoji'
 | 
						|
        emoji_data = {'name': emoji_name, 'url': 'https://example.com/my_emoji'}
 | 
						|
        result = self.client_put('/json/realm/emoji', info=emoji_data,
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        self.assertEqual(200, result.status_code)
 | 
						|
 | 
						|
        result = self.client_get("/json/realm/emoji", **self.api_auth(sender))
 | 
						|
        content = ujson.loads(result.content)
 | 
						|
        self.assert_json_success(result)
 | 
						|
        self.assertTrue(emoji_name in content["emoji"])
 | 
						|
 | 
						|
        result = self.client_put('/api/v1/messages/1/emoji_reactions/%s' % (emoji_name,),
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
 | 
						|
class ReactionMessageIDTest(ZulipTestCase):
 | 
						|
    def test_missing_message_id(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Reacting without a message_id fails
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_put('/api/v1/messages//emoji_reactions/smile',
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assertEquals(result.status_code, 404)
 | 
						|
 | 
						|
    def test_invalid_message_id(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Reacting to an invalid message id fails
 | 
						|
        """
 | 
						|
        sender = 'hamlet@zulip.com'
 | 
						|
        result = self.client_put('/api/v1/messages/-1/emoji_reactions/smile',
 | 
						|
                                 **self.api_auth(sender))
 | 
						|
        self.assertEquals(result.status_code, 404)
 | 
						|
 | 
						|
    def test_inaccessible_message_id(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Reacting to a inaccessible (for instance, private) message fails
 | 
						|
        """
 | 
						|
        pm_sender = 'hamlet@zulip.com'
 | 
						|
        pm_recipient = 'othello@zulip.com'
 | 
						|
        reaction_sender = 'iago@zulip.com'
 | 
						|
 | 
						|
        result = self.client_post("/api/v1/messages", {"type": "private",
 | 
						|
                                                       "content": "Test message",
 | 
						|
                                                       "to": pm_recipient},
 | 
						|
                                  **self.api_auth(pm_sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        content = ujson.loads(result.content)
 | 
						|
        pm_id = content['id']
 | 
						|
        result = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                 **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_error(result, "Invalid message(s)")
 | 
						|
 | 
						|
class ReactionTest(ZulipTestCase):
 | 
						|
    def test_add_existing_reaction(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Creating the same reaction twice fails
 | 
						|
        """
 | 
						|
        pm_sender = 'hamlet@zulip.com'
 | 
						|
        pm_recipient = 'othello@zulip.com'
 | 
						|
        reaction_sender = pm_recipient
 | 
						|
 | 
						|
        pm = self.client_post("/api/v1/messages", {"type": "private",
 | 
						|
                                                   "content": "Test message",
 | 
						|
                                                   "to": pm_recipient},
 | 
						|
                              **self.api_auth(pm_sender))
 | 
						|
        self.assert_json_success(pm)
 | 
						|
        content = ujson.loads(pm.content)
 | 
						|
 | 
						|
        pm_id = content['id']
 | 
						|
        first = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(first)
 | 
						|
        second = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                 **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_error(second, "Reaction already exists")
 | 
						|
 | 
						|
    def test_remove_nonexisting_reaction(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Removing a reaction twice fails
 | 
						|
        """
 | 
						|
        pm_sender = 'hamlet@zulip.com'
 | 
						|
        pm_recipient = 'othello@zulip.com'
 | 
						|
        reaction_sender = pm_recipient
 | 
						|
 | 
						|
        pm = self.client_post("/api/v1/messages", {"type": "private",
 | 
						|
                                                   "content": "Test message",
 | 
						|
                                                   "to": pm_recipient},
 | 
						|
                              **self.api_auth(pm_sender))
 | 
						|
        self.assert_json_success(pm)
 | 
						|
        content = ujson.loads(pm.content)
 | 
						|
        pm_id = content['id']
 | 
						|
        add = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                              **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(add)
 | 
						|
 | 
						|
        first = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                   **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(first)
 | 
						|
 | 
						|
        second = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                    **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_error(second, "Reaction does not exist")
 | 
						|
 | 
						|
 | 
						|
class ReactionEventTest(ZulipTestCase):
 | 
						|
    def test_add_event(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Recipients of the message receive the reaction event
 | 
						|
        and event contains relevant data
 | 
						|
        """
 | 
						|
        pm_sender = 'hamlet@zulip.com'
 | 
						|
        pm_recipient = 'othello@zulip.com'
 | 
						|
        reaction_sender = pm_recipient
 | 
						|
 | 
						|
        result = self.client_post("/api/v1/messages", {"type": "private",
 | 
						|
                                                       "content": "Test message",
 | 
						|
                                                       "to": pm_recipient},
 | 
						|
                                  **self.api_auth(pm_sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        content = ujson.loads(result.content)
 | 
						|
        pm_id = content['id']
 | 
						|
 | 
						|
        expected_recipient_emails = set([pm_sender, pm_recipient])
 | 
						|
        expected_recipient_ids = set([get_user_profile_by_email(email).id for email in expected_recipient_emails])
 | 
						|
 | 
						|
        events = [] # type: List[Dict[str, Any]]
 | 
						|
        with tornado_redirected_to_list(events):
 | 
						|
            result = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                     **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        self.assertEqual(len(events), 1)
 | 
						|
 | 
						|
        event = events[0]['event']
 | 
						|
        event_user_ids = set(events[0]['users'])
 | 
						|
 | 
						|
        self.assertEqual(expected_recipient_ids, event_user_ids)
 | 
						|
        self.assertEqual(event['user']['email'], reaction_sender)
 | 
						|
        self.assertEqual(event['type'], 'reaction')
 | 
						|
        self.assertEqual(event['op'], 'add')
 | 
						|
        self.assertEqual(event['emoji_name'], 'smile')
 | 
						|
        self.assertEqual(event['message_id'], pm_id)
 | 
						|
 | 
						|
    def test_remove_event(self):
 | 
						|
        # type: () -> None
 | 
						|
        """
 | 
						|
        Recipients of the message receive the reaction event
 | 
						|
        and event contains relevant data
 | 
						|
        """
 | 
						|
        pm_sender = 'hamlet@zulip.com'
 | 
						|
        pm_recipient = 'othello@zulip.com'
 | 
						|
        reaction_sender = pm_recipient
 | 
						|
 | 
						|
        result = self.client_post("/api/v1/messages", {"type": "private",
 | 
						|
                                                       "content": "Test message",
 | 
						|
                                                       "to": pm_recipient},
 | 
						|
                                  **self.api_auth(pm_sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        content = ujson.loads(result.content)
 | 
						|
        pm_id = content['id']
 | 
						|
 | 
						|
        expected_recipient_emails = set([pm_sender, pm_recipient])
 | 
						|
        expected_recipient_ids = set([get_user_profile_by_email(email).id for email in expected_recipient_emails])
 | 
						|
 | 
						|
        add = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                              **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(add)
 | 
						|
 | 
						|
        events = [] # type: List[Dict[str, Any]]
 | 
						|
        with tornado_redirected_to_list(events):
 | 
						|
            result = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
 | 
						|
                                        **self.api_auth(reaction_sender))
 | 
						|
        self.assert_json_success(result)
 | 
						|
        self.assertEqual(len(events), 1)
 | 
						|
 | 
						|
        event = events[0]['event']
 | 
						|
        event_user_ids = set(events[0]['users'])
 | 
						|
 | 
						|
        self.assertEqual(expected_recipient_ids, event_user_ids)
 | 
						|
        self.assertEqual(event['user']['email'], reaction_sender)
 | 
						|
        self.assertEqual(event['type'], 'reaction')
 | 
						|
        self.assertEqual(event['op'], 'remove')
 | 
						|
        self.assertEqual(event['emoji_name'], 'smile')
 | 
						|
        self.assertEqual(event['message_id'], pm_id)
 |