Updated _trackMessageSize based on latest upstream version (#12468)

Change-Id: Ie7db27a026d52befe027ed2abb96e62947f8116d

3 files changed, 199 insertions, 25 deletions

diff --git a/WebContent/VAADIN/jquery.atmosphere.js b/WebContent/VAADIN/jquery.atmosphere.js
index b6f86d428a..520e63d7cb 100644
--- a/WebContent/VAADIN/jquery.atmosphere.js
+++ b/WebContent/VAADIN/jquery.atmosphere.js
@@ -1199,6 +1199,9 @@ jQuery.atmosphere = function() {
              * @param response
              */
             function _trackMessageSize(message, request, response) {
+                if (message.length === 0)
+                    return true;
+
                 if (request.trackMessageLength) {
 
                     // If we have found partial message, prepend them.
@@ -1207,36 +1210,29 @@ jQuery.atmosphere = function() {
                     }
 
                     var messages = [];
-                    var messageLength = 0;
                     var messageStart = message.indexOf(request.messageDelimiter);
-                    while (messageStart != -1) {
-                        messageLength = jQuery.trim(message.substring(messageLength, messageStart));
-                        message = message.substring(messageStart + request.messageDelimiter.length, message.length);
-
-                        // Stop search if there is not enough characters remaining (wait for next part to arrive)
-                        if (message.length == 0 || message.length < messageLength) break;
-
-                        // Find start of a possibly existing subsequent message from the remaining data
-                        messageStart = message.substring(messageLength).indexOf(request.messageDelimiter);
-                        
-                        // Store the completely received message 
-                        messages.push(message.substring(0, messageLength));
-                    }
-
-                    if (messages.length == 0 || (message.length != 0 && messageLength != message.length)){
-                        if (messageStart == -1) {
-                            // http://dev.vaadin.com/ticket/12197
-                            // partialMessage must contain length header of next message
-                            // it starts at the end of the last message
-                            response.partialMessage = message.substring(messageLength);
+                    while (messageStart !== -1) {
+                        var str = jQuery.trim(message.substring(0, messageStart));
+                        var messageLength = parseInt(str, 10);
+                        if (isNaN(messageLength))
+                            throw 'message length "' + str + '" is not a number';
+                        messageStart += request.messageDelimiter.length;
+                        if (messageStart + messageLength > message.length) {
+                            // message not complete, so there is no trailing messageDelimiter
+                            messageStart = -1;
                         } else {
-                            response.partialMessage = messageLength + request.messageDelimiter + message ;
+                            // message complete, so add it
+                            messages.push(message.substring(messageStart, messageStart + messageLength));
+                            // remove consumed characters
+                            message = message.substring(messageStart + messageLength, message.length);
+                            messageStart = message.indexOf(request.messageDelimiter);
                         }
-                    } else {
-                        response.partialMessage = "";
                     }
 
-                    if (messages.length != 0) {
+                    /* keep any remaining data */
+                    response.partialMessage = message;
+
+                    if (messages.length !== 0) {
                         response.responseBody = messages.join(request.messageDelimiter);
                         response.messages = messages;
                         return false;
diff --git a/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.html b/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.html
new file mode 100644
index 0000000000..89dd7d4e78
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.html
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head profile="http://selenium-ide.openqa.org/profiles/test-case">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<link rel="selenium.base" href="http://192.168.2.162:8888/" />
+<title>New Test</title>
+</head>
+<body>
+<table cellpadding="1" cellspacing="1" border="1">
+<thead>
+<tr><td rowspan="1" colspan="3">New Test</td></tr>
+</thead><tbody>
+<tr>
+	<td>open</td>
+	<td>/run/com.vaadin.tests.push.TrackMessageSizeUnitTests?restartApplication</td>
+	<td></td>
+</tr>
+<tr>
+	<td>assertText</td>
+	<td>vaadin=runcomvaadintestspushTrackMessageSizeUnitTests::PID_SLog_row_0</td>
+	<td>1. All tests run</td>
+</tr>
+</tbody></table>
+</body>
+</html>
diff --git a/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.java b/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.java
new file mode 100644
index 0000000000..062698edf5
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/push/TrackMessageSizeUnitTests.java
@@ -0,0 +1,152 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.vaadin.tests.push;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+
+import javax.servlet.ServletContext;
+
+import org.apache.commons.io.IOUtils;
+import org.json.JSONArray;
+import org.json.JSONException;
+
+import com.vaadin.annotations.JavaScript;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.server.VaadinService;
+import com.vaadin.server.VaadinServletService;
+import com.vaadin.tests.components.AbstractTestUIWithLog;
+import com.vaadin.ui.JavaScriptFunction;
+
+// Load vaadinPush.js so that jQueryVaadin is defined 
+@JavaScript("vaadin://vaadinPush.js")
+public class TrackMessageSizeUnitTests extends AbstractTestUIWithLog {
+
+    private String testMethod = "function testSequence(expected, data) {\n"
+            + "    var request = {trackMessageLength: true, messageDelimiter: '|'};\n"
+            + "    var response = {partialMessage: ''};\n"
+            + "    var messages = [];\n"
+            + "    for(var i = 0; i < data.length; i++) {\n"
+            + "        if (!_trackMessageSize(data[i], request, response))\n"
+            + "            messages = messages.concat(response.messages);\n"
+            + "    }\n"
+            + "    if (JSON.stringify(expected) != JSON.stringify(messages)) {\n"
+            + "        if (console && typeof console.error == 'function') console.error('Expected', expected, 'but got', messages, 'for', data);\n"
+            + "        logToServer('Test failed, see javascript console for details.');\n"
+            + "    }" + "}\n";
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        String methodImplementation = findMethodImplementation();
+        getPage().getJavaScript().addFunction("logToServer",
+                new JavaScriptFunction() {
+                    @Override
+                    public void call(JSONArray arguments) throws JSONException {
+                        String message = arguments.getString(0);
+                        log(message);
+                    }
+                });
+
+        getPage().getJavaScript().execute(
+                methodImplementation + testMethod + buildTestCase());
+    }
+
+    private String buildTestCase() {
+        // Could maybe express the cases in java and generate JS?
+        return "testSequence(['a', 'b'], ['1|a1|b', '']);\n"
+                + "testSequence(['a', 'b'], ['1|a1|', 'b']);\n"
+                + "testSequence(['a', 'b'], ['1|a1', '|b']);\n"
+                + "testSequence(['a', 'b'], ['1|a', '1|b']);\n"
+                + "testSequence(['a', 'b'], ['1|a', '', '1|b']);\n"
+                + "testSequence(['a|', '|b'], ['2|a|2||b']);\n"
+                + "testSequence(['a|', 'b'], ['2|a|', '', '1|b']);\n"
+                + "testSequence(['a|', 'b'], ['2|a|', '1|b']);\n"
+                + "testSequence(['a|', 'b'], ['2|a|1', '|b']);\n"
+                + "testSequence(['a|', 'b'], ['2|a|1|', 'b']);\n"
+                + "testSequence([' ', 'b'], ['1| 1|b']);\n"
+                + "testSequence([' ', 'b'], ['1| ','1|b']);\n"
+                + "testSequence([' ', 'b'], ['1|',' 1|b']);\n"
+                + "logToServer('All tests run')\n";
+    }
+
+    private String findMethodImplementation() {
+        String filename = "/VAADIN/jquery.atmosphere.js";
+        URL resourceURL = findResourceURL(filename,
+                (VaadinServletService) VaadinService.getCurrent());
+        if (resourceURL == null) {
+            log("Can't find " + filename);
+            return null;
+        }
+
+        try {
+            String string = IOUtils.toString(resourceURL);
+
+            // Find the function inside the script content
+            int startIndex = string.indexOf("function _trackMessageSize");
+            if (startIndex == -1) {
+                log("function not found");
+                return null;
+            }
+
+            // Assumes there's a /** comment before the next function
+            int endIndex = string.indexOf("/**", startIndex);
+            if (endIndex == -1) {
+                log("End of function not found");
+                return null;
+            }
+
+            string = string.substring(startIndex, endIndex);
+            string = string.replaceAll("jQuery", "jQueryVaadin");
+            return string;
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    private URL findResourceURL(String filename, VaadinServletService service) {
+        ServletContext sc = service.getServlet().getServletContext();
+        URL resourceUrl;
+        try {
+            resourceUrl = sc.getResource(filename);
+        } catch (MalformedURLException e) {
+            throw new RuntimeException(e);
+        }
+        if (resourceUrl == null) {
+            // try if requested file is found from classloader
+
+            // strip leading "/" otherwise stream from JAR wont work
+            if (filename.startsWith("/")) {
+                filename = filename.substring(1);
+            }
+
+            resourceUrl = service.getClassLoader().getResource(filename);
+        }
+        return resourceUrl;
+    }
+
+    @Override
+    protected String getTestDescription() {
+        return "Unit tests for _trackMessageSize in jquery.atmosphere.js. Implemented with testbench and a full Vaadin server side since the testing requires some file mangling.";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return Integer.valueOf(12468);
+    }
+
+}