Skip to content

Add basic connection interruption tests #3292

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
8 changes: 8 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,14 @@
<scope>test</scope>
</dependency>

<!-- Dependencies for FaultInjectionClient -->
<dependency>
<groupId>io.projectreactor.netty</groupId>
<artifactId>reactor-netty-http</artifactId>
<version>1.1.16</version>
<scope>test</scope>
</dependency>

</dependencies>

<build>
Expand Down
5 changes: 5 additions & 0 deletions src/test/java/io/lettuce/TestTags.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,9 @@ public class TestTags {
*/
public static final String ENTRA_ID = "entraid";

/**
* Tag for scenario tests
*/
public static final String SCENARIO_TEST = "scenario";

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
package io.lettuce.scenario;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assumptions.assumeTrue;

import java.time.Duration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.atomic.AtomicLong;

import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.lettuce.core.ClientOptions;
import io.lettuce.core.RedisClient;
import io.lettuce.core.RedisURI;
import io.lettuce.core.api.StatefulRedisConnection;
import io.lettuce.core.api.reactive.RedisReactiveCommands;
import io.lettuce.core.pubsub.RedisPubSubAdapter;
import io.lettuce.core.pubsub.StatefulRedisPubSubConnection;
import io.lettuce.core.pubsub.api.reactive.RedisPubSubReactiveCommands;
import io.lettuce.test.Wait;
import io.lettuce.test.env.Endpoints;
import io.lettuce.test.env.Endpoints.Endpoint;
import reactor.core.Disposable;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;

import static io.lettuce.TestTags.SCENARIO_TEST;

/**
* Tests for connection interruption using reactive API.
*/
@Tag(SCENARIO_TEST)
public class ConnectionInterruptionReactiveTest {

private static final Logger log = LoggerFactory.getLogger(ConnectionInterruptionReactiveTest.class);

private static final Duration DEFAULT_TIMEOUT = Duration.ofSeconds(30);

private static final Duration CHECK_INTERVAL = Duration.ofSeconds(1);

private static final Duration DELAY_AFTER = Duration.ofMillis(500);

private static Endpoint standalone;

private final FaultInjectionClient faultClient = new FaultInjectionClient();

@BeforeAll
public static void setup() {
standalone = Endpoints.DEFAULT.getEndpoint("re-standalone");
assumeTrue(standalone != null, "Skipping test because no Redis endpoint is configured!");
}

@ParameterizedTest(name = "Reactive Client Recovery on {0}")
@ValueSource(strings = { "dmc_restart", "network_failure" })
@DisplayName("Reactive client should reconnect automatically during connection interruptions")
public void testWithReactiveCommands(String triggerAction) {
RedisURI uri = RedisURI.builder(RedisURI.create(standalone.getEndpoints().get(0)))
.withAuthentication(standalone.getUsername(), standalone.getPassword()).build();
RedisClient client = RedisClient.create(uri);

client.setOptions(ClientOptions.builder().autoReconnect(true).build());

StatefulRedisConnection<String, String> connection = client.connect();
RedisReactiveCommands<String, String> reactive = connection.reactive();

String keyName = "counter";

// Setup: Set initial counter value
StepVerifier.create(reactive.set(keyName, "0")).expectNext("OK").verifyComplete();

AtomicLong commandsSubmitted = new AtomicLong();
List<Throwable> capturedExceptions = new CopyOnWriteArrayList<>();

// Start a flux that imitates an application using the client
Disposable subscription = Flux.interval(Duration.ofMillis(100)).flatMap(i -> reactive.incr(keyName)
// We should count all attempts, because Lettuce retransmits failed commands
.doFinally(value -> {
commandsSubmitted.incrementAndGet();
log.info("Commands submitted {}", commandsSubmitted.get());
}).onErrorResume(e -> {
log.warn("Error executing command", e);
capturedExceptions.add(e);
return Mono.empty();
})).subscribe();

// Trigger the fault injection
Map<String, Object> params = new HashMap<>();
params.put("bdb_id", standalone.getBdbId());

Mono<Boolean> actionCompleted = faultClient.triggerActionAndWait(triggerAction, params, CHECK_INTERVAL, DELAY_AFTER,
DEFAULT_TIMEOUT);

StepVerifier.create(actionCompleted).expectNext(true).verifyComplete();

// Stop the command execution
subscription.dispose();

// Verify results
StepVerifier.create(reactive.get(keyName).map(Long::parseLong)).consumeNextWith(value -> {
log.info("Final counter value: {}, commands submitted: {}", value, commandsSubmitted.get());
assertThat(value).isEqualTo(commandsSubmitted.get());
}).verifyComplete();

log.info("Captured exceptions: {}", capturedExceptions);

connection.close();
client.shutdown();
}

@ParameterizedTest(name = "PubSub Reconnection on {0}")
@ValueSource(strings = { "dmc_restart", "network_failure" })
@DisplayName("PubSub connections should automatically reconnect and resume message delivery during failures")
public void testWithPubSub(String triggerAction) {
RedisURI uri = RedisURI.builder(RedisURI.create(standalone.getEndpoints().get(0)))
.withAuthentication(standalone.getUsername(), standalone.getPassword()).build();

RedisClient subscriberClient = RedisClient.create(uri);
subscriberClient.setOptions(ClientOptions.builder().autoReconnect(true).build());

RedisClient publisherClient = RedisClient.create(uri);
publisherClient.setOptions(ClientOptions.builder().autoReconnect(true).build());

StatefulRedisConnection<String, String> publisherConnection = publisherClient.connect();
RedisReactiveCommands<String, String> publisherReactive = publisherConnection.reactive();

AtomicLong messagesSent = new AtomicLong();
AtomicLong messagesReceived = new AtomicLong();
List<Throwable> subscriberExceptions = new CopyOnWriteArrayList<>();
List<String> receivedMessages = new CopyOnWriteArrayList<>();

StatefulRedisPubSubConnection<String, String> pubSubConnection = subscriberClient.connectPubSub();
RedisPubSubReactiveCommands<String, String> pubSubReactive = pubSubConnection.reactive();
pubSubConnection.addListener(new RedisPubSubAdapter<String, String>() {

@Override
public void message(String channel, String message) {
log.info("Received message: {}", message);
messagesReceived.incrementAndGet();
receivedMessages.add(message);
}

});

StepVerifier.create(pubSubReactive.subscribe("test")).verifyComplete();

Disposable publisherSubscription = Flux.interval(Duration.ofMillis(200)).flatMap(
i -> publisherReactive.publish("test", String.valueOf(messagesSent.getAndIncrement())).onErrorResume(e -> {
log.warn("Error publishing message", e);
subscriberExceptions.add(e);
return Mono.empty();
})).subscribe();

// Wait for messages to be sent and processed
Wait.untilTrue(() -> messagesReceived.get() > 0).waitOrTimeout();

// Trigger the fault injection
Map<String, Object> params = new HashMap<>();
params.put("bdb_id", standalone.getBdbId());

Mono<Boolean> actionCompleted = faultClient.triggerActionAndWait(triggerAction, params, CHECK_INTERVAL, DELAY_AFTER,
DEFAULT_TIMEOUT);

StepVerifier.create(actionCompleted).expectNext(true).verifyComplete();

// Stop the publisher
publisherSubscription.dispose();

log.info("Messages sent: {}, messages received: {}", messagesSent.get(), messagesReceived.get());
log.info("Received messages: {}", receivedMessages);

assertThat(messagesReceived.get()).isGreaterThan(0);
assertThat(messagesReceived.get()).isLessThanOrEqualTo(messagesSent.get());

// Assert that the last received message has an ID equal to the number of sent messages minus one
assertThat(receivedMessages).isNotEmpty();

String lastMessage = receivedMessages.get(receivedMessages.size() - 1);
log.info("Last received message: {}, expected ID: {}", lastMessage, messagesSent.get() - 1);
assertThat(lastMessage).isEqualTo(String.valueOf(messagesSent.get() - 1));

log.info("Captured exceptions: {}", subscriberExceptions);

pubSubConnection.close();
publisherConnection.close();
publisherClient.shutdown();
subscriberClient.shutdown();
}

}
169 changes: 169 additions & 0 deletions src/test/java/io/lettuce/scenario/FaultInjectionClient.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
package io.lettuce.scenario;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import reactor.core.publisher.Mono;
import reactor.netty.ByteBufFlux;
import reactor.netty.http.client.HttpClient;

/**
* Async Fault Injection Client using reactor.netty.http.client.HttpClient.
*/
public class FaultInjectionClient {

private static final String BASE_URL;

static {
BASE_URL = System.getenv().getOrDefault("FAULT_INJECTION_API_URL", "http://127.0.0.1:20324");
}

private static final Logger log = LoggerFactory.getLogger(FaultInjectionClient.class);

private final HttpClient httpClient;

private final ObjectMapper objectMapper;

public FaultInjectionClient() {
this.httpClient = HttpClient.create().responseTimeout(Duration.ofSeconds(10));

this.objectMapper = new ObjectMapper().setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
}

public static class TriggerActionResponse {

@JsonProperty("action_id")
private String actionId;

// Default constructor for Jackson
public TriggerActionResponse() {
}

public TriggerActionResponse(String actionId) {
this.actionId = actionId;
}

public String getActionId() {
return actionId;
}

public void setActionId(String actionId) {
this.actionId = actionId;
}

}

/**
* Triggers an action with the specified type and parameters.
*
* @param actionType the type of action to trigger
* @param parameters the parameters for the action
* @return a Mono that emits the TriggerActionResponse when the action is triggered
*/
public Mono<TriggerActionResponse> triggerAction(String actionType, Map<String, Object> parameters) {
Map<String, Object> payload = new HashMap<>();
payload.put("type", actionType);
payload.put("parameters", parameters);

try {
String jsonString = objectMapper.writeValueAsString(payload);
byte[] bytes = jsonString.getBytes();
ByteBuf byteBuf = Unpooled.wrappedBuffer(bytes);

return httpClient.headers(h -> h.add("Content-Type", "application/json")).post().uri(BASE_URL + "/action")
.send(ByteBufFlux.fromInbound(Mono.just(byteBuf))).responseSingle((response, body) -> body.asString())
.map(result -> {
log.info("Trigger action response: {}", result);
try {
return objectMapper.readValue(result, TriggerActionResponse.class);
} catch (Exception e) {
throw new RuntimeException("Failed to parse response", e);
}
}).onErrorResume(e -> {
log.error("Failed to trigger action", e);
return Mono.error(new RuntimeException("Failed to trigger action", e));
});
} catch (Exception e) {
log.error("Failed to serialize request", e);
return Mono.error(new RuntimeException("Failed to serialize request", e));
}
}

/**
* Checks the status of an action.
*
* @param actionId the ID of the action to check
* @return Mono that emits true if the action is completed, empty if still in progress
*/
private Mono<Boolean> checkActionStatus(String actionId) {
return httpClient.get().uri(BASE_URL + "/action/" + actionId).responseSingle((response, body) -> body.asString())
.flatMap(result -> {
log.info("Action status: {}", result);
if (result.contains("success")) {
return Mono.just(true);
}
// Return empty to trigger retry
return Mono.empty();
})
.retryWhen(reactor.util.retry.Retry.backoff(3, Duration.ofMillis(300)).maxBackoff(Duration.ofSeconds(2))
.filter(throwable -> !(throwable instanceof RuntimeException && throwable.getMessage() != null
&& throwable.getMessage().contains("Fault injection proxy error")))
.doBeforeRetry(retrySignal -> log.warn("Retrying action status check after error, attempt: {}",
retrySignal.totalRetries() + 1)))
.onErrorResume(e -> {
log.error("Fault injection proxy error after retries", e);
return Mono.error(new RuntimeException("Fault injection proxy error", e));
});
}

/**
* Waits for an action to complete by polling the status endpoint. Uses Reactor's retry capabilities for a more idiomatic
* approach.
*
* @param actionId the ID of the action to wait for
* @param checkInterval interval between status checks
* @param delayAfter delay after completion before returning true
* @param timeout maximum time to wait for completion
* @return Mono that completes with true when the action is completed and the delay has passed
*/
public Mono<Boolean> waitForCompletion(String actionId, Duration checkInterval, Duration delayAfter, Duration timeout) {
return Mono.defer(() -> checkActionStatus(actionId)).flatMap(completed -> {
if (completed) {
// If we need to wait after completion, delay and then return true
if (!delayAfter.isZero()) {
return Mono.delay(delayAfter).thenReturn(true);
}
return Mono.just(true);
}
return Mono.just(false);
}).repeatWhenEmpty(repeat -> repeat.delayElements(checkInterval).timeout(timeout)
.doOnError(e -> log.error("Timeout waiting for action to complete", e)));
}

/**
* Triggers an action and waits for it to complete.
*
* @param actionType the type of action to trigger
* @param parameters the parameters for the action
* @param checkInterval interval between status checks
* @param delayAfter delay after completion before returning true
* @param timeout maximum time to wait for completion
* @return a Mono that emits true when the action is completed
*/
public Mono<Boolean> triggerActionAndWait(String actionType, Map<String, Object> parameters, Duration checkInterval,
Duration delayAfter, Duration timeout) {
return triggerAction(actionType, parameters)
.flatMap(response -> waitForCompletion(response.getActionId(), checkInterval, delayAfter, timeout));
}

}