web-socket-proxy-test.js

/*
  node-http-proxy-test.js: http proxy for node.js

  Copyright (c) 2010 Charlie Robbins, Marak Squires and Fedor Indutny

  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

*/

var util = require('util'),
    assert = require('assert'),
    argv = require('optimist').argv,
    colors = require('colors'),
    request = require('request'),
    vows = require('vows'),
    websocket = require('./../vendor/websocket'),
    helpers = require('./helpers');

try {
  var utils = require('socket.io/lib/socket.io/utils'),
      io = require('socket.io');
}
catch (ex) {
  console.error('Socket.io is required for this example:');
  console.error('npm ' + 'install'.green + ' socket.io@0.6.18'.magenta);
  process.exit(1);
}

var protocol = argv.https ? 'https' : 'http',
    wsprotocol = argv.https ? 'wss' : 'ws',
    runner = new helpers.TestRunner(protocol);

vows.describe('node-http-proxy/websocket/' + wsprotocol).addBatch({
  "When using server created by httpProxy.createServer()": {
    "with no latency" : {
      "when an inbound message is sent from a WebSocket client": {
        topic: function () {
          var that = this
              headers = {};

          runner.webSocketTest({
            io: io,
            host: 'localhost',
            wsprotocol: wsprotocol,
            protocol: protocol,
            ports: {
              target: 8130,
              proxy: 8131
            },
            onListen: function (socket) {
              socket.on('connection', function (client) {
                client.on('message', function (msg) {
                  that.callback(null, msg, headers);
                });
              });
            },
            onWsupgrade: function (req, res) {
              headers.request = req;
              headers.response = res.headers;
            },
            onOpen: function (ws) {
              ws.send(utils.encode('from client'));
            }
          });
        },
        "the target server should receive the message": function (err, msg, headers) {
          assert.equal(msg, 'from client');
        },
        "the origin and sec-websocket-origin headers should match": function (err, msg, headers) {
          assert.isString(headers.response['sec-websocket-location']);
          assert.isTrue(headers.response['sec-websocket-location'].indexOf(wsprotocol) !== -1);
          assert.equal(headers.request.Origin, headers.response['sec-websocket-origin']);
        }
      },
      "when an inbound message is sent from a WebSocket client with event listeners": {
        topic: function () {
          var that = this
              headers = {};

          runner.webSocketTest({
            io: io,
            host: 'localhost',
            wsprotocol: wsprotocol,
            protocol: protocol,
            ports: {
              target: 8132,
              proxy: 8133
            },
            onServer: function (server) {
              server.proxy.on('websocket:incoming', function (req, socket, head, data) {
                that.callback(null, data);
              });
            },
            onOpen: function (ws) {
              ws.send(utils.encode('from client'));
            }
          });
        },
        "should raise the `websocket:incoming` event": function (ign, data) {
          assert.equal(utils.decode(data.toString().replace('\u0000', '')), 'from client');
        },
      },
      "when an outbound message is sent from the target server": {
        topic: function () {
          var that = this,
              headers = {};

          runner.webSocketTest({
            io: io,
            host: 'localhost',
            wsprotocol: wsprotocol,
            protocol: protocol,
            ports: {
              target: 8134,
              proxy: 8135
            },
            onListen: function (socket) {
              socket.on('connection', function (client) {
                socket.broadcast('from server');
              });
            },
            onWsupgrade: function (req, res) {
              headers.request = req;
              headers.response = res.headers;
            },
            onMessage: function (msg) {
              msg = utils.decode(msg);
              if (!/\d+/.test(msg)) {
                that.callback(null, msg, headers);
              }
            }
          });
        },
        "the client should receive the message": function (err, msg, headers) {
          assert.equal(msg, 'from server');
        },
        "the origin and sec-websocket-origin headers should match": function (err, msg, headers) {
          assert.isString(headers.response['sec-websocket-location']);
          assert.isTrue(headers.response['sec-websocket-location'].indexOf(wsprotocol) !== -1);
          assert.equal(headers.request.Origin, headers.response['sec-websocket-origin']);
        }
      }
    }
  }
}).addBatch({
  "When the tests are over": {
    topic: function () {
      return runner.closeServers();
    },
    "the servers should clean up": function () {
      assert.isTrue(true);
    }
  }
}).export(module);