upstream-zulip/web/tests/user_pill.test.cjs

"use strict";

const assert = require("node:assert/strict");

const {make_realm} = require("./lib/example_realm.cjs");
const {make_user} = require("./lib/example_user.cjs");
const {mock_esm, zrequire} = require("./lib/namespace.cjs");
const {run_test} = require("./lib/test.cjs");
const blueslip = require("./lib/zblueslip.cjs");

const people = zrequire("people");
const user_pill = zrequire("user_pill");
const {set_realm} = zrequire("state_data");

const settings_data = mock_esm("../src/settings_data");

const realm = make_realm();
set_realm(realm);

const alice = make_user({
    email: "alice@example.com",
    user_id: 99,
    full_name: "Alice Barson",
});

const isaac = make_user({
    email: "isaac@example.com",
    user_id: 102,
    full_name: "Isaac Newton",
});

const isaac_duplicate = make_user({
    email: "isaac_duplicate@example.com",
    user_id: 102102,
    full_name: "Isaac Newton",
});

const isaac_item = {
    email: "isaac@example.com",
    full_name: "Isaac Newton",
    type: "user",
    user_id: isaac.user_id,
    deactivated: false,
    img_src: `/avatar/${isaac.user_id}`,
    is_bot: false,
    status_emoji_info: undefined,
    should_add_guest_user_indicator: false,
};

const deactivated_user = make_user({
    email: "deactivated@example.com",
    user_id: 104,
    full_name: "Deactivated User",
});

const deactivated_user_item = {
    email: "deactivated@example.com",
    full_name: "Deactivated User",
    type: "user",
    user_id: deactivated_user.user_id,
    deactivated: true,
    img_src: `/avatar/${deactivated_user.user_id}`,
    is_bot: undefined,
    status_emoji_info: undefined,
    should_add_guest_user_indicator: false,
};

const inaccessible_user_id = 103;

const inaccessible_user_item = {
    email: "user103@example.com",
    full_name: "translated: Unknown user",
    type: "user",
    user_id: inaccessible_user_id,
    deactivated: false,
    img_src: `/avatar/${inaccessible_user_id}`,
    is_bot: false,
    status_emoji_info: undefined,
    should_add_guest_user_indicator: false,
};

let pill_widget = {};

function test(label, f) {
    run_test(label, ({override}) => {
        people.init();
        people.add_active_user(alice);
        people.add_active_user(isaac);
        pill_widget = {};
        f({override});
    });
}

test("create_item", ({override}) => {
    function test_create_item(user_id, current_items, expected_item, pill_config) {
        const item = user_pill.create_item_from_user_id(user_id, current_items, pill_config);
        assert.deepEqual(item, expected_item);
    }

    settings_data.user_can_access_all_other_users = () => false;

    test_create_item(isaac_item.user_id.toString(), [], isaac_item);
    test_create_item(isaac_item.user_id.toString(), [isaac_item], undefined);

    override(realm, "realm_bot_domain", "example.com");
    people.add_inaccessible_user(inaccessible_user_id);

    test_create_item(inaccessible_user_id.toString(), [], undefined, {
        exclude_inaccessible_users: true,
    });
    test_create_item(inaccessible_user_id.toString(), [], inaccessible_user_item, {
        exclude_inaccessible_users: false,
    });
});

test("get_unique_full_name_from_item", () => {
    people.add_active_user(isaac);
    people.add_active_user(isaac_duplicate);
    assert.equal(
        user_pill.get_unique_full_name_from_item({user_id: 1, full_name: isaac.full_name}),
        "Isaac Newton|1",
    );
});

test("append", ({override}) => {
    let appended;
    let cleared;

    let expected_item = isaac_item;

    function fake_append(opts) {
        appended = true;
        assert.equal(opts.email, expected_item.email);
        assert.equal(opts.full_name, expected_item.full_name);
        assert.equal(opts.user_id, expected_item.user_id);
        assert.equal(opts.img_src, expected_item.img_src);
        assert.equal(opts.deactivated, expected_item.deactivated);
    }

    function fake_clear() {
        cleared = true;
    }

    pill_widget.appendValidatedData = fake_append;
    pill_widget.clear_text = fake_clear;

    user_pill.append_person({
        person: isaac,
        pill_widget,
    });

    assert.ok(appended);
    assert.ok(cleared);

    // Test appending a deactivated user
    appended = false;
    cleared = false;

    people.add_active_user(deactivated_user);
    people.deactivate(deactivated_user);

    expected_item = deactivated_user_item;

    user_pill.append_person({
        person: deactivated_user,
        pill_widget,
    });

    assert.ok(appended);
    assert.ok(cleared);

    // Test appending an inaccessible user
    // We consider inaccessible users as active to avoid falsely showing them as deactivated,
    // since we don't have information about their activity status.
    appended = false;
    cleared = false;

    override(realm, "realm_bot_domain", "example.com");
    people.add_inaccessible_user(inaccessible_user_id);
    const inaccessible_user = people.get_by_user_id(inaccessible_user_id);
    // Deactivate the inaccessible user to verify they're still shown as active
    people.deactivate(inaccessible_user);

    expected_item = inaccessible_user_item;

    user_pill.append_person({
        person: inaccessible_user,
        pill_widget,
    });

    assert.ok(appended);
    assert.ok(cleared);

    blueslip.expect("warn", "Undefined user in function append_user");
    user_pill.append_user(undefined, pill_widget);
});

test("get_items", () => {
    const items = [isaac_item];
    pill_widget.items = () => items;

    assert.deepEqual(user_pill.get_user_ids(pill_widget), [isaac.user_id]);
});

test("typeahead", () => {
    const items = [isaac_item];
    pill_widget.items = () => items;

    // Both alice and isaac are in our realm, but isaac will be
    // excluded by virtue of already being one of the widget items.
    // And then bogus_item is just a red herring to test robustness.
    const result = user_pill.typeahead_source(pill_widget);
    assert.deepEqual(result, [{type: "user", user: alice}]);
});

test("update_pill_full_name", () => {
    const pill = {item: {...isaac_item}, $element: {0: {}}};
    let pill_updated = false;
    pill_widget.getPillByPredicate = (predicate) => (predicate(pill.item) ? pill : undefined);
    pill_widget.updatePill = (_element, item) => {
        pill.item = item;
        pill_updated = true;
    };

    assert.equal(pill.item.full_name, "Isaac Newton");
    user_pill.update_pill_full_name(pill_widget, isaac.user_id, "Sir Isaac Newton");
    assert.equal(pill.item.full_name, "Sir Isaac Newton");
    assert.ok(pill_updated);

    // No-op when no matching pill.
    pill_updated = false;
    user_pill.update_pill_full_name(pill_widget, 999, "Nobody");
    assert.ok(!pill_updated);
});