Allow customizing client-side push config on server side (#11867)

Change-Id: I212067aa0bd04e3e73844ef57963b5622291986a
author: Artur Signell <artur@vaadin.com> 2013-06-05 14:27:09 +0300
committer: Artur Signell <artur@vaadin.com> 2013-06-05 15:14:42 +0300
commit: edca4095d2e75d73f9d6a5acb2da9009129b4db2 (patch)
tree: 15226365a8501ba55255dc21111696709aafa632 /uitest/src/com/vaadin/tests/push
parent: ebd4a5c0ae6e61c20283ba5b866fe51e3576a179 (diff)
download: vaadin-framework-edca4095d2e75d73f9d6a5acb2da9009129b4db2.tar.gz
vaadin-framework-edca4095d2e75d73f9d6a5acb2da9009129b4db2.zip
4 files changed, 392 insertions, 5 deletions
diff --git a/uitest/src/com/vaadin/tests/push/PushConfiguration.html b/uitest/src/com/vaadin/tests/push/PushConfiguration.html
new file mode 100644
index 0000000000..c3786b1cc1
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/push/PushConfiguration.html
@@ -0,0 +1,130 @@
+<?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://localhost: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>
+<!--Websocket-->
+<tr>
+	<td>open</td>
+	<td>/run/com.vaadin.tests.push.PushConfigurationTest?debug&amp;restartApplication</td>
+	<td></td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[1]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=WEBSOCKET</td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=AUTOMATIC</td>
+</tr>
+<tr>
+	<td>assertText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[5]/VLabel[0]/domChild[0]</td>
+	<td>*fallbackTransport: streaming*transport: websocket*</td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>waitForText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<!--Use debug console to verify we used the correct transport type-->
+<tr>
+	<td>assertTextPresent</td>
+	<td>Push connection established using websocket</td>
+	<td></td>
+</tr>
+<tr>
+	<td>assertTextNotPresent</td>
+	<td>Push connection established using streaming</td>
+	<td>Push connection established using streaming</td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=DISABLED</td>
+</tr>
+<!--Streaming-->
+<tr>
+	<td>open</td>
+	<td>/run/com.vaadin.tests.push.PushConfigurationTest?debug&amp;restartApplication</td>
+	<td></td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[1]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=STREAMING</td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=AUTOMATIC</td>
+</tr>
+<tr>
+	<td>assertNotText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<tr>
+	<td>assertText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[5]/VLabel[0]/domChild[0]</td>
+	<td>*fallbackTransport: streaming*transport: streaming*</td>
+</tr>
+<tr>
+	<td>waitForText</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[5]/VLabel[0]</td>
+	<td>4</td>
+</tr>
+<!--Use debug console to verify we used the correct transport type-->
+<tr>
+	<td>assertTextNotPresent</td>
+	<td>Push connection established using websocket</td>
+	<td></td>
+</tr>
+<tr>
+	<td>assertTextPresent</td>
+	<td>Push connection established using streaming</td>
+	<td></td>
+</tr>
+<tr>
+	<td>select</td>
+	<td>vaadin=runcomvaadintestspushPushConfigurationTest::/VVerticalLayout[0]/Slot[1]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VVerticalLayout[0]/Slot[0]/VNativeSelect[0]/domChild[0]</td>
+	<td>label=DISABLED</td>
+</tr>
+</tbody></table>
+</body>
+</html>
diff --git a/uitest/src/com/vaadin/tests/push/PushConfigurationTest.java b/uitest/src/com/vaadin/tests/push/PushConfigurationTest.java
new file mode 100644
index 0000000000..b57e9732cc
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/push/PushConfigurationTest.java
@@ -0,0 +1,102 @@
+package com.vaadin.tests.push;
+
+import java.util.Date;
+import java.util.Timer;
+import java.util.TimerTask;
+
+import com.vaadin.data.util.ObjectProperty;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.shared.ui.label.ContentMode;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+import com.vaadin.ui.Label;
+
+public class PushConfigurationTest extends AbstractTestUI {
+
+    private ObjectProperty<Integer> counter = new ObjectProperty<Integer>(0);
+
+    private ObjectProperty<Integer> counter2 = new ObjectProperty<Integer>(0);
+
+    private final Timer timer = new Timer(true);
+
+    private final TimerTask task = new TimerTask() {
+
+        @Override
+        public void run() {
+            access(new Runnable() {
+                @Override
+                public void run() {
+                    counter2.setValue(counter2.getValue() + 1);
+                }
+            });
+        }
+    };
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        addComponent(new PushConfigurator(this));
+        spacer();
+
+        /*
+         * Client initiated push.
+         */
+        Label lbl = new Label(counter);
+        lbl.setCaption("Client counter (click 'increment' to update):");
+        addComponent(lbl);
+
+        addComponent(new Button("Increment", new Button.ClickListener() {
+
+            @Override
+            public void buttonClick(ClickEvent event) {
+                counter.setValue(counter.getValue() + 1);
+            }
+        }));
+
+        spacer();
+
+        /*
+         * Server initiated push.
+         */
+        lbl = new Label(counter2);
+        lbl.setCaption("Server counter (updates each 1s by server thread) :");
+        addComponent(lbl);
+
+        addComponent(new Button("Reset", new Button.ClickListener() {
+
+            @Override
+            public void buttonClick(ClickEvent event) {
+                counter2.setValue(0);
+            }
+        }));
+    }
+
+    @Override
+    protected String getTestDescription() {
+        return "This test tests the very basic operations of push. "
+                + "It tests that client initiated changes are "
+                + "recieved back to the client as well as server "
+                + "initiated changes are correctly updated to the client.";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return 11494;
+    }
+
+    private void spacer() {
+        addComponent(new Label("<hr/>", ContentMode.HTML));
+    }
+
+    @Override
+    public void attach() {
+        super.attach();
+        timer.scheduleAtFixedRate(task, new Date(), 1000);
+    }
+
+    @Override
+    public void detach() {
+        super.detach();
+        timer.cancel();
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/push/PushConfigurator.java b/uitest/src/com/vaadin/tests/push/PushConfigurator.java
new file mode 100644
index 0000000000..6528366b59
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/push/PushConfigurator.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.util.ArrayList;
+import java.util.Collections;
+
+import com.vaadin.data.Property.ValueChangeEvent;
+import com.vaadin.data.Property.ValueChangeListener;
+import com.vaadin.shared.communication.PushMode;
+import com.vaadin.shared.ui.label.ContentMode;
+import com.vaadin.shared.ui.ui.Transport;
+import com.vaadin.ui.Alignment;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+import com.vaadin.ui.Button.ClickListener;
+import com.vaadin.ui.HorizontalLayout;
+import com.vaadin.ui.Label;
+import com.vaadin.ui.NativeSelect;
+import com.vaadin.ui.PushConfiguration;
+import com.vaadin.ui.TextField;
+import com.vaadin.ui.UI;
+import com.vaadin.ui.VerticalLayout;
+
+/**
+ * 
+ * @since 7.1
+ * @author Vaadin Ltd
+ */
+public class PushConfigurator extends VerticalLayout {
+    private NativeSelect pushMode = new NativeSelect("Push mode");
+    private NativeSelect transport = new NativeSelect("Transport");
+    private NativeSelect fallbackTransport = new NativeSelect("Fallback");
+    private TextField parameter = new TextField("Parameter");
+    private TextField value = new TextField("Value");
+    private Button set = new Button("Set");
+    private HorizontalLayout paramValue = new HorizontalLayout();
+    private VerticalLayout vl = new VerticalLayout();
+    private UI ui;
+
+    private Label status = new Label("", ContentMode.PREFORMATTED);
+
+    public PushConfigurator(UI ui) {
+        this.ui = ui;
+        construct();
+        refreshStatus();
+    }
+
+    /**
+     * @since
+     */
+    private void refreshStatus() {
+        PushConfiguration pc = ui.getPushConfiguration();
+        String value = "";
+        ArrayList<String> names = new ArrayList<String>();
+        names.addAll(pc.getParameterNames());
+        Collections.sort(names);
+        for (String param : names) {
+            value += param + ": " + pc.getParameter(param) + "\n";
+        }
+        status.setValue(value);
+    }
+
+    /**
+     * @since
+     */
+    private void construct() {
+        pushMode.addItem(PushMode.DISABLED);
+        pushMode.addItem(PushMode.MANUAL);
+        pushMode.addItem(PushMode.AUTOMATIC);
+
+        for (Transport t : Transport.values()) {
+            transport.addItem(t.toString());
+            fallbackTransport.addItem(t.toString());
+        }
+        transport.addItem("");
+        fallbackTransport.addItem("");
+
+        pushMode.setImmediate(true);
+        transport.setImmediate(true);
+        fallbackTransport.setImmediate(true);
+
+        listeners();
+
+        paramValue.setDefaultComponentAlignment(Alignment.BOTTOM_RIGHT);
+        paramValue.addComponents(parameter, value, set);
+        vl.addComponents(pushMode, transport, fallbackTransport, paramValue,
+                new Label("<hr/>", ContentMode.HTML), status);
+        addComponent(vl);
+
+    }
+
+    /**
+     * @since
+     */
+    private void listeners() {
+        pushMode.addValueChangeListener(new ValueChangeListener() {
+            @Override
+            public void valueChange(ValueChangeEvent event) {
+                ui.getPushConfiguration().setPushMode(
+                        (PushMode) pushMode.getValue());
+                refreshStatus();
+            }
+        });
+
+        transport.addValueChangeListener(new ValueChangeListener() {
+            @Override
+            public void valueChange(ValueChangeEvent event) {
+                Transport t = Transport.valueOf((String) transport.getValue());
+                ui.getPushConfiguration().setTransport(t);
+                refreshStatus();
+            }
+        });
+
+        fallbackTransport.addValueChangeListener(new ValueChangeListener() {
+            @Override
+            public void valueChange(ValueChangeEvent event) {
+                Transport t = Transport.valueOf((String) fallbackTransport
+                        .getValue());
+                ui.getPushConfiguration().setFallbackTransport(t);
+                refreshStatus();
+            }
+        });
+
+        set.addClickListener(new ClickListener() {
+            @Override
+            public void buttonClick(ClickEvent event) {
+                ui.getPushConfiguration().setParameter(parameter.getValue(),
+                        value.getValue());
+                refreshStatus();
+            }
+        });
+
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/push/TogglePush.java b/uitest/src/com/vaadin/tests/push/TogglePush.java
index 37687260dd..c0bdc54ee0 100644
--- a/uitest/src/com/vaadin/tests/push/TogglePush.java
+++ b/uitest/src/com/vaadin/tests/push/TogglePush.java
@@ -22,19 +22,22 @@ public class TogglePush extends AbstractTestUI {
         updateCounter();
         addComponent(counterLabel);
 
-        setPushMode("disabled".equals(request.getParameter("push")) ? PushMode.DISABLED
-                : PushMode.AUTOMATIC);
+        getPushConfiguration()
+                .setPushMode(
+                        "disabled".equals(request.getParameter("push")) ? PushMode.DISABLED
+                                : PushMode.AUTOMATIC);
 
         CheckBox pushSetting = new CheckBox("Push enabled");
-        pushSetting.setValue(Boolean.valueOf(getPushMode().isEnabled()));
+        pushSetting.setValue(Boolean.valueOf(getPushConfiguration()
+                .getPushMode().isEnabled()));
         pushSetting.setImmediate(true);
         pushSetting.addValueChangeListener(new ValueChangeListener() {
             @Override
             public void valueChange(ValueChangeEvent event) {
                 if (event.getProperty().getValue() == Boolean.TRUE) {
-                    setPushMode(PushMode.AUTOMATIC);
+                    getPushConfiguration().setPushMode(PushMode.AUTOMATIC);
                 } else {
-                    setPushMode(PushMode.DISABLED);
+                    getPushConfiguration().setPushMode(PushMode.DISABLED);
                 }
             }
         });
author	Artur Signell <artur@vaadin.com>	2013-06-05 14:27:09 +0300
committer	Artur Signell <artur@vaadin.com>	2013-06-05 15:14:42 +0300
commit	edca4095d2e75d73f9d6a5acb2da9009129b4db2 (patch)
tree	15226365a8501ba55255dc21111696709aafa632 /uitest/src/com/vaadin/tests/push
parent	ebd4a5c0ae6e61c20283ba5b866fe51e3576a179 (diff)
download	vaadin-framework-edca4095d2e75d73f9d6a5acb2da9009129b4db2.tar.gz vaadin-framework-edca4095d2e75d73f9d6a5acb2da9009129b4db2.zip