-
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
11
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.
+194
−5
Open
Changes from 6 commits
Commits
Show all changes
11 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 3ebac15
Remove unused AtomicInteger in AsyncServletOutputStreamWriterTest
mgustimz 1ef9eb8
Fix test and log message per Copilot review
mgustimz 3f81019
Split flush and writeBytes into separate branches
mgustimz d79bdb6
Clean up test per Copilot review
mgustimz c73e67a
Add test validating write without onWritePossible is buffered
mgustimz e898755
Address Copilot review items from #4251754607
mgustimz 8c217f5
Replace third test to cover flush-specific behavior
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
127 changes: 127 additions & 0 deletions
127
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,127 @@ | ||
| /* | ||
| * 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 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.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. | ||
| * This tests the Tomcat scenario where isReady() returns true but write() still fails | ||
| * because the previous write hasn't completed internally. | ||
| */ | ||
| @RunWith(JUnit4.class) | ||
| public class AsyncServletOutputStreamWriterTest { | ||
|
|
||
| /** | ||
| * Test that multiple consecutive writes succeed when isReady() always returns true. | ||
| * The container calls onWritePossible() between writes to drain buffered actions. | ||
| * This reproduces the Tomcat fix: writeBytes sets readyAndDrained=false so | ||
| * subsequent writes are buffered, and onWritePossible drains them. | ||
| */ | ||
|
mgustimz marked this conversation as resolved.
|
||
| @Test | ||
| public void writeBytes_alwaysReady_doesNotStall() throws IOException { | ||
| AtomicBoolean isReady = new AtomicBoolean(true); | ||
| List<byte[]> writtenData = new ArrayList<>(); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> { | ||
| writtenData.add(bytes); | ||
| }; | ||
|
|
||
| ActionItem flushAction = () -> {}; | ||
|
|
||
| ActionItem completeAction = () -> {}; | ||
|
|
||
| BooleanSupplier isReadySupplier = () -> isReady.get(); | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter(writeAction, flushAction, completeAction, isReadySupplier, new Log() {}); | ||
|
|
||
| // Initial onWritePossible to start with readyAndDrained=true | ||
| writer.onWritePossible(); | ||
|
|
||
| // Write 5 times. After the first write, readyAndDrained becomes false so subsequent | ||
| // writes are buffered. The container calls onWritePossible() after each write completes | ||
| // internally (isReady stays true), which drains the buffered writes. | ||
|
mgustimz marked this conversation as resolved.
Outdated
|
||
| for (int i = 0; i < 5; i++) { | ||
| byte[] data = new byte[]{(byte) i}; | ||
| writer.writeBytes(data, 1); | ||
| // Simulate container calling onWritePossible after each write completes | ||
| // isReady stays true so onWritePossible drains buffered writes directly | ||
| writer.onWritePossible(); | ||
| } | ||
|
|
||
| // Verify all 5 writes completed | ||
| assertEquals("All writes should complete", 5, writtenData.size()); | ||
| } | ||
|
mgustimz marked this conversation as resolved.
|
||
|
|
||
| /** | ||
| * Test that writeBytes with isReady transitioning from true to false eventually | ||
| * drains via 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 = () -> isReady.get(); | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter(writeAction, flushAction, completeAction, isReadySupplier, new Log() {}); | ||
|
|
||
| // Initial onWritePossible | ||
| writer.onWritePossible(); | ||
|
|
||
| // First write - isReady is true, goes direct, readyAndDrained=false | ||
| byte[] data1 = new byte[]{1}; | ||
| writer.writeBytes(data1, 1); | ||
|
|
||
| // Container calls onWritePossible after first write completes internally | ||
| // isReady is still true but readyAndDrained is false, so buffered writes drain | ||
| writer.onWritePossible(); | ||
|
|
||
|
Comment on lines
+155
to
+167
|
||
| // Second write after isReady returns to true | ||
| isReady.set(true); | ||
| byte[] data2 = new byte[]{2}; | ||
| writer.writeBytes(data2, 1); | ||
|
mgustimz marked this conversation as resolved.
Outdated
|
||
|
|
||
| assertEquals("Two writes should complete", 2, actions.size()); | ||
| } | ||
|
Comment on lines
+126
to
+174
|
||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.