Skip to content

Fix Vert.x request blocking timeouts #13128

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.

Sign up for GitHub

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

Merged
gh-worker-dd-mergequeue-cf854d merged 4 commits into from
Oct 31, 2026
Merged

Fix Vert.x request blocking timeouts #13128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b31d7e4
Limit Netty write failures to close frames
datadog-bits Oct 30, 2026
8c1e5e8
Complete discarded Netty write promises
datadog-bits Oct 30, 2026
8a9edc9
Merge branch 'master' into dd/fix-vertx-blocking-timeouts-20261030-b7d1
ygree Oct 30, 2026
cca47ed
Merge branch 'master' into dd/fix-vertx-blocking-timeouts-20261030-b7d1
ygree Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ...1/src/main/java/datadog/trace/instrumentation/netty41/server/BlockingResponseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import io.netty.handler.codec.http.HttpResponseStatus;
import io.netty.handler.codec.http.HttpUtil;
import io.netty.handler.codec.http.HttpVersion;
import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
import io.netty.util.ReferenceCountUtil;
import java.nio.channels.ClosedChannelException;
import java.util.Map;
Expand Down Expand Up @@ -247,8 +248,13 @@ public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)
throws Exception {
log.info("Ignored write of object {}", msg);
ReferenceCountUtil.release(msg);
// Releasing the message does not complete the write; notify listeners that it failed.
promise.tryFailure(new ClosedChannelException());
// Fail close frames so Netty's close listener runs. Complete other discarded writes
// successfully to avoid re-entering framework error handling (e.g. in Vert.x).
if (msg instanceof CloseWebSocketFrame) {
promise.tryFailure(new ClosedChannelException());
Comment thread
cgcote marked this conversation as resolved.
Resolved
} else {
promise.trySuccess();
}
}
}
}
53 changes: 53 additions & 0 deletions ...c/test/java/datadog/trace/instrumentation/netty41/server/BlockingResponseHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import static datadog.trace.instrumentation.netty41.server.BlockingResponseHandler.BEFORE_BLOCKING_HANDLER_NAME;
import static datadog.trace.instrumentation.netty41.server.BlockingResponseHandler.HANDLER_NAME;
import static io.netty.handler.codec.http.HttpMethod.GET;
import static io.netty.handler.codec.http.HttpResponseStatus.OK;
import static io.netty.handler.codec.http.HttpVersion.HTTP_1_1;
import static java.util.Collections.emptyMap;
import static java.util.concurrent.TimeUnit.SECONDS;
Expand All @@ -18,23 +19,75 @@
import datadog.context.Context;
import datadog.trace.instrumentation.netty41.ServerRequestContext;
import datadog.trace.instrumentation.netty41.server.NettyHttpServerDecorator.NettyBlockResponseFunction;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.channel.ChannelPromise;
import io.netty.channel.DefaultEventLoopGroup;
import io.netty.channel.embedded.EmbeddedChannel;
import io.netty.channel.local.LocalChannel;
import io.netty.handler.codec.http.DefaultFullHttpRequest;
import io.netty.handler.codec.http.DefaultFullHttpResponse;
import io.netty.handler.codec.http.DefaultLastHttpContent;
import io.netty.handler.codec.http.FullHttpRequest;
import io.netty.handler.codec.http.HttpContent;
import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
import io.netty.util.concurrent.Future;
import java.nio.channels.ClosedChannelException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicReference;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;

class BlockingResponseHandlerTest {

@ParameterizedTest
@MethodSource("discardedHttpWritesArguments")
void discardedHttpWritesDoNotFireExceptions(HttpContent message) {
EmbeddedChannel channel =
new EmbeddedChannel(BlockingResponseHandler.IgnoreAllWritesHandler.INSTANCE);
try {
channel.pipeline().writeAndFlush(message, channel.voidPromise());

channel.checkException();
assertEquals(0, message.refCnt());
assertNull(channel.readOutbound());
assertTrue(channel.isActive());
} finally {
channel.finishAndReleaseAll();
}
}

@ParameterizedTest
@MethodSource("discardedHttpWritesArguments")
void discardedHttpWritesCompletePromiseAndNotifyListener(HttpContent message) {
EmbeddedChannel channel =
new EmbeddedChannel(BlockingResponseHandler.IgnoreAllWritesHandler.INSTANCE);
AtomicReference<ChannelFuture> notifiedPromise = new AtomicReference<>();
try {
ChannelFuture future = channel.pipeline().writeAndFlush(message);
future.addListener((ChannelFutureListener) notifiedPromise::set);

assertTrue(future.isSuccess());
assertSame(future, notifiedPromise.get());
channel.checkException();
assertEquals(0, message.refCnt());
assertNull(channel.readOutbound());
assertTrue(channel.isActive());
} finally {
channel.finishAndReleaseAll();
}
}

static Stream<HttpContent> discardedHttpWritesArguments() {
return Stream.of(
new DefaultFullHttpResponse(HTTP_1_1, OK, Unpooled.buffer().writeByte(1)),
new DefaultLastHttpContent(Unpooled.buffer().writeByte(1)));
}

@Test
void discardedCloseFrameCompletesPromiseAndNotifiesCloseListener() {
EmbeddedChannel channel =
Expand Down
Loading