Skip to content

api, core: rename ChannelBuilders' nameResolverFactory to nameResolverFactory_deprecated as a precursor to removing the method #10460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

api, core: rename ChannelBuilders' nameResolverFactory to nameResolverFactory_deprecated as a precursor to removing the method #10460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/src/main/java/io/grpc/ForwardingChannelBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ public T useTransportSecurity() {

@Deprecated
@Override
public T nameResolverFactory(NameResolver.Factory resolverFactory) {
delegate().nameResolverFactory(resolverFactory);
public T nameResolverFactory_deprecated(NameResolver.Factory resolverFactory) {
delegate().nameResolverFactory_deprecated(resolverFactory);
return thisT();
}

Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/grpc/ManagedChannelBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ public T useTransportSecurity() {
*/
@Deprecated
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
public abstract T nameResolverFactory(NameResolver.Factory resolverFactory);
public abstract T nameResolverFactory_deprecated(NameResolver.Factory resolverFactory);

/**
* Sets the default load-balancing policy that will be used if the service config doesn't specify
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ public T useTransportSecurity() {

@Deprecated
@Override
public T nameResolverFactory(NameResolver.Factory resolverFactory) {
delegate().nameResolverFactory(resolverFactory);
public T nameResolverFactory_deprecated(NameResolver.Factory resolverFactory) {
delegate().nameResolverFactory_deprecated(resolverFactory);
return thisT();
}

Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/io/grpc/internal/ManagedChannelImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1632,7 +1632,7 @@ protected ManagedChannelBuilder<?> delegate() {

@SuppressWarnings("deprecation")
ResolvingOobChannelBuilder builder = new ResolvingOobChannelBuilder()
.nameResolverFactory(nameResolverFactory);
.nameResolverFactory_deprecated(nameResolverFactory);

return builder
// TODO(zdapeng): executors should not outlive the parent channel.
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/io/grpc/internal/ManagedChannelImplBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,8 @@ public ManagedChannelImplBuilder intercept(ClientInterceptor... interceptors) {

@Deprecated
@Override
public ManagedChannelImplBuilder nameResolverFactory(NameResolver.Factory resolverFactory) {
public ManagedChannelImplBuilder nameResolverFactory_deprecated(
NameResolver.Factory resolverFactory) {
Preconditions.checkState(directServerAddress == null,
"directServerAddress is set (%s), which forbids the use of NameResolverFactory",
directServerAddress);
Expand Down
8 changes: 4 additions & 4 deletions core/src/test/java/io/grpc/internal/ManagedChannelImplBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,23 +204,23 @@ public void nameResolverFactory_default() {
@SuppressWarnings("deprecation")
public void nameResolverFactory_normal() {
NameResolver.Factory nameResolverFactory = mock(NameResolver.Factory.class);
assertEquals(builder, builder.nameResolverFactory(nameResolverFactory));
assertEquals(builder, builder.nameResolverFactory_deprecated(nameResolverFactory));
assertEquals(nameResolverFactory, builder.nameResolverFactory);
}

@Test
@SuppressWarnings("deprecation")
public void nameResolverFactory_null() {
NameResolver.Factory defaultValue = builder.nameResolverFactory;
builder.nameResolverFactory(mock(NameResolver.Factory.class));
assertEquals(builder, builder.nameResolverFactory(null));
builder.nameResolverFactory_deprecated(mock(NameResolver.Factory.class));
assertEquals(builder, builder.nameResolverFactory_deprecated(null));
assertEquals(defaultValue, builder.nameResolverFactory);
}

@Test(expected = IllegalStateException.class)
@SuppressWarnings("deprecation")
public void nameResolverFactory_notAllowedWithDirectAddress() {
directAddressBuilder.nameResolverFactory(mock(NameResolver.Factory.class));
directAddressBuilder.nameResolverFactory_deprecated(mock(NameResolver.Factory.class));
}

@Test
Expand Down
2 changes: 1 addition & 1 deletion core/src/test/java/io/grpc/internal/ManagedChannelImplIdlenessTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ public void setUp() {
new UnsupportedClientTransportFactoryBuilder(), null);

builder
.nameResolverFactory(mockNameResolverFactory)
.nameResolverFactory_deprecated(mockNameResolverFactory)
.defaultLoadBalancingPolicy(MOCK_POLICY_NAME)
.idleTimeout(IDLE_TIMEOUT_SECONDS, TimeUnit.SECONDS)
.userAgent(USER_AGENT);
Expand Down
101 changes: 51 additions & 50 deletions core/src/test/java/io/grpc/internal/ManagedChannelImplTest.java
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions core/src/test/java/io/grpc/internal/ServiceConfigErrorHandlingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ public void setUp() throws Exception {
new UnsupportedClientTransportFactoryBuilder(), new FixedPortProvider(DEFAULT_PORT));

channelBuilder
.nameResolverFactory(new FakeNameResolverFactory.Builder(expectedUri).build())
.nameResolverFactory_deprecated(new FakeNameResolverFactory.Builder(expectedUri).build())
.defaultLoadBalancingPolicy(MOCK_POLICY_NAME)
.userAgent(USER_AGENT)
.idleTimeout(ManagedChannelImplBuilder.IDLE_MODE_MAX_TIMEOUT_DAYS, TimeUnit.DAYS)
Expand Down Expand Up @@ -238,7 +238,7 @@ public void emptyAddresses_validConfig_firstResolution_lbNeedsAddress() throws E
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(Collections.emptyList())
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

Map<String, Object> rawServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"round_robin\": {}}]}");
Expand All @@ -258,7 +258,7 @@ public void emptyAddresses_validConfig_2ndResolution_lbNeedsAddress() throws Exc
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(new ArrayList<>(ImmutableList.of(addressGroup)))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

Map<String, Object> rawServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"12\"}}]}");
Expand Down Expand Up @@ -296,7 +296,7 @@ public void emptyAddresses_validConfig_lbDoesNotNeedAddress() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(Collections.emptyList())
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

Map<String, Object> rawServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"val\"}}]}");
Expand All @@ -322,7 +322,7 @@ public void validConfig_lbDoesNotNeedAddress() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

Map<String, Object> rawServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"foo\"}}]}");
Expand All @@ -347,7 +347,7 @@ public void noConfig_noDefaultConfig() {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);
nameResolverFactory.nextRawServiceConfig.set(null);

createChannel();
Expand All @@ -369,7 +369,7 @@ public void noConfig_usingDefaultConfig() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);
Map<String, Object> defaultServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"foo\"}}]}");
channelBuilder.defaultServiceConfig(defaultServiceConfig);
Expand Down Expand Up @@ -398,7 +398,7 @@ public void invalidConfig_noDefaultConfig() throws Exception {
nameResolverFactory.nextRawServiceConfig.set(
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"no_check\": \"foo\"}}]}"));
nextLbPolicyConfigError.set(error);
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

createChannel();

Expand All @@ -416,7 +416,7 @@ public void invalidConfig_withDefaultConfig() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);
Map<String, Object> defaultServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"mate\"}}]}");
channelBuilder.defaultServiceConfig(defaultServiceConfig);
Expand All @@ -441,7 +441,7 @@ public void invalidConfig_2ndResolution() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);

Map<String, Object> rawServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"1st raw config\"}}]}");
Expand Down Expand Up @@ -486,7 +486,7 @@ public void validConfig_thenNoConfig_withDefaultConfig() throws Exception {
new FakeNameResolverFactory.Builder(expectedUri)
.setServers(ImmutableList.of(addressGroup))
.build();
channelBuilder.nameResolverFactory(nameResolverFactory);
channelBuilder.nameResolverFactory_deprecated(nameResolverFactory);
Map<String, Object> defaultServiceConfig =
parseJson("{\"loadBalancingConfig\": [{\"mock_lb\": {\"check\": \"mate\"}}]}");
channelBuilder.defaultServiceConfig(defaultServiceConfig);
Expand Down