2
0

mam.js 42 KB

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