zulip/web/tests/narrow_state.test.js
Lauryn Menard 8d102cf12f web-search-suggestions: Update to use channel and channels.
Updates the search suggestions in the web app to use the modern
convention of "channel" and "channels".

Also, updates the "from" search suggestions to use the modern
canonical convention of "sender".

Part of stream to channel rename project.
2024-04-24 17:03:36 -07:00

340 lines
10 KiB
JavaScript

"use strict";
const {strict: assert} = require("assert");
const {zrequire} = require("./lib/namespace");
const {run_test} = require("./lib/test");
const {page_params} = require("./lib/zpage_params");
const people = zrequire("people");
const {Filter} = zrequire("../src/filter");
const stream_data = zrequire("stream_data");
const narrow_state = zrequire("narrow_state");
const message_lists = zrequire("message_lists");
function set_filter(raw_terms) {
const terms = raw_terms.map((op) => ({
operator: op[0],
operand: op[1],
}));
const filter = new Filter(terms);
message_lists.set_current({
data: {
filter,
},
});
return filter;
}
function test(label, f) {
run_test(label, ({override}) => {
message_lists.set_current(undefined);
stream_data.clear_subscriptions();
f({override});
});
}
test("stream", () => {
assert.equal(narrow_state.public_search_terms(), undefined);
assert.ok(!narrow_state.filter());
assert.equal(narrow_state.stream_id(), undefined);
const test_stream = {name: "Test", stream_id: 15};
stream_data.add_sub(test_stream);
assert.ok(!narrow_state.is_for_stream_id(test_stream.stream_id));
set_filter([
["stream", "Test"],
["topic", "Bar"],
["search", "yo"],
]);
assert.ok(narrow_state.filter());
assert.equal(narrow_state.stream_name(), "Test");
assert.equal(narrow_state.stream_id(), 15);
assert.equal(narrow_state.stream_sub().stream_id, test_stream.stream_id);
assert.equal(narrow_state.topic(), "Bar");
assert.ok(narrow_state.is_for_stream_id(test_stream.stream_id));
const expected_terms = [
{negated: false, operator: "channel", operand: "Test"},
{negated: false, operator: "topic", operand: "Bar"},
{negated: false, operator: "search", operand: "yo"},
];
const public_terms = narrow_state.public_search_terms();
assert.deepEqual(public_terms, expected_terms);
assert.equal(narrow_state.search_string(), "channel:Test topic:Bar yo");
});
test("narrowed", () => {
assert.ok(!narrow_state.narrowed_to_pms());
assert.ok(!narrow_state.narrowed_by_reply());
assert.ok(!narrow_state.narrowed_by_pm_reply());
assert.ok(!narrow_state.narrowed_by_topic_reply());
assert.ok(!narrow_state.narrowed_to_topic());
assert.ok(!narrow_state.narrowed_by_stream_reply());
assert.equal(narrow_state.stream_sub(), undefined);
set_filter([["stream", "Foo"]]);
assert.ok(!narrow_state.narrowed_to_pms());
assert.ok(!narrow_state.narrowed_by_reply());
assert.ok(!narrow_state.narrowed_by_pm_reply());
assert.ok(!narrow_state.narrowed_by_topic_reply());
assert.ok(!narrow_state.narrowed_to_topic());
assert.ok(narrow_state.narrowed_by_stream_reply());
set_filter([["dm", "[email protected]"]]);
assert.ok(narrow_state.narrowed_to_pms());
assert.ok(narrow_state.narrowed_by_reply());
assert.ok(narrow_state.narrowed_by_pm_reply());
assert.ok(!narrow_state.narrowed_by_topic_reply());
assert.ok(!narrow_state.narrowed_to_topic());
assert.ok(!narrow_state.narrowed_by_stream_reply());
set_filter([
["stream", "Foo"],
["topic", "bar"],
]);
assert.ok(!narrow_state.narrowed_to_pms());
assert.ok(narrow_state.narrowed_by_reply());
assert.ok(!narrow_state.narrowed_by_pm_reply());
assert.ok(narrow_state.narrowed_by_topic_reply());
assert.ok(narrow_state.narrowed_to_topic());
assert.ok(!narrow_state.narrowed_by_stream_reply());
set_filter([["search", "grail"]]);
assert.ok(!narrow_state.narrowed_to_pms());
assert.ok(!narrow_state.narrowed_by_reply());
assert.ok(!narrow_state.narrowed_by_pm_reply());
assert.ok(!narrow_state.narrowed_by_topic_reply());
assert.ok(!narrow_state.narrowed_to_topic());
assert.ok(!narrow_state.narrowed_by_stream_reply());
set_filter([["is", "starred"]]);
assert.ok(!narrow_state.narrowed_to_pms());
assert.ok(!narrow_state.narrowed_by_reply());
assert.ok(!narrow_state.narrowed_by_pm_reply());
assert.ok(!narrow_state.narrowed_by_topic_reply());
assert.ok(!narrow_state.narrowed_to_topic());
assert.ok(!narrow_state.narrowed_by_stream_reply());
});
test("terms", () => {
set_filter([
["stream", "Foo"],
["topic", "Bar"],
["search", "Yo"],
]);
let result = narrow_state.search_terms();
assert.equal(result.length, 3);
assert.equal(result[0].operator, "channel");
assert.equal(result[0].operand, "Foo");
assert.equal(result[1].operator, "topic");
assert.equal(result[1].operand, "Bar");
assert.equal(result[2].operator, "search");
assert.equal(result[2].operand, "yo");
message_lists.set_current(undefined);
result = narrow_state.search_terms();
assert.equal(result.length, 0);
page_params.narrow = [{operator: "stream", operand: "Foo"}];
result = narrow_state.search_terms();
assert.equal(result.length, 1);
assert.equal(result[0].operator, "channel");
assert.equal(result[0].operand, "Foo");
});
test("excludes_muted_topics", () => {
let filter = set_filter([["stream", "devel"]]);
assert.ok(filter.excludes_muted_topics());
// Combined feed view.
filter = set_filter([["in", "home"]]);
assert.ok(filter.excludes_muted_topics());
filter = set_filter([
["stream", "devel"],
["topic", "mac"],
]);
assert.ok(!filter.excludes_muted_topics());
filter = set_filter([["search", "whatever"]]);
assert.ok(!filter.excludes_muted_topics());
filter = set_filter([["is", "private"]]);
assert.ok(!filter.excludes_muted_topics());
filter = set_filter([["is", "starred"]]);
assert.ok(!filter.excludes_muted_topics());
});
test("set_compose_defaults", () => {
set_filter([
["stream", "Foo"],
["topic", "Bar"],
]);
// First try with a stream that doesn't exist.
let stream_and_topic = narrow_state.set_compose_defaults();
assert.equal(stream_and_topic.stream_id, undefined);
assert.equal(stream_and_topic.topic, "Bar");
const test_stream = {name: "Foo", stream_id: 72};
stream_data.add_sub(test_stream);
stream_and_topic = narrow_state.set_compose_defaults();
assert.equal(stream_and_topic.stream_id, 72);
assert.equal(stream_and_topic.topic, "Bar");
set_filter([["dm", "[email protected]"]]);
let dm_test = narrow_state.set_compose_defaults();
assert.equal(dm_test.private_message_recipient, undefined);
const john = {
email: "[email protected]",
user_id: 57,
full_name: "John Doe",
};
people.add_active_user(john);
people.add_active_user(john);
set_filter([["dm", "[email protected]"]]);
dm_test = narrow_state.set_compose_defaults();
assert.equal(dm_test.private_message_recipient, "[email protected]");
// Even though we renamed "pm-with" to "dm",
// compose defaults are set correctly.
set_filter([["pm-with", "[email protected]"]]);
dm_test = narrow_state.set_compose_defaults();
assert.equal(dm_test.private_message_recipient, "[email protected]");
set_filter([
["topic", "duplicate"],
["topic", "duplicate"],
]);
assert.deepEqual(narrow_state.set_compose_defaults(), {});
stream_data.add_sub({name: "ROME", stream_id: 99});
set_filter([["stream", "rome"]]);
const stream_test = narrow_state.set_compose_defaults();
assert.equal(stream_test.stream_id, 99);
});
test("update_email", () => {
const steve = {
email: "[email protected]",
user_id: 43,
full_name: "Steve",
};
people.add_active_user(steve);
set_filter([
["dm", "[email protected]"],
["sender", "[email protected]"],
["stream", "[email protected]"], // try to be tricky
]);
narrow_state.update_email(steve.user_id, "[email protected]");
const filter = narrow_state.filter();
assert.deepEqual(filter.operands("dm"), ["[email protected]"]);
assert.deepEqual(filter.operands("sender"), ["[email protected]"]);
assert.deepEqual(filter.operands("channel"), ["[email protected]"]);
});
test("topic", () => {
set_filter([
["stream", "Foo"],
["topic", "Bar"],
]);
assert.equal(narrow_state.topic(), "Bar");
set_filter([
["stream", "release"],
["topic", "@#$$^test"],
]);
assert.equal(narrow_state.topic(), "@#$$^test");
set_filter([]);
assert.equal(narrow_state.topic(), undefined);
set_filter([
["sender", "[email protected]"],
["dm", "[email protected]"],
]);
assert.equal(narrow_state.topic(), undefined);
message_lists.set_current(undefined);
assert.equal(narrow_state.topic(), undefined);
});
test("stream_sub", () => {
set_filter([]);
assert.equal(narrow_state.stream_name(), undefined);
assert.equal(narrow_state.stream_sub(), undefined);
set_filter([
["stream", "Foo"],
["topic", "Bar"],
]);
assert.equal(narrow_state.stream_name(), "Foo");
assert.equal(narrow_state.stream_sub(), undefined);
const sub = {name: "Foo", stream_id: 55};
stream_data.add_sub(sub);
assert.deepEqual(narrow_state.stream_sub(), sub);
set_filter([
["sender", "someone"],
["topic", "random"],
]);
assert.equal(narrow_state.stream_name(), undefined);
});
test("pm_ids_string", () => {
// This function will return undefined unless we're clearly
// narrowed to a specific direct message (including group
// direct messages) with real users.
message_lists.set_current(undefined);
assert.equal(narrow_state.pm_ids_string(), undefined);
assert.deepStrictEqual(narrow_state.pm_ids_set(), new Set());
set_filter([
["stream", "Foo"],
["topic", "Bar"],
]);
assert.equal(narrow_state.pm_ids_string(), undefined);
assert.deepStrictEqual(narrow_state.pm_ids_set(), new Set());
set_filter([["dm", ""]]);
assert.equal(narrow_state.pm_ids_string(), undefined);
assert.deepStrictEqual(narrow_state.pm_ids_set(), new Set());
set_filter([["dm", "[email protected]"]]);
assert.equal(narrow_state.pm_ids_string(), undefined);
assert.deepStrictEqual(narrow_state.pm_ids_set(), new Set());
const alice = {
email: "[email protected]",
user_id: 444,
full_name: "Alice",
};
const bob = {
email: "[email protected]",
user_id: 555,
full_name: "Bob",
};
people.add_active_user(alice);
people.add_active_user(bob);
set_filter([["dm", "[email protected],[email protected]"]]);
assert.equal(narrow_state.pm_ids_string(), "444,555");
assert.deepStrictEqual(narrow_state.pm_ids_set(), new Set([444, 555]));
});