mirror of https://github.com/zulip/zulip.git
878 lines
36 KiB
Python
878 lines
36 KiB
Python
import time
|
|
from typing import Any, Callable, Dict, List
|
|
from unittest import mock
|
|
|
|
import orjson
|
|
from django.conf import settings
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.lib.actions import check_send_message, do_change_user_role, do_set_realm_property
|
|
from zerver.lib.events import fetch_initial_state_data, get_raw_user_data
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.test_helpers import POSTRequestMock, queries_captured, stub_event_queue_user_events
|
|
from zerver.lib.users import get_api_key
|
|
from zerver.models import (
|
|
Realm,
|
|
UserMessage,
|
|
UserProfile,
|
|
flush_per_request_caches,
|
|
get_client,
|
|
get_realm,
|
|
get_stream,
|
|
get_system_bot,
|
|
)
|
|
from zerver.tornado.event_queue import (
|
|
allocate_client_descriptor,
|
|
clear_client_event_queues_for_testing,
|
|
get_client_info_for_message_event,
|
|
process_message_event,
|
|
)
|
|
from zerver.tornado.views import get_events
|
|
from zerver.views.events_register import _default_all_public_streams, _default_narrow
|
|
|
|
|
|
class EventsEndpointTest(ZulipTestCase):
|
|
def test_events_register_endpoint(self) -> None:
|
|
|
|
# This test is intended to get minimal coverage on the
|
|
# events_register code paths
|
|
user = self.example_user("hamlet")
|
|
with mock.patch('zerver.views.events_register.do_events_register', return_value={}):
|
|
result = self.api_post(user, '/json/register')
|
|
self.assert_json_success(result)
|
|
|
|
with mock.patch('zerver.lib.events.request_event_queue', return_value=None):
|
|
result = self.api_post(user, '/json/register')
|
|
self.assert_json_error(result, "Could not allocate event queue")
|
|
|
|
return_event_queue = '15:11'
|
|
return_user_events: List[Dict[str, Any]] = []
|
|
|
|
# We choose realm_emoji somewhat randomly--we want
|
|
# a "boring" event type for the purpose of this test.
|
|
event_type = 'realm_emoji'
|
|
test_event = dict(
|
|
id=6,
|
|
type=event_type,
|
|
realm_emoji=[]
|
|
)
|
|
|
|
# Test that call is made to deal with a returning soft deactivated user.
|
|
with mock.patch('zerver.lib.events.reactivate_user_if_soft_deactivated') as fa:
|
|
with stub_event_queue_user_events(return_event_queue, return_user_events):
|
|
result = self.api_post(user, '/json/register', dict(event_types=orjson.dumps([event_type]).decode()))
|
|
self.assertEqual(fa.call_count, 1)
|
|
|
|
with stub_event_queue_user_events(return_event_queue, return_user_events):
|
|
result = self.api_post(user, '/json/register', dict(event_types=orjson.dumps([event_type]).decode()))
|
|
|
|
self.assert_json_success(result)
|
|
result_dict = result.json()
|
|
self.assertEqual(result_dict['last_event_id'], -1)
|
|
self.assertEqual(result_dict['queue_id'], '15:11')
|
|
|
|
# Now start simulating returning actual data
|
|
return_event_queue = '15:12'
|
|
return_user_events = [test_event]
|
|
|
|
with stub_event_queue_user_events(return_event_queue, return_user_events):
|
|
result = self.api_post(user, '/json/register', dict(event_types=orjson.dumps([event_type]).decode()))
|
|
|
|
self.assert_json_success(result)
|
|
result_dict = result.json()
|
|
self.assertEqual(result_dict['last_event_id'], 6)
|
|
self.assertEqual(result_dict['queue_id'], '15:12')
|
|
|
|
# sanity check the data relevant to our event
|
|
self.assertEqual(result_dict['realm_emoji'], [])
|
|
|
|
# Now test with `fetch_event_types` not matching the event
|
|
return_event_queue = '15:13'
|
|
with stub_event_queue_user_events(return_event_queue, return_user_events):
|
|
result = self.api_post(user, '/json/register',
|
|
dict(event_types=orjson.dumps([event_type]).decode(),
|
|
fetch_event_types=orjson.dumps(['message']).decode()))
|
|
self.assert_json_success(result)
|
|
result_dict = result.json()
|
|
self.assertEqual(result_dict['last_event_id'], 6)
|
|
# Check that the message event types data is in there
|
|
self.assertIn('max_message_id', result_dict)
|
|
|
|
# Check that our original event type is not there.
|
|
self.assertNotIn(event_type, result_dict)
|
|
self.assertEqual(result_dict['queue_id'], '15:13')
|
|
|
|
# Now test with `fetch_event_types` matching the event
|
|
with stub_event_queue_user_events(return_event_queue, return_user_events):
|
|
result = self.api_post(user, '/json/register',
|
|
dict(fetch_event_types=orjson.dumps([event_type]).decode(),
|
|
event_types=orjson.dumps(['message']).decode()))
|
|
self.assert_json_success(result)
|
|
result_dict = result.json()
|
|
self.assertEqual(result_dict['last_event_id'], 6)
|
|
# Check that we didn't fetch the messages data
|
|
self.assertNotIn('max_message_id', result_dict)
|
|
|
|
# Check that the realm_emoji data is in there.
|
|
self.assertIn('realm_emoji', result_dict)
|
|
self.assertEqual(result_dict['realm_emoji'], [])
|
|
self.assertEqual(result_dict['queue_id'], '15:13')
|
|
|
|
def test_tornado_endpoint(self) -> None:
|
|
|
|
# This test is mostly intended to get minimal coverage on
|
|
# the /notify_tornado endpoint, so we can have 100% URL coverage,
|
|
# but it does exercise a little bit of the codepath.
|
|
post_data = dict(
|
|
data=orjson.dumps(
|
|
dict(
|
|
event=dict(
|
|
type='other',
|
|
),
|
|
users=[self.example_user('hamlet').id],
|
|
),
|
|
).decode(),
|
|
)
|
|
req = POSTRequestMock(post_data, user_profile=None)
|
|
req.META['REMOTE_ADDR'] = '127.0.0.1'
|
|
result = self.client_post_request('/notify_tornado', req)
|
|
self.assert_json_error(result, 'Access denied', status_code=403)
|
|
|
|
post_data['secret'] = settings.SHARED_SECRET
|
|
req = POSTRequestMock(post_data, user_profile=None)
|
|
req.META['REMOTE_ADDR'] = '127.0.0.1'
|
|
result = self.client_post_request('/notify_tornado', req)
|
|
self.assert_json_success(result)
|
|
|
|
class GetEventsTest(ZulipTestCase):
|
|
def tornado_call(self, view_func: Callable[[HttpRequest, UserProfile], HttpResponse],
|
|
user_profile: UserProfile,
|
|
post_data: Dict[str, Any]) -> HttpResponse:
|
|
request = POSTRequestMock(post_data, user_profile)
|
|
return view_func(request, user_profile)
|
|
|
|
def test_get_events(self) -> None:
|
|
user_profile = self.example_user('hamlet')
|
|
email = user_profile.email
|
|
recipient_user_profile = self.example_user('othello')
|
|
recipient_email = recipient_user_profile.email
|
|
self.login_user(user_profile)
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"apply_markdown": orjson.dumps(True).decode(),
|
|
"client_gravatar": orjson.dumps(True).decode(),
|
|
"event_types": orjson.dumps(["message"]).decode(),
|
|
"user_client": "website",
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
self.assert_json_success(result)
|
|
queue_id = orjson.loads(result.content)["queue_id"]
|
|
|
|
recipient_result = self.tornado_call(get_events, recipient_user_profile,
|
|
{"apply_markdown": orjson.dumps(True).decode(),
|
|
"client_gravatar": orjson.dumps(True).decode(),
|
|
"event_types": orjson.dumps(["message"]).decode(),
|
|
"user_client": "website",
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
self.assert_json_success(recipient_result)
|
|
recipient_queue_id = orjson.loads(recipient_result.content)["queue_id"]
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"queue_id": queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": -1,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
events = orjson.loads(result.content)["events"]
|
|
self.assert_json_success(result)
|
|
self.assert_length(events, 0)
|
|
|
|
local_id = '10.01'
|
|
check_send_message(
|
|
sender=user_profile,
|
|
client=get_client('whatever'),
|
|
message_type_name='private',
|
|
message_to=[recipient_email],
|
|
topic_name=None,
|
|
message_content='hello',
|
|
local_id=local_id,
|
|
sender_queue_id=queue_id,
|
|
)
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"queue_id": queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": -1,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
events = orjson.loads(result.content)["events"]
|
|
self.assert_json_success(result)
|
|
self.assert_length(events, 1)
|
|
self.assertEqual(events[0]["type"], "message")
|
|
self.assertEqual(events[0]["message"]["sender_email"], email)
|
|
self.assertEqual(events[0]["local_message_id"], local_id)
|
|
self.assertEqual(events[0]["message"]["display_recipient"][0]["is_mirror_dummy"], False)
|
|
self.assertEqual(events[0]["message"]["display_recipient"][1]["is_mirror_dummy"], False)
|
|
|
|
last_event_id = events[0]["id"]
|
|
local_id = '10.02'
|
|
|
|
check_send_message(
|
|
sender=user_profile,
|
|
client=get_client('whatever'),
|
|
message_type_name='private',
|
|
message_to=[recipient_email],
|
|
topic_name=None,
|
|
message_content='hello',
|
|
local_id=local_id,
|
|
sender_queue_id=queue_id,
|
|
)
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"queue_id": queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": last_event_id,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
events = orjson.loads(result.content)["events"]
|
|
self.assert_json_success(result)
|
|
self.assert_length(events, 1)
|
|
self.assertEqual(events[0]["type"], "message")
|
|
self.assertEqual(events[0]["message"]["sender_email"], email)
|
|
self.assertEqual(events[0]["local_message_id"], local_id)
|
|
|
|
# Test that the received message in the receiver's event queue
|
|
# exists and does not contain a local id
|
|
recipient_result = self.tornado_call(get_events, recipient_user_profile,
|
|
{"queue_id": recipient_queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": -1,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
recipient_events = orjson.loads(recipient_result.content)["events"]
|
|
self.assert_json_success(recipient_result)
|
|
self.assertEqual(len(recipient_events), 2)
|
|
self.assertEqual(recipient_events[0]["type"], "message")
|
|
self.assertEqual(recipient_events[0]["message"]["sender_email"], email)
|
|
self.assertTrue("local_message_id" not in recipient_events[0])
|
|
self.assertEqual(recipient_events[1]["type"], "message")
|
|
self.assertEqual(recipient_events[1]["message"]["sender_email"], email)
|
|
self.assertTrue("local_message_id" not in recipient_events[1])
|
|
|
|
def test_get_events_narrow(self) -> None:
|
|
user_profile = self.example_user('hamlet')
|
|
self.login_user(user_profile)
|
|
|
|
def get_message(apply_markdown: bool, client_gravatar: bool) -> Dict[str, Any]:
|
|
result = self.tornado_call(
|
|
get_events,
|
|
user_profile,
|
|
dict(
|
|
apply_markdown=orjson.dumps(apply_markdown).decode(),
|
|
client_gravatar=orjson.dumps(client_gravatar).decode(),
|
|
event_types=orjson.dumps(["message"]).decode(),
|
|
narrow=orjson.dumps([["stream", "denmark"]]).decode(),
|
|
user_client="website",
|
|
dont_block=orjson.dumps(True).decode(),
|
|
),
|
|
)
|
|
|
|
self.assert_json_success(result)
|
|
queue_id = orjson.loads(result.content)["queue_id"]
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"queue_id": queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": -1,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
events = orjson.loads(result.content)["events"]
|
|
self.assert_json_success(result)
|
|
self.assert_length(events, 0)
|
|
|
|
self.send_personal_message(user_profile, self.example_user("othello"), "hello")
|
|
self.send_stream_message(user_profile, "Denmark", "**hello**")
|
|
|
|
result = self.tornado_call(get_events, user_profile,
|
|
{"queue_id": queue_id,
|
|
"user_client": "website",
|
|
"last_event_id": -1,
|
|
"dont_block": orjson.dumps(True).decode(),
|
|
})
|
|
events = orjson.loads(result.content)["events"]
|
|
self.assert_json_success(result)
|
|
self.assert_length(events, 1)
|
|
self.assertEqual(events[0]["type"], "message")
|
|
return events[0]['message']
|
|
|
|
message = get_message(apply_markdown=False, client_gravatar=False)
|
|
self.assertEqual(message["display_recipient"], "Denmark")
|
|
self.assertEqual(message["content"], "**hello**")
|
|
self.assertTrue(message["avatar_url"].startswith("https://secure.gravatar.com"))
|
|
|
|
message = get_message(apply_markdown=True, client_gravatar=False)
|
|
self.assertEqual(message["display_recipient"], "Denmark")
|
|
self.assertEqual(message["content"], "<p><strong>hello</strong></p>")
|
|
self.assertIn('gravatar.com', message["avatar_url"])
|
|
|
|
message = get_message(apply_markdown=False, client_gravatar=True)
|
|
self.assertEqual(message["display_recipient"], "Denmark")
|
|
self.assertEqual(message["content"], "**hello**")
|
|
self.assertEqual(message["avatar_url"], None)
|
|
|
|
message = get_message(apply_markdown=True, client_gravatar=True)
|
|
self.assertEqual(message["display_recipient"], "Denmark")
|
|
self.assertEqual(message["content"], "<p><strong>hello</strong></p>")
|
|
self.assertEqual(message["avatar_url"], None)
|
|
|
|
class FetchInitialStateDataTest(ZulipTestCase):
|
|
# Non-admin users don't have access to all bots
|
|
def test_realm_bots_non_admin(self) -> None:
|
|
user_profile = self.example_user('cordelia')
|
|
self.assertFalse(user_profile.is_realm_admin)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
self.assert_length(result['realm_bots'], 0)
|
|
|
|
# additionally the API key for a random bot is not present in the data
|
|
api_key = get_api_key(self.notification_bot())
|
|
self.assertNotIn(api_key, str(result))
|
|
|
|
# Admin users have access to all bots in the realm_bots field
|
|
def test_realm_bots_admin(self) -> None:
|
|
user_profile = self.example_user('hamlet')
|
|
do_change_user_role(user_profile, UserProfile.ROLE_REALM_ADMINISTRATOR)
|
|
self.assertTrue(user_profile.is_realm_admin)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
self.assertTrue(len(result['realm_bots']) > 2)
|
|
|
|
def test_max_message_id_with_no_history(self) -> None:
|
|
user_profile = self.example_user('aaron')
|
|
# Delete all historical messages for this user
|
|
UserMessage.objects.filter(user_profile=user_profile).delete()
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
self.assertEqual(result['max_message_id'], -1)
|
|
|
|
def test_delivery_email_presence_for_non_admins(self) -> None:
|
|
user_profile = self.example_user('aaron')
|
|
self.assertFalse(user_profile.is_realm_admin)
|
|
|
|
do_set_realm_property(user_profile.realm, "email_address_visibility",
|
|
Realm.EMAIL_ADDRESS_VISIBILITY_EVERYONE)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
for key, value in result['raw_users'].items():
|
|
self.assertNotIn('delivery_email', value)
|
|
|
|
do_set_realm_property(user_profile.realm, "email_address_visibility",
|
|
Realm.EMAIL_ADDRESS_VISIBILITY_ADMINS)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
for key, value in result['raw_users'].items():
|
|
self.assertNotIn('delivery_email', value)
|
|
|
|
def test_delivery_email_presence_for_admins(self) -> None:
|
|
user_profile = self.example_user('iago')
|
|
self.assertTrue(user_profile.is_realm_admin)
|
|
|
|
do_set_realm_property(user_profile.realm, "email_address_visibility",
|
|
Realm.EMAIL_ADDRESS_VISIBILITY_EVERYONE)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
for key, value in result['raw_users'].items():
|
|
self.assertNotIn('delivery_email', value)
|
|
|
|
do_set_realm_property(user_profile.realm, "email_address_visibility",
|
|
Realm.EMAIL_ADDRESS_VISIBILITY_ADMINS)
|
|
result = fetch_initial_state_data(user_profile, None, "", client_gravatar=False, user_avatar_url_field_optional=False, realm=user_profile.realm)
|
|
for key, value in result['raw_users'].items():
|
|
self.assertIn('delivery_email', value)
|
|
|
|
def test_user_avatar_url_field_optional(self) -> None:
|
|
hamlet = self.example_user('hamlet')
|
|
users = [
|
|
self.example_user('iago'),
|
|
self.example_user('cordelia'),
|
|
self.example_user('ZOE'),
|
|
self.example_user('othello'),
|
|
]
|
|
|
|
for user in users:
|
|
user.long_term_idle = True
|
|
user.save()
|
|
|
|
long_term_idle_users_ids = [user.id for user in users]
|
|
|
|
result = fetch_initial_state_data(user_profile=hamlet,
|
|
event_types=None,
|
|
queue_id='',
|
|
client_gravatar=False,
|
|
user_avatar_url_field_optional=True,
|
|
realm=hamlet.realm)
|
|
|
|
raw_users = result['raw_users']
|
|
|
|
for user_dict in raw_users.values():
|
|
if user_dict['user_id'] in long_term_idle_users_ids:
|
|
self.assertFalse('avatar_url' in user_dict)
|
|
else:
|
|
self.assertIsNotNone(user_dict['avatar_url'])
|
|
|
|
gravatar_users_id = [user_dict['user_id'] for user_dict in raw_users.values()
|
|
if 'avatar_url' in user_dict and 'gravatar.com' in user_dict['avatar_url']]
|
|
|
|
# Test again with client_gravatar = True
|
|
result = fetch_initial_state_data(user_profile=hamlet,
|
|
event_types=None,
|
|
queue_id='',
|
|
client_gravatar=True,
|
|
user_avatar_url_field_optional=True,
|
|
realm=hamlet.realm)
|
|
|
|
raw_users = result['raw_users']
|
|
|
|
for user_dict in raw_users.values():
|
|
if user_dict['user_id'] in gravatar_users_id:
|
|
self.assertIsNone(user_dict['avatar_url'])
|
|
else:
|
|
self.assertFalse('avatar_url' in user_dict)
|
|
|
|
class ClientDescriptorsTest(ZulipTestCase):
|
|
def test_get_client_info_for_all_public_streams(self) -> None:
|
|
hamlet = self.example_user('hamlet')
|
|
realm = hamlet.realm
|
|
|
|
queue_data = dict(
|
|
all_public_streams=True,
|
|
apply_markdown=True,
|
|
client_gravatar=True,
|
|
client_type_name='website',
|
|
event_types=['message'],
|
|
last_connection_time=time.time(),
|
|
queue_timeout=0,
|
|
realm_id=realm.id,
|
|
user_profile_id=hamlet.id,
|
|
)
|
|
|
|
client = allocate_client_descriptor(queue_data)
|
|
|
|
message_event = dict(
|
|
realm_id=realm.id,
|
|
stream_name='whatever',
|
|
)
|
|
|
|
client_info = get_client_info_for_message_event(
|
|
message_event,
|
|
users=[],
|
|
)
|
|
|
|
self.assertEqual(len(client_info), 1)
|
|
|
|
dct = client_info[client.event_queue.id]
|
|
self.assertEqual(dct['client'].apply_markdown, True)
|
|
self.assertEqual(dct['client'].client_gravatar, True)
|
|
self.assertEqual(dct['client'].user_profile_id, hamlet.id)
|
|
self.assertEqual(dct['flags'], [])
|
|
self.assertEqual(dct['is_sender'], False)
|
|
|
|
message_event = dict(
|
|
realm_id=realm.id,
|
|
stream_name='whatever',
|
|
sender_queue_id=client.event_queue.id,
|
|
)
|
|
|
|
client_info = get_client_info_for_message_event(
|
|
message_event,
|
|
users=[],
|
|
)
|
|
dct = client_info[client.event_queue.id]
|
|
self.assertEqual(dct['is_sender'], True)
|
|
|
|
def test_get_client_info_for_normal_users(self) -> None:
|
|
hamlet = self.example_user('hamlet')
|
|
cordelia = self.example_user('cordelia')
|
|
realm = hamlet.realm
|
|
|
|
def test_get_info(apply_markdown: bool, client_gravatar: bool) -> None:
|
|
clear_client_event_queues_for_testing()
|
|
|
|
queue_data = dict(
|
|
all_public_streams=False,
|
|
apply_markdown=apply_markdown,
|
|
client_gravatar=client_gravatar,
|
|
client_type_name='website',
|
|
event_types=['message'],
|
|
last_connection_time=time.time(),
|
|
queue_timeout=0,
|
|
realm_id=realm.id,
|
|
user_profile_id=hamlet.id,
|
|
)
|
|
|
|
client = allocate_client_descriptor(queue_data)
|
|
message_event = dict(
|
|
realm_id=realm.id,
|
|
stream_name='whatever',
|
|
)
|
|
|
|
client_info = get_client_info_for_message_event(
|
|
message_event,
|
|
users=[
|
|
dict(id=cordelia.id),
|
|
],
|
|
)
|
|
|
|
self.assertEqual(len(client_info), 0)
|
|
|
|
client_info = get_client_info_for_message_event(
|
|
message_event,
|
|
users=[
|
|
dict(id=cordelia.id),
|
|
dict(id=hamlet.id, flags=['mentioned']),
|
|
],
|
|
)
|
|
self.assertEqual(len(client_info), 1)
|
|
|
|
dct = client_info[client.event_queue.id]
|
|
self.assertEqual(dct['client'].apply_markdown, apply_markdown)
|
|
self.assertEqual(dct['client'].client_gravatar, client_gravatar)
|
|
self.assertEqual(dct['client'].user_profile_id, hamlet.id)
|
|
self.assertEqual(dct['flags'], ['mentioned'])
|
|
self.assertEqual(dct['is_sender'], False)
|
|
|
|
test_get_info(apply_markdown=False, client_gravatar=False)
|
|
test_get_info(apply_markdown=True, client_gravatar=False)
|
|
|
|
test_get_info(apply_markdown=False, client_gravatar=True)
|
|
test_get_info(apply_markdown=True, client_gravatar=True)
|
|
|
|
def test_process_message_event_with_mocked_client_info(self) -> None:
|
|
hamlet = self.example_user("hamlet")
|
|
|
|
class MockClient:
|
|
def __init__(self, user_profile_id: int,
|
|
apply_markdown: bool,
|
|
client_gravatar: bool) -> None:
|
|
self.user_profile_id = user_profile_id
|
|
self.apply_markdown = apply_markdown
|
|
self.client_gravatar = client_gravatar
|
|
self.client_type_name = 'whatever'
|
|
self.events: List[Dict[str, Any]] = []
|
|
|
|
def accepts_messages(self) -> bool:
|
|
return True
|
|
|
|
def accepts_event(self, event: Dict[str, Any]) -> bool:
|
|
assert(event['type'] == 'message')
|
|
return True
|
|
|
|
def add_event(self, event: Dict[str, Any]) -> None:
|
|
self.events.append(event)
|
|
|
|
client1 = MockClient(
|
|
user_profile_id=hamlet.id,
|
|
apply_markdown=True,
|
|
client_gravatar=False,
|
|
)
|
|
|
|
client2 = MockClient(
|
|
user_profile_id=hamlet.id,
|
|
apply_markdown=False,
|
|
client_gravatar=False,
|
|
)
|
|
|
|
client3 = MockClient(
|
|
user_profile_id=hamlet.id,
|
|
apply_markdown=True,
|
|
client_gravatar=True,
|
|
)
|
|
|
|
client4 = MockClient(
|
|
user_profile_id=hamlet.id,
|
|
apply_markdown=False,
|
|
client_gravatar=True,
|
|
)
|
|
|
|
client_info = {
|
|
'client:1': dict(
|
|
client=client1,
|
|
flags=['starred'],
|
|
),
|
|
'client:2': dict(
|
|
client=client2,
|
|
flags=['has_alert_word'],
|
|
),
|
|
'client:3': dict(
|
|
client=client3,
|
|
flags=[],
|
|
),
|
|
'client:4': dict(
|
|
client=client4,
|
|
flags=[],
|
|
),
|
|
}
|
|
|
|
sender = hamlet
|
|
|
|
message_event = dict(
|
|
message_dict=dict(
|
|
id=999,
|
|
content='**hello**',
|
|
rendered_content='<b>hello</b>',
|
|
sender_id=sender.id,
|
|
type='stream',
|
|
client='website',
|
|
|
|
# NOTE: Some of these fields are clutter, but some
|
|
# will be useful when we let clients specify
|
|
# that they can compute their own gravatar URLs.
|
|
sender_email=sender.email,
|
|
sender_delivery_email=sender.delivery_email,
|
|
sender_realm_id=sender.realm_id,
|
|
sender_avatar_source=UserProfile.AVATAR_FROM_GRAVATAR,
|
|
sender_avatar_version=1,
|
|
sender_is_mirror_dummy=None,
|
|
recipient_type=None,
|
|
recipient_type_id=None,
|
|
),
|
|
)
|
|
|
|
# Setting users to `[]` bypasses code we don't care about
|
|
# for this test--we assume client_info is correct in our mocks,
|
|
# and we are interested in how messages are put on event queue.
|
|
users: List[Dict[str, Any]] = []
|
|
|
|
with mock.patch('zerver.tornado.event_queue.get_client_info_for_message_event',
|
|
return_value=client_info):
|
|
process_message_event(message_event, users)
|
|
|
|
# We are not closely examining avatar_url at this point, so
|
|
# just sanity check them and then delete the keys so that
|
|
# upcoming comparisons work.
|
|
for client in [client1, client2]:
|
|
message = client.events[0]['message']
|
|
self.assertIn('gravatar.com', message['avatar_url'])
|
|
message.pop('avatar_url')
|
|
|
|
self.assertEqual(client1.events, [
|
|
dict(
|
|
type='message',
|
|
message=dict(
|
|
type='stream',
|
|
sender_id=sender.id,
|
|
sender_email=sender.email,
|
|
id=999,
|
|
content='<b>hello</b>',
|
|
content_type='text/html',
|
|
client='website',
|
|
),
|
|
flags=['starred'],
|
|
),
|
|
])
|
|
|
|
self.assertEqual(client2.events, [
|
|
dict(
|
|
type='message',
|
|
message=dict(
|
|
type='stream',
|
|
sender_id=sender.id,
|
|
sender_email=sender.email,
|
|
id=999,
|
|
content='**hello**',
|
|
content_type='text/x-markdown',
|
|
client='website',
|
|
),
|
|
flags=['has_alert_word'],
|
|
),
|
|
])
|
|
|
|
self.assertEqual(client3.events, [
|
|
dict(
|
|
type='message',
|
|
message=dict(
|
|
type='stream',
|
|
sender_id=sender.id,
|
|
sender_email=sender.email,
|
|
avatar_url=None,
|
|
id=999,
|
|
content='<b>hello</b>',
|
|
content_type='text/html',
|
|
client='website',
|
|
),
|
|
flags=[],
|
|
),
|
|
])
|
|
|
|
self.assertEqual(client4.events, [
|
|
dict(
|
|
type='message',
|
|
message=dict(
|
|
type='stream',
|
|
sender_id=sender.id,
|
|
sender_email=sender.email,
|
|
avatar_url=None,
|
|
id=999,
|
|
content='**hello**',
|
|
content_type='text/x-markdown',
|
|
client='website',
|
|
),
|
|
flags=[],
|
|
),
|
|
])
|
|
|
|
class FetchQueriesTest(ZulipTestCase):
|
|
def test_queries(self) -> None:
|
|
user = self.example_user("hamlet")
|
|
|
|
self.login_user(user)
|
|
|
|
flush_per_request_caches()
|
|
with queries_captured() as queries:
|
|
with mock.patch('zerver.lib.events.always_want') as want_mock:
|
|
fetch_initial_state_data(
|
|
user_profile=user,
|
|
event_types=None,
|
|
queue_id='x',
|
|
client_gravatar=False,
|
|
user_avatar_url_field_optional=False,
|
|
realm=user.realm,
|
|
)
|
|
|
|
self.assert_length(queries, 29)
|
|
|
|
expected_counts = dict(
|
|
alert_words=1,
|
|
custom_profile_fields=1,
|
|
default_streams=1,
|
|
default_stream_groups=1,
|
|
hotspots=0,
|
|
message=1,
|
|
muted_topics=1,
|
|
presence=1,
|
|
realm=0,
|
|
realm_bot=1,
|
|
realm_domains=1,
|
|
realm_embedded_bots=0,
|
|
realm_incoming_webhook_bots=0,
|
|
realm_emoji=1,
|
|
realm_filters=1,
|
|
realm_user=3,
|
|
realm_user_groups=2,
|
|
recent_private_conversations=1,
|
|
starred_messages=1,
|
|
stream=2,
|
|
stop_words=0,
|
|
subscription=4,
|
|
update_display_settings=0,
|
|
update_global_notifications=0,
|
|
update_message_flags=5,
|
|
user_status=1,
|
|
video_calls=0,
|
|
)
|
|
|
|
wanted_event_types = {
|
|
item[0][0] for item
|
|
in want_mock.call_args_list
|
|
}
|
|
|
|
self.assertEqual(wanted_event_types, set(expected_counts))
|
|
|
|
for event_type in sorted(wanted_event_types):
|
|
count = expected_counts[event_type]
|
|
flush_per_request_caches()
|
|
with queries_captured() as queries:
|
|
if event_type == 'update_message_flags':
|
|
event_types = ['update_message_flags', 'message']
|
|
else:
|
|
event_types = [event_type]
|
|
|
|
fetch_initial_state_data(
|
|
user_profile=user,
|
|
event_types=event_types,
|
|
queue_id='x',
|
|
client_gravatar=False,
|
|
user_avatar_url_field_optional=False,
|
|
realm=user.realm,
|
|
)
|
|
self.assert_length(queries, count)
|
|
|
|
|
|
class TestEventsRegisterAllPublicStreamsDefaults(ZulipTestCase):
|
|
def setUp(self) -> None:
|
|
super().setUp()
|
|
self.user_profile = self.example_user('hamlet')
|
|
self.email = self.user_profile.email
|
|
|
|
def test_use_passed_all_public_true_default_false(self) -> None:
|
|
self.user_profile.default_all_public_streams = False
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, True)
|
|
self.assertTrue(result)
|
|
|
|
def test_use_passed_all_public_true_default(self) -> None:
|
|
self.user_profile.default_all_public_streams = True
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, True)
|
|
self.assertTrue(result)
|
|
|
|
def test_use_passed_all_public_false_default_false(self) -> None:
|
|
self.user_profile.default_all_public_streams = False
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, False)
|
|
self.assertFalse(result)
|
|
|
|
def test_use_passed_all_public_false_default_true(self) -> None:
|
|
self.user_profile.default_all_public_streams = True
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, False)
|
|
self.assertFalse(result)
|
|
|
|
def test_use_true_default_for_none(self) -> None:
|
|
self.user_profile.default_all_public_streams = True
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, None)
|
|
self.assertTrue(result)
|
|
|
|
def test_use_false_default_for_none(self) -> None:
|
|
self.user_profile.default_all_public_streams = False
|
|
self.user_profile.save()
|
|
result = _default_all_public_streams(self.user_profile, None)
|
|
self.assertFalse(result)
|
|
|
|
class TestEventsRegisterNarrowDefaults(ZulipTestCase):
|
|
def setUp(self) -> None:
|
|
super().setUp()
|
|
self.user_profile = self.example_user('hamlet')
|
|
self.email = self.user_profile.email
|
|
self.stream = get_stream('Verona', self.user_profile.realm)
|
|
|
|
def test_use_passed_narrow_no_default(self) -> None:
|
|
self.user_profile.default_events_register_stream_id = None
|
|
self.user_profile.save()
|
|
result = _default_narrow(self.user_profile, [['stream', 'my_stream']])
|
|
self.assertEqual(result, [['stream', 'my_stream']])
|
|
|
|
def test_use_passed_narrow_with_default(self) -> None:
|
|
self.user_profile.default_events_register_stream_id = self.stream.id
|
|
self.user_profile.save()
|
|
result = _default_narrow(self.user_profile, [['stream', 'my_stream']])
|
|
self.assertEqual(result, [['stream', 'my_stream']])
|
|
|
|
def test_use_default_if_narrow_is_empty(self) -> None:
|
|
self.user_profile.default_events_register_stream_id = self.stream.id
|
|
self.user_profile.save()
|
|
result = _default_narrow(self.user_profile, [])
|
|
self.assertEqual(result, [['stream', 'Verona']])
|
|
|
|
def test_use_narrow_if_default_is_none(self) -> None:
|
|
self.user_profile.default_events_register_stream_id = None
|
|
self.user_profile.save()
|
|
result = _default_narrow(self.user_profile, [])
|
|
self.assertEqual(result, [])
|
|
|
|
class TestGetRawUserDataSystemBotRealm(ZulipTestCase):
|
|
def test_get_raw_user_data_on_system_bot_realm(self) -> None:
|
|
result = get_raw_user_data(get_realm("zulipinternal"), self.example_user('hamlet'),
|
|
client_gravatar=True, user_avatar_url_field_optional=True)
|
|
|
|
for bot_email in settings.CROSS_REALM_BOT_EMAILS:
|
|
bot_profile = get_system_bot(bot_email)
|
|
self.assertTrue(bot_profile.id in result)
|
|
self.assertTrue(result[bot_profile.id]['is_cross_realm_bot'])
|