#19247

Committed 24 May 2024 06:28PM UTC coverage: 88.484% (+0.03%) from 88.451%

Build # #19247

Build Type

push

github

Committed by

ejona86

Commit Message

api: Add ClientStreamTracer.inboundHeaders(Metadata)

This will be used by the metadata exchange of CSM. When recording
per-attempt metrics, we really need per-attempt data and can't leverage
ClientInterceptors.

Run Details

32062 of 36235 relevant lines covered (88.48%)

0.88 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.37

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

/*
 * Copyright 2017 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;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.base.MoreObjects;
import javax.annotation.concurrent.ThreadSafe;

/**
 * {@link StreamTracer} for the client-side.
 */
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861")
@ThreadSafe
public abstract class ClientStreamTracer extends StreamTracer {
  /**
   * Indicates how long the call was delayed, in nanoseconds, due to waiting for name resolution
   * result. If the call option is not set, the call did not experience name resolution delay.
   */
  public static final CallOptions.Key<Long> NAME_RESOLUTION_DELAYED =
      CallOptions.Key.create("io.grpc.ClientStreamTracer.NAME_RESOLUTION_DELAYED");

  /**
   * The stream is being created on a ready transport.
   *
   * @param headers the mutable initial metadata. Modifications to it will be sent to the socket but
   *     not be seen by client interceptors and the application.
   *
   * @since 1.40.0
   */
  public void streamCreated(@Grpc.TransportAttr Attributes transportAttrs, Metadata headers) {
  }

  /**
   * Name resolution is completed and the connection starts getting established. This method is only
   * invoked on the streams that encounter such delay.
   *
   * </p>gRPC buffers the client call if the remote address and configurations, e.g. timeouts and
   * retry policy, are not ready. Asynchronously gRPC internally does the name resolution to get
   * this information. The streams that are processed immediately on ready transports by the time
   * the RPC comes do not go through the pending process, thus this callback will not be invoked.
   */
  public void createPendingStream() {
  }

  /**
   * Headers has been sent to the socket.
   */
  public void outboundHeaders() {
  }

  /**
   * Headers has been received from the server.
   */
  public void inboundHeaders() {
  }

  /**
   * Headers has been received from the server. This method does not pass ownership to {@code
   * headers}, so implementations must not access the metadata after returning. Modifications to the
   * metadata within this method will be seen by interceptors and the application.
   *
   * @param headers the received header metadata
   */
  public void inboundHeaders(Metadata headers) {
    inboundHeaders();
  }

  /**
   * Trailing metadata has been received from the server. This method does not pass ownership to
   * {@code trailers}, so implementations must not access the metadata after returning.
   * Modifications to the metadata within this method will be seen by interceptors and the
   * application.
   *
   * @param trailers the received trailing metadata
   * @since 1.17.0
   */
  public void inboundTrailers(Metadata trailers) {
  }

  /**
   * Information providing context to the call became available.
   */
  @Internal
  public void addOptionalLabel(String key, String value) {
  }

  /**
   * Factory class for {@link ClientStreamTracer}.
   */
  public abstract static class Factory {
    /**
     * Creates a {@link ClientStreamTracer} for a new client stream.  This is called inside the
     * transport when it's creating the stream.
     *
     * @param info information about the stream
     * @param headers the mutable headers of the stream. It can be safely mutated within this
     *        method.  Changes made to it will be sent by the stream.  It should not be saved
     *        because it is not safe for read or write after the method returns.
     *
     * @since 1.20.0
     */
    public ClientStreamTracer newClientStreamTracer(StreamInfo info, Metadata headers) {
      throw new UnsupportedOperationException("Not implemented");
    }
  }

  /**
   * Information about a stream.
   *
   * <p>Note this class doesn't override {@code equals()} and {@code hashCode}, as is the case for
   * {@link CallOptions}.
   *
   * @since 1.20.0
   */
  @ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861")
  public static final class StreamInfo {
    private final CallOptions callOptions;
    private final int previousAttempts;
    private final boolean isTransparentRetry;

    StreamInfo(
        CallOptions callOptions, int previousAttempts, boolean isTransparentRetry) {
      this.callOptions = checkNotNull(callOptions, "callOptions");
      this.previousAttempts = previousAttempts;
      this.isTransparentRetry = isTransparentRetry;
    }

    /**
     * Returns the effective CallOptions of the call.
     */
    public CallOptions getCallOptions() {
      return callOptions;
    }

    /**
     * Returns the number of preceding attempts for the RPC.
     *
     * @since 1.40.0
     */
    public int getPreviousAttempts() {
      return previousAttempts;
    }

    /**
     * Whether the stream is a transparent retry.
     *
     * @since 1.40.0
     */
    public boolean isTransparentRetry() {
      return isTransparentRetry;
    }

    /**
     * Converts this StreamInfo into a new Builder.
     *
     * @since 1.21.0
     */
    public Builder toBuilder() {
      return new Builder()
          .setCallOptions(callOptions)
          .setPreviousAttempts(previousAttempts)
          .setIsTransparentRetry(isTransparentRetry);
    }

    /**
     * Creates an empty Builder.
     *
     * @since 1.21.0
     */
    public static Builder newBuilder() {
      return new Builder();
    }

    @Override
    public String toString() {
      return MoreObjects.toStringHelper(this)
          .add("callOptions", callOptions)
          .add("previousAttempts", previousAttempts)
          .add("isTransparentRetry", isTransparentRetry)
          .toString();
    }

    /**
     * Builds {@link StreamInfo} objects.
     *
     * @since 1.21.0
     */
    public static final class Builder {
      private CallOptions callOptions = CallOptions.DEFAULT;
      private int previousAttempts;
      private boolean isTransparentRetry;

      Builder() {
      }

      /**
       * Sets the effective CallOptions of the call.  This field is optional.
       */
      public Builder setCallOptions(CallOptions callOptions) {
        this.callOptions = checkNotNull(callOptions, "callOptions cannot be null");
        return this;
      }

      /**
       * Set the number of preceding attempts of the RPC.
       *
       * @since 1.40.0
       */
      public Builder setPreviousAttempts(int previousAttempts) {
        this.previousAttempts = previousAttempts;
        return this;
      }

      /**
       * Sets whether the stream is a transparent retry.
       *
       * @since 1.40.0
       */
      public Builder setIsTransparentRetry(boolean isTransparentRetry) {
        this.isTransparentRetry = isTransparentRetry;
        return this;
      }

      /**
       * Builds a new StreamInfo.
       */
      public StreamInfo build() {
        return new StreamInfo(callOptions, previousAttempts, isTransparentRetry);
      }
    }
  }
}

1	/*
2	* Copyright 2017 The gRPC Authors
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package io.grpc;
18
19	import static com.google.common.base.Preconditions.checkNotNull;
20
21	import com.google.common.base.MoreObjects;
22	import javax.annotation.concurrent.ThreadSafe;
23
24	/**
25	* {@link StreamTracer} for the client-side.
26	*/
27	@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861")
28	@ThreadSafe
29	public abstract class ClientStreamTracer extends StreamTracer {	1✔
30	/**
31	* Indicates how long the call was delayed, in nanoseconds, due to waiting for name resolution
32	* result. If the call option is not set, the call did not experience name resolution delay.
33	*/
34	public static final CallOptions.Key<Long> NAME_RESOLUTION_DELAYED =	1✔
35	CallOptions.Key.create("io.grpc.ClientStreamTracer.NAME_RESOLUTION_DELAYED");	1✔
36
37	/**
38	* The stream is being created on a ready transport.
39	*
40	* @param headers the mutable initial metadata. Modifications to it will be sent to the socket but
41	* not be seen by client interceptors and the application.
42	*
43	* @since 1.40.0
44	*/
45	public void streamCreated(@Grpc.TransportAttr Attributes transportAttrs, Metadata headers) {
46	}	1✔
47
48	/**
49	* Name resolution is completed and the connection starts getting established. This method is only
50	* invoked on the streams that encounter such delay.
51	*
52	* </p>gRPC buffers the client call if the remote address and configurations, e.g. timeouts and
53	* retry policy, are not ready. Asynchronously gRPC internally does the name resolution to get
54	* this information. The streams that are processed immediately on ready transports by the time
55	* the RPC comes do not go through the pending process, thus this callback will not be invoked.
56	*/
57	public void createPendingStream() {
58	}	1✔
59
60	/**
61	* Headers has been sent to the socket.
62	*/
63	public void outboundHeaders() {
64	}	1✔
65
66	/**
67	* Headers has been received from the server.
68	*/
69	public void inboundHeaders() {
70	}	1✔
71
72	/**
73	* Headers has been received from the server. This method does not pass ownership to {@code
74	* headers}, so implementations must not access the metadata after returning. Modifications to the
75	* metadata within this method will be seen by interceptors and the application.
76	*
77	* @param headers the received header metadata
78	*/
79	public void inboundHeaders(Metadata headers) {
80	inboundHeaders();	1✔
81	}	1✔
82
83	/**
84	* Trailing metadata has been received from the server. This method does not pass ownership to
85	* {@code trailers}, so implementations must not access the metadata after returning.
86	* Modifications to the metadata within this method will be seen by interceptors and the
87	* application.
88	*
89	* @param trailers the received trailing metadata
90	* @since 1.17.0
91	*/
92	public void inboundTrailers(Metadata trailers) {
93	}	1✔
94
95	/**
96	* Information providing context to the call became available.
97	*/
98	@Internal
99	public void addOptionalLabel(String key, String value) {
100	}	1✔
101
102	/**
103	* Factory class for {@link ClientStreamTracer}.
104	*/
105	public abstract static class Factory {	1✔
106	/**
107	* Creates a {@link ClientStreamTracer} for a new client stream. This is called inside the
108	* transport when it's creating the stream.
109	*
110	* @param info information about the stream
111	* @param headers the mutable headers of the stream. It can be safely mutated within this
112	* method. Changes made to it will be sent by the stream. It should not be saved
113	* because it is not safe for read or write after the method returns.
114	*
115	* @since 1.20.0
116	*/
117	public ClientStreamTracer newClientStreamTracer(StreamInfo info, Metadata headers) {
118	throw new UnsupportedOperationException("Not implemented");	×
119	}
120	}
121
122	/**
123	* Information about a stream.
124	*
125	* <p>Note this class doesn't override {@code equals()} and {@code hashCode}, as is the case for
126	* {@link CallOptions}.
127	*
128	* @since 1.20.0
129	*/
130	@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861")
131	public static final class StreamInfo {
132	private final CallOptions callOptions;
133	private final int previousAttempts;
134	private final boolean isTransparentRetry;
135
136	StreamInfo(
137	CallOptions callOptions, int previousAttempts, boolean isTransparentRetry) {	1✔
138	this.callOptions = checkNotNull(callOptions, "callOptions");	1✔
139	this.previousAttempts = previousAttempts;	1✔
140	this.isTransparentRetry = isTransparentRetry;	1✔
141	}	1✔
142
143	/**
144	* Returns the effective CallOptions of the call.
145	*/
146	public CallOptions getCallOptions() {
147	return callOptions;	1✔
148	}
149
150	/**
151	* Returns the number of preceding attempts for the RPC.
152	*
153	* @since 1.40.0
154	*/
155	public int getPreviousAttempts() {
156	return previousAttempts;	1✔
157	}
158
159	/**
160	* Whether the stream is a transparent retry.
161	*
162	* @since 1.40.0
163	*/
164	public boolean isTransparentRetry() {
165	return isTransparentRetry;	1✔
166	}
167
168	/**
169	* Converts this StreamInfo into a new Builder.
170	*
171	* @since 1.21.0
172	*/
173	public Builder toBuilder() {
174	return new Builder()	1✔
175	.setCallOptions(callOptions)	1✔
176	.setPreviousAttempts(previousAttempts)	1✔
177	.setIsTransparentRetry(isTransparentRetry);	1✔
178	}
179
180	/**
181	* Creates an empty Builder.
182	*
183	* @since 1.21.0
184	*/
185	public static Builder newBuilder() {
186	return new Builder();	1✔
187	}
188
189	@Override
190	public String toString() {
191	return MoreObjects.toStringHelper(this)	×
192	.add("callOptions", callOptions)	×
193	.add("previousAttempts", previousAttempts)	×
194	.add("isTransparentRetry", isTransparentRetry)	×
195	.toString();	×
196	}
197
198	/**
199	* Builds {@link StreamInfo} objects.
200	*
201	* @since 1.21.0
202	*/
203	public static final class Builder {
204	private CallOptions callOptions = CallOptions.DEFAULT;	1✔
205	private int previousAttempts;
206	private boolean isTransparentRetry;
207
208	Builder() {	1✔
209	}	1✔
210
211	/**
212	* Sets the effective CallOptions of the call. This field is optional.
213	*/
214	public Builder setCallOptions(CallOptions callOptions) {
215	this.callOptions = checkNotNull(callOptions, "callOptions cannot be null");	1✔
216	return this;	1✔
217	}
218
219	/**
220	* Set the number of preceding attempts of the RPC.
221	*
222	* @since 1.40.0
223	*/
224	public Builder setPreviousAttempts(int previousAttempts) {
225	this.previousAttempts = previousAttempts;	1✔
226	return this;	1✔
227	}
228
229	/**
230	* Sets whether the stream is a transparent retry.
231	*
232	* @since 1.40.0
233	*/
234	public Builder setIsTransparentRetry(boolean isTransparentRetry) {
235	this.isTransparentRetry = isTransparentRetry;	1✔
236	return this;	1✔
237	}
238
239	/**
240	* Builds a new StreamInfo.
241	*/
242	public StreamInfo build() {
243	return new StreamInfo(callOptions, previousAttempts, isTransparentRetry);	1✔
244	}
245	}
246	}
247	}

grpc / grpc-java / #19247

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous