Rename ForwardedEventHandler to ForwardedEventDispatcher
Renames the `ForwardedEventHandler` class and all of its usages to
`ForwardedEventDispatcher` to better reflect its actual responsibility.
Despite its previous name, the class does not handle stream events but
instead dispatches them to the internal Gerrit event bus.
This renaming improves code clarity by aligning the class name with its
true role, as described in its documentation. It also prepares the
codebase for the introduction of new handler classes that will take on
actual event handling responsibilities, separate from internal
dispatching.
All relevant imports, variables, and test cases have been updated to use
the new class name.
Change-Id: Ib52857c06051d4d789e6b939ce8e3691979035db
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandler.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcher.java
similarity index 87%
rename from src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandler.java
rename to src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcher.java
index e2e3954..aeee827 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandler.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcher.java
@@ -22,23 +22,24 @@
import com.google.gerrit.server.util.OneOffRequestContext;
import com.google.inject.Inject;
import com.google.inject.Singleton;
+import com.googlesource.gerrit.plugins.multisite.forwarder.router.StreamEventRouter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Dispatch event to the {@link EventDispatcher}. This class is meant to be used on the receiving
- * side of the {@link StreamEventForwarder} since it will prevent dispatched event to be forwarded
+ * side of the {@link StreamEventRouter} since it will prevent dispatched event to be forwarded
* again causing an infinite forwarding loop between the 2 nodes.
*/
@Singleton
-public class ForwardedEventHandler {
- private static final Logger log = LoggerFactory.getLogger(ForwardedEventHandler.class);
+public class ForwardedEventDispatcher {
+ private static final Logger log = LoggerFactory.getLogger(ForwardedEventDispatcher.class);
private final DynamicItem<EventDispatcher> dispatcher;
private final OneOffRequestContext oneOffCtx;
@Inject
- public ForwardedEventHandler(
+ public ForwardedEventDispatcher(
DynamicItem<EventDispatcher> dispatcher, OneOffRequestContext oneOffCtx) {
this.dispatcher = dispatcher;
this.oneOffCtx = oneOffCtx;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/router/StreamEventRouter.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/router/StreamEventRouter.java
index 95a3e66..c88f5cb 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/router/StreamEventRouter.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/forwarder/router/StreamEventRouter.java
@@ -17,18 +17,18 @@
import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.inject.Inject;
-import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventHandler;
+import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventDispatcher;
import com.googlesource.gerrit.plugins.replication.events.RefReplicationDoneEvent;
import java.io.IOException;
public class StreamEventRouter implements ForwardedEventRouter<Event> {
- private final ForwardedEventHandler streamEventHandler;
+ private final ForwardedEventDispatcher forwardedEventDispatcher;
private final IndexEventRouter indexEventRouter;
@Inject
public StreamEventRouter(
- ForwardedEventHandler streamEventHandler, IndexEventRouter indexEventRouter) {
- this.streamEventHandler = streamEventHandler;
+ ForwardedEventDispatcher forwardedEventDispatcher, IndexEventRouter indexEventRouter) {
+ this.forwardedEventDispatcher = forwardedEventDispatcher;
this.indexEventRouter = indexEventRouter;
}
@@ -44,6 +44,6 @@
indexEventRouter.onRefReplicated((RefReplicationDoneEvent) sourceEvent);
}
- streamEventHandler.dispatch(sourceEvent);
+ forwardedEventDispatcher.dispatch(sourceEvent);
}
}
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/event/IndexEventRouterTest.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/event/IndexEventRouterTest.java
index 4ffdbbc..4fa1735 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/multisite/event/IndexEventRouterTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/event/IndexEventRouterTest.java
@@ -20,7 +20,7 @@
import com.google.gerrit.entities.Account;
import com.google.gerrit.server.config.AllUsersName;
-import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventHandler;
+import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventDispatcher;
import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedIndexAccountHandler;
import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedIndexChangeHandler;
import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedIndexGroupHandler;
@@ -50,7 +50,7 @@
@Mock private ForwardedIndexChangeHandler indexChangeHandler;
@Mock private ForwardedIndexGroupHandler indexGroupHandler;
@Mock private ForwardedIndexProjectHandler indexProjectHandler;
- @Mock private ForwardedEventHandler forwardedEventHandler;
+ @Mock private ForwardedEventDispatcher forwardedEventDispatcher;
private AllUsersName allUsersName = new AllUsersName("All-Users");
@Before
@@ -79,7 +79,7 @@
@Test
public void streamEventRouterShouldTriggerAccountIndexFlush() throws Exception {
- StreamEventRouter streamEventRouter = new StreamEventRouter(forwardedEventHandler, router);
+ StreamEventRouter streamEventRouter = new StreamEventRouter(forwardedEventDispatcher, router);
final AccountIndexEvent event = new AccountIndexEvent(1, INSTANCE_ID);
router.route(event);
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/event/StreamEventRouterTest.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/event/StreamEventRouterTest.java
index ac90436..8d02c20 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/multisite/event/StreamEventRouterTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/event/StreamEventRouterTest.java
@@ -21,7 +21,7 @@
import com.google.gerrit.entities.Change;
import com.google.gerrit.server.events.CommentAddedEvent;
import com.google.gerrit.server.util.time.TimeUtil;
-import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventHandler;
+import com.googlesource.gerrit.plugins.multisite.forwarder.ForwardedEventDispatcher;
import com.googlesource.gerrit.plugins.multisite.forwarder.router.IndexEventRouter;
import com.googlesource.gerrit.plugins.multisite.forwarder.router.StreamEventRouter;
import org.junit.Before;
@@ -34,19 +34,19 @@
public class StreamEventRouterTest {
private StreamEventRouter router;
- @Mock private ForwardedEventHandler streamEventHandler;
+ @Mock private ForwardedEventDispatcher forwardedEventDispatcher;
@Mock private IndexEventRouter indexEventRouter;
@Before
public void setUp() {
- router = new StreamEventRouter(streamEventHandler, indexEventRouter);
+ router = new StreamEventRouter(forwardedEventDispatcher, indexEventRouter);
}
@Test
public void routerShouldSendEventsToTheAppropriateHandler_StreamEvent() throws Exception {
final CommentAddedEvent event = new CommentAddedEvent(aChange());
router.route(event);
- verify(streamEventHandler).dispatch(event);
+ verify(forwardedEventDispatcher).dispatch(event);
}
private Change aChange() {
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandlerTest.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcherTest.java
similarity index 87%
rename from src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandlerTest.java
rename to src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcherTest.java
index 73ef353..bf70f62 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventHandlerTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/forwarder/ForwardedEventDispatcherTest.java
@@ -31,24 +31,24 @@
import org.mockito.junit.MockitoJUnitRunner;
@RunWith(MockitoJUnitRunner.class)
-public class ForwardedEventHandlerTest {
+public class ForwardedEventDispatcherTest {
@Rule public ExpectedException exception = ExpectedException.none();
@Mock private DynamicItem<EventDispatcher> dispatcherMockItem;
@Mock private EventDispatcher dispatcherMock;
@Mock OneOffRequestContext oneOffCtxMock;
- private ForwardedEventHandler handler;
+ private ForwardedEventDispatcher forwardedEventDispatcher;
@Before
public void setUp() throws Exception {
when(dispatcherMockItem.get()).thenReturn(dispatcherMock);
- handler = new ForwardedEventHandler(dispatcherMockItem, oneOffCtxMock);
+ forwardedEventDispatcher = new ForwardedEventDispatcher(dispatcherMockItem, oneOffCtxMock);
}
@Test
public void testSuccessfulDispatching() throws Exception {
Event event = new ProjectCreatedEvent();
- handler.dispatch(event);
+ forwardedEventDispatcher.dispatch(event);
verify(dispatcherMock).postEvent(event);
}
}
