Skip to content
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.

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

Add config to disable close on circuit breaker #1755

Merged
merged 1 commit into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,8 @@ public interface ConnectionPoolConfig {
boolean isSecure();

boolean useIPAddrForServer();

default boolean isCloseOnCircuitBreakerEnabled() {
return true;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ public class ConnectionPoolConfigImpl implements ConnectionPoolConfig {
public static final IClientConfigKey<Integer> PER_SERVER_WATERLINE =
new CommonClientConfigKey<>("PerServerWaterline", DEFAULT_PER_SERVER_WATERLINE) {};

public static final IClientConfigKey<Boolean> CLOSE_ON_CIRCUIT_BREAKER =
new CommonClientConfigKey<>("CloseOnCircuitBreaker", true) {};

private final OriginName originName;
private final IClientConfig clientConfig;

Expand Down Expand Up @@ -148,4 +151,9 @@ public boolean isSecure() {
public boolean useIPAddrForServer() {
return clientConfig.getPropertyAsBoolean(IClientConfigKey.Keys.UseIPAddrForServer, true);
}

@Override
public boolean isCloseOnCircuitBreakerEnabled() {
return clientConfig.getPropertyAsBoolean(CLOSE_ON_CIRCUIT_BREAKER, true);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ public boolean release(final PooledConnection conn) {
conn.getChannel().id());
}

} else if (discoveryResult.isCircuitBreakerTripped()) {
} else if (connPoolConfig.isCloseOnCircuitBreakerEnabled() && discoveryResult.isCircuitBreakerTripped()) {
LOG.debug(
"[{}] closing conn, server circuit breaker tripped",
conn.getChannel().id());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.netflix.appinfo.InstanceInfo.Builder;
import com.netflix.client.config.DefaultClientConfigImpl;
import com.netflix.spectator.api.DefaultRegistry;
import com.netflix.spectator.api.NoopRegistry;
import com.netflix.spectator.api.Registry;
import com.netflix.zuul.discovery.DiscoveryResult;
import com.netflix.zuul.discovery.DynamicServerResolver;
Expand All @@ -31,10 +32,12 @@
import com.netflix.zuul.passport.CurrentPassport;
import io.netty.channel.DefaultEventLoop;
import io.netty.channel.EventLoop;
import io.netty.channel.embedded.EmbeddedChannel;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.util.concurrent.Promise;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.net.InetSocketAddress;
import java.net.ServerSocket;
Expand All @@ -47,7 +50,11 @@
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
Expand Down Expand Up @@ -217,4 +224,59 @@ void initializeAndShutdown() throws Exception {
clientChannelManager.shutdown();
serverSocket.close();
}

@Test
void closeOnCircuitBreaker() {
final OriginName originName = OriginName.fromVipAndApp("whatever", "whatever");
DefaultClientChannelManager manager =
new DefaultClientChannelManager(
originName,
new DefaultClientConfigImpl(),
Mockito.mock(DynamicServerResolver.class),
new NoopRegistry()) {
@Override
protected void updateServerStatsOnRelease(PooledConnection conn) {}
};

PooledConnection connection = mock(PooledConnection.class);
DiscoveryResult discoveryResult = mock(DiscoveryResult.class);
doReturn(discoveryResult).when(connection).getServer();
doReturn(true).when(discoveryResult).isCircuitBreakerTripped();
doReturn(new EmbeddedChannel()).when(connection).getChannel();

Truth.assertThat(manager.release(connection)).isFalse();
verify(connection).setInPool(false);
verify(connection).close();
}

@Test
void skipCloseOnCircuitBreaker() {
final OriginName originName = OriginName.fromVipAndApp("whatever", "whatever");
DefaultClientConfigImpl clientConfig = new DefaultClientConfigImpl();
DefaultClientChannelManager manager =
new DefaultClientChannelManager(
originName, clientConfig, Mockito.mock(DynamicServerResolver.class), new NoopRegistry()) {
@Override
protected void updateServerStatsOnRelease(PooledConnection conn) {}

@Override
protected void releaseHandlers(PooledConnection conn) {}
};

PooledConnection connection = mock(PooledConnection.class);
DiscoveryResult discoveryResult = mock(DiscoveryResult.class);
doReturn(discoveryResult).when(connection).getServer();
doReturn(true).when(discoveryResult).isCircuitBreakerTripped();
doReturn(true).when(connection).isActive();
doReturn(new EmbeddedChannel()).when(connection).getChannel();

IConnectionPool connectionPool = mock(IConnectionPool.class);
doReturn(true).when(connectionPool).release(connection);
manager.getPerServerPools().put(discoveryResult, connectionPool);
clientConfig.set(ConnectionPoolConfigImpl.CLOSE_ON_CIRCUIT_BREAKER, false);

Truth.assertThat(manager.release(connection)).isTrue();
verify(connection, never()).setInPool(anyBoolean());
verify(connection, never()).close();
}
}