vaadin-framework/uitest/src/main/java/com/vaadin/tests/application/NavigateWithOngoingXHR.java

/*
 * 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.application;

import java.io.IOException;
import java.io.PrintWriter;

import com.vaadin.server.ExternalResource;
import com.vaadin.server.RequestHandler;
import com.vaadin.server.VaadinRequest;
import com.vaadin.server.VaadinResponse;
import com.vaadin.server.VaadinSession;
import com.vaadin.tests.components.AbstractReindeerTestUI;
import com.vaadin.ui.Link;
import com.vaadin.v7.shared.ui.progressindicator.ProgressIndicatorServerRpc;
import com.vaadin.v7.ui.ProgressIndicator;

public class NavigateWithOngoingXHR extends AbstractReindeerTestUI {
    private final RequestHandler slowRequestHandler = new RequestHandler() {
        @Override
        public boolean handleRequest(VaadinSession session,
                VaadinRequest request, VaadinResponse response)
                throws IOException {
            if ("/slowRequestHandler".equals(request.getPathInfo())) {
                // Make the navigation request last longer to keep the
                // communication error visible
                // System.out.println("Got slow content request");
                try {
                    Thread.sleep(5000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }

                if (request.getParameter("download") != null) {
                    response.setHeader("Content-Disposition", "attachment");
                }

                response.setContentType("text/plain");
                PrintWriter writer = response.getWriter();
                writer.println("Loaded slowly");
                writer.close();

                // System.out.println("Finished slow content request");

                return true;
            }
            return false;
        }
    };

    @Override
    protected void setup(VaadinRequest request) {
        addComponent(new ProgressIndicator() {
            {
                registerRpc(new ProgressIndicatorServerRpc() {
                    @Override
                    public void poll() {
                        // System.out.println("Pausing poll request");
                        try {
                            // Make the XHR request last longer to make it
                            // easier to click the link at the right moment.
                            Thread.sleep(1000);
                        } catch (InterruptedException e) {
                            e.printStackTrace();
                        }
                        // System.out.println("Continuing poll request");
                    }
                });
                setPollingInterval(3000);
            }
        });

        // Hacky URLs that are might not work in all deployment scenarios
        addComponent(new Link("Navigate away",
                new ExternalResource("slowRequestHandler")));
        addComponent(new Link("Start download",
                new ExternalResource("slowRequestHandler?download")));
    }

    @Override
    public void attach() {
        super.attach();
        getSession().addRequestHandler(slowRequestHandler);
    }

    @Override
    public void detach() {
        getSession().removeRequestHandler(slowRequestHandler);
        super.detach();
    }

    @Override
    protected String getTestDescription() {
        return "Navigating away from a Vaadin page while there's an ongoing XHR request should not cause a communication error to be displayed";
    }

    @Override
    protected Integer getTicketNumber() {
        return Integer.valueOf(8891);
    }

}