core: de-expermentalize pick first config parsing (#10531)

This commit is contained in:
Terry Wilson 2023-08-30 15:40:34 -07:00 committed by GitHub
parent b63e1579ed
commit 36e0af66fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 31 deletions

View File

@ -16,8 +16,6 @@
package io.grpc.internal; package io.grpc.internal;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import io.grpc.LoadBalancer; import io.grpc.LoadBalancer;
import io.grpc.LoadBalancerProvider; import io.grpc.LoadBalancerProvider;
import io.grpc.NameResolver; import io.grpc.NameResolver;
@ -33,11 +31,7 @@ import java.util.Map;
* down the address list and sticks to the first that works. * down the address list and sticks to the first that works.
*/ */
public final class PickFirstLoadBalancerProvider extends LoadBalancerProvider { public final class PickFirstLoadBalancerProvider extends LoadBalancerProvider {
private static final String NO_CONFIG = "no service config";
private static final String SHUFFLE_ADDRESS_LIST_KEY = "shuffleAddressList"; private static final String SHUFFLE_ADDRESS_LIST_KEY = "shuffleAddressList";
private static final String CONFIG_FLAG_NAME = "GRPC_EXPERIMENTAL_PICKFIRST_LB_CONFIG";
@VisibleForTesting
static boolean enablePickFirstConfig = !Strings.isNullOrEmpty(System.getenv(CONFIG_FLAG_NAME));
@Override @Override
public boolean isAvailable() { public boolean isAvailable() {
@ -62,18 +56,14 @@ public final class PickFirstLoadBalancerProvider extends LoadBalancerProvider {
@Override @Override
public ConfigOrError parseLoadBalancingPolicyConfig( public ConfigOrError parseLoadBalancingPolicyConfig(
Map<String, ?> rawLoadBalancingPolicyConfig) { Map<String, ?> rawLoadBalancingPolicyConfig) {
if (enablePickFirstConfig) { try {
try { return ConfigOrError.fromConfig(
return ConfigOrError.fromConfig( new PickFirstLoadBalancerConfig(JsonUtil.getBoolean(rawLoadBalancingPolicyConfig,
new PickFirstLoadBalancerConfig(JsonUtil.getBoolean(rawLoadBalancingPolicyConfig, SHUFFLE_ADDRESS_LIST_KEY)));
SHUFFLE_ADDRESS_LIST_KEY))); } catch (RuntimeException e) {
} catch (RuntimeException e) { return ConfigOrError.fromError(
return ConfigOrError.fromError( Status.UNAVAILABLE.withCause(e).withDescription(
Status.UNAVAILABLE.withCause(e).withDescription( "Failed parsing configuration for " + getPolicyName()));
"Failed parsing configuration for " + getPolicyName()));
}
} else {
return ConfigOrError.fromConfig(NO_CONFIG);
} }
} }
} }

View File

@ -22,7 +22,6 @@ import io.grpc.NameResolver.ConfigOrError;
import io.grpc.internal.PickFirstLoadBalancer.PickFirstLoadBalancerConfig; import io.grpc.internal.PickFirstLoadBalancer.PickFirstLoadBalancerConfig;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.junit.After;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
import org.junit.runners.JUnit4; import org.junit.runners.JUnit4;
@ -30,14 +29,8 @@ import org.junit.runners.JUnit4;
@RunWith(JUnit4.class) @RunWith(JUnit4.class)
public class PickFirstLoadBalancerProviderTest { public class PickFirstLoadBalancerProviderTest {
@After
public void resetConfigFlag() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = false;
}
@Test @Test
public void parseWithConfigEnabled() { public void parseWithConfig() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = true;
Map<String, Object> rawConfig = new HashMap<>(); Map<String, Object> rawConfig = new HashMap<>();
rawConfig.put("shuffleAddressList", true); rawConfig.put("shuffleAddressList", true);
ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig( ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig(
@ -45,17 +38,17 @@ public class PickFirstLoadBalancerProviderTest {
PickFirstLoadBalancerConfig config = (PickFirstLoadBalancerConfig) parsedConfig.getConfig(); PickFirstLoadBalancerConfig config = (PickFirstLoadBalancerConfig) parsedConfig.getConfig();
assertThat(config.shuffleAddressList).isTrue(); assertThat(config.shuffleAddressList).isTrue();
assertThat(config.randomSeed).isNull();
} }
@Test @Test
public void parseWithConfigDisabled() { public void parseWithoutConfig() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = false;
Map<String, Object> rawConfig = new HashMap<>(); Map<String, Object> rawConfig = new HashMap<>();
rawConfig.put("shuffleAddressList", true);
ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig( ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig(
rawConfig); rawConfig);
String config = (String) parsedConfig.getConfig(); PickFirstLoadBalancerConfig config = (PickFirstLoadBalancerConfig) parsedConfig.getConfig();
assertThat(config).isEqualTo("no service config"); assertThat(config.shuffleAddressList).isNull();
assertThat(config.randomSeed).isNull();
} }
} }