#19982

Committed 16 Sep 2025 03:47AM UTC coverage: 88.57% (+0.009%) from 88.561%

Build # #19982

Build Type

push

github

Committed by

web-flow

Commit Message

servlet: configurable methodNameResolver (#12333)

Introduces configuring a method name resolver in `ServletServerBuilder` for customizing the servlet context root path for request paths.

Run Details

34839 of 39335 relevant lines covered (88.57%)

0.89 hits per line

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

83.87

/../servlet/src/main/java/io/grpc/servlet/ServletAdapter.java

/*
 * Copyright 2018 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 com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static io.grpc.internal.GrpcUtil.TIMEOUT_KEY;
import static java.util.logging.Level.FINE;
import static java.util.logging.Level.FINEST;

import com.google.common.io.BaseEncoding;
import io.grpc.Attributes;
import io.grpc.ExperimentalApi;
import io.grpc.Grpc;
import io.grpc.InternalLogId;
import io.grpc.InternalMetadata;
import io.grpc.Metadata;
import io.grpc.ServerStreamTracer;
import io.grpc.Status;
import io.grpc.internal.GrpcUtil;
import io.grpc.internal.ReadableBuffers;
import io.grpc.internal.ServerTransportListener;
import io.grpc.internal.StatsTraceContext;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.logging.Logger;
import javax.servlet.AsyncContext;
import javax.servlet.AsyncEvent;
import javax.servlet.AsyncListener;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * An adapter that transforms {@link HttpServletRequest} into gRPC request and lets a gRPC server
 * process it, and transforms the gRPC response into {@link HttpServletResponse}. An adapter can be
 * instantiated by {@link ServletServerBuilder#buildServletAdapter()}.
 *
 * <p>In a servlet, calling {@link #doPost(HttpServletRequest, HttpServletResponse)} inside {@link
 * javax.servlet.http.HttpServlet#doPost(HttpServletRequest, HttpServletResponse)} makes the servlet
 * backed by the gRPC server associated with the adapter. The servlet must support Asynchronous
 * Processing and must be deployed to a container that supports servlet 4.0 and enables HTTP/2.
 *
 * <p>The API is experimental. The authors would like to know more about the real usecases. Users
 * are welcome to provide feedback by commenting on
 * <a href=https://github.com/grpc/grpc-java/issues/5066>the tracking issue</a>.
 */
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/5066")
public final class ServletAdapter {

  static final Logger logger = Logger.getLogger(ServletAdapter.class.getName());
  static final Function<HttpServletRequest, String> DEFAULT_METHOD_NAME_RESOLVER =
          req -> req.getRequestURI().substring(1); // remove the leading "/"

  private final ServerTransportListener transportListener;
  private final List<? extends ServerStreamTracer.Factory> streamTracerFactories;
  private final Function<HttpServletRequest, String> methodNameResolver;
  private final int maxInboundMessageSize;
  private final Attributes attributes;

  ServletAdapter(
      ServerTransportListener transportListener,
      List<? extends ServerStreamTracer.Factory> streamTracerFactories,
      Function<HttpServletRequest, String> methodNameResolver,
      int maxInboundMessageSize) {
    this.transportListener = transportListener;
    this.streamTracerFactories = streamTracerFactories;
    this.methodNameResolver = methodNameResolver;
    this.maxInboundMessageSize = maxInboundMessageSize;
    attributes = transportListener.transportReady(Attributes.EMPTY);
  }

  /**
   * Call this method inside {@link javax.servlet.http.HttpServlet#doGet(HttpServletRequest,
   * HttpServletResponse)} to serve gRPC GET request.
   *
   * <p>This method is currently not implemented.
   *
   * <p>Note that in rare case gRPC client sends GET requests.
   *
   * <p>Do not modify {@code req} and {@code resp} before or after calling this method. However,
   * calling {@code resp.setBufferSize()} before invocation is allowed.
   */
  public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "GET method not supported");
  }

  /**
   * Call this method inside {@link javax.servlet.http.HttpServlet#doPost(HttpServletRequest,
   * HttpServletResponse)} to serve gRPC POST request.
   *
   * <p>Do not modify {@code req} and {@code resp} before or after calling this method. However,
   * calling {@code resp.setBufferSize()} before invocation is allowed.
   */
  public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    checkArgument(req.isAsyncSupported(), "servlet does not support asynchronous operation");
    checkArgument(ServletAdapter.isGrpc(req), "the request is not a gRPC request");

    InternalLogId logId = InternalLogId.allocate(ServletAdapter.class, null);
    logger.log(FINE, "[{0}] RPC started", logId);

    AsyncContext asyncCtx = req.startAsync(req, resp);

    String method = methodNameResolver.apply(req);
    Metadata headers = getHeaders(req);

    if (logger.isLoggable(FINEST)) {
      logger.log(FINEST, "[{0}] method: {1}", new Object[] {logId, method});
      logger.log(FINEST, "[{0}] headers: {1}", new Object[] {logId, headers});
    }

    Long timeoutNanos = headers.get(TIMEOUT_KEY);
    if (timeoutNanos == null) {
      timeoutNanos = 0L;
    }
    asyncCtx.setTimeout(TimeUnit.NANOSECONDS.toMillis(timeoutNanos));
    StatsTraceContext statsTraceCtx =
        StatsTraceContext.newServerContext(streamTracerFactories, method, headers);

    ServletServerStream stream = new ServletServerStream(
        asyncCtx,
        statsTraceCtx,
        maxInboundMessageSize,
        attributes.toBuilder()
            .set(
                Grpc.TRANSPORT_ATTR_REMOTE_ADDR,
                new InetSocketAddress(req.getRemoteHost(), req.getRemotePort()))
            .set(
                Grpc.TRANSPORT_ATTR_LOCAL_ADDR,
                new InetSocketAddress(req.getLocalAddr(), req.getLocalPort()))
            .build(),
        getAuthority(req),
        logId);

    transportListener.streamCreated(stream, method, headers);
    stream.transportState().runOnTransportThread(stream.transportState()::onStreamAllocated);

    asyncCtx.getRequest().getInputStream()
        .setReadListener(new GrpcReadListener(stream, asyncCtx, logId));
    asyncCtx.addListener(new GrpcAsyncListener(stream, logId));
  }

  // This method must use Enumeration and its members, since that is the only way to read headers
  // from the servlet api.
  @SuppressWarnings("JdkObsolete")
  private static Metadata getHeaders(HttpServletRequest req) {
    Enumeration<String> headerNames = req.getHeaderNames();
    checkNotNull(
        headerNames, "Servlet container does not allow HttpServletRequest.getHeaderNames()");
    List<byte[]> byteArrays = new ArrayList<>();
    while (headerNames.hasMoreElements()) {
      String headerName = headerNames.nextElement();
      Enumeration<String> values = req.getHeaders(headerName);
      if (values == null) {
        continue;
      }
      while (values.hasMoreElements()) {
        String value = values.nextElement();
        if (headerName.endsWith(Metadata.BINARY_HEADER_SUFFIX)) {
          byteArrays.add(headerName.getBytes(StandardCharsets.US_ASCII));
          byteArrays.add(BaseEncoding.base64().decode(value));
        } else {
          byteArrays.add(headerName.getBytes(StandardCharsets.US_ASCII));
          byteArrays.add(value.getBytes(StandardCharsets.US_ASCII));
        }
      }
    }
    return InternalMetadata.newMetadata(byteArrays.toArray(new byte[][]{}));
  }

  // This method must use HttpRequest#getRequestURL or HttpUtils#getRequestURL, both of which
  // can only return StringBuffer instances
  @SuppressWarnings("JdkObsolete")
  private static String getAuthority(HttpServletRequest req) {
    try {
      return new URI(req.getRequestURL().toString()).getAuthority();
    } catch (URISyntaxException e) {
      logger.log(FINE, "Error getting authority from the request URL {0}", req.getRequestURL());
      return req.getServerName() + ":" + req.getServerPort();
    }
  }

  /**
   * Call this method when the adapter is no longer needed. The gRPC server will be terminated.
   */
  public void destroy() {
    transportListener.transportTerminated();
  }

  private static final class GrpcAsyncListener implements AsyncListener {
    final InternalLogId logId;
    final ServletServerStream stream;

    GrpcAsyncListener(ServletServerStream stream, InternalLogId logId) {
      this.stream = stream;
      this.logId = logId;
    }

    @Override
    public void onComplete(AsyncEvent event) {
      stream.asyncCompleted = true;
    }

    @Override
    public void onTimeout(AsyncEvent event) {
      if (logger.isLoggable(FINE)) {
        logger.log(FINE, String.format("[{%s}] Timeout: ", logId), event.getThrowable());
      }
      // If the resp is not committed, cancel() to avoid being redirected to an error page.
      // Else, the container will send RST_STREAM in the end.
      if (!event.getAsyncContext().getResponse().isCommitted()) {
        stream.cancel(Status.DEADLINE_EXCEEDED);
      } else {
        stream.transportState().runOnTransportThread(
            () -> stream.transportState().transportReportStatus(Status.DEADLINE_EXCEEDED));
      }
    }

    @Override
    public void onError(AsyncEvent event) {
      if (logger.isLoggable(FINE)) {
        logger.log(FINE, String.format("[{%s}] Error: ", logId), event.getThrowable());
      }

      // If the resp is not committed, cancel() to avoid being redirected to an error page.
      // Else, the container will send RST_STREAM at the end.
      if (!event.getAsyncContext().getResponse().isCommitted()) {
        stream.cancel(Status.fromThrowable(event.getThrowable()));
      } else {
        stream.transportState().runOnTransportThread(
            () -> stream.transportState().transportReportStatus(
                Status.fromThrowable(event.getThrowable())));
      }
    }

    @Override
    public void onStartAsync(AsyncEvent event) {}
  }

  private static final class GrpcReadListener implements ReadListener {
    final ServletServerStream stream;
    final AsyncContext asyncCtx;
    final ServletInputStream input;
    final InternalLogId logId;

    GrpcReadListener(
        ServletServerStream stream,
        AsyncContext asyncCtx,
        InternalLogId logId) throws IOException {
      this.stream = stream;
      this.asyncCtx = asyncCtx;
      input = asyncCtx.getRequest().getInputStream();
      this.logId = logId;
    }

    final byte[] buffer = new byte[4 * 1024];

    @Override
    public void onDataAvailable() throws IOException {
      logger.log(FINEST, "[{0}] onDataAvailable: ENTRY", logId);

      while (input.isReady()) {
        int length = input.read(buffer);
        if (length == -1) {
          logger.log(FINEST, "[{0}] inbound data: read end of stream", logId);
          return;
        } else {
          if (logger.isLoggable(FINEST)) {
            logger.log(
                FINEST,
                "[{0}] inbound data: length = {1}, bytes = {2}",
                new Object[] {logId, length, ServletServerStream.toHexString(buffer, length)});
          }

          byte[] copy = Arrays.copyOf(buffer, length);
          stream.transportState().runOnTransportThread(
              () -> stream.transportState().inboundDataReceived(ReadableBuffers.wrap(copy), false));
        }
      }

      logger.log(FINEST, "[{0}] onDataAvailable: EXIT", logId);
    }

    @Override
    public void onAllDataRead() {
      logger.log(FINE, "[{0}] onAllDataRead", logId);
      stream.transportState().runOnTransportThread(() ->
          stream.transportState().inboundDataReceived(ReadableBuffers.empty(), true));
    }

    @Override
    public void onError(Throwable t) {
      if (logger.isLoggable(FINE)) {
        logger.log(FINE, String.format("[{%s}] Error: ", logId), t);
      }
      // If the resp is not committed, cancel() to avoid being redirected to an error page.
      // Else, the container will send RST_STREAM at the end.
      if (!asyncCtx.getResponse().isCommitted()) {
        stream.cancel(Status.fromThrowable(t));
      } else {
        stream.transportState().runOnTransportThread(
            () -> stream.transportState()
                .transportReportStatus(Status.fromThrowable(t)));
      }
    }
  }

  /**
   * Checks whether an incoming {@code HttpServletRequest} may come from a gRPC client.
   *
   * @return true if the request comes from a gRPC client
   */
  public static boolean isGrpc(HttpServletRequest request) {
    return request.getContentType() != null
        && request.getContentType().contains(GrpcUtil.CONTENT_TYPE_GRPC);
  }
}

1	/*
2	* Copyright 2018 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.servlet;
18
19	import static com.google.common.base.Preconditions.checkArgument;
20	import static com.google.common.base.Preconditions.checkNotNull;
21	import static io.grpc.internal.GrpcUtil.TIMEOUT_KEY;
22	import static java.util.logging.Level.FINE;
23	import static java.util.logging.Level.FINEST;
24
25	import com.google.common.io.BaseEncoding;
26	import io.grpc.Attributes;
27	import io.grpc.ExperimentalApi;
28	import io.grpc.Grpc;
29	import io.grpc.InternalLogId;
30	import io.grpc.InternalMetadata;
31	import io.grpc.Metadata;
32	import io.grpc.ServerStreamTracer;
33	import io.grpc.Status;
34	import io.grpc.internal.GrpcUtil;
35	import io.grpc.internal.ReadableBuffers;
36	import io.grpc.internal.ServerTransportListener;
37	import io.grpc.internal.StatsTraceContext;
38	import java.io.IOException;
39	import java.net.InetSocketAddress;
40	import java.net.URI;
41	import java.net.URISyntaxException;
42	import java.nio.charset.StandardCharsets;
43	import java.util.ArrayList;
44	import java.util.Arrays;
45	import java.util.Enumeration;
46	import java.util.List;
47	import java.util.concurrent.TimeUnit;
48	import java.util.function.Function;
49	import java.util.logging.Logger;
50	import javax.servlet.AsyncContext;
51	import javax.servlet.AsyncEvent;
52	import javax.servlet.AsyncListener;
53	import javax.servlet.ReadListener;
54	import javax.servlet.ServletInputStream;
55	import javax.servlet.http.HttpServletRequest;
56	import javax.servlet.http.HttpServletResponse;
57
58	/**
59	* An adapter that transforms {@link HttpServletRequest} into gRPC request and lets a gRPC server
60	* process it, and transforms the gRPC response into {@link HttpServletResponse}. An adapter can be
61	* instantiated by {@link ServletServerBuilder#buildServletAdapter()}.
62	*
63	* <p>In a servlet, calling {@link #doPost(HttpServletRequest, HttpServletResponse)} inside {@link
64	* javax.servlet.http.HttpServlet#doPost(HttpServletRequest, HttpServletResponse)} makes the servlet
65	* backed by the gRPC server associated with the adapter. The servlet must support Asynchronous
66	* Processing and must be deployed to a container that supports servlet 4.0 and enables HTTP/2.
67	*
68	* <p>The API is experimental. The authors would like to know more about the real usecases. Users
69	* are welcome to provide feedback by commenting on
70	* <a href=https://github.com/grpc/grpc-java/issues/5066>the tracking issue</a>.
71	*/
72	@ExperimentalApi("https://github.com/grpc/grpc-java/issues/5066")
73	public final class ServletAdapter {
74
75	static final Logger logger = Logger.getLogger(ServletAdapter.class.getName());	1✔
76	static final Function<HttpServletRequest, String> DEFAULT_METHOD_NAME_RESOLVER =	1✔
77	req -> req.getRequestURI().substring(1); // remove the leading "/"	1✔
78
79	private final ServerTransportListener transportListener;
80	private final List<? extends ServerStreamTracer.Factory> streamTracerFactories;
81	private final Function<HttpServletRequest, String> methodNameResolver;
82	private final int maxInboundMessageSize;
83	private final Attributes attributes;
84
85	ServletAdapter(
86	ServerTransportListener transportListener,
87	List<? extends ServerStreamTracer.Factory> streamTracerFactories,
88	Function<HttpServletRequest, String> methodNameResolver,
89	int maxInboundMessageSize) {	1✔
90	this.transportListener = transportListener;	1✔
91	this.streamTracerFactories = streamTracerFactories;	1✔
92	this.methodNameResolver = methodNameResolver;	1✔
93	this.maxInboundMessageSize = maxInboundMessageSize;	1✔
94	attributes = transportListener.transportReady(Attributes.EMPTY);	1✔
95	}	1✔
96
97	/**
98	* Call this method inside {@link javax.servlet.http.HttpServlet#doGet(HttpServletRequest,
99	* HttpServletResponse)} to serve gRPC GET request.
100	*
101	* <p>This method is currently not implemented.
102	*
103	* <p>Note that in rare case gRPC client sends GET requests.
104	*
105	* <p>Do not modify {@code req} and {@code resp} before or after calling this method. However,
106	* calling {@code resp.setBufferSize()} before invocation is allowed.
107	*/
108	public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
109	resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "GET method not supported");	×
110	}	×
111
112	/**
113	* Call this method inside {@link javax.servlet.http.HttpServlet#doPost(HttpServletRequest,
114	* HttpServletResponse)} to serve gRPC POST request.
115	*
116	* <p>Do not modify {@code req} and {@code resp} before or after calling this method. However,
117	* calling {@code resp.setBufferSize()} before invocation is allowed.
118	*/
119	public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
120	checkArgument(req.isAsyncSupported(), "servlet does not support asynchronous operation");	1✔
121	checkArgument(ServletAdapter.isGrpc(req), "the request is not a gRPC request");	1✔
122
123	InternalLogId logId = InternalLogId.allocate(ServletAdapter.class, null);	1✔
124	logger.log(FINE, "[{0}] RPC started", logId);	1✔
125
126	AsyncContext asyncCtx = req.startAsync(req, resp);	1✔
127
128	String method = methodNameResolver.apply(req);	1✔
129	Metadata headers = getHeaders(req);	1✔
130
131	if (logger.isLoggable(FINEST)) {	1✔
132	logger.log(FINEST, "[{0}] method: {1}", new Object[] {logId, method});	×
133	logger.log(FINEST, "[{0}] headers: {1}", new Object[] {logId, headers});	×
134	}
135
136	Long timeoutNanos = headers.get(TIMEOUT_KEY);	1✔
137	if (timeoutNanos == null) {	1✔
138	timeoutNanos = 0L;	1✔
139	}
140	asyncCtx.setTimeout(TimeUnit.NANOSECONDS.toMillis(timeoutNanos));	1✔
141	StatsTraceContext statsTraceCtx =	1✔
142	StatsTraceContext.newServerContext(streamTracerFactories, method, headers);	1✔
143
144	ServletServerStream stream = new ServletServerStream(	1✔
145	asyncCtx,
146	statsTraceCtx,
147	maxInboundMessageSize,
148	attributes.toBuilder()	1✔
149	.set(	1✔
150	Grpc.TRANSPORT_ATTR_REMOTE_ADDR,
151	new InetSocketAddress(req.getRemoteHost(), req.getRemotePort()))	1✔
152	.set(	1✔
153	Grpc.TRANSPORT_ATTR_LOCAL_ADDR,
154	new InetSocketAddress(req.getLocalAddr(), req.getLocalPort()))	1✔
155	.build(),	1✔
156	getAuthority(req),	1✔
157	logId);
158
159	transportListener.streamCreated(stream, method, headers);	1✔
160	stream.transportState().runOnTransportThread(stream.transportState()::onStreamAllocated);	1✔
161
162	asyncCtx.getRequest().getInputStream()	1✔
163	.setReadListener(new GrpcReadListener(stream, asyncCtx, logId));	1✔
164	asyncCtx.addListener(new GrpcAsyncListener(stream, logId));	1✔
165	}	1✔
166
167	// This method must use Enumeration and its members, since that is the only way to read headers
168	// from the servlet api.
169	@SuppressWarnings("JdkObsolete")
170	private static Metadata getHeaders(HttpServletRequest req) {
171	Enumeration<String> headerNames = req.getHeaderNames();	1✔
172	checkNotNull(	1✔
173	headerNames, "Servlet container does not allow HttpServletRequest.getHeaderNames()");
174	List<byte[]> byteArrays = new ArrayList<>();	1✔
175	while (headerNames.hasMoreElements()) {	1✔
176	String headerName = headerNames.nextElement();	1✔
177	Enumeration<String> values = req.getHeaders(headerName);	1✔
178	if (values == null) {	1✔
179	continue;	×
180	}
181	while (values.hasMoreElements()) {	1✔
182	String value = values.nextElement();	1✔
183	if (headerName.endsWith(Metadata.BINARY_HEADER_SUFFIX)) {	1✔
184	byteArrays.add(headerName.getBytes(StandardCharsets.US_ASCII));	1✔
185	byteArrays.add(BaseEncoding.base64().decode(value));	1✔
186	} else {
187	byteArrays.add(headerName.getBytes(StandardCharsets.US_ASCII));	1✔
188	byteArrays.add(value.getBytes(StandardCharsets.US_ASCII));	1✔
189	}
190	}	1✔
191	}	1✔
192	return InternalMetadata.newMetadata(byteArrays.toArray(new byte[][]{}));	1✔
193	}
194
195	// This method must use HttpRequest#getRequestURL or HttpUtils#getRequestURL, both of which
196	// can only return StringBuffer instances
197	@SuppressWarnings("JdkObsolete")
198	private static String getAuthority(HttpServletRequest req) {
199	try {
200	return new URI(req.getRequestURL().toString()).getAuthority();	1✔
201	} catch (URISyntaxException e) {	×
202	logger.log(FINE, "Error getting authority from the request URL {0}", req.getRequestURL());	×
203	return req.getServerName() + ":" + req.getServerPort();	×
204	}
205	}
206
207	/**
208	* Call this method when the adapter is no longer needed. The gRPC server will be terminated.
209	*/
210	public void destroy() {
211	transportListener.transportTerminated();	1✔
212	}	1✔
213
214	private static final class GrpcAsyncListener implements AsyncListener {
215	final InternalLogId logId;
216	final ServletServerStream stream;
217
218	GrpcAsyncListener(ServletServerStream stream, InternalLogId logId) {	1✔
219	this.stream = stream;	1✔
220	this.logId = logId;	1✔
221	}	1✔
222
223	@Override
224	public void onComplete(AsyncEvent event) {
225	stream.asyncCompleted = true;	1✔
226	}	1✔
227
228	@Override
229	public void onTimeout(AsyncEvent event) {
230	if (logger.isLoggable(FINE)) {	1✔
231	logger.log(FINE, String.format("[{%s}] Timeout: ", logId), event.getThrowable());	×
232	}
233	// If the resp is not committed, cancel() to avoid being redirected to an error page.
234	// Else, the container will send RST_STREAM in the end.
235	if (!event.getAsyncContext().getResponse().isCommitted()) {	1✔
236	stream.cancel(Status.DEADLINE_EXCEEDED);	1✔
237	} else {
238	stream.transportState().runOnTransportThread(	1✔
239	() -> stream.transportState().transportReportStatus(Status.DEADLINE_EXCEEDED));	1✔
240	}
241	}	1✔
242
243	@Override
244	public void onError(AsyncEvent event) {
245	if (logger.isLoggable(FINE)) {	1✔
246	logger.log(FINE, String.format("[{%s}] Error: ", logId), event.getThrowable());	×
247	}
248
249	// If the resp is not committed, cancel() to avoid being redirected to an error page.
250	// Else, the container will send RST_STREAM at the end.
251	if (!event.getAsyncContext().getResponse().isCommitted()) {	1✔
252	stream.cancel(Status.fromThrowable(event.getThrowable()));	×
253	} else {
254	stream.transportState().runOnTransportThread(	1✔
255	() -> stream.transportState().transportReportStatus(	1✔
256	Status.fromThrowable(event.getThrowable())));	1✔
257	}
258	}	1✔
259
260	@Override
261	public void onStartAsync(AsyncEvent event) {}	×
262	}
263
264	private static final class GrpcReadListener implements ReadListener {
265	final ServletServerStream stream;
266	final AsyncContext asyncCtx;
267	final ServletInputStream input;
268	final InternalLogId logId;
269
270	GrpcReadListener(
271	ServletServerStream stream,
272	AsyncContext asyncCtx,
273	InternalLogId logId) throws IOException {	1✔
274	this.stream = stream;	1✔
275	this.asyncCtx = asyncCtx;	1✔
276	input = asyncCtx.getRequest().getInputStream();	1✔
277	this.logId = logId;	1✔
278	}	1✔
279
280	final byte[] buffer = new byte[4 * 1024];	1✔
281
282	@Override
283	public void onDataAvailable() throws IOException {
284	logger.log(FINEST, "[{0}] onDataAvailable: ENTRY", logId);	1✔
285
286	while (input.isReady()) {	1✔
287	int length = input.read(buffer);	1✔
288	if (length == -1) {	1✔
289	logger.log(FINEST, "[{0}] inbound data: read end of stream", logId);	×
290	return;	×
291	} else {
292	if (logger.isLoggable(FINEST)) {	1✔
293	logger.log(	×
294	FINEST,
295	"[{0}] inbound data: length = {1}, bytes = {2}",
296	new Object[] {logId, length, ServletServerStream.toHexString(buffer, length)});	×
297	}
298
299	byte[] copy = Arrays.copyOf(buffer, length);	1✔
300	stream.transportState().runOnTransportThread(	1✔
301	() -> stream.transportState().inboundDataReceived(ReadableBuffers.wrap(copy), false));	1✔
302	}
303	}	1✔
304
305	logger.log(FINEST, "[{0}] onDataAvailable: EXIT", logId);	1✔
306	}	1✔
307
308	@Override
309	public void onAllDataRead() {
310	logger.log(FINE, "[{0}] onAllDataRead", logId);	1✔
311	stream.transportState().runOnTransportThread(() ->	1✔
312	stream.transportState().inboundDataReceived(ReadableBuffers.empty(), true));	1✔
313	}	1✔
314
315	@Override
316	public void onError(Throwable t) {
317	if (logger.isLoggable(FINE)) {	1✔
318	logger.log(FINE, String.format("[{%s}] Error: ", logId), t);	×
319	}
320	// If the resp is not committed, cancel() to avoid being redirected to an error page.
321	// Else, the container will send RST_STREAM at the end.
322	if (!asyncCtx.getResponse().isCommitted()) {	1✔
323	stream.cancel(Status.fromThrowable(t));	1✔
324	} else {
325	stream.transportState().runOnTransportThread(	×
326	() -> stream.transportState()	×
327	.transportReportStatus(Status.fromThrowable(t)));	×
328	}
329	}	1✔
330	}
331
332	/**
333	* Checks whether an incoming {@code HttpServletRequest} may come from a gRPC client.
334	*
335	* @return true if the request comes from a gRPC client
336	*/
337	public static boolean isGrpc(HttpServletRequest request) {
338	return request.getContentType() != null	1✔
339	&& request.getContentType().contains(GrpcUtil.CONTENT_TYPE_GRPC);	1✔
340	}
341	}

grpc / grpc-java / #19982

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