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

Remove WATCH Command in absence of Optimistic Locking #38672

Merged
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
@@ -0,0 +1,135 @@
package io.quarkus.cache.redis.deployment;

import static org.junit.jupiter.api.Assertions.*;

import java.util.List;
import java.util.Optional;

import jakarta.inject.Inject;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.arc.Arc;
import io.quarkus.cache.Cache;
import io.quarkus.cache.CacheManager;
import io.quarkus.cache.redis.runtime.RedisCache;
import io.quarkus.redis.datasource.RedisDataSource;
import io.quarkus.test.QuarkusUnitTest;

public class RedisCacheWithOptimisticLockingTest {

private static final String KEY_1 = "1";
private static final String KEY_2 = "2";

@RegisterExtension
static final QuarkusUnitTest TEST = new QuarkusUnitTest()
.withApplicationRoot(jar -> jar.addClasses(SimpleCachedService.class, TestUtil.class))
.overrideRuntimeConfigKey("quarkus.cache.redis.use-optimistic-locking", "true");

@Inject
SimpleCachedService simpleCachedService;

@Test
public void testTypes() {
CacheManager cacheManager = Arc.container().select(CacheManager.class).get();
assertNotNull(cacheManager);

Optional<Cache> cacheOpt = cacheManager.getCache(SimpleCachedService.CACHE_NAME);
assertTrue(cacheOpt.isPresent());

Cache cache = cacheOpt.get();
assertTrue(cache instanceof RedisCache);
}

@Test
public void testAllCacheAnnotations() {
RedisDataSource redisDataSource = Arc.container().select(RedisDataSource.class).get();
List<String> allKeysAtStart = TestUtil.allRedisKeys(redisDataSource);

// STEP 1
// Action: @CacheResult-annotated method call.
// Expected effect: method invoked and result cached.
// Verified by: STEP 2.
String value1 = simpleCachedService.cachedMethod(KEY_1);
List<String> newKeys = TestUtil.allRedisKeys(redisDataSource);
assertEquals(allKeysAtStart.size() + 1, newKeys.size());
Assertions.assertThat(newKeys).contains(expectedCacheKey(KEY_1));

// STEP 2
// Action: same call as STEP 1.
// Expected effect: method not invoked and result coming from the cache.
// Verified by: same object reference between STEPS 1 and 2 results.
String value2 = simpleCachedService.cachedMethod(KEY_1);
assertEquals(value1, value2);
assertEquals(allKeysAtStart.size() + 1,
TestUtil.allRedisKeys(redisDataSource).size());

// STEP 3
// Action: same call as STEP 2 with a new key.
// Expected effect: method invoked and result cached.
// Verified by: different objects references between STEPS 2 and 3 results.
String value3 = simpleCachedService.cachedMethod(KEY_2);
assertNotEquals(value2, value3);
newKeys = TestUtil.allRedisKeys(redisDataSource);
assertEquals(allKeysAtStart.size() + 2, newKeys.size());
Assertions.assertThat(newKeys).contains(expectedCacheKey(KEY_1), expectedCacheKey(KEY_2));

// STEP 4
// Action: cache entry invalidation.
// Expected effect: STEP 2 cache entry removed.
// Verified by: STEP 5.
simpleCachedService.invalidate(KEY_1);
newKeys = TestUtil.allRedisKeys(redisDataSource);
assertEquals(allKeysAtStart.size() + 1, newKeys.size());
Assertions.assertThat(newKeys).contains(expectedCacheKey(KEY_2)).doesNotContain(expectedCacheKey(KEY_1));

// STEP 5
// Action: same call as STEP 2.
// Expected effect: method invoked because of STEP 4 and result cached.
// Verified by: different objects references between STEPS 2 and 5 results.
String value5 = simpleCachedService.cachedMethod(KEY_1);
assertNotEquals(value2, value5);
newKeys = TestUtil.allRedisKeys(redisDataSource);
assertEquals(allKeysAtStart.size() + 2, newKeys.size());
Assertions.assertThat(newKeys).contains(expectedCacheKey(KEY_1), expectedCacheKey(KEY_2));

// STEP 6
// Action: same call as STEP 3.
// Expected effect: method not invoked and result coming from the cache.
// Verified by: same object reference between STEPS 3 and 6 results.
String value6 = simpleCachedService.cachedMethod(KEY_2);
assertEquals(value3, value6);
assertEquals(allKeysAtStart.size() + 2,
TestUtil.allRedisKeys(redisDataSource).size());

// STEP 7
// Action: full cache invalidation.
// Expected effect: empty cache.
// Verified by: STEPS 8 and 9.
simpleCachedService.invalidateAll();
newKeys = TestUtil.allRedisKeys(redisDataSource);
assertEquals(allKeysAtStart.size(), newKeys.size());
Assertions.assertThat(newKeys).doesNotContain(expectedCacheKey(KEY_1), expectedCacheKey(KEY_2));

// STEP 8
// Action: same call as STEP 5.
// Expected effect: method invoked because of STEP 7 and result cached.
// Verified by: different objects references between STEPS 5 and 8 results.
String value8 = simpleCachedService.cachedMethod(KEY_1);
assertNotEquals(value5, value8);

// STEP 9
// Action: same call as STEP 6.
// Expected effect: method invoked because of STEP 7 and result cached.
// Verified by: different objects references between STEPS 6 and 9 results.
String value9 = simpleCachedService.cachedMethod(KEY_2);
assertNotEquals(value6, value9);
}

private static String expectedCacheKey(String key) {
return "cache:" + SimpleCachedService.CACHE_NAME + ":" + key;
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -146,24 +146,40 @@ public <K, V> Uni<V> get(K key, Class<V> clazz, Function<K, V> valueLoader) {
// With optimistic locking:
// WATCH K
// val = deserialize(GET K)
// If val == null
// MULTI
// SET K computation.apply(K)
// EXEC
// if val == null
// MULTI
// SET K computation.apply(K)
// EXEC
// else
// UNWATCH K
// return val
// Without:
// val = deserialize(GET K)
// if (val == null) => SET K computation.apply(K)
// else => return val
byte[] encodedKey = marshaller.encode(computeActualKey(encodeKey(key)));
boolean isWorkerThread = blockingAllowedSupplier.get();
return withConnection(new Function<RedisConnection, Uni<V>>() {
@Override
public Uni<V> apply(RedisConnection connection) {
return watch(connection, encodedKey)
.chain(new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller))
Uni<V> startingPoint;
if (cacheInfo.useOptimisticLocking) {
startingPoint = watch(connection, encodedKey)
.chain(new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller));
} else {
startingPoint = new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller).get();
}

return startingPoint
.chain(Unchecked.function(new UncheckedFunction<>() {
@Override
public Uni<V> apply(V cached) throws Exception {
if (cached != null) {
// Unwatch if optimistic locking
if (cacheInfo.useOptimisticLocking) {
return connection.send(Request.cmd(Command.UNWATCH))
.replaceWith(cached);
}
return Uni.createFrom().item(new StaticSupplier<>(cached));
} else {
Uni<V> uni = computeValue(key, valueLoader, isWorkerThread);
Expand Down Expand Up @@ -210,10 +226,22 @@ public <K, V> Uni<V> getAsync(K key, Class<V> clazz, Function<K, Uni<V>> valueLo
return withConnection(new Function<RedisConnection, Uni<V>>() {
@Override
public Uni<V> apply(RedisConnection connection) {
return watch(connection, encodedKey)
.chain(new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller))
Uni<V> startingPoint;
if (cacheInfo.useOptimisticLocking) {
startingPoint = watch(connection, encodedKey)
.chain(new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller));
} else {
startingPoint = new GetFromConnectionSupplier<>(connection, clazz, encodedKey, marshaller).get();
}

return startingPoint
.chain(cached -> {
if (cached != null) {
// Unwatch if optimistic locking
if (cacheInfo.useOptimisticLocking) {
return connection.send(Request.cmd(Command.UNWATCH))
.replaceWith(cached);
}
return Uni.createFrom().item(new StaticSupplier<>(cached));
} else {
Uni<V> getter = valueLoader.apply(key);
Expand Down
Loading