From 097e0ae38a18f20bc1228416d29d4c9e9dd4cc62 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 31 Jan 2018 13:40:23 -0800 Subject: [PATCH 1/2] rename ActivateNotification to ActivateNotificationListener same with TrackNotificationListener --- ...java => ActivateNotificationListener.java} | 13 +++++----- .../ab/notification/NotificationCenter.java | 4 ++-- .../ab/notification/NotificationListener.java | 2 +- ...on.java => TrackNotificationListener.java} | 2 +- .../com/optimizely/ab/OptimizelyTest.java | 24 +++++++++---------- .../notification/NotificationCenterTest.java | 17 ++++++++----- 6 files changed, 34 insertions(+), 28 deletions(-) rename core-api/src/main/java/com/optimizely/ab/notification/{ActivateNotification.java => ActivateNotificationListener.java} (81%) rename core-api/src/main/java/com/optimizely/ab/notification/{TrackNotification.java => TrackNotificationListener.java} (96%) diff --git a/core-api/src/main/java/com/optimizely/ab/notification/ActivateNotification.java b/core-api/src/main/java/com/optimizely/ab/notification/ActivateNotificationListener.java similarity index 81% rename from core-api/src/main/java/com/optimizely/ab/notification/ActivateNotification.java rename to core-api/src/main/java/com/optimizely/ab/notification/ActivateNotificationListener.java index 9ee96afc9..e0843d745 100644 --- a/core-api/src/main/java/com/optimizely/ab/notification/ActivateNotification.java +++ b/core-api/src/main/java/com/optimizely/ab/notification/ActivateNotificationListener.java @@ -21,10 +21,11 @@ import com.optimizely.ab.config.Variation; import com.optimizely.ab.event.LogEvent; +import javax.annotation.Nonnull; import java.util.Map; -public abstract class ActivateNotification extends NotificationListener { +public abstract class ActivateNotificationListener extends NotificationListener { /** * Base notify called with var args. This method parses the parameters and calls the abstract method. @@ -54,11 +55,11 @@ public final void notify(Object... args) { * @param variation - The variation that was returned from activate. * @param event - The impression event that was triggered. */ - public abstract void onActivate(@javax.annotation.Nonnull Experiment experiment, - @javax.annotation.Nonnull String userId, - @javax.annotation.Nonnull Map attributes, - @javax.annotation.Nonnull Variation variation, - @javax.annotation.Nonnull LogEvent event) ; + public abstract void onActivate(@Nonnull Experiment experiment, + @Nonnull String userId, + @Nonnull Map attributes, + @Nonnull Variation variation, + @Nonnull LogEvent event) ; } diff --git a/core-api/src/main/java/com/optimizely/ab/notification/NotificationCenter.java b/core-api/src/main/java/com/optimizely/ab/notification/NotificationCenter.java index a538fe3fa..7cd270925 100644 --- a/core-api/src/main/java/com/optimizely/ab/notification/NotificationCenter.java +++ b/core-api/src/main/java/com/optimizely/ab/notification/NotificationCenter.java @@ -34,8 +34,8 @@ public class NotificationCenter { */ public enum NotificationType { - Activate(ActivateNotification.class), // Activate was called. Track an impression event - Track(TrackNotification.class); // Track was called. Track a conversion event + Activate(ActivateNotificationListener.class), // Activate was called. Track an impression event + Track(TrackNotificationListener.class); // Track was called. Track a conversion event private Class notificationTypeClass; diff --git a/core-api/src/main/java/com/optimizely/ab/notification/NotificationListener.java b/core-api/src/main/java/com/optimizely/ab/notification/NotificationListener.java index 012e250d7..3072f3921 100644 --- a/core-api/src/main/java/com/optimizely/ab/notification/NotificationListener.java +++ b/core-api/src/main/java/com/optimizely/ab/notification/NotificationListener.java @@ -69,7 +69,7 @@ public void onExperimentActivated(@Nonnull Experiment experiment, } /** - * This is the new method of notification. Implementation classes such as {@link com.optimizely.ab.notification.ActivateNotification} + * This is the new method of notification. Implementation classes such as {@link ActivateNotificationListener} * will implement this call and provide another method with the correct parameters * Notify called when a notification is triggered via the {@link com.optimizely.ab.notification.NotificationCenter} * @param args - variable argument list based on the type of notification. diff --git a/core-api/src/main/java/com/optimizely/ab/notification/TrackNotification.java b/core-api/src/main/java/com/optimizely/ab/notification/TrackNotificationListener.java similarity index 96% rename from core-api/src/main/java/com/optimizely/ab/notification/TrackNotification.java rename to core-api/src/main/java/com/optimizely/ab/notification/TrackNotificationListener.java index 3ba9e3153..bdf3c19fd 100644 --- a/core-api/src/main/java/com/optimizely/ab/notification/TrackNotification.java +++ b/core-api/src/main/java/com/optimizely/ab/notification/TrackNotificationListener.java @@ -24,7 +24,7 @@ /** * This class handles the track event notification. */ -public abstract class TrackNotification extends NotificationListener { +public abstract class TrackNotificationListener extends NotificationListener { /** * Base notify called with var args. This method parses the parameters and calls the abstract method. diff --git a/core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java b/core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java index 96e929690..d4065743a 100644 --- a/core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java +++ b/core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java @@ -37,10 +37,10 @@ import com.optimizely.ab.event.LogEvent; import com.optimizely.ab.event.internal.EventBuilder; import com.optimizely.ab.internal.LogbackVerifier; -import com.optimizely.ab.notification.ActivateNotification; +import com.optimizely.ab.notification.ActivateNotificationListener; import com.optimizely.ab.notification.NotificationCenter; import com.optimizely.ab.notification.NotificationListener; -import com.optimizely.ab.notification.TrackNotification; +import com.optimizely.ab.notification.TrackNotificationListener; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import org.junit.Rule; import org.junit.Test; @@ -2215,7 +2215,7 @@ public void activateWithListener() throws Exception { testUserAttributes.put(testBucketingIdKey, testBucketingId); - ActivateNotification activateNotification = new ActivateNotification() { + ActivateNotificationListener activateNotification = new ActivateNotificationListener() { @Override public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map attributes, @Nonnull Variation variation, @Nonnull LogEvent event) { assertEquals(experiment.getKey(), activatedExperiment.getKey()); @@ -2283,7 +2283,7 @@ public void activateWithListenerNullAttributes() throws Exception { when(mockBucketer.bucket(activatedExperiment, testUserId)) .thenReturn(bucketedVariation); - ActivateNotification activateNotification = new ActivateNotification() { + ActivateNotificationListener activateNotification = new ActivateNotificationListener() { @Override public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map attributes, @Nonnull Variation variation, @Nonnull LogEvent event) { assertEquals(experiment.getKey(), activatedExperiment.getKey()); @@ -2608,7 +2608,7 @@ public void addNotificationListenerFromNotificationCenter() throws Exception { .thenReturn(bucketedVariation); // Add listener - ActivateNotification listener = mock(ActivateNotification.class); + ActivateNotificationListener listener = mock(ActivateNotificationListener.class); optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Activate, listener); // Check if listener is notified when experiment is activated @@ -2636,7 +2636,7 @@ public void addNotificationListenerFromNotificationCenter() throws Exception { anyMapOf(String.class, Object.class))) .thenReturn(logEventToDispatch); - TrackNotification trackNotification = mock(TrackNotification.class); + TrackNotificationListener trackNotification = mock(TrackNotificationListener.class); optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Track, trackNotification); @@ -2680,11 +2680,11 @@ public void removeNotificationListenerNotificationCenter() throws Exception { .thenReturn(logEventToDispatch); // Add and remove listener - ActivateNotification activateNotification = mock(ActivateNotification.class); + ActivateNotificationListener activateNotification = mock(ActivateNotificationListener.class); int notificationId = optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Activate, activateNotification); assertTrue(optimizely.notificationCenter.removeNotification(notificationId)); - TrackNotification trackNotification = mock(TrackNotification.class); + TrackNotificationListener trackNotification = mock(TrackNotificationListener.class); notificationId = optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Track, trackNotification); assertTrue(optimizely.notificationCenter.removeNotification(notificationId)); @@ -2771,8 +2771,8 @@ public void clearNotificationListenersNotificationCenter() throws Exception { attributeCaptor.capture() )).thenReturn(logEventToDispatch); - ActivateNotification activateNotification = mock(ActivateNotification.class); - TrackNotification trackNotification = mock(TrackNotification.class); + ActivateNotificationListener activateNotification = mock(ActivateNotificationListener.class); + TrackNotificationListener trackNotification = mock(TrackNotificationListener.class); optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Activate, activateNotification); optimizely.notificationCenter.addNotification(NotificationCenter.NotificationType.Track, trackNotification); @@ -2870,7 +2870,7 @@ public void trackEventWithListenerAttributes() throws Exception { logbackVerifier.expectMessage(Level.DEBUG, "Dispatching conversion event to URL test_url with params " + testParams + " and payload \"\""); - TrackNotification trackNotification = new TrackNotification() { + TrackNotificationListener trackNotification = new TrackNotificationListener() { @Override public void onTrack(@Nonnull String eventKey, @Nonnull String userId, @Nonnull Map _attributes, @Nonnull Map eventTags, @Nonnull LogEvent event) { assertEquals(eventType.getKey(), eventKey); @@ -2956,7 +2956,7 @@ public void trackEventWithListenerNullAttributes() throws Exception { logbackVerifier.expectMessage(Level.DEBUG, "Dispatching conversion event to URL test_url with params " + testParams + " and payload \"\""); - TrackNotification trackNotification = new TrackNotification() { + TrackNotificationListener trackNotification = new TrackNotificationListener() { @Override public void onTrack(@Nonnull String eventKey, @Nonnull String userId, @Nonnull Map attributes, @Nonnull Map eventTags, @Nonnull LogEvent event) { assertEquals(eventType.getKey(), eventKey); diff --git a/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java b/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java index e23e1e695..0f1091812 100644 --- a/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java +++ b/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java @@ -1,12 +1,16 @@ package com.optimizely.ab.notification; import ch.qos.logback.classic.Level; +import com.optimizely.ab.config.Experiment; +import com.optimizely.ab.config.Variation; +import com.optimizely.ab.event.LogEvent; import com.optimizely.ab.internal.LogbackVerifier; import org.junit.Before; import org.junit.Rule; import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; + +import javax.annotation.Nonnull; +import java.util.Map; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; @@ -14,8 +18,8 @@ public class NotificationCenterTest { private NotificationCenter notificationCenter; - private ActivateNotification activateNotification; - private TrackNotification trackNotification; + private ActivateNotificationListener activateNotification; + private TrackNotificationListener trackNotification; @Rule public LogbackVerifier logbackVerifier = new LogbackVerifier(); @@ -23,8 +27,8 @@ public class NotificationCenterTest { @Before public void initialize() { notificationCenter = new NotificationCenter(); - activateNotification = mock(ActivateNotification.class); - trackNotification = mock(TrackNotification.class); + activateNotification = mock(ActivateNotificationListener.class); + trackNotification = mock(TrackNotificationListener.class); } @Test @@ -33,6 +37,7 @@ public void testAddWrongTrackNotificationListener() { logbackVerifier.expectMessage(Level.WARN,"Notification listener was the wrong type. It was not added to the notification center."); assertEquals(notificationId, -1); assertFalse(notificationCenter.removeNotification(notificationId)); + } @Test From 39e1d9849bb37d8715603434bb15c021b8f7f86f Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 31 Jan 2018 13:52:13 -0800 Subject: [PATCH 2/2] remove unused imports --- .../com/optimizely/ab/notification/NotificationCenterTest.java | 3 --- 1 file changed, 3 deletions(-) diff --git a/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java b/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java index 0f1091812..f6a4eb1cd 100644 --- a/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java +++ b/core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java @@ -1,9 +1,6 @@ package com.optimizely.ab.notification; import ch.qos.logback.classic.Level; -import com.optimizely.ab.config.Experiment; -import com.optimizely.ab.config.Variation; -import com.optimizely.ab.event.LogEvent; import com.optimizely.ab.internal.LogbackVerifier; import org.junit.Before; import org.junit.Rule;