core: Make `clearSession` a synchronous event

In order to give plugins time to properly clear data from the browser storage.

spec/smacks.js

@@ -23,7 +23,7 @@
             const view = _converse.chatboxviews.get('controlbox');
             spyOn(view, 'renderControlBoxPane').and.callThrough();
 
-            _converse.api.user.login('romeo@montague.lit/orchard', 'secret');
+            await _converse.api.user.login('romeo@montague.lit/orchard', 'secret');
             const sent_stanzas = _converse.connection.sent_stanzas;
             let stanza = await u.waitUntil(() =>
                 sent_stanzas.filter(s => (s.tagName === 'enable')).pop());
@@ -99,13 +99,13 @@
             _converse.connection._dataRecv(test_utils.createRequest(r));
             ack = await u.waitUntil(() => sent_stanzas.filter(s => (s.nodeName === 'a' && s.getAttribute('h') === '1')).pop());
             expect(Strophe.serialize(ack)).toBe('<a h="1" xmlns="urn:xmpp:sm:3"/>');
+            await _converse.api.waitUntil('rosterInitialized');
 
             // test session resumption
             _converse.connection.IQ_stanzas = [];
             IQ_stanzas = _converse.connection.IQ_stanzas;
             await _converse.api.connection.reconnect();
             stanza = await u.waitUntil(() => sent_stanzas.filter(s => (s.tagName === 'resume')).pop());
-
             expect(Strophe.serialize(stanza)).toEqual('<resume h="2" previd="some-long-sm-id" xmlns="urn:xmpp:sm:3"/>');
 
             result = u.toStanza(`<resumed xmlns="urn:xmpp:sm:3" h="another-sequence-number" previd="some-long-sm-id"/>`);
@@ -115,6 +115,7 @@
             expect(sent_stanzas.filter(s => (s.tagName === 'enable')).length).toBe(1);
             expect(_converse.session.get('smacks_enabled')).toBe(true);
 
+            await new Promise(resolve => _converse.api.listen.once('reconnected', resolve));
             await u.waitUntil(() => IQ_stanzas.length === 1);
 
             // Test that unacked stanzas get resent out
@@ -122,8 +123,6 @@
             expect(Strophe.serialize(iq)).toBe(`<iq id="${iq.getAttribute('id')}" type="get" xmlns="jabber:client"><query xmlns="jabber:iq:roster"/></iq>`);
 
             expect(IQ_stanzas.filter(iq => sizzle('query[xmlns="jabber:iq:roster"]', iq).pop()).length).toBe(0);
-
-            await _converse.api.waitUntil('statusInitialized');
             done();
         }));
 
@@ -138,7 +137,7 @@
                 },
                 async function (done, _converse) {
 
-            _converse.api.user.login('romeo@montague.lit/orchard', 'secret');
+            await _converse.api.user.login('romeo@montague.lit/orchard', 'secret');
             const sent_stanzas = _converse.connection.sent_stanzas;
             let stanza = await u.waitUntil(() => sent_stanzas.filter(s => (s.tagName === 'enable')).pop());
             expect(Strophe.serialize(stanza)).toEqual('<enable resume="true" xmlns="urn:xmpp:sm:3"/>');
@@ -177,6 +176,7 @@
 
             // Check that the roster gets fetched
             await test_utils.waitForRoster(_converse, 'current', 1);
+            await new Promise(resolve => _converse.api.listen.once('reconnected', resolve));
             done();
         }));
 
@@ -233,7 +233,7 @@
             );
 
             _converse.no_connection_on_bind = true; // XXX Don't trigger CONNECTED in tests/mock.js
-            _converse.api.user.login('romeo@montague.lit', 'secret');
+            await _converse.api.user.login('romeo@montague.lit', 'secret');
             delete _converse.no_connection_on_bind;
 
             const sent_stanzas = _converse.connection.sent_stanzas;

src/headless/converse-core.js

@@ -534,12 +534,12 @@ function clearSession  () {
         delete _converse.session;
     }
     /**
-     * Triggered once the user session has been cleared,
+     * Synchronouse event triggered once the user session has been cleared,
      * for example when the user has logged out or when Converse has
      * disconnected for some other reason.
      * @event _converse#clearSession
      */
-    _converse.api.trigger('clearSession');
+    return _converse.api.trigger('clearSession', {'synchronous': true});
 }
 
 
@@ -798,7 +798,6 @@ async function finishInitialization () {
     initPlugins();
     registerGlobalEventHandlers();
 
-
     if (!History.started) {
         _converse.router.history.start();
     }
@@ -820,12 +819,12 @@ async function finishInitialization () {
  * @emits _converse#disconnected
  * @private
  */
-function finishDisconnection () {
+async function finishDisconnection () {
     log.debug('DISCONNECTED');
     delete _converse.connection.reconnecting;
     _converse.connection.reset();
     tearDown();
-    clearSession();
+    await clearSession();
     delete _converse.connection;
     /**
      * Triggered after converse.js has disconnected from the XMPP server.
@@ -1236,7 +1235,7 @@ _converse.api = {
 
             if (_converse.authentication === _converse.ANONYMOUS) {
                 await tearDown();
-                clearSession();
+                await clearSession();
             }
             if (conn_status === Strophe.Status.CONNFAIL) {
                 // When reconnecting with a new transport, we call setUserJID

src/headless/converse-roster.js

@@ -913,38 +913,33 @@ converse.plugins.add('converse-roster', {
             });
         });
 
-        function clearPresences () {
-            if (_converse.presences) {
-                _converse.presences.forEach(p => {
-                    p.resources.reject(r => r === undefined).forEach(r => r.destroy({'silent': true}));
-                });
-                _converse.presences.clearStore();
-            }
+        async function clearPresences () {
+            _converse.presences && await _converse.presences.clearStore();
         }
 
         _converse.api.listen.on('streamResumptionFailed', () => _converse.session.set('roster_cached', false));
 
-        _converse.api.listen.on('clearSession', () => {
-            clearPresences();
+        _converse.api.listen.on('clearSession', async () => {
+            await clearPresences();
             if (_converse.shouldClearCache()) {
+                if (_converse.rostergroups) {
+                    await _converse.rostergroups.clearStore();
+                    delete _converse.rostergroups;
+                }
                 if (_converse.roster) {
                     invoke(_converse, 'roster.data.destroy');
-                    _converse.roster.clearStore();
+                    await _converse.roster.clearStore();
                     delete _converse.roster;
                 }
-                if (_converse.rostergroups) {
-                    _converse.rostergroups.clearStore();
-                    delete _converse.rostergroups;
-                }
             }
         });
 
-        _converse.api.listen.on('statusInitialized', (reconnecting) => {
+        _converse.api.listen.on('statusInitialized', async reconnecting => {
             if (reconnecting) {
                 // When reconnecting and not resuming a previous session,
                 // we clear all cached presence data, since it might be stale
                 // and we'll receive new presence updates
-                !_converse.haveResumed() && clearPresences();
+                !_converse.haveResumed() && await clearPresences();
             } else {
                 _converse.presences = new _converse.Presences();
                 const id = `converse.presences-${_converse.bare_jid}`;

tests/utils.js

@@ -139,7 +139,7 @@
         return _converse.chatboxviews.get(jid);
     };
 
-    utils.openChatRoom = async function (_converse, room, server) {
+    utils.openChatRoom = function (_converse, room, server) {
         return _converse.api.rooms.open(`${room}@${server}`);
     };
 
@@ -371,11 +371,8 @@
     };
 
     utils.waitForRoster = async function (_converse, type='current', length=-1, include_nick=true, grouped=true) {
-        const iq = await u.waitUntil(() =>
-            _.filter(
-                _converse.connection.IQ_stanzas,
-                iq => sizzle(`iq[type="get"] query[xmlns="${Strophe.NS.ROSTER}"]`, iq).length
-            ).pop());
+        const s = `iq[type="get"] query[xmlns="${Strophe.NS.ROSTER}"]`;
+        const iq = await u.waitUntil(() => _converse.connection.IQ_stanzas.filter(iq => sizzle(s, iq).length).pop());
 
         const result = $iq({
             'to': _converse.connection.jid,