/*global waitUntilPromise */ (function (root, factory) { define([ "jasmine", "mock", "test-utils" ], factory); } (this, function (jasmine, mock, test_utils) { "use strict"; const $iq = converse.env.$iq, $msg = converse.env.$msg, Backbone = converse.env.Backbone, Strophe = converse.env.Strophe, sizzle = converse.env.sizzle, _ = converse.env._, u = converse.env.utils; describe("A chat room", function () { it("can be bookmarked", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); let sent_stanza, IQ_id; const sendIQ = _converse.connection.sendIQ; spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) { sent_stanza = iq; IQ_id = sendIQ.bind(this)(iq, callback, errback); }); spyOn(_converse.connection, 'getUniqueId').and.callThrough(); await test_utils.openChatRoom(_converse, 'theplay', 'conference.shakespeare.lit', 'JC'); var jid = 'theplay@conference.shakespeare.lit'; const view = _converse.chatboxviews.get(jid); spyOn(view, 'renderBookmarkForm').and.callThrough(); spyOn(view, 'closeForm').and.callThrough(); await test_utils.waitUntil(() => !_.isNull(view.el.querySelector('.toggle-bookmark'))); let toggle = view.el.querySelector('.toggle-bookmark'); expect(toggle.title).toBe('Bookmark this groupchat'); toggle.click(); expect(view.renderBookmarkForm).toHaveBeenCalled(); view.el.querySelector('.button-cancel').click(); expect(view.closeForm).toHaveBeenCalled(); expect(u.hasClass('on-button', toggle), false); expect(toggle.title).toBe('Bookmark this groupchat'); toggle.click(); expect(view.renderBookmarkForm).toHaveBeenCalled(); /* Client uploads data: * -------------------- * * * * * * * JC * * * * * * * * http://jabber.org/protocol/pubsub#publish-options * * * true * * * whitelist * * * * * */ expect(view.model.get('bookmarked')).toBeFalsy(); const form = view.el.querySelector('.chatroom-form'); form.querySelector('input[name="name"]').value = 'Play's the Thing'; form.querySelector('input[name="autojoin"]').checked = 'checked'; form.querySelector('input[name="nick"]').value = 'JC'; _converse.connection.IQ_stanzas = []; view.el.querySelector('.btn-primary').click(); await test_utils.waitUntil(() => sent_stanza); expect(sent_stanza.toLocaleString()).toBe( ``+ ``+ ``+ ``+ ``+ ``+ `JC`+ ``+ ``+ ``+ ``+ ``+ ``+ ``+ `http://jabber.org/protocol/pubsub#publish-options`+ ``+ ``+ `true`+ ``+ ``+ `whitelist`+ ``+ ``+ ``+ ``+ `` ); /* Server acknowledges successful storage * * */ const stanza = $iq({ 'to':_converse.connection.jid, 'type':'result', 'id':IQ_id }); _converse.connection._dataRecv(test_utils.createRequest(stanza)); await test_utils.waitUntil(() => view.model.get('bookmarked')); toggle = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(view.model.get('bookmarked')).toBeTruthy(); expect(toggle.title).toBe('Unbookmark this groupchat'); expect(u.hasClass('on-button', toggle), true); // We ignore this IQ stanza... (unless it's an error stanza), so // nothing to test for here. done(); })); it("will be automatically opened if 'autojoin' is set on the bookmark", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); await test_utils.waitUntil(() => _converse.bookmarks); let jid = 'lounge@montague.lit'; _converse.bookmarks.create({ 'jid': jid, 'autojoin': false, 'name': 'The Lounge', 'nick': ' Othello' }); expect(_.isUndefined(_converse.chatboxviews.get(jid))).toBeTruthy(); jid = 'theplay@conference.shakespeare.lit'; _converse.bookmarks.create({ 'jid': jid, 'autojoin': true, 'name': 'The Play', 'nick': ' Othello' }); expect(_.isUndefined(_converse.chatboxviews.get(jid))).toBeFalsy(); // Check that we don't auto-join if muc_respect_autojoin is false _converse.muc_respect_autojoin = false; jid = 'balcony@conference.shakespeare.lit'; _converse.bookmarks.create({ 'jid': jid, 'autojoin': true, 'name': 'Balcony', 'nick': ' Othello' }); expect(_.isUndefined(_converse.chatboxviews.get(jid))).toBe(true); done(); })); describe("when bookmarked", function () { it("will use the nickname from the bookmark", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); const room_jid = 'coven@chat.shakespeare.lit'; await test_utils.waitUntil(() => _converse.bookmarks); _converse.bookmarks.create({ 'jid': room_jid, 'autojoin': false, 'name': 'The Play', 'nick': 'Othello' }); const model = await _converse.api.rooms.open(room_jid); spyOn(model, 'join').and.callThrough(); await test_utils.getRoomFeatures(_converse, 'coven', 'chat.shakespeare.lit'); await test_utils.waitUntil(() => model.join.calls.count()); expect(model.get('nick')).toBe('Othello'); done(); })); it("displays that it's bookmarked through its bookmark icon", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); await _converse.api.rooms.open(`lounge@montague.lit`); const view = _converse.chatboxviews.get('lounge@montague.lit'); let bookmark_icon = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(_.includes(bookmark_icon.classList, 'button-on')).toBeFalsy(); _converse.bookmarks.create({ 'jid': view.model.get('jid'), 'autojoin': false, 'name': 'The lounge', 'nick': ' some1' }); view.model.set('bookmarked', true); bookmark_icon = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(_.includes(bookmark_icon.classList, 'button-on')).toBeTruthy(); view.model.set('bookmarked', false); bookmark_icon = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(_.includes(bookmark_icon.classList, 'button-on')).toBeFalsy(); done(); })); it("can be unbookmarked", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { let sent_stanza, IQ_id; await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); const sendIQ = _converse.connection.sendIQ; await test_utils.openChatRoom(_converse, 'theplay', 'conference.shakespeare.lit', 'JC'); const jid = 'theplay@conference.shakespeare.lit'; const view = _converse.chatboxviews.get(jid); await test_utils.waitUntil(() => !_.isNull(view.el.querySelector('.toggle-bookmark'))); spyOn(view, 'toggleBookmark').and.callThrough(); spyOn(_converse.bookmarks, 'sendBookmarkStanza').and.callThrough(); view.delegateEvents(); _converse.bookmarks.create({ 'jid': view.model.get('jid'), 'autojoin': false, 'name': 'The Play', 'nick': ' Othello' }); expect(_converse.bookmarks.length).toBe(1); expect(view.model.get('bookmarked')).toBeTruthy(); let bookmark_icon = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(u.hasClass('button-on', bookmark_icon)).toBeTruthy(); spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) { sent_stanza = iq; IQ_id = sendIQ.bind(this)(iq, callback, errback); }); spyOn(_converse.connection, 'getUniqueId').and.callThrough(); bookmark_icon.click(); bookmark_icon = await test_utils.waitUntil(() => view.el.querySelector('.toggle-bookmark')); expect(view.toggleBookmark).toHaveBeenCalled(); expect(u.hasClass('button-on', bookmark_icon)).toBeFalsy(); expect(_converse.bookmarks.length).toBe(0); // Check that an IQ stanza is sent out, containing no // conferences to bookmark (since we removed the one and // only bookmark). expect(sent_stanza.toLocaleString()).toBe( ``+ ``+ ``+ ``+ ``+ ``+ ``+ ``+ ``+ ``+ `http://jabber.org/protocol/pubsub#publish-options`+ ``+ ``+ `true`+ ``+ ``+ `whitelist`+ ``+ ``+ ``+ ``+ `` ); done(); })); }); describe("and when autojoin is set", function () { it("will be be opened and joined automatically upon login", mock.initConverse( null, ['rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); spyOn(_converse.api.rooms, 'create').and.callThrough(); const jid = 'theplay@conference.shakespeare.lit'; const model = _converse.bookmarks.create({ 'jid': jid, 'autojoin': false, 'name': 'The Play', 'nick': '' }); expect(_converse.api.rooms.create).not.toHaveBeenCalled(); _converse.bookmarks.remove(model); _converse.bookmarks.create({ 'jid': jid, 'autojoin': true, 'name': 'Hamlet', 'nick': '' }); expect(_converse.api.rooms.create).toHaveBeenCalled(); done(); })); }); }); describe("Bookmarks", function () { it("can be pushed from the XMPP server", mock.initConverse( ['send'], ['rosterGroupsFetched', 'connected'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); await test_utils.waitUntil(() => _converse.bookmarks); // Emit here instead of mocking fetching of bookmarks. _converse.api.trigger('bookmarksInitialized'); /* The stored data is automatically pushed to all of the user's * connected resources. * * Publisher receives event notification * ------------------------------------- * * * * * * * JC * * * * * * */ var stanza = $msg({ 'from': 'romeo@montague.lit', 'to': 'romeo@montague.lit/orchard', 'type': 'headline', 'id': 'rnfoo1' }).c('event', {'xmlns': 'http://jabber.org/protocol/pubsub#event'}) .c('items', {'node': 'storage:bookmarks'}) .c('item', {'id': 'current'}) .c('storage', {'xmlns': 'storage:bookmarks'}) .c('conference', {'name': 'The Play's the Thing', 'autojoin': 'true', 'jid':'theplay@conference.shakespeare.lit'}) .c('nick').t('JC'); _converse.connection._dataRecv(test_utils.createRequest(stanza)); await test_utils.waitUntil(() => _converse.bookmarks.length); expect(_converse.bookmarks.length).toBe(1); expect(_converse.chatboxviews.get('theplay@conference.shakespeare.lit')).not.toBeUndefined(); done(); })); it("can be retrieved from the XMPP server", mock.initConverse( {'connection': ['send']}, ['chatBoxesFetched', 'roomsPanelRendered', 'rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); /* Client requests all items * ------------------------- * * * * * * */ let IQ_id; const call = await test_utils.waitUntil(() => _.filter( _converse.connection.send.calls.all(), call => { const stanza = call.args[0]; if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') { return; } if (sizzle('items[node="storage:bookmarks"]', stanza).length) { IQ_id = stanza.getAttribute('id'); return true; } } ).pop() ); expect(Strophe.serialize(call.args[0])).toBe( ``+ ''+ ''+ ''+ ''); /* * Server returns all items * ------------------------ * * * * * * * JC * * * * * * */ expect(_converse.bookmarks.models.length).toBe(0); spyOn(_converse.bookmarks, 'onBookmarksReceived').and.callThrough(); var stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id}) .c('pubsub', {'xmlns': Strophe.NS.PUBSUB}) .c('items', {'node': 'storage:bookmarks'}) .c('item', {'id': 'current'}) .c('storage', {'xmlns': 'storage:bookmarks'}) .c('conference', { 'name': 'The Play's the Thing', 'autojoin': 'true', 'jid': 'theplay@conference.shakespeare.lit' }).c('nick').t('JC').up().up() .c('conference', { 'name': 'Another room', 'autojoin': 'false', 'jid': 'another@conference.shakespeare.lit' }); // Purposefully exclude the element to test #1043 _converse.connection._dataRecv(test_utils.createRequest(stanza)); await test_utils.waitUntil(() => _converse.bookmarks.onBookmarksReceived.calls.count()); expect(_converse.bookmarks.models.length).toBe(2); expect(_converse.bookmarks.findWhere({'jid': 'theplay@conference.shakespeare.lit'}).get('autojoin')).toBe(true); expect(_converse.bookmarks.findWhere({'jid': 'another@conference.shakespeare.lit'}).get('autojoin')).toBe(false); done(); })); describe("The rooms panel", function () { it("shows a list of bookmarks", mock.initConverse( {'connection': ['send']}, ['rosterGroupsFetched'], {}, async function (done, _converse) { await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); test_utils.openControlBox(); let IQ_id; const call = await test_utils.waitUntil(() => _.filter( _converse.connection.send.calls.all(), call => { const stanza = call.args[0]; if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') { return; } if (sizzle('items[node="storage:bookmarks"]', stanza).length) { IQ_id = stanza.getAttribute('id'); return true; } } ).pop() ); expect(Strophe.serialize(call.args[0])).toBe( ``+ ''+ ''+ ''+ '' ); const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id}) .c('pubsub', {'xmlns': Strophe.NS.PUBSUB}) .c('items', {'node': 'storage:bookmarks'}) .c('item', {'id': 'current'}) .c('storage', {'xmlns': 'storage:bookmarks'}) .c('conference', { 'name': 'The Play's the Thing', 'autojoin': 'false', 'jid': 'theplay@conference.shakespeare.lit' }).c('nick').t('JC').up().up() .c('conference', { 'name': '1st Bookmark', 'autojoin': 'false', 'jid': 'first@conference.shakespeare.lit' }).c('nick').t('JC').up().up() .c('conference', { 'autojoin': 'false', 'jid': 'noname@conference.shakespeare.lit' }).c('nick').t('JC').up().up() .c('conference', { 'name': 'Bookmark with a very very long name that will be shortened', 'autojoin': 'false', 'jid': 'longname@conference.shakespeare.lit' }).c('nick').t('JC').up().up() .c('conference', { 'name': 'Another room', 'autojoin': 'false', 'jid': 'another@conference.shakespeare.lit' }).c('nick').t('JC').up().up(); _converse.connection._dataRecv(test_utils.createRequest(stanza)); await test_utils.waitUntil(() => document.querySelectorAll('#chatrooms div.bookmarks.rooms-list .room-item').length); expect(document.querySelectorAll('#chatrooms div.bookmarks.rooms-list .room-item').length).toBe(5); let els = document.querySelectorAll('#chatrooms div.bookmarks.rooms-list .room-item a.list-item-link'); expect(els[0].textContent).toBe("1st Bookmark"); expect(els[1].textContent).toBe("Another room"); expect(els[2].textContent).toBe("Bookmark with a very very long name that will be shortened"); expect(els[3].textContent).toBe("noname@conference.shakespeare.lit"); expect(els[4].textContent).toBe("The Play's the Thing"); spyOn(window, 'confirm').and.returnValue(true); document.querySelector('#chatrooms .bookmarks.rooms-list .room-item:nth-child(2) a:nth-child(2)').click(); expect(window.confirm).toHaveBeenCalled(); await test_utils.waitUntil(() => document.querySelectorAll('#chatrooms div.bookmarks.rooms-list .room-item').length === 4) els = document.querySelectorAll('#chatrooms div.bookmarks.rooms-list .room-item a.list-item-link'); expect(els[0].textContent).toBe("1st Bookmark"); expect(els[1].textContent).toBe("Bookmark with a very very long name that will be shortened"); expect(els[2].textContent).toBe("noname@conference.shakespeare.lit"); expect(els[3].textContent).toBe("The Play's the Thing"); done(); })); it("remembers the toggle state of the bookmarks list", mock.initConverse( {'connection': ['send']}, ['rosterGroupsFetched'], {}, async function (done, _converse) { test_utils.openControlBox(); await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); let IQ_id; const call = await test_utils.waitUntil(() => _.filter( _converse.connection.send.calls.all(), call => { const stanza = call.args[0]; if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') { return; } if (sizzle('items[node="storage:bookmarks"]', stanza).length) { IQ_id = stanza.getAttribute('id'); return true; } } ).pop() ); expect(Strophe.serialize(call.args[0])).toBe( ``+ ''+ ''+ ''+ '' ); const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id}) .c('pubsub', {'xmlns': Strophe.NS.PUBSUB}) .c('items', {'node': 'storage:bookmarks'}) .c('item', {'id': 'current'}) .c('storage', {'xmlns': 'storage:bookmarks'}); _converse.connection._dataRecv(test_utils.createRequest(stanza)); _converse.bookmarks.create({ 'jid': 'theplay@conference.shakespeare.lit', 'autojoin': false, 'name': 'The Play', 'nick': '' }); const el = _converse.chatboxviews.el const selector = '#chatrooms .bookmarks.rooms-list .room-item'; await test_utils.waitUntil(() => sizzle(selector, el).filter(u.isVisible).length); expect(u.hasClass('collapsed', sizzle('#chatrooms .bookmarks.rooms-list', el).pop())).toBeFalsy(); expect(sizzle(selector, el).filter(u.isVisible).length).toBe(1); expect(_converse.bookmarksview.list_model.get('toggle-state')).toBe(_converse.OPENED); sizzle('#chatrooms .bookmarks-toggle', el).pop().click(); expect(u.hasClass('collapsed', sizzle('#chatrooms .bookmarks.rooms-list', el).pop())).toBeTruthy(); expect(_converse.bookmarksview.list_model.get('toggle-state')).toBe(_converse.CLOSED); sizzle('#chatrooms .bookmarks-toggle', el).pop().click(); expect(u.hasClass('collapsed', sizzle('#chatrooms .bookmarks.rooms-list', el).pop())).toBeFalsy(); expect(sizzle(selector, el).filter(u.isVisible).length).toBe(1); expect(_converse.bookmarksview.list_model.get('toggle-state')).toBe(_converse.OPENED); done(); })); }); }); describe("When hide_open_bookmarks is true and a bookmarked room is opened", function () { it("can be closed", mock.initConverse( null, ['rosterGroupsFetched'], { hide_open_bookmarks: true }, async function (done, _converse) { const jid = 'room@conference.example.org'; await test_utils.waitUntilDiscoConfirmed( _converse, _converse.bare_jid, [{'category': 'pubsub', 'type': 'pep'}], ['http://jabber.org/protocol/pubsub#publish-options'] ); // XXX Create bookmarks view here, otherwise we need to mock stanza // traffic for it to get created. _converse.bookmarksview = new _converse.BookmarksView( {'model': _converse.bookmarks} ); _converse.api.trigger('bookmarksInitialized'); // Check that it's there _converse.bookmarks.create({ 'jid': jid, 'autojoin': false, 'name': 'The Play', 'nick': ' Othello' }); expect(_converse.bookmarks.length).toBe(1); const room_els = _converse.bookmarksview.el.querySelectorAll(".open-room"); expect(room_els.length).toBe(1); // Check that it disappears once the room is opened const bookmark = _converse.bookmarksview.el.querySelector(".open-room"); bookmark.click(); await test_utils.waitUntil(() => _converse.chatboxviews.get(jid)); expect(u.hasClass('hidden', _converse.bookmarksview.el.querySelector(".available-chatroom"))).toBeTruthy(); // Check that it reappears once the room is closed const view = _converse.chatboxviews.get(jid); view.close(); expect(u.hasClass('hidden', _converse.bookmarksview.el.querySelector(".available-chatroom"))).toBeFalsy(); done(); })); }); }));