web_public_view: Replace `web_public_visitor` with `spectator`.

We use `spectator` term instead of `web_public_visitor` as it is
more concise and better represents this type of users.
This commit is contained in:
Aman Agrawal 2021-06-15 16:03:32 +00:00 committed by Tim Abbott
parent 512229cf7d
commit 64f04e9913
10 changed files with 27 additions and 27 deletions

View File

@ -641,7 +641,7 @@ test("electron_bridge", (override) => {
}); });
}); });
test("test_send_or_receive_no_presence_for_web_public_visitor", () => { test("test_send_or_receive_no_presence_for_spectator", () => {
page_params.is_web_public_visitor = true; page_params.is_spectator = true;
activity.send_presence_to_server(); activity.send_presence_to_server();
}); });

View File

@ -183,7 +183,7 @@ export function send_presence_to_server(want_redraw) {
// which will clear suspect_offline and potentially trigger a // which will clear suspect_offline and potentially trigger a
// reload if the device was offline for more than // reload if the device was offline for more than
// DEFAULT_EVENT_QUEUE_TIMEOUT_SECS). // DEFAULT_EVENT_QUEUE_TIMEOUT_SECS).
if (page_params.is_web_public_visitor) { if (page_params.is_spectator) {
return; return;
} }

View File

@ -176,9 +176,9 @@ function get_events({dont_block = false} = {}) {
} }
// TODO: In the future, we may implement Tornado support for live // TODO: In the future, we may implement Tornado support for live
// update for web_public_visitor, but until then, there's nothing // update for spectator, but until then, there's nothing
// to do here. // to do here.
if (page_params.is_web_public_visitor) { if (page_params.is_spectator) {
return; return;
} }

View File

@ -913,7 +913,7 @@ def zulip_otp_required(
""" """
:if_configured: If ``True``, an authenticated user with no confirmed :if_configured: If ``True``, an authenticated user with no confirmed
OTP devices will be allowed. Also, non-authenticated users will be OTP devices will be allowed. Also, non-authenticated users will be
allowed as web_public_visitor users. Default is ``False``. If ``False``, allowed as spectator users. Default is ``False``. If ``False``,
2FA will not do any authentication. 2FA will not do any authentication.
""" """
if_configured = settings.TWO_FACTOR_AUTHENTICATION_ENABLED if_configured = settings.TWO_FACTOR_AUTHENTICATION_ENABLED

View File

@ -152,9 +152,9 @@ def build_page_params_for_home_page_load(
include_streams=False, include_streams=False,
) )
else: else:
# Since events for web_public_visitor is not implemented, we only fetch the data # Since events for spectator is not implemented, we only fetch the data
# at the time of request and don't register for any events. # at the time of request and don't register for any events.
# TODO: Implement events for web_public_visitor. # TODO: Implement events for spectator.
from zerver.lib.events import fetch_initial_state_data, post_process_state from zerver.lib.events import fetch_initial_state_data, post_process_state
register_ret = fetch_initial_state_data( register_ret = fetch_initial_state_data(
@ -215,9 +215,9 @@ def build_page_params_for_home_page_load(
# Adding two_fa_enabled as condition saves us 3 queries when # Adding two_fa_enabled as condition saves us 3 queries when
# 2FA is not enabled. # 2FA is not enabled.
two_fa_enabled_user=two_fa_enabled and bool(default_device(user_profile)), two_fa_enabled_user=two_fa_enabled and bool(default_device(user_profile)),
is_web_public_visitor=user_profile is None, is_spectator=user_profile is None,
# There is no event queue for web_public_visitors since # There is no event queue for spectators since
# events support for web_public_visitors is not implemented yet. # events support for spectators is not implemented yet.
no_event_queue=user_profile is None, no_event_queue=user_profile is None,
# Required for about_zulip.hbs # Required for about_zulip.hbs
zulip_merge_base=ZULIP_MERGE_BASE, zulip_merge_base=ZULIP_MERGE_BASE,

View File

@ -507,22 +507,22 @@ Output:
def check_rendered_logged_in_app(self, result: HttpResponse) -> None: def check_rendered_logged_in_app(self, result: HttpResponse) -> None:
"""Verifies that a visit of / was a 200 that rendered page_params """Verifies that a visit of / was a 200 that rendered page_params
and not for a logged-out web-public visitor.""" and not for a (logged-out) spectator."""
self.assertEqual(result.status_code, 200) self.assertEqual(result.status_code, 200)
page_params = self._get_page_params(result) page_params = self._get_page_params(result)
# It is important to check `is_web_public_visitor` to verify # It is important to check `is_spectator` to verify
# that we treated this request as a normal logged-in session, # that we treated this request as a normal logged-in session,
# not as a web-public visitor. # not as a spectator.
self.assertEqual(page_params["is_web_public_visitor"], False) self.assertEqual(page_params["is_spectator"], False)
def check_rendered_web_public_visitor(self, result: HttpResponse) -> None: def check_rendered_spectator(self, result: HttpResponse) -> None:
"""Verifies that a visit of / was a 200 that rendered page_params """Verifies that a visit of / was a 200 that rendered page_params
for a logged-out web-public visitor.""" for a (logged-out) spectator."""
self.assertEqual(result.status_code, 200) self.assertEqual(result.status_code, 200)
page_params = self._get_page_params(result) page_params = self._get_page_params(result)
# It is important to check `is_web_public_visitor` to verify # It is important to check `is_spectator` to verify
# that we treated this request to render for a `web_public_visitor` # that we treated this request to render for a `spectator`
self.assertEqual(page_params["is_web_public_visitor"], True) self.assertEqual(page_params["is_spectator"], True)
def login_with_return( def login_with_return(
self, email: str, password: Optional[str] = None, **kwargs: Any self, email: str, password: Optional[str] = None, **kwargs: Any

View File

@ -1121,7 +1121,7 @@ paths:
description: | description: |
Note: Only present if the changed property was `invite_only`. Note: Only present if the changed property was `invite_only`.
Whether the stream's history is now readable by web-public visitors. Whether the stream's history is now readable by web-public spectators.
**Changes**: New in Zulip 5.0 (feature level 71). **Changes**: New in Zulip 5.0 (feature level 71).
additionalProperties: false additionalProperties: false

View File

@ -104,7 +104,7 @@ class HomeTest(ZulipTestCase):
"is_guest", "is_guest",
"is_moderator", "is_moderator",
"is_owner", "is_owner",
"is_web_public_visitor", "is_spectator",
"jitsi_server_url", "jitsi_server_url",
"language_list", "language_list",
"language_list_dbl_col", "language_list_dbl_col",

View File

@ -28,7 +28,7 @@ class TestSessions(ZulipTestCase):
action() action()
if expected_result: if expected_result:
result = self.client_get("/", subdomain=realm.subdomain) result = self.client_get("/", subdomain=realm.subdomain)
self.check_rendered_web_public_visitor(result) self.check_rendered_spectator(result)
else: else:
self.assertIn("_auth_user_id", self.client.session) self.assertIn("_auth_user_id", self.client.session)
@ -39,7 +39,7 @@ class TestSessions(ZulipTestCase):
for session in user_sessions(user_profile): for session in user_sessions(user_profile):
delete_session(session) delete_session(session)
result = self.client_get("/") result = self.client_get("/")
self.check_rendered_web_public_visitor(result) self.check_rendered_spectator(result)
def test_delete_user_sessions(self) -> None: def test_delete_user_sessions(self) -> None:
user_profile = self.example_user("hamlet") user_profile = self.example_user("hamlet")
@ -87,7 +87,7 @@ class TestSessions(ZulipTestCase):
self.client_post("/accounts/logout/") self.client_post("/accounts/logout/")
delete_all_deactivated_user_sessions() delete_all_deactivated_user_sessions()
result = self.client_get("/") result = self.client_get("/")
self.check_rendered_web_public_visitor(result) self.check_rendered_spectator(result)
# Test nothing happens to an active user's session # Test nothing happens to an active user's session
self.login("othello") self.login("othello")
@ -106,7 +106,7 @@ class TestSessions(ZulipTestCase):
info_logs.output, ["INFO:root:Deactivating session for deactivated user 8"] info_logs.output, ["INFO:root:Deactivating session for deactivated user 8"]
) )
result = self.client_get("/") result = self.client_get("/")
self.check_rendered_web_public_visitor(result) self.check_rendered_spectator(result)
class TestExpirableSessionVars(ZulipTestCase): class TestExpirableSessionVars(ZulipTestCase):

View File

@ -1095,7 +1095,7 @@ def get_messages_backend(
message_ids: List[int] = [] message_ids: List[int] = []
user_message_flags: Dict[int, List[str]] = {} user_message_flags: Dict[int, List[str]] = {}
if is_web_public_query: if is_web_public_query:
# For web-public users, we treat all historical messages as read. # For spectators, we treat all historical messages as read.
for row in rows: for row in rows:
message_id = row[0] message_id = row[0]
message_ids.append(message_id) message_ids.append(message_id)