src/example/benchmark.html

<!--
Copyright 2013, Google Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
    * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->

<html>
<head>
<title>WebSocket benchmark</title>
<script src="util.js"></script>
<script>
// Namespace for holding globals.
var benchmark = {};

var sockets = [];
var numEstablishedSockets = 0;

var addressBox = null;

var timerID = null;

benchmark.startTimeInMs = 0;

var totalSize = 0;
var totalReplied = 0;

function destroySocket(socket) {
  socket.onopen = function() {};
  socket.onmessage = function() {};
  socket.onerror = function() {};
  socket.onclose = function() {};
  socket.close();
}

function destroyAllSockets() {
  for (var i = 0; i < sockets.length; ++i) {
    destroySocket(sockets[i]);
  }
  sockets = [];
}

function sendBenchmarkStep(size, multiplierIndex, config) {
  if (size > config.stopThreshold) {
    addToLog('Finished');
    destroyAllSockets();
    return;
  }

  var onMessageHandler = function(event) {
    if (!verifyAcknowledgement(event.data, size)) {
      destroyAllSockets();
      return;
    }

    totalReplied += size;

    if (totalReplied < totalSize) {
      return;
    }

    calculateAndLogResult(
        size, benchmark.startTimeInMs, totalSize, config.printSize);

    timerID = setTimeout(
        sendBenchmarkStep,
        0,
        size * config.multipliers[multiplierIndex],
        (multiplierIndex + 1) % config.multipliers.length,
        config);
  };

  for (var i = 0; i < sockets.length; ++i) {
    var socket = sockets[i];
    socket.onmessage = onMessageHandler;
  }

  benchmark.startTimeInMs = getTimeStamp();

  totalReplied = 0;

  totalSize = 0;

  var socketIndex = 0;
  while (totalSize < config.minTotal) {
    var buffer = new ArrayBuffer(size);

    fillArrayBuffer(buffer, 0x61);

    var command = ['send'];
    command.push(config.verifyData ? '1' : '0');
    sockets[socketIndex].send(command.join(' '));
    sockets[socketIndex].send(buffer);
    socketIndex = (socketIndex + 1) % sockets.length;

    totalSize += size;
  }
}

function receiveBenchmarkStep(size, multiplierIndex, config) {
  if (size > config.stopThreshold) {
    addToLog('Finished');
    destroyAllSockets();
    return;
  }

  var onMessageHandler = function(event) {
    var bytesReceived = event.data.byteLength;
    if (bytesReceived != size) {
      addToLog('Expected ' + size + 'B but received ' + bytesReceived + 'B');
      destroyAllSockets();
      return;
    }

    if (config.verifyData && !verifyArrayBuffer(event.data, 0x61)) {
      addToLog('Response verification failed');
      destroyAllSockets();
      return;
    }

    totalReplied += bytesReceived;

    if (totalReplied < totalSize) {
      return;
    }

    calculateAndLogResult(
        size, benchmark.startTimeInMs, totalSize, config.printSize);

    timerID = setTimeout(
        receiveBenchmarkStep,
        0,
        size * config.multipliers[multiplierIndex],
        (multiplierIndex + 1) % config.multipliers.length,
        config);
  };

  for (var i = 0; i < sockets.length; ++i) {
    var socket = sockets[i];
    socket.binaryType = 'arraybuffer';
    socket.onmessage = onMessageHandler;
  }

  benchmark.startTimeInMs = getTimeStamp();

  totalReplied = 0;

  totalSize = 0;

  var socketIndex = 0;
  while (totalSize < config.minTotal) {
    sockets[socketIndex].send('receive ' + size);
    socketIndex = (socketIndex + 1) % sockets.length;

    totalSize += size;
  }
}

function createSocket() {
  // TODO(tyoshino): Add TCP warm up.

  if (!('WebSocket' in window)) {
    return;
  }

  var url = addressBox.value;

  addToLog('Connect ' + url);

  var socket = new WebSocket(url);
  socket.onmessage = function(event) {
    addToLog('Unexpected message received. Aborting.');
  };
  socket.onerror = function() {
    addToLog('Error');
  };
  socket.onclose = function(event) {
    addToLog('Closed');
  };
  return socket;
}

function startBenchmark(runner, numSockets) {
  clearTimeout(timerID);
  destroyAllSockets();

  numEstablishedSockets = 0;

  for (var i = 0; i < numSockets; ++i) {
    var socket = createSocket();
    socket.onopen = function() {
      addToLog('Opened');

      ++numEstablishedSockets;

      if (numEstablishedSockets == sockets.length) {
        setTimeout(runner, 0);
      }
    };
    sockets.push(socket);
  }
}

function buildLegendString(config) {
  var legend = ''
  if (config.printSize)
    legend = 'Message size in KiB, Time/message in ms, ';
  legend += 'Speed in kB/s';
  return legend;
}

function getBoolFromCheckBox(id) {
  return document.getElementById(id).checked;
}

function getIntFromInput(id) {
  return parseInt(document.getElementById(id).value);
}

function getIntArrayFromInput(id) {
  var strArray = document.getElementById(id).value.split(',');
  return strArray.map(function(str) { return parseInt(str, 10); });
}

function getConfig() {
  return {
    printSize: getBoolFromCheckBox('printsize'),
    numSockets: getIntFromInput('numsockets'),
    // Initial size of messages.
    startSize: getIntFromInput('startsize'),
    // Stops benchmark when the size of message exceeds this threshold.
    stopThreshold: getIntFromInput('stopthreshold'),
    // If the size of each message is small, send/receive multiple messages
    // until the sum of sizes reaches this threshold.
    minTotal: getIntFromInput('mintotal'),
    multipliers: getIntArrayFromInput('multipliers'),
    verifyData: getBoolFromCheckBox('verifydata')
  };
}

function sendBenchmark() {
  var config = getConfig();

  addToLog('Send benchmark');
  addToLog(buildLegendString(config));

  var runner = sendBenchmarkStep.bind(
      null,
      config.startSize,
      0,
      config);

  startBenchmark(runner, config.numSockets);
}

function receiveBenchmark() {
  var config = getConfig();

  addToLog('Receive benchmark');
  addToLog(buildLegendString(config));

  var runner = receiveBenchmarkStep.bind(
      null,
      config.startSize,
      0,
      config);

  startBenchmark(runner, config.numSockets);
}

function stop() {
  addToLog('Stopped');
  destroyAllSockets();
}

function init() {
  addressBox = document.getElementById('address');
  logBox = document.getElementById('log');

  var scheme = window.location.protocol == 'https:' ? 'wss://' : 'ws://';
  var defaultAddress = scheme + window.location.host + '/benchmark_helper';

  addressBox.value = defaultAddress;

  addToLog(window.navigator.userAgent.toLowerCase());

  if (!('WebSocket' in window)) {
    addToLog('WebSocket is not available');
  }
}
</script>
</head>
<body onload="init()">

<div id="benchmark_div">
  url <input type="text" id="address" size="40">
  <input type="button" value="send" onclick="sendBenchmark()">
  <input type="button" value="receive" onclick="receiveBenchmark()">
  <input type="button" value="stop" onclick="stop()">

  <br/>

  <input type="checkbox" id="printsize" checked>
  <label for="printsize">Print size and time per message</label>
  <input type="checkbox" id="verifydata" checked>
  <label for="verifydata">Verify data</label>

  <br/>

  Parameters:

  <br/>

  <table>
    <tr>
      <td>Num sockets</td>
      <td><input type="text" id="numsockets" value="1"></td>
    </tr>
    <tr>
      <td>Start size</td>
      <td><input type="text" id="startsize" value="10240"></td>
    </tr>
    <tr>
      <td>Stop threshold</td>
      <td><input type="text" id="stopthreshold" value="102400000"></td>
    </tr>
    <tr>
      <td>Minimum total</td>
      <td><input type="text" id="mintotal" value="102400000"></td>
    </tr>
    <tr>
      <td>Multipliers</td>
      <td><input type="text" id="multipliers" value="5, 2"></td>
    </tr>
  </table>
</div>

<div id="log_div">
  <textarea
      id="log" rows="20" style="width: 100%" readonly></textarea>
</div>

Note: Effect of RTT and time spent for ArrayBuffer creation are not eliminated.

</body>
</html>