2
0

mam.js 39 KB

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