Files
zulip/web/tests/hotkey.test.cjs
Ines Falcato 8d96b7879f keyboard_UI: Allow use of e hotkey for spectators.
Previously, when in anonymous login, pressing the "view original
message" button showed the original message and allowed copying it.
However, the corresponding keyboard shortcut ('e') did not work as
expected and a login pop-up appeared instead.

Now, by fixing the UI features' permissions for anonymous users, by
adding "edit_message" as a feature they can perform, they are allowed
to use the 'e' keyboard shortcut as intended.

Fixes #33838
2025-04-21 14:36:10 -07:00

585 lines
21 KiB
JavaScript

"use strict";
const assert = require("node:assert/strict");
const {process_keydown} = require("../src/hotkey.js");
const {mock_esm, set_global, with_overrides, zrequire} = require("./lib/namespace.cjs");
const {make_stub} = require("./lib/stub.cjs");
const {run_test} = require("./lib/test.cjs");
const $ = require("./lib/zjquery.cjs");
const {page_params} = require("./lib/zpage_params.cjs");
// Important note on these tests:
//
// The way the Zulip hotkey tests work is as follows. First, we set
// up various contexts by monkey-patching the various hotkeys exports
// functions (like overlays.settings_open). Within that context, to
// test whether a given key (e.g. `x`) results in a specific function
// (e.g. `ui.foo()`), we fail to import any modules other than
// hotkey.js so that accessing them will result in a ReferenceError.
//
// Then we create a stub `ui.foo`, and call the hotkey function. If
// it calls any external module other than `ui.foo`, it'll crash.
// Future work includes making sure it actually does call `ui.foo()`.
// All tests use the combined feed as the default narrow.
window.location.hash = "#feed";
set_global("navigator", {
platform: "",
});
// jQuery stuff should go away if we make an initialize() method.
set_global("document", {
hasFocus: () => false,
});
const activity_ui = mock_esm("../src/activity_ui");
const activity = zrequire("../src/activity");
const browser_history = mock_esm("../src/browser_history");
const compose_actions = mock_esm("../src/compose_actions");
const compose_reply = mock_esm("../src/compose_reply");
const condense = mock_esm("../src/condense");
const drafts_overlay_ui = mock_esm("../src/drafts_overlay_ui");
const emoji_picker = mock_esm("../src/emoji_picker", {
is_open: () => false,
toggle_emoji_popover() {},
});
const gear_menu = mock_esm("../src/gear_menu");
const lightbox = mock_esm("../src/lightbox");
const list_util = mock_esm("../src/list_util");
const message_actions_popover = mock_esm("../src/message_actions_popover");
const message_edit = mock_esm("../src/message_edit");
const message_lists = mock_esm("../src/message_lists");
const user_topics_ui = mock_esm("../src/user_topics_ui");
const message_view = mock_esm("../src/message_view");
const narrow_state = mock_esm("../src/narrow_state");
const navigate = mock_esm("../src/navigate");
const modals = mock_esm("../src/modals", {
any_active: () => false,
active_modal: () => undefined,
});
const overlays = mock_esm("../src/overlays", {
any_active: () => false,
settings_open: () => false,
streams_open: () => false,
lightbox_open: () => false,
drafts_open: () => false,
scheduled_messages_open: () => false,
info_overlay_open: () => false,
message_edit_history_open: () => false,
});
const popovers = mock_esm("../src/user_card_popover", {
user_sidebar: {
is_open: () => false,
},
message_user_card: {
is_open: () => false,
},
user_card: {
is_open: () => false,
},
});
const reactions = mock_esm("../src/reactions");
const read_receipts = mock_esm("../src/read_receipts");
const search = mock_esm("../src/search");
const settings_data = mock_esm("../src/settings_data");
const stream_list = mock_esm("../src/stream_list", {
is_zoomed_in: () => false,
});
const stream_popover = mock_esm("../src/stream_popover");
const stream_settings_ui = mock_esm("../src/stream_settings_ui");
mock_esm("../src/recent_view_ui", {
is_in_focus: () => false,
});
const spectators = mock_esm("../src/spectators", {
login_to_access() {},
});
message_lists.current = {
visibly_empty() {
return false;
},
selected_id() {
return 42;
},
selected_row() {
const $row = $.create("selected-row-stub");
$row.set_find_results(".message-actions-menu-button", []);
$row.set_find_results(".emoji-message-control-button-container", {is: () => false});
return $row;
},
selected_message() {
return {
sent_by_me: true,
flags: ["read", "starred"],
};
},
get_row() {
return 101;
},
};
const emoji = zrequire("emoji");
const emoji_codes = zrequire("../../static/generated/emoji/emoji_codes.json");
const hotkey = zrequire("hotkey");
emoji.initialize({
realm_emoji: {},
emoji_codes,
});
function stubbing(module, func_name_to_stub, test_function) {
with_overrides(({override}) => {
const stub = make_stub();
override(module, func_name_to_stub, stub.f);
test_function(stub);
});
}
function test_while_not_editing_text(label, f) {
run_test(label, (helpers) => {
helpers.override_rewire(hotkey, "processing_text", () => false);
f(helpers);
});
}
run_test("mappings", () => {
function map_press(which, shiftKey) {
return hotkey.get_keypress_hotkey({
which,
shiftKey,
});
}
function map_down(which, shiftKey, ctrlKey, metaKey, altKey) {
return hotkey.get_keydown_hotkey({
which,
shiftKey,
ctrlKey,
metaKey,
altKey,
});
}
// The next assertion protects against an iOS bug where we
// treat "!" as a hotkey, because iOS sends the wrong code.
assert.equal(map_press(33), undefined);
// Test page-up does work.
assert.equal(map_down(33).name, "page_up");
// Test other mappings.
assert.equal(map_down(9).name, "tab");
assert.equal(map_down(9, true).name, "shift_tab");
assert.equal(map_down(27).name, "escape");
assert.equal(map_down(37).name, "left_arrow");
assert.equal(map_down(13).name, "enter");
assert.equal(map_down(46).name, "delete");
assert.equal(map_down(13, true).name, "enter");
assert.equal(map_down(78, true).name, "narrow_to_next_unread_followed_topic");
assert.equal(map_down(86, true).name, "toggle_read_receipts"); // Shift + V
assert.equal(map_press(47).name, "search"); // slash
assert.equal(map_press(106).name, "vim_down"); // j
assert.equal(map_down(219, false, true).name, "escape"); // Ctrl + [
assert.equal(map_down(67, false, true).name, "copy_with_c"); // Ctrl + C
assert.equal(map_down(75, false, true).name, "search_with_k"); // Ctrl + K
assert.equal(map_down(83, false, true).name, "star_message"); // Ctrl + S
assert.equal(map_down(190, false, true).name, "narrow_to_compose_target"); // Ctrl + .
assert.equal(map_down(80, false, false, false, true).name, "toggle_compose_preview"); // Alt + P
// More negative tests.
assert.equal(map_down(47), undefined);
assert.equal(map_press(27), undefined);
assert.equal(map_down(27, true), undefined);
assert.equal(map_down(86, false, true), undefined); // Ctrl + V
assert.equal(map_down(90, false, true), undefined); // Ctrl + Z
assert.equal(map_down(84, false, true), undefined); // Ctrl + T
assert.equal(map_down(82, false, true), undefined); // Ctrl + R
assert.equal(map_down(79, false, true), undefined); // Ctrl + O
assert.equal(map_down(80, false, true), undefined); // Ctrl + P
assert.equal(map_down(65, false, true), undefined); // Ctrl + A
assert.equal(map_down(70, false, true), undefined); // Ctrl + F
assert.equal(map_down(72, false, true), undefined); // Ctrl + H
assert.equal(map_down(88, false, true), undefined); // Ctrl + X
assert.equal(map_down(78, false, true), undefined); // Ctrl + N
assert.equal(map_down(77, false, true), undefined); // Ctrl + M
assert.equal(map_down(67, false, false, true), undefined); // Cmd + C
assert.equal(map_down(75, false, false, true), undefined); // Cmd + K
assert.equal(map_down(83, false, false, true), undefined); // Cmd + S
assert.equal(map_down(75, true, true), undefined); // Shift + Ctrl + K
assert.equal(map_down(83, true, true), undefined); // Shift + Ctrl + S
assert.equal(map_down(219, true, true, false), undefined); // Shift + Ctrl + [
// Cmd tests for MacOS
navigator.platform = "MacIntel";
assert.equal(map_down(219, false, true, false).name, "escape"); // Ctrl + [
assert.equal(map_down(219, false, false, true), undefined); // Cmd + [
assert.equal(map_down(67, false, true, true).name, "copy_with_c"); // Ctrl + C
assert.equal(map_down(67, false, true, false), undefined); // Cmd + C
assert.equal(map_down(75, false, false, true).name, "search_with_k"); // Cmd + K
assert.equal(map_down(75, false, true, false), undefined); // Ctrl + K
assert.equal(map_down(83, false, false, true).name, "star_message"); // Cmd + S
assert.equal(map_down(83, false, true, false), undefined); // Ctrl + S
assert.equal(map_down(190, false, false, true).name, "narrow_to_compose_target"); // Cmd + .
assert.equal(map_down(190, false, true, false), undefined); // Ctrl + .
// Reset platform
navigator.platform = "";
});
function process(s, shiftKey, keydown = false) {
const e = {
which: s.codePointAt(0),
shiftKey,
};
try {
if (keydown) {
return hotkey.process_keydown(e);
}
return hotkey.process_keypress(e);
} catch (error) /* istanbul ignore next */ {
// An exception will be thrown here if a different
// function is called than the one declared. Try to
// provide a useful error message.
// add a newline to separate from other console output.
console.log('\nERROR: Mapping for character "' + e.which + '" does not match tests.');
throw error;
}
}
function assert_mapping(c, module, func_name, shiftKey, keydown) {
stubbing(module, func_name, (stub) => {
assert.ok(process(c, shiftKey, keydown));
assert.equal(stub.num_calls, 1);
});
}
function assert_unmapped(s) {
for (const c of s) {
assert.equal(process(c), false);
}
}
function test_normal_typing() {
assert_unmapped("abcdefghijklmnopqrsuvwxyz");
assert_unmapped(" ");
assert_unmapped("[]\\.,;");
assert_unmapped("ABCDEFGHIJKLMNOPQRSTUVWXYZ");
assert_unmapped('~!@#$%^*()_+{}:"<>');
}
test_while_not_editing_text("unmapped keys return false easily", () => {
// Unmapped keys should immediately return false, without
// calling any functions outside of hotkey.js.
// (unless we are editing text)
assert_unmapped("bfoyz");
assert_unmapped("BEFHLNOQTWXYZ");
});
run_test("allow normal typing when editing text", ({override, override_rewire}) => {
// All letters should return false if we are composing text.
override_rewire(hotkey, "processing_text", () => true);
let settings_open;
let any_active;
let info_overlay_open;
override(overlays, "any_active", () => any_active);
override(overlays, "settings_open", () => settings_open);
override(overlays, "info_overlay_open", () => info_overlay_open);
for (settings_open of [true, false]) {
for (any_active of [true, false]) {
for (info_overlay_open of [true, false]) {
test_normal_typing();
}
}
}
});
test_while_not_editing_text("streams", ({override}) => {
settings_data.user_can_create_private_streams = () => true;
delete settings_data.user_can_create_public_streams;
delete settings_data.user_can_create_web_public_streams;
override(overlays, "streams_open", () => true);
override(overlays, "any_active", () => true);
assert_mapping("S", stream_settings_ui, "keyboard_sub");
assert_mapping("V", stream_settings_ui, "view_stream");
assert_mapping("n", stream_settings_ui, "open_create_stream");
settings_data.user_can_create_private_streams = () => false;
settings_data.user_can_create_public_streams = () => false;
settings_data.user_can_create_web_public_streams = () => false;
assert_unmapped("n");
});
test_while_not_editing_text("basic mappings", () => {
assert_mapping("?", browser_history, "go_to_location");
assert_mapping("/", search, "initiate_search");
assert_mapping("w", activity_ui, "initiate_search");
assert_mapping("q", stream_list, "initiate_search");
assert_mapping("A", message_view, "stream_cycle_backward");
assert_mapping("D", message_view, "stream_cycle_forward");
assert_mapping("c", compose_actions, "start");
assert_mapping("x", compose_actions, "start");
assert_mapping("P", message_view, "show");
assert_mapping("g", gear_menu, "toggle");
});
test_while_not_editing_text("drafts open", ({override}) => {
override(overlays, "any_active", () => true);
override(overlays, "drafts_open", () => true);
assert_mapping("d", overlays, "close_overlay");
});
test_while_not_editing_text("drafts closed w/other overlay", ({override}) => {
override(overlays, "any_active", () => true);
override(overlays, "drafts_open", () => false);
test_normal_typing();
});
test_while_not_editing_text("drafts closed launch", ({override}) => {
override(overlays, "any_active", () => false);
assert_mapping("d", browser_history, "go_to_location");
});
run_test("modal open", ({override}) => {
override(modals, "any_active", () => true);
test_normal_typing();
});
test_while_not_editing_text("misc", ({override}) => {
// Next, test keys that only work on a selected message.
const message_view_only_keys = "@+>RjJkKsuvVi:GM";
// Check that they do nothing without a selected message
with_overrides(({override}) => {
override(message_lists.current, "visibly_empty", () => true);
assert_unmapped(message_view_only_keys);
});
// Check that they do nothing while in the settings overlay
with_overrides(({override}) => {
override(overlays, "settings_open", () => true);
assert_unmapped("@*+->rRjJkKsSuvVi:GM");
});
// TODO: Similar check for being in the subs page
assert_mapping("@", compose_reply, "reply_with_mention");
assert_mapping("+", reactions, "toggle_emoji_reaction");
// Without an existing emoji reaction, this next one will only
// call get_message_reactions, so we verify just that.
assert_mapping("=", reactions, "get_message_reactions");
assert_mapping("-", condense, "toggle_collapse");
assert_mapping("r", compose_reply, "respond_to_message");
assert_mapping("R", compose_reply, "respond_to_message", true);
assert_mapping("j", navigate, "down");
assert_mapping("J", navigate, "page_down");
assert_mapping("k", navigate, "up");
assert_mapping("K", navigate, "page_up");
assert_mapping("u", popovers, "toggle_sender_info");
assert_mapping("i", message_actions_popover, "toggle_message_actions_menu");
assert_mapping(":", emoji_picker, "toggle_emoji_popover", true);
assert_mapping(">", compose_reply, "quote_message");
assert_mapping("<", compose_reply, "quote_message");
assert_mapping("e", message_edit, "start");
override(narrow_state, "narrowed_by_topic_reply", () => true);
assert_mapping("s", message_view, "narrow_by_recipient");
override(narrow_state, "narrowed_by_topic_reply", () => false);
override(narrow_state, "narrowed_by_pm_reply", () => true);
assert_unmapped("s");
override(narrow_state, "narrowed_by_topic_reply", () => false);
override(narrow_state, "narrowed_by_pm_reply", () => false);
assert_mapping("s", message_view, "narrow_by_topic");
override(message_edit, "can_move_message", () => true);
assert_mapping("m", stream_popover, "build_move_topic_to_stream_popover");
override(message_edit, "can_move_message", () => false);
assert_unmapped("m");
assert_mapping("V", read_receipts, "show_user_list", true, true);
override(modals, "any_active", () => true);
override(modals, "active_modal", () => "#read_receipts_modal");
assert_mapping("V", read_receipts, "hide_user_list", true, true);
});
test_while_not_editing_text("lightbox overlay open", ({override}) => {
override(overlays, "any_active", () => true);
override(overlays, "lightbox_open", () => true);
assert_mapping("v", overlays, "close_overlay");
});
test_while_not_editing_text("lightbox closed w/other overlay open", ({override}) => {
override(overlays, "any_active", () => true);
override(overlays, "lightbox_open", () => false);
test_normal_typing();
});
test_while_not_editing_text("v w/no overlays", ({override}) => {
override(overlays, "any_active", () => false);
assert_mapping("v", lightbox, "show_from_selected_message");
});
run_test("emoji picker", ({override}) => {
override(emoji_picker, "is_open", () => true);
assert_mapping(":", emoji_picker, "navigate", true);
});
test_while_not_editing_text("G/M keys", () => {
// TODO: move
assert_mapping("G", navigate, "to_end");
assert_mapping("M", user_topics_ui, "toggle_topic_visibility_policy");
});
test_while_not_editing_text("n/p keys", () => {
// Test keys that work when a message is selected and
// also when the message list is empty.
assert_mapping("n", message_view, "narrow_to_next_topic");
assert_mapping("p", message_view, "narrow_to_next_pm_string");
assert_mapping("n", message_view, "narrow_to_next_topic");
});
test_while_not_editing_text("narrow next unread followed topic", () => {
assert_mapping("N", message_view, "narrow_to_next_topic", true, true);
});
test_while_not_editing_text("motion_keys", () => {
const codes = {
down_arrow: 40,
end: 35,
home: 36,
left_arrow: 37,
right_arrow: 39,
page_up: 33,
page_down: 34,
spacebar: 32,
up_arrow: 38,
"+": 187,
};
function process(name) {
const e = {
which: codes[name],
};
try {
return hotkey.process_keydown(e);
} catch (error) /* istanbul ignore next */ {
// An exception will be thrown here if a different
// function is called than the one declared. Try to
// provide a useful error message.
// add a newline to separate from other console output.
console.log('\nERROR: Mapping for character "' + e.which + '" does not match tests.');
throw error;
}
}
function assert_unmapped(name) {
assert.equal(process(name), false);
}
function assert_mapping(key_name, module, func_name) {
stubbing(module, func_name, (stub) => {
assert.ok(process(key_name));
assert.equal(stub.num_calls, 1);
});
}
list_util.inside_list = () => false;
message_lists.current.visibly_empty = () => true;
overlays.settings_open = () => false;
overlays.streams_open = () => false;
overlays.lightbox_open = () => false;
assert_unmapped("down_arrow");
assert_unmapped("end");
assert_unmapped("home");
assert_unmapped("page_up");
assert_unmapped("page_down");
assert_unmapped("spacebar");
assert_unmapped("up_arrow");
list_util.inside_list = () => true;
assert_mapping("up_arrow", list_util, "go_up");
assert_mapping("down_arrow", list_util, "go_down");
list_util.inside_list = () => false;
message_lists.current.visibly_empty = () => false;
assert_mapping("down_arrow", navigate, "down");
assert_mapping("end", navigate, "to_end");
assert_mapping("home", navigate, "to_home");
assert_mapping("left_arrow", message_edit, "edit_last_sent_message");
assert_mapping("page_up", navigate, "page_up");
assert_mapping("page_down", navigate, "page_down");
assert_mapping("spacebar", navigate, "page_down");
assert_mapping("up_arrow", navigate, "up");
overlays.info_overlay_open = () => true;
assert_unmapped("down_arrow");
assert_unmapped("up_arrow");
overlays.info_overlay_open = () => false;
overlays.streams_open = () => true;
assert_mapping("up_arrow", stream_settings_ui, "switch_rows");
assert_mapping("down_arrow", stream_settings_ui, "switch_rows");
delete overlays.streams_open;
overlays.lightbox_open = () => true;
assert_mapping("left_arrow", lightbox, "prev");
assert_mapping("right_arrow", lightbox, "next");
delete overlays.lightbox_open;
overlays.settings_open = () => true;
assert_unmapped("end");
assert_unmapped("home");
assert_unmapped("left_arrow");
assert_unmapped("page_up");
assert_unmapped("page_down");
assert_unmapped("spacebar");
delete overlays.settings_open;
delete overlays.any_active;
overlays.drafts_open = () => true;
assert_mapping("up_arrow", drafts_overlay_ui, "handle_keyboard_events");
assert_mapping("down_arrow", drafts_overlay_ui, "handle_keyboard_events");
delete overlays.any_active;
delete overlays.drafts_open;
});
run_test("test new user input hook called", () => {
let hook_called = false;
activity.register_on_new_user_input_hook(() => {
hook_called = true;
});
hotkey.process_keydown({which: "S".codePointAt(0)});
assert.ok(hook_called);
});
run_test("e shortcut works for anonymous users", () => {
page_params.is_spectator = true;
const stub = make_stub();
spectators.login_to_access = stub.f;
const e = {
which: "e".codePointAt(0),
};
process_keydown(e);
assert.equal(stub.num_calls, 0, "login_to_access should not be called for 'e' shortcut");
});