mam.js 39 KB

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