From 70cef27dbec365bd7e226842178d54151b862aa4 Mon Sep 17 00:00:00 2001
From: Joel Martin <github@martintribe.org>
Date: Wed, 19 Jan 2011 15:25:44 -0600
Subject: [PATCH] Add latency test and browser latency test results.

---
 docs/latency_results.txt |  84 +++++++++++
 tests/echo.py            |   2 +-
 tests/latency.html       | 295 +++++++++++++++++++++++++++++++++++++++
 tests/latency.py         |   1 +
 tests/load.html          |   2 +-
 websocket.py             |   3 +-
 6 files changed, 384 insertions(+), 3 deletions(-)
 create mode 100644 docs/latency_results.txt
 create mode 100644 tests/latency.html
 create mode 120000 tests/latency.py

diff --git a/docs/latency_results.txt b/docs/latency_results.txt
new file mode 100644
index 0000000..d39d505
--- /dev/null
+++ b/docs/latency_results.txt
@@ -0,0 +1,84 @@
+Old web-socket-js (9e7663771), 2000 byte payload, 10ms delay
+
+Chrome 8.0.552 - native WebSockets
+    Packets sent:                     2998
+    Packets Received:                 2998
+    Average Latency:                  1.84
+    40 Frame Running Average Latency: 1.90
+    Minimum Latency:                  1.00
+    Maximum Latency:                  10.00
+
+firefox 4.0b9 - WebSockets enabled
+    Packets sent:                     3011
+    Packets Received:                 3011
+    Average Latency:                  6.45
+    40 Frame Running Average Latency: 6.08
+    Minimum Latency:                  5.00
+    Maximum Latency:                  119.00
+
+---
+
+firefox 4.0b9 - no WebSockets
+    Packets sent:                     3024
+    Packets Received:                 3020
+    Average Latency:                  80.59
+    40 Frame Running Average Latency: 60.15
+    Minimum Latency:                  10.00
+    Maximm Latency:                   348.00
+
+
+firefox 3.6.10 - no WebSockets
+    Packets sent:                     2777
+    Packets Received:                 2775
+    Average Latency:                  34.89
+    40 Frame Running Average Latency: 24.50
+    Minimum Latency:                  10.00
+    Maximum Latency:                  208.00
+
+
+Opera 11 - no Websockets
+    Packets sent:                     3012
+    Packets Received:                 3011
+    Average Latency:                  380.87
+    40 Frame Running Average Latency: 341.90
+    Minimum Latency:                  28.00
+    Maximum Latency:                  2175.00
+
+    - average starts at around 290ms
+    - time for each 1000 packets: 23s, 38s, 65s
+
+------------------------------------------------------------
+
+New web-socket-js (9e7663771), 2000 byte payload, 10ms delay
+
+firefox 4.0b9 - no WebSockets
+    Packets sent:                     3088
+    Packets Received:                 3087
+    Average Latency:                  16.71
+    40 Frame Running Average Latency: 16.80
+    Minimum Latency:                  7.00
+    Maximum Latency:                  75.00
+
+    - First 1000 sent in 13 seconds 
+    - Second 1000 sent in 12 seconds
+    - Third 1000 sent in 12 seconds
+
+firefox 3.6.10 - no WebSockets
+    Packets sent:                     3100
+    Packets Received:                 3099
+    Average Latency:                  17.32
+    40 Frame Running Average Latency: 16.73
+    Minimum Latency:                  6.00
+    Maximum Latency:                  72.00
+
+Opera 11 - no WebSockets
+    Packets sent:                     3007
+    Packets Received:                 3007
+    Average Latency:                  465.91
+    40 Frame Running Average Latency: 147.95
+    Minimum Latency:                  12.00
+    Maximum Latency:                  9143.00
+
+    - average starts at around 28ms
+    - time for each 500 packets: 13s, 16s, 25s, 37s, 50s, 72s
+    - also start seeing sent, receive lags around 1200 packets
diff --git a/tests/echo.py b/tests/echo.py
index 3787f3c..fce121f 100755
--- a/tests/echo.py
+++ b/tests/echo.py
@@ -84,7 +84,7 @@ if __name__ == '__main__':
 
     server = WebSocketEcho(
             listen_port=listen_port,
-            verbose=True,
+            #verbose=True,
             cert='self.pem',
             web='.')
     server.start_server()
diff --git a/tests/latency.html b/tests/latency.html
new file mode 100644
index 0000000..aedecf5
--- /dev/null
+++ b/tests/latency.html
@@ -0,0 +1,295 @@
+<html>
+
+    <head>
+        <title>WebSockets Latency Test</title>
+        <script src="include/base64.js"></script>
+        <script src="include/util.js"></script>
+        <script src="include/webutil.js"></script> 
+        <!-- Uncomment to activate firebug lite -->
+        <!--
+        <script type='text/javascript' 
+            src='http://getfirebug.com/releases/lite/1.2/firebug-lite-compressed.js'></script>
+        -->
+
+
+    </head>
+
+    <body>
+
+        Host: <input id='host' style='width:100'>&nbsp;
+        Port: <input id='port' style='width:50'>&nbsp;
+        Encrypt: <input id='encrypt' type='checkbox'>
+        <br>
+        Payload Size: <input id='payload_size' style='width:50'>&nbsp;
+        Send Delay (ms): <input id='sendDelay' style='width:50' value="10">&nbsp;
+        <input id='connectButton' type='button' value='Start' style='width:100px'
+            onclick="connect();">&nbsp;
+
+        <br><br>
+        <table border=1>
+            <tr>
+                <th align="right">Packets sent:</th>
+                <td align="right"><div id='sent'></div></td>
+            </tr><tr>
+                <th align="right">Packets Received:</th>
+                <td align="right"><div id='received'></div></td>
+            </tr><tr>
+                <th align="right">Average Latency:</th>
+                <td align="right"><div id='laverage'></div></td>
+            </tr><tr>
+                <th align="right">40 Frame Running Average Latency:</th>
+                <td align="right"><div id='lrunning'></div></td>
+            </tr><tr>
+                <th align="right">Minimum Latency:</th>
+                <td align="right"><div id='lmin'></div></td>
+            </tr><tr>
+                <th align="right">Maximum Latency:</th>
+                <td align="right"><div id='lmax'></div></td>
+            </tr>
+        </table>
+
+        <br>
+        Messages:<br>
+        <textarea id="messages" style="font-size: 9;" cols=80 rows=10></textarea>
+    </body>
+
+
+    <script>
+
+        var host = null, port = null, sendDelay = 0,
+            ws = null, send_ref = null,
+            sent, received, latencies, ltotal, laverage, lrunning, lmin, lmax,
+            run_length = 40,
+            payload_size = 2000, payload,
+            msg_cnt = 0, recv_seq = 0, send_seq = 0;
+
+        Array.prototype.pushStr = function (str) {
+            var n = str.length;
+            for (var i=0; i < n; i++) {
+                this.push(str.charCodeAt(i));
+            }
+        }
+
+
+        function message(str) {
+            console.log(str);
+            cell = $D('messages');
+            msg_cnt++;
+            cell.innerHTML += msg_cnt + ": " + str + "\n";
+            cell.scrollTop = cell.scrollHeight;
+        }
+
+
+        function add (x,y) {
+            return parseInt(x,10)+parseInt(y,10); }
+
+        function recvMsg(data) {
+            //console.log(">> check_respond");
+            var i, now, decoded, first, last, arr, latency;
+
+            now = (new Date()).getTime(); // Early as possible
+
+            decoded = Base64.decode(data);
+            first = String.fromCharCode(decoded.shift());
+            last = String.fromCharCode(decoded.pop());
+
+            if (first != "^") {
+                message("Error: packet missing start char '^'");
+                disconnect();
+                return;
+            }
+            if (last != "$") {
+                message("Error: packet missing end char '$'");
+                disconnect();
+                return;
+            }
+            arr = decoded.map(function(num) {
+                    return String.fromCharCode(num); 
+                } ).join('').split(':');
+            seq       = arr[0];
+            timestamp = parseInt(arr[1],10);
+            rpayload  = arr[2];
+
+            if (seq != recv_seq) {
+                message("Error: expected seq " + recv_seq + " but got " + seq);
+                disconnect();
+                return;
+            }
+            recv_seq++;
+            if (payload !== rpayload) {
+                message("Payload corrupt");
+                disconnect();
+                return;
+            }
+
+            received++;
+
+            latency = now - timestamp;
+            latencies.push(latency);
+            if (latencies.length > run_length) {
+                latencies.shift();
+            }
+            ltotal   += latency;
+            laverage  = ltotal / received;
+            lrunning  = 0;
+            for (var i=0; i < latencies.length; i++) {
+                lrunning += latencies[i];
+            }
+            lrunning  = lrunning / latencies.length;
+
+            if (latency < lmin) {
+                lmin  = latency;
+            }
+            if (latency > lmax) {
+                lmax  = latency;
+            }
+
+            showStats();
+            //console.log("<< check_respond");
+        }
+
+        function sendMsg() {
+            var arr = [];
+            if (ws.bufferedAmount > 0) {
+                console.log("Delaying send");
+                return;
+            }
+
+            timestamp = (new Date()).getTime();
+            arr.pushStr("^" + send_seq + ":" + timestamp + ":" + payload + "$")
+            send_seq ++;
+            ws.send(Base64.encode(arr));
+            sent++;
+
+            showStats();
+        }
+
+        function showStats() {
+            $D('sent').innerHTML     = sent;
+            $D('received').innerHTML = received;
+            $D('laverage').innerHTML = laverage.toFixed(2);
+            $D('lrunning').innerHTML = lrunning.toFixed(2);
+            $D('lmin').innerHTML     = lmin.toFixed(2);
+            $D('lmax').innerHTML     = lmax.toFixed(2);
+        }
+
+        function init_ws() {
+            console.log(">> init_ws");
+            var scheme = "ws://";
+            if ($D('encrypt').checked) {
+                scheme = "wss://";
+            }
+            var uri = scheme + host + ":" + port;
+            console.log("connecting to " + uri);
+            ws = new WebSocket(uri);
+
+            ws.onmessage = function(e) {
+                //console.log(">> WebSockets.onmessage");
+                recvMsg(e.data);
+                //console.log("<< WebSockets.onmessage");
+            };
+            ws.onopen = function(e) {
+                console.log(">> WebSockets.onopen");
+                send_ref = setInterval(sendMsg, sendDelay);
+                console.log("<< WebSockets.onopen");
+            };
+            ws.onclose = function(e) {
+                console.log(">> WebSockets.onclose");
+                clearInterval(send_ref);
+                console.log("<< WebSockets.onclose");
+            };
+            ws.onerror = function(e) {
+                console.log(">> WebSockets.onerror");
+                console.log("   " + e);
+                console.log("<< WebSockets.onerror");
+            };
+
+            console.log("<< init_ws");
+        }
+
+        function connect() {
+            console.log(">> connect");
+            host = $D('host').value;
+            port = $D('port').value;
+            payload_size = parseInt($D('payload_size').value, 10);
+            sendDelay = parseInt($D('sendDelay').value, 10);
+
+            if ((!host) || (!port)) {
+                console.log("must set host and port");
+                return;
+            }
+
+            if (ws) {
+                ws.close();
+            }
+            init_ws();
+
+            // Populate payload data
+            var numlist = []
+            for (var i=0; i < payload_size; i++) {
+                numlist.push( Math.floor(Math.random()*10) );
+            }
+            payload = numlist.join('');
+
+            // Initialize stats
+            sent      = 0;
+            received  = 0;
+            latencies = [];
+            ltotal    = 0;
+            laverage  = 0;
+            lrunning  = 0;
+            lmin      = 999999999;
+            lmax      = 0;
+
+            $D('connectButton').value = "Stop";
+            $D('connectButton').onclick = disconnect;
+            console.log("<< connect");
+        }
+
+        function disconnect() {
+            console.log(">> disconnect");
+            if (ws) {
+                ws.close();
+            }
+
+            clearInterval(send_ref);
+            send_ref = null;
+            showStats(); // Final numbers
+            recv_seq = 0;
+            send_seq = 0;
+
+            $D('connectButton').value = "Start";
+            $D('connectButton').onclick = connect;
+            console.log("<< disconnect");
+        }
+
+
+        /* If no builtin websockets then load web_socket.js */
+        if (window.WebSocket) {
+            VNC_native_ws = true;
+        } else {
+            VNC_native_ws = false;
+            message("Loading web-socket-js flash bridge");
+            var extra = "<script src='include/web-socket-js/swfobject.js'><\/script>";
+            extra += "<script src='include/web-socket-js/FABridge.js'><\/script>";
+            extra += "<script src='include/web-socket-js/web_socket.js'><\/script>";
+            document.write(extra);
+        }
+
+        window.onload = function() {
+            console.log("onload");
+            if (VNC_native_ws) {
+                message("Using native WebSockets");
+            } else {
+                message("initializing web-socket-js flash bridge");
+                WebSocket.__swfLocation = "include/web-socket-js/WebSocketMain.swf";
+                WebSocket.__initialize();
+            }
+            var url = document.location.href;
+            $D('host').value = (url.match(/host=([^&#]*)/) || ['',''])[1];
+            $D('port').value = (url.match(/port=([^&#]*)/) || ['',''])[1];
+            $D('payload_size').value = payload_size;
+        }
+    </script>
+
+</html>
diff --git a/tests/latency.py b/tests/latency.py
new file mode 120000
index 0000000..3ae4d96
--- /dev/null
+++ b/tests/latency.py
@@ -0,0 +1 @@
+echo.py
\ No newline at end of file
diff --git a/tests/load.html b/tests/load.html
index c56c4c7..b1e1b32 100644
--- a/tests/load.html
+++ b/tests/load.html
@@ -1,7 +1,7 @@
 <html>
 
     <head>
-        <title>WebSockets Test</title>
+        <title>WebSockets Load Test</title>
         <script src="include/base64.js"></script>
         <script src="include/util.js"></script>
         <script src="include/webutil.js"></script> 
diff --git a/websocket.py b/websocket.py
index 1ed21d2..aeb5063 100755
--- a/websocket.py
+++ b/websocket.py
@@ -312,7 +312,8 @@ Connection: Upgrade\r
 
     def poll(self):
         """ Run periodically while waiting for connections. """
-        self.msg("Running poll()")
+        #self.vmsg("Running poll()")
+        pass
 
     def do_SIGCHLD(self, sig, stack):
         self.vmsg("Got SIGCHLD, ignoring")