Fixes #129 Add support for XEP-0156.

Only XML is supported for now.

Author: jcbrand

CHANGES.md

@@ -2,11 +2,18 @@
 
 ## 6.0.0 (Unreleased)
 
+- #129: Add support for XEP-0156: Disovering Alternative XMPP Connection Methods. Only XML is supported for now.
 - #1691 Fix `collection.chatbox is undefined` errors
 - Prevent editing of sent file uploads.
 
 ### Breaking changes
 
+- In order to add support for XEP-0156, the XMPP connection needs to be created
+  only once we know the JID of the user that's logging in. This means that the
+  [connectionInitialized](https://conversejs.org/docs/html/api/-_converse.html#event:connectionInitialized)
+  event now fires much later than before. Plugins that rely on `connectionInitialized`
+  being triggered before the user's JID has been provided will need to be updated.
+
 - The following API methods now return promises:
   * `_converse.api.chats.get`
   * `_converse.api.chats.create`

docs/source/configuration.rst

@@ -639,6 +639,23 @@ The default chat status that the user wil have. If you for example set this to
 ``'chat'``, then Converse will send out a presence stanza with ``"show"``
 set to ``'chat'`` as soon as you've been logged in.
 
+
+discover_connection_methods
+---------------------------
+
+* Default: ``false``
+
+Use `XEP-0156 <https://xmpp.org/extensions/xep-0156.html>`_ to discover whether
+the XMPP host for the current user advertises any Websocket or BOSH connection
+URLs that can be used.
+
+If this is set to ``false``, then a `websocket_url`_ or `bosh_service_url`_ need to be
+set.
+
+Currently only the XML encoded host-meta resource is supported as shown in
+`Example 2 under section 3.3 <https://xmpp.org/extensions/xep-0156.html#httpexamples>`_.
+
+
 domain_placeholder
 ------------------
 
@@ -647,8 +664,6 @@ domain_placeholder
 The placeholder text shown in the domain input on the registration form.
 
 
-
-
 emoji_image_path
 ----------------
 
@@ -1624,6 +1639,7 @@ Allows you to show or hide buttons on the chatboxes' toolbars.
 
 .. _`websocket-url`:
 
+
 websocket_url
 -------------
 

spec/bookmarks.js

@@ -404,8 +404,8 @@
 
 
         it("can be retrieved from the XMPP server", mock.initConverse(
-            {'connection': ['send']}, ['chatBoxesFetched', 'roomsPanelRendered', 'rosterGroupsFetched'], {},
-            async function (done, _converse) {
+                null, ['chatBoxesFetched', 'roomsPanelRendered', 'rosterGroupsFetched'], {},
+                async function (done, _converse) {
 
             await test_utils.waitUntilDiscoConfirmed(
                 _converse, _converse.bare_jid,
@@ -421,25 +421,12 @@
              *  </pubsub>
              *  </iq>
              */
-            let IQ_id;
-            const call = await u.waitUntil(() =>
-                _.filter(
-                    _converse.connection.send.calls.all(),
-                    call => {
-                        const stanza = call.args[0];
-                        if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') {
-                            return;
-                        }
-                        if (sizzle('items[node="storage:bookmarks"]', stanza).length) {
-                            IQ_id = stanza.getAttribute('id');
-                            return true;
-                        }
-                    }
-                ).pop()
-            );
+            const IQ_stanzas = _converse.connection.IQ_stanzas;
+            const sent_stanza = await u.waitUntil(
+                () => IQ_stanzas.filter(s => sizzle('items[node="storage:bookmarks"]', s).length).pop());
 
-            expect(Strophe.serialize(call.args[0])).toBe(
-                `<iq from="[email protected]/orchard" id="${IQ_id}" type="get" xmlns="jabber:client">`+
+            expect(Strophe.serialize(sent_stanza)).toBe(
+                `<iq from="[email protected]/orchard" id="${sent_stanza.getAttribute('id')}" type="get" xmlns="jabber:client">`+
                 '<pubsub xmlns="http://jabber.org/protocol/pubsub">'+
                     '<items node="storage:bookmarks"/>'+
                 '</pubsub>'+
@@ -469,7 +456,7 @@
             expect(_converse.bookmarks.models.length).toBe(0);
 
             spyOn(_converse.bookmarks, 'onBookmarksReceived').and.callThrough();
-            var stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id})
+            var stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':sent_stanza.getAttribute('id')})
                 .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
                     .c('items', {'node': 'storage:bookmarks'})
                         .c('item', {'id': 'current'})
@@ -495,7 +482,7 @@
         describe("The rooms panel", function () {
 
             it("shows a list of bookmarks", mock.initConverse(
-                {'connection': ['send']}, ['rosterGroupsFetched'], {},
+                null, ['rosterGroupsFetched'], {},
                 async function (done, _converse) {
 
                 await test_utils.waitUntilDiscoConfirmed(
@@ -505,31 +492,19 @@
                 );
                 test_utils.openControlBox();
 
-                let IQ_id;
-                const call = await u.waitUntil(() =>
-                    _.filter(
-                        _converse.connection.send.calls.all(),
-                        call => {
-                            const stanza = call.args[0];
-                            if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') {
-                                return;
-                            }
-                            if (sizzle('items[node="storage:bookmarks"]', stanza).length) {
-                                IQ_id = stanza.getAttribute('id');
-                                return true;
-                            }
-                        }
-                    ).pop()
-                );
-                expect(Strophe.serialize(call.args[0])).toBe(
-                    `<iq from="[email protected]/orchard" id="${IQ_id}" type="get" xmlns="jabber:client">`+
+                const IQ_stanzas = _converse.connection.IQ_stanzas;
+                const sent_stanza = await u.waitUntil(
+                    () => IQ_stanzas.filter(s => sizzle('items[node="storage:bookmarks"]', s).length).pop());
+
+                expect(Strophe.serialize(sent_stanza)).toBe(
+                    `<iq from="[email protected]/orchard" id="${sent_stanza.getAttribute('id')}" type="get" xmlns="jabber:client">`+
                     '<pubsub xmlns="http://jabber.org/protocol/pubsub">'+
                         '<items node="storage:bookmarks"/>'+
                     '</pubsub>'+
                     '</iq>'
                 );
 
-                const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id})
+                const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':sent_stanza.getAttribute('id')})
                     .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
                         .c('items', {'node': 'storage:bookmarks'})
                             .c('item', {'id': 'current'})
@@ -583,7 +558,7 @@
 
 
             it("remembers the toggle state of the bookmarks list", mock.initConverse(
-                {'connection': ['send']}, ['rosterGroupsFetched'], {},
+                null, ['rosterGroupsFetched'], {},
                 async function (done, _converse) {
 
                 test_utils.openControlBox();
@@ -593,31 +568,19 @@
                     ['http://jabber.org/protocol/pubsub#publish-options']
                 );
 
-                let IQ_id;
-                const call = await u.waitUntil(() =>
-                    _.filter(
-                        _converse.connection.send.calls.all(),
-                        call => {
-                            const stanza = call.args[0];
-                            if (!(stanza instanceof Element) || stanza.nodeName !== 'iq') {
-                                return;
-                            }
-                            if (sizzle('items[node="storage:bookmarks"]', stanza).length) {
-                                IQ_id = stanza.getAttribute('id');
-                                return true;
-                            }
-                        }
-                    ).pop()
-                );
-                expect(Strophe.serialize(call.args[0])).toBe(
-                    `<iq from="[email protected]/orchard" id="${IQ_id}" type="get" xmlns="jabber:client">`+
+                const IQ_stanzas = _converse.connection.IQ_stanzas;
+                const sent_stanza = await u.waitUntil(
+                    () => IQ_stanzas.filter(s => sizzle('items[node="storage:bookmarks"]', s).length).pop());
+
+                expect(Strophe.serialize(sent_stanza)).toBe(
+                    `<iq from="[email protected]/orchard" id="${sent_stanza.getAttribute('id')}" type="get" xmlns="jabber:client">`+
                     '<pubsub xmlns="http://jabber.org/protocol/pubsub">'+
                         '<items node="storage:bookmarks"/>'+
                     '</pubsub>'+
                     '</iq>'
                 );
 
-                const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':IQ_id})
+                const stanza = $iq({'to': _converse.connection.jid, 'type':'result', 'id':sent_stanza.getAttribute('id')})
                     .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
                         .c('items', {'node': 'storage:bookmarks'})
                             .c('item', {'id': 'current'})

spec/login.js

@@ -8,7 +8,7 @@
 
         it("contains a checkbox to indicate whether the computer is trusted or not",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: false },
                 async function (done, _converse) {
@@ -42,7 +42,7 @@
 
         it("checkbox can be set to false by default",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   trusted: false,
                   allow_registration: false },

spec/register.js

@@ -10,7 +10,7 @@
 
         it("is not available unless allow_registration=true",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: false },
                 async function (done, _converse) {
@@ -24,7 +24,7 @@
 
         it("can be opened by clicking on the registration tab",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: true },
                 async function (done, _converse) {
@@ -45,18 +45,18 @@
 
         it("allows the user to choose an XMPP provider's domain",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: true },
                 async function (done, _converse) {
 
+            spyOn(Strophe.Connection.prototype, 'connect');
             await u.waitUntil(() => _.get(_converse.chatboxviews.get('controlbox'), 'registerpanel'));
             test_utils.openControlBox();
             const cbview = _converse.chatboxviews.get('controlbox');
             const registerview = cbview.registerpanel;
             spyOn(registerview, 'onProviderChosen').and.callThrough();
             registerview.delegateEvents();  // We need to rebind all events otherwise our spy won't be called
-            spyOn(_converse.connection, 'connect');
 
             // Open the register panel
             cbview.el.querySelector('.toggle-register-login').click();
@@ -75,17 +75,18 @@
             form.querySelector('input[name=domain]').value = 'conversejs.org';
             submit_button.click();
             expect(registerview.onProviderChosen).toHaveBeenCalled();
-            expect(_converse.connection.connect).toHaveBeenCalled();
+            await u.waitUntil(() => _converse.connection.connect.calls.count());
             done();
         }));
 
         it("will render a registration form as received from the XMPP provider",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: true },
                 async function (done, _converse) {
 
+            spyOn(Strophe.Connection.prototype, 'connect');
             await u.waitUntil(() => _.get(_converse.chatboxviews.get('controlbox'), 'registerpanel'));
             test_utils.openControlBox();
             const cbview = _converse.chatboxviews.get('controlbox');
@@ -97,15 +98,14 @@
             spyOn(registerview, 'onRegistrationFields').and.callThrough();
             spyOn(registerview, 'renderRegistrationForm').and.callThrough();
             registerview.delegateEvents();  // We need to rebind all events otherwise our spy won't be called
-            spyOn(_converse.connection, 'connect').and.callThrough();
 
             expect(registerview._registering).toBeFalsy();
             expect(_converse.connection.connected).toBeFalsy();
             registerview.el.querySelector('input[name=domain]').value  = 'conversejs.org';
             registerview.el.querySelector('input[type=submit]').click();
             expect(registerview.onProviderChosen).toHaveBeenCalled();
             expect(registerview._registering).toBeTruthy();
-            expect(_converse.connection.connect).toHaveBeenCalled();
+            await u.waitUntil(() => _converse.connection.connect.calls.count());
 
             let stanza = new Strophe.Builder("stream:features", {
                         'xmlns:stream': "http://etherx.jabber.org/streams",
@@ -137,7 +137,7 @@
 
         it("will set form_type to legacy and submit it as legacy",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: true },
                 async function (done, _converse) {
@@ -194,7 +194,7 @@
 
         it("will set form_type to xform and submit it as xform",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   allow_registration: true },
                 async function (done, _converse) {
@@ -267,7 +267,7 @@
 
         it("renders the account registration form",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { auto_login: false,
                   view_mode: 'fullscreen',
                   allow_registration: true },

spec/roomslist.js

@@ -53,7 +53,7 @@
 
         it("uses bookmarks to determine groupchat names",
             mock.initConverse(
-                {'connection': ['send']},
+                null,
                 ['rosterGroupsFetched', 'chatBoxesFetched', 'emojisInitialized'],
                 {'view_mode': 'fullscreen'},
                 async function (done, _converse) {
@@ -113,7 +113,7 @@
 
     describe("A groupchat shown in the groupchats list", function () {
 
-        it("is highlighted if its currently open", mock.initConverse(
+        it("is highlighted if it's currently open", mock.initConverse(
             null, ['rosterGroupsFetched', 'chatBoxesFetched', 'emojisInitialized'],
             { view_mode: 'fullscreen',
               allow_bookmarks: false // Makes testing easier, otherwise we have to mock stanza traffic.
@@ -137,8 +137,6 @@
             expect(room_els.length).toBe(1);
             item = room_els[0];
             expect(item.textContent.trim()).toBe('[email protected]');
-            const conv_el = document.querySelector('#conversejs');
-            conv_el.parentElement.removeChild(conv_el);
             done();
         }));
 

spec/smacks.js

@@ -11,7 +11,7 @@
 
         it("gets enabled with an <enable> stanza and resumed with a <resume> stanza",
             mock.initConverse(
-                null, ['connectionInitialized', 'chatBoxesInitialized'],
+                null, ['chatBoxesInitialized'],
                 { 'auto_login': false,
                   'enable_smacks': true,
                   'show_controlbox_by_default': true,

src/converse-chatview.js

@@ -1124,7 +1124,7 @@ converse.plugins.add('converse-chatview', {
                 if (Backbone.history.getFragment() === "converse/chat?jid="+this.model.get('jid')) {
                     _converse.router.navigate('');
                 }
-                if (_converse.connection.connected) {
+                if (_converse.api.connection.connected()) {
                     // Immediately sending the chat state, because the
                     // model is going to be destroyed afterwards.
                     this.model.setChatState(_converse.INACTIVE);