Skip to content

Commit e31361f

Browse files
authored
core: rename headersSent to outboundHeaders. (#2922)
This is a partial backport of #2921 into v1.3.x The addition of inboundHeaders is not backported as it turns out to be non-trivial as OkHttp is still on AbstractClientStream on v1.3.x while has switched to AbstractClientStream2 on master.
1 parent d5e3d5b commit e31361f

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

core/src/main/java/io/grpc/ClientStreamTracer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public abstract class ClientStreamTracer extends StreamTracer {
4242
/**
4343
* Headers has been sent to the socket.
4444
*/
45-
public void headersSent() {
45+
public void outboundHeaders() {
4646
}
4747

4848
/**

core/src/main/java/io/grpc/internal/StatsTraceContext.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ public List<StreamTracer> getTracersForTest() {
103103
}
104104

105105
/**
106-
* See {@link ClientStreamTracer#headersSent}. For client-side only.
106+
* See {@link ClientStreamTracer#outboundHeaders}. For client-side only.
107107
*/
108-
public void clientHeadersSent() {
108+
public void clientOutboundHeaders() {
109109
for (StreamTracer tracer : tracers) {
110-
((ClientStreamTracer) tracer).headersSent();
110+
((ClientStreamTracer) tracer).outboundHeaders();
111111
}
112112
}
113113

core/src/test/java/io/grpc/internal/CensusStreamTracerModuleTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ public void clientBasicStats() {
191191
ClientStreamTracer tracer = callTracer.newClientStreamTracer(headers);
192192

193193
fakeClock.forwardTime(30, MILLISECONDS);
194-
tracer.headersSent();
194+
tracer.outboundHeaders();
195195

196196
fakeClock.forwardTime(100, MILLISECONDS);
197197
tracer.outboundWireSize(1028);

interop-testing/src/main/java/io/grpc/testing/integration/AbstractInteropTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1448,7 +1448,7 @@ private void assertClientMetrics(String method, Status.Code status,
14481448
// Tracer-based stats
14491449
ClientStreamTracer tracer = clientStreamTracers.poll();
14501450
assertNotNull(tracer);
1451-
verify(tracer).headersSent();
1451+
verify(tracer).outboundHeaders();
14521452
ArgumentCaptor<Status> statusCaptor = ArgumentCaptor.forClass(Status.class);
14531453
// assertClientMetrics() is called right after application receives status,
14541454
// but streamClosed() may be called slightly later than that. So we need a timeout.

netty/src/main/java/io/grpc/netty/NettyClientHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ public void operationComplete(ChannelFuture future) throws Exception {
432432
// was canceled via RST_STREAM.
433433
Http2Stream http2Stream = connection().stream(streamId);
434434
if (http2Stream != null) {
435-
stream.getStatsTraceContext().clientHeadersSent();
435+
stream.getStatsTraceContext().clientOutboundHeaders();
436436
http2Stream.setProperty(streamKey, stream);
437437

438438
// Attach the client stream to the HTTP/2 stream object as user data.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ public void start(int id) {
162162
if (pendingData != null) {
163163
// Only happens when the stream has neither been started nor cancelled.
164164
frameWriter.synStream(false, false, id, 0, requestHeaders);
165-
statsTraceCtx.clientHeadersSent();
165+
statsTraceCtx.clientOutboundHeaders();
166166
requestHeaders = null;
167167

168168
boolean flush = false;

testing/src/main/java/io/grpc/internal/testing/AbstractTransportTest.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ public void basicStream() throws Exception {
661661
StreamCreation serverStreamCreation
662662
= serverTransportListener.takeStreamOrFail(TIMEOUT_MS, TimeUnit.MILLISECONDS);
663663
if (metricsExpected()) {
664-
clientInOrder.verify(clientStreamTracer).headersSent();
664+
clientInOrder.verify(clientStreamTracer).outboundHeaders();
665665
}
666666
assertEquals(methodDescriptor.getFullMethodName(), serverStreamCreation.method);
667667
assertEquals(Lists.newArrayList(clientHeadersCopy.getAll(asciiKey)),
@@ -817,7 +817,7 @@ public void zeroMessageStream() throws Exception {
817817
assertEquals(status.getCode(), statusCaptor.getValue().getCode());
818818
assertEquals(status.getDescription(), statusCaptor.getValue().getDescription());
819819
if (metricsExpected()) {
820-
verify(clientStreamTracer).headersSent();
820+
verify(clientStreamTracer).outboundHeaders();
821821
verify(clientStreamTracer).streamClosed(same(statusCaptor.getValue()));
822822
verify(serverStreamTracer).streamClosed(same(status));
823823
verifyNoMoreInteractions(clientStreamTracer);
@@ -854,7 +854,7 @@ public void earlyServerClose_withServerHeaders() throws Exception {
854854
assertEquals("Hello. Goodbye.", statusCaptor.getValue().getDescription());
855855
assertNull(statusCaptor.getValue().getCause());
856856
if (metricsExpected()) {
857-
verify(clientStreamTracer).headersSent();
857+
verify(clientStreamTracer).outboundHeaders();
858858
verify(clientStreamTracer).streamClosed(same(statusCaptor.getValue()));
859859
verify(serverStreamTracer).streamClosed(same(status));
860860
verifyNoMoreInteractions(clientStreamTracer);
@@ -898,7 +898,7 @@ public void earlyServerClose_noServerHeaders() throws Exception {
898898
assertEquals(Lists.newArrayList(trailers.getAll(binaryKey)),
899899
Lists.newArrayList(metadataCaptor.getValue().getAll(binaryKey)));
900900
if (metricsExpected()) {
901-
verify(clientStreamTracer).headersSent();
901+
verify(clientStreamTracer).outboundHeaders();
902902
verify(clientStreamTracer).streamClosed(same(statusCaptor.getValue()));
903903
verify(serverStreamTracer).streamClosed(same(status));
904904
verifyNoMoreInteractions(clientStreamTracer);
@@ -933,7 +933,7 @@ public void earlyServerClose_serverFailure() throws Exception {
933933
assertEquals(status.getDescription(), statusCaptor.getValue().getDescription());
934934
assertNull(statusCaptor.getValue().getCause());
935935
if (metricsExpected()) {
936-
verify(clientStreamTracer).headersSent();
936+
verify(clientStreamTracer).outboundHeaders();
937937
verify(clientStreamTracer).streamClosed(same(statusCaptor.getValue()));
938938
verify(serverStreamTracer).streamClosed(same(status));
939939
verifyNoMoreInteractions(clientStreamTracer);
@@ -971,7 +971,7 @@ public void clientCancel() throws Exception {
971971
verify(mockServerStreamListener, never()).closed(any(Status.class));
972972
verify(mockClientStreamListener, never()).closed(any(Status.class), any(Metadata.class));
973973
if (metricsExpected()) {
974-
verify(clientStreamTracer).headersSent();
974+
verify(clientStreamTracer).outboundHeaders();
975975
verify(clientStreamTracer).streamClosed(same(status));
976976
verify(serverStreamTracer).streamClosed(same(statusCaptor.getValue()));
977977
verifyNoMoreInteractions(clientStreamTracer);
@@ -1034,7 +1034,7 @@ public void onReady() {
10341034

10351035
serverStream.close(Status.OK, new Metadata());
10361036
if (metricsExpected()) {
1037-
verify(clientStreamTracer).headersSent();
1037+
verify(clientStreamTracer).outboundHeaders();
10381038
verify(clientStreamTracer).inboundMessage();
10391039
verify(clientStreamTracer).inboundWireSize(anyLong());
10401040
verify(clientStreamTracer, atLeast(1)).inboundUncompressedSize(anyLong());
@@ -1080,7 +1080,7 @@ public void serverCancel() throws Exception {
10801080

10811081
if (metricsExpected()) {
10821082
verify(clientStreamTracerFactory).newClientStreamTracer(any(Metadata.class));
1083-
verify(clientStreamTracer).headersSent();
1083+
verify(clientStreamTracer).outboundHeaders();
10841084
verify(clientStreamTracer).streamClosed(same(statusCaptor.getValue()));
10851085
verify(serverStreamTracerFactory).newServerStreamTracer(anyString(), any(Metadata.class));
10861086
verify(serverStreamTracer).streamClosed(same(status));

0 commit comments

Comments
 (0)