2
0

mam.js 36 KB

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