-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4987 from eclipse/jetty-9.4.x-1100-WebSocketEncod…
…erLifeCycle Issue #1100 - ensure init and destroy are always called on JSR356 Encoders
- Loading branch information
Showing
7 changed files
with
240 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,4 +26,6 @@ | |
| public interface Configurable | ||
| { | ||
| void init(EndpointConfig config); | ||
|
|
||
| void destroy(); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
186 changes: 186 additions & 0 deletions
186
...er-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/EncoderLifeCycleTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| // | ||
| // ======================================================================== | ||
| // 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.jsr356.server; | ||
|
|
||
| import java.net.URI; | ||
| import java.util.Collections; | ||
| import java.util.concurrent.CountDownLatch; | ||
| import java.util.concurrent.TimeUnit; | ||
| import javax.websocket.ClientEndpointConfig; | ||
| import javax.websocket.CloseReason; | ||
| import javax.websocket.ContainerProvider; | ||
| import javax.websocket.Encoder; | ||
| import javax.websocket.Endpoint; | ||
| import javax.websocket.EndpointConfig; | ||
| import javax.websocket.MessageHandler; | ||
| import javax.websocket.Session; | ||
| import javax.websocket.WebSocketContainer; | ||
| import javax.websocket.server.ServerEndpointConfig; | ||
|
|
||
| import org.eclipse.jetty.server.Server; | ||
| import org.eclipse.jetty.server.ServerConnector; | ||
| import org.eclipse.jetty.servlet.ServletContextHandler; | ||
| import org.eclipse.jetty.util.BlockingArrayQueue; | ||
| import org.eclipse.jetty.util.log.Log; | ||
| import org.eclipse.jetty.util.log.Logger; | ||
| import org.eclipse.jetty.websocket.jsr356.EncoderFactory; | ||
| import org.eclipse.jetty.websocket.jsr356.JsrSession; | ||
| import org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer; | ||
| import org.eclipse.jetty.websocket.jsr356.server.samples.echo.EchoReturnEndpoint; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.ValueSource; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.is; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| public class EncoderLifeCycleTest | ||
| { | ||
| private static final Logger LOG = Log.getLogger(EncoderLifeCycleTest.class); | ||
| private static Server server; | ||
| private static URI serverUri; | ||
|
|
||
| @BeforeAll | ||
| public static void startServer() throws Exception | ||
| { | ||
| server = new Server(); | ||
| ServerConnector connector = new ServerConnector(server); | ||
| server.addConnector(connector); | ||
|
|
||
| ServletContextHandler contextHandler = new ServletContextHandler(); | ||
| contextHandler.setContextPath("/"); | ||
| server.setHandler(contextHandler); | ||
|
|
||
| WebSocketServerContainerInitializer.configure(contextHandler, ((servletContext, serverContainer) -> | ||
| serverContainer.addEndpoint(ServerEndpointConfig.Builder.create(EchoReturnEndpoint.class, "/").build()))); | ||
|
|
||
| // Start Server | ||
| server.start(); | ||
| serverUri = new URI(String.format("ws://localhost:%d/", connector.getLocalPort())); | ||
| } | ||
|
|
||
| public static class StringHolder | ||
| { | ||
| private final String string; | ||
|
|
||
| public StringHolder(String msg) | ||
| { | ||
| string = msg; | ||
| } | ||
|
|
||
| public String getString() | ||
| { | ||
| return string; | ||
| } | ||
| } | ||
|
|
||
| public static class StringHolderSubtype extends StringHolder | ||
| { | ||
| public StringHolderSubtype(String msg) | ||
| { | ||
| super(msg + "|subtype"); | ||
| } | ||
| } | ||
|
|
||
| public static class MyEncoder implements Encoder.Text<StringHolder> | ||
| { | ||
| public CountDownLatch initialized = new CountDownLatch(1); | ||
| public CountDownLatch destroyed = new CountDownLatch(1); | ||
|
|
||
| @Override | ||
| public void init(EndpointConfig config) | ||
| { | ||
| initialized.countDown(); | ||
| } | ||
|
|
||
| @Override | ||
| public String encode(StringHolder message) | ||
| { | ||
| return message.getString(); | ||
| } | ||
|
|
||
| @Override | ||
| public void destroy() | ||
| { | ||
| destroyed.countDown(); | ||
| } | ||
| } | ||
|
|
||
| public static class TextMessageEndpoint extends Endpoint implements MessageHandler.Whole<String> | ||
| { | ||
| public BlockingArrayQueue<String> textMessages = new BlockingArrayQueue<>(); | ||
| public CountDownLatch openLatch = new CountDownLatch(1); | ||
| public CountDownLatch closeLatch = new CountDownLatch(1); | ||
| public CloseReason closeReason = null; | ||
|
|
||
| @Override | ||
| public void onOpen(Session session, EndpointConfig config) | ||
| { | ||
| session.addMessageHandler(this); | ||
| this.openLatch.countDown(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onClose(Session session, CloseReason closeReason) | ||
| { | ||
| this.closeReason = closeReason; | ||
| this.closeLatch.countDown(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onMessage(String message) | ||
| { | ||
| this.textMessages.add(message); | ||
| } | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @ValueSource(classes = {StringHolder.class, StringHolderSubtype.class}) | ||
| public void testEncoderLifeCycle(Class<? extends StringHolder> clazz) throws Exception | ||
| { | ||
| WebSocketContainer container = ContainerProvider.getWebSocketContainer(); | ||
| TextMessageEndpoint clientEndpoint = new TextMessageEndpoint(); | ||
| ClientEndpointConfig clientConfig = ClientEndpointConfig.Builder.create() | ||
| .encoders(Collections.singletonList(MyEncoder.class)) | ||
| .build(); | ||
|
|
||
| // Send an instance of our StringHolder type. | ||
| Session session = container.connectToServer(clientEndpoint, clientConfig, serverUri); | ||
| StringHolder data = clazz.getConstructor(String.class).newInstance("test1"); | ||
| session.getBasicRemote().sendObject(data); | ||
|
|
||
| // We received the expected echo. | ||
| String echoed = clientEndpoint.textMessages.poll(5, TimeUnit.SECONDS); | ||
| assertThat("Echoed message", echoed, is(data.getString())); | ||
|
|
||
| // Verify that the encoder has been opened. | ||
| EncoderFactory encoderFactory = ((JsrSession)session).getEncoderFactory(); | ||
| Object obj = encoderFactory.getEncoderFor(data.getClass()); | ||
| assertThat(obj.getClass(), is(MyEncoder.class)); | ||
| MyEncoder encoder = (MyEncoder)obj; | ||
| assertThat(encoder.initialized.getCount(), is(0L)); | ||
|
|
||
| // Verify the Encoder has not been destroyed, but is destroyed after the session is closed. | ||
| assertThat(encoder.destroyed.getCount(), is(1L)); | ||
| session.close(); | ||
| assertTrue(clientEndpoint.closeLatch.await(5, TimeUnit.SECONDS)); | ||
| assertTrue(encoder.destroyed.await(5, TimeUnit.SECONDS)); | ||
| } | ||
| } |