Skip to content

Commit

Permalink
core: de-expermentalize pick first config parsing (#10531) (#10742)
Browse files Browse the repository at this point in the history
Co-authored-by: Terry Wilson <tmwilson@google.com>
  • Loading branch information
larry-safran and temawi committed Dec 12, 2023
1 parent d7c590f commit a905d89
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 31 deletions.
Expand Up @@ -16,8 +16,6 @@

package io.grpc.internal;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancerProvider;
import io.grpc.NameResolver;
Expand All @@ -33,11 +31,7 @@
* down the address list and sticks to the first that works.
*/
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 CONFIG_FLAG_NAME = "GRPC_EXPERIMENTAL_PICKFIRST_LB_CONFIG";
@VisibleForTesting
static boolean enablePickFirstConfig = !Strings.isNullOrEmpty(System.getenv(CONFIG_FLAG_NAME));

@Override
public boolean isAvailable() {
Expand All @@ -62,18 +56,14 @@ public LoadBalancer newLoadBalancer(LoadBalancer.Helper helper) {
@Override
public ConfigOrError parseLoadBalancingPolicyConfig(
Map<String, ?> rawLoadBalancingPolicyConfig) {
if (enablePickFirstConfig) {
try {
return ConfigOrError.fromConfig(
new PickFirstLoadBalancerConfig(JsonUtil.getBoolean(rawLoadBalancingPolicyConfig,
SHUFFLE_ADDRESS_LIST_KEY)));
} catch (RuntimeException e) {
return ConfigOrError.fromError(
Status.UNAVAILABLE.withCause(e).withDescription(
"Failed parsing configuration for " + getPolicyName()));
}
} else {
return ConfigOrError.fromConfig(NO_CONFIG);
try {
return ConfigOrError.fromConfig(
new PickFirstLoadBalancerConfig(JsonUtil.getBoolean(rawLoadBalancingPolicyConfig,
SHUFFLE_ADDRESS_LIST_KEY)));
} catch (RuntimeException e) {
return ConfigOrError.fromError(
Status.UNAVAILABLE.withCause(e).withDescription(
"Failed parsing configuration for " + getPolicyName()));
}
}
}
Expand Up @@ -22,40 +22,33 @@
import io.grpc.internal.PickFirstLoadBalancer.PickFirstLoadBalancerConfig;
import java.util.HashMap;
import java.util.Map;
import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class PickFirstLoadBalancerProviderTest {

@After
public void resetConfigFlag() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = false;
}

@Test
public void parseWithConfigEnabled() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = true;
public void parseWithConfig() {
Map<String, Object> rawConfig = new HashMap<>();
rawConfig.put("shuffleAddressList", true);
ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig(
rawConfig);
PickFirstLoadBalancerConfig config = (PickFirstLoadBalancerConfig) parsedConfig.getConfig();

assertThat(config.shuffleAddressList).isTrue();
assertThat(config.randomSeed).isNull();
}

@Test
public void parseWithConfigDisabled() {
PickFirstLoadBalancerProvider.enablePickFirstConfig = false;
public void parseWithoutConfig() {
Map<String, Object> rawConfig = new HashMap<>();
rawConfig.put("shuffleAddressList", true);
ConfigOrError parsedConfig = new PickFirstLoadBalancerProvider().parseLoadBalancingPolicyConfig(
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();
}
}

0 comments on commit a905d89

Please sign in to comment.