#20232

Committed 02 Apr 2026 11:39AM UTC coverage: 88.784% (+0.03%) from 88.755%

Build # #20232

Build Type

push

github

Committed by

web-flow

Commit Message

xds: Add configuration objects for ExtAuthz, GrpcService and Bootstrap changes for GrpcService (#12492)

This commit introduces configuration objects for the external
authorization (ExtAuthz) filter and the gRPC service and corresponding
translations from XDS proto and Bootstrap. These classes provide a
structured, immutable representation of the subset of the configuration
defined in the xDS protobuf messages.

This PR should mostly now (hopefully ) be compliant with
https://github.com/grpc/proposal/pull/510 but without
- CallCredentials (since I don't see A97) being implemented yet and
would prefer to do it in a followup , we return empty optional)
- TlsCredentials( since it's non trivial to construct a TLS credentials
object, we throw an exception)
- LocalCredentials(Java does't support these, we throw an exception)

The main new classes are:
- `ExtAuthzConfig`: Represents the configuration for the `ExtAuthz`
filter, including settings for the gRPC service, header mutation rules,
and other filter behaviors.
- `GrpcServiceConfig`: Represents the configuration for a gRPC service,
including the target URI, credentials, and other settings.
- `HeaderMutationRulesConfig`: Represents the configuration for header
mutation rules.
- `ChannelCredsConfig` and friends: To allow comparison between
credential configuration , to allow caching based on creds which'll be
needed in followup PRs for authz and proc.

The relevant sections of the spec are 
- GrpcService: https://github.com/grpc/proposal/pull/510
- ExtAuthz:
https://github.com/grpc/proposal/pull/481/files#diff-6bb76a24ad2fd8849f164244e68cd54eaR106-R190

This commit also includes parsers to create these configuration objects
from the corresponding protobuf messages, as well as unit tests for the
new classes.

Coverage Stats

35968 of 40512 relevant lines covered (88.78%)

0.89 hits per line

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

87.88

/../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.DisconnectError;
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 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, DisconnectError disconnectError) {
    if (transportShutdown) {
      return;
    }
    transportShutdown = true;
    listener.transportShutdown(s, disconnectError);
  }

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

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

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

  public Status getShutdownStatus() {
    return shutdownStatus;
  }

}

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.DisconnectError;
23	import io.grpc.internal.ManagedClientTransport;
24
25	/** Maintainer of transport lifecycle status. */
26	final class ClientTransportLifecycleManager {
27	private final ManagedClientTransport.Listener listener;
28	private boolean transportReady;
29	private boolean transportShutdown;
30	private boolean transportInUse;
31	/** null iff !transportShutdown. */
32	private Status shutdownStatus;
33	/** null iff !transportShutdown. */
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, DisconnectError disconnectError) {
60	if (transportShutdown) {	1✔
61	return;	1✔
62	}
63	transportShutdown = true;	1✔
64	listener.transportShutdown(s, disconnectError);	1✔
65	}	1✔
66
67	/** Returns {@code true} if was the first shutdown. */
68	@CanIgnoreReturnValue
69	public boolean notifyShutdown(Status s, DisconnectError disconnectError) {
70	notifyGracefulShutdown(s, disconnectError);	1✔
71	if (shutdownStatus != null) {	1✔
72	return false;	1✔
73	}
74	shutdownStatus = s;	1✔
75	return true;	1✔
76	}
77
78	public void notifyInUse(boolean inUse) {
79	if (inUse == transportInUse) {	1✔
80	return;	×
81	}
82	transportInUse = inUse;	1✔
83	listener.transportInUse(inUse);	1✔
84	}	1✔
85
86	public void notifyTerminated(Status s, DisconnectError disconnectError) {
87	if (transportTerminated) {	1✔
88	return;	×
89	}
90	transportTerminated = true;	1✔
91	notifyShutdown(s, disconnectError);	1✔
92	listener.transportTerminated();	1✔
93	}	1✔
94
95	public Status getShutdownStatus() {
96	return shutdownStatus;	1✔
97	}
98
99	}

grpc / grpc-java / #20232

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