Add test validation for deserialising cache keys The cache invalidation relies on the ability to serialise/deserialise cache keys and preserve the original data types. The groups_bymember and other caches fail to propagate cache evictions because of the inability to preserve the cache key object type. Add a test case for the groups_bymember cache, which relies on an Account.Id as a cache key and make it pass by considering the correct deserialisation for the groups_bymember and other cases. The deserialization uses the actual key class type definition from the Gerrit DynamicMap<CacheDef<?, ?>> which is injected into the CacheKeyJsonParser. Bug: Issue 534416999 Change-Id: Ibc0adf4a7e7089d215dc03917f142c07b6fdcbc2
diff --git a/src/main/java/com/ericsson/gerrit/plugins/highavailability/cache/Constants.java b/src/main/java/com/ericsson/gerrit/plugins/highavailability/cache/Constants.java index d4fab98..66208e2 100644 --- a/src/main/java/com/ericsson/gerrit/plugins/highavailability/cache/Constants.java +++ b/src/main/java/com/ericsson/gerrit/plugins/highavailability/cache/Constants.java
@@ -20,6 +20,7 @@ public static final String ACCOUNTS = "accounts"; public static final String GROUPS = "groups"; public static final String GROUPS_BYINCLUDE = "groups_byinclude"; + public static final String GROUPS_BYMEMBER = "groups_bymember"; public static final String GROUPS_MEMBERS = "groups_members"; public static final String PROJECTS = "projects"; public static final String TOKENS = "tokens";
diff --git a/src/main/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParser.java b/src/main/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParser.java index 6202f48..4f2eea7 100644 --- a/src/main/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParser.java +++ b/src/main/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParser.java
@@ -22,6 +22,8 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.AccountGroup; import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.registration.DynamicMap; +import com.google.gerrit.server.cache.CacheDef; import com.google.gson.Gson; import com.google.gson.JsonElement; import com.google.inject.Inject; @@ -30,10 +32,12 @@ @Singleton public class CacheKeyJsonParser { private final Gson gson; + private final DynamicMap<CacheDef<?, ?>> cachesMap; @Inject - public CacheKeyJsonParser(@RestGson Gson gson) { + public CacheKeyJsonParser(@RestGson Gson gson, DynamicMap<CacheDef<?, ?>> cachesMap) { this.gson = gson; + this.cachesMap = cachesMap; } public Object fromJson(String cacheName, String jsonString) { @@ -57,10 +61,27 @@ return Project.nameKey(CharMatcher.is('\"').trimFrom(json.getAsString())); default: try { - return gson.fromJson(json, String.class); + return gson.fromJson(json, getCacheKeyType(cacheName)); } catch (Exception e) { return gson.fromJson(json, Object.class); } } } + + private Class<?> getCacheKeyType(String cacheName) { + int dot = cacheName.indexOf('.'); + String pluginName = Constants.GERRIT; + String pluginCacheName = cacheName; + if (dot > 0) { + pluginName = cacheName.substring(0, dot); + pluginCacheName = cacheName.substring(dot + 1); + } + + CacheDef<?, ?> cacheDef = cachesMap.get(pluginName, pluginCacheName); + if (cacheDef == null) { + throw new IllegalStateException("Unable to find definition for cache '" + cacheName + "'"); + } + + return cacheDef.keyType().getRawType(); + } }
diff --git a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/jgroups/CommandDeserializerTest.java b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/jgroups/CommandDeserializerTest.java index 7829a80..63e6f46 100644 --- a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/jgroups/CommandDeserializerTest.java +++ b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/jgroups/CommandDeserializerTest.java
@@ -20,6 +20,7 @@ import com.ericsson.gerrit.plugins.highavailability.forwarder.EventType; import com.ericsson.gerrit.plugins.highavailability.forwarder.rest.CacheKeyJsonParser; import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.server.events.Event; import com.google.gerrit.server.events.EventGsonProvider; import com.google.gerrit.server.events.ProjectCreatedEvent; @@ -36,7 +37,7 @@ public void setUp() { Gson eventGson = new EventGsonProvider().get(); this.gson = new JGroupsForwarderModule().buildJGroupsGson(eventGson); - this.cacheKeyParser = new CacheKeyJsonParser(eventGson); + this.cacheKeyParser = new CacheKeyJsonParser(eventGson, DynamicMap.emptyMap()); } @Test
diff --git a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParserTest.java b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParserTest.java index d661cad..e3f9615 100644 --- a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParserTest.java +++ b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheKeyJsonParserTest.java
@@ -17,23 +17,103 @@ import static com.google.common.truth.Truth.assertThat; import com.ericsson.gerrit.plugins.highavailability.cache.Constants; +import com.google.common.cache.CacheLoader; +import com.google.common.cache.Weigher; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.AccountGroup; import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.registration.DynamicMap; +import com.google.gerrit.extensions.registration.PrivateInternals_DynamicMapImpl; +import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.server.cache.CacheDef; import com.google.gerrit.server.events.EventGsonProvider; import com.google.gson.Gson; +import com.google.inject.TypeLiteral; +import com.google.inject.util.Providers; +import java.time.Duration; +import org.junit.Before; import org.junit.Test; public class CacheKeyJsonParserTest { private static final Object EMPTY_JSON = "{}"; private final Gson gson = RestForwarderModule.buildRestGson(new EventGsonProvider().get()); - private final CacheKeyJsonParser objectUnderTest = new CacheKeyJsonParser(gson); + private CacheKeyJsonParser objectUnderTest; + + private PrivateInternals_DynamicMapImpl<CacheDef<?, ?>> cacheDefMap; + + @Before + public void setUp() throws Exception { + cacheDefMap = + (PrivateInternals_DynamicMapImpl<CacheDef<?, ?>>) DynamicMap.<CacheDef<?, ?>>emptyMap(); + + RegistrationHandle unused = + cacheDefMap.put( + Constants.GERRIT, + Constants.GROUPS_BYMEMBER, + Providers.of(new GroupsByIncludeCacheDef())); + + objectUnderTest = new CacheKeyJsonParser(gson, cacheDefMap); + } + + static class GroupsByIncludeCacheDef implements CacheDef<Account.Id, Object> { + + @Override + public String name() { + return Constants.GROUPS_BYMEMBER; + } + + @Override + public String configKey() { + return ""; + } + + @Override + public TypeLiteral<Account.Id> keyType() { + return TypeLiteral.get(Account.Id.class); + } + + @Override + public TypeLiteral<Object> valueType() { + return null; + } + + @Override + public long maximumWeight() { + return 0; + } + + @Override + public Duration expireAfterWrite() { + return null; + } + + @Override + public Duration expireFromMemoryAfterAccess() { + return null; + } + + @Override + public Duration refreshAfterWrite() { + return null; + } + + @Override + public Weigher<Account.Id, Object> weigher() { + return null; + } + + @Override + public CacheLoader<Account.Id, Object> loader() { + return null; + } + } @Test public void accountIDParse() { Account.Id accountId = Account.id(1); String json = gson.toJson(accountId); assertThat(accountId).isEqualTo(objectUnderTest.fromJson(Constants.ACCOUNTS, json)); + assertThat(accountId).isEqualTo(objectUnderTest.fromJson(Constants.GROUPS_BYMEMBER, json)); } @Test
diff --git a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheRestApiServletTest.java b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheRestApiServletTest.java index 68d348c..88a325e 100644 --- a/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheRestApiServletTest.java +++ b/src/test/java/com/ericsson/gerrit/plugins/highavailability/forwarder/rest/CacheRestApiServletTest.java
@@ -26,6 +26,7 @@ import com.ericsson.gerrit.plugins.highavailability.forwarder.ForwardedCacheEvictionHandler; import com.ericsson.gerrit.plugins.highavailability.forwarder.ProcessorMetrics; import com.ericsson.gerrit.plugins.highavailability.forwarder.ProcessorMetricsRegistry; +import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gson.Gson; import java.io.BufferedReader; import java.io.IOException; @@ -52,7 +53,9 @@ when(metricsRegistry.get(any())).thenReturn(metrics); servlet = new CacheRestApiServlet( - forwardedCacheEvictionHandlerMock, new CacheKeyJsonParser(new Gson()), metricsRegistry); + forwardedCacheEvictionHandlerMock, + new CacheKeyJsonParser(new Gson(), DynamicMap.emptyMap()), + metricsRegistry); } @Test