Skip to content

Fix liveness checking for unresponsive connections #1514

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

Merged
merged 4 commits into from
Dec 18, 2023
Merged

Fix liveness checking for unresponsive connections #1514

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1872cb8
Fix liveness checking for unresponsive connections
bigmontz Dec 14, 2023
9940d33
Remove unused imports
bigmontz Dec 14, 2023
148be83
apply code style
bigmontz Dec 14, 2023
c2a5938
Update driver/src/main/java/org/neo4j/driver/internal/async/pool/Nett…
bigmontz Dec 18, 2023
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: 4 additions & 0 deletions driver/src/main/java/org/neo4j/driver/internal/async/inbound/InboundMessageDispatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ public void handleIgnoredMessage() {
handler.onFailure(error);
}

public HandlerHook getBeforeLastHandlerHook() {
return this.beforeLastHandlerHook;
}

private Optional<ResetResponseHandler> getPendingResetHandler() {
return handlers.stream()
.filter(h -> h instanceof ResetResponseHandler)
Expand Down
22 changes: 21 additions & 1 deletion driver/src/main/java/org/neo4j/driver/internal/async/pool/NettyChannelHealthChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,14 @@
import io.netty.util.concurrent.Promise;
import io.netty.util.concurrent.PromiseNotifier;
import java.time.Clock;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import org.neo4j.driver.Logger;
import org.neo4j.driver.Logging;
import org.neo4j.driver.internal.async.connection.AuthorizationStateListener;
import org.neo4j.driver.internal.async.connection.ChannelAttributes;
import org.neo4j.driver.internal.async.inbound.ConnectionReadTimeoutHandler;
import org.neo4j.driver.internal.async.inbound.InboundMessageDispatcher;
import org.neo4j.driver.internal.handlers.PingResponseHandler;
import org.neo4j.driver.internal.messaging.request.ResetMessage;
import org.neo4j.driver.internal.messaging.v51.BoltProtocolV51;
Expand Down Expand Up @@ -164,8 +168,24 @@ private boolean hasBeenIdleForTooLong(Channel channel) {

private Future<Boolean> ping(Channel channel) {
Promise<Boolean> result = channel.eventLoop().newPromise();
messageDispatcher(channel).enqueue(new PingResponseHandler(result, channel, logging));
var messageDispatcher = messageDispatcher(channel);
messageDispatcher.enqueue(new PingResponseHandler(result, channel, logging));
channel.writeAndFlush(ResetMessage.RESET, channel.voidPromise());
attachConnectionReadTimeoutHandler(channel, messageDispatcher);
return result;
}

private void attachConnectionReadTimeoutHandler(Channel channel, InboundMessageDispatcher messageDispatcher) {
ChannelAttributes.connectionReadTimeout(channel).ifPresent(connectionReadTimeout -> {
var connectionReadTimeoutHandler =
new ConnectionReadTimeoutHandler(connectionReadTimeout, TimeUnit.SECONDS);
channel.pipeline().addFirst(connectionReadTimeoutHandler);
log.debug("Added ConnectionReadTimeoutHandler");
messageDispatcher.setBeforeLastHandlerHook((messageType) -> {
channel.pipeline().remove(connectionReadTimeoutHandler);
messageDispatcher.setBeforeLastHandlerHook(null);
log.debug("Removed ConnectionReadTimeoutHandler");
});
});
}
}
64 changes: 64 additions & 0 deletions driver/src/test/java/org/neo4j/driver/internal/async/pool/NettyChannelHealthCheckerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.BDDMockito.given;
import static org.mockito.BDDMockito.then;
Expand All @@ -29,6 +32,7 @@
import static org.mockito.Mockito.times;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.authContext;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.setAuthContext;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.setConnectionReadTimeout;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.setCreationTimestamp;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.setLastUsedTimestamp;
import static org.neo4j.driver.internal.async.connection.ChannelAttributes.setMessageDispatcher;
Expand All @@ -54,6 +58,7 @@
import org.junit.jupiter.params.provider.MethodSource;
import org.neo4j.driver.AuthTokenManager;
import org.neo4j.driver.AuthTokens;
import org.neo4j.driver.internal.async.inbound.ConnectionReadTimeoutHandler;
import org.neo4j.driver.internal.async.inbound.InboundMessageDispatcher;
import org.neo4j.driver.internal.messaging.BoltProtocolVersion;
import org.neo4j.driver.internal.messaging.request.ResetMessage;
Expand Down Expand Up @@ -248,6 +253,65 @@ void shouldKeepIdleConnectionWhenPingSucceeds() {
testPing(true);
}

@Test
void shouldHandlePingWithConnectionReceiveTimeout() {
var idleTimeBeforeConnectionTest = 1000;
var connectionReadTimeout = 60L;
var settings = new PoolSettings(
DEFAULT_MAX_CONNECTION_POOL_SIZE,
DEFAULT_CONNECTION_ACQUISITION_TIMEOUT,
NOT_CONFIGURED,
idleTimeBeforeConnectionTest);
var clock = Clock.systemUTC();
var healthChecker = newHealthChecker(settings, clock);

setCreationTimestamp(channel, clock.millis());
setConnectionReadTimeout(channel, connectionReadTimeout);
setLastUsedTimestamp(channel, clock.millis() - idleTimeBeforeConnectionTest * 2);

var healthy = healthChecker.isHealthy(channel);
channel.runPendingTasks();

var firstElementOnPipeline = channel.pipeline().first();
assertInstanceOf(ConnectionReadTimeoutHandler.class, firstElementOnPipeline);
assertNotNull(dispatcher.getBeforeLastHandlerHook());
var readTimeoutHandler = (ConnectionReadTimeoutHandler) firstElementOnPipeline;
assertEquals(connectionReadTimeout * 1000L, readTimeoutHandler.getReaderIdleTimeInMillis());
assertEquals(ResetMessage.RESET, single(channel.outboundMessages()));
assertFalse(healthy.isDone());

dispatcher.handleSuccessMessage(Collections.emptyMap());
assertThat(await(healthy), is(true));
assertNull(channel.pipeline().first());
assertNull(dispatcher.getBeforeLastHandlerHook());
}

@Test
void shouldHandlePingWithoutConnectionReceiveTimeout() {
var idleTimeBeforeConnectionTest = 1000;
var settings = new PoolSettings(
DEFAULT_MAX_CONNECTION_POOL_SIZE,
DEFAULT_CONNECTION_ACQUISITION_TIMEOUT,
NOT_CONFIGURED,
idleTimeBeforeConnectionTest);
var clock = Clock.systemUTC();
var healthChecker = newHealthChecker(settings, clock);

setCreationTimestamp(channel, clock.millis());
setLastUsedTimestamp(channel, clock.millis() - idleTimeBeforeConnectionTest * 2);

var healthy = healthChecker.isHealthy(channel);
channel.runPendingTasks();

assertNull(channel.pipeline().first());
assertEquals(ResetMessage.RESET, single(channel.outboundMessages()));
assertFalse(healthy.isDone());

dispatcher.handleSuccessMessage(Collections.emptyMap());
assertThat(await(healthy), is(true));
assertNull(channel.pipeline().first());
}

@Test
void shouldDropIdleConnectionWhenPingFails() {
testPing(false);
Expand Down