-
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
25
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.
+338
−12
Open
Changes from all commits
Commits
Show all changes
25 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 ccb13ee
Fix flush test per Copilot review
mgustimz 1a07b84
servlet: fix flush test assertion to account for buffered writeBytes
mgustimz 5ec98e1
servlet: fix comment and add test for consecutive flush behavior
mgustimz 7924aae
fix(servlet): address review comments in AsyncServletOutputStreamWriter
mgustimz ca8408e
fix(servlet): update log message for clarity and improve test imports
mgustimz 512680b
fix(servlet): correct unpark placement and format action items in tests
mgustimz 09c4a02
fix(servlet): reorder checkState calls and improve log message for wr…
mgustimz 7ffb701
Merge branch 'grpc:master' into fix/12723-servlet-clean
mgustimz 33b5258
servlet: avoid Tomcat write stall when still ready
mgustimz 8b68f2b
servlet: preserve Undertow direct write flow
mgustimz 835a5de
servlet: improve writer test coverage
mgustimz dfe0f33
servlet: cover writer race recovery paths
mgustimz e600550
servlet: fix reflective rethrow in writer test
mgustimz 6c6a2e4
servlet: fix writer test import order
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
Some comments aren't visible on the classic Files Changed page.
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
312 changes: 312 additions & 0 deletions
312
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,312 @@ | ||
| /* | ||
| * 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.assertThrows; | ||
|
|
||
| import io.grpc.servlet.AsyncServletOutputStreamWriter.ActionItem; | ||
| import io.grpc.servlet.AsyncServletOutputStreamWriter.Log; | ||
| import java.io.IOException; | ||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.concurrent.ConcurrentLinkedQueue; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import java.util.function.BiFunction; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| /** Unit test for {@link AsyncServletOutputStreamWriter} with a mock isReady supplier. */ | ||
| @RunWith(JUnit4.class) | ||
| public class AsyncServletOutputStreamWriterTest { | ||
|
|
||
| @Test | ||
| public void writeBytes_notReadyException_buffersUntilOnWritePossible() throws IOException { | ||
| List<String> actions = new ArrayList<>(); | ||
| AtomicBoolean rejectWrites = new AtomicBoolean(true); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> { | ||
| if (rejectWrites.get()) { | ||
| throw new IllegalStateException("not ready"); | ||
| } | ||
| actions.add("write"); | ||
| }; | ||
| ActionItem flushAction = () -> { }; | ||
| ActionItem completeAction = () -> { }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| writeAction, flushAction, completeAction, () -> true, new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| writer.writeBytes(new byte[]{1}, 1); | ||
|
|
||
| assertEquals("Write should be buffered until onWritePossible", 0, actions.size()); | ||
|
|
||
| rejectWrites.set(false); | ||
| writer.onWritePossible(); | ||
| assertEquals("Buffered write should drain after onWritePossible", 1, actions.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void writeBytes_consecutiveWithIsReadyTrue_allGoDirect() throws IOException { | ||
| List<byte[]> writtenData = new ArrayList<>(); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> writtenData.add(Arrays.copyOf(bytes, numBytes)); | ||
| ActionItem flushAction = () -> { }; | ||
| ActionItem completeAction = () -> { }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| writeAction, flushAction, completeAction, () -> true, new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| for (int i = 0; i < 5; i++) { | ||
| writer.writeBytes(new byte[]{(byte) i}, 1); | ||
| } | ||
|
|
||
| assertEquals("All writes should complete", 5, writtenData.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void writeBytes_isReadyFalseAfterWrite_buffersNextWrite() throws IOException { | ||
| List<byte[]> writtenData = new ArrayList<>(); | ||
| AtomicBoolean isReady = new AtomicBoolean(true); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> { | ||
| writtenData.add(Arrays.copyOf(bytes, numBytes)); | ||
| isReady.set(false); | ||
| }; | ||
| ActionItem flushAction = () -> { }; | ||
| ActionItem completeAction = () -> { }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| writeAction, flushAction, completeAction, isReady::get, new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| writer.writeBytes(new byte[]{1}, 1); | ||
| writer.writeBytes(new byte[]{2}, 1); | ||
| assertEquals("Second write should be buffered", 1, writtenData.size()); | ||
|
|
||
| isReady.set(true); | ||
| writer.onWritePossible(); | ||
| assertEquals("Buffered write should drain", 2, writtenData.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void flush_isReadyFalse_buffersUntilOnWritePossible() throws IOException { | ||
| List<String> actions = new ArrayList<>(); | ||
| AtomicBoolean isReady = new AtomicBoolean(true); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> actions.add("write"); | ||
| ActionItem flushAction = () -> { | ||
| actions.add("flush"); | ||
| isReady.set(false); | ||
| }; | ||
| ActionItem completeAction = () -> { }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| writeAction, flushAction, completeAction, isReady::get, new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| writer.flush(); | ||
| assertEquals("First flush should execute directly", 1, actions.size()); | ||
|
|
||
| writer.flush(); | ||
| assertEquals("Second flush should be buffered", 1, actions.size()); | ||
|
|
||
| isReady.set(true); | ||
| writer.onWritePossible(); | ||
| assertEquals("Both flushes should complete after onWritePossible", 2, actions.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void flush_consecutiveWithIsReadyTrue_bothGoDirect() throws IOException { | ||
| List<String> actions = new ArrayList<>(); | ||
|
|
||
| BiFunction<byte[], Integer, ActionItem> writeAction = | ||
| (bytes, numBytes) -> () -> actions.add("write"); | ||
| ActionItem flushAction = () -> actions.add("flush"); | ||
| ActionItem completeAction = () -> { }; | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| writeAction, flushAction, completeAction, () -> true, new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| writer.flush(); | ||
| writer.flush(); | ||
|
|
||
| assertEquals("Both flushes should execute directly", 2, actions.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void complete_readyAndDrained_runsDirectly() throws IOException { | ||
| AtomicInteger completeCount = new AtomicInteger(); | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| (bytes, numBytes) -> () -> { }, | ||
| () -> { }, | ||
| completeCount::incrementAndGet, | ||
| () -> true, | ||
| new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| writer.complete(); | ||
|
|
||
| assertEquals(1, completeCount.get()); | ||
| } | ||
|
|
||
| @Test | ||
| public void complete_notReadyAndDrained_buffersUntilOnWritePossible() throws IOException { | ||
| AtomicInteger completeCount = new AtomicInteger(); | ||
|
|
||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| (bytes, numBytes) -> () -> { }, | ||
| () -> { }, | ||
| completeCount::incrementAndGet, | ||
| () -> true, | ||
| new Log() {}); | ||
|
|
||
| writer.complete(); | ||
| assertEquals(0, completeCount.get()); | ||
|
|
||
| writer.onWritePossible(); | ||
| assertEquals(1, completeCount.get()); | ||
| } | ||
|
|
||
| @Test | ||
| public void writeBytes_onWritePossibleWinsRace_drainsBufferedWrite() throws Exception { | ||
| List<String> actions = new ArrayList<>(); | ||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| (bytes, numBytes) -> () -> actions.add("write"), | ||
| () -> { | ||
| }, | ||
| () -> { | ||
| }, | ||
| () -> true, | ||
| new Log() { | ||
| }); | ||
| replaceWriteChain(writer, new ConcurrentLinkedQueue<ActionItem>() { | ||
| @Override | ||
| public boolean offer(ActionItem actionItem) { | ||
| boolean offered = super.offer(actionItem); | ||
| try { | ||
| writer.onWritePossible(); | ||
| } catch (IOException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| return offered; | ||
| } | ||
| }); | ||
|
|
||
| writer.writeBytes(new byte[]{1}, 1); | ||
|
|
||
| assertEquals(1, actions.size()); | ||
| } | ||
|
|
||
| @Test | ||
| public void writeBytes_readyStateWinsRace_retriesWrite() throws Exception { | ||
| List<String> actions = new ArrayList<>(); | ||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| (bytes, numBytes) -> () -> actions.add("write"), | ||
| () -> { | ||
| }, | ||
| () -> { | ||
| }, | ||
| () -> true, | ||
| new Log() { | ||
| }); | ||
| replaceWriteChain(writer, new ConcurrentLinkedQueue<ActionItem>() { | ||
| @Override | ||
| public boolean offer(ActionItem actionItem) { | ||
| boolean offered = super.offer(actionItem); | ||
| try { | ||
| forceReadyAndDrained(writer); | ||
| } catch (ReflectiveOperationException e) { | ||
| throw new LinkageError(e.getMessage(), e); | ||
| } | ||
| return offered; | ||
| } | ||
| }); | ||
|
|
||
| writer.writeBytes(new byte[]{1}, 1); | ||
|
|
||
| assertEquals(1, actions.size()); | ||
| } | ||
|
|
||
| private static void replaceWriteChain( | ||
| AsyncServletOutputStreamWriter writer, ConcurrentLinkedQueue<ActionItem> writeChain) | ||
| throws ReflectiveOperationException { | ||
| Field writeChainField = AsyncServletOutputStreamWriter.class.getDeclaredField("writeChain"); | ||
| writeChainField.setAccessible(true); | ||
| writeChainField.set(writer, writeChain); | ||
| } | ||
|
|
||
| private static void forceReadyAndDrained(AsyncServletOutputStreamWriter writer) | ||
| throws ReflectiveOperationException { | ||
| Field writeStateField = AsyncServletOutputStreamWriter.class.getDeclaredField("writeState"); | ||
| writeStateField.setAccessible(true); | ||
| @SuppressWarnings("unchecked") | ||
| AtomicReference<Object> writeState = | ||
| (AtomicReference<Object>) writeStateField.get(writer); | ||
| Object curState = writeState.get(); | ||
| Method withReadyAndDrained = curState.getClass().getDeclaredMethod( | ||
| "withReadyAndDrained", boolean.class); | ||
| withReadyAndDrained.setAccessible(true); | ||
| writeState.set(withReadyAndDrained.invoke(curState, true)); | ||
| } | ||
|
|
||
| @Test | ||
| public void flush_notReadyException_isPropagated() throws IOException { | ||
| AsyncServletOutputStreamWriter writer = | ||
| new AsyncServletOutputStreamWriter( | ||
| (bytes, numBytes) -> () -> { }, | ||
| () -> { | ||
| throw new IllegalStateException("not ready"); | ||
| }, | ||
| () -> { }, | ||
| () -> true, | ||
| new Log() {}); | ||
|
|
||
| writer.onWritePossible(); | ||
|
|
||
| assertThrows(IllegalStateException.class, writer::flush); | ||
| } | ||
| } | ||
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.