converse.js/spec/disco.js

(function (root, factory) {
    define([
        "jasmine",
        "mock",
        "test-utils"], factory);
} (this, function (jasmine, mock, test_utils) {
    "use strict";
    const Strophe = converse.env.Strophe;
    const $iq = converse.env.$iq;
    const _ = converse.env._;
    const u = converse.env.utils;

    describe("Service Discovery", function () {

        describe("Whenever converse.js queries a server for its features", function () {

            it("stores the features it receives",
                mock.initConverse(
                    ['discoInitialized'], {},
                    async function (done, _converse) {

                const IQ_stanzas = _converse.connection.IQ_stanzas;
                const IQ_ids =  _converse.connection.IQ_ids;
                await u.waitUntil(function () {
                    return _.filter(IQ_stanzas, function (iq) {
                        return iq.querySelector('iq[to="montague.lit"] query[xmlns="http://jabber.org/protocol/disco#info"]');
                    }).length > 0;
                });
                /* <iq type='result'
                 *      from='plays.shakespeare.lit'
                 *      to='romeo@montague.net/orchard'
                 *      id='info1'>
                 *  <query xmlns='http://jabber.org/protocol/disco#info'>
                 *      <identity
                 *          category='server'
                 *          type='im'/>
                 *      <identity
                 *          category='conference'
                 *          type='text'
                 *          name='Play-Specific Chatrooms'/>
                 *      <identity
                 *          category='directory'
                 *          type='chatroom'
                 *          name='Play-Specific Chatrooms'/>
                 *      <feature var='http://jabber.org/protocol/disco#info'/>
                 *      <feature var='http://jabber.org/protocol/disco#items'/>
                 *      <feature var='http://jabber.org/protocol/muc'/>
                 *      <feature var='jabber:iq:register'/>
                 *      <feature var='jabber:iq:search'/>
                 *      <feature var='jabber:iq:time'/>
                 *      <feature var='jabber:iq:version'/>
                 *  </query>
                 *  </iq>
                 */
                let stanza = _.find(IQ_stanzas, function (iq) {
                    return iq.querySelector('iq[to="montague.lit"] query[xmlns="http://jabber.org/protocol/disco#info"]');
                });
                const info_IQ_id = IQ_ids[IQ_stanzas.indexOf(stanza)];
                stanza = $iq({
                    'type': 'result',
                    'from': 'montague.lit',
                    'to': 'romeo@montague.lit/orchard',
                    'id': info_IQ_id
                }).c('query', {'xmlns': 'http://jabber.org/protocol/disco#info'})
                    .c('identity', {
                        'category': 'server',
                        'type': 'im'}).up()
                    .c('identity', {
                        'category': 'conference',
                        'type': 'text',
                        'name': 'Play-Specific Chatrooms'}).up()
                    .c('identity', {
                        'category': 'directory',
                        'type': 'chatroom',
                        'name': 'Play-Specific Chatrooms'}).up()
                    .c('feature', {
                        'var': 'http://jabber.org/protocol/disco#info'}).up()
                    .c('feature', {
                        'var': 'http://jabber.org/protocol/disco#items'}).up()
                    .c('feature', {
                        'var': 'jabber:iq:register'}).up()
                    .c('feature', {
                        'var': 'jabber:iq:time'}).up()
                    .c('feature', {
                        'var': 'jabber:iq:version'});
                _converse.connection._dataRecv(test_utils.createRequest(stanza));

                let entities = await _converse.api.disco.entities.get()
                expect(entities.length).toBe(2); // We have an extra entity, which is the user's JID
                expect(entities.get(_converse.domain).features.length).toBe(5);
                expect(entities.get(_converse.domain).identities.length).toBe(3);
                expect(entities.get('montague.lit').features.where({'var': 'jabber:iq:version'}).length).toBe(1);
                expect(entities.get('montague.lit').features.where({'var': 'jabber:iq:time'}).length).toBe(1);
                expect(entities.get('montague.lit').features.where({'var': 'jabber:iq:register'}).length).toBe(1);
                expect(entities.get('montague.lit').features.where(
                    {'var': 'http://jabber.org/protocol/disco#items'}).length).toBe(1);
                expect(entities.get('montague.lit').features.where(
                    {'var': 'http://jabber.org/protocol/disco#info'}).length).toBe(1);

                await u.waitUntil(function () {
                    // Converse.js sees that the entity has a disco#items feature,
                    // so it will make a query for it.
                    return _.filter(IQ_stanzas, function (iq) {
                        return iq.querySelector('query[xmlns="http://jabber.org/protocol/disco#items"]');
                    }).length > 0;
                });
                /* <iq type='result'
                 *     from='catalog.shakespeare.lit'
                 *     to='romeo@montague.net/orchard'
                 *     id='items2'>
                 * <query xmlns='http://jabber.org/protocol/disco#items'>
                 *     <item jid='people.shakespeare.lit'
                 *         name='Directory of Characters'/>
                 *     <item jid='plays.shakespeare.lit'
                 *         name='Play-Specific Chatrooms'/>
                 *     <item jid='mim.shakespeare.lit'
                 *         name='Gateway to Marlowe IM'/>
                 *     <item jid='words.shakespeare.lit'
                 *         name='Shakespearean Lexicon'/>
                 *
                 *     <item jid='catalog.shakespeare.lit'
                 *         node='books'
                 *         name='Books by and about Shakespeare'/>
                 *     <item jid='catalog.shakespeare.lit'
                 *         node='clothing'
                 *         name='Wear your literary taste with pride'/>
                 *     <item jid='catalog.shakespeare.lit'
                 *         node='music'
                 *         name='Music from the time of Shakespeare'/>
                 * </query>
                 * </iq>
                 */
                stanza = _.find(IQ_stanzas, function (iq) {
                    return iq.querySelector('iq[to="montague.lit"] query[xmlns="http://jabber.org/protocol/disco#items"]');
                });
                var items_IQ_id = IQ_ids[IQ_stanzas.indexOf(stanza)];
                stanza = $iq({
                    'type': 'result',
                    'from': 'montague.lit',
                    'to': 'romeo@montague.lit/orchard',
                    'id': items_IQ_id
                }).c('query', {'xmlns': 'http://jabber.org/protocol/disco#items'})
                    .c('item', {
                        'jid': 'people.shakespeare.lit',
                        'name': 'Directory of Characters'}).up()
                    .c('item', {
                        'jid': 'plays.shakespeare.lit',
                        'name': 'Play-Specific Chatrooms'}).up()
                    .c('item', {
                        'jid': 'words.shakespeare.lit',
                        'name': 'Gateway to Marlowe IM'}).up()

                    .c('item', {
                        'jid': 'montague.lit',
                        'node': 'books',
                        'name': 'Books by and about Shakespeare'}).up()
                    .c('item', {
                        'node': 'montague.lit',
                        'name': 'Wear your literary taste with pride'}).up()
                    .c('item', {
                        'jid': 'montague.lit',
                        'node': 'music',
                        'name': 'Music from the time of Shakespeare'
                    });
                _converse.connection._dataRecv(test_utils.createRequest(stanza));
                await u.waitUntil(() => _converse.disco_entities);
                entities = _converse.disco_entities;
                expect(entities.length).toBe(2); // We have an extra entity, which is the user's JID
                expect(entities.get(_converse.domain).items.length).toBe(3);
                expect(_.includes(entities.get(_converse.domain).items.pluck('jid'), 'people.shakespeare.lit')).toBeTruthy();
                expect(_.includes(entities.get(_converse.domain).items.pluck('jid'), 'plays.shakespeare.lit')).toBeTruthy();
                expect(_.includes(entities.get(_converse.domain).items.pluck('jid'), 'words.shakespeare.lit')).toBeTruthy();
                expect(entities.get(_converse.domain).identities.where({'category': 'conference'}).length).toBe(1);
                expect(entities.get(_converse.domain).identities.where({'category': 'directory'}).length).toBe(1);
                done();
            }));
        });

        describe("Whenever converse.js discovers a new server feature", function () {
           it("emits the serviceDiscovered event",
                mock.initConverse(
                    ['discoInitialized'], {},
                    function (done, _converse) {

                sinon.spy(_converse.api, "trigger");
                _converse.disco_entities.get(_converse.domain).features.create({'var': Strophe.NS.MAM});
                expect(_converse.api.trigger.called).toBe(true);
                expect(_converse.api.trigger.args[0][0]).toBe('serviceDiscovered');
                expect(_converse.api.trigger.args[0][1].get('var')).toBe(Strophe.NS.MAM);
                done();
            }));
        });
    });
}));