#19110

Committed 22 Mar 2024 12:02AM UTC coverage: 88.291% (+0.004%) from 88.287%

Build # #19110

Build Type

push

github

Committed by

web-flow

Commit Message

core: Provide DEADLINE_EXCEEDED insights for context deadline

We provided extra details when the RPC is killed by CallOptions'
Deadline, but didn't do the same for Context.

To avoid duplicating code, things were restructured, including the
threading. There are more code flows now, but I think the
multi-threading came out more obvious and less error-prone. I didn't
change the status when the deadline is already expired, because the
text is shared with DelayedClientCall and AbstractInteropTest doesn't
distinguish between the two cases.

This is a roll-forward that avoids a NPE when cancel() is called
without an earlier call to start().

As seen at b/300991330

Run Details

31196 of 35333 relevant lines covered (88.29%)

0.88 hits per line

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

88.57

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

/*
 * Copyright 2016 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.netty;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.grpc.Attributes;
import io.grpc.Status;
import io.grpc.internal.ManagedClientTransport;

/** Maintainer of transport lifecycle status. */
final class ClientTransportLifecycleManager {
  private final ManagedClientTransport.Listener listener;
  private boolean transportReady;
  private boolean transportShutdown;
  private boolean transportInUse;
  /** null iff !transportShutdown. */
  private Status shutdownStatus;
  /** null iff !transportShutdown. */
  private Throwable shutdownThrowable;
  private boolean transportTerminated;

  public ClientTransportLifecycleManager(ManagedClientTransport.Listener listener) {
    this.listener = listener;
  }

  public Attributes filterAttributes(Attributes attributes) {
    if (transportReady || transportShutdown) {
      return attributes;
    }
    return listener.filterTransport(attributes);
  }

  public void notifyReady() {
    if (transportReady || transportShutdown) {
      return;
    }
    transportReady = true;
    listener.transportReady();
  }

  /**
   * Marks transport as shutdown, but does not set the error status. This must eventually be
   * followed by a call to notifyShutdown.
   */
  public void notifyGracefulShutdown(Status s) {
    if (transportShutdown) {
      return;
    }
    transportShutdown = true;
    listener.transportShutdown(s);
  }

  /** Returns {@code true} if was the first shutdown. */
  @CanIgnoreReturnValue
  public boolean notifyShutdown(Status s) {
    notifyGracefulShutdown(s);
    if (shutdownStatus != null) {
      return false;
    }
    shutdownStatus = s;
    shutdownThrowable = s.asException();
    return true;
  }

  public void notifyInUse(boolean inUse) {
    if (inUse == transportInUse) {
      return;
    }
    transportInUse = inUse;
    listener.transportInUse(inUse);
  }

  public void notifyTerminated(Status s) {
    if (transportTerminated) {
      return;
    }
    transportTerminated = true;
    notifyShutdown(s);
    listener.transportTerminated();
  }

  public Status getShutdownStatus() {
    return shutdownStatus;
  }

  public Throwable getShutdownThrowable() {
    return shutdownThrowable;
  }
}

1	/*
2	* Copyright 2016 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.netty;
18
19	import com.google.errorprone.annotations.CanIgnoreReturnValue;
20	import io.grpc.Attributes;
21	import io.grpc.Status;
22	import io.grpc.internal.ManagedClientTransport;
23
24	/** Maintainer of transport lifecycle status. */
25	final class ClientTransportLifecycleManager {
26	private final ManagedClientTransport.Listener listener;
27	private boolean transportReady;
28	private boolean transportShutdown;
29	private boolean transportInUse;
30	/** null iff !transportShutdown. */
31	private Status shutdownStatus;
32	/** null iff !transportShutdown. */
33	private Throwable shutdownThrowable;
34	private boolean transportTerminated;
35
36	public ClientTransportLifecycleManager(ManagedClientTransport.Listener listener) {	1✔
37	this.listener = listener;	1✔
38	}	1✔
39
40	public Attributes filterAttributes(Attributes attributes) {
41	if (transportReady \|\| transportShutdown) {	1✔
42	return attributes;	×
43	}
44	return listener.filterTransport(attributes);	1✔
45	}
46
47	public void notifyReady() {
48	if (transportReady \|\| transportShutdown) {	1✔
49	return;	×
50	}
51	transportReady = true;	1✔
52	listener.transportReady();	1✔
53	}	1✔
54
55	/**
56	* Marks transport as shutdown, but does not set the error status. This must eventually be
57	* followed by a call to notifyShutdown.
58	*/
59	public void notifyGracefulShutdown(Status s) {
60	if (transportShutdown) {	1✔
61	return;	1✔
62	}
63	transportShutdown = true;	1✔
64	listener.transportShutdown(s);	1✔
65	}	1✔
66
67	/** Returns {@code true} if was the first shutdown. */
68	@CanIgnoreReturnValue
69	public boolean notifyShutdown(Status s) {
70	notifyGracefulShutdown(s);	1✔
71	if (shutdownStatus != null) {	1✔
72	return false;	1✔
73	}
74	shutdownStatus = s;	1✔
75	shutdownThrowable = s.asException();	1✔
76	return true;	1✔
77	}
78
79	public void notifyInUse(boolean inUse) {
80	if (inUse == transportInUse) {	1✔
81	return;	×
82	}
83	transportInUse = inUse;	1✔
84	listener.transportInUse(inUse);	1✔
85	}	1✔
86
87	public void notifyTerminated(Status s) {
88	if (transportTerminated) {	1✔
89	return;	×
90	}
91	transportTerminated = true;	1✔
92	notifyShutdown(s);	1✔
93	listener.transportTerminated();	1✔
94	}	1✔
95
96	public Status getShutdownStatus() {
97	return shutdownStatus;	1✔
98	}
99
100	public Throwable getShutdownThrowable() {
101	return shutdownThrowable;	1✔
102	}
103	}

grpc / grpc-java / #19110

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