Skip to content

Commit 1084e97

Browse files
authored
okhttp: reset stream when trailers arrive with END_STREAM unsent (grpc#13084)
This is the OkHttp counterpart of netty's grpc#13078 and ba0aab4.
1 parent cf50cf8 commit 1084e97

2 files changed

Lines changed: 52 additions & 1 deletion

File tree

‎okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ public void transportDataReceived(okio.Buffer frame, boolean endOfStream, int pa
343343

344344
@GuardedBy("lock")
345345
private void onEndOfStream() {
346-
if (!isOutboundClosed()) {
346+
if (!isOutboundClosed() || outboundFlowState.hasPendingData()) {
347347
// If server's end-of-stream is received before client sends end-of-stream, we just send a
348348
// reset to server to fully close the server side stream.
349349
transport.finishStream(id(),null, PROCESSED, false, ErrorCode.CANCEL, null);

‎okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,6 +1007,57 @@ public void outboundFlowControl() throws Exception {
10071007
shutdownAndVerify();
10081008
}
10091009

1010+
/**
1011+
* The server closes the call while the client's END_STREAM is still queued in the outbound flow
1012+
* controller. That END_STREAM will never be written, so the client must reset the stream;
1013+
* otherwise the server never sees the stream close.
1014+
*/
1015+
@Test
1016+
public void serverClosesWhileEndOfStreamBlockedByFlowControl_sendsReset() throws Exception {
1017+
initTransport();
1018+
MockStreamListener listener = new MockStreamListener();
1019+
ClientStream stream =
1020+
clientTransport.newStream(method, new Metadata(), CallOptions.DEFAULT, tracers);
1021+
stream.start(listener);
1022+
1023+
// Larger than the outbound window, so the tail of the message stays queued.
1024+
stream.writeMessage(new ByteArrayInputStream(new byte[INITIAL_WINDOW_SIZE]));
1025+
stream.flush();
1026+
verify(frameWriter, timeout(TIME_OUT_MS))
1027+
.data(eq(false), eq(3), any(Buffer.class), eq(INITIAL_WINDOW_SIZE));
1028+
// END_STREAM is queued behind the tail.
1029+
stream.halfClose();
1030+
1031+
frameHandler().headers(true, true, 3, 0, grpcResponseTrailers(), HeadersMode.HTTP_20_HEADERS);
1032+
listener.waitUntilStreamClosed();
1033+
1034+
assertEquals(Status.Code.OK, listener.status.getCode());
1035+
verify(frameWriter, timeout(TIME_OUT_MS)).rstStream(eq(3), eq(ErrorCode.CANCEL));
1036+
verify(frameWriter, never()).data(eq(true), eq(3), any(Buffer.class), anyInt());
1037+
shutdownAndVerify();
1038+
}
1039+
1040+
@Test
1041+
public void serverClosesAfterEndOfStreamSent_noReset() throws Exception {
1042+
initTransport();
1043+
MockStreamListener listener = new MockStreamListener();
1044+
ClientStream stream =
1045+
clientTransport.newStream(method, new Metadata(), CallOptions.DEFAULT, tracers);
1046+
stream.start(listener);
1047+
1048+
stream.writeMessage(new ByteArrayInputStream(new byte[10]));
1049+
stream.halfClose();
1050+
verify(frameWriter, timeout(TIME_OUT_MS))
1051+
.data(eq(true), eq(3), any(Buffer.class), eq(10 + HEADER_LENGTH));
1052+
1053+
frameHandler().headers(true, true, 3, 0, grpcResponseTrailers(), HeadersMode.HTTP_20_HEADERS);
1054+
listener.waitUntilStreamClosed();
1055+
1056+
assertEquals(Status.Code.OK, listener.status.getCode());
1057+
verify(frameWriter, never()).rstStream(eq(3), any(ErrorCode.class));
1058+
shutdownAndVerify();
1059+
}
1060+
10101061
/**
10111062
* Outbound flow control where the initial window size is reduced before a stream is started.
10121063
*/

0 commit comments

Comments
 (0)