Skip to content

Commit d3eed7f

Browse files
committed
Fix: rename ChannelConfigurer to ChannelConfigurator and removes the ServerConfigurer
1 parent 3e38536 commit d3eed7f

27 files changed

Lines changed: 118 additions & 181 deletions

api/src/main/java/io/grpc/ChannelConfigurer.java renamed to api/src/main/java/io/grpc/ChannelConfigurator.java

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020

2121
/**
22-
* A configurer for child channels created by gRPC's internal infrastructure.
22+
* A configurator for child channels created by gRPC's internal infrastructure.
2323
*
2424
* <p>This interface allows users to inject configuration (such as credentials, interceptors,
2525
* or flow control settings) into channels created automatically by gRPC for control plane
@@ -31,15 +31,15 @@
3131
*
3232
* <p><strong>Usage Example:</strong>
3333
* <pre>{@code
34-
* // 1. Define the configurer
35-
* ChannelConfigurer configurer = builder -> {
34+
* // 1. Define the configurator
35+
* ChannelConfigurator configurator = builder -> {
3636
* builder.maxInboundMessageSize(4 * 1024 * 1024);
3737
* };
3838
*
3939
* // 2. Apply to parent channel - automatically used for ALL child channels
4040
* ManagedChannel channel = ManagedChannelBuilder
4141
* .forTarget("xds:///my-service")
42-
* .childChannelConfigurer(configurer)
42+
* .childChannelConfigurator(configurator)
4343
* .build();
4444
* }</pre>
4545
*
@@ -49,7 +49,7 @@
4949
* @since 1.81.0
5050
*/
5151
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
52-
public interface ChannelConfigurer {
52+
public interface ChannelConfigurator {
5353

5454
/**
5555
* Configures a builder for a new child channel.
@@ -60,14 +60,4 @@ public interface ChannelConfigurer {
6060
* @param builder the mutable channel builder for the new child channel
6161
*/
6262
default void configureChannelBuilder(ManagedChannelBuilder<?> builder) {}
63-
64-
/**
65-
* Configures a builder for a new child server.
66-
*
67-
* <p>This method is invoked synchronously during the creation of the child server,
68-
* before {@link ServerBuilder#build()} is called.
69-
*
70-
* @param builder the mutable server builder for the new child server
71-
*/
72-
default void configureServerBuilder(ServerBuilder<?> builder) {}
7363
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ public T disableServiceConfigLookUp() {
244244

245245

246246
@Override
247-
public T childChannelConfigurer(ChannelConfigurer channelConfigurer) {
248-
delegate().childChannelConfigurer(channelConfigurer);
247+
public T childChannelConfigurator(ChannelConfigurator channelConfigurer) {
248+
delegate().childChannelConfigurator(channelConfigurer);
249249
return thisT();
250250
}
251251

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,8 +271,8 @@ public <X> T setNameResolverArg(NameResolver.Args.Key<X> key, X value) {
271271

272272

273273
@Override
274-
public T childChannelConfigurer(ChannelConfigurer channelConfigurer) {
275-
delegate().childChannelConfigurer(channelConfigurer);
274+
public T childChannelConfigurator(ChannelConfigurator channelConfigurer) {
275+
delegate().childChannelConfigurator(channelConfigurer);
276276
return thisT();
277277
}
278278

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,8 @@ public T setBinaryLog(BinaryLog binaryLog) {
193193
}
194194

195195
@Override
196-
public T childChannelConfigurer(ChannelConfigurer channelConfigurer) {
197-
delegate().childChannelConfigurer(channelConfigurer);
196+
public T childChannelConfigurator(ChannelConfigurator channelConfigurer) {
197+
delegate().childChannelConfigurator(channelConfigurer);
198198
return thisT();
199199
}
200200

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@ public <X> T setNameResolverArg(NameResolver.Args.Key<X> key, X value) {
670670
* @since 1.81.0
671671
*/
672672
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
673-
public T childChannelConfigurer(ChannelConfigurer channelConfigurer) {
673+
public T childChannelConfigurator(ChannelConfigurator channelConfigurer) {
674674
throw new UnsupportedOperationException("Not implemented");
675675
}
676676

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

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@
2727
@Internal
2828
public interface MetricRecorder {
2929

30-
/**
31-
* Returns a {@link MetricRecorder} that performs no operations.
32-
* The returned instance ignores all calls and skips all validation checks.
33-
*/
34-
static MetricRecorder noOp() {
35-
return NoOpMetricRecorder.INSTANCE;
36-
}
3730

3831
/**
3932
* Adds a value for a double-precision counter metric instrument.
@@ -186,46 +179,5 @@ interface Registration extends AutoCloseable {
186179
void close();
187180
}
188181

189-
/**
190-
* No-Op implementation of MetricRecorder.
191-
* Overrides all default methods to skip validation checks for maximum performance.
192-
*/
193-
final class NoOpMetricRecorder implements MetricRecorder {
194-
private static final NoOpMetricRecorder INSTANCE = new NoOpMetricRecorder();
195182

196-
@Override
197-
public void addDoubleCounter(DoubleCounterMetricInstrument metricInstrument, double value,
198-
List<String> requiredLabelValues,
199-
List<String> optionalLabelValues) {
200-
}
201-
202-
@Override
203-
public void addLongCounter(LongCounterMetricInstrument metricInstrument, long value,
204-
List<String> requiredLabelValues, List<String> optionalLabelValues) {
205-
}
206-
207-
@Override
208-
public void addLongUpDownCounter(LongUpDownCounterMetricInstrument metricInstrument, long value,
209-
List<String> requiredLabelValues,
210-
List<String> optionalLabelValues) {
211-
}
212-
213-
@Override
214-
public void recordDoubleHistogram(DoubleHistogramMetricInstrument metricInstrument,
215-
double value, List<String> requiredLabelValues,
216-
List<String> optionalLabelValues) {
217-
}
218-
219-
@Override
220-
public void recordLongHistogram(LongHistogramMetricInstrument metricInstrument, long value,
221-
List<String> requiredLabelValues,
222-
List<String> optionalLabelValues) {
223-
}
224-
225-
@Override
226-
public Registration registerBatchCallback(BatchCallback callback,
227-
CallbackMetricInstrument... metricInstruments) {
228-
return () -> { };
229-
}
230-
}
231183
}

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ public static final class Args {
358358
@Nullable private final MetricRecorder metricRecorder;
359359
@Nullable private final NameResolverRegistry nameResolverRegistry;
360360
@Nullable private final IdentityHashMap<Key<?>, Object> customArgs;
361-
@Nullable private final ChannelConfigurer channelConfigurer;
361+
@Nullable private final ChannelConfigurator channelConfigurer;
362362

363363
private Args(Builder builder) {
364364
this.defaultPort = checkNotNull(builder.defaultPort, "defaultPort not set");
@@ -479,7 +479,7 @@ public ChannelLogger getChannelLogger() {
479479
*/
480480
@Nullable
481481
@Internal
482-
public ChannelConfigurer getChildChannelConfigurer() {
482+
public ChannelConfigurator getChildChannelConfigurator() {
483483
return channelConfigurer;
484484
}
485485

@@ -592,7 +592,7 @@ public static final class Builder {
592592
private MetricRecorder metricRecorder;
593593
private NameResolverRegistry nameResolverRegistry;
594594
private IdentityHashMap<Key<?>, Object> customArgs;
595-
private ChannelConfigurer channelConfigurer = new ChannelConfigurer() {};
595+
private ChannelConfigurator channelConfigurer = new ChannelConfigurator() {};
596596

597597
Builder() {
598598
}
@@ -709,11 +709,11 @@ public Builder setNameResolverRegistry(NameResolverRegistry registry) {
709709
}
710710

711711
/**
712-
* See {@link Args#getChildChannelConfigurer()}. This is an optional field.
712+
* See {@link Args#getChildChannelConfigurator()}. This is an optional field.
713713
*
714714
* @since 1.81.0
715715
*/
716-
public Builder setChildChannelConfigurer(ChannelConfigurer channelConfigurer) {
716+
public Builder setChildChannelConfigurator(ChannelConfigurator channelConfigurer) {
717717
this.channelConfigurer = channelConfigurer;
718718
return this;
719719
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ public T setBinaryLog(BinaryLog binaryLog) {
437437
* @since 1.81.0
438438
*/
439439
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
440-
public T childChannelConfigurer(ChannelConfigurer channelConfigurer) {
440+
public T childChannelConfigurator(ChannelConfigurator channelConfigurer) {
441441
throw new UnsupportedOperationException("Not implemented");
442442
}
443443

api/src/test/java/io/grpc/ChannelConfigurerTest.java renamed to api/src/test/java/io/grpc/ChannelConfiguratorTest.java

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,14 @@
2424
import org.junit.runners.JUnit4;
2525

2626
@RunWith(JUnit4.class)
27-
public class ChannelConfigurerTest {
27+
public class ChannelConfiguratorTest {
2828

2929
@Test
3030
public void defaultMethods_doNothing() {
31-
ChannelConfigurer configurer = new ChannelConfigurer() {};
31+
ChannelConfigurator configurator = new ChannelConfigurator() {};
3232

3333
ManagedChannelBuilder<?> mockChannelBuilder = mock(ManagedChannelBuilder.class);
34-
configurer.configureChannelBuilder(mockChannelBuilder);
34+
configurator.configureChannelBuilder(mockChannelBuilder);
3535
verifyNoInteractions(mockChannelBuilder);
36-
37-
ServerBuilder<?> mockServerBuilder = mock(ServerBuilder.class);
38-
configurer.configureServerBuilder(mockServerBuilder);
39-
verifyNoInteractions(mockServerBuilder);
4036
}
4137
}

api/src/test/java/io/grpc/NameResolverTest.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public void args() {
105105
}
106106

107107
private NameResolver.Args createArgs() {
108-
ChannelConfigurer channelConfigurer = mock(ChannelConfigurer.class);
108+
ChannelConfigurator channelConfigurer = mock(ChannelConfigurator.class);
109109
return NameResolver.Args.newBuilder()
110110
.setDefaultPort(defaultPort)
111111
.setProxyDetector(proxyDetector)
@@ -117,13 +117,13 @@ private NameResolver.Args createArgs() {
117117
.setOverrideAuthority(overrideAuthority)
118118
.setMetricRecorder(metricRecorder)
119119
.setArg(FOO_ARG_KEY, customArgValue)
120-
.setChildChannelConfigurer(channelConfigurer)
120+
.setChildChannelConfigurator(channelConfigurer)
121121
.build();
122122
}
123123

124124
@Test
125-
public void args_childChannelConfigurer() {
126-
ChannelConfigurer channelConfigurer = mock(ChannelConfigurer.class);
125+
public void args_childChannelConfigurator() {
126+
ChannelConfigurator channelConfigurer = mock(ChannelConfigurator.class);
127127

128128
SynchronizationContext realSyncContext = new SynchronizationContext(
129129
new Thread.UncaughtExceptionHandler() {
@@ -139,14 +139,14 @@ public void uncaughtException(Thread t, Throwable e) {
139139
.setSynchronizationContext(realSyncContext)
140140
.setServiceConfigParser(mock(NameResolver.ServiceConfigParser.class))
141141
.setChannelLogger(mock(ChannelLogger.class))
142-
.setChildChannelConfigurer(channelConfigurer)
142+
.setChildChannelConfigurator(channelConfigurer)
143143
.build();
144144

145-
assertThat(args.getChildChannelConfigurer()).isSameInstanceAs(channelConfigurer);
145+
assertThat(args.getChildChannelConfigurator()).isSameInstanceAs(channelConfigurer);
146146

147147
// Validate configurer accepts builders
148148
ManagedChannelBuilder<?> mockBuilder = mock(ManagedChannelBuilder.class);
149-
args.getChildChannelConfigurer().configureChannelBuilder(mockBuilder);
149+
args.getChildChannelConfigurator().configureChannelBuilder(mockBuilder);
150150
verify(channelConfigurer).configureChannelBuilder(mockBuilder);
151151
}
152152

0 commit comments

Comments
 (0)