Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #6050 - fix bug for permessage deflate buffer aggregation #6056

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,135 @@
//
// ========================================================================
// Copyright (c) 1995-2021 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;

import java.net.URI;
import java.util.Arrays;
import java.util.List;
import java.util.Random;
import java.util.concurrent.TimeUnit;

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.annotations.WebSocket;
import org.eclipse.jetty.websocket.client.ClientUpgradeRequest;
import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer;
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class PermessageDeflateBufferTest
{
private Server server;
private ServerConnector connector;
private WebSocketClient client;

// @checkstyle-disable-check : AvoidEscapedUnicodeCharactersCheck
private static final List<String> DICT = Arrays.asList(
"\uD83C\uDF09",
"\uD83C\uDF0A",
"\uD83C\uDF0B",
"\uD83C\uDF0C",
"\uD83C\uDF0D",
"\uD83C\uDF0F",
"\uD83C\uDFC0",
"\uD83C\uDFC1",
"\uD83C\uDFC2",
"\uD83C\uDFC3",
"\uD83C\uDFC4",
"\uD83C\uDFC5"
);

private static String randomText()
{
Random rnd = new Random();
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 15000; i++)
{
sb.append(DICT.get(rnd.nextInt(DICT.size())));
}
return sb.toString();
}

@BeforeEach
public void before() throws Exception
{
server = new Server();
connector = new ServerConnector(server);
server.addConnector(connector);

ServletContextHandler contextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS);
contextHandler.setContextPath("/");
server.setHandler(contextHandler);
WebSocketUpgradeFilter.configure(contextHandler);
NativeWebSocketServletContainerInitializer.configure(contextHandler, (context, container) ->
{
container.getPolicy().setMaxTextMessageBufferSize(65535);
container.getPolicy().setInputBufferSize(16384);
container.addMapping("/", ServerSocket.class);
});

server.start();
client = new WebSocketClient();
client.start();
}

@AfterEach
public void after() throws Exception
{
client.stop();
server.stop();
}

@WebSocket
public static class ServerSocket extends EchoSocket
{
@Override
public void onError(Throwable cause)
{
cause.printStackTrace();
super.onError(cause);
}
}

@Test
public void testPermessageDeflateAggregation() throws Exception
{
EventSocket socket = new EventSocket();
ClientUpgradeRequest clientUpgradeRequest = new ClientUpgradeRequest();
clientUpgradeRequest.addExtensions("permessage-deflate");

URI uri = URI.create("ws://localhost:" + connector.getLocalPort());
Session session = client.connect(socket, uri, clientUpgradeRequest).get(5, TimeUnit.SECONDS);

String s = randomText();
session.getRemote().sendString(s);
assertThat(socket.textMessages.poll(5, TimeUnit.SECONDS), is(s));

session.close();
assertTrue(socket.closeLatch.await(5, TimeUnit.SECONDS));
}
}
Expand Up @@ -197,14 +197,15 @@ protected void decompress(ByteAccumulator accumulator, ByteBuffer buf) throws Da

while (true)
{
// The buffer returned by the accumulator might not be empty, so we must append starting from the limit.
ByteBuffer buffer = accumulator.ensureBuffer(DECOMPRESS_BUF_SIZE);
int read = inflater.inflate(buffer.array(), buffer.arrayOffset() + buffer.position(), buffer.capacity() - buffer.limit());
buffer.limit(buffer.limit() + read);
accumulator.addLength(read);
int decompressed = inflater.inflate(buffer.array(), buffer.arrayOffset() + buffer.limit(), buffer.capacity() - buffer.limit());
buffer.limit(buffer.limit() + decompressed);
accumulator.addLength(decompressed);
if (LOG.isDebugEnabled())
LOG.debug("Decompressed {} bytes into buffer {} from {}", read, BufferUtil.toDetailString(buffer), toDetail(inflater));
LOG.debug("Decompressed {} bytes into buffer {} from {}", decompressed, BufferUtil.toDetailString(buffer), toDetail(inflater));

if (read <= 0)
if (decompressed <= 0)
break;
}
}
Expand Down Expand Up @@ -495,8 +496,9 @@ private void compress(FrameEntry entry, boolean first)
{
while (true)
{
// The buffer returned by the accumulator might not be empty, so we must append starting from the limit.
ByteBuffer buffer = accumulator.ensureBuffer(8, outputLength);
int compressed = deflater.deflate(buffer.array(), buffer.arrayOffset() + buffer.position(), buffer.capacity() - buffer.limit(), Deflater.SYNC_FLUSH);
int compressed = deflater.deflate(buffer.array(), buffer.arrayOffset() + buffer.limit(), buffer.capacity() - buffer.limit(), Deflater.SYNC_FLUSH);
buffer.limit(buffer.limit() + compressed);

if (LOG.isDebugEnabled())
Expand Down