Files
zulip/frontend_tests/node_tests/drafts.js
Steve Howell 94ffef4de9 zjquery: Eliminate css() helper.
We use css() pretty rarely in our codebase, and
it can sometimes be used mistakenly, when a better
alternative is to toggle a class for external css.

It's hard to support the full API in zjquery, so
we just punt and tell folks to create their own
stubs.

Most of the existing tests that were "fixed" here
weren't actually verifying the behavior of the css()
calls, and for those I just create no-op stubs.

In a few places I verify that css() was called as
expected.
2021-06-04 20:08:19 -07:00

321 lines
8.7 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"use strict";
const {strict: assert} = require("assert");
const {stub_templates} = require("../zjsunit/handlebars");
const {mock_cjs, mock_esm, set_global, zrequire, with_overrides} = require("../zjsunit/namespace");
const {run_test} = require("../zjsunit/test");
const $ = require("../zjsunit/zjquery");
const {page_params} = require("../zjsunit/zpage_params");
const ls_container = new Map();
const noop = () => {};
const localStorage = 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();
},
});
mock_cjs("jquery", $);
const compose_state = mock_esm("../../static/js/compose_state");
mock_esm("../../static/js/markdown", {
apply_markdown: noop,
});
mock_esm("../../static/js/stream_data", {
get_color() {
return "#FFFFFF";
},
});
page_params.twenty_four_hour_time = false;
const {localstorage} = zrequire("localstorage");
const drafts = zrequire("drafts");
const timerender = zrequire("timerender");
const legacy_draft = {
stream: "stream",
subject: "lunch",
type: "stream",
content: "whatever",
};
const compose_args_for_legacy_draft = {
stream: "stream",
topic: "lunch",
type: "stream",
content: "whatever",
};
const draft_1 = {
stream: "stream",
topic: "topic",
type: "stream",
content: "Test stream message",
};
const draft_2 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "aaron@zulip.com",
type: "private",
content: "Test private message",
};
const short_msg = {
stream: "stream",
subject: "topic",
type: "stream",
content: "a",
};
function test(label, f) {
run_test(label, (override) => {
$("#draft_overlay").css = () => {};
localStorage.clear();
f(override);
});
}
test("legacy", () => {
assert.deepEqual(drafts.restore_message(legacy_draft), compose_args_for_legacy_draft);
});
test("draft_model add", (override) => {
const draft_model = drafts.draft_model;
const ls = localstorage();
assert.equal(ls.get("draft"), undefined);
override(Date, "now", () => 1);
const expected = {...draft_1};
expected.updatedAt = 1;
const id = draft_model.addDraft({...draft_1});
assert.deepEqual(draft_model.getDraft(id), expected);
});
test("draft_model edit", () => {
const draft_model = drafts.draft_model;
const ls = localstorage();
assert.equal(ls.get("draft"), undefined);
let id;
with_overrides((override) => {
override(Date, "now", () => 1);
const expected = {...draft_1};
expected.updatedAt = 1;
id = draft_model.addDraft({...draft_1});
assert.deepEqual(draft_model.getDraft(id), expected);
});
with_overrides((override) => {
override(Date, "now", () => 2);
const expected = {...draft_2};
expected.updatedAt = 2;
draft_model.editDraft(id, {...draft_2});
assert.deepEqual(draft_model.getDraft(id), expected);
});
});
test("draft_model delete", (override) => {
const draft_model = drafts.draft_model;
const ls = localstorage();
assert.equal(ls.get("draft"), undefined);
override(Date, "now", () => 1);
const expected = {...draft_1};
expected.updatedAt = 1;
const id = draft_model.addDraft({...draft_1});
assert.deepEqual(draft_model.getDraft(id), expected);
draft_model.deleteDraft(id);
assert.deepEqual(draft_model.getDraft(id), false);
});
test("snapshot_message", (override) => {
let curr_draft;
function map(field, f) {
override(compose_state, field, f);
}
map("get_message_type", () => curr_draft.type);
map("composing", () => Boolean(curr_draft.type));
map("message_content", () => curr_draft.content);
map("stream_name", () => curr_draft.stream);
map("topic", () => curr_draft.topic);
map("private_message_recipient", () => curr_draft.private_message_recipient);
curr_draft = draft_1;
assert.deepEqual(drafts.snapshot_message(), draft_1);
curr_draft = draft_2;
assert.deepEqual(drafts.snapshot_message(), draft_2);
curr_draft = short_msg;
assert.deepEqual(drafts.snapshot_message(), undefined);
curr_draft = {};
assert.equal(drafts.snapshot_message(), undefined);
});
test("initialize", (override) => {
window.addEventListener = (event_name, f) => {
assert.equal(event_name, "beforeunload");
let called = false;
override(drafts, "update_draft", () => {
called = true;
});
f();
assert(called);
};
drafts.initialize();
});
test("remove_old_drafts", () => {
const draft_3 = {
stream: "stream",
subject: "topic",
type: "stream",
content: "Test stream message",
updatedAt: Date.now(),
};
const draft_4 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "aaron@zulip.com",
type: "private",
content: "Test private message",
updatedAt: new Date().setDate(-30),
};
const draft_model = drafts.draft_model;
const ls = localstorage();
const data = {id3: draft_3, id4: draft_4};
ls.set("drafts", data);
assert.deepEqual(draft_model.get(), data);
drafts.remove_old_drafts();
assert.deepEqual(draft_model.get(), {id3: draft_3});
});
test("format_drafts", (override) => {
override(drafts, "remove_old_drafts", noop);
function feb12() {
return new Date(1549958107000); // 2/12/2019 07:55:07 AM (UTC+0)
}
function date(offset) {
return feb12().setDate(offset);
}
const draft_1 = {
stream: "stream",
topic: "topic",
type: "stream",
content: "Test stream message",
updatedAt: feb12().getTime(),
};
const draft_2 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "aaron@zulip.com",
type: "private",
content: "Test private message",
updatedAt: date(-1),
};
const draft_3 = {
stream: "stream 2",
subject: "topic",
type: "stream",
content: "Test stream message 2",
updatedAt: date(-10),
};
const draft_4 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "iago@zulip.com",
type: "private",
content: "Test private message 2",
updatedAt: date(-5),
};
const draft_5 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "zoe@zulip.com",
type: "private",
content: "Test private message 3",
updatedAt: date(-2),
};
const expected = [
{
draft_id: "id1",
is_stream: true,
stream: "stream",
stream_color: "#FFFFFF",
dark_background: "",
topic: "topic",
raw_content: "Test stream message",
time_stamp: "7:55 AM",
},
{
draft_id: "id2",
is_stream: false,
recipients: "aaron@zulip.com",
raw_content: "Test private message",
time_stamp: "Jan 30",
},
{
draft_id: "id5",
is_stream: false,
recipients: "aaron@zulip.com",
raw_content: "Test private message 3",
time_stamp: "Jan 29",
},
{
draft_id: "id4",
is_stream: false,
recipients: "aaron@zulip.com",
raw_content: "Test private message 2",
time_stamp: "Jan 26",
},
{
draft_id: "id3",
is_stream: true,
stream: "stream 2",
stream_color: "#FFFFFF",
dark_background: "",
topic: "topic",
raw_content: "Test stream message 2",
time_stamp: "Jan 21",
},
];
$("#drafts_table").append = noop;
const draft_model = drafts.draft_model;
const ls = localstorage();
const data = {id1: draft_1, id2: draft_2, id3: draft_3, id4: draft_4, id5: draft_5};
ls.set("drafts", data);
assert.deepEqual(draft_model.get(), data);
const stub_render_now = timerender.render_now;
override(timerender, "render_now", (time) => stub_render_now(time, new Date(1549958107000)));
stub_templates((template_name, data) => {
assert.equal(template_name, "draft_table_body");
// Tests formatting and sorting of drafts
assert.deepEqual(data.drafts, expected);
return "<draft table stub>";
});
override(drafts, "open_overlay", noop);
override(drafts, "set_initial_element", noop);
$.create("#drafts_table .draft-row", {children: []});
drafts.launch();
timerender.__Rewire__("render_now", stub_render_now);
});