grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "core: make ManagedChannel honor Service config LB " 

This reverts commit 98aa69af72.

The GSON dependency is noticable on Android for no benefit (currently).
Reverting until we figure out what we want to do.
This commit is contained in:
Eric Anderson 2018-01-29 13:44:03 -08:00
parent fbdc217b46
commit d792a72ea1
8 changed files with 25 additions and 409 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
core/BUILD.bazel
View File

@ -41,7 +41,6 @@ java_library(
"//context", "//context",
"@com_google_code_findbugs_jsr305//jar", "@com_google_code_findbugs_jsr305//jar",
"@com_google_errorprone_error_prone_annotations//jar", "@com_google_errorprone_error_prone_annotations//jar",
"@com_google_code_gson_gson//jar",
"@com_google_guava_guava//jar", "@com_google_guava_guava//jar",
"@io_opencensus_opencensus_api//jar", "@io_opencensus_opencensus_api//jar",
"@io_opencensus_opencensus_contrib_grpc_metrics//jar", "@io_opencensus_opencensus_contrib_grpc_metrics//jar",

11
core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java
View File

@ -31,6 +31,7 @@ import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder; import io.grpc.ManagedChannelBuilder;
import io.grpc.NameResolver; import io.grpc.NameResolver;
import io.grpc.NameResolverProvider; import io.grpc.NameResolverProvider;
import io.grpc.PickFirstBalancerFactory;
import io.opencensus.trace.Tracing; import io.opencensus.trace.Tracing;
import java.net.SocketAddress; import java.net.SocketAddress;
import java.net.URI; import java.net.URI;
@ -84,6 +85,9 @@ public abstract class AbstractManagedChannelImplBuilder
private static final NameResolver.Factory DEFAULT_NAME_RESOLVER_FACTORY = private static final NameResolver.Factory DEFAULT_NAME_RESOLVER_FACTORY =
NameResolverProvider.asFactory(); NameResolverProvider.asFactory();
private static final LoadBalancer.Factory DEFAULT_LOAD_BALANCER_FACTORY =
PickFirstBalancerFactory.getInstance();
private static final DecompressorRegistry DEFAULT_DECOMPRESSOR_REGISTRY = private static final DecompressorRegistry DEFAULT_DECOMPRESSOR_REGISTRY =
DecompressorRegistry.getDefaultInstance(); DecompressorRegistry.getDefaultInstance();
@ -112,7 +116,8 @@ public abstract class AbstractManagedChannelImplBuilder
@Nullable @Nullable
String authorityOverride; String authorityOverride;
@Nullable LoadBalancer.Factory loadBalancerFactory;
LoadBalancer.Factory loadBalancerFactory = DEFAULT_LOAD_BALANCER_FACTORY;
boolean fullStreamDecompression; boolean fullStreamDecompression;
@ -224,7 +229,11 @@ public abstract class AbstractManagedChannelImplBuilder
Preconditions.checkState(directServerAddress == null, Preconditions.checkState(directServerAddress == null,
"directServerAddress is set (%s), which forbids the use of LoadBalancer.Factory", "directServerAddress is set (%s), which forbids the use of LoadBalancer.Factory",
directServerAddress); directServerAddress);
if (loadBalancerFactory != null) {
this.loadBalancerFactory = loadBalancerFactory; this.loadBalancerFactory = loadBalancerFactory;
} else {
this.loadBalancerFactory = DEFAULT_LOAD_BALANCER_FACTORY;
}
return thisT(); return thisT();
} }

197
core/src/main/java/io/grpc/internal/AutoConfiguredLoadBalancerFactory.java
View File

@ -1,197 +0,0 @@
/*
* Copyright 2018, gRPC Authors All rights reserved.
*
* 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.internal;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.annotations.VisibleForTesting;
import com.google.gson.JsonObject;
import io.grpc.Attributes;
import io.grpc.ConnectivityState;
import io.grpc.ConnectivityStateInfo;
import io.grpc.EquivalentAddressGroup;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancer.Helper;
import io.grpc.LoadBalancer.PickResult;
import io.grpc.LoadBalancer.PickSubchannelArgs;
import io.grpc.LoadBalancer.SubchannelPicker;
import io.grpc.PickFirstBalancerFactory;
import io.grpc.Status;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Locale;
import java.util.logging.Logger;
import javax.annotation.Nullable;
final class AutoConfiguredLoadBalancerFactory extends LoadBalancer.Factory {
private static final Logger logger =
Logger.getLogger(AutoConfiguredLoadBalancerFactory.class.getName());
@VisibleForTesting
static final String ROUND_ROUND_LOAD_BALANCER_FACTORY_NAME =
"io.grpc.util.RoundRobinLoadBalancerFactory";
@VisibleForTesting
static final String GRPCLB_LOAD_BALANCER_FACTORY_NAME =
"io.grpc.grpclb.GrpclbLoadBalancerFactory";
AutoConfiguredLoadBalancerFactory() {}
@Override
public LoadBalancer newLoadBalancer(Helper helper) {
return new AutoConfiguredLoadBalancer(helper);
}
private static final class EmptySubchannelPicker extends SubchannelPicker {
@Override
public PickResult pickSubchannel(PickSubchannelArgs args) {
return PickResult.withNoResult();
}
}
@VisibleForTesting
static final class AutoConfiguredLoadBalancer extends LoadBalancer {
private final Helper helper;
private LoadBalancer delegate;
private LoadBalancer.Factory delegateFactory;
AutoConfiguredLoadBalancer(Helper helper) {
this.helper = helper;
setDelegateFactory(PickFirstBalancerFactory.getInstance());
setDelegate(getDelegateFactory().newLoadBalancer(helper));
}
// Must be run inside ChannelExecutor.
@Override
public void handleResolvedAddressGroups(
List<EquivalentAddressGroup> servers, Attributes attributes) {
if (attributes.keys().contains(GrpcAttributes.NAME_RESOLVER_ATTR_SERVICE_CONFIG)) {
Factory newlbf = decideLoadBalancerFactory(
servers, attributes.get(GrpcAttributes.NAME_RESOLVER_ATTR_SERVICE_CONFIG));
if (newlbf != null && newlbf != delegateFactory) {
helper.updateBalancingState(ConnectivityState.CONNECTING, new EmptySubchannelPicker());
getDelegate().shutdown();
setDelegateFactory(newlbf);
setDelegate(getDelegateFactory().newLoadBalancer(helper));
}
}
getDelegate().handleResolvedAddressGroups(servers, attributes);
}
@Override
public void handleNameResolutionError(Status error) {
getDelegate().handleNameResolutionError(error);
}
@Override
public void handleSubchannelState(Subchannel subchannel, ConnectivityStateInfo stateInfo) {
getDelegate().handleSubchannelState(subchannel, stateInfo);
}
@Override
public void shutdown() {
getDelegate().shutdown();
setDelegate(null);
}
@VisibleForTesting
LoadBalancer getDelegate() {
return delegate;
}
@VisibleForTesting
void setDelegate(LoadBalancer delegate) {
this.delegate = delegate;
}
@VisibleForTesting
LoadBalancer.Factory getDelegateFactory() {
return delegateFactory;
}
@VisibleForTesting
void setDelegateFactory(LoadBalancer.Factory delegateFactory) {
this.delegateFactory = delegateFactory;
}
/**
* Picks a load balancer based on given criteria. In order of preference:
*
* <ol>
* <li>User provided lb on the channel. This is a degenerate case and not handled here.</li>
* <li>gRPCLB if on the class path and any gRPC LB balancer addresses are present</li>
* <li>RoundRobin if on the class path and picked by the service config</li>
* <li>PickFirst if the service config choice does not specify</li>
* </ol>
*
* @param servers The list of servers reported
* @param choice the service config object
* @return the new load balancer factory, or null if the existing lb should be used.
*/
@Nullable
@VisibleForTesting
static LoadBalancer.Factory decideLoadBalancerFactory(
List<EquivalentAddressGroup> servers, JsonObject choice) {
boolean loadBalancingPolicyPresent = choice.has("loadBalancingPolicy");
// Check for balancer addresses
boolean haveBalancerAddress = false;
for (EquivalentAddressGroup s : servers) {
if (s.getAttributes().get(GrpcAttributes.ATTR_LB_ADDR_AUTHORITY) != null) {
haveBalancerAddress = true;
break;
}
}
if (haveBalancerAddress) {
try {
Class<?> lbFactoryClass;
lbFactoryClass = Class.forName(GRPCLB_LOAD_BALANCER_FACTORY_NAME);
Method getInstance = lbFactoryClass.getMethod("getInstance");
return (LoadBalancer.Factory) getInstance.invoke(null);
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw new RuntimeException("Can't get GRPCLB, but balancer addresses were present", e);
}
}
// Check for an explicitly present lb choice
if (loadBalancingPolicyPresent) {
String serviceConfigChoiceBalancingPolicy = null;
serviceConfigChoiceBalancingPolicy = choice.get("loadBalancingPolicy").getAsString();
String policy = checkNotNull(serviceConfigChoiceBalancingPolicy, "policy");
if (policy.toUpperCase(Locale.ROOT).equals("ROUND_ROBIN")) {
ClassNotFoundException caught = null;
try {
Class<?> lbFactoryClass;
lbFactoryClass = Class.forName(ROUND_ROUND_LOAD_BALANCER_FACTORY_NAME);
Method getInstance = lbFactoryClass.getMethod("getInstance");
return (LoadBalancer.Factory) getInstance.invoke(null);
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw new RuntimeException("Can't get Round Robin LB", e);
}
}
throw new IllegalArgumentException("Unknown service config policy: " + policy);
}
return PickFirstBalancerFactory.getInstance();
}
}
}

6
core/src/main/java/io/grpc/internal/DnsNameResolver.java
View File

@ -194,13 +194,9 @@ final class DnsNameResolver extends NameResolver {
Attributes.Builder attrs = Attributes.newBuilder(); Attributes.Builder attrs = Attributes.newBuilder();
if (!resolvedInetAddrs.txtRecords.isEmpty()) { if (!resolvedInetAddrs.txtRecords.isEmpty()) {
// TODO(carl-mastrangelo): re enable this
/*
attrs.set( attrs.set(
GrpcAttributes.NAME_RESOLVER_ATTR_SERVICE_CONFIG, GrpcAttributes.NAME_RESOLVER_ATTR_DNS_TXT,
Collections.unmodifiableList(new ArrayList<String>(resolvedInetAddrs.txtRecords))); Collections.unmodifiableList(new ArrayList<String>(resolvedInetAddrs.txtRecords)));
*/
} }
savedListener.onAddresses(servers, attrs.build()); savedListener.onAddresses(servers, attrs.build());
} finally { } finally {

7
core/src/main/java/io/grpc/internal/GrpcAttributes.java
View File

@ -16,8 +16,8 @@
package io.grpc.internal; package io.grpc.internal;
import com.google.gson.JsonObject;
import io.grpc.Attributes; import io.grpc.Attributes;
import java.util.List;
/** /**
* Special attributes that are only useful to gRPC. * Special attributes that are only useful to gRPC.
@ -26,8 +26,8 @@ public final class GrpcAttributes {
/** /**
* Attribute key TXT DNS records. * Attribute key TXT DNS records.
*/ */
public static final Attributes.Key<JsonObject> NAME_RESOLVER_ATTR_SERVICE_CONFIG = public static final Attributes.Key<List<String>> NAME_RESOLVER_ATTR_DNS_TXT =
Attributes.Key.of("service-config"); Attributes.Key.of("dns-txt");
/** /**
* The naming authority of a gRPC LB server address. It is an address-group-level attribute, * The naming authority of a gRPC LB server address. It is an address-group-level attribute,
@ -36,5 +36,6 @@ public final class GrpcAttributes {
public static final Attributes.Key<String> ATTR_LB_ADDR_AUTHORITY = public static final Attributes.Key<String> ATTR_LB_ADDR_AUTHORITY =
Attributes.Key.of("io.grpc.grpclb.lbAddrAuthority"); Attributes.Key.of("io.grpc.grpclb.lbAddrAuthority");
private GrpcAttributes() {} private GrpcAttributes() {}
} }

19
core/src/main/java/io/grpc/internal/ManagedChannelImpl.java
View File

@ -112,7 +112,6 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
private final NameResolver.Factory nameResolverFactory; private final NameResolver.Factory nameResolverFactory;
private final Attributes nameResolverParams; private final Attributes nameResolverParams;
private final LoadBalancer.Factory loadBalancerFactory; private final LoadBalancer.Factory loadBalancerFactory;
private final ClientTransportFactory transportFactory; private final ClientTransportFactory transportFactory;
private final Executor executor; private final Executor executor;
private final ObjectPool<? extends Executor> executorPool; private final ObjectPool<? extends Executor> executorPool;
@ -472,11 +471,8 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
this.nameResolverFactory = builder.getNameResolverFactory(); this.nameResolverFactory = builder.getNameResolverFactory();
this.nameResolverParams = checkNotNull(builder.getNameResolverParams(), "nameResolverParams"); this.nameResolverParams = checkNotNull(builder.getNameResolverParams(), "nameResolverParams");
this.nameResolver = getNameResolver(target, nameResolverFactory, nameResolverParams); this.nameResolver = getNameResolver(target, nameResolverFactory, nameResolverParams);
if (builder.loadBalancerFactory == null) { this.loadBalancerFactory =
this.loadBalancerFactory = new AutoConfiguredLoadBalancerFactory(); checkNotNull(builder.loadBalancerFactory, "loadBalancerFactory");
} else {
this.loadBalancerFactory = builder.loadBalancerFactory;
}
this.executorPool = checkNotNull(builder.executorPool, "executorPool"); this.executorPool = checkNotNull(builder.executorPool, "executorPool");
this.oobExecutorPool = checkNotNull(oobExecutorPool, "oobExecutorPool"); this.oobExecutorPool = checkNotNull(oobExecutorPool, "oobExecutorPool");
this.executor = checkNotNull(executorPool.getObject(), "executor"); this.executor = checkNotNull(executorPool.getObject(), "executor");
@ -1006,9 +1002,11 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
} }
private class NameResolverListenerImpl implements NameResolver.Listener { private class NameResolverListenerImpl implements NameResolver.Listener {
final LbHelperImpl helper; final LoadBalancer balancer;
final LoadBalancer.Helper helper;
NameResolverListenerImpl(LbHelperImpl helperImpl) { NameResolverListenerImpl(LbHelperImpl helperImpl) {
this.balancer = helperImpl.lb;
this.helper = helperImpl; this.helper = helperImpl;
} }
@ -1023,7 +1021,6 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
new Object[]{getLogId(), servers, config}); new Object[]{getLogId(), servers, config});
} }
final class NamesResolved implements Runnable { final class NamesResolved implements Runnable {
@Override @Override
public void run() { public void run() {
@ -1032,13 +1029,13 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
return; return;
} }
try { try {
helper.lb.handleResolvedAddressGroups(servers, config); balancer.handleResolvedAddressGroups(servers, config);
} catch (Throwable e) { } catch (Throwable e) {
logger.log( logger.log(
Level.WARNING, "[" + getLogId() + "] Unexpected exception from LoadBalancer", e); Level.WARNING, "[" + getLogId() + "] Unexpected exception from LoadBalancer", e);
// It must be a bug! Push the exception back to LoadBalancer in the hope that it may // It must be a bug! Push the exception back to LoadBalancer in the hope that it may
// be propagated to the application. // be propagated to the application.
helper.lb.handleNameResolutionError(Status.INTERNAL.withCause(e) balancer.handleNameResolutionError(Status.INTERNAL.withCause(e)
.withDescription("Thrown from handleResolvedAddresses(): " + e)); .withDescription("Thrown from handleResolvedAddresses(): " + e));
} }
} }
@ -1059,7 +1056,7 @@ public final class ManagedChannelImpl extends ManagedChannel implements Instrume
if (NameResolverListenerImpl.this.helper != ManagedChannelImpl.this.lbHelper) { if (NameResolverListenerImpl.this.helper != ManagedChannelImpl.this.lbHelper) {
return; return;
} }
lbHelper.lb.handleNameResolutionError(error); balancer.handleNameResolutionError(error);
} }
}).drain(); }).drain();
} }

2
core/src/test/java/io/grpc/internal/AbstractManagedChannelImplBuilderTest.java
View File

@ -117,7 +117,7 @@ public class AbstractManagedChannelImplBuilderTest {
@Test @Test
public void loadBalancerFactory_default() { public void loadBalancerFactory_default() {
assertNull(builder.loadBalancerFactory); assertNotNull(builder.loadBalancerFactory);
} }
@Test @Test

189
core/src/test/java/io/grpc/internal/AutoConfiguredLoadBalancerFactoryTest.java
View File

@ -1,189 +0,0 @@
/*
* Copyright 2018, gRPC Authors All rights reserved.
*
* 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.internal;
import static com.google.common.truth.Truth.assertThat;
import io.grpc.Attributes;
import io.grpc.ConnectivityState;
import io.grpc.ConnectivityStateInfo;
import io.grpc.EquivalentAddressGroup;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancer.Helper;
import io.grpc.LoadBalancer.Subchannel;
import io.grpc.LoadBalancer.SubchannelPicker;
import io.grpc.ManagedChannel;
import io.grpc.NameResolver.Factory;
import io.grpc.PickFirstBalancerFactory;
import io.grpc.Status;
import io.grpc.internal.AutoConfiguredLoadBalancerFactory.AutoConfiguredLoadBalancer;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import javax.annotation.Nonnull;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Unit tests for {@link AutoConfiguredLoadBalancerFactory}.
*/
// TODO(carl-mastrangelo): Add tests for selection logic.
@RunWith(JUnit4.class)
public class AutoConfiguredLoadBalancerFactoryTest {
private final AutoConfiguredLoadBalancerFactory lbf = new AutoConfiguredLoadBalancerFactory();
@Test
public void newLoadBalancer_isAuto() {
LoadBalancer lb = lbf.newLoadBalancer(new TestHelper());
assertThat(lb).isInstanceOf(AutoConfiguredLoadBalancer.class);
}
@Test
public void defaultIsPickFirst() {
AutoConfiguredLoadBalancer lb =
(AutoConfiguredLoadBalancer) lbf.newLoadBalancer(new TestHelper());
assertThat(lb.getDelegateFactory()).isInstanceOf(PickFirstBalancerFactory.class);
assertThat(lb.getDelegate().getClass().getName()).contains("PickFirst");
}
@Test
public void forwardsCalls() {
AutoConfiguredLoadBalancer lb =
(AutoConfiguredLoadBalancer) lbf.newLoadBalancer(new TestHelper());
final AtomicInteger calls = new AtomicInteger();
TestLoadBalancer testlb = new TestLoadBalancer() {
@Override
public void handleNameResolutionError(Status error) {
calls.getAndSet(1);
}
@Override
public void handleSubchannelState(Subchannel subchannel, ConnectivityStateInfo stateInfo) {
calls.getAndSet(2);
}
@Override
public void shutdown() {
calls.getAndSet(3);
}
};
lb.setDelegate(testlb);
lb.handleNameResolutionError(Status.RESOURCE_EXHAUSTED);
assertThat(calls.getAndSet(0)).isEqualTo(1);
lb.handleSubchannelState(null, null);
assertThat(calls.getAndSet(0)).isEqualTo(2);
lb.shutdown();
assertThat(calls.getAndSet(0)).isEqualTo(3);
}
public static class ForwardingLoadBalancer extends LoadBalancer {
private final LoadBalancer delegate;
public ForwardingLoadBalancer(LoadBalancer delegate) {
this.delegate = delegate;
}
protected LoadBalancer delegate() {
return delegate;
}
@Override
public void handleResolvedAddressGroups(
List<EquivalentAddressGroup> servers, Attributes attributes) {
delegate().handleResolvedAddressGroups(servers, attributes);
}
@Override
public void handleNameResolutionError(Status error) {
delegate().handleNameResolutionError(error);
}
@Override
public void handleSubchannelState(Subchannel subchannel, ConnectivityStateInfo stateInfo) {
delegate().handleSubchannelState(subchannel, stateInfo);
}
@Override
public void shutdown() {
delegate().shutdown();
}
}
public static class ForwardingLoadBalancerHelper extends Helper {
private final Helper delegate;
public ForwardingLoadBalancerHelper(Helper delegate) {
this.delegate = delegate;
}
protected Helper delegate() {
return delegate;
}
@Override
public Subchannel createSubchannel(EquivalentAddressGroup addrs, Attributes attrs) {
return delegate().createSubchannel(addrs, attrs);
}
@Override
public ManagedChannel createOobChannel(EquivalentAddressGroup eag, String authority) {
return delegate().createOobChannel(eag, authority);
}
@Override
public void updateBalancingState(
@Nonnull ConnectivityState newState, @Nonnull SubchannelPicker newPicker) {
delegate().updateBalancingState(newState, newPicker);
}
@Override
public void runSerialized(Runnable task) {
delegate().runSerialized(task);
}
@Override
public Factory getNameResolverFactory() {
return delegate().getNameResolverFactory();
}
@Override
public String getAuthority() {
return delegate().getAuthority();
}
}
private static class TestLoadBalancer extends ForwardingLoadBalancer {
TestLoadBalancer() {
super(null);
}
}
private static class TestHelper extends ForwardingLoadBalancerHelper {
TestHelper() {
super(null);
}
}
}