Differentiate the multi-site Gson from Gerrit's
Gerrit uses an explicit binding of the Gson serializer to be used
internally, not to be confused with the Gson serializer used for
sending and receiving events to the Broker.
Introduce a new specific annotation BrokerGson and use it throughout
the code.
Eliminate also the indirection through a Provider<Gson> which is an
unnecessary complication.
Change-Id: I387d50f70e2c5ba9dc229a95aa5b93497be0a799
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/Module.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/Module.java
index 4d713ea..a471b04 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/Module.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/Module.java
@@ -22,6 +22,7 @@
import com.google.inject.Provides;
import com.google.inject.ProvisionException;
import com.google.inject.Singleton;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.broker.GsonProvider;
import com.googlesource.gerrit.plugins.multisite.cache.CacheModule;
import com.googlesource.gerrit.plugins.multisite.event.EventModule;
@@ -100,7 +101,10 @@
}
install(new ValidationModule(config, disableGitRepositoryValidation));
- bind(Gson.class).toProvider(GsonProvider.class).in(Singleton.class);
+ bind(Gson.class)
+ .annotatedWith(BrokerGson.class)
+ .toProvider(GsonProvider.class)
+ .in(Singleton.class);
}
@Provides
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerGson.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerGson.java
new file mode 100644
index 0000000..219aa96
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerGson.java
@@ -0,0 +1,27 @@
+// Copyright (C) 2019 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.googlesource.gerrit.plugins.multisite.broker;
+
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import com.google.inject.BindingAnnotation;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+@Retention(RUNTIME)
+@Target(PARAMETER)
+@BindingAnnotation
+public @interface BrokerGson {}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerPublisher.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerPublisher.java
index eff8824..4dca9e9 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerPublisher.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/broker/BrokerPublisher.java
@@ -42,7 +42,10 @@
@Inject
public BrokerPublisher(
- BrokerSession session, Gson gson, @InstanceId UUID instanceId, MessageLogger msgLog) {
+ BrokerSession session,
+ @BrokerGson Gson gson,
+ @InstanceId UUID instanceId,
+ MessageLogger msgLog) {
this.session = session;
this.gson = gson;
this.instanceId = instanceId;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/broker/BrokerForwarderModule.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/broker/BrokerForwarderModule.java
index 8a3b6dc..7c6bef3 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/broker/BrokerForwarderModule.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/broker/BrokerForwarderModule.java
@@ -16,12 +16,9 @@
import com.google.gerrit.extensions.registration.DynamicSet;
import com.google.gerrit.lifecycle.LifecycleModule;
-import com.google.gson.Gson;
-import com.google.inject.Singleton;
import com.googlesource.gerrit.plugins.multisite.Configuration.KafkaPublisher;
import com.googlesource.gerrit.plugins.multisite.broker.BrokerPublisher;
import com.googlesource.gerrit.plugins.multisite.broker.BrokerSession;
-import com.googlesource.gerrit.plugins.multisite.broker.GsonProvider;
import com.googlesource.gerrit.plugins.multisite.broker.kafka.KafkaSession;
import com.googlesource.gerrit.plugins.multisite.forwarder.CacheEvictionForwarder;
import com.googlesource.gerrit.plugins.multisite.forwarder.IndexEventForwarder;
@@ -38,7 +35,6 @@
@Override
protected void configure() {
- bind(Gson.class).toProvider(GsonProvider.class).in(Singleton.class);
listener().to(BrokerPublisher.class);
bind(BrokerSession.class).to(KafkaSession.class);
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/AbstractKafkaSubcriber.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/AbstractKafkaSubcriber.java
index fa73964..25200ad 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/AbstractKafkaSubcriber.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/AbstractKafkaSubcriber.java
@@ -21,11 +21,11 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.gson.Gson;
import com.google.gwtorm.server.OrmException;
-import com.google.inject.Provider;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.InstanceId;
import com.googlesource.gerrit.plugins.multisite.MessageLogger;
import com.googlesource.gerrit.plugins.multisite.MessageLogger.Direction;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.EventFamily;
import com.googlesource.gerrit.plugins.multisite.kafka.router.ForwardedEventRouter;
import java.io.IOException;
@@ -46,7 +46,7 @@
private final KafkaConsumer<byte[], byte[]> consumer;
private final ForwardedEventRouter eventRouter;
private final DynamicSet<DroppedEventListener> droppedEventListeners;
- private final Provider<Gson> gsonProvider;
+ private final Gson gson;
private final UUID instanceId;
private final AtomicBoolean closed = new AtomicBoolean(false);
private final Deserializer<SourceAwareEventWrapper> valueDeserializer;
@@ -60,14 +60,14 @@
Deserializer<SourceAwareEventWrapper> valueDeserializer,
ForwardedEventRouter eventRouter,
DynamicSet<DroppedEventListener> droppedEventListeners,
- Provider<Gson> gsonProvider,
+ @BrokerGson Gson gson,
@InstanceId UUID instanceId,
OneOffRequestContext oneOffCtx,
MessageLogger msgLog) {
this.configuration = configuration;
this.eventRouter = eventRouter;
this.droppedEventListeners = droppedEventListeners;
- this.gsonProvider = gsonProvider;
+ this.gson = gson;
this.instanceId = instanceId;
this.oneOffCtx = oneOffCtx;
this.msgLog = msgLog;
@@ -122,7 +122,7 @@
} else {
try {
msgLog.log(Direction.CONSUME, event);
- eventRouter.route(event.getEventBody(gsonProvider));
+ eventRouter.route(event.getEventBody(gson));
} catch (IOException e) {
logger.atSevere().withCause(e).log(
"Malformed event '%s': [Exception: %s]", event.getHeader().getEventType());
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/CacheEvictionEventSubscriber.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/CacheEvictionEventSubscriber.java
index 0e33c00..8e724be 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/CacheEvictionEventSubscriber.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/CacheEvictionEventSubscriber.java
@@ -18,11 +18,11 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.gson.Gson;
import com.google.inject.Inject;
-import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.InstanceId;
import com.googlesource.gerrit.plugins.multisite.MessageLogger;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.EventFamily;
import com.googlesource.gerrit.plugins.multisite.kafka.router.StreamEventRouter;
import java.util.UUID;
@@ -37,7 +37,7 @@
Deserializer<SourceAwareEventWrapper> valueDeserializer,
StreamEventRouter eventRouter,
DynamicSet<DroppedEventListener> droppedEventListeners,
- Provider<Gson> gsonProvider,
+ @BrokerGson Gson gsonProvider,
@InstanceId UUID instanceId,
OneOffRequestContext oneOffCtx,
MessageLogger msgLog) {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/IndexEventSubscriber.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/IndexEventSubscriber.java
index b61d23d..e52b624 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/IndexEventSubscriber.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/IndexEventSubscriber.java
@@ -18,11 +18,11 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.gson.Gson;
import com.google.inject.Inject;
-import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.InstanceId;
import com.googlesource.gerrit.plugins.multisite.MessageLogger;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.EventFamily;
import com.googlesource.gerrit.plugins.multisite.kafka.router.IndexEventRouter;
import java.util.UUID;
@@ -37,7 +37,7 @@
Deserializer<SourceAwareEventWrapper> valueDeserializer,
IndexEventRouter eventRouter,
DynamicSet<DroppedEventListener> droppedEventListeners,
- Provider<Gson> gsonProvider,
+ @BrokerGson Gson gsonProvider,
@InstanceId UUID instanceId,
OneOffRequestContext oneOffCtx,
MessageLogger msgLog) {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializer.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializer.java
index 9a589df..6e86d25 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializer.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializer.java
@@ -16,8 +16,8 @@
import com.google.gson.Gson;
import com.google.inject.Inject;
-import com.google.inject.Provider;
import com.google.inject.Singleton;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import java.util.Map;
import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.StringDeserializer;
@@ -26,29 +26,24 @@
public class KafkaEventDeserializer implements Deserializer<SourceAwareEventWrapper> {
private final StringDeserializer stringDeserializer = new StringDeserializer();
- private Provider<Gson> gsonProvider;
+ private Gson gson;
// To be used when providing this deserializer with class name (then need to add a configuration
// entry to set the gson.provider
public KafkaEventDeserializer() {}
@Inject
- public KafkaEventDeserializer(Provider<Gson> gsonProvider) {
- this.gsonProvider = gsonProvider;
+ public KafkaEventDeserializer(@BrokerGson Gson gson) {
+ this.gson = gson;
}
- @SuppressWarnings("unchecked")
@Override
- public void configure(Map<String, ?> configs, boolean isKey) {
- gsonProvider = (Provider<Gson>) configs.get("gson.provider");
- }
+ public void configure(Map<String, ?> configs, boolean isKey) {}
@Override
public SourceAwareEventWrapper deserialize(String topic, byte[] data) {
final SourceAwareEventWrapper result =
- gsonProvider
- .get()
- .fromJson(stringDeserializer.deserialize(topic, data), SourceAwareEventWrapper.class);
+ gson.fromJson(stringDeserializer.deserialize(topic, data), SourceAwareEventWrapper.class);
result.validate();
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/ProjectUpdateEventSubscriber.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/ProjectUpdateEventSubscriber.java
index 207848e..a949cd2 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/ProjectUpdateEventSubscriber.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/ProjectUpdateEventSubscriber.java
@@ -18,11 +18,11 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.gson.Gson;
import com.google.inject.Inject;
-import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.InstanceId;
import com.googlesource.gerrit.plugins.multisite.MessageLogger;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.EventFamily;
import com.googlesource.gerrit.plugins.multisite.kafka.router.ProjectListUpdateRouter;
import java.util.UUID;
@@ -37,7 +37,7 @@
Deserializer<SourceAwareEventWrapper> valueDeserializer,
ProjectListUpdateRouter eventRouter,
DynamicSet<DroppedEventListener> droppedEventListeners,
- Provider<Gson> gsonProvider,
+ @BrokerGson Gson gson,
@InstanceId UUID instanceId,
OneOffRequestContext oneOffCtx,
MessageLogger msgLog) {
@@ -47,7 +47,7 @@
valueDeserializer,
eventRouter,
droppedEventListeners,
- gsonProvider,
+ gson,
instanceId,
oneOffCtx,
msgLog);
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/SourceAwareEventWrapper.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/SourceAwareEventWrapper.java
index a618dfc..09fbe0d 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/SourceAwareEventWrapper.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/SourceAwareEventWrapper.java
@@ -17,7 +17,6 @@
import com.google.gerrit.server.events.Event;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
-import com.google.inject.Provider;
import java.util.UUID;
import org.apache.commons.lang3.Validate;
@@ -34,8 +33,8 @@
return body;
}
- public Event getEventBody(Provider<Gson> gsonProvider) {
- return gsonProvider.get().fromJson(this.body, Event.class);
+ public Event getEventBody(Gson gson) {
+ return gson.fromJson(this.body, Event.class);
}
public static class EventHeader {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/StreamEventSubscriber.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/StreamEventSubscriber.java
index c55be53..d43a3c3 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/StreamEventSubscriber.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/StreamEventSubscriber.java
@@ -18,11 +18,11 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.gson.Gson;
import com.google.inject.Inject;
-import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.InstanceId;
import com.googlesource.gerrit.plugins.multisite.MessageLogger;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.EventFamily;
import com.googlesource.gerrit.plugins.multisite.kafka.router.StreamEventRouter;
import java.util.UUID;
@@ -37,7 +37,7 @@
Deserializer<SourceAwareEventWrapper> valueDeserializer,
StreamEventRouter eventRouter,
DynamicSet<DroppedEventListener> droppedEventListeners,
- Provider<Gson> gsonProvider,
+ @BrokerGson Gson gson,
@InstanceId UUID instanceId,
OneOffRequestContext oneOffCtx,
MessageLogger msgLog) {
@@ -47,7 +47,7 @@
valueDeserializer,
eventRouter,
droppedEventListeners,
- gsonProvider,
+ gson,
instanceId,
oneOffCtx,
msgLog);
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/EventConsumerIT.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/EventConsumerIT.java
index 45f02dc..674e8de 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/EventConsumerIT.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/EventConsumerIT.java
@@ -33,13 +33,14 @@
import com.google.gerrit.server.events.PatchSetCreatedEvent;
import com.google.gerrit.server.events.RefUpdatedEvent;
import com.google.gerrit.server.query.change.ChangeData;
+import com.google.gson.Gson;
import com.google.inject.Inject;
import com.google.inject.Key;
import com.google.inject.TypeLiteral;
import com.googlesource.gerrit.plugins.multisite.Configuration;
import com.googlesource.gerrit.plugins.multisite.Module;
import com.googlesource.gerrit.plugins.multisite.NoteDbStatus;
-import com.googlesource.gerrit.plugins.multisite.broker.GsonProvider;
+import com.googlesource.gerrit.plugins.multisite.broker.BrokerGson;
import com.googlesource.gerrit.plugins.multisite.forwarder.events.ChangeIndexEvent;
import java.io.IOException;
import java.util.ArrayList;
@@ -250,11 +251,11 @@
private List<Event> drainQueue(LinkedBlockingQueue<SourceAwareEventWrapper> queue)
throws InterruptedException {
- GsonProvider gsonProvider = server.getTestInjector().getInstance(Key.get(GsonProvider.class));
+ Gson gson = server.getTestInjector().getInstance(Key.get(Gson.class, BrokerGson.class));
SourceAwareEventWrapper event;
List<Event> eventsList = new ArrayList<>();
while ((event = queue.poll(QUEUE_POLL_TIMEOUT_MSECS, TimeUnit.MILLISECONDS)) != null) {
- eventsList.add(event.getEventBody(gsonProvider));
+ eventsList.add(event.getEventBody(gson));
}
return eventsList;
}
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializerTest.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializerTest.java
index 4a3b466..ce958cf 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializerTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/kafka/consumer/KafkaEventDeserializerTest.java
@@ -17,7 +17,6 @@
import static com.google.common.truth.Truth.assertThat;
import com.google.gson.Gson;
-import com.google.inject.Provider;
import com.googlesource.gerrit.plugins.multisite.broker.GsonProvider;
import java.util.UUID;
import org.junit.Before;
@@ -28,8 +27,8 @@
@Before
public void setUp() {
- final Provider<Gson> gsonProvider = new GsonProvider();
- deserializer = new KafkaEventDeserializer(gsonProvider);
+ final Gson gson = new GsonProvider().get();
+ deserializer = new KafkaEventDeserializer(gson);
}
@Test
