Merge pull request #5030 from eclipse/jetty-9.4.x-5018-WebSocketClien…

…tConnectFuture

Issue #5018 - cancellation of WebSocketClient.connect Future should fail upgrade

jetty-websocket/jetty-websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/client/ConnectFutureTest.java

@@ -0,0 +1,396 @@
+//
+//  ========================================================================
+//  Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
+//  ------------------------------------------------------------------------
+//  All rights reserved. This program and the accompanying materials
+//  are made available under the terms of the Eclipse Public License v1.0
+//  and Apache License v2.0 which accompanies this distribution.
+//
+//      The Eclipse Public License is available at
+//      http://www.eclipse.org/legal/epl-v10.html
+//
+//      The Apache License v2.0 is available at
+//      http://www.opensource.org/licenses/apache2.0.php
+//
+//  You may elect to redistribute this code under either of these licenses.
+//  ========================================================================
+//
+
+package org.eclipse.jetty.websocket.tests.client;
+
+import java.util.EnumSet;
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import java.util.function.Consumer;
+import javax.servlet.DispatcherType;
+
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
+import org.eclipse.jetty.servlet.ServletContextHandler;
+import org.eclipse.jetty.websocket.api.Session;
+import org.eclipse.jetty.websocket.api.StatusCode;
+import org.eclipse.jetty.websocket.api.UpgradeException;
+import org.eclipse.jetty.websocket.api.UpgradeRequest;
+import org.eclipse.jetty.websocket.api.UpgradeResponse;
+import org.eclipse.jetty.websocket.api.WebSocketException;
+import org.eclipse.jetty.websocket.api.util.WSURI;
+import org.eclipse.jetty.websocket.client.ClientUpgradeRequest;
+import org.eclipse.jetty.websocket.client.WebSocketClient;
+import org.eclipse.jetty.websocket.client.io.UpgradeListener;
+import org.eclipse.jetty.websocket.common.WebSocketSession;
+import org.eclipse.jetty.websocket.common.WebSocketSessionListener;
+import org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration;
+import org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer;
+import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
+import org.eclipse.jetty.websocket.tests.CloseTrackingEndpoint;
+import org.eclipse.jetty.websocket.tests.EchoSocket;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.instanceOf;
+import static org.hamcrest.Matchers.is;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class ConnectFutureTest
+{
+    private Server server;
+    private WebSocketClient client;
+
+    public void start(Consumer<NativeWebSocketConfiguration> configuration) throws Exception
+    {
+        server = new Server();
+        ServerConnector connector = new ServerConnector(server);
+        server.addConnector(connector);
+
+        ServletContextHandler contextHandler = new ServletContextHandler();
+        contextHandler.setContextPath("/");
+        server.setHandler(contextHandler);
+
+        NativeWebSocketServletContainerInitializer.configure(contextHandler, (context, container) ->
+            configuration.accept(container));
+        contextHandler.addFilter(WebSocketUpgradeFilter.class, "/", EnumSet.of(DispatcherType.REQUEST));
+        server.start();
+
+        client = new WebSocketClient();
+        client.start();
+    }
+
+    @AfterEach
+    public void stop() throws Exception
+    {
+        if (client != null)
+            client.stop();
+        if (server != null)
+            server.stop();
+    }
+
+    @Test
+    public void testAbortDuringCreator() throws Exception
+    {
+        CountDownLatch enteredCreator = new CountDownLatch(1);
+        CountDownLatch exitCreator = new CountDownLatch(1);
+        start(c ->
+        {
+            c.addMapping("/", (req, res) ->
+            {
+                try
+                {
+                    enteredCreator.countDown();
+                    exitCreator.await();
+                    return new EchoSocket();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            });
+        });
+
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+
+        // Cancel the future once we have entered the servers WebSocketCreator (after upgrade request is sent).
+        assertTrue(enteredCreator.await(5, TimeUnit.SECONDS));
+        assertTrue(connect.cancel(true));
+        assertThrows(CancellationException.class, () -> connect.get(5, TimeUnit.SECONDS));
+        exitCreator.countDown();
+        assertFalse(clientSocket.openLatch.await(1, TimeUnit.SECONDS));
+
+        Throwable error = clientSocket.error.get();
+        assertThat(error, instanceOf(UpgradeException.class));
+        assertThat(error.getCause(), instanceOf(CancellationException.class));
+    }
+
+    @Test
+    public void testAbortSessionOnCreated() throws Exception
+    {
+        start(c -> c.addMapping("/", EchoSocket.class));
+
+        CountDownLatch enteredListener = new CountDownLatch(1);
+        CountDownLatch exitListener = new CountDownLatch(1);
+        client.addSessionListener(new WebSocketSessionListener()
+        {
+            @Override
+            public void onSessionCreated(WebSocketSession session)
+            {
+                try
+                {
+                    enteredListener.countDown();
+                    exitListener.await();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            }
+        });
+
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+
+        // Abort when session is created, this is before future has been added to session and before the connection upgrade.
+        assertTrue(enteredListener.await(5, TimeUnit.SECONDS));
+        assertTrue(connect.cancel(true));
+        assertThrows(CancellationException.class, () -> connect.get(5, TimeUnit.SECONDS));
+        exitListener.countDown();
+        assertFalse(clientSocket.openLatch.await(1, TimeUnit.SECONDS));
+        assertThat(clientSocket.error.get(), instanceOf(CancellationException.class));
+    }
+
+    @Test
+    public void testAbortInHandshakeResponse() throws Exception
+    {
+        start(c -> c.addMapping("/", EchoSocket.class));
+
+        CountDownLatch enteredListener = new CountDownLatch(1);
+        CountDownLatch exitListener = new CountDownLatch(1);
+        UpgradeListener upgradeListener = new AbstractUpgradeListener()
+        {
+            @Override
+            public void onHandshakeResponse(UpgradeResponse response)
+            {
+                try
+                {
+                    enteredListener.countDown();
+                    exitListener.await();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            }
+        };
+
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        ClientUpgradeRequest upgradeRequest = new ClientUpgradeRequest();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()), upgradeRequest, upgradeListener);
+
+        // Abort after after handshake response, which is before connection upgrade, but after future has been set on session.
+        assertTrue(enteredListener.await(5, TimeUnit.SECONDS));
+        assertTrue(connect.cancel(true));
+        assertThrows(CancellationException.class, () -> connect.get(5, TimeUnit.SECONDS));
+        exitListener.countDown();
+        assertFalse(clientSocket.openLatch.await(1, TimeUnit.SECONDS));
+        assertThat(clientSocket.error.get(), instanceOf(CancellationException.class));
+    }
+
+    @Test
+    public void testAbortOnOpened() throws Exception
+    {
+        start(c -> c.addMapping("/", EchoSocket.class));
+
+        CountDownLatch exitOnOpen = new CountDownLatch(1);
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint()
+        {
+            @Override
+            public void onWebSocketConnect(Session session)
+            {
+                try
+                {
+                    super.onWebSocketConnect(session);
+                    exitOnOpen.await();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            }
+        };
+
+        // Abort during the call to onOpened. This is after future has been added to session,
+        // and after connection has been upgraded, but before future completion.
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+        assertTrue(clientSocket.openLatch.await(5, TimeUnit.SECONDS));
+        assertTrue(connect.cancel(true));
+        exitOnOpen.countDown();
+
+        // We got an error on the WebSocket endpoint and an error from the future.
+        assertTrue(clientSocket.errorLatch.await(5, TimeUnit.SECONDS));
+        assertThrows(CancellationException.class, () -> connect.get(5, TimeUnit.SECONDS));
+    }
+
+    @Test
+    public void testAbortAfterCompletion() throws Exception
+    {
+        start(c -> c.addMapping("/", EchoSocket.class));
+
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+        Session session = connect.get(5, TimeUnit.SECONDS);
+
+        // If we can send and receive messages the future has been completed.
+        assertTrue(clientSocket.openLatch.await(5, TimeUnit.SECONDS));
+        clientSocket.getSession().getRemote().sendString("hello");
+        assertThat(clientSocket.messageQueue.poll(5, TimeUnit.SECONDS), Matchers.is("hello"));
+
+        // After it has been completed we should not get any errors from cancelling it.
+        assertFalse(connect.cancel(true));
+        assertThat(connect.get(5, TimeUnit.SECONDS), instanceOf(Session.class));
+        assertFalse(clientSocket.closeLatch.await(1, TimeUnit.SECONDS));
+        assertNull(clientSocket.error.get());
+
+        // Close the session properly.
+        session.close();
+        assertTrue(clientSocket.closeLatch.await(5, TimeUnit.SECONDS));
+        assertThat(clientSocket.closeCode, is(StatusCode.NORMAL));
+    }
+
+    @Test
+    public void testFutureTimeout() throws Exception
+    {
+        CountDownLatch exitCreator = new CountDownLatch(1);
+        start(c ->
+        {
+            c.addMapping("/", (req, res) ->
+            {
+                try
+                {
+                    exitCreator.await();
+                    return new EchoSocket();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            });
+        });
+
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+        assertThrows(TimeoutException.class, () -> connect.get(1, TimeUnit.SECONDS));
+        exitCreator.countDown();
+        Session session = connect.get(5, TimeUnit.SECONDS);
+
+        // Close the session properly.
+        session.close();
+        assertTrue(clientSocket.closeLatch.await(5, TimeUnit.SECONDS));
+        assertThat(clientSocket.closeCode, is(StatusCode.NORMAL));
+    }
+
+    @Test
+    public void testAbortWithExceptionBeforeUpgrade() throws Exception
+    {
+        CountDownLatch exitCreator = new CountDownLatch(1);
+        start(c ->
+        {
+            c.addMapping("/", (req, res) ->
+            {
+                try
+                {
+                    exitCreator.await();
+                    return new EchoSocket();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            });
+        });
+
+        // Complete the CompletableFuture with an exception the during the call to onOpened.
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+        CompletableFuture<Session> completableFuture = (CompletableFuture<Session>)connect;
+        assertTrue(completableFuture.completeExceptionally(new WebSocketException("custom exception")));
+        exitCreator.countDown();
+
+        // Exception from the future is correct.
+        ExecutionException futureError = assertThrows(ExecutionException.class, () -> connect.get(5, TimeUnit.SECONDS));
+        Throwable cause = futureError.getCause();
+        assertThat(cause, instanceOf(WebSocketException.class));
+        assertThat(cause.getMessage(), is("custom exception"));
+
+        // Exception from the endpoint is correct.
+        assertTrue(clientSocket.errorLatch.await(5, TimeUnit.SECONDS));
+        Throwable endpointError = clientSocket.error.get();
+        assertThat(endpointError, instanceOf(UpgradeException.class));
+        Throwable endpointErrorCause = endpointError.getCause();
+        assertThat(endpointError, instanceOf(WebSocketException.class));
+        assertThat(endpointErrorCause.getMessage(), is("custom exception"));
+    }
+
+    @Test
+    public void testAbortWithExceptionAfterUpgrade() throws Exception
+    {
+        start(c -> c.addMapping("/", EchoSocket.class));
+        CountDownLatch exitOnOpen = new CountDownLatch(1);
+        CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint()
+        {
+            @Override
+            public void onWebSocketConnect(Session session)
+            {
+                try
+                {
+                    super.onWebSocketConnect(session);
+                    exitOnOpen.await();
+                }
+                catch (InterruptedException e)
+                {
+                    throw new IllegalStateException(e);
+                }
+            }
+        };
+
+        // Complete the CompletableFuture with an exception the during the call to onOpened.
+        Future<Session> connect = client.connect(clientSocket, WSURI.toWebsocket(server.getURI()));
+        assertTrue(clientSocket.openLatch.await(5, TimeUnit.SECONDS));
+        CompletableFuture<Session> completableFuture = (CompletableFuture<Session>)connect;
+        assertTrue(completableFuture.completeExceptionally(new WebSocketException("custom exception")));
+        exitOnOpen.countDown();
+
+        // Exception from the future is correct.
+        ExecutionException futureError = assertThrows(ExecutionException.class, () -> connect.get(5, TimeUnit.SECONDS));
+        Throwable cause = futureError.getCause();
+        assertThat(cause, instanceOf(WebSocketException.class));
+        assertThat(cause.getMessage(), is("custom exception"));
+
+        // Exception from the endpoint is correct.
+        assertTrue(clientSocket.errorLatch.await(5, TimeUnit.SECONDS));
+        Throwable endpointError = clientSocket.error.get();
+        assertThat(endpointError, instanceOf(WebSocketException.class));
+        assertThat(endpointError.getMessage(), is("custom exception"));
+    }
+
+    public abstract static class AbstractUpgradeListener implements UpgradeListener
+    {
+        @Override
+        public void onHandshakeRequest(UpgradeRequest request)
+        {
+        }
+
+        @Override
+        public void onHandshakeResponse(UpgradeResponse response)
+        {
+        }
+    }
+}