"use strict"; const {strict: assert} = require("assert"); const {stub_templates} = require("../zjsunit/handlebars"); const {mock_cjs, mock_esm, set_global, zrequire} = require("../zjsunit/namespace"); const {run_test} = require("../zjsunit/test"); const $ = require("../zjsunit/zjquery"); const noop = () => {}; // We assign this in our test() wrapper. let messages; // sender1 == current user // sender2 == any other user const sender1 = 1; const sender2 = 2; // New stream const stream1 = 1; const stream2 = 2; const stream3 = 3; const stream4 = 4; const stream5 = 5; // Deleted stream // Topics in the stream, all unread except topic1 & stream1. const topic1 = "topic-1"; // No other sender & read. const topic2 = "topic-2"; // Other sender const topic3 = "topic-3"; // User not present const topic4 = "topic-4"; // User not present const topic5 = "topic-5"; // other sender const topic6 = "topic-6"; // other sender const topic7 = "topic-7"; // muted topic const topic8 = "topic-8"; const topic9 = "topic-9"; const topic10 = "topic-10"; mock_cjs("jquery", $); let expected_data_to_replace_in_list_widget; const ListWidget = mock_esm("../../static/js/list_widget", { modifier: noop, create: (container, mapped_topic_values, opts) => { const formatted_topics = []; ListWidget.modifier = opts.modifier; for (const item of mapped_topic_values) { formatted_topics.push(opts.modifier(item)); opts.filter.predicate(item); } // Just for coverage, the mechanisms // are tested in list_widget.js if (mapped_topic_values.length >= 2) { opts.sort_fields.stream_sort(mapped_topic_values[0], mapped_topic_values[1]); opts.sort_fields.stream_sort(mapped_topic_values[1], mapped_topic_values[0]); opts.sort_fields.stream_sort(mapped_topic_values[0], mapped_topic_values[0]); opts.sort_fields.topic_sort(mapped_topic_values[0], mapped_topic_values[1]); opts.sort_fields.topic_sort(mapped_topic_values[1], mapped_topic_values[0]); opts.sort_fields.topic_sort(mapped_topic_values[0], mapped_topic_values[0]); } return ListWidget; }, hard_redraw: noop, render_item: (item) => ListWidget.modifier(item), replace_list_data: (data) => { if (expected_data_to_replace_in_list_widget === undefined) { throw new Error("You must set expected_data_to_replace_in_list_widget"); } assert.deepEqual(data, expected_data_to_replace_in_list_widget); expected_data_to_replace_in_list_widget = undefined; }, }); mock_esm("../../static/js/compose_closed_ui", { set_standard_text_for_reply_button: noop, update_buttons_for_recent_topics: noop, }); mock_esm("../../static/js/hash_util", { by_stream_uri: () => "https://www.example.com", by_stream_topic_uri: () => "https://www.example.com", }); mock_esm("../../static/js/message_list_data", { MessageListData: class {}, }); mock_esm("../../static/js/message_store", { get: (msg_id) => messages[msg_id - 1], }); mock_esm("../../static/js/message_view_header", { render_title_area: noop, }); mock_esm("../../static/js/muting", { is_topic_muted: (stream_id, topic) => { if (stream_id === stream1 && topic === topic7) { return true; } return false; }, }); mock_esm("../../static/js/narrow", { set_narrow_title: noop, }); mock_esm("../../static/js/popovers", { any_active: () => false, }); mock_esm("../../static/js/recent_senders", { get_topic_recent_senders: () => [1, 2], }); mock_esm("../../static/js/stream_data", { is_muted: () => // We only test via muted topics for now. // TODO: Make muted streams and test them. false, id_is_subscribed: () => true, }); mock_esm("../../static/js/stream_list", { handle_narrow_deactivated: noop, }); mock_esm("../../static/js/timerender", { last_seen_status_from_date: () => "Just now", get_full_datetime: () => ({ date: "date", time: "time", }), }); mock_esm("../../static/js/sub_store", { get: (stream) => { if (stream === stream5) { // No data is available for deactivated streams return undefined; } return { color: "", invite_only: false, is_web_public: true, }; }, }); mock_esm("../../static/js/top_left_corner", { narrow_to_recent_topics: noop, }); mock_esm("../../static/js/unread", { num_unread_for_topic: (stream_id, topic) => { if (stream_id === 1 && topic === "topic-1") { // Only stream1, topic-1 is read. return 0; } return 1; }, }); const ls_container = new Map(); set_global("localStorage", { getItem(key) { return ls_container.get(key); }, setItem(key, val) { ls_container.set(key, val); }, removeItem(key) { ls_container.delete(key); }, clear() { ls_container.clear(); }, }); const {all_messages_data} = zrequire("all_messages_data"); const people = zrequire("people"); const rt = zrequire("recent_topics"); people.is_my_user_id = (id) => id === 1; people.sender_info_for_recent_topics_row = (ids) => ids; let id = 0; const sample_messages = []; sample_messages[0] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic1, sender_id: sender1, type: "stream", }; sample_messages[1] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic2, sender_id: sender1, type: "stream", }; sample_messages[2] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic2, sender_id: sender2, type: "stream", }; sample_messages[3] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic3, sender_id: sender2, type: "stream", }; sample_messages[4] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic4, sender_id: sender2, type: "stream", }; sample_messages[5] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic5, sender_id: sender1, type: "stream", }; sample_messages[6] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic5, sender_id: sender2, type: "stream", }; sample_messages[7] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic6, sender_id: sender1, type: "stream", }; sample_messages[8] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic6, sender_id: sender2, type: "stream", }; sample_messages[9] = { stream_id: stream1, stream: "stream1", id: (id += 1), topic: topic7, sender_id: sender1, type: "stream", }; // a message of stream4 sample_messages[10] = { stream_id: stream4, stream: "stream4", id: (id += 1), topic: topic10, sender_id: sender1, type: "stream", }; function get_topic_key(stream_id, topic) { return stream_id + ":" + topic.toLowerCase(); } function generate_topic_data(topic_info_array) { // Since most of the fields are common, this function helps generate fixtures // with non common fields. $.clear_all_elements(); const data = []; for (const [stream_id, topic, unread_count, muted, participated] of topic_info_array) { data.push({ other_senders_count: 0, invite_only: false, is_web_public: true, last_msg_time: "Just now", full_last_msg_date_time: "date time", senders: [1, 2], stream: "stream" + stream_id, stream_color: "", stream_id, stream_url: "https://www.example.com", topic, topic_key: get_topic_key(stream_id, topic), topic_url: "https://www.example.com", unread_count, muted, topic_muted: muted, participated, }); } return data; } function verify_topic_data(all_topics, stream, topic, last_msg_id, participated) { const topic_data = all_topics.get(stream + ":" + topic); assert.equal(topic_data.last_msg_id, last_msg_id); assert.equal(topic_data.participated, participated); } rt.set_default_focus(); function stub_out_filter_buttons() { // TODO: We probably want more direct tests that make sure // the widgets get updated correctly, but the stubs here // should accurately simulate toggling the filters. // // See show_selected_filters() and set_filter() in the // implementation. for (const filter of ["all", "unread", "muted", "participated"]) { const stub = $.create(`filter-${filter}-stub`); const selector = `[data-filter="${filter}"]`; $("#recent_topics_filter_buttons").set_find_results(selector, stub); } } function test(label, f) { run_test(label, (override) => { messages = sample_messages.map((message) => ({...message})); f(override); }); } test("test_recent_topics_show", () => { // Note: unread count and urls are fake, // since they are generated in external libraries // and are not to be tested here. const expected = { filter_participated: false, filter_unread: false, filter_muted: false, search_val: "", }; stub_templates((template_name, data) => { if (template_name === "recent_topics_table") { assert.deepEqual(data, expected); } else if (template_name === "recent_topics_filters") { assert.equal(data.filter_unread, expected.filter_unread); assert.equal(data.filter_participated, expected.filter_participated); } return ""; }); stub_out_filter_buttons(); rt.clear_for_tests(); rt.process_messages(messages); rt.show(); // incorrect topic_key assert.equal(rt.inplace_rerender("stream_unknown:topic_unknown"), false); }); test("test_filter_all", (override) => { // Just tests inplace rerender of a message // in All topics filter. const expected = { filter_participated: false, filter_unread: false, filter_muted: false, search_val: "", }; let row_data; let i; stub_templates((template_name, data) => { if (template_name === "recent_topic_row") { // All the row will be processed. i -= 1; assert.deepEqual(data, row_data[i]); } else if (template_name === "recent_topics_table") { assert.deepEqual(data, expected); } return ""; }); // topic is not muted row_data = generate_topic_data([[1, "topic-1", 0, false, true]]); i = row_data.length; rt.clear_for_tests(); stub_out_filter_buttons(); override(rt, "is_visible", () => true); rt.set_filter("all"); rt.process_messages([messages[0]]); expected_data_to_replace_in_list_widget = [ {last_msg_id: 10, participated: true}, {last_msg_id: 1, participated: true}, ]; row_data = row_data.concat(generate_topic_data([[1, "topic-7", 1, true, true]])); i = row_data.length; // topic is muted (=== hidden) stub_out_filter_buttons(); rt.process_messages([messages[9]]); // Test search expected.search_val = "topic-1"; row_data = generate_topic_data([[1, "topic-1", 0, false, true]]); i = row_data.length; rt.set_default_focus(); assert.equal(rt.inplace_rerender("1:topic-1"), true); }); test("test_filter_unread", (override) => { // Tests rerender of all topics when filter changes to "unread". const expected = { filter_participated: false, filter_unread: true, filter_muted: false, search_val: "", }; const row_data = generate_topic_data([ // stream_id, topic, unread_count, muted, participated [4, "topic-10", 1, false, true], [1, "topic-7", 1, true, true], [1, "topic-6", 1, false, true], [1, "topic-5", 1, false, true], [1, "topic-4", 1, false, false], [1, "topic-3", 1, false, false], [1, "topic-2", 1, false, true], [1, "topic-1", 0, false, true], ]); let i = 0; rt.clear_for_tests(); override(rt, "is_visible", () => true); rt.set_default_focus(); stub_templates(() => ""); stub_out_filter_buttons(); rt.process_messages(messages); assert.equal(rt.inplace_rerender("1:topic-1"), true); $("#recent_topics_filter_buttons").removeClass("btn-recent-selected"); stub_templates((template_name, data) => { assert.equal(template_name, "recent_topics_filters"); assert.equal(data.filter_unread, expected.filter_unread); assert.equal(data.filter_participated, expected.filter_participated); return ""; }); rt.set_filter("unread"); rt.update_filters_view(); stub_templates((template_name, data) => { if (template_name === "recent_topic_row") { // All the row will be processed. assert.deepEqual(data, row_data[i]); i += 1; } else if (template_name === "recent_topics_table") { assert.deepEqual(data, expected); } return ""; }); expected_data_to_replace_in_list_widget = [ { last_msg_id: 11, participated: true, }, { last_msg_id: 10, participated: true, }, { last_msg_id: 9, participated: true, }, { last_msg_id: 7, participated: true, }, { last_msg_id: 5, participated: false, }, { last_msg_id: 4, participated: false, }, { last_msg_id: 3, participated: true, }, { last_msg_id: 1, participated: true, }, ]; rt.process_messages([messages[0]]); // Unselect "unread" filter by clicking twice. expected.filter_unread = false; $("#recent_topics_filter_buttons").addClass("btn-recent-selected"); rt.set_filter("unread"); $("#recent_topics_filter_buttons").removeClass("btn-recent-selected"); // reselect "unread" filter rt.set_filter("unread"); // Now clicking "all" filter should have no change to expected data. rt.set_filter("all"); }); test("test_filter_participated", (override) => { // Tests rerender of all topics when filter changes to "unread". const expected = { filter_participated: true, filter_unread: false, filter_muted: false, search_val: "", }; const row_data = generate_topic_data([ // stream_id, topic, unread_count, muted, participated [4, "topic-10", 1, false, true], [1, "topic-7", 1, true, true], [1, "topic-6", 1, false, true], [1, "topic-5", 1, false, true], [1, "topic-4", 1, false, false], [1, "topic-3", 1, false, false], [1, "topic-2", 1, false, true], [1, "topic-1", 0, false, true], ]); let i = 0; rt.clear_for_tests(); override(rt, "is_visible", () => true); rt.set_default_focus(); stub_templates(() => ""); stub_out_filter_buttons(); rt.process_messages(messages); assert.equal(rt.inplace_rerender("1:topic-4"), true); // Set muted filter rt.set_filter("muted"); assert.equal(rt.inplace_rerender("1:topic-7"), true); // remove muted filter rt.set_filter("muted"); $("#recent_topics_filter_buttons").removeClass("btn-recent-selected"); stub_templates((template_name, data) => { assert.equal(template_name, "recent_topics_filters"); assert.equal(data.filter_unread, expected.filter_unread); assert.equal(data.filter_participated, expected.filter_participated); return ""; }); rt.set_filter("participated"); rt.update_filters_view(); stub_templates((template_name, data) => { if (template_name === "recent_topic_row") { // All the row will be processed. assert.deepEqual(data, row_data[i]); i += 1; } else if (template_name === "recent_topics_table") { assert.deepEqual(data, expected); } return ""; }); expected_data_to_replace_in_list_widget = [ { last_msg_id: 11, participated: true, }, { last_msg_id: 10, participated: true, }, { last_msg_id: 9, participated: true, }, { last_msg_id: 7, participated: true, }, { last_msg_id: 5, participated: false, }, { last_msg_id: 4, participated: false, }, { last_msg_id: 3, participated: true, }, { last_msg_id: 1, participated: true, }, ]; rt.process_messages([messages[4]]); expected.filter_participated = false; rt.set_filter("all"); }); test("test_update_unread_count", () => { rt.clear_for_tests(); stub_out_filter_buttons(); rt.set_filter("all"); stub_templates(() => ""); rt.process_messages(messages); // update a message generate_topic_data([[1, "topic-7", 1, false, true]]); rt.update_topic_unread_count(messages[9]); }); // template rendering is tested in test_recent_topics_launch. stub_templates(() => ""); test("basic assertions", (override) => { rt.clear_for_tests(); stub_templates(() => ""); stub_out_filter_buttons(); override(rt, "is_visible", () => true); rt.set_default_focus(); rt.set_filter("all"); rt.process_messages(messages); let all_topics = rt.get(); // update a message generate_topic_data([[1, "topic-7", 1, false, true]]); stub_out_filter_buttons(); expected_data_to_replace_in_list_widget = [ { last_msg_id: 11, participated: true, }, { last_msg_id: 10, participated: true, }, { last_msg_id: 9, participated: true, }, { last_msg_id: 7, participated: true, }, { last_msg_id: 5, participated: false, }, { last_msg_id: 4, participated: false, }, { last_msg_id: 3, participated: true, }, { last_msg_id: 1, participated: true, }, ]; rt.process_messages([messages[9]]); // Check for expected lengths. // total 8 topics, 1 muted assert.equal(all_topics.size, 8); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3,1:topic-2,1:topic-1", ); rt.process_message({ type: "private", }); // Private msgs are not processed. assert.equal(all_topics.size, 8); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3,1:topic-2,1:topic-1", ); // participated verify_topic_data(all_topics, stream1, topic1, messages[0].id, true); // No message was sent by us. verify_topic_data(all_topics, stream1, topic3, messages[3].id, false); // Not participated verify_topic_data(all_topics, stream1, topic4, messages[4].id, false); // topic3 now participated rt.process_message({ stream_id: stream1, id: (id += 1), topic: topic3, sender_id: sender1, type: "stream", }); all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "1:topic-3,4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-2,1:topic-1", ); verify_topic_data(all_topics, stream1, topic3, id, true); // Send new message to topic7 (muted) // The topic will be hidden when displayed rt.process_message({ stream_id: stream1, id: (id += 1), topic: topic7, sender_id: sender1, type: "stream", }); all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "1:topic-7,1:topic-3,4:topic-10,1:topic-6,1:topic-5,1:topic-4,1:topic-2,1:topic-1", ); // update_topic_is_muted now relies on external libraries completely // so we don't need to check anythere here. generate_topic_data([[1, topic1, 0, false, true]]); assert.equal(rt.update_topic_is_muted(stream1, topic1), true); // a topic gets muted which we are not tracking assert.equal(rt.update_topic_is_muted(stream1, "topic-10"), false); }); test("test_reify_local_echo_message", (override) => { stub_templates(() => ""); rt.clear_for_tests(); stub_out_filter_buttons(); override(rt, "is_visible", () => true); rt.set_filter("all"); rt.process_messages(messages); rt.process_message({ stream_id: stream1, id: 1000.01, topic: topic7, sender_id: sender1, type: "stream", }); assert.equal( rt.reify_message_id_if_available({ old_id: 1000.01, new_id: 1001, }), true, ); rt.process_message({ stream_id: stream1, id: 1001.01, topic: topic7, sender_id: sender1, type: "stream", }); // A new message arrived in the same topic before we could reify the message_id rt.process_message({ stream_id: stream1, id: 1003, topic: topic7, sender_id: sender1, type: "stream", }); assert.equal( rt.reify_message_id_if_available({ old_id: 1000.01, new_id: 1001, }), false, ); }); test("test_delete_messages", (override) => { rt.clear_for_tests(); stub_out_filter_buttons(); rt.set_filter("all"); rt.process_messages(messages); // messages[0] was removed. let reduced_msgs = messages.slice(1); override(all_messages_data, "all_messages", () => reduced_msgs); let all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3,1:topic-2,1:topic-1", ); rt.update_topics_of_deleted_message_ids([messages[0].id]); all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3,1:topic-2", ); // messages[0], messages[1] and message[2] were removed. reduced_msgs = messages.slice(3); rt.update_topics_of_deleted_message_ids([messages[1].id, messages[2].id]); all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3", ); // test deleting a message which is not locally // stored, doesn't raise any errors. rt.update_topics_of_deleted_message_ids([-1]); }); test("test_topic_edit", (override) => { override(all_messages_data, "all_messages", () => messages); // NOTE: This test should always run in the end as it modified the messages data. rt.clear_for_tests(); stub_out_filter_buttons(); rt.set_filter("all"); rt.process_messages(messages); let all_topics = rt.get(); assert.equal( Array.from(all_topics.keys()).toString(), "4:topic-10,1:topic-7,1:topic-6,1:topic-5,1:topic-4,1:topic-3,1:topic-2,1:topic-1", ); // ---------------- test change topic ---------------- verify_topic_data(all_topics, stream1, topic6, messages[8].id, true); assert.equal(all_topics.get(get_topic_key(stream1, topic8)), undefined); // change topic of topic6 to topic8 messages[7].topic = topic8; messages[8].topic = topic8; rt.process_topic_edit(stream1, topic6, topic8); all_topics = rt.get(); verify_topic_data(all_topics, stream1, topic8, messages[8].id, true); assert.equal(all_topics.get(get_topic_key(stream1, topic6)), undefined); // ---------------- test stream change ---------------- verify_topic_data(all_topics, stream1, topic1, messages[0].id, true); assert.equal(all_topics.get(get_topic_key(stream2, topic1)), undefined); messages[0].stream_id = stream2; rt.process_topic_edit(stream1, topic1, topic1, stream2); all_topics = rt.get(); assert.equal(all_topics.get(get_topic_key(stream1, topic1)), undefined); verify_topic_data(all_topics, stream2, topic1, messages[0].id, true); // ---------------- test stream & topic change ---------------- verify_topic_data(all_topics, stream2, topic1, messages[0].id, true); assert.equal(all_topics.get(get_topic_key(stream3, topic9)), undefined); messages[0].stream_id = stream3; messages[0].topic = topic9; rt.process_topic_edit(stream2, topic1, topic9, stream3); all_topics = rt.get(); assert.equal(all_topics.get(get_topic_key(stream2, topic1)), undefined); verify_topic_data(all_topics, stream3, topic9, messages[0].id, true); // Message was moveed to a deleted stream, hence hidden regardless of filter. messages[0].stream_id = stream5; messages[0].topic = topic8; rt.process_topic_edit(stream3, topic9, topic8, stream5); all_topics = rt.get(); assert.equal(rt.filters_should_hide_topic(all_topics.get("5:topic-8")), true); }); test("test_search", () => { rt.clear_for_tests(); assert.equal(rt.topic_in_search_results("t", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("T", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("to", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("top", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("ToP", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("Topi", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("tOpi", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("toPic", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("Topic", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("topic", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("recent", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("RECENT", "general", "Recent topic"), true); // match in any order of words assert.equal(rt.topic_in_search_results("topic recent", "general", "Recent topic"), true); // Matches any sequence of words. assert.equal(rt.topic_in_search_results("o", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("nt to", "general", "Recent topic"), true); assert.equal(rt.topic_in_search_results("z", "general", "Recent topic"), false); assert.equal(rt.topic_in_search_results("?", "general", "Recent topic"), false); // Test special character match assert.equal(rt.topic_in_search_results(".*+?^${}()[]\\", "general", "Recent topic"), false); assert.equal(rt.topic_in_search_results("?", "general", "not-at-start?"), true); assert.equal(rt.topic_in_search_results("?", "general", "?"), true); assert.equal(rt.topic_in_search_results("?", "general", "\\?"), true); assert.equal(rt.topic_in_search_results("\\", "general", "\\"), true); assert.equal(rt.topic_in_search_results("\\", "general", "\\\\"), true); });