Files
zulip/frontend_tests/node_tests/drafts.js
Tim Abbott ea7c6d395f compose_state: Rename compost_state.recipient to be about PMs only.
The compose_state.recipient field was only actually the recipient for
the message if it was a private_message_recipient (in the sense of
other code); we store the stream in compose_state.stream instead.

As a result, the name was quite confusing, resulting in the
possibility of problematic correctness bugs where code assumes this
field has a valid value for stream messages.  Fix this by changing it
to compose_state.private_message_recipient for clarity.
2019-12-02 08:53:55 -08:00

334 lines
8.9 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.
set_global('$', global.make_zjquery());
set_global('i18n', global.stub_i18n);
zrequire('localstorage');
zrequire('drafts');
set_global('XDate', zrequire('XDate', 'xdate'));
zrequire('timerender');
set_global('Handlebars', global.make_handlebars());
zrequire('util');
zrequire('stream_color');
zrequire('colorspace');
let ls_container = {};
const noop = function () { return; };
set_global('localStorage', {
getItem: function (key) {
return ls_container[key];
},
setItem: function (key, val) {
ls_container[key] = val;
},
removeItem: function (key) {
delete ls_container[key];
},
clear: function () {
ls_container = {};
},
});
set_global('compose', {});
set_global('compose_state', {});
set_global('stream_data', {
get_color: function () {
return '#FFFFFF';
},
});
set_global('blueslip', {});
set_global('people', {
// Mocking get_by_email function, here we are
// just returning string before `@` in email
get_by_email: function (email) {
return {
full_name: email.split('@')[0],
};
},
});
set_global('markdown', {
apply_markdown: noop,
});
set_global('page_params', {
twenty_four_hour_time: false,
});
function stub_timestamp(timestamp, func) {
const original_func = Date.prototype.getTime;
Date.prototype.getTime = function () {
return timestamp;
};
func();
Date.prototype.getTime = original_func;
}
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",
};
run_test('legacy', () => {
assert.deepEqual(
drafts.restore_message(legacy_draft),
compose_args_for_legacy_draft
);
});
run_test('draft_model', () => {
const draft_model = drafts.draft_model;
const ls = localstorage();
localStorage.clear();
(function test_get() {
const expected = { id1: draft_1, id2: draft_2 };
ls.set("drafts", expected);
assert.deepEqual(draft_model.get(), expected);
}());
localStorage.clear();
(function test_get() {
ls.set("drafts", { id1: draft_1 });
assert.deepEqual(draft_model.getDraft("id1"), draft_1);
assert.equal(draft_model.getDraft("id2"), false);
}());
localStorage.clear();
(function test_addDraft() {
stub_timestamp(1, function () {
const expected = _.clone(draft_1);
expected.updatedAt = 1;
const id = draft_model.addDraft(_.clone(draft_1));
assert.deepEqual(ls.get("drafts")[id], expected);
});
}());
localStorage.clear();
(function test_editDraft() {
stub_timestamp(2, function () {
ls.set("drafts", { id1: draft_1 });
const expected = _.clone(draft_2);
expected.updatedAt = 2;
draft_model.editDraft("id1", _.clone(draft_2));
assert.deepEqual(ls.get("drafts").id1, expected);
});
}());
localStorage.clear();
(function test_deleteDraft() {
ls.set("drafts", { id1: draft_1 });
draft_model.deleteDraft("id1");
assert.deepEqual(ls.get("drafts"), {});
}());
});
run_test('snapshot_message', () => {
function stub_draft(draft) {
global.compose_state.get_message_type = function () {
return draft.type;
};
global.compose_state.composing = function () {
return !!draft.type;
};
global.compose_state.message_content = function () {
return draft.content;
};
global.compose_state.private_message_recipient = function () {
return draft.private_message_recipient;
};
global.compose_state.stream_name = function () {
return draft.stream;
};
global.compose_state.topic = function () {
return draft.topic;
};
}
stub_draft(draft_1);
assert.deepEqual(drafts.snapshot_message(), draft_1);
stub_draft(draft_2);
assert.deepEqual(drafts.snapshot_message(), draft_2);
stub_draft(short_msg);
assert.deepEqual(drafts.snapshot_message(), undefined);
stub_draft({});
assert.equal(drafts.snapshot_message(), undefined);
});
run_test('initialize', () => {
const message_content = $("#compose-textarea");
message_content.focusout = function (f) {
assert.equal(f, drafts.update_draft);
f();
};
global.window.addEventListener = function (event_name, f) {
assert.equal(event_name, "beforeunload");
let called = false;
drafts.update_draft = function () { called = true; };
f();
assert(called);
};
drafts.initialize();
});
run_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();
localStorage.clear();
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});
});
run_test('format_drafts', () => {
drafts.remove_old_drafts = noop;
draft_1.updatedAt = new Date(1549958107000).getTime(); // 2/12/2019 07:55:07 AM (UTC+0)
draft_2.updatedAt = new Date(1549958107000).setDate(-1);
const draft_3 = {
stream: "stream 2",
subject: "topic",
type: "stream",
content: "Test Stream Message 2",
updatedAt: new Date(1549958107000).setDate(-10),
};
const draft_4 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "iago@zulip.com",
type: "private",
content: "Test Private Message 2",
updatedAt: new Date(1549958107000).setDate(-5),
};
const draft_5 = {
private_message_recipient: "aaron@zulip.com",
reply_to: "zoe@zulip.com",
type: "private",
content: "Test Private Message 3",
updatedAt: new Date(1549958107000).setDate(-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',
raw_content: 'Test Private Message',
time_stamp: 'Jan 30',
},
{
draft_id: 'id5',
is_stream: false,
recipients: 'aaron',
raw_content: 'Test Private Message 3',
time_stamp: 'Jan 29',
},
{
draft_id: 'id4',
is_stream: false,
recipients: 'aaron',
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',
},
];
blueslip.error = noop;
$('#drafts_table').append = noop;
const draft_model = drafts.draft_model;
const ls = localstorage();
localStorage.clear();
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;
timerender.render_now = function (time) {
return stub_render_now(time, new XDate(1549958107000));
};
global.stub_templates(function (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>';
});
drafts.open_modal = noop;
drafts.set_initial_element = noop;
$("#drafts_table .draft-row").length = 0;
drafts.launch();
timerender.render_now = stub_render_now;
});