Skip to content

servlet: add extra 5s to AsyncContext timeout #12321

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
kannanjgithub merged 3 commits into from
Sep 16, 2025
Merged

servlet: add extra 5s to AsyncContext timeout #12321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e028d86
servlet: add extra 5s to AsyncContext timeout
panchenko Aug 28, 2025
3e69193
fix unit test
panchenko Aug 28, 2025
b9ac349
Merge branch 'master' into servlet-ASYNC_TIMEOUT_SAFETY_MARGIN
panchenko Aug 28, 2025
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
14 changes: 10 additions & 4 deletions servlet/src/main/java/io/grpc/servlet/ServletAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import static java.util.logging.Level.FINE;
import static java.util.logging.Level.FINEST;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.io.BaseEncoding;
import io.grpc.Attributes;
import io.grpc.ExperimentalApi;
Expand Down Expand Up @@ -128,10 +129,9 @@ public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOEx
}

Long timeoutNanos = headers.get(TIMEOUT_KEY);
if (timeoutNanos == null) {
timeoutNanos = 0L;
}
asyncCtx.setTimeout(TimeUnit.NANOSECONDS.toMillis(timeoutNanos));
asyncCtx.setTimeout(timeoutNanos != null
? TimeUnit.NANOSECONDS.toMillis(timeoutNanos) + ASYNC_TIMEOUT_SAFETY_MARGIN
: 0);
StatsTraceContext statsTraceCtx =
StatsTraceContext.newServerContext(streamTracerFactories, method, headers);

Expand All @@ -158,6 +158,12 @@ public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOEx
asyncCtx.addListener(new GrpcAsyncListener(stream, logId));
}

/**
* Deadlines are managed via Context, servlet async timeout is not supposed to happen.
*/
@VisibleForTesting
static final long ASYNC_TIMEOUT_SAFETY_MARGIN = 5_000;

// This method must use Enumeration and its members, since that is the only way to read headers
// from the servlet api.
@SuppressWarnings("JdkObsolete")
Expand Down
2 changes: 1 addition & 1 deletion servlet/src/test/java/io/grpc/servlet/ServletServerBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public void scheduledExecutorService() throws Exception {
ServletAdapter servletAdapter = serverBuilder.buildServletAdapter();
servletAdapter.doPost(request, response);

verify(asyncContext).setTimeout(1);
verify(asyncContext).setTimeout(1 + ServletAdapter.ASYNC_TIMEOUT_SAFETY_MARGIN);

// The following just verifies that scheduler is populated to the transport.
// It doesn't matter what tasks (such as handshake timeout and request deadline) are actually
Expand Down