mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 15:03:34 +00:00
b9e62c7af8
For spectators, the chunk of page_params that originates from do_events_register isn’t assigned until ui_init.js. That means the TypeScript type of page_params is mostly a lie during module load time: reading a parameter too early silently results in undefined rather than the declared type, with unpredictable results later on. We want to make such an early read into an immediate runtime error, for both users and spectators consistently, and pave the way for runtime validation of the page_params type. As a second step, split out the subset of fields that pertain to the entire realm. Signed-off-by: Anders Kaseorg <anders@zulip.com>
304 lines
9.4 KiB
JavaScript
304 lines
9.4 KiB
JavaScript
"use strict";
|
|
|
|
const {strict: assert} = require("assert");
|
|
|
|
const events = require("./lib/events");
|
|
const {mock_esm, zrequire} = require("./lib/namespace");
|
|
const {make_stub} = require("./lib/stub");
|
|
const {run_test, noop} = require("./lib/test");
|
|
const blueslip = require("./lib/zblueslip");
|
|
const {realm} = require("./lib/zpage_params");
|
|
|
|
const event_fixtures = events.fixtures;
|
|
const test_user = events.test_user;
|
|
|
|
const message_lists = mock_esm("../src/message_lists");
|
|
const narrow_state = mock_esm("../src/narrow_state");
|
|
const overlays = mock_esm("../src/overlays");
|
|
const settings_org = mock_esm("../src/settings_org");
|
|
const settings_streams = mock_esm("../src/settings_streams");
|
|
const stream_events = mock_esm("../src/stream_events");
|
|
const stream_list = mock_esm("../src/stream_list");
|
|
const stream_settings_ui = mock_esm("../src/stream_settings_ui");
|
|
message_lists.current = {};
|
|
|
|
const compose_recipient = zrequire("compose_recipient");
|
|
const compose_state = zrequire("compose_state");
|
|
const peer_data = zrequire("peer_data");
|
|
const people = zrequire("people");
|
|
const server_events_dispatch = zrequire("server_events_dispatch");
|
|
const stream_data = zrequire("stream_data");
|
|
const sub_store = zrequire("sub_store");
|
|
|
|
people.add_active_user(test_user);
|
|
|
|
const me = {
|
|
email: "me@zulip.com",
|
|
full_name: "Me Myself",
|
|
user_id: 101,
|
|
};
|
|
people.add_active_user(me);
|
|
people.initialize_current_user(me.user_id);
|
|
|
|
const dispatch = server_events_dispatch.dispatch_normal_event;
|
|
|
|
function test(label, f) {
|
|
run_test(label, (helpers) => {
|
|
stream_data.clear_subscriptions();
|
|
f(helpers);
|
|
});
|
|
}
|
|
|
|
test("add", ({override}) => {
|
|
const event = event_fixtures.subscription__add;
|
|
|
|
const sub = event.subscriptions[0];
|
|
const stream_id = sub.stream_id;
|
|
|
|
stream_data.add_sub({
|
|
stream_id,
|
|
name: sub.name,
|
|
});
|
|
|
|
const subscription_stub = make_stub();
|
|
override(stream_events, "mark_subscribed", subscription_stub.f);
|
|
dispatch(event);
|
|
assert.equal(subscription_stub.num_calls, 1);
|
|
const args = subscription_stub.get_args("sub", "subscribers");
|
|
assert.deepEqual(args.sub.stream_id, stream_id);
|
|
assert.deepEqual(args.subscribers, event.subscriptions[0].subscribers);
|
|
});
|
|
|
|
test("peer add/remove", ({override}) => {
|
|
let event = event_fixtures.subscription__peer_add;
|
|
|
|
stream_data.add_sub({
|
|
name: "devel",
|
|
stream_id: event.stream_ids[0],
|
|
});
|
|
|
|
const stream_stub = make_stub();
|
|
override(stream_events, "process_subscriber_update", stream_stub.f);
|
|
|
|
dispatch(event);
|
|
assert.equal(stream_stub.num_calls, 1);
|
|
|
|
assert.ok(peer_data.is_user_subscribed(event.stream_ids[0], event.user_ids[0]));
|
|
|
|
event = event_fixtures.subscription__peer_remove;
|
|
dispatch(event);
|
|
assert.equal(stream_stub.num_calls, 2);
|
|
|
|
assert.ok(!peer_data.is_user_subscribed(event.stream_ids[0], event.user_ids[0]));
|
|
});
|
|
|
|
test("remove", ({override}) => {
|
|
const event = event_fixtures.subscription__remove;
|
|
const event_sub = event.subscriptions[0];
|
|
const stream_id = event_sub.stream_id;
|
|
|
|
const sub = {
|
|
stream_id,
|
|
name: event_sub.name,
|
|
};
|
|
|
|
stream_data.add_sub(sub);
|
|
|
|
const stub = make_stub();
|
|
override(stream_events, "mark_unsubscribed", stub.f);
|
|
dispatch(event);
|
|
assert.equal(stub.num_calls, 1);
|
|
const args = stub.get_args("sub");
|
|
assert.deepEqual(args.sub, sub);
|
|
});
|
|
|
|
test("update", ({override}) => {
|
|
const event = event_fixtures.subscription__update;
|
|
|
|
const stub = make_stub();
|
|
override(stream_events, "update_property", stub.f);
|
|
dispatch(event);
|
|
assert.equal(stub.num_calls, 1);
|
|
const args = stub.get_args("stream_id", "property", "value");
|
|
assert.deepEqual(args.stream_id, event.stream_id);
|
|
assert.deepEqual(args.property, event.property);
|
|
assert.deepEqual(args.value, event.value);
|
|
});
|
|
|
|
test("add error handling", () => {
|
|
// test blueslip errors/warns
|
|
const event = event_fixtures.subscription__add;
|
|
|
|
blueslip.expect("error", "Subscribing to unknown stream");
|
|
dispatch(event);
|
|
blueslip.reset();
|
|
});
|
|
|
|
test("peer event error handling (bad stream_ids/user_ids)", ({override}) => {
|
|
override(stream_events, "process_subscriber_update", noop);
|
|
|
|
const add_event = {
|
|
type: "subscription",
|
|
op: "peer_add",
|
|
stream_ids: [8888, 9999],
|
|
user_ids: [3333, 4444],
|
|
};
|
|
|
|
blueslip.expect("warn", "We have untracked stream_ids: 8888,9999");
|
|
blueslip.expect("warn", "We have untracked user_ids");
|
|
dispatch(add_event);
|
|
blueslip.reset();
|
|
|
|
const remove_event = {
|
|
type: "subscription",
|
|
op: "peer_remove",
|
|
stream_ids: [8888, 9999],
|
|
user_ids: [3333, 4444],
|
|
};
|
|
|
|
blueslip.expect("warn", "We have untracked stream_ids: 8888,9999");
|
|
blueslip.expect("warn", "We have untracked user_ids");
|
|
dispatch(remove_event);
|
|
});
|
|
|
|
test("stream update", ({override}) => {
|
|
const event = event_fixtures.stream__update;
|
|
|
|
const stub = make_stub();
|
|
override(stream_events, "update_property", stub.f);
|
|
override(settings_streams, "update_default_streams_table", noop);
|
|
override(stream_list, "update_subscribe_to_more_streams_link", noop);
|
|
dispatch(event);
|
|
assert.equal(stub.num_calls, 1);
|
|
const args = stub.get_args("stream_id", "property", "value");
|
|
assert.equal(args.stream_id, event.stream_id);
|
|
assert.equal(args.property, event.property);
|
|
assert.equal(args.value, event.value);
|
|
});
|
|
|
|
test("stream create", ({override}) => {
|
|
assert.equal(sub_store.get(101), undefined);
|
|
assert.equal(sub_store.get(102), undefined);
|
|
|
|
const event = event_fixtures.stream__create;
|
|
|
|
override(stream_settings_ui, "add_sub_to_table", noop);
|
|
override(stream_list, "update_subscribe_to_more_streams_link", noop);
|
|
override(overlays, "streams_open", () => true);
|
|
dispatch(event);
|
|
|
|
assert.deepEqual(sub_store.get(101).name, "devel");
|
|
assert.deepEqual(sub_store.get(102).name, "test");
|
|
});
|
|
|
|
test("stream delete (normal)", ({override}) => {
|
|
const event = event_fixtures.stream__delete;
|
|
|
|
for (const stream of event.streams) {
|
|
stream_data.add_sub(stream);
|
|
}
|
|
|
|
stream_data.subscribe_myself(event.streams[0]);
|
|
|
|
override(settings_streams, "update_default_streams_table", noop);
|
|
|
|
narrow_state.is_for_stream_id = () => true;
|
|
|
|
let bookend_updates = 0;
|
|
override(message_lists.current, "update_trailing_bookend", () => {
|
|
bookend_updates += 1;
|
|
});
|
|
|
|
const removed_stream_ids = [];
|
|
|
|
override(stream_settings_ui, "remove_stream", (stream_id) => {
|
|
removed_stream_ids.push(stream_id);
|
|
});
|
|
|
|
let removed_sidebar_rows = 0;
|
|
override(stream_list, "remove_sidebar_row", () => {
|
|
removed_sidebar_rows += 1;
|
|
});
|
|
override(stream_list, "update_subscribe_to_more_streams_link", noop);
|
|
|
|
dispatch(event);
|
|
|
|
assert.deepEqual(removed_stream_ids, [event.streams[0].stream_id, event.streams[1].stream_id]);
|
|
|
|
// We should possibly be able to make a single call to
|
|
// update_trailing_bookend, but we currently do it for each stream.
|
|
assert.equal(bookend_updates, 2);
|
|
|
|
assert.equal(removed_sidebar_rows, 1);
|
|
});
|
|
|
|
test("stream delete (special streams)", ({override}) => {
|
|
const event = event_fixtures.stream__delete;
|
|
|
|
for (const stream of event.streams) {
|
|
stream_data.add_sub(stream);
|
|
}
|
|
|
|
// sanity check data
|
|
assert.equal(event.streams.length, 2);
|
|
realm.realm_notifications_stream_id = event.streams[0].stream_id;
|
|
realm.realm_signup_notifications_stream_id = event.streams[1].stream_id;
|
|
|
|
override(stream_settings_ui, "remove_stream", noop);
|
|
override(settings_org, "sync_realm_settings", noop);
|
|
override(settings_streams, "update_default_streams_table", noop);
|
|
override(message_lists.current, "update_trailing_bookend", noop);
|
|
override(stream_list, "remove_sidebar_row", noop);
|
|
override(stream_list, "update_subscribe_to_more_streams_link", noop);
|
|
|
|
dispatch(event);
|
|
|
|
assert.equal(realm.realm_notifications_stream_id, -1);
|
|
assert.equal(realm.realm_signup_notifications_stream_id, -1);
|
|
});
|
|
|
|
test("stream delete (stream is selected in compose)", ({override, override_rewire}) => {
|
|
override_rewire(compose_recipient, "on_compose_select_recipient_update", noop);
|
|
|
|
const event = event_fixtures.stream__delete;
|
|
|
|
for (const stream of event.streams) {
|
|
stream_data.add_sub(stream);
|
|
}
|
|
|
|
stream_data.subscribe_myself(event.streams[0]);
|
|
compose_state.set_stream_id(event.streams[0].stream_id);
|
|
|
|
override(settings_streams, "update_default_streams_table", noop);
|
|
|
|
narrow_state.is_for_stream_id = () => true;
|
|
|
|
let bookend_updates = 0;
|
|
override(message_lists.current, "update_trailing_bookend", () => {
|
|
bookend_updates += 1;
|
|
});
|
|
|
|
const removed_stream_ids = [];
|
|
|
|
override(stream_settings_ui, "remove_stream", (stream_id) => {
|
|
removed_stream_ids.push(stream_id);
|
|
});
|
|
|
|
let removed_sidebar_rows = 0;
|
|
override(stream_list, "remove_sidebar_row", () => {
|
|
removed_sidebar_rows += 1;
|
|
});
|
|
override(stream_list, "update_subscribe_to_more_streams_link", noop);
|
|
|
|
dispatch(event);
|
|
|
|
assert.equal(compose_state.stream_name(), "");
|
|
assert.deepEqual(removed_stream_ids, [event.streams[0].stream_id, event.streams[1].stream_id]);
|
|
|
|
// We should possibly be able to make a single call to
|
|
// update_trailing_bookend, but we currently do it for each stream.
|
|
assert.equal(bookend_updates, 2);
|
|
|
|
assert.equal(removed_sidebar_rows, 1);
|
|
});
|