chatbox.js 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217
  1. /*global mock, converse, _ */
  2. const $msg = converse.env.$msg;
  3. const Strophe = converse.env.Strophe;
  4. const u = converse.env.utils;
  5. const sizzle = converse.env.sizzle;
  6. const original_timeout = jasmine.DEFAULT_TIMEOUT_INTERVAL;
  7. describe("Chatboxes", function () {
  8. beforeEach(() => (jasmine.DEFAULT_TIMEOUT_INTERVAL = 7000));
  9. afterEach(() => (jasmine.DEFAULT_TIMEOUT_INTERVAL = original_timeout));
  10. describe("A Chatbox", function () {
  11. it("has a /help command to show the available commands", mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  12. await mock.waitForRoster(_converse, 'current', 1);
  13. await mock.openControlBox(_converse);
  14. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  15. await mock.openChatBoxFor(_converse, contact_jid);
  16. const view = _converse.chatboxviews.get(contact_jid);
  17. mock.sendMessage(view, '/help');
  18. await u.waitUntil(() => sizzle('.chat-info:not(.chat-date)', view.el).length);
  19. const info_messages = await u.waitUntil(() => sizzle('.chat-info:not(.chat-date)', view.el));
  20. expect(info_messages.length).toBe(4);
  21. expect(info_messages.pop().textContent).toBe('/help: Show this menu');
  22. expect(info_messages.pop().textContent).toBe('/me: Write in the third person');
  23. expect(info_messages.pop().textContent).toBe('/close: Close this chat');
  24. expect(info_messages.pop().textContent).toBe('/clear: Remove messages');
  25. const msg = $msg({
  26. from: contact_jid,
  27. to: _converse.connection.jid,
  28. type: 'chat',
  29. id: u.getUniqueId()
  30. }).c('body').t('hello world').tree();
  31. await _converse.handleMessageStanza(msg);
  32. await u.waitUntil(() => view.content.querySelectorAll('.chat-msg').length);
  33. const msg_txt_sel = 'converse-chat-message:last-child .chat-msg__body';
  34. await u.waitUntil(() => view.querySelector(msg_txt_sel).textContent.trim() === 'hello world');
  35. done();
  36. }));
  37. it("has a /clear command", mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  38. await mock.waitForRoster(_converse, 'current', 1);
  39. await mock.openControlBox(_converse);
  40. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  41. await mock.openChatBoxFor(_converse, contact_jid);
  42. const view = _converse.chatboxviews.get(contact_jid);
  43. spyOn(window, 'confirm').and.returnValue(true);
  44. for (const i of Array(10).keys()) {
  45. mock.sendMessage(view, `Message ${i}`);
  46. }
  47. await u.waitUntil(() => sizzle('converse-chat-message', view.el).length === 10);
  48. const textarea = view.querySelector('textarea.chat-textarea');
  49. textarea.value = '/clear';
  50. view.onKeyDown({
  51. target: textarea,
  52. preventDefault: function preventDefault () {},
  53. keyCode: 13 // Enter
  54. });
  55. expect(window.confirm).toHaveBeenCalled();
  56. await u.waitUntil(() => sizzle('converse-chat-message', view.el).length === 0);
  57. done();
  58. }));
  59. it("is created when you click on a roster item", mock.initConverse(
  60. ['chatBoxesFetched'], {}, async function (done, _converse) {
  61. await mock.waitForRoster(_converse, 'current');
  62. await mock.openControlBox(_converse);
  63. // openControlBox was called earlier, so the controlbox is
  64. // visible, but no other chat boxes have been created.
  65. expect(_converse.chatboxes.length).toEqual(1);
  66. spyOn(_converse.minimize, 'trimChats');
  67. expect(document.querySelectorAll("#conversejs .chatbox").length).toBe(1); // Controlbox is open
  68. const rosterview = document.querySelector('converse-roster');
  69. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group li').length, 700);
  70. const online_contacts = rosterview.querySelectorAll('.roster-group .current-xmpp-contact a.open-chat');
  71. expect(online_contacts.length).toBe(17);
  72. let el = online_contacts[0];
  73. el.click();
  74. await u.waitUntil(() => document.querySelectorAll("#conversejs .chatbox").length == 2);
  75. expect(_converse.minimize.trimChats).toHaveBeenCalled();
  76. online_contacts[1].click();
  77. await u.waitUntil(() => _converse.chatboxes.length == 3);
  78. el = online_contacts[1];
  79. expect(_converse.minimize.trimChats).toHaveBeenCalled();
  80. // Check that new chat boxes are created to the left of the
  81. // controlbox (but to the right of all existing chat boxes)
  82. expect(document.querySelectorAll("#conversejs .chatbox").length).toBe(3);
  83. done();
  84. }));
  85. it("opens when a new message is received", mock.initConverse(
  86. [], {'allow_non_roster_messaging': true},
  87. async function (done, _converse) {
  88. await mock.waitForRoster(_converse, 'current', 0);
  89. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  90. const stanza = u.toStanza(`
  91. <message from="${sender_jid}"
  92. type="chat"
  93. to="romeo@montague.lit/orchard">
  94. <body>Hey\nHave you heard the news?</body>
  95. </message>`);
  96. const message_promise = new Promise(resolve => _converse.api.listen.on('message', resolve));
  97. _converse.connection._dataRecv(mock.createRequest(stanza));
  98. await new Promise(resolve => _converse.api.listen.once('chatBoxViewInitialized', resolve));
  99. await u.waitUntil(() => message_promise);
  100. expect(_converse.chatboxviews.keys().length).toBe(2);
  101. done();
  102. }));
  103. it("doesn't open when a message without body is received", mock.initConverse([], {}, async function (done, _converse) {
  104. await mock.waitForRoster(_converse, 'current', 1);
  105. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  106. const stanza = u.toStanza(`
  107. <message from="${sender_jid}"
  108. type="chat"
  109. to="romeo@montague.lit/orchard">
  110. <composing xmlns="http://jabber.org/protocol/chatstates"/>
  111. </message>`);
  112. const message_promise = new Promise(resolve => _converse.api.listen.on('message', resolve))
  113. _converse.connection._dataRecv(mock.createRequest(stanza));
  114. await u.waitUntil(() => message_promise);
  115. expect(_converse.chatboxviews.keys().length).toBe(1);
  116. done();
  117. }));
  118. it("is focused if its already open and you click on its corresponding roster item",
  119. mock.initConverse(['chatBoxesFetched'], {'auto_focus': true}, async function (done, _converse) {
  120. await mock.waitForRoster(_converse, 'current');
  121. await mock.openControlBox(_converse);
  122. expect(_converse.chatboxes.length).toEqual(1);
  123. const contact_jid = mock.cur_names[2].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  124. spyOn(_converse.ChatBoxView.prototype, 'focus').and.callThrough();
  125. const view = await mock.openChatBoxFor(_converse, contact_jid);
  126. const rosterview = document.querySelector('converse-roster');
  127. const el = sizzle('a.open-chat:contains("'+view.model.getDisplayName()+'")', rosterview.el).pop();
  128. await u.waitUntil(() => u.isVisible(el));
  129. const textarea = view.querySelector('.chat-textarea');
  130. await u.waitUntil(() => u.isVisible(textarea));
  131. textarea.blur();
  132. el.click();
  133. await u.waitUntil(() => view.focus.calls.count(), 1000);
  134. expect(view.focus).toHaveBeenCalled();
  135. expect(_converse.chatboxes.length).toEqual(2);
  136. done();
  137. }));
  138. it("can be saved to, and retrieved from, browserStorage",
  139. mock.initConverse([], {}, async function (done, _converse) {
  140. spyOn(_converse.minimize, 'trimChats');
  141. await mock.waitForRoster(_converse, 'current');
  142. await mock.openControlBox(_converse);
  143. spyOn(_converse.api, "trigger").and.callThrough();
  144. mock.openChatBoxes(_converse, 6);
  145. await u.waitUntil(() => _converse.chatboxes.length == 7);
  146. expect(_converse.minimize.trimChats).toHaveBeenCalled();
  147. // We instantiate a new ChatBoxes collection, which by default
  148. // will be empty.
  149. const newchatboxes = new _converse.ChatBoxes();
  150. expect(newchatboxes.length).toEqual(0);
  151. // The chatboxes will then be fetched from browserStorage inside the
  152. // onConnected method
  153. newchatboxes.onConnected();
  154. await new Promise(resolve => _converse.api.listen.on('chatBoxesFetched', resolve));
  155. expect(newchatboxes.length).toEqual(7);
  156. // Check that the chatboxes items retrieved from browserStorage
  157. // have the same attributes values as the original ones.
  158. const attrs = ['id', 'box_id', 'visible'];
  159. let new_attrs, old_attrs;
  160. for (let i=0; i<attrs.length; i++) {
  161. new_attrs = _.map(_.map(newchatboxes.models, 'attributes'), attrs[i]);
  162. old_attrs = _.map(_.map(_converse.chatboxes.models, 'attributes'), attrs[i]);
  163. expect(_.isEqual(new_attrs, old_attrs)).toEqual(true);
  164. }
  165. done();
  166. }));
  167. it("can be closed by clicking a DOM element with class 'close-chatbox-button'",
  168. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  169. await mock.waitForRoster(_converse, 'current');
  170. const contact_jid = mock.cur_names[7].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  171. const rosterview = document.querySelector('converse-roster');
  172. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  173. await mock.openChatBoxFor(_converse, contact_jid);
  174. const chatview = _converse.chatboxviews.get(contact_jid);
  175. spyOn(chatview, 'close').and.callThrough();
  176. spyOn(_converse.api, "trigger").and.callThrough();
  177. // We need to rebind all events otherwise our spy won't be called
  178. chatview.delegateEvents();
  179. chatview.querySelector('.close-chatbox-button').click();
  180. expect(chatview.close).toHaveBeenCalled();
  181. await new Promise(resolve => _converse.api.listen.once('chatBoxClosed', resolve));
  182. expect(_converse.api.trigger).toHaveBeenCalledWith('chatBoxClosed', jasmine.any(Object));
  183. done();
  184. }));
  185. it("will be removed from browserStorage when closed",
  186. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  187. await mock.waitForRoster(_converse, 'current');
  188. await mock.openControlBox(_converse);
  189. spyOn(_converse.minimize, 'trimChats');
  190. const rosterview = document.querySelector('converse-roster');
  191. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  192. spyOn(_converse.api, "trigger").and.callThrough();
  193. const promise = new Promise(resolve => _converse.api.listen.once('controlBoxClosed', resolve));
  194. mock.closeControlBox();
  195. await promise;
  196. expect(_converse.chatboxes.length).toEqual(1);
  197. expect(_converse.chatboxes.pluck('id')).toEqual(['controlbox']);
  198. mock.openChatBoxes(_converse, 6);
  199. await u.waitUntil(() => _converse.chatboxes.length == 7)
  200. expect(_converse.minimize.trimChats).toHaveBeenCalled();
  201. expect(_converse.chatboxes.length).toEqual(7);
  202. expect(_converse.api.trigger).toHaveBeenCalledWith('chatBoxViewInitialized', jasmine.any(Object));
  203. await mock.closeAllChatBoxes(_converse);
  204. expect(_converse.chatboxes.length).toEqual(1);
  205. expect(_converse.chatboxes.pluck('id')).toEqual(['controlbox']);
  206. expect(_converse.api.trigger).toHaveBeenCalledWith('chatBoxClosed', jasmine.any(Object));
  207. const newchatboxes = new _converse.ChatBoxes();
  208. expect(newchatboxes.length).toEqual(0);
  209. expect(_converse.chatboxes.pluck('id')).toEqual(['controlbox']);
  210. // onConnected will fetch chatboxes in browserStorage, but
  211. // because there aren't any open chatboxes, there won't be any
  212. // in browserStorage either. XXX except for the controlbox
  213. newchatboxes.onConnected();
  214. await new Promise(resolve => _converse.api.listen.on('chatBoxesFetched', resolve));
  215. expect(newchatboxes.length).toEqual(1);
  216. expect(newchatboxes.models[0].id).toBe("controlbox");
  217. done();
  218. }));
  219. describe("A chat toolbar", function () {
  220. it("shows the remaining character count if a message_limit is configured",
  221. mock.initConverse(['chatBoxesFetched'], {'message_limit': 200}, async function (done, _converse) {
  222. await mock.waitForRoster(_converse, 'current', 3);
  223. await mock.openControlBox(_converse);
  224. const contact_jid = mock.cur_names[2].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  225. await mock.openChatBoxFor(_converse, contact_jid);
  226. const view = _converse.chatboxviews.get(contact_jid);
  227. const toolbar = view.querySelector('.chat-toolbar');
  228. const counter = toolbar.querySelector('.message-limit');
  229. expect(counter.textContent).toBe('200');
  230. view.insertIntoTextArea('hello world');
  231. expect(counter.textContent).toBe('188');
  232. toolbar.querySelector('.toggle-emojis').click();
  233. const picker = await u.waitUntil(() => view.querySelector('.emoji-picker__lists'));
  234. const item = await u.waitUntil(() => picker.querySelector('.emoji-picker li.insert-emoji a'));
  235. item.click()
  236. expect(counter.textContent).toBe('179');
  237. const textarea = view.querySelector('.chat-textarea');
  238. const ev = {
  239. target: textarea,
  240. preventDefault: function preventDefault () {},
  241. keyCode: 13 // Enter
  242. };
  243. view.onKeyDown(ev);
  244. await new Promise(resolve => view.model.messages.once('rendered', resolve));
  245. view.onKeyUp(ev);
  246. expect(counter.textContent).toBe('200');
  247. textarea.value = 'hello world';
  248. view.onKeyUp(ev);
  249. expect(counter.textContent).toBe('189');
  250. done();
  251. }));
  252. it("does not show a remaining character count if message_limit is zero",
  253. mock.initConverse(['chatBoxesFetched'], {'message_limit': 0}, async function (done, _converse) {
  254. await mock.waitForRoster(_converse, 'current', 3);
  255. await mock.openControlBox(_converse);
  256. const contact_jid = mock.cur_names[2].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  257. await mock.openChatBoxFor(_converse, contact_jid);
  258. const view = _converse.chatboxviews.get(contact_jid);
  259. const counter = view.querySelector('.chat-toolbar .message-limit');
  260. expect(counter).toBe(null);
  261. done();
  262. }));
  263. it("can contain a button for starting a call",
  264. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  265. await mock.waitForRoster(_converse, 'current');
  266. await mock.openControlBox(_converse);
  267. let toolbar, call_button;
  268. const contact_jid = mock.cur_names[2].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  269. spyOn(_converse.api, "trigger").and.callThrough();
  270. // First check that the button doesn't show if it's not enabled
  271. // via "visible_toolbar_buttons"
  272. _converse.visible_toolbar_buttons.call = false;
  273. await mock.openChatBoxFor(_converse, contact_jid);
  274. let view = _converse.chatboxviews.get(contact_jid);
  275. toolbar = view.querySelector('.chat-toolbar');
  276. call_button = toolbar.querySelector('.toggle-call');
  277. expect(call_button === null).toBeTruthy();
  278. view.close();
  279. // Now check that it's shown if enabled and that it emits
  280. // callButtonClicked
  281. _converse.visible_toolbar_buttons.call = true; // enable the button
  282. await mock.openChatBoxFor(_converse, contact_jid);
  283. view = _converse.chatboxviews.get(contact_jid);
  284. toolbar = view.querySelector('.chat-toolbar');
  285. call_button = toolbar.querySelector('.toggle-call');
  286. call_button.click();
  287. expect(_converse.api.trigger).toHaveBeenCalledWith('callButtonClicked', jasmine.any(Object));
  288. done();
  289. }));
  290. });
  291. describe("A Chat Status Notification", function () {
  292. it("does not open a new chatbox", mock.initConverse([], {}, async function (done, _converse) {
  293. await mock.waitForRoster(_converse, 'current');
  294. await mock.openControlBox(_converse);
  295. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  296. // <composing> state
  297. const stanza = $msg({
  298. 'from': sender_jid,
  299. 'to': _converse.connection.jid,
  300. 'type': 'chat',
  301. 'id': u.getUniqueId()
  302. }).c('composing', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  303. spyOn(_converse.api, "trigger").and.callThrough();
  304. _converse.connection._dataRecv(mock.createRequest(stanza));
  305. await u.waitUntil(() => _converse.api.trigger.calls.count());
  306. expect(_converse.api.trigger).toHaveBeenCalledWith('message', jasmine.any(Object));
  307. expect(_converse.chatboxviews.keys().length).toBe(1);
  308. done();
  309. }));
  310. describe("An active notification", function () {
  311. it("is sent when the user opens a chat box",
  312. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  313. await mock.waitForRoster(_converse, 'current');
  314. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  315. await mock.openControlBox(_converse);
  316. const rosterview = document.querySelector('converse-roster');
  317. u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  318. spyOn(_converse.connection, 'send');
  319. await mock.openChatBoxFor(_converse, contact_jid);
  320. const view = _converse.chatboxviews.get(contact_jid);
  321. expect(view.model.get('chat_state')).toBe('active');
  322. expect(_converse.connection.send).toHaveBeenCalled();
  323. const stanza = _converse.connection.send.calls.argsFor(0)[0].tree();
  324. expect(stanza.getAttribute('to')).toBe(contact_jid);
  325. expect(stanza.childNodes.length).toBe(3);
  326. expect(stanza.childNodes[0].tagName).toBe('active');
  327. expect(stanza.childNodes[1].tagName).toBe('no-store');
  328. expect(stanza.childNodes[2].tagName).toBe('no-permanent-store');
  329. done();
  330. }));
  331. it("is sent when the user maximizes a minimized a chat box", mock.initConverse(
  332. ['chatBoxesFetched'], {}, async function (done, _converse) {
  333. await mock.waitForRoster(_converse, 'current', 1);
  334. await mock.openControlBox(_converse);
  335. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  336. const rosterview = document.querySelector('converse-roster');
  337. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  338. await mock.openChatBoxFor(_converse, contact_jid);
  339. const view = _converse.chatboxviews.get(contact_jid);
  340. _converse.minimize.minimize(view.model);
  341. expect(view.model.get('chat_state')).toBe('inactive');
  342. spyOn(_converse.connection, 'send');
  343. _converse.minimize.maximize(view.model);
  344. await u.waitUntil(() => view.model.get('chat_state') === 'active', 1000);
  345. expect(_converse.connection.send).toHaveBeenCalled();
  346. const calls = _.filter(_converse.connection.send.calls.all(), function (call) {
  347. return call.args[0] instanceof Strophe.Builder;
  348. });
  349. expect(calls.length).toBe(1);
  350. const stanza = calls[0].args[0].tree();
  351. expect(stanza.getAttribute('to')).toBe(contact_jid);
  352. expect(stanza.childNodes.length).toBe(3);
  353. expect(stanza.childNodes[0].tagName).toBe('active');
  354. expect(stanza.childNodes[1].tagName).toBe('no-store');
  355. expect(stanza.childNodes[2].tagName).toBe('no-permanent-store');
  356. done();
  357. }));
  358. });
  359. describe("A composing notification", function () {
  360. it("is sent as soon as the user starts typing a message which is not a command",
  361. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  362. await mock.waitForRoster(_converse, 'current');
  363. await mock.openControlBox(_converse);
  364. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  365. const rosterview = document.querySelector('converse-roster');
  366. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  367. await mock.openChatBoxFor(_converse, contact_jid);
  368. var view = _converse.chatboxviews.get(contact_jid);
  369. expect(view.model.get('chat_state')).toBe('active');
  370. spyOn(_converse.connection, 'send');
  371. spyOn(_converse.api, "trigger").and.callThrough();
  372. view.onKeyDown({
  373. target: view.querySelector('textarea.chat-textarea'),
  374. keyCode: 1
  375. });
  376. expect(view.model.get('chat_state')).toBe('composing');
  377. expect(_converse.connection.send).toHaveBeenCalled();
  378. const stanza = _converse.connection.send.calls.argsFor(0)[0].tree();
  379. expect(stanza.getAttribute('to')).toBe(contact_jid);
  380. expect(stanza.childNodes.length).toBe(3);
  381. expect(stanza.childNodes[0].tagName).toBe('composing');
  382. expect(stanza.childNodes[1].tagName).toBe('no-store');
  383. expect(stanza.childNodes[2].tagName).toBe('no-permanent-store');
  384. // The notification is not sent again
  385. view.onKeyDown({
  386. target: view.querySelector('textarea.chat-textarea'),
  387. keyCode: 1
  388. });
  389. expect(view.model.get('chat_state')).toBe('composing');
  390. expect(_converse.api.trigger.calls.count(), 1);
  391. done();
  392. }));
  393. it("is NOT sent out if send_chat_state_notifications doesn't allow it",
  394. mock.initConverse(['chatBoxesFetched'], {'send_chat_state_notifications': []},
  395. async function (done, _converse) {
  396. await mock.waitForRoster(_converse, 'current');
  397. await mock.openControlBox(_converse);
  398. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  399. const rosterview = document.querySelector('converse-roster');
  400. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  401. await mock.openChatBoxFor(_converse, contact_jid);
  402. var view = _converse.chatboxviews.get(contact_jid);
  403. expect(view.model.get('chat_state')).toBe('active');
  404. spyOn(_converse.connection, 'send');
  405. spyOn(_converse.api, "trigger").and.callThrough();
  406. view.onKeyDown({
  407. target: view.querySelector('textarea.chat-textarea'),
  408. keyCode: 1
  409. });
  410. expect(view.model.get('chat_state')).toBe('composing');
  411. expect(_converse.connection.send).not.toHaveBeenCalled();
  412. done();
  413. }));
  414. it("will be shown if received", mock.initConverse([], {}, async function (done, _converse) {
  415. await mock.waitForRoster(_converse, 'current');
  416. await mock.openControlBox(_converse);
  417. // See XEP-0085 https://xmpp.org/extensions/xep-0085.html#definitions
  418. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  419. const rosterview = document.querySelector('converse-roster');
  420. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  421. await mock.openChatBoxFor(_converse, sender_jid);
  422. // <composing> state
  423. let msg = $msg({
  424. from: sender_jid,
  425. to: _converse.connection.jid,
  426. type: 'chat',
  427. id: u.getUniqueId()
  428. }).c('composing', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  429. _converse.connection._dataRecv(mock.createRequest(msg));
  430. const view = _converse.chatboxviews.get(sender_jid);
  431. let csn = mock.cur_names[1] + ' is typing';
  432. await u.waitUntil( () => view.querySelector('.chat-content__notifications').innerText === csn);
  433. expect(view.model.messages.length).toEqual(0);
  434. // <paused> state
  435. msg = $msg({
  436. from: sender_jid,
  437. to: _converse.connection.jid,
  438. type: 'chat',
  439. id: u.getUniqueId()
  440. }).c('paused', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  441. _converse.connection._dataRecv(mock.createRequest(msg));
  442. csn = mock.cur_names[1] + ' has stopped typing';
  443. await u.waitUntil( () => view.querySelector('.chat-content__notifications').innerText === csn);
  444. msg = $msg({
  445. from: sender_jid,
  446. to: _converse.connection.jid,
  447. type: 'chat',
  448. id: u.getUniqueId()
  449. }).c('body').t('hello world').tree();
  450. await _converse.handleMessageStanza(msg);
  451. const msg_el = await u.waitUntil(() => view.content.querySelector('.chat-msg'));
  452. await u.waitUntil( () => view.querySelector('.chat-content__notifications').innerText === '');
  453. expect(msg_el.querySelector('.chat-msg__text').textContent).toBe('hello world');
  454. done();
  455. }));
  456. it("is ignored if it's a composing carbon message sent by this user from a different client",
  457. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  458. await mock.waitUntilDiscoConfirmed(_converse, 'montague.lit', [], ['vcard-temp']);
  459. await u.waitUntil(() => _converse.xmppstatus.vcard.get('fullname'));
  460. await mock.waitForRoster(_converse, 'current');
  461. // Send a message from a different resource
  462. const recipient_jid = mock.cur_names[5].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  463. const view = await mock.openChatBoxFor(_converse, recipient_jid);
  464. spyOn(u, 'shouldCreateMessage').and.callThrough();
  465. const msg = $msg({
  466. 'from': _converse.bare_jid,
  467. 'id': u.getUniqueId(),
  468. 'to': _converse.connection.jid,
  469. 'type': 'chat',
  470. 'xmlns': 'jabber:client'
  471. }).c('sent', {'xmlns': 'urn:xmpp:carbons:2'})
  472. .c('forwarded', {'xmlns': 'urn:xmpp:forward:0'})
  473. .c('message', {
  474. 'xmlns': 'jabber:client',
  475. 'from': _converse.bare_jid+'/another-resource',
  476. 'to': recipient_jid,
  477. 'type': 'chat'
  478. }).c('composing', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  479. _converse.connection._dataRecv(mock.createRequest(msg));
  480. await u.waitUntil(() => u.shouldCreateMessage.calls.count());
  481. expect(view.model.messages.length).toEqual(0);
  482. const el = view.querySelector('.chat-content__notifications');
  483. expect(el.textContent).toBe('');
  484. done();
  485. }));
  486. });
  487. describe("A paused notification", function () {
  488. it("is sent if the user has stopped typing since 30 seconds",
  489. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  490. await mock.waitForRoster(_converse, 'current');
  491. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  492. await mock.openControlBox(_converse);
  493. const rosterview = document.querySelector('converse-roster');
  494. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group li').length, 700);
  495. _converse.TIMEOUTS.PAUSED = 200; // Make the timeout shorter so that we can test
  496. await mock.openChatBoxFor(_converse, contact_jid);
  497. const view = _converse.chatboxviews.get(contact_jid);
  498. spyOn(_converse.connection, 'send');
  499. spyOn(view.model, 'setChatState').and.callThrough();
  500. expect(view.model.get('chat_state')).toBe('active');
  501. view.onKeyDown({
  502. target: view.querySelector('textarea.chat-textarea'),
  503. keyCode: 1
  504. });
  505. expect(view.model.get('chat_state')).toBe('composing');
  506. expect(_converse.connection.send).toHaveBeenCalled();
  507. let stanza = _converse.connection.send.calls.argsFor(0)[0].tree();
  508. expect(stanza.childNodes[0].tagName).toBe('composing');
  509. await u.waitUntil(() => view.model.get('chat_state') === 'paused', 500);
  510. expect(_converse.connection.send).toHaveBeenCalled();
  511. var calls = _.filter(_converse.connection.send.calls.all(), function (call) {
  512. return call.args[0] instanceof Strophe.Builder;
  513. });
  514. expect(calls.length).toBe(2);
  515. stanza = calls[1].args[0].tree();
  516. expect(stanza.getAttribute('to')).toBe(contact_jid);
  517. expect(stanza.childNodes.length).toBe(3);
  518. expect(stanza.childNodes[0].tagName).toBe('paused');
  519. expect(stanza.childNodes[1].tagName).toBe('no-store');
  520. expect(stanza.childNodes[2].tagName).toBe('no-permanent-store');
  521. // Test #359. A paused notification should not be sent
  522. // out if the user simply types longer than the
  523. // timeout.
  524. view.onKeyDown({
  525. target: view.querySelector('textarea.chat-textarea'),
  526. keyCode: 1
  527. });
  528. expect(view.model.setChatState).toHaveBeenCalled();
  529. expect(view.model.get('chat_state')).toBe('composing');
  530. view.onKeyDown({
  531. target: view.querySelector('textarea.chat-textarea'),
  532. keyCode: 1
  533. });
  534. expect(view.model.get('chat_state')).toBe('composing');
  535. done();
  536. }));
  537. it("will be shown if received", mock.initConverse([], {}, async function (done, _converse) {
  538. await mock.waitForRoster(_converse, 'current');
  539. await mock.openControlBox(_converse);
  540. const rosterview = document.querySelector('converse-roster');
  541. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  542. // TODO: only show paused state if the previous state was composing
  543. // See XEP-0085 https://xmpp.org/extensions/xep-0085.html#definitions
  544. spyOn(_converse.api, "trigger").and.callThrough();
  545. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  546. const view = await mock.openChatBoxFor(_converse, sender_jid);
  547. // <paused> state
  548. const msg = $msg({
  549. from: sender_jid,
  550. to: _converse.connection.jid,
  551. type: 'chat',
  552. id: u.getUniqueId()
  553. }).c('paused', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  554. _converse.connection._dataRecv(mock.createRequest(msg));
  555. const csn = mock.cur_names[1] + ' has stopped typing';
  556. await u.waitUntil( () => view.querySelector('.chat-content__notifications').innerText === csn);
  557. expect(view.model.messages.length).toEqual(0);
  558. done();
  559. }));
  560. it("will not be shown if it's a paused carbon message that this user sent from a different client",
  561. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  562. await mock.waitUntilDiscoConfirmed(_converse, 'montague.lit', [], ['vcard-temp']);
  563. await u.waitUntil(() => _converse.xmppstatus.vcard.get('fullname'));
  564. await mock.waitForRoster(_converse, 'current');
  565. // Send a message from a different resource
  566. const recipient_jid = mock.cur_names[5].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  567. spyOn(u, 'shouldCreateMessage').and.callThrough();
  568. const view = await mock.openChatBoxFor(_converse, recipient_jid);
  569. const msg = $msg({
  570. 'from': _converse.bare_jid,
  571. 'id': u.getUniqueId(),
  572. 'to': _converse.connection.jid,
  573. 'type': 'chat',
  574. 'xmlns': 'jabber:client'
  575. }).c('sent', {'xmlns': 'urn:xmpp:carbons:2'})
  576. .c('forwarded', {'xmlns': 'urn:xmpp:forward:0'})
  577. .c('message', {
  578. 'xmlns': 'jabber:client',
  579. 'from': _converse.bare_jid+'/another-resource',
  580. 'to': recipient_jid,
  581. 'type': 'chat'
  582. }).c('paused', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  583. _converse.connection._dataRecv(mock.createRequest(msg));
  584. await u.waitUntil(() => u.shouldCreateMessage.calls.count());
  585. expect(view.model.messages.length).toEqual(0);
  586. const el = view.querySelector('.chat-content__notifications');
  587. expect(el.textContent).toBe('');
  588. done();
  589. done();
  590. }));
  591. });
  592. describe("An inactive notification", function () {
  593. it("is sent if the user has stopped typing since 2 minutes",
  594. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  595. const sent_stanzas = _converse.connection.sent_stanzas;
  596. // Make the timeouts shorter so that we can test
  597. _converse.TIMEOUTS.PAUSED = 100;
  598. _converse.TIMEOUTS.INACTIVE = 100;
  599. await mock.waitForRoster(_converse, 'current');
  600. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  601. await mock.openControlBox(_converse);
  602. const rosterview = document.querySelector('converse-roster');
  603. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 1000);
  604. await mock.openChatBoxFor(_converse, contact_jid);
  605. const view = _converse.chatboxviews.get(contact_jid);
  606. await u.waitUntil(() => view.model.get('chat_state') === 'active');
  607. let messages = await u.waitUntil(() => sent_stanzas.filter(s => s.matches('message')));
  608. expect(messages.length).toBe(1);
  609. expect(view.model.get('chat_state')).toBe('active');
  610. view.onKeyDown({
  611. target: view.querySelector('textarea.chat-textarea'),
  612. keyCode: 1
  613. });
  614. await u.waitUntil(() => view.model.get('chat_state') === 'composing', 600);
  615. messages = sent_stanzas.filter(s => s.matches('message'));
  616. expect(messages.length).toBe(2);
  617. await u.waitUntil(() => view.model.get('chat_state') === 'paused', 600);
  618. messages = sent_stanzas.filter(s => s.matches('message'));
  619. expect(messages.length).toBe(3);
  620. await u.waitUntil(() => view.model.get('chat_state') === 'inactive', 600);
  621. messages = sent_stanzas.filter(s => s.matches('message'));
  622. expect(messages.length).toBe(4);
  623. expect(Strophe.serialize(messages[0])).toBe(
  624. `<message id="${messages[0].getAttribute('id')}" to="mercutio@montague.lit" type="chat" xmlns="jabber:client">`+
  625. `<active xmlns="http://jabber.org/protocol/chatstates"/>`+
  626. `<no-store xmlns="urn:xmpp:hints"/>`+
  627. `<no-permanent-store xmlns="urn:xmpp:hints"/>`+
  628. `</message>`);
  629. expect(Strophe.serialize(messages[1])).toBe(
  630. `<message id="${messages[1].getAttribute('id')}" to="mercutio@montague.lit" type="chat" xmlns="jabber:client">`+
  631. `<composing xmlns="http://jabber.org/protocol/chatstates"/>`+
  632. `<no-store xmlns="urn:xmpp:hints"/>`+
  633. `<no-permanent-store xmlns="urn:xmpp:hints"/>`+
  634. `</message>`);
  635. expect(Strophe.serialize(messages[2])).toBe(
  636. `<message id="${messages[2].getAttribute('id')}" to="mercutio@montague.lit" type="chat" xmlns="jabber:client">`+
  637. `<paused xmlns="http://jabber.org/protocol/chatstates"/>`+
  638. `<no-store xmlns="urn:xmpp:hints"/>`+
  639. `<no-permanent-store xmlns="urn:xmpp:hints"/>`+
  640. `</message>`);
  641. expect(Strophe.serialize(messages[3])).toBe(
  642. `<message id="${messages[3].getAttribute('id')}" to="mercutio@montague.lit" type="chat" xmlns="jabber:client">`+
  643. `<inactive xmlns="http://jabber.org/protocol/chatstates"/>`+
  644. `<no-store xmlns="urn:xmpp:hints"/>`+
  645. `<no-permanent-store xmlns="urn:xmpp:hints"/>`+
  646. `</message>`);
  647. done();
  648. }));
  649. it("is sent when the user a minimizes a chat box",
  650. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  651. await mock.waitForRoster(_converse, 'current');
  652. await mock.openControlBox(_converse);
  653. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  654. await mock.openChatBoxFor(_converse, contact_jid);
  655. const view = _converse.chatboxviews.get(contact_jid);
  656. spyOn(_converse.connection, 'send');
  657. _converse.minimize.minimize(view.model);
  658. expect(view.model.get('chat_state')).toBe('inactive');
  659. expect(_converse.connection.send).toHaveBeenCalled();
  660. var stanza = _converse.connection.send.calls.argsFor(0)[0].tree();
  661. expect(stanza.getAttribute('to')).toBe(contact_jid);
  662. expect(stanza.childNodes[0].tagName).toBe('inactive');
  663. done();
  664. }));
  665. it("is sent if the user closes a chat box",
  666. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  667. await mock.waitForRoster(_converse, 'current');
  668. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  669. await mock.openControlBox(_converse);
  670. const rosterview = document.querySelector('converse-roster');
  671. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  672. const view = await mock.openChatBoxFor(_converse, contact_jid);
  673. expect(view.model.get('chat_state')).toBe('active');
  674. spyOn(_converse.connection, 'send');
  675. view.close();
  676. expect(view.model.get('chat_state')).toBe('inactive');
  677. expect(_converse.connection.send).toHaveBeenCalled();
  678. const stanza = _converse.connection.send.calls.argsFor(0)[0].tree();
  679. expect(stanza.getAttribute('to')).toBe(contact_jid);
  680. expect(stanza.childNodes.length).toBe(3);
  681. expect(stanza.childNodes[0].tagName).toBe('inactive');
  682. expect(stanza.childNodes[1].tagName).toBe('no-store');
  683. expect(stanza.childNodes[2].tagName).toBe('no-permanent-store');
  684. done();
  685. }));
  686. it("will clear any other chat status notifications",
  687. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  688. await mock.waitForRoster(_converse, 'current');
  689. await mock.openControlBox(_converse);
  690. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  691. // See XEP-0085 https://xmpp.org/extensions/xep-0085.html#definitions
  692. await mock.openChatBoxFor(_converse, sender_jid);
  693. const view = _converse.chatboxviews.get(sender_jid);
  694. expect(view.querySelectorAll('.chat-event').length).toBe(0);
  695. // Insert <composing> message, to also check that
  696. // text messages are inserted correctly with
  697. // temporary chat events in the chat contents.
  698. let msg = $msg({
  699. 'to': _converse.bare_jid,
  700. 'xmlns': 'jabber:client',
  701. 'from': sender_jid,
  702. 'type': 'chat'})
  703. .c('composing', {'xmlns': Strophe.NS.CHATSTATES}).up()
  704. .tree();
  705. _converse.connection._dataRecv(mock.createRequest(msg));
  706. const csntext = await u.waitUntil(() => view.querySelector('.chat-content__notifications').textContent);
  707. expect(csntext).toEqual(mock.cur_names[1] + ' is typing');
  708. expect(view.model.messages.length).toBe(0);
  709. msg = $msg({
  710. from: sender_jid,
  711. to: _converse.connection.jid,
  712. type: 'chat',
  713. id: u.getUniqueId()
  714. }).c('inactive', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  715. _converse.connection._dataRecv(mock.createRequest(msg));
  716. await u.waitUntil(() => !view.querySelector('.chat-content__notifications').textContent);
  717. done();
  718. }));
  719. });
  720. describe("A gone notification", function () {
  721. it("will be shown if received", mock.initConverse([], {}, async function (done, _converse) {
  722. await mock.waitForRoster(_converse, 'current', 3);
  723. await mock.openControlBox(_converse);
  724. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  725. await mock.openChatBoxFor(_converse, sender_jid);
  726. const msg = $msg({
  727. from: sender_jid,
  728. to: _converse.connection.jid,
  729. type: 'chat',
  730. id: u.getUniqueId()
  731. }).c('body').c('gone', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  732. _converse.connection._dataRecv(mock.createRequest(msg));
  733. const view = _converse.chatboxviews.get(sender_jid);
  734. const csntext = await u.waitUntil(() => view.querySelector('.chat-content__notifications').textContent);
  735. expect(csntext).toEqual(mock.cur_names[1] + ' has gone away');
  736. done();
  737. }));
  738. });
  739. describe("On receiving a message correction", function () {
  740. it("will be removed", mock.initConverse([], {}, async function (done, _converse) {
  741. await mock.waitForRoster(_converse, 'current');
  742. await mock.openControlBox(_converse);
  743. // See XEP-0085 https://xmpp.org/extensions/xep-0085.html#definitions
  744. const sender_jid = mock.cur_names[1].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  745. const rosterview = document.querySelector('converse-roster');
  746. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length);
  747. await mock.openChatBoxFor(_converse, sender_jid);
  748. // Original message
  749. const original_id = u.getUniqueId();
  750. const original = $msg({
  751. from: sender_jid,
  752. to: _converse.connection.jid,
  753. type: 'chat',
  754. id: original_id,
  755. body: "Original message",
  756. }).c('active', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  757. spyOn(_converse.api, "trigger").and.callThrough();
  758. _converse.connection._dataRecv(mock.createRequest(original));
  759. await u.waitUntil(() => _converse.api.trigger.calls.count());
  760. expect(_converse.api.trigger).toHaveBeenCalledWith('message', jasmine.any(Object));
  761. const view = _converse.chatboxviews.get(sender_jid);
  762. expect(view).toBeDefined();
  763. // <composing> state
  764. const msg = $msg({
  765. from: sender_jid,
  766. to: _converse.connection.jid,
  767. type: 'chat',
  768. id: u.getUniqueId()
  769. }).c('composing', {'xmlns': Strophe.NS.CHATSTATES}).tree();
  770. _converse.connection._dataRecv(mock.createRequest(msg));
  771. const csntext = await u.waitUntil(() => view.querySelector('.chat-content__notifications').textContent);
  772. expect(csntext).toEqual(mock.cur_names[1] + ' is typing');
  773. // Edited message
  774. const edited = $msg({
  775. from: sender_jid,
  776. to: _converse.connection.jid,
  777. type: 'chat',
  778. id: u.getUniqueId(),
  779. body: "Edited message",
  780. })
  781. .c('active', {'xmlns': Strophe.NS.CHATSTATES}).up()
  782. .c('replace', {'xmlns': Strophe.NS.MESSAGE_CORRECT, 'id': original_id }).tree();
  783. await _converse.handleMessageStanza(edited);
  784. await u.waitUntil(() => !view.querySelector('.chat-content__notifications').textContent);
  785. done();
  786. }));
  787. });
  788. });
  789. });
  790. describe("Special Messages", function () {
  791. it("'/clear' can be used to clear messages in a conversation",
  792. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  793. await mock.waitForRoster(_converse, 'current');
  794. await mock.openControlBox(_converse);
  795. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  796. spyOn(_converse.api, "trigger").and.callThrough();
  797. await mock.openChatBoxFor(_converse, contact_jid);
  798. const view = _converse.chatboxviews.get(contact_jid);
  799. let message = 'This message is another sent from this chatbox';
  800. await mock.sendMessage(view, message);
  801. expect(view.model.messages.length === 1).toBeTruthy();
  802. let stored_messages = await view.model.messages.browserStorage.findAll();
  803. expect(stored_messages.length).toBe(1);
  804. await u.waitUntil(() => view.querySelector('.chat-msg'));
  805. message = '/clear';
  806. spyOn(view, 'clearMessages').and.callThrough();
  807. spyOn(window, 'confirm').and.callFake(function () {
  808. return true;
  809. });
  810. view.querySelector('.chat-textarea').value = message;
  811. view.onKeyDown({
  812. target: view.querySelector('textarea.chat-textarea'),
  813. preventDefault: function preventDefault () {},
  814. keyCode: 13
  815. });
  816. expect(view.clearMessages.calls.all().length).toBe(1);
  817. await view.clearMessages.calls.all()[0].returnValue;
  818. expect(window.confirm).toHaveBeenCalled();
  819. expect(view.model.messages.length, 0); // The messages must be removed from the chatbox
  820. stored_messages = await view.model.messages.browserStorage.findAll();
  821. expect(stored_messages.length).toBe(0);
  822. expect(_converse.api.trigger.calls.count(), 1);
  823. expect(_converse.api.trigger.calls.mostRecent().args, ['messageSend', message]);
  824. done();
  825. }));
  826. });
  827. describe("A ChatBox's Unread Message Count", function () {
  828. it("is incremented when the message is received and ChatBoxView is scrolled up",
  829. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  830. await mock.waitForRoster(_converse, 'current', 1);
  831. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit',
  832. msg = mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  833. const view = await mock.openChatBoxFor(_converse, sender_jid)
  834. const sent_stanzas = [];
  835. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  836. view.model.save('scrolled', true);
  837. await _converse.handleMessageStanza(msg);
  838. await u.waitUntil(() => view.model.messages.length);
  839. expect(view.model.get('num_unread')).toBe(1);
  840. const msgid = view.model.messages.last().get('id');
  841. expect(view.model.get('first_unread_id')).toBe(msgid);
  842. await u.waitUntil(() => sent_stanzas.length);
  843. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  844. done();
  845. }));
  846. it("is not incremented when the message is received and ChatBoxView is scrolled down",
  847. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  848. await mock.waitForRoster(_converse, 'current', 1);
  849. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  850. const msg = mock.createChatMessage(_converse, sender_jid, 'This message will be read');
  851. await mock.openChatBoxFor(_converse, sender_jid);
  852. const sent_stanzas = [];
  853. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  854. const chatbox = _converse.chatboxes.get(sender_jid);
  855. await _converse.handleMessageStanza(msg);
  856. expect(chatbox.get('num_unread')).toBe(0);
  857. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length === 2);
  858. expect(sent_stanzas[1].querySelector('displayed')).toBeDefined();
  859. done();
  860. }));
  861. it("is incremented when message is received, chatbox is scrolled down and the window is not focused",
  862. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  863. await mock.waitForRoster(_converse, 'current');
  864. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  865. const msgFactory = function () {
  866. return mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  867. };
  868. await mock.openChatBoxFor(_converse, sender_jid);
  869. const sent_stanzas = [];
  870. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  871. const chatbox = _converse.chatboxes.get(sender_jid);
  872. _converse.windowState = 'hidden';
  873. const msg = msgFactory();
  874. _converse.handleMessageStanza(msg);
  875. await u.waitUntil(() => chatbox.messages.length);
  876. expect(chatbox.get('num_unread')).toBe(1);
  877. const msgid = chatbox.messages.last().get('id');
  878. expect(chatbox.get('first_unread_id')).toBe(msgid);
  879. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length);
  880. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  881. done();
  882. }));
  883. it("is incremented when message is received, chatbox is scrolled up and the window is not focused",
  884. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  885. await mock.waitForRoster(_converse, 'current', 1);
  886. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  887. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  888. await mock.openChatBoxFor(_converse, sender_jid);
  889. const sent_stanzas = [];
  890. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  891. const chatbox = _converse.chatboxes.get(sender_jid);
  892. chatbox.save('scrolled', true);
  893. _converse.windowState = 'hidden';
  894. const msg = msgFactory();
  895. _converse.handleMessageStanza(msg);
  896. await u.waitUntil(() => chatbox.messages.length);
  897. expect(chatbox.get('num_unread')).toBe(1);
  898. const msgid = chatbox.messages.last().get('id');
  899. expect(chatbox.get('first_unread_id')).toBe(msgid);
  900. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length === 1);
  901. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  902. done();
  903. }));
  904. it("is cleared when ChatBoxView was scrolled down and the window become focused",
  905. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  906. await mock.waitForRoster(_converse, 'current', 1);
  907. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  908. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  909. await mock.openChatBoxFor(_converse, sender_jid);
  910. const sent_stanzas = [];
  911. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  912. const chatbox = _converse.chatboxes.get(sender_jid);
  913. _converse.windowState = 'hidden';
  914. const msg = msgFactory();
  915. _converse.handleMessageStanza(msg);
  916. await u.waitUntil(() => chatbox.messages.length);
  917. expect(chatbox.get('num_unread')).toBe(1);
  918. const msgid = chatbox.messages.last().get('id');
  919. expect(chatbox.get('first_unread_id')).toBe(msgid);
  920. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length === 1);
  921. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  922. _converse.saveWindowState({'type': 'focus'});
  923. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length === 2);
  924. expect(sent_stanzas[1].querySelector('displayed')).toBeDefined();
  925. expect(chatbox.get('num_unread')).toBe(0);
  926. done();
  927. }));
  928. it("is not cleared when ChatBoxView was scrolled up and the windows become focused",
  929. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  930. await mock.waitForRoster(_converse, 'current', 1);
  931. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  932. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  933. await mock.openChatBoxFor(_converse, sender_jid);
  934. const sent_stanzas = [];
  935. spyOn(_converse.connection, 'send').and.callFake(s => sent_stanzas.push(s?.nodeTree ?? s));
  936. const chatbox = _converse.chatboxes.get(sender_jid);
  937. chatbox.save('scrolled', true);
  938. _converse.windowState = 'hidden';
  939. const msg = msgFactory();
  940. _converse.handleMessageStanza(msg);
  941. await u.waitUntil(() => chatbox.messages.length);
  942. expect(chatbox.get('num_unread')).toBe(1);
  943. const msgid = chatbox.messages.last().get('id');
  944. expect(chatbox.get('first_unread_id')).toBe(msgid);
  945. await u.waitUntil(() => sent_stanzas.filter(s => s.nodeName === 'message').length === 1);
  946. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  947. _converse.saveWindowState({'type': 'focus'});
  948. await u.waitUntil(() => chatbox.get('num_unread') === 1);
  949. expect(chatbox.get('first_unread_id')).toBe(msgid);
  950. expect(sent_stanzas[0].querySelector('received')).toBeDefined();
  951. done();
  952. }));
  953. });
  954. describe("A RosterView's Unread Message Count", function () {
  955. it("is updated when message is received and chatbox is scrolled up",
  956. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  957. await mock.waitForRoster(_converse, 'current', 1);
  958. let msg, indicator_el;
  959. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  960. const rosterview = document.querySelector('converse-roster');
  961. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 500);
  962. await mock.openChatBoxFor(_converse, sender_jid);
  963. const chatbox = _converse.chatboxes.get(sender_jid);
  964. chatbox.save('scrolled', true);
  965. msg = mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  966. await _converse.handleMessageStanza(msg);
  967. await u.waitUntil(() => chatbox.messages.length);
  968. const selector = 'a.open-chat:contains("' + chatbox.get('nickname') + '") .msgs-indicator';
  969. indicator_el = sizzle(selector, rosterview.el).pop();
  970. expect(indicator_el.textContent).toBe('1');
  971. msg = mock.createChatMessage(_converse, sender_jid, 'This message will be unread too');
  972. await _converse.handleMessageStanza(msg);
  973. await u.waitUntil(() => chatbox.messages.length > 1);
  974. indicator_el = sizzle(selector, rosterview.el).pop();
  975. expect(indicator_el.textContent).toBe('2');
  976. done();
  977. }));
  978. it("is updated when message is received and chatbox is minimized",
  979. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  980. await mock.waitForRoster(_converse, 'current', 1);
  981. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  982. let indicator_el, msg;
  983. const rosterview = document.querySelector('converse-roster');
  984. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 500);
  985. await mock.openChatBoxFor(_converse, sender_jid);
  986. const chatbox = _converse.chatboxes.get(sender_jid);
  987. _converse.minimize.minimize(chatbox);
  988. msg = mock.createChatMessage(_converse, sender_jid, 'This message will be unread');
  989. await _converse.handleMessageStanza(msg);
  990. await u.waitUntil(() => chatbox.messages.length);
  991. const selector = 'a.open-chat:contains("' + chatbox.get('nickname') + '") .msgs-indicator';
  992. indicator_el = sizzle(selector, rosterview.el).pop();
  993. expect(indicator_el.textContent).toBe('1');
  994. msg = mock.createChatMessage(_converse, sender_jid, 'This message will be unread too');
  995. await _converse.handleMessageStanza(msg);
  996. await u.waitUntil(() => chatbox.messages.length === 2);
  997. indicator_el = sizzle(selector, rosterview.el).pop();
  998. expect(indicator_el.textContent).toBe('2');
  999. done();
  1000. }));
  1001. it("is cleared when chatbox is maximzied after receiving messages in minimized mode",
  1002. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  1003. await mock.waitForRoster(_converse, 'current', 1);
  1004. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  1005. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, 'This message will be received as unread, but eventually will be read');
  1006. const rosterview = document.querySelector('converse-roster');
  1007. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 500);
  1008. await mock.openChatBoxFor(_converse, sender_jid);
  1009. const chatbox = _converse.chatboxes.get(sender_jid);
  1010. const view = _converse.chatboxviews.get(sender_jid);
  1011. const selector = 'a.open-chat:contains("' + chatbox.get('nickname') + '") .msgs-indicator';
  1012. const select_msgs_indicator = () => sizzle(selector, rosterview.el).pop();
  1013. _converse.minimize.minimize(view.model);
  1014. _converse.handleMessageStanza(msgFactory());
  1015. await u.waitUntil(() => chatbox.messages.length);
  1016. expect(select_msgs_indicator().textContent).toBe('1');
  1017. _converse.handleMessageStanza(msgFactory());
  1018. await u.waitUntil(() => chatbox.messages.length > 1);
  1019. expect(select_msgs_indicator().textContent).toBe('2');
  1020. _converse.minimize.minimize(view.model);
  1021. u.waitUntil(() => typeof select_msgs_indicator() === 'undefined');
  1022. done();
  1023. }));
  1024. it("is cleared when unread messages are viewed which were received in scrolled-up chatbox",
  1025. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  1026. await mock.openControlBox(_converse);
  1027. await mock.waitForRoster(_converse, 'current', 1);
  1028. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  1029. const rosterview = document.querySelector('converse-roster');
  1030. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 500);
  1031. await mock.openChatBoxFor(_converse, sender_jid);
  1032. const chatbox = _converse.chatboxes.get(sender_jid);
  1033. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, 'This message will be received as unread, but eventually will be read');
  1034. const selector = `a.open-chat:contains("${chatbox.get('nickname')}") .msgs-indicator`;
  1035. const select_msgs_indicator = () => sizzle(selector, rosterview.el).pop();
  1036. chatbox.save('scrolled', true);
  1037. _converse.handleMessageStanza(msgFactory());
  1038. const view = _converse.chatboxviews.get(sender_jid);
  1039. await u.waitUntil(() => view.model.messages.length);
  1040. expect(select_msgs_indicator().textContent).toBe('1');
  1041. view.viewUnreadMessages();
  1042. rosterview.render();
  1043. await u.waitUntil(() => select_msgs_indicator() === undefined);
  1044. done();
  1045. }));
  1046. it("is not cleared after user clicks on roster view when chatbox is already opened and scrolled up",
  1047. mock.initConverse(['chatBoxesFetched'], {}, async function (done, _converse) {
  1048. await mock.waitForRoster(_converse, 'current', 1);
  1049. const sender_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  1050. const rosterview = document.querySelector('converse-roster');
  1051. await u.waitUntil(() => rosterview.querySelectorAll('.roster-group').length, 500);
  1052. await mock.openChatBoxFor(_converse, sender_jid);
  1053. const chatbox = _converse.chatboxes.get(sender_jid);
  1054. const view = _converse.chatboxviews.get(sender_jid);
  1055. const msg = 'This message will be received as unread, but eventually will be read';
  1056. const msgFactory = () => mock.createChatMessage(_converse, sender_jid, msg);
  1057. const selector = 'a.open-chat:contains("' + chatbox.get('nickname') + '") .msgs-indicator';
  1058. const select_msgs_indicator = () => sizzle(selector, rosterview.el).pop();
  1059. chatbox.save('scrolled', true);
  1060. _converse.handleMessageStanza(msgFactory());
  1061. await u.waitUntil(() => view.model.messages.length);
  1062. expect(select_msgs_indicator().textContent).toBe('1');
  1063. await mock.openChatBoxFor(_converse, sender_jid);
  1064. expect(select_msgs_indicator().textContent).toBe('1');
  1065. done();
  1066. }));
  1067. });
  1068. });