zulip/frontend_tests/node_tests/dispatch.js

"use strict";

const {strict: assert} = require("assert");

const {mock_cjs, mock_esm, set_global, with_field, zrequire} = require("../zjsunit/namespace");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const blueslip = require("../zjsunit/zblueslip");
const $ = require("../zjsunit/zjquery");
const {page_params} = require("../zjsunit/zpage_params");

const noop = () => {};

const events = require("./lib/events");

const event_fixtures = events.fixtures;
const test_message = events.test_message;
const test_user = events.test_user;
const typing_person1 = events.typing_person1;

set_global("setTimeout", (func) => func());

mock_cjs("jquery", $);
const activity = mock_esm("../../static/js/activity");
const alert_words_ui = mock_esm("../../static/js/alert_words_ui");
const attachments_ui = mock_esm("../../static/js/attachments_ui");
const bot_data = mock_esm("../../static/js/bot_data");
const composebox_typeahead = mock_esm("../../static/js/composebox_typeahead");
const emoji_picker = mock_esm("../../static/js/emoji_picker");
const hotspots = mock_esm("../../static/js/hotspots");
const markdown = mock_esm("../../static/js/markdown");
const message_edit = mock_esm("../../static/js/message_edit");
const message_events = mock_esm("../../static/js/message_events");
const message_list = mock_esm("../../static/js/message_list");
const message_lists = mock_esm("../../static/js/message_lists");
const muting_ui = mock_esm("../../static/js/muting_ui");
const night_mode = mock_esm("../../static/js/night_mode");
const notifications = mock_esm("../../static/js/notifications");
const reactions = mock_esm("../../static/js/reactions");
const realm_icon = mock_esm("../../static/js/realm_icon");
const realm_logo = mock_esm("../../static/js/realm_logo");
const reload = mock_esm("../../static/js/reload");
const scroll_bar = mock_esm("../../static/js/scroll_bar");
const settings_account = mock_esm("../../static/js/settings_account");
const settings_bots = mock_esm("../../static/js/settings_bots");
const settings_display = mock_esm("../../static/js/settings_display");
const settings_emoji = mock_esm("../../static/js/settings_emoji");
const settings_exports = mock_esm("../../static/js/settings_exports");
const settings_invites = mock_esm("../../static/js/settings_invites");
const settings_linkifiers = mock_esm("../../static/js/settings_linkifiers");
const settings_notifications = mock_esm("../../static/js/settings_notifications");
const settings_org = mock_esm("../../static/js/settings_org");
const settings_profile_fields = mock_esm("../../static/js/settings_profile_fields");
const settings_streams = mock_esm("../../static/js/settings_streams");
const settings_user_groups = mock_esm("../../static/js/settings_user_groups");
const settings_users = mock_esm("../../static/js/settings_users");
const stream_data = mock_esm("../../static/js/stream_data");
const stream_events = mock_esm("../../static/js/stream_events");
const submessage = mock_esm("../../static/js/submessage");
const typing_events = mock_esm("../../static/js/typing_events");
const ui = mock_esm("../../static/js/ui");
const unread_ops = mock_esm("../../static/js/unread_ops");
const user_events = mock_esm("../../static/js/user_events");
const user_groups = mock_esm("../../static/js/user_groups");
mock_esm("../../static/js/compose");

const electron_bridge = set_global("electron_bridge", {});

message_lists.current = {};
message_lists.home = {};

// page_params is highly coupled to dispatching now

page_params.test_suite = false;
page_params.is_admin = true;
page_params.realm_description = "already set description";

// For data-oriented modules, just use them, don't stub them.
const alert_words = zrequire("alert_words");
const stream_topic_history = zrequire("stream_topic_history");
const stream_list = zrequire("stream_list");
const message_helper = zrequire("message_helper");
const message_store = zrequire("message_store");
const people = zrequire("people");
const starred_messages = zrequire("starred_messages");
const user_status = zrequire("user_status");

const emoji = zrequire("../shared/js/emoji");

const server_events_dispatch = zrequire("server_events_dispatch");

function dispatch(ev) {
    server_events_dispatch.dispatch_normal_event(ev);
}

people.init();
people.add_active_user(test_user);

message_helper.process_new_message(test_message);

const realm_emoji = {};
const emoji_codes = zrequire("../generated/emoji/emoji_codes.json");

emoji.initialize({realm_emoji, emoji_codes});

function assert_same(actual, expected) {
    // This helper prevents us from getting false positives
    // where actual and expected are both undefined.
    assert(expected !== undefined);
    assert.deepEqual(actual, expected);
}

run_test("alert_words", (override) => {
    alert_words.initialize({alert_words: []});
    assert(!alert_words.has_alert_word("fire"));
    assert(!alert_words.has_alert_word("lunch"));

    override(alert_words_ui, "render_alert_words_ui", noop);
    const event = event_fixtures.alert_words;
    dispatch(event);

    assert.deepEqual(alert_words.get_word_list(), ["fire", "lunch"]);
    assert(alert_words.has_alert_word("fire"));
    assert(alert_words.has_alert_word("lunch"));
});

run_test("attachments", (override) => {
    const event = event_fixtures.attachment__add;
    const stub = make_stub();
    // attachments_ui is hard to test deeply
    override(attachments_ui, "update_attachments", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    assert_same(stub.get_args("event").event, event);
});

run_test("user groups", (override) => {
    let event = event_fixtures.user_group__add;
    override(settings_user_groups, "reload", noop);
    {
        const stub = make_stub();
        override(user_groups, "add", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("group");
        assert_same(args.group, event.group);
    }

    event = event_fixtures.user_group__remove;
    {
        const stub = make_stub();
        override(user_groups, "get_user_group_from_id", stub.f);
        override(user_groups, "remove", noop);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("group_id");
        assert_same(args.group_id, event.group_id);
    }

    event = event_fixtures.user_group__add_members;
    {
        const stub = make_stub();
        override(user_groups, "add_members", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("group_id", "user_ids");
        assert_same(args.group_id, event.group_id);
        assert_same(args.user_ids, event.user_ids);
    }

    event = event_fixtures.user_group__remove_members;
    {
        const stub = make_stub();
        override(user_groups, "remove_members", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("group_id", "user_ids");
        assert_same(args.group_id, event.group_id);
        assert_same(args.user_ids, event.user_ids);
    }

    event = event_fixtures.user_group__update;
    {
        const stub = make_stub();
        override(user_groups, "update", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("event");
        assert_same(args.event.group_id, event.group_id);
        assert_same(args.event.data.name, event.data.name);
        assert_same(args.event.data.description, event.data.description);
    }
});

run_test("custom profile fields", (override) => {
    const event = event_fixtures.custom_profile_fields;
    override(settings_profile_fields, "populate_profile_fields", noop);
    override(settings_account, "add_custom_profile_fields_to_settings", noop);
    dispatch(event);
    assert_same(page_params.custom_profile_fields, event.fields);
});

run_test("default_streams", (override) => {
    const event = event_fixtures.default_streams;
    override(settings_streams, "update_default_streams_table", noop);
    const stub = make_stub();
    override(stream_data, "set_realm_default_streams", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("realm_default_streams");
    assert_same(args.realm_default_streams, event.default_streams);
});

run_test("hotspots", (override) => {
    page_params.hotspots = [];
    const event = event_fixtures.hotspots;
    override(hotspots, "load_new", noop);
    dispatch(event);
    assert_same(page_params.hotspots, event.hotspots);
});

run_test("invites_changed", (override) => {
    $.create("#admin-invites-list", {children: ["stub"]});
    const event = event_fixtures.invites_changed;
    const stub = make_stub();
    override(settings_invites, "set_up", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
});

run_test("muted_topics", (override) => {
    const event = event_fixtures.muted_topics;

    const stub = make_stub();
    override(muting_ui, "handle_topic_updates", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("muted_topics");
    assert_same(args.muted_topics, event.muted_topics);
});

run_test("muted_users", (override) => {
    const event = event_fixtures.muted_users;

    const stub = make_stub();
    override(muting_ui, "handle_user_updates", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("muted_users");
    assert_same(args.muted_users, event.muted_users);
});

run_test("presence", (override) => {
    const event = event_fixtures.presence;

    const stub = make_stub();
    override(activity, "update_presence_info", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("user_id", "presence", "server_time");
    assert_same(args.user_id, event.user_id);
    assert_same(args.presence, event.presence);
    assert_same(args.server_time, event.server_timestamp);
});

run_test("reaction", (override) => {
    let event = event_fixtures.reaction__add;
    {
        const stub = make_stub();
        override(reactions, "add_reaction", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("event");
        assert_same(args.event.emoji_name, event.emoji_name);
        assert_same(args.event.message_id, event.message_id);
    }

    event = event_fixtures.reaction__remove;
    {
        const stub = make_stub();
        override(reactions, "remove_reaction", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("event");
        assert_same(args.event.emoji_name, event.emoji_name);
        assert_same(args.event.message_id, event.message_id);
    }
});

run_test("realm settings", (override) => {
    page_params.is_admin = true;

    override(settings_org, "sync_realm_settings", noop);
    override(settings_bots, "update_bot_permissions_ui", noop);
    override(notifications, "redraw_title", noop);

    function test_electron_dispatch(event, fake_send_event) {
        let called = false;

        with_field(electron_bridge, "send_event", fake_send_event, () => {
            dispatch(event);
            called = true;
        });

        assert(called);
    }

    // realm
    function test_realm_boolean(event, parameter_name) {
        page_params[parameter_name] = true;
        event = {...event};
        event.value = false;
        dispatch(event);
        assert.equal(page_params[parameter_name], false);
        event = {...event};
        event.value = true;
        dispatch(event);
        assert.equal(page_params[parameter_name], true);
    }

    function test_realm_integer(event, parameter_name) {
        page_params[parameter_name] = 1;
        event = {...event};
        event.value = 2;
        dispatch(event);
        assert.equal(page_params[parameter_name], 2);

        event = {...event};
        event.value = 3;
        dispatch(event);
        assert.equal(page_params[parameter_name], 3);

        event = {...event};
        event.value = 1;
        dispatch(event);
        assert.equal(page_params[parameter_name], 1);
    }

    let event = event_fixtures.realm__update__create_stream_policy;
    test_realm_integer(event, "realm_create_stream_policy");

    event = event_fixtures.realm__update__invite_to_stream_policy;
    test_realm_integer(event, "realm_invite_to_stream_policy");

    event = event_fixtures.realm__update__bot_creation_policy;
    test_realm_integer(event, "realm_bot_creation_policy");

    event = event_fixtures.realm__update__invite_required;
    test_realm_boolean(event, "realm_invite_required");

    event = event_fixtures.realm__update__invite_to_realm_policy;
    test_realm_integer(event, "realm_invite_to_realm_policy");

    event = event_fixtures.realm__update__name;

    test_electron_dispatch(event, (key, val) => {
        assert_same(key, "realm_name");
        assert_same(val, "new_realm_name");
    });
    assert_same(page_params.realm_name, "new_realm_name");

    event = event_fixtures.realm__update__emails_restricted_to_domains;
    test_realm_boolean(event, "realm_emails_restricted_to_domains");

    event = event_fixtures.realm__update__disallow_disposable_email_addresses;
    test_realm_boolean(event, "realm_disallow_disposable_email_addresses");

    event = event_fixtures.realm__update__default_twenty_four_hour_time;
    test_realm_boolean(event, "realm_default_twenty_four_hour_time");

    event = event_fixtures.realm__update__email_addresses_visibility;
    dispatch(event);
    assert_same(page_params.realm_email_address_visibility, 3);

    event = event_fixtures.realm__update__notifications_stream_id;
    dispatch(event);
    assert_same(page_params.realm_notifications_stream_id, 42);
    page_params.realm_notifications_stream_id = -1; // make sure to reset for future tests

    event = event_fixtures.realm__update__signup_notifications_stream_id;
    dispatch(event);
    assert_same(page_params.realm_signup_notifications_stream_id, 41);
    page_params.realm_signup_notifications_stream_id = -1; // make sure to reset for future tests

    event = event_fixtures.realm__update__default_code_block_language;
    dispatch(event);
    assert_same(page_params.realm_default_code_block_language, "javascript");

    event = event_fixtures.realm__update_dict__default;
    page_params.realm_allow_message_editing = false;
    page_params.realm_message_content_edit_limit_seconds = 0;
    override(settings_org, "populate_auth_methods", noop);
    override(message_edit, "update_message_topic_editing_pencil", noop);
    dispatch(event);
    assert_same(page_params.realm_allow_message_editing, true);
    assert_same(page_params.realm_message_content_edit_limit_seconds, 5);
    assert_same(page_params.realm_authentication_methods, {Google: true});

    event = event_fixtures.realm__update_dict__icon;
    override(realm_icon, "rerender", noop);

    test_electron_dispatch(event, (key, val) => {
        assert_same(key, "realm_icon_url");
        assert_same(val, "icon.png");
    });

    assert_same(page_params.realm_icon_url, "icon.png");
    assert_same(page_params.realm_icon_source, "U");

    override(realm_logo, "rerender", noop);

    event = event_fixtures.realm__update_dict__logo;
    dispatch(event);
    assert_same(page_params.realm_logo_url, "logo.png");
    assert_same(page_params.realm_logo_source, "U");

    event = event_fixtures.realm__update_dict__night_logo;
    dispatch(event);
    assert_same(page_params.realm_night_logo_url, "night_logo.png");
    assert_same(page_params.realm_night_logo_source, "U");

    event = event_fixtures.realm__deactivated;
    set_global("location", {});
    dispatch(event);
    assert_same(window.location.href, "/accounts/deactivated/");
});

run_test("realm_bot add", (override) => {
    const event = event_fixtures.realm_bot__add;
    const bot_stub = make_stub();
    const admin_stub = make_stub();
    override(bot_data, "add", bot_stub.f);
    override(settings_bots, "eventually_render_bots", () => {});
    override(settings_users, "update_bot_data", admin_stub.f);
    dispatch(event);

    assert.equal(bot_stub.num_calls, 1);
    assert.equal(admin_stub.num_calls, 1);
    const args = bot_stub.get_args("bot");
    assert_same(args.bot, event.bot);
    admin_stub.get_args("update_user_id", "update_bot_data");
});

run_test("realm_bot remove", (override) => {
    const event = event_fixtures.realm_bot__remove;
    const bot_stub = make_stub();
    const admin_stub = make_stub();
    override(bot_data, "deactivate", bot_stub.f);
    override(settings_bots, "eventually_render_bots", () => {});
    override(settings_users, "update_bot_data", admin_stub.f);
    dispatch(event);

    assert.equal(bot_stub.num_calls, 1);
    assert.equal(admin_stub.num_calls, 1);
    const args = bot_stub.get_args("user_id");
    assert_same(args.user_id, event.bot.user_id);
    admin_stub.get_args("update_user_id", "update_bot_data");
});

run_test("realm_bot delete", () => {
    const event = event_fixtures.realm_bot__delete;
    // We don't handle live updates for delete events, this is a noop.
    dispatch(event);
});

run_test("realm_bot update", (override) => {
    const event = event_fixtures.realm_bot__update;
    const bot_stub = make_stub();
    const admin_stub = make_stub();
    override(bot_data, "update", bot_stub.f);
    override(settings_bots, "eventually_render_bots", () => {});
    override(settings_users, "update_bot_data", admin_stub.f);

    dispatch(event);

    assert.equal(bot_stub.num_calls, 1);
    assert.equal(admin_stub.num_calls, 1);
    let args = bot_stub.get_args("user_id", "bot");
    assert_same(args.user_id, event.bot.user_id);
    assert_same(args.bot, event.bot);

    args = admin_stub.get_args("update_user_id", "update_bot_data");
    assert_same(args.update_user_id, event.bot.user_id);
});

run_test("realm_emoji", (override) => {
    const event = event_fixtures.realm_emoji__update;

    const ui_func_names = [
        [settings_emoji, "populate_emoji"],
        [emoji_picker, "rebuild_catalog"],
        [composebox_typeahead, "update_emoji_data"],
    ];

    const ui_stubs = [];

    for (const [module, func_name] of ui_func_names) {
        const ui_stub = make_stub();
        override(module, func_name, ui_stub.f);
        ui_stubs.push(ui_stub);
    }

    // Make sure we start with nothing...
    emoji.update_emojis([]);
    assert.equal(emoji.get_realm_emoji_url("spain"), undefined);

    dispatch(event);

    // Now emoji.js knows about the spain emoji.
    assert_same(emoji.get_realm_emoji_url("spain"), "/some/path/to/spain.png");

    // Make sure our UI modules all got dispatched the same simple way.
    for (const stub of ui_stubs) {
        assert(stub.num_calls, 1);
        assert.equal(stub.last_call_args.length, 0);
    }
});

run_test("linkifier", (override) => {
    const event = event_fixtures.realm_filters;
    page_params.realm_filters = [];
    override(settings_linkifiers, "populate_linkifiers", noop);
    override(markdown, "update_linkifier_rules", noop);
    dispatch(event);
    assert_same(page_params.realm_filters, event.realm_filters);
});

run_test("realm_domains", (override) => {
    let event = event_fixtures.realm_domains__add;
    page_params.realm_domains = [];
    override(settings_org, "populate_realm_domains", noop);
    dispatch(event);
    assert_same(page_params.realm_domains, [event.realm_domain]);

    override(settings_org, "populate_realm_domains", noop);
    event = event_fixtures.realm_domains__change;
    dispatch(event);
    assert_same(page_params.realm_domains, [event.realm_domain]);

    override(settings_org, "populate_realm_domains", noop);
    event = event_fixtures.realm_domains__remove;
    dispatch(event);
    assert_same(page_params.realm_domains, []);
});

run_test("realm_user", (override) => {
    let event = event_fixtures.realm_user__add;
    dispatch({...event});
    const added_person = people.get_by_user_id(event.person.user_id);
    // sanity check a few individual fields
    assert.equal(added_person.full_name, "Test User");
    assert.equal(added_person.timezone, "America/New_York");

    // ...but really the whole struct gets copied without any
    // manipulation
    assert.deepEqual(added_person, event.person);

    assert(people.is_active_user_for_popover(event.person.user_id));

    event = event_fixtures.realm_user__remove;
    override(stream_events, "remove_deactivated_user_from_all_streams", noop);
    dispatch(event);

    // We don't actually remove the person, we just deactivate them.
    const removed_person = people.get_by_user_id(event.person.user_id);
    assert.equal(removed_person.full_name, "Test User");
    assert(!people.is_active_user_for_popover(event.person.user_id));

    event = event_fixtures.realm_user__update;
    const stub = make_stub();
    override(user_events, "update_person", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("person");
    assert_same(args.person, event.person);
});

run_test("restart", (override) => {
    const event = event_fixtures.restart;
    const stub = make_stub();
    override(reload, "initiate", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("options");
    assert.equal(args.options.save_pointer, true);
    assert.equal(args.options.immediate, true);
});

run_test("submessage", (override) => {
    const event = event_fixtures.submessage;
    const stub = make_stub();
    override(submessage, "handle_event", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const submsg = stub.get_args("submsg").submsg;
    assert_same(submsg, {
        id: 99,
        sender_id: 42,
        msg_type: "stream",
        message_id: 56,
        content: "test",
    });
});

// For subscriptions, see dispatch_subs.js

run_test("typing", (override) => {
    // Simulate that we are not typing.
    page_params.user_id = typing_person1.user_id + 1;

    let event = event_fixtures.typing__start;
    {
        const stub = make_stub();
        override(typing_events, "display_notification", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("event");
        assert_same(args.event.sender.user_id, typing_person1.user_id);
    }

    event = event_fixtures.typing__stop;
    {
        const stub = make_stub();
        override(typing_events, "hide_notification", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("event");
        assert_same(args.event.sender.user_id, typing_person1.user_id);
    }

    // Get line coverage--we ignore our own typing events.
    page_params.user_id = typing_person1.user_id;
    event = event_fixtures.typing__start;
    dispatch(event);
});

run_test("update_display_settings", (override) => {
    let event = event_fixtures.update_display_settings__default_language;
    page_params.default_language = "en";
    override(settings_display, "update_page", noop);
    dispatch(event);
    assert_same(page_params.default_language, "fr");

    event = event_fixtures.update_display_settings__left_side_userlist;
    page_params.left_side_userlist = false;
    dispatch(event);
    assert_same(page_params.left_side_userlist, true);

    // We alias message_list.narrowed to message_lists.current
    // to make sure we get line coverage on re-rendering
    // the current message list.  The actual code tests
    // that these two objects are equal.  It is possible
    // we want a better strategy for that, or at least
    // a helper.
    message_list.narrowed = message_lists.current;

    let called = false;
    message_lists.current.rerender = () => {
        called = true;
    };

    override(message_lists.home, "rerender", noop);
    event = event_fixtures.update_display_settings__twenty_four_hour_time;
    page_params.twenty_four_hour_time = false;
    dispatch(event);
    assert_same(page_params.twenty_four_hour_time, true);
    assert_same(called, true);

    event = event_fixtures.update_display_settings__translate_emoticons;
    page_params.translate_emoticons = false;
    dispatch(event);
    assert_same(page_params.translate_emoticons, true);

    event = event_fixtures.update_display_settings__high_contrast_mode;
    page_params.high_contrast_mode = false;
    let toggled = [];
    $("body").toggleClass = (cls) => {
        toggled.push(cls);
    };
    dispatch(event);
    assert_same(page_params.high_contrast_mode, true);
    assert_same(toggled, ["high-contrast"]);

    event = event_fixtures.update_display_settings__dense_mode;
    page_params.dense_mode = false;
    toggled = [];
    dispatch(event);
    assert_same(page_params.dense_mode, true);
    assert_same(toggled, ["less_dense_mode", "more_dense_mode"]);

    $("body").fadeOut = (secs) => {
        assert_same(secs, 300);
    };
    $("body").fadeIn = (secs) => {
        assert_same(secs, 300);
    };

    override(realm_logo, "rerender", noop);

    {
        const stub = make_stub();
        event = event_fixtures.update_display_settings__color_scheme_dark;
        page_params.color_scheme = 1;
        override(night_mode, "enable", stub.f); // automatically checks if called
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        assert(page_params.color_scheme, 2);
    }

    {
        const stub = make_stub();
        event = event_fixtures.update_display_settings__color_scheme_light;
        page_params.color_scheme = 1;
        override(night_mode, "disable", stub.f); // automatically checks if called
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        assert(page_params.color_scheme, 3);
    }

    {
        event = event_fixtures.update_display_settings__default_view_recent_topics;
        page_params.default_view = "all_messages";
        dispatch(event);
        assert(page_params.default_view, "recent_topics");
    }

    {
        event = event_fixtures.update_display_settings__default_view_all_messages;
        page_params.default_view = "recent_topics";
        dispatch(event);
        assert(page_params.default_view, "all_messages");
    }

    {
        const stub = make_stub();
        event = event_fixtures.update_display_settings__color_scheme_automatic;
        page_params.color_scheme = 2;
        override(night_mode, "default_preference_checker", stub.f); // automatically checks if called
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        assert(page_params.color_scheme, 1);
    }

    {
        const stub = make_stub();
        event = event_fixtures.update_display_settings__emojiset;
        called = false;
        override(settings_display, "report_emojiset_change", stub.f);
        page_params.emojiset = "text";
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        assert_same(called, true);
        assert_same(page_params.emojiset, "google");
    }

    override(starred_messages, "rerender_ui", noop);
    event = event_fixtures.update_display_settings__starred_message_counts;
    page_params.starred_message_counts = false;
    dispatch(event);
    assert_same(page_params.starred_message_counts, true);

    override(scroll_bar, "set_layout_width", noop);
    event = event_fixtures.update_display_settings__fluid_layout_width;
    page_params.fluid_layout_width = false;
    dispatch(event);
    assert_same(page_params.fluid_layout_width, true);

    {
        const stub = make_stub();
        event = event_fixtures.update_display_settings__demote_inactive_streams;
        override(stream_data, "set_filter_out_inactives", noop);
        override(stream_list, "update_streams_sidebar", stub.f);
        page_params.demote_inactive_streams = 1;
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        assert_same(page_params.demote_inactive_streams, 2);
    }
});

run_test("update_global_notifications", (override) => {
    const event = event_fixtures.update_global_notifications;
    const stub = make_stub();
    override(notifications, "handle_global_notification_updates", stub.f);
    override(settings_notifications, "update_page", noop);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("name", "setting");
    assert_same(args.name, event.notification_name);
    assert_same(args.setting, event.setting);
});

run_test("update_message (read)", (override) => {
    const event = event_fixtures.update_message_flags__read;

    const stub = make_stub();
    override(unread_ops, "process_read_messages_event", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("message_ids");
    assert_same(args.message_ids, [999]);
});

run_test("update_message (add star)", (override) => {
    override(starred_messages, "rerender_ui", noop);

    const event = event_fixtures.update_message_flags__starred_add;
    const stub = make_stub();
    override(ui, "update_starred_view", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("message_id", "new_value");
    assert_same(args.message_id, test_message.id);
    assert_same(args.new_value, true); // for 'add'
    const msg = message_store.get(test_message.id);
    assert.equal(msg.starred, true);
});

run_test("update_message (remove star)", (override) => {
    override(starred_messages, "rerender_ui", noop);
    const event = event_fixtures.update_message_flags__starred_remove;
    const stub = make_stub();
    override(ui, "update_starred_view", stub.f);
    dispatch(event);
    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("message_id", "new_value");
    assert_same(args.message_id, test_message.id);
    assert_same(args.new_value, false);
    const msg = message_store.get(test_message.id);
    assert.equal(msg.starred, false);
});

run_test("update_message (wrong data)", (override) => {
    override(starred_messages, "rerender_ui", noop);
    const event = {
        ...event_fixtures.update_message_flags__starred_add,
        messages: [0], // message does not exist
    };
    dispatch(event);
    // update_starred_view never gets invoked, early return is successful
});

run_test("delete_message", (override) => {
    const event = event_fixtures.delete_message;

    override(stream_list, "update_streams_sidebar", noop);

    const message_events_stub = make_stub();
    override(message_events, "remove_messages", message_events_stub.f);

    const unread_ops_stub = make_stub();
    override(unread_ops, "process_read_messages_event", unread_ops_stub.f);

    const stream_topic_history_stub = make_stub();
    override(stream_topic_history, "remove_messages", stream_topic_history_stub.f);

    dispatch(event);

    let args;

    args = message_events_stub.get_args("message_ids");
    assert_same(args.message_ids, [1337]);

    args = unread_ops_stub.get_args("message_ids");
    assert_same(args.message_ids, [1337]);

    args = stream_topic_history_stub.get_args("opts");
    assert_same(args.opts.stream_id, 99);
    assert_same(args.opts.topic_name, "topic1");
    assert_same(args.opts.num_messages, 1);
    assert_same(args.opts.max_removed_msg_id, 1337);
});

run_test("user_status", (override) => {
    let event = event_fixtures.user_status__set_away;
    {
        const stub = make_stub();
        override(activity, "on_set_away", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("user_id");
        assert_same(args.user_id, 55);
    }

    event = event_fixtures.user_status__revoke_away;
    {
        const stub = make_stub();
        override(activity, "on_revoke_away", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("user_id");
        assert_same(args.user_id, 63);
    }

    event = event_fixtures.user_status__set_status_text;
    {
        const stub = make_stub();
        override(activity, "redraw_user", stub.f);
        dispatch(event);
        assert.equal(stub.num_calls, 1);
        const args = stub.get_args("user_id");
        assert_same(args.user_id, test_user.user_id);
        const status_text = user_status.get_status_text(test_user.user_id);
        assert.equal(status_text, "out to lunch");
    }
});

run_test("realm_export", (override) => {
    const event = event_fixtures.realm_export;
    const stub = make_stub();
    override(settings_exports, "populate_exports_table", stub.f);
    dispatch(event);

    assert.equal(stub.num_calls, 1);
    const args = stub.get_args("exports");
    assert.equal(args.exports, event.exports);
});

run_test("server_event_dispatch_op_errors", (override) => {
    blueslip.expect("error", "Unexpected event type subscription/other");
    server_events_dispatch.dispatch_normal_event({type: "subscription", op: "other"});
    blueslip.expect("error", "Unexpected event type reaction/other");
    server_events_dispatch.dispatch_normal_event({type: "reaction", op: "other"});
    blueslip.expect("error", "Unexpected event type realm/update_dict/other");
    server_events_dispatch.dispatch_normal_event({
        type: "realm",
        op: "update_dict",
        property: "other",
    });
    blueslip.expect("error", "Unexpected event type realm_bot/other");
    server_events_dispatch.dispatch_normal_event({type: "realm_bot", op: "other"});
    blueslip.expect("error", "Unexpected event type realm_domains/other");
    server_events_dispatch.dispatch_normal_event({type: "realm_domains", op: "other"});
    blueslip.expect("error", "Unexpected event type realm_user/other");
    server_events_dispatch.dispatch_normal_event({type: "realm_user", op: "other"});
    blueslip.expect("error", "Unexpected event type stream/other");
    server_events_dispatch.dispatch_normal_event({type: "stream", op: "other"});
    blueslip.expect("error", "Unexpected event type typing/other");
    server_events_dispatch.dispatch_normal_event({
        type: "typing",
        sender: {user_id: 5},
        op: "other",
    });
    override(settings_user_groups, "reload", noop);
    blueslip.expect("error", "Unexpected event type user_group/other");
    server_events_dispatch.dispatch_normal_event({type: "user_group", op: "other"});
});