signal-desktop/libtextsecure/test/websocket-resources_test.js

/* vim: ts=4:sw=4
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

;(function() {
    'use strict';

    describe('WebSocket-Resource', function() {
        describe('requests and responses', function () {
            it('receives requests and sends responses', function(done) {
                // mock socket
                var request_id = '1';
                var socket = {
                    send: function(data) {
                        var message = textsecure.protobuf.WebSocketMessage.decode(data);
                        assert.strictEqual(message.type, textsecure.protobuf.WebSocketMessage.Type.RESPONSE);
                        assert.strictEqual(message.response.message, 'OK');
                        assert.strictEqual(message.response.status, 200);
                        assert.strictEqual(message.response.id.toString(), request_id);
                        done();
                    }
                };

                // actual test
                var resource = new WebSocketResource(socket, {
                    handleRequest: function (request) {
                        assert.strictEqual(request.verb, 'PUT');
                        assert.strictEqual(request.path, '/some/path');
                        assertEqualArrayBuffers(request.body.toArrayBuffer(), new Uint8Array([1,2,3]).buffer);
                        request.respond(200, 'OK');
                    }
                });

                // mock socket request
                socket.onmessage({
                    data: new Blob([
                        new textsecure.protobuf.WebSocketMessage({
                            type: textsecure.protobuf.WebSocketMessage.Type.REQUEST,
                            request: {
                                id: request_id,
                                verb: 'PUT',
                                path: '/some/path',
                                body: new Uint8Array([1,2,3]).buffer
                            }
                        }).encode().toArrayBuffer()
                    ])
                });
            });

            it('sends requests and receives responses', function(done) {
                // mock socket and request handler
                var request_id;
                var socket = {
                    send: function(data) {
                        var message = textsecure.protobuf.WebSocketMessage.decode(data);
                        assert.strictEqual(message.type, textsecure.protobuf.WebSocketMessage.Type.REQUEST);
                        assert.strictEqual(message.request.verb, 'PUT');
                        assert.strictEqual(message.request.path, '/some/path');
                        assertEqualArrayBuffers(message.request.body.toArrayBuffer(), new Uint8Array([1,2,3]).buffer);
                        request_id = message.request.id;
                    }
                };

                // actual test
                var resource = new WebSocketResource(socket);
                resource.sendRequest({
                    verb: 'PUT',
                    path: '/some/path',
                    body: new Uint8Array([1,2,3]).buffer,
                    error: done,
                    success: function(message, status, request) {
                        assert.strictEqual(message, 'OK');
                        assert.strictEqual(status, 200);
                        done();
                    }
                });

                // mock socket response
                socket.onmessage({
                    data: new Blob([
                        new textsecure.protobuf.WebSocketMessage({
                            type: textsecure.protobuf.WebSocketMessage.Type.RESPONSE,
                            response: { id: request_id, message: 'OK', status: 200 }
                        }).encode().toArrayBuffer()
                    ])
                });
            });
        });

        describe('close', function() {
            before(function() { window.WebSocket = MockSocket; });
            after (function() { window.WebSocket = WebSocket;  });
            it('closes the connection', function(done) {
                var mockServer = new MockServer('ws://localhost:8081');
                mockServer.on('connection', function(server) {
                    server.on('close', done);
                });
                var resource = new WebSocketResource(new WebSocket('ws://localhost:8081'));
                resource.close();
            });
        });

        describe('with a keepalive config', function() {
            before(function() { window.WebSocket = MockSocket; });
            after (function() { window.WebSocket = WebSocket;  });
            this.timeout(60000);
            it('sends keepalives once a minute', function(done) {
                var mockServer = new MockServer('ws://localhost:8081');
                mockServer.on('connection', function(server) {
                    server.on('message', function(data) {
                        var message = textsecure.protobuf.WebSocketMessage.decode(data);
                        assert.strictEqual(message.type, textsecure.protobuf.WebSocketMessage.Type.REQUEST);
                        assert.strictEqual(message.request.verb, 'GET');
                        assert.strictEqual(message.request.path, '/v1/keepalive');
                        server.close();
                        done();
                    });
                });
                new WebSocketResource(new WebSocket('ws://localhost:8081'), {
                    keepalive: { path: '/v1/keepalive' }
                });
            });

            it('uses / as a default path', function(done) {
                var mockServer = new MockServer('ws://localhost:8081');
                mockServer.on('connection', function(server) {
                    server.on('message', function(data) {
                        var message = textsecure.protobuf.WebSocketMessage.decode(data);
                        assert.strictEqual(message.type, textsecure.protobuf.WebSocketMessage.Type.REQUEST);
                        assert.strictEqual(message.request.verb, 'GET');
                        assert.strictEqual(message.request.path, '/');
                        server.close();
                        done();
                    });
                });
                new WebSocketResource(new WebSocket('ws://localhost:8081'), {
                    keepalive: true
                });

            });

            it('optionally disconnects if no response', function(done) {
                this.timeout(65000);
                var mockServer = new MockServer('ws://localhost:8081');
                var socket = new WebSocket('ws://localhost:8081');
                mockServer.on('connection', function(server) {
                    server.on('close', done);
                });
                new WebSocketResource(socket, { keepalive: true });
            });

            it('allows resetting the keepalive timer', function(done) {
                this.timeout(65000);
                var mockServer = new MockServer('ws://localhost:8081');
                var socket = new WebSocket('ws://localhost:8081');
                var startTime = Date.now();
                mockServer.on('connection', function(server) {
                    server.on('message', function(data) {
                        var message = textsecure.protobuf.WebSocketMessage.decode(data);
                        assert.strictEqual(message.type, textsecure.protobuf.WebSocketMessage.Type.REQUEST);
                        assert.strictEqual(message.request.verb, 'GET');
                        assert.strictEqual(message.request.path, '/');
                        assert(Date.now() > startTime + 60000, 'keepalive time should be longer than a minute');
                        server.close();
                        done();
                    });
                });
                var resource = new WebSocketResource(socket, { keepalive: true });
                setTimeout(function() {
                    resource.resetKeepAliveTimer()
                }, 5000);
            });
        });
    });
}());