-
Notifications
You must be signed in to change notification settings - Fork 4k
servlet: fix write when not ready in AsyncServletOutputStreamWriter #12790
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
Open
mgustimz
wants to merge
4
commits into
grpc:master
Choose a base branch
from
mgustimz:fix/12723-servlet-clean
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+153
−4
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3f87103
servlet: fix write when not ready in AsyncServletOutputStreamWriter
mgustimz 60e9f16
servlet: fix write when not ready, narrow to writeBytes only
mgustimz 44ee627
servlet: fix type comparison in runOrBuffer
mgustimz 55e6629
Add AsyncServletOutputStreamWriterTest with mock isReady supplier
mgustimz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
135 changes: 135 additions & 0 deletions
135
servlet/src/test/java/io/grpc/servlet/AsyncServletOutputStreamWriterTest.java
This file contains hidden or 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,135 @@ | ||
| /* | ||
| * Copyright 2026 The gRPC Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.servlet; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import io.grpc.servlet.AsyncServletOutputStreamWriter.ActionItem; | ||
| import io.grpc.servlet.AsyncServletOutputStreamWriter.Log; | ||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.function.BiFunction; | ||
| import java.util.function.BooleanSupplier; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| /** | ||
| * Unit test for {@link AsyncServletOutputStreamWriter} with a mock isReady supplier | ||
| * that always returns true. This specifically tests the scenario where isReady stays | ||
| * true across multiple write calls (as can happen with Tomcat and other servlet | ||
| * containers that defer onWritePossible until the previous write completes internally). | ||
| */ | ||
| @RunWith(JUnit4.class) | ||
| public class AsyncServletOutputStreamWriterTest { | ||
|
|
||
| /** | ||
| * Test that multiple consecutive writes succeed even when isReady() always returns true. | ||
| * This reproduces the Tomcat issue where isReady() returns true but write() still fails | ||
| * because the previous write hasn't completed internally. | ||
| */ | ||
| @Test | ||
| public void writeBytes_alwaysReady_doesNotStall() throws IOException { | ||
| AtomicBoolean isReady = new AtomicBoolean(true); | ||
| List<byte[]> writtenData = new ArrayList<>(); | ||
| AtomicInteger onWritePossibleCount = new AtomicInteger(0); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> { | ||
| writtenData.add(bytes); | ||
| }; | ||
|
|
||
| ActionItem flushAction = () -> {}; | ||
|
|
||
| ActionItem completeAction = () -> {}; | ||
|
|
||
| BooleanSupplier isReadySupplier = () -> { | ||
| // Note: isReady stays true throughout this test | ||
| return isReady.get(); | ||
| }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter(writeAction, flushAction, completeAction, isReadySupplier, new Log() {}); | ||
|
|
||
| // Simulate the first onWritePossible call (container init) | ||
| isReady.set(true); | ||
| writer.onWritePossible(); | ||
| onWritePossibleCount.incrementAndGet(); | ||
|
|
||
| // Write multiple times while isReady stays true | ||
| // Before the fix, writes would stall because isReady returned true | ||
| // but the previous write hadn't completed internally | ||
| for (int i = 0; i < 5; i++) { | ||
| byte[] data = new byte[]{(byte) i}; | ||
| writer.writeBytes(data, 1); | ||
| } | ||
|
|
||
| // Verify all writes completed | ||
| assertEquals("All writes should complete", 5, writtenData.size()); | ||
| } | ||
|
|
||
| /** | ||
| * Test that writeBytes with isReady returning false eventually triggers onWritePossible. | ||
| */ | ||
| @Test | ||
| public void writeBytes_isReadyBecomesFalse_triggersOnWritePossible() throws IOException { | ||
| AtomicBoolean isReady = new AtomicBoolean(true); | ||
| List<String> actions = new ArrayList<>(); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> { | ||
| actions.add("write"); | ||
| }; | ||
|
|
||
| ActionItem flushAction = () -> { | ||
| actions.add("flush"); | ||
| }; | ||
|
|
||
| ActionItem completeAction = () -> {}; | ||
|
|
||
| BooleanSupplier isReadySupplier = () -> { | ||
| return isReady.get(); | ||
| }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter(writeAction, flushAction, completeAction, isReadySupplier, new Log() {}); | ||
|
|
||
| // Initial onWritePossible | ||
| writer.onWritePossible(); | ||
|
|
||
| // First write - isReady is true | ||
| byte[] data1 = new byte[]{1}; | ||
| writer.writeBytes(data1, 1); | ||
|
|
||
| // Simulate isReady becoming false (Tomcat calls onWritePossible when ready) | ||
| isReady.set(false); | ||
| writer.onWritePossible(); | ||
|
|
||
| // Second write after isReady returns to true | ||
| isReady.set(true); | ||
| byte[] data2 = new byte[]{2}; | ||
| writer.writeBytes(data2, 1); | ||
|
|
||
| assertEquals("Two writes should complete", 2, actions.size()); | ||
| assertEquals("write", actions.get(0)); | ||
| assertEquals("write", actions.get(1)); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compiler flags AtomicInteger because you are using it for a variable that is technically only being used by a single thread in this specific test scope. Error Prone's [UnnecessaryAsync]
check suggests using a non-concurrent type to reduce verbosity and overhead.
However, since you are inside a JUnit test and need to increment a counter inside a lambda (which requires variables to be "effectively final"), a simple int won't work.
The idiomatic way to satisfy both Error Prone and the "effectively final" constraint in gRPC tests is to use a single-element primitive array (e.g., int[]) instead of an AtomicInteger.