#19671

Committed 30 Jan 2025 08:43PM UTC coverage: 88.581% (-0.01%) from 88.595%

Build # #19671

Build Type

push

github

Committed by

web-flow

Commit Message

xds: Reuse filter interceptors across RPCs

This moves the interceptor creation from the ConfigSelector to the
resource update handling.

The code structure changes will make adding support for filter
lifecycles (for RLQS) a bit easier. The filter lifecycles will allow
filters to share state across interceptors, and constructing all the
interceptors on a single thread will mean filters wouldn't need to be
thread-safe (but their interceptors would be thread-safe).

Run Details

33760 of 38112 relevant lines covered (88.58%)

0.89 hits per line

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

87.5

/../xds/src/main/java/io/grpc/xds/Filter.java

/*
 * Copyright 2021 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.xds;

import com.google.common.base.MoreObjects;
import com.google.protobuf.Message;
import io.grpc.ClientInterceptor;
import io.grpc.ServerInterceptor;
import java.util.Objects;
import java.util.concurrent.ScheduledExecutorService;
import javax.annotation.Nullable;

/**
 * Defines the parsing functionality of an HTTP filter. A Filter may optionally implement either
 * {@link ClientInterceptorBuilder} or {@link ServerInterceptorBuilder} or both, indicating it is
 * capable of working on the client side or server side or both, respectively.
 */
interface Filter {

  /**
   * The proto message types supported by this filter. A filter will be registered by each of its
   * supported message types.
   */
  String[] typeUrls();

  /**
   * Parses the top-level filter config from raw proto message. The message may be either a {@link
   * com.google.protobuf.Any} or a {@link com.google.protobuf.Struct}.
   */
  ConfigOrError<? extends FilterConfig> parseFilterConfig(Message rawProtoMessage);

  /**
   * Parses the per-filter override filter config from raw proto message. The message may be either
   * a {@link com.google.protobuf.Any} or a {@link com.google.protobuf.Struct}.
   */
  ConfigOrError<? extends FilterConfig> parseFilterConfigOverride(Message rawProtoMessage);

  /** Represents an opaque data structure holding configuration for a filter. */
  interface FilterConfig {
    String typeUrl();
  }

  /** Uses the FilterConfigs produced above to produce an HTTP filter interceptor for clients. */
  interface ClientInterceptorBuilder {
    @Nullable
    ClientInterceptor buildClientInterceptor(
        FilterConfig config, @Nullable FilterConfig overrideConfig,
        ScheduledExecutorService scheduler);
  }

  /** Uses the FilterConfigs produced above to produce an HTTP filter interceptor for the server. */
  interface ServerInterceptorBuilder {
    @Nullable
    ServerInterceptor buildServerInterceptor(
        FilterConfig config, @Nullable FilterConfig overrideConfig);
  }

  /** Filter config with instance name. */
  final class NamedFilterConfig {
    // filter instance name
    final String name;
    final FilterConfig filterConfig;

    NamedFilterConfig(String name, FilterConfig filterConfig) {
      this.name = name;
      this.filterConfig = filterConfig;
    }

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      NamedFilterConfig that = (NamedFilterConfig) o;
      return Objects.equals(name, that.name)
          && Objects.equals(filterConfig, that.filterConfig);
    }

    @Override
    public int hashCode() {
      return Objects.hash(name, filterConfig);
    }

    @Override
    public String toString() {
      return MoreObjects.toStringHelper(this)
          .add("name", name)
          .add("filterConfig", filterConfig)
          .toString();
    }
  }
}

1	/*
2	* Copyright 2021 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.xds;
18
19	import com.google.common.base.MoreObjects;
20	import com.google.protobuf.Message;
21	import io.grpc.ClientInterceptor;
22	import io.grpc.ServerInterceptor;
23	import java.util.Objects;
24	import java.util.concurrent.ScheduledExecutorService;
25	import javax.annotation.Nullable;
26
27	/**
28	* Defines the parsing functionality of an HTTP filter. A Filter may optionally implement either
29	* {@link ClientInterceptorBuilder} or {@link ServerInterceptorBuilder} or both, indicating it is
30	* capable of working on the client side or server side or both, respectively.
31	*/
32	interface Filter {
33
34	/**
35	* The proto message types supported by this filter. A filter will be registered by each of its
36	* supported message types.
37	*/
38	String[] typeUrls();
39
40	/**
41	* Parses the top-level filter config from raw proto message. The message may be either a {@link
42	* com.google.protobuf.Any} or a {@link com.google.protobuf.Struct}.
43	*/
44	ConfigOrError<? extends FilterConfig> parseFilterConfig(Message rawProtoMessage);
45
46	/**
47	* Parses the per-filter override filter config from raw proto message. The message may be either
48	* a {@link com.google.protobuf.Any} or a {@link com.google.protobuf.Struct}.
49	*/
50	ConfigOrError<? extends FilterConfig> parseFilterConfigOverride(Message rawProtoMessage);
51
52	/** Represents an opaque data structure holding configuration for a filter. */
53	interface FilterConfig {
54	String typeUrl();
55	}
56
57	/** Uses the FilterConfigs produced above to produce an HTTP filter interceptor for clients. */
58	interface ClientInterceptorBuilder {
59	@Nullable
60	ClientInterceptor buildClientInterceptor(
61	FilterConfig config, @Nullable FilterConfig overrideConfig,
62	ScheduledExecutorService scheduler);
63	}
64
65	/** Uses the FilterConfigs produced above to produce an HTTP filter interceptor for the server. */
66	interface ServerInterceptorBuilder {
67	@Nullable
68	ServerInterceptor buildServerInterceptor(
69	FilterConfig config, @Nullable FilterConfig overrideConfig);
70	}
71
72	/** Filter config with instance name. */
73	final class NamedFilterConfig {
74	// filter instance name
75	final String name;
76	final FilterConfig filterConfig;
77
78	NamedFilterConfig(String name, FilterConfig filterConfig) {	1✔
79	this.name = name;	1✔
80	this.filterConfig = filterConfig;	1✔
81	}	1✔
82
83	@Override
84	public boolean equals(Object o) {
85	if (this == o) {	1✔
86	return true;	×
87	}
88	if (o == null \|\| getClass() != o.getClass()) {	1✔
89	return false;	×
90	}
91	NamedFilterConfig that = (NamedFilterConfig) o;	1✔
92	return Objects.equals(name, that.name)	1✔
93	&& Objects.equals(filterConfig, that.filterConfig);	1✔
94	}
95
96	@Override
97	public int hashCode() {
98	return Objects.hash(name, filterConfig);	1✔
99	}
100
101	@Override
102	public String toString() {
103	return MoreObjects.toStringHelper(this)	1✔
104	.add("name", name)	1✔
105	.add("filterConfig", filterConfig)	1✔
106	.toString();	1✔
107	}
108	}
109	}

grpc / grpc-java / #19671

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