mirror of
https://github.com/zulip/zulip.git
synced 2026-06-12 21:00:58 +08:00
f1b59ec5f5
Currently, our URL encoding in zerver uses `urllib`, which encodes additional characters that are not encoded by our web logic. This results in urls generated by the server not matching the urls encoded during markdown rendering. We add these additional characters which are ! and ' to sync with the zerver url encoding.
98 lines
4.6 KiB
Python
98 lines
4.6 KiB
Python
import os
|
|
|
|
import orjson
|
|
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.url_encoding import (
|
|
encode_channel,
|
|
encode_hash_component,
|
|
encode_user_full_name_and_id,
|
|
encode_user_ids,
|
|
stream_message_url,
|
|
)
|
|
from zerver.models.messages import Message
|
|
from zerver.models.realms import get_realm
|
|
from zerver.models.streams import get_stream
|
|
|
|
|
|
class URLEncodeTest(ZulipTestCase):
|
|
def test_encode_hash_component(self) -> None:
|
|
fixture_path = os.path.join(
|
|
os.path.dirname(__file__), "fixtures/url_encoding_test_cases.json"
|
|
)
|
|
with open(fixture_path, "rb") as f:
|
|
data = orjson.loads(f.read())
|
|
for test in data:
|
|
with self.subTest(name=test["name"]):
|
|
self.assertEqual(encode_hash_component(test["input"]), test["expected_output"])
|
|
|
|
def test_encode_channel(self) -> None:
|
|
# We have more tests for this function in `test_topic_link_utils.py`
|
|
self.assertEqual(encode_channel(9, "Verona"), "9-Verona")
|
|
self.assertEqual(encode_channel(123, "General"), "123-General")
|
|
self.assertEqual(encode_channel(7, "random_channel"), "7-random_channel")
|
|
self.assertEqual(encode_channel(9, "Verona", with_operator=True), "channel/9-Verona")
|
|
|
|
def test_encode_user_ids(self) -> None:
|
|
# Group narrow URL has 3 or more user IDs
|
|
self.assertEqual(encode_user_ids([1, 2, 3]), "1,2,3-group")
|
|
self.assertEqual(encode_user_ids([3, 1, 2]), "1,2,3-group")
|
|
|
|
# One-on-one narrow URL has 2 user IDs
|
|
self.assertEqual(encode_user_ids([1, 2]), "1,2")
|
|
|
|
# Narrow URL to ones own direct message conversation
|
|
self.assertEqual(encode_user_ids([1]), "1")
|
|
|
|
self.assertEqual(encode_user_ids([1, 2, 3], with_operator=True), "dm/1,2,3-group")
|
|
with self.assertRaises(AssertionError):
|
|
encode_user_ids([])
|
|
|
|
def test_encode_user_full_name_and_id(self) -> None:
|
|
self.assertEqual(encode_user_full_name_and_id("King Hamlet", 9), "9-King-Hamlet")
|
|
self.assertEqual(
|
|
encode_user_full_name_and_id("King Hamlet", 9, with_operator=True), "dm/9-King-Hamlet"
|
|
)
|
|
self.assertEqual(encode_user_full_name_and_id("ZOE", 1), "1-ZOE")
|
|
self.assertEqual(encode_user_full_name_and_id(" User Name ", 100), "100-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User Name", 101), "101-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User/Name", 200), "200-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User%Name", 201), "201-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User<Name>", 202), "202-User-Name-")
|
|
self.assertEqual(encode_user_full_name_and_id('User"Name`', 203), "203-User-Name-")
|
|
self.assertEqual(encode_user_full_name_and_id('User/ % < > ` " Name', 204), "204-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User--Name", 205), "205-User--Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User%%Name", 206), "206-User-Name")
|
|
self.assertEqual(encode_user_full_name_and_id("User_Name", 5), "5-User_Name")
|
|
|
|
def test_stream_message_url(self) -> None:
|
|
realm = get_realm("zulip")
|
|
topic = "test topic"
|
|
channel = get_stream("Verona", realm)
|
|
channel_message_id = self.send_stream_message(
|
|
sender=self.example_user("hamlet"), stream_name=channel.name, topic_name=topic
|
|
)
|
|
channel_message = Message.objects.get(id=channel_message_id, realm=realm)
|
|
message_dict = dict(
|
|
id=channel_message_id,
|
|
stream_id=channel.id,
|
|
display_recipient=channel_message.recipient.label(),
|
|
topic=topic,
|
|
)
|
|
channel_message_url = stream_message_url(
|
|
realm,
|
|
message_dict,
|
|
)
|
|
expected_channel_message_url = f"{realm.url}/#narrow/{encode_channel(channel.id, channel.name, True)}/topic/{encode_hash_component(topic)}/near/{channel_message_id}"
|
|
self.assertEqual(channel_message_url, expected_channel_message_url)
|
|
|
|
relative_channel_message_url = stream_message_url(
|
|
realm, message_dict, include_base_url=False
|
|
)
|
|
expected_relative_channel_message_url = f"#narrow/{encode_channel(channel.id, channel.name, True)}/topic/{encode_hash_component(topic)}/near/{channel_message_id}"
|
|
self.assertEqual(relative_channel_message_url, expected_relative_channel_message_url)
|
|
|
|
with self.assertRaises(ValueError) as e:
|
|
stream_message_url(realm=None, message=message_dict, include_base_url=True)
|
|
self.assertEqual(str(e.exception), "realm is required when include_base_url=True")
|