Close push connection when UI is detached (#11596)

Change-Id: Ibfc5923406b386786ae399b7f53cea47ac885f48

2 files changed, 184 insertions, 0 deletions

diff --git a/uitest/src/com/vaadin/tests/applicationcontext/CloseUI.java b/uitest/src/com/vaadin/tests/applicationcontext/CloseUI.java
new file mode 100644
index 0000000000..6d8be4339d
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/applicationcontext/CloseUI.java
@@ -0,0 +1,160 @@
+/*
+ * Copyright 2012 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.applicationcontext;
+
+import com.vaadin.server.Page;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.server.VaadinService;
+import com.vaadin.server.VaadinSession;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.tests.util.Log;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+import com.vaadin.ui.UI;
+
+public class CloseUI extends AbstractTestUI {
+    private static final String OLD_HASH_PARAM = "oldHash";
+    private static final String OLD_SESSION_ID_PARAM = "oldSessionId";
+
+    private final Log log = new Log(6);
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        System.out.println("UI " + getUIId() + " inited");
+
+        final int sessionHash = getSession().hashCode();
+        final String sessionId = request.getWrappedSession().getId();
+
+        log.log("Current session hashcode: " + sessionHash);
+        log.log("Current WrappedSession id: " + sessionId);
+
+        // Log previous values to make it easier to see what has changed
+        String oldHashValue = request.getParameter(OLD_HASH_PARAM);
+        if (oldHashValue != null) {
+            log.log("Old session hashcode: " + oldHashValue);
+            log.log("Same hash as current? "
+                    + oldHashValue.equals(Integer.toString(sessionHash)));
+        }
+
+        String oldSessionId = request.getParameter(OLD_SESSION_ID_PARAM);
+        if (oldSessionId != null) {
+            log.log("Old WrappedSession id: " + oldSessionId);
+            log.log("Same WrappedSession id? " + oldSessionId.equals(sessionId));
+        }
+
+        addComponent(log);
+        addComponent(new Button("Log 'hello'", new Button.ClickListener() {
+            @Override
+            public void buttonClick(ClickEvent event) {
+                log.log("Hello");
+            }
+        }));
+        addComponent(new Button("Close UI", new Button.ClickListener() {
+            @Override
+            public void buttonClick(ClickEvent event) {
+                close();
+            }
+        }));
+
+        addComponent(new Button("Close UI (background)",
+                new Button.ClickListener() {
+                    @Override
+                    public void buttonClick(ClickEvent event) {
+                        new UIRunSafelyThread(CloseUI.this) {
+                            @Override
+                            protected void runSafely() {
+                                close();
+                            };
+                        }.start();
+                    }
+                }));
+        addComponent(new Button(
+                "Close UI and redirect to /statictestfiles/static.html",
+                new Button.ClickListener() {
+                    @Override
+                    public void buttonClick(ClickEvent event) {
+                        getPage().setLocation("/statictestfiles/static.html");
+                        close();
+                    }
+                }));
+        addComponent(new Button(
+                "Close UI and redirect to /statictestfiles/static.html (background)",
+                new Button.ClickListener() {
+                    @Override
+                    public void buttonClick(ClickEvent event) {
+                        new UIRunSafelyThread(CloseUI.this) {
+
+                            @Override
+                            protected void runSafely() {
+                                getPage().setLocation(
+                                        "/statictestfiles/static.html");
+                                close();
+                            }
+                        };
+                    }
+                }));
+
+    }
+
+    private abstract class RunSafelyThread extends Thread {
+        private UI ui;
+
+        public RunSafelyThread(UI ui) {
+            this.ui = ui;
+        }
+
+        @Override
+        public void run() {
+            ui.runSafely(new Runnable() {
+
+                @Override
+                public void run() {
+                    runSafely();
+                }
+            });
+        }
+
+        protected abstract void runSafely();
+    }
+
+    @Override
+    protected String getTestDescription() {
+        return "Test for closing the session and redirecting the user";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return Integer.valueOf(9859);
+    }
+
+    @Override
+    public void detach() {
+        super.detach();
+        log.log("Detach of " + this + " (" + getUIId() + ")");
+        boolean correctUI = (UI.getCurrent() == this);
+        boolean correctPage = (Page.getCurrent() == getPage());
+        boolean correctVaadinSession = (VaadinSession.getCurrent() == getSession());
+        boolean correctVaadinService = (VaadinService.getCurrent() == getSession()
+                .getService());
+        log.log("UI.current correct in detach: " + correctUI);
+        log.log("Page.current correct in detach: " + correctPage);
+        log.log("VaadinSession.current correct in detach: "
+                + correctVaadinSession);
+        log.log("VaadinService.current correct in detach: "
+                + correctVaadinService);
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/applicationcontext/UIRunSafelyThread.java b/uitest/src/com/vaadin/tests/applicationcontext/UIRunSafelyThread.java
new file mode 100644
index 0000000000..0048cbd741
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/applicationcontext/UIRunSafelyThread.java
@@ -0,0 +1,24 @@
+package com.vaadin.tests.applicationcontext;
+
+import com.vaadin.ui.UI;
+
+public abstract class UIRunSafelyThread extends Thread {
+    private UI ui;
+
+    public UIRunSafelyThread(UI ui) {
+        this.ui = ui;
+    }
+
+    @Override
+    public void run() {
+        ui.runSafely(new Runnable() {
+
+            @Override
+            public void run() {
+                runSafely();
+            }
+        });
+    }
+
+    protected abstract void runSafely();
+}
\ No newline at end of file