mam.js 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789
  1. (function (root, factory) {
  2. define(["jasmine", "mock", "test-utils"], factory);
  3. } (this, function (jasmine, mock, test_utils) {
  4. "use strict";
  5. const _ = converse.env._;
  6. const Backbone = converse.env.Backbone;
  7. const Strophe = converse.env.Strophe;
  8. const $iq = converse.env.$iq;
  9. const $msg = converse.env.$msg;
  10. const dayjs = converse.env.dayjs;
  11. const u = converse.env.utils;
  12. const sizzle = converse.env.sizzle;
  13. // See: https://xmpp.org/rfcs/rfc3921.html
  14. describe("Message Archive Management", function () {
  15. // Implement the protocol defined in https://xmpp.org/extensions/xep-0313.html#config
  16. describe("An archived message", function () {
  17. describe("when recieved", function () {
  18. it("updates the is_archived value of an already cached version",
  19. mock.initConverse(
  20. null, ['discoInitialized'], {},
  21. async function (done, _converse) {
  22. await test_utils.openAndEnterChatRoom(_converse, 'trek-radio', 'conference.lightwitch.org', 'romeo');
  23. const view = _converse.chatboxviews.get('trek-radio@conference.lightwitch.org');
  24. let stanza = u.toStanza(
  25. `<message xmlns="jabber:client" to="romeo@montague.lit/orchard" type="groupchat" from="trek-radio@conference.lightwitch.org/some1">
  26. <body>Hello</body>
  27. <stanza-id xmlns="urn:xmpp:sid:0" id="45fbbf2a-1059-479d-9283-c8effaf05621" by="trek-radio@conference.lightwitch.org"/>
  28. </message>`);
  29. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  30. await test_utils.waitUntil(() => view.content.querySelectorAll('.chat-msg').length);
  31. expect(view.model.messages.length).toBe(1);
  32. expect(view.model.messages.at(0).get('is_archived')).toBe(false);
  33. expect(view.model.messages.at(0).get('stanza_id trek-radio@conference.lightwitch.org')).toBe('45fbbf2a-1059-479d-9283-c8effaf05621');
  34. stanza = u.toStanza(
  35. `<message xmlns="jabber:client"
  36. to="romeo@montague.lit/orchard"
  37. from="trek-radio@conference.lightwitch.org">
  38. <result xmlns="urn:xmpp:mam:2" queryid="82d9db27-6cf8-4787-8c2c-5a560263d823" id="45fbbf2a-1059-479d-9283-c8effaf05621">
  39. <forwarded xmlns="urn:xmpp:forward:0">
  40. <delay xmlns="urn:xmpp:delay" stamp="2018-01-09T06:17:23Z"/>
  41. <message from="trek-radio@conference.lightwitch.org/some1" type="groupchat">
  42. <body>Hello</body>
  43. </message>
  44. </forwarded>
  45. </result>
  46. </message>`);
  47. spyOn(view.model, 'findDuplicateFromArchiveID').and.callThrough();
  48. spyOn(view.model, 'updateMessage').and.callThrough();
  49. view.model.onMessage(stanza);
  50. await test_utils.waitUntil(() => view.model.findDuplicateFromArchiveID.calls.count());
  51. expect(view.model.findDuplicateFromArchiveID.calls.count()).toBe(1);
  52. const result = await view.model.findDuplicateFromArchiveID.calls.all()[0].returnValue
  53. expect(result instanceof _converse.Message).toBe(true);
  54. expect(view.content.querySelectorAll('.chat-msg').length).toBe(1);
  55. await test_utils.waitUntil(() => view.model.updateMessage.calls.count());
  56. expect(view.model.messages.length).toBe(1);
  57. expect(view.model.messages.at(0).get('is_archived')).toBe(true);
  58. expect(view.model.messages.at(0).get('stanza_id trek-radio@conference.lightwitch.org')).toBe('45fbbf2a-1059-479d-9283-c8effaf05621');
  59. done();
  60. }));
  61. it("isn't shown as duplicate by comparing its stanza id or archive id",
  62. mock.initConverse(
  63. null, ['discoInitialized'], {},
  64. async function (done, _converse) {
  65. await test_utils.openAndEnterChatRoom(_converse, 'trek-radio', 'conference.lightwitch.org', 'jcbrand');
  66. const view = _converse.chatboxviews.get('trek-radio@conference.lightwitch.org');
  67. let stanza = u.toStanza(
  68. `<message xmlns="jabber:client" to="jcbrand@lightwitch.org/converse.js-73057452" type="groupchat" from="trek-radio@conference.lightwitch.org/comndrdukath#0805 (STO)">
  69. <body>negan</body>
  70. <stanza-id xmlns="urn:xmpp:sid:0" id="45fbbf2a-1059-479d-9283-c8effaf05621" by="trek-radio@conference.lightwitch.org"/>
  71. </message>`);
  72. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  73. await test_utils.waitUntil(() => view.content.querySelectorAll('.chat-msg').length);
  74. // Not sure whether such a race-condition might pose a problem
  75. // in "real-world" situations.
  76. stanza = u.toStanza(
  77. `<message xmlns="jabber:client"
  78. to="jcbrand@lightwitch.org/converse.js-73057452"
  79. from="trek-radio@conference.lightwitch.org">
  80. <result xmlns="urn:xmpp:mam:2" queryid="82d9db27-6cf8-4787-8c2c-5a560263d823" id="45fbbf2a-1059-479d-9283-c8effaf05621">
  81. <forwarded xmlns="urn:xmpp:forward:0">
  82. <delay xmlns="urn:xmpp:delay" stamp="2018-01-09T06:17:23Z"/>
  83. <message from="trek-radio@conference.lightwitch.org/comndrdukath#0805 (STO)" type="groupchat">
  84. <body>negan</body>
  85. </message>
  86. </forwarded>
  87. </result>
  88. </message>`);
  89. spyOn(view.model, 'findDuplicateFromArchiveID').and.callThrough();
  90. view.model.onMessage(stanza);
  91. await test_utils.waitUntil(() => view.model.findDuplicateFromArchiveID.calls.count());
  92. expect(view.model.findDuplicateFromArchiveID.calls.count()).toBe(1);
  93. const result = await view.model.findDuplicateFromArchiveID.calls.all()[0].returnValue
  94. expect(result instanceof _converse.Message).toBe(true);
  95. expect(view.content.querySelectorAll('.chat-msg').length).toBe(1);
  96. done();
  97. }));
  98. it("isn't shown as duplicate by comparing only the archive id",
  99. mock.initConverse(
  100. null, ['discoInitialized'], {},
  101. async function (done, _converse) {
  102. await test_utils.openAndEnterChatRoom(_converse, 'discuss', 'conference.conversejs.org', 'romeo');
  103. const view = _converse.chatboxviews.get('discuss@conference.conversejs.org');
  104. let stanza = u.toStanza(
  105. `<message xmlns="jabber:client" to="romeo@montague.lit/orchard" from="discuss@conference.conversejs.org">
  106. <result xmlns="urn:xmpp:mam:2" queryid="06fea9ca-97c9-48c4-8583-009ff54ea2e8" id="7a9fde91-4387-4bf8-b5d3-978dab8f6bf3">
  107. <forwarded xmlns="urn:xmpp:forward:0">
  108. <delay xmlns="urn:xmpp:delay" stamp="2018-12-05T04:53:12Z"/>
  109. <message xmlns="jabber:client" to="discuss@conference.conversejs.org" type="groupchat" xml:lang="en" from="discuss@conference.conversejs.org/prezel">
  110. <body>looks like omemo fails completely with "bundle is undefined" when there is a device in the devicelist that has no keys published</body>
  111. <x xmlns="http://jabber.org/protocol/muc#user">
  112. <item affiliation="none" jid="prezel@blubber.im" role="participant"/>
  113. </x>
  114. </message>
  115. </forwarded>
  116. </result>
  117. </message>`);
  118. view.model.onMessage(stanza);
  119. await test_utils.waitUntil(() => view.content.querySelectorAll('.chat-msg').length);
  120. expect(view.content.querySelectorAll('.chat-msg').length).toBe(1);
  121. stanza = u.toStanza(
  122. `<message xmlns="jabber:client" to="romeo@montague.lit/orchard" from="discuss@conference.conversejs.org">
  123. <result xmlns="urn:xmpp:mam:2" queryid="06fea9ca-97c9-48c4-8583-009ff54ea2e8" id="7a9fde91-4387-4bf8-b5d3-978dab8f6bf3">
  124. <forwarded xmlns="urn:xmpp:forward:0">
  125. <delay xmlns="urn:xmpp:delay" stamp="2018-12-05T04:53:12Z"/>
  126. <message xmlns="jabber:client" to="discuss@conference.conversejs.org" type="groupchat" xml:lang="en" from="discuss@conference.conversejs.org/prezel">
  127. <body>looks like omemo fails completely with "bundle is undefined" when there is a device in the devicelist that has no keys published</body>
  128. <x xmlns="http://jabber.org/protocol/muc#user">
  129. <item affiliation="none" jid="prezel@blubber.im" role="participant"/>
  130. </x>
  131. </message>
  132. </forwarded>
  133. </result>
  134. </message>`);
  135. spyOn(view.model, 'findDuplicateFromArchiveID').and.callThrough();
  136. view.model.onMessage(stanza);
  137. await test_utils.waitUntil(() => view.model.findDuplicateFromArchiveID.calls.count());
  138. expect(view.model.findDuplicateFromArchiveID.calls.count()).toBe(1);
  139. const result = await view.model.findDuplicateFromArchiveID.calls.all()[0].returnValue
  140. expect(result instanceof _converse.Message).toBe(true);
  141. expect(view.content.querySelectorAll('.chat-msg').length).toBe(1);
  142. done();
  143. }))
  144. });
  145. });
  146. describe("The archive.query API", function () {
  147. it("can be used to query for all archived messages",
  148. mock.initConverse(
  149. null, ['discoInitialized'], {},
  150. async function (done, _converse) {
  151. const sendIQ = _converse.connection.sendIQ;
  152. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  153. let sent_stanza, IQ_id;
  154. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  155. sent_stanza = iq;
  156. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  157. });
  158. _converse.api.archive.query();
  159. await test_utils.waitUntil(() => sent_stanza);
  160. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  161. expect(sent_stanza.toString()).toBe(
  162. `<iq id="${IQ_id}" type="set" xmlns="jabber:client"><query queryid="${queryid}" xmlns="urn:xmpp:mam:2"/></iq>`);
  163. done();
  164. }));
  165. it("can be used to query for all messages to/from a particular JID",
  166. mock.initConverse(
  167. null, [], {},
  168. async function (done, _converse) {
  169. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  170. let sent_stanza, IQ_id;
  171. const sendIQ = _converse.connection.sendIQ;
  172. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  173. sent_stanza = iq;
  174. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  175. });
  176. _converse.api.archive.query({'with':'juliet@capulet.lit'});
  177. await test_utils.waitUntil(() => sent_stanza);
  178. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  179. expect(sent_stanza.toString()).toBe(
  180. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  181. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  182. `<x type="submit" xmlns="jabber:x:data">`+
  183. `<field type="hidden" var="FORM_TYPE">`+
  184. `<value>urn:xmpp:mam:2</value>`+
  185. `</field>`+
  186. `<field var="with">`+
  187. `<value>juliet@capulet.lit</value>`+
  188. `</field>`+
  189. `</x>`+
  190. `</query>`+
  191. `</iq>`);
  192. done();
  193. }));
  194. it("can be used to query for archived messages from a chat room",
  195. mock.initConverse(
  196. null, [], {},
  197. async function (done, _converse) {
  198. const room_jid = 'coven@chat.shakespeare.lit';
  199. _converse.api.archive.query({'with': room_jid, 'groupchat': true});
  200. await test_utils.waitUntilDiscoConfirmed(_converse, room_jid, null, [Strophe.NS.MAM]);
  201. const sent_stanzas = _converse.connection.sent_stanzas;
  202. const stanza = await test_utils.waitUntil(
  203. () => sent_stanzas.filter(s => sizzle(`[xmlns="${Strophe.NS.MAM}"]`, s).length).pop());
  204. const queryid = stanza.querySelector('query').getAttribute('queryid');
  205. expect(Strophe.serialize(stanza)).toBe(
  206. `<iq id="${stanza.getAttribute('id')}" to="coven@chat.shakespeare.lit" type="set" xmlns="jabber:client">`+
  207. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  208. `<x type="submit" xmlns="jabber:x:data">`+
  209. `<field type="hidden" var="FORM_TYPE">`+
  210. `<value>urn:xmpp:mam:2</value>`+
  211. `</field>`+
  212. `</x>`+
  213. `</query>`+
  214. `</iq>`);
  215. done();
  216. }));
  217. it("checks whether returned MAM messages from a MUC room are from the right JID",
  218. mock.initConverse(
  219. null, [], {},
  220. async function (done, _converse) {
  221. const room_jid = 'coven@chat.shakespeare.lit';
  222. const promise = _converse.api.archive.query({'with': room_jid, 'groupchat': true, 'max':'10'});
  223. await test_utils.waitUntilDiscoConfirmed(_converse, room_jid, null, [Strophe.NS.MAM]);
  224. const sent_stanzas = _converse.connection.sent_stanzas;
  225. const sent_stanza = await test_utils.waitUntil(
  226. () => sent_stanzas.filter(s => sizzle(`[xmlns="${Strophe.NS.MAM}"]`, s).length).pop());
  227. const queryid = sent_stanza.querySelector('query').getAttribute('queryid');
  228. /* <message id='iasd207' from='coven@chat.shakespeare.lit' to='hag66@shakespeare.lit/pda'>
  229. * <result xmlns='urn:xmpp:mam:2' queryid='g27' id='34482-21985-73620'>
  230. * <forwarded xmlns='urn:xmpp:forward:0'>
  231. * <delay xmlns='urn:xmpp:delay' stamp='2002-10-13T23:58:37Z'/>
  232. * <message xmlns="jabber:client"
  233. * from='coven@chat.shakespeare.lit/firstwitch'
  234. * id='162BEBB1-F6DB-4D9A-9BD8-CFDCC801A0B2'
  235. * type='groupchat'>
  236. * <body>Thrice the brinded cat hath mew'd.</body>
  237. * <x xmlns='http://jabber.org/protocol/muc#user'>
  238. * <item affiliation='none'
  239. * jid='witch1@shakespeare.lit'
  240. * role='participant' />
  241. * </x>
  242. * </message>
  243. * </forwarded>
  244. * </result>
  245. * </message>
  246. */
  247. const msg1 = $msg({'id':'iasd207', 'from': 'other@chat.shakespear.lit', 'to': 'romeo@montague.lit'})
  248. .c('result', {'xmlns': 'urn:xmpp:mam:2', 'queryid':queryid, 'id':'34482-21985-73620'})
  249. .c('forwarded', {'xmlns':'urn:xmpp:forward:0'})
  250. .c('delay', {'xmlns':'urn:xmpp:delay', 'stamp':'2010-07-10T23:08:25Z'}).up()
  251. .c('message', {
  252. 'xmlns':'jabber:client',
  253. 'to':'romeo@montague.lit',
  254. 'id':'162BEBB1-F6DB-4D9A-9BD8-CFDCC801A0B2',
  255. 'from':'coven@chat.shakespeare.lit/firstwitch',
  256. 'type':'groupchat' })
  257. .c('body').t("Thrice the brinded cat hath mew'd.");
  258. _converse.connection._dataRecv(test_utils.createRequest(msg1));
  259. /* Send an <iq> stanza to indicate the end of the result set.
  260. *
  261. * <iq type='result' id='juliet1'>
  262. * <fin xmlns='urn:xmpp:mam:2'>
  263. * <set xmlns='http://jabber.org/protocol/rsm'>
  264. * <first index='0'>28482-98726-73623</first>
  265. * <last>09af3-cc343-b409f</last>
  266. * <count>20</count>
  267. * </set>
  268. * </iq>
  269. */
  270. const stanza = $iq({'type': 'result', 'id': sent_stanza.getAttribute('id')})
  271. .c('fin', {'xmlns': 'urn:xmpp:mam:2'})
  272. .c('set', {'xmlns': 'http://jabber.org/protocol/rsm'})
  273. .c('first', {'index': '0'}).t('23452-4534-1').up()
  274. .c('last').t('09af3-cc343-b409f').up()
  275. .c('count').t('16');
  276. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  277. const result = await promise;
  278. expect(result.messages.length).toBe(0);
  279. done();
  280. }));
  281. it("can be used to query for all messages in a certain timespan",
  282. mock.initConverse(
  283. null, [], {},
  284. async function (done, _converse) {
  285. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  286. let sent_stanza, IQ_id;
  287. const sendIQ = _converse.connection.sendIQ;
  288. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  289. sent_stanza = iq;
  290. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  291. });
  292. const start = '2010-06-07T00:00:00Z';
  293. const end = '2010-07-07T13:23:54Z';
  294. _converse.api.archive.query({
  295. 'start': start,
  296. 'end': end
  297. });
  298. await test_utils.waitUntil(() => sent_stanza);
  299. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  300. expect(sent_stanza.toString()).toBe(
  301. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  302. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  303. `<x type="submit" xmlns="jabber:x:data">`+
  304. `<field type="hidden" var="FORM_TYPE">`+
  305. `<value>urn:xmpp:mam:2</value>`+
  306. `</field>`+
  307. `<field var="start">`+
  308. `<value>${dayjs(start).toISOString()}</value>`+
  309. `</field>`+
  310. `<field var="end">`+
  311. `<value>${dayjs(end).toISOString()}</value>`+
  312. `</field>`+
  313. `</x>`+
  314. `</query>`+
  315. `</iq>`
  316. );
  317. done();
  318. }));
  319. it("throws a TypeError if an invalid date is provided",
  320. mock.initConverse(
  321. null, [], {},
  322. async function (done, _converse) {
  323. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  324. try {
  325. await _converse.api.archive.query({'start': 'not a real date'});
  326. } catch (e) {
  327. expect(() => {throw e}).toThrow(new TypeError('archive.query: invalid date provided for: start'));
  328. }
  329. done();
  330. }));
  331. it("can be used to query for all messages after a certain time",
  332. mock.initConverse(
  333. null, [], {},
  334. async function (done, _converse) {
  335. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  336. let sent_stanza, IQ_id;
  337. const sendIQ = _converse.connection.sendIQ;
  338. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  339. sent_stanza = iq;
  340. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  341. });
  342. if (!_converse.disco_entities.get(_converse.domain).features.findWhere({'var': Strophe.NS.MAM})) {
  343. _converse.disco_entities.get(_converse.domain).features.create({'var': Strophe.NS.MAM});
  344. }
  345. const start = '2010-06-07T00:00:00Z';
  346. _converse.api.archive.query({'start': start});
  347. await test_utils.waitUntil(() => sent_stanza);
  348. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  349. expect(sent_stanza.toString()).toBe(
  350. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  351. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  352. `<x type="submit" xmlns="jabber:x:data">`+
  353. `<field type="hidden" var="FORM_TYPE">`+
  354. `<value>urn:xmpp:mam:2</value>`+
  355. `</field>`+
  356. `<field var="start">`+
  357. `<value>${dayjs(start).toISOString()}</value>`+
  358. `</field>`+
  359. `</x>`+
  360. `</query>`+
  361. `</iq>`
  362. );
  363. done();
  364. }));
  365. it("can be used to query for a limited set of results",
  366. mock.initConverse(
  367. null, [], {},
  368. async function (done, _converse) {
  369. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  370. let sent_stanza, IQ_id;
  371. const sendIQ = _converse.connection.sendIQ;
  372. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  373. sent_stanza = iq;
  374. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  375. });
  376. const start = '2010-06-07T00:00:00Z';
  377. _converse.api.archive.query({'start': start, 'max':10});
  378. await test_utils.waitUntil(() => sent_stanza);
  379. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  380. expect(sent_stanza.toString()).toBe(
  381. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  382. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  383. `<x type="submit" xmlns="jabber:x:data">`+
  384. `<field type="hidden" var="FORM_TYPE">`+
  385. `<value>urn:xmpp:mam:2</value>`+
  386. `</field>`+
  387. `<field var="start">`+
  388. `<value>${dayjs(start).toISOString()}</value>`+
  389. `</field>`+
  390. `</x>`+
  391. `<set xmlns="http://jabber.org/protocol/rsm">`+
  392. `<max>10</max>`+
  393. `</set>`+
  394. `</query>`+
  395. `</iq>`
  396. );
  397. done();
  398. }));
  399. it("can be used to page through results",
  400. mock.initConverse(
  401. null, [], {},
  402. async function (done, _converse) {
  403. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  404. let sent_stanza, IQ_id;
  405. const sendIQ = _converse.connection.sendIQ;
  406. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  407. sent_stanza = iq;
  408. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  409. });
  410. const start = '2010-06-07T00:00:00Z';
  411. _converse.api.archive.query({
  412. 'start': start,
  413. 'after': '09af3-cc343-b409f',
  414. 'max':10
  415. });
  416. await test_utils.waitUntil(() => sent_stanza);
  417. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  418. expect(sent_stanza.toString()).toBe(
  419. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  420. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  421. `<x type="submit" xmlns="jabber:x:data">`+
  422. `<field type="hidden" var="FORM_TYPE">`+
  423. `<value>urn:xmpp:mam:2</value>`+
  424. `</field>`+
  425. `<field var="start">`+
  426. `<value>${dayjs(start).toISOString()}</value>`+
  427. `</field>`+
  428. `</x>`+
  429. `<set xmlns="http://jabber.org/protocol/rsm">`+
  430. `<max>10</max>`+
  431. `<after>09af3-cc343-b409f</after>`+
  432. `</set>`+
  433. `</query>`+
  434. `</iq>`);
  435. done();
  436. }));
  437. it("accepts \"before\" with an empty string as value to reverse the order",
  438. mock.initConverse(
  439. null, [], {},
  440. async function (done, _converse) {
  441. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  442. let sent_stanza, IQ_id;
  443. const sendIQ = _converse.connection.sendIQ;
  444. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  445. sent_stanza = iq;
  446. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  447. });
  448. _converse.api.archive.query({'before': '', 'max':10});
  449. await test_utils.waitUntil(() => sent_stanza);
  450. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  451. expect(sent_stanza.toString()).toBe(
  452. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  453. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  454. `<x type="submit" xmlns="jabber:x:data">`+
  455. `<field type="hidden" var="FORM_TYPE">`+
  456. `<value>urn:xmpp:mam:2</value>`+
  457. `</field>`+
  458. `</x>`+
  459. `<set xmlns="http://jabber.org/protocol/rsm">`+
  460. `<max>10</max>`+
  461. `<before></before>`+
  462. `</set>`+
  463. `</query>`+
  464. `</iq>`);
  465. done();
  466. }));
  467. it("accepts a _converse.RSM object for the query options",
  468. mock.initConverse(
  469. null, [], {},
  470. async function (done, _converse) {
  471. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  472. let sent_stanza, IQ_id;
  473. const sendIQ = _converse.connection.sendIQ;
  474. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  475. sent_stanza = iq;
  476. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  477. });
  478. // Normally the user wouldn't manually make a _converse.RSM object
  479. // and pass it in. However, in the callback method an RSM object is
  480. // returned which can be reused for easy paging. This test is
  481. // more for that usecase.
  482. const rsm = new _converse.RSM({'max': '10'});
  483. rsm['with'] = 'romeo@montague.lit'; // eslint-disable-line dot-notation
  484. rsm.start = '2010-06-07T00:00:00Z';
  485. _converse.api.archive.query(rsm);
  486. await test_utils.waitUntil(() => sent_stanza);
  487. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  488. expect(sent_stanza.toString()).toBe(
  489. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  490. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  491. `<x type="submit" xmlns="jabber:x:data">`+
  492. `<field type="hidden" var="FORM_TYPE">`+
  493. `<value>urn:xmpp:mam:2</value>`+
  494. `</field>`+
  495. `<field var="with">`+
  496. `<value>romeo@montague.lit</value>`+
  497. `</field>`+
  498. `<field var="start">`+
  499. `<value>${dayjs(rsm.start).toISOString()}</value>`+
  500. `</field>`+
  501. `</x>`+
  502. `<set xmlns="http://jabber.org/protocol/rsm">`+
  503. `<max>10</max>`+
  504. `</set>`+
  505. `</query>`+
  506. `</iq>`);
  507. done();
  508. }));
  509. it("returns an object which includes the messages and a _converse.RSM object",
  510. mock.initConverse(
  511. null, [], {},
  512. async function (done, _converse) {
  513. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  514. let sent_stanza, IQ_id;
  515. const sendIQ = _converse.connection.sendIQ;
  516. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  517. sent_stanza = iq;
  518. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  519. });
  520. const promise = _converse.api.archive.query({'with': 'romeo@capulet.lit', 'max':'10'});
  521. await test_utils.waitUntil(() => sent_stanza);
  522. const queryid = sent_stanza.nodeTree.querySelector('query').getAttribute('queryid');
  523. /* <message id='aeb213' to='juliet@capulet.lit/chamber'>
  524. * <result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
  525. * <forwarded xmlns='urn:xmpp:forward:0'>
  526. * <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
  527. * <message xmlns='jabber:client'
  528. * to='juliet@capulet.lit/balcony'
  529. * from='romeo@montague.lit/orchard'
  530. * type='chat'>
  531. * <body>Call me but love, and I'll be new baptized; Henceforth I never will be Romeo.</body>
  532. * </message>
  533. * </forwarded>
  534. * </result>
  535. * </message>
  536. */
  537. const msg1 = $msg({'id':'aeb213', 'to':'juliet@capulet.lit/chamber'})
  538. .c('result', {'xmlns': 'urn:xmpp:mam:2', 'queryid':queryid, 'id':'28482-98726-73623'})
  539. .c('forwarded', {'xmlns':'urn:xmpp:forward:0'})
  540. .c('delay', {'xmlns':'urn:xmpp:delay', 'stamp':'2010-07-10T23:08:25Z'}).up()
  541. .c('message', {
  542. 'xmlns':'jabber:client',
  543. 'to':'juliet@capulet.lit/balcony',
  544. 'from':'romeo@montague.lit/orchard',
  545. 'type':'chat' })
  546. .c('body').t("Call me but love, and I'll be new baptized;");
  547. _converse.connection._dataRecv(test_utils.createRequest(msg1));
  548. const msg2 = $msg({'id':'aeb213', 'to':'juliet@capulet.lit/chamber'})
  549. .c('result', {'xmlns': 'urn:xmpp:mam:2', 'queryid':queryid, 'id':'28482-98726-73624'})
  550. .c('forwarded', {'xmlns':'urn:xmpp:forward:0'})
  551. .c('delay', {'xmlns':'urn:xmpp:delay', 'stamp':'2010-07-10T23:08:25Z'}).up()
  552. .c('message', {
  553. 'xmlns':'jabber:client',
  554. 'to':'juliet@capulet.lit/balcony',
  555. 'from':'romeo@montague.lit/orchard',
  556. 'type':'chat' })
  557. .c('body').t("Henceforth I never will be Romeo.");
  558. _converse.connection._dataRecv(test_utils.createRequest(msg2));
  559. /* Send an <iq> stanza to indicate the end of the result set.
  560. *
  561. * <iq type='result' id='juliet1'>
  562. * <fin xmlns='urn:xmpp:mam:2'>
  563. * <set xmlns='http://jabber.org/protocol/rsm'>
  564. * <first index='0'>28482-98726-73623</first>
  565. * <last>09af3-cc343-b409f</last>
  566. * <count>20</count>
  567. * </set>
  568. * </iq>
  569. */
  570. const stanza = $iq({'type': 'result', 'id': IQ_id})
  571. .c('fin', {'xmlns': 'urn:xmpp:mam:2'})
  572. .c('set', {'xmlns': 'http://jabber.org/protocol/rsm'})
  573. .c('first', {'index': '0'}).t('23452-4534-1').up()
  574. .c('last').t('09af3-cc343-b409f').up()
  575. .c('count').t('16');
  576. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  577. const result = await promise;
  578. expect(result.messages.length).toBe(2);
  579. expect(result.messages[0].outerHTML).toBe(msg1.nodeTree.outerHTML);
  580. expect(result.messages[1].outerHTML).toBe(msg2.nodeTree.outerHTML);
  581. expect(result.rsm['with']).toBe('romeo@capulet.lit'); // eslint-disable-line dot-notation
  582. expect(result.rsm.max).toBe('10');
  583. expect(result.rsm.count).toBe('16');
  584. expect(result.rsm.first).toBe('23452-4534-1');
  585. expect(result.rsm.last).toBe('09af3-cc343-b409f');
  586. done()
  587. }));
  588. });
  589. describe("The default preference", function () {
  590. it("is set once server support for MAM has been confirmed",
  591. mock.initConverse(
  592. null, [], {},
  593. async function (done, _converse) {
  594. const entity = await _converse.api.disco.entities.get(_converse.domain);
  595. let sent_stanza, IQ_id;
  596. const sendIQ = _converse.connection.sendIQ;
  597. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  598. sent_stanza = iq;
  599. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  600. });
  601. spyOn(_converse, 'onMAMPreferences').and.callThrough();
  602. _converse.message_archiving = 'never';
  603. const feature = new Backbone.Model({
  604. 'var': Strophe.NS.MAM
  605. });
  606. spyOn(feature, 'save').and.callFake(feature.set); // Save will complain about a url not being set
  607. entity.onFeatureAdded(feature);
  608. expect(_converse.connection.sendIQ).toHaveBeenCalled();
  609. expect(sent_stanza.toLocaleString()).toBe(
  610. `<iq id="${IQ_id}" type="get" xmlns="jabber:client">`+
  611. `<prefs xmlns="urn:xmpp:mam:2"/>`+
  612. `</iq>`);
  613. /* Example 20. Server responds with current preferences
  614. *
  615. * <iq type='result' id='juliet2'>
  616. * <prefs xmlns='urn:xmpp:mam:0' default='roster'>
  617. * <always/>
  618. * <never/>
  619. * </prefs>
  620. * </iq>
  621. */
  622. let stanza = $iq({'type': 'result', 'id': IQ_id})
  623. .c('prefs', {'xmlns': Strophe.NS.MAM, 'default':'roster'})
  624. .c('always').c('jid').t('romeo@montague.lit').up().up()
  625. .c('never').c('jid').t('montague@montague.lit');
  626. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  627. await test_utils.waitUntil(() => _converse.onMAMPreferences.calls.count());
  628. expect(_converse.onMAMPreferences).toHaveBeenCalled();
  629. expect(sent_stanza.toString()).toBe(
  630. `<iq id="${IQ_id}" type="set" xmlns="jabber:client">`+
  631. `<prefs default="never" xmlns="urn:xmpp:mam:2">`+
  632. `<always><jid>romeo@montague.lit</jid></always>`+
  633. `<never><jid>montague@montague.lit</jid></never>`+
  634. `</prefs>`+
  635. `</iq>`
  636. );
  637. expect(feature.get('preference')).toBe(undefined);
  638. /* <iq type='result' id='juliet3'>
  639. * <prefs xmlns='urn:xmpp:mam:0' default='always'>
  640. * <always>
  641. * <jid>romeo@montague.lit</jid>
  642. * </always>
  643. * <never>
  644. * <jid>montague@montague.lit</jid>
  645. * </never>
  646. * </prefs>
  647. * </iq>
  648. */
  649. stanza = $iq({'type': 'result', 'id': IQ_id})
  650. .c('prefs', {'xmlns': Strophe.NS.MAM, 'default':'always'})
  651. .c('always').up()
  652. .c('never');
  653. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  654. await test_utils.waitUntil(() => feature.save.calls.count());
  655. expect(feature.save).toHaveBeenCalled();
  656. expect(feature.get('preferences')['default']).toBe('never'); // eslint-disable-line dot-notation
  657. done();
  658. }));
  659. });
  660. });
  661. describe("Chatboxes", function () {
  662. describe("A Chatbox", function () {
  663. it("will fetch archived messages once it's opened",
  664. mock.initConverse(
  665. null, ['discoInitialized'], {},
  666. async function (done, _converse) {
  667. await test_utils.waitForRoster(_converse, 'current', 1);
  668. const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
  669. await test_utils.openChatBoxFor(_converse, contact_jid);
  670. await test_utils.waitUntilDiscoConfirmed(_converse, _converse.bare_jid, null, [Strophe.NS.MAM]);
  671. let sent_stanza, IQ_id;
  672. const sendIQ = _converse.connection.sendIQ;
  673. spyOn(_converse.connection, 'sendIQ').and.callFake(function (iq, callback, errback) {
  674. sent_stanza = iq;
  675. IQ_id = sendIQ.bind(this)(iq, callback, errback);
  676. });
  677. const view = _converse.chatboxviews.get(contact_jid);
  678. await test_utils.waitUntil(() => sent_stanza);
  679. const stanza_el = sent_stanza.root().nodeTree;
  680. const queryid = stanza_el.querySelector('query').getAttribute('queryid');
  681. expect(sent_stanza.toString()).toBe(
  682. `<iq id="${stanza_el.getAttribute('id')}" type="set" xmlns="jabber:client">`+
  683. `<query queryid="${queryid}" xmlns="urn:xmpp:mam:2">`+
  684. `<x type="submit" xmlns="jabber:x:data">`+
  685. `<field type="hidden" var="FORM_TYPE"><value>urn:xmpp:mam:2</value></field>`+
  686. `<field var="with"><value>mercutio@montague.lit</value></field>`+
  687. `</x>`+
  688. `<set xmlns="http://jabber.org/protocol/rsm"><max>50</max><before></before></set>`+
  689. `</query>`+
  690. `</iq>`
  691. );
  692. const msg1 = $msg({'id':'aeb213', 'to': contact_jid})
  693. .c('result', {'xmlns': 'urn:xmpp:mam:2', 'queryid':queryid, 'id':'28482-98726-73623'})
  694. .c('forwarded', {'xmlns':'urn:xmpp:forward:0'})
  695. .c('delay', {'xmlns':'urn:xmpp:delay', 'stamp':'2010-07-10T23:08:25Z'}).up()
  696. .c('message', {
  697. 'xmlns':'jabber:client',
  698. 'to': contact_jid,
  699. 'from': _converse.bare_jid,
  700. 'type':'chat' })
  701. .c('body').t("Call me but love, and I'll be new baptized;");
  702. _converse.connection._dataRecv(test_utils.createRequest(msg1));
  703. const msg2 = $msg({'id':'aeb213', 'to': contact_jid})
  704. .c('result', {'xmlns': 'urn:xmpp:mam:2', 'queryid':queryid, 'id':'28482-98726-73624'})
  705. .c('forwarded', {'xmlns':'urn:xmpp:forward:0'})
  706. .c('delay', {'xmlns':'urn:xmpp:delay', 'stamp':'2010-07-10T23:08:25Z'}).up()
  707. .c('message', {
  708. 'xmlns':'jabber:client',
  709. 'to': contact_jid,
  710. 'from': _converse.bare_jid,
  711. 'type':'chat' })
  712. .c('body').t("Henceforth I never will be Romeo.");
  713. _converse.connection._dataRecv(test_utils.createRequest(msg2));
  714. const stanza = $iq({'type': 'result', 'id': IQ_id})
  715. .c('fin', {'xmlns': 'urn:xmpp:mam:2'})
  716. .c('set', {'xmlns': 'http://jabber.org/protocol/rsm'})
  717. .c('first', {'index': '0'}).t('23452-4534-1').up()
  718. .c('last').t('09af3-cc343-b409f').up()
  719. .c('count').t('16');
  720. _converse.connection._dataRecv(test_utils.createRequest(stanza));
  721. done();
  722. }));
  723. });
  724. });
  725. }));