node tests: Move peer_data tests to new peer_data.js.

frontend_tests/node_tests/peer_data.js

@@ -0,0 +1,298 @@
+"use strict";
+
+/*
+    This mostly tests the peer_data module, but it
+    also tests some stream_data functions that are
+    glorified wrappers for peer_data functions.
+*/
+
+const {strict: assert} = require("assert");
+
+const {set_global, with_field, zrequire} = require("../zjsunit/namespace");
+const {run_test} = require("../zjsunit/test");
+
+const peer_data = zrequire("peer_data");
+const people = zrequire("people");
+zrequire("hash_util");
+zrequire("stream_data");
+
+set_global("page_params", {
+    is_admin: false,
+    realm_users: [],
+    is_guest: false,
+});
+
+const me = {
+    email: "me@zulip.com",
+    full_name: "Current User",
+    user_id: 100,
+};
+
+// set up user data
+people.add_active_user(me);
+people.initialize_current_user(me.user_id);
+
+function contains_sub(subs, sub) {
+    return subs.some((s) => s.name === sub.name);
+}
+
+run_test("unsubscribe", () => {
+    stream_data.clear_subscriptions();
+
+    let sub = {name: "devel", subscribed: false, stream_id: 1};
+
+    // set up our subscription
+    stream_data.add_sub(sub);
+    sub.subscribed = true;
+    peer_data.set_subscribers(sub.stream_id, [me.user_id]);
+
+    // ensure our setup is accurate
+    assert(stream_data.is_subscribed("devel"));
+
+    // DO THE UNSUBSCRIBE HERE
+    stream_data.unsubscribe_myself(sub);
+    assert(!sub.subscribed);
+    assert(!stream_data.is_subscribed("devel"));
+    assert(!contains_sub(stream_data.subscribed_subs(), sub));
+    assert(contains_sub(stream_data.unsubscribed_subs(), sub));
+
+    // make sure subsequent calls work
+    sub = stream_data.get_sub("devel");
+    assert(!sub.subscribed);
+});
+
+run_test("subscribers", () => {
+    stream_data.clear_subscriptions();
+    let sub = {name: "Rome", subscribed: true, stream_id: 1001};
+
+    stream_data.add_sub(sub);
+
+    const fred = {
+        email: "fred@zulip.com",
+        full_name: "Fred",
+        user_id: 101,
+    };
+    const not_fred = {
+        email: "not_fred@zulip.com",
+        full_name: "Not Fred",
+        user_id: 102,
+    };
+    const george = {
+        email: "george@zulip.com",
+        full_name: "George",
+        user_id: 103,
+    };
+    people.add_active_user(fred);
+    people.add_active_user(not_fred);
+    people.add_active_user(george);
+
+    function potential_subscriber_ids() {
+        const users = peer_data.potential_subscribers(sub.stream_id);
+        return users.map((u) => u.user_id).sort();
+    }
+
+    assert.deepEqual(potential_subscriber_ids(), [
+        me.user_id,
+        fred.user_id,
+        not_fred.user_id,
+        george.user_id,
+    ]);
+
+    peer_data.set_subscribers(sub.stream_id, [me.user_id, fred.user_id, george.user_id]);
+    stream_data.update_calculated_fields(sub);
+    assert(stream_data.is_user_subscribed(sub.stream_id, me.user_id));
+    assert(stream_data.is_user_subscribed(sub.stream_id, fred.user_id));
+    assert(stream_data.is_user_subscribed(sub.stream_id, george.user_id));
+    assert(!stream_data.is_user_subscribed(sub.stream_id, not_fred.user_id));
+
+    assert.deepEqual(potential_subscriber_ids(), [not_fred.user_id]);
+
+    peer_data.set_subscribers(sub.stream_id, []);
+
+    const brutus = {
+        email: "brutus@zulip.com",
+        full_name: "Brutus",
+        user_id: 104,
+    };
+    people.add_active_user(brutus);
+    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+
+    // add
+    let ok = peer_data.add_subscriber(sub.stream_id, brutus.user_id);
+    assert(ok);
+    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+    sub = stream_data.get_sub("Rome");
+    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 1);
+    const sub_email = "Rome:214125235@zulipdev.com:9991";
+    stream_data.update_stream_email_address(sub, sub_email);
+    assert.equal(sub.email_address, sub_email);
+
+    // verify that adding an already-added subscriber is a noop
+    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
+    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+    sub = stream_data.get_sub("Rome");
+    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 1);
+
+    // remove
+    ok = peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
+    assert(ok);
+    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+    sub = stream_data.get_sub("Rome");
+    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 0);
+
+    // verify that checking subscription with undefined user id
+
+    blueslip.expect("warn", "Undefined user_id passed to function is_user_subscribed");
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, undefined), undefined);
+
+    // Verify noop for bad stream when removing subscriber
+    const bad_stream_id = 999999;
+    blueslip.expect(
+        "warn",
+        "We got a remove_subscriber call for an untracked stream " + bad_stream_id,
+    );
+    ok = peer_data.remove_subscriber(bad_stream_id, brutus.user_id);
+    assert(!ok);
+
+    // verify that removing an already-removed subscriber is a noop
+    blueslip.expect("warn", "We tried to remove invalid subscriber: 104");
+    ok = peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
+    assert(!ok);
+    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+    sub = stream_data.get_sub("Rome");
+    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 0);
+
+    // Verify defensive code in set_subscribers, where the second parameter
+    // can be undefined.
+    stream_data.add_sub(sub);
+    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
+    sub.subscribed = true;
+    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
+
+    // Verify that we noop and don't crash when unsubscribed.
+    sub.subscribed = false;
+    stream_data.update_calculated_fields(sub);
+    ok = peer_data.add_subscriber(sub.stream_id, brutus.user_id);
+    assert(ok);
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), true);
+    peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), false);
+    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), true);
+
+    blueslip.expect(
+        "warn",
+        "We got a is_user_subscribed call for a non-existent or inaccessible stream.",
+        2,
+    );
+    sub.invite_only = true;
+    stream_data.update_calculated_fields(sub);
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), undefined);
+    peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
+    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), undefined);
+
+    // Verify that we don't crash and return false for a bad stream.
+    blueslip.expect("warn", "We got an add_subscriber call for an untracked stream: 9999999");
+    ok = peer_data.add_subscriber(9999999, brutus.user_id);
+    assert(!ok);
+
+    // Verify that we don't crash and return false for a bad user id.
+    blueslip.expect("error", "Unknown user_id in get_by_user_id: 9999999");
+    blueslip.expect("error", "We tried to add invalid subscriber: 9999999");
+    ok = peer_data.add_subscriber(sub.stream_id, 9999999);
+    assert(!ok);
+});
+
+run_test("get_subscriber_count", () => {
+    const india = {
+        stream_id: 102,
+        name: "India",
+        subscribed: true,
+    };
+    stream_data.clear_subscriptions();
+
+    blueslip.expect("warn", "We got a get_subscriber_count call for an untracked stream: 102");
+    assert.equal(peer_data.get_subscriber_count(india.stream_id), undefined);
+
+    stream_data.add_sub(india);
+    assert.equal(peer_data.get_subscriber_count(india.stream_id), 0);
+
+    const fred = {
+        email: "fred@zulip.com",
+        full_name: "Fred",
+        user_id: 101,
+    };
+    people.add_active_user(fred);
+    peer_data.add_subscriber(india.stream_id, 102);
+    assert.equal(peer_data.get_subscriber_count(india.stream_id), 1);
+    const george = {
+        email: "george@zulip.com",
+        full_name: "George",
+        user_id: 103,
+    };
+    people.add_active_user(george);
+    peer_data.add_subscriber(india.stream_id, 103);
+    assert.equal(peer_data.get_subscriber_count(india.stream_id), 2);
+
+    peer_data.remove_subscriber(india.stream_id, 103);
+    assert.deepStrictEqual(peer_data.get_subscriber_count(india.stream_id), 1);
+});
+
+run_test("is_subscriber_subset", () => {
+    function make_sub(stream_id, user_ids) {
+        const sub = {stream_id};
+        peer_data.set_subscribers(sub.stream_id, user_ids);
+        return sub;
+    }
+
+    const sub_a = make_sub(301, [1, 2]);
+    const sub_b = make_sub(302, [2, 3]);
+    const sub_c = make_sub(303, [1, 2, 3]);
+
+    // The bogus case should not come up in normal
+    // use.
+    // We simply punt on any calculation if
+    // a stream has no subscriber info (like
+    // maybe Zephyr?).
+    const bogus = {}; // no subscribers
+
+    const matrix = [
+        [sub_a, sub_a, true],
+        [sub_a, sub_b, false],
+        [sub_a, sub_c, true],
+        [sub_b, sub_a, false],
+        [sub_b, sub_b, true],
+        [sub_b, sub_c, true],
+        [sub_c, sub_a, false],
+        [sub_c, sub_b, false],
+        [sub_c, sub_c, true],
+        [bogus, bogus, false],
+    ];
+
+    for (const row of matrix) {
+        assert.equal(peer_data.is_subscriber_subset(row[0].stream_id, row[1].stream_id), row[2]);
+    }
+});
+
+run_test("warn if subscribers are missing", () => {
+    // This should only happen in this contrived test situation.
+    stream_data.clear_subscriptions();
+    const sub = {
+        name: "test",
+        stream_id: 3,
+        can_access_subscribers: true,
+    };
+
+    with_field(
+        stream_data,
+        "get_sub_by_id",
+        () => sub,
+        () => {
+            blueslip.expect("warn", "We called is_user_subscribed for an untracked stream: 3");
+            stream_data.is_user_subscribed(sub.stream_id, me.user_id);
+
+            blueslip.expect("warn", "We called get_subscribers for an untracked stream: 3");
+            assert.deepEqual(peer_data.get_subscribers(sub.stream_id), []);
+        },
+    );
+});

frontend_tests/node_tests/stream_data.js

@@ -4,7 +4,7 @@ const {strict: assert} = require("assert");
 
 const _ = require("lodash");
 
-const {set_global, stub_out_jquery, with_field, zrequire} = require("../zjsunit/namespace");
+const {set_global, stub_out_jquery, zrequire} = require("../zjsunit/namespace");
 const {run_test} = require("../zjsunit/test");
 
 set_global("page_params", {
@@ -19,7 +19,6 @@ stub_out_jquery();
 zrequire("color_data");
 zrequire("hash_util");
 zrequire("stream_topic_history");
-const peer_data = zrequire("peer_data");
 const people = zrequire("people");
 zrequire("stream_color");
 zrequire("stream_data");
@@ -153,173 +152,6 @@ run_test("renames", () => {
     assert.equal(actual_id, 42);
 });
 
-run_test("unsubscribe", () => {
-    stream_data.clear_subscriptions();
-
-    let sub = {name: "devel", subscribed: false, stream_id: 1};
-
-    // set up our subscription
-    stream_data.add_sub(sub);
-    sub.subscribed = true;
-    peer_data.set_subscribers(sub.stream_id, [me.user_id]);
-
-    // ensure our setup is accurate
-    assert(stream_data.is_subscribed("devel"));
-
-    // DO THE UNSUBSCRIBE HERE
-    stream_data.unsubscribe_myself(sub);
-    assert(!sub.subscribed);
-    assert(!stream_data.is_subscribed("devel"));
-    assert(!contains_sub(stream_data.subscribed_subs(), sub));
-    assert(contains_sub(stream_data.unsubscribed_subs(), sub));
-
-    // make sure subsequent calls work
-    sub = stream_data.get_sub("devel");
-    assert(!sub.subscribed);
-});
-
-run_test("subscribers", () => {
-    stream_data.clear_subscriptions();
-    let sub = {name: "Rome", subscribed: true, stream_id: 1001};
-
-    stream_data.add_sub(sub);
-
-    const fred = {
-        email: "fred@zulip.com",
-        full_name: "Fred",
-        user_id: 101,
-    };
-    const not_fred = {
-        email: "not_fred@zulip.com",
-        full_name: "Not Fred",
-        user_id: 102,
-    };
-    const george = {
-        email: "george@zulip.com",
-        full_name: "George",
-        user_id: 103,
-    };
-    people.add_active_user(fred);
-    people.add_active_user(not_fred);
-    people.add_active_user(george);
-
-    function potential_subscriber_ids() {
-        const users = peer_data.potential_subscribers(sub.stream_id);
-        return users.map((u) => u.user_id).sort();
-    }
-
-    assert.deepEqual(potential_subscriber_ids(), [
-        me.user_id,
-        fred.user_id,
-        not_fred.user_id,
-        george.user_id,
-    ]);
-
-    peer_data.set_subscribers(sub.stream_id, [me.user_id, fred.user_id, george.user_id]);
-    stream_data.update_calculated_fields(sub);
-    assert(stream_data.is_user_subscribed(sub.stream_id, me.user_id));
-    assert(stream_data.is_user_subscribed(sub.stream_id, fred.user_id));
-    assert(stream_data.is_user_subscribed(sub.stream_id, george.user_id));
-    assert(!stream_data.is_user_subscribed(sub.stream_id, not_fred.user_id));
-
-    assert.deepEqual(potential_subscriber_ids(), [not_fred.user_id]);
-
-    peer_data.set_subscribers(sub.stream_id, []);
-
-    const brutus = {
-        email: "brutus@zulip.com",
-        full_name: "Brutus",
-        user_id: 104,
-    };
-    people.add_active_user(brutus);
-    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-
-    // add
-    let ok = peer_data.add_subscriber(sub.stream_id, brutus.user_id);
-    assert(ok);
-    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-    sub = stream_data.get_sub("Rome");
-    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 1);
-    const sub_email = "Rome:214125235@zulipdev.com:9991";
-    stream_data.update_stream_email_address(sub, sub_email);
-    assert.equal(sub.email_address, sub_email);
-
-    // verify that adding an already-added subscriber is a noop
-    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
-    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-    sub = stream_data.get_sub("Rome");
-    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 1);
-
-    // remove
-    ok = peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
-    assert(ok);
-    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-    sub = stream_data.get_sub("Rome");
-    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 0);
-
-    // verify that checking subscription with undefined user id
-
-    blueslip.expect("warn", "Undefined user_id passed to function is_user_subscribed");
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, undefined), undefined);
-
-    // Verify noop for bad stream when removing subscriber
-    const bad_stream_id = 999999;
-    blueslip.expect(
-        "warn",
-        "We got a remove_subscriber call for an untracked stream " + bad_stream_id,
-    );
-    ok = peer_data.remove_subscriber(bad_stream_id, brutus.user_id);
-    assert(!ok);
-
-    // verify that removing an already-removed subscriber is a noop
-    blueslip.expect("warn", "We tried to remove invalid subscriber: 104");
-    ok = peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
-    assert(!ok);
-    assert(!stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-    sub = stream_data.get_sub("Rome");
-    assert.equal(peer_data.get_subscriber_count(sub.stream_id), 0);
-
-    // Verify defensive code in set_subscribers, where the second parameter
-    // can be undefined.
-    stream_data.add_sub(sub);
-    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
-    sub.subscribed = true;
-    assert(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id));
-
-    // Verify that we noop and don't crash when unsubscribed.
-    sub.subscribed = false;
-    stream_data.update_calculated_fields(sub);
-    ok = peer_data.add_subscriber(sub.stream_id, brutus.user_id);
-    assert(ok);
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), true);
-    peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), false);
-    peer_data.add_subscriber(sub.stream_id, brutus.user_id);
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), true);
-
-    blueslip.expect(
-        "warn",
-        "We got a is_user_subscribed call for a non-existent or inaccessible stream.",
-        2,
-    );
-    sub.invite_only = true;
-    stream_data.update_calculated_fields(sub);
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), undefined);
-    peer_data.remove_subscriber(sub.stream_id, brutus.user_id);
-    assert.equal(stream_data.is_user_subscribed(sub.stream_id, brutus.user_id), undefined);
-
-    // Verify that we don't crash and return false for a bad stream.
-    blueslip.expect("warn", "We got an add_subscriber call for an untracked stream: 9999999");
-    ok = peer_data.add_subscriber(9999999, brutus.user_id);
-    assert(!ok);
-
-    // Verify that we don't crash and return false for a bad user id.
-    blueslip.expect("error", "Unknown user_id in get_by_user_id: 9999999");
-    blueslip.expect("error", "We tried to add invalid subscriber: 9999999");
-    ok = peer_data.add_subscriber(sub.stream_id, 9999999);
-    assert(!ok);
-});
-
 run_test("is_active", () => {
     stream_data.clear_subscriptions();
 
@@ -595,41 +427,6 @@ run_test("delete_sub", () => {
     stream_data.delete_sub(99999);
 });
 
-run_test("get_subscriber_count", () => {
-    const india = {
-        stream_id: 102,
-        name: "India",
-        subscribed: true,
-    };
-    stream_data.clear_subscriptions();
-
-    blueslip.expect("warn", "We got a get_subscriber_count call for an untracked stream: 102");
-    assert.equal(peer_data.get_subscriber_count(india.stream_id), undefined);
-
-    stream_data.add_sub(india);
-    assert.equal(peer_data.get_subscriber_count(india.stream_id), 0);
-
-    const fred = {
-        email: "fred@zulip.com",
-        full_name: "Fred",
-        user_id: 101,
-    };
-    people.add_active_user(fred);
-    peer_data.add_subscriber(india.stream_id, 102);
-    assert.equal(peer_data.get_subscriber_count(india.stream_id), 1);
-    const george = {
-        email: "george@zulip.com",
-        full_name: "George",
-        user_id: 103,
-    };
-    people.add_active_user(george);
-    peer_data.add_subscriber(india.stream_id, 103);
-    assert.equal(peer_data.get_subscriber_count(india.stream_id), 2);
-
-    peer_data.remove_subscriber(india.stream_id, 103);
-    assert.deepStrictEqual(peer_data.get_subscriber_count(india.stream_id), 1);
-});
-
 run_test("notifications", () => {
     const india = {
         stream_id: 102,
@@ -970,42 +767,6 @@ run_test("filter inactives", () => {
     assert(stream_data.is_filtering_inactives());
 });
 
-run_test("is_subscriber_subset", () => {
-    function make_sub(stream_id, user_ids) {
-        const sub = {stream_id};
-        peer_data.set_subscribers(sub.stream_id, user_ids);
-        return sub;
-    }
-
-    const sub_a = make_sub(301, [1, 2]);
-    const sub_b = make_sub(302, [2, 3]);
-    const sub_c = make_sub(303, [1, 2, 3]);
-
-    // The bogus case should not come up in normal
-    // use.
-    // We simply punt on any calculation if
-    // a stream has no subscriber info (like
-    // maybe Zephyr?).
-    const bogus = {}; // no subscribers
-
-    const matrix = [
-        [sub_a, sub_a, true],
-        [sub_a, sub_b, false],
-        [sub_a, sub_c, true],
-        [sub_b, sub_a, false],
-        [sub_b, sub_b, true],
-        [sub_b, sub_c, true],
-        [sub_c, sub_a, false],
-        [sub_c, sub_b, false],
-        [sub_c, sub_c, true],
-        [bogus, bogus, false],
-    ];
-
-    for (const row of matrix) {
-        assert.equal(peer_data.is_subscriber_subset(row[0].stream_id, row[1].stream_id), row[2]);
-    }
-});
-
 run_test("edge_cases", () => {
     const bad_stream_ids = [555555, 99999];
 
@@ -1083,26 +844,3 @@ run_test("all_topics_in_cache", () => {
     sub.first_message_id = 2;
     assert.equal(stream_data.all_topics_in_cache(sub), true);
 });
-
-run_test("warn if subscribers are missing", () => {
-    // This should only happen in this contrived test situation.
-    stream_data.clear_subscriptions();
-    const sub = {
-        name: "test",
-        stream_id: 3,
-        can_access_subscribers: true,
-    };
-
-    with_field(
-        stream_data,
-        "get_sub_by_id",
-        () => sub,
-        () => {
-            blueslip.expect("warn", "We called is_user_subscribed for an untracked stream: 3");
-            stream_data.is_user_subscribed(sub.stream_id, me.user_id);
-
-            blueslip.expect("warn", "We called get_subscribers for an untracked stream: 3");
-            assert.deepEqual(peer_data.get_subscribers(sub.stream_id), []);
-        },
-    );
-});

static/js/peer_data.js

@@ -1,13 +1,6 @@
 const {LazySet} = require("./lazy_set");
 const people = require("./people");
 
-/*
-
-For legacy reasons this module is mostly tested
-by frontend_tests/node_tests/stream_data.js.
-
-*/
-
 // This maps a stream_id to a LazySet of user_ids who are subscribed.
 // We maintain the invariant that this has keys for all all stream_ids
 // that we track in the other data structures.  We intialize it during