Decorated impressions

src/androidTest/java/fake/SyncManagerStub.java

@@ -1,7 +1,7 @@
 package fake;
 
 import io.split.android.client.dtos.Event;
-import io.split.android.client.impressions.Impression;
+import io.split.android.client.impressions.DecoratedImpression;
 import io.split.android.client.service.synchronizer.SyncManager;
 import io.split.android.client.shared.UserConsent;
 
@@ -42,6 +42,6 @@ public void pushEvent(Event event) {
     }
 
     @Override
-    public void pushImpression(Impression impression) {
+    public void pushImpression(DecoratedImpression impression) {
     }
 }

src/androidTest/java/fake/SynchronizerSpyImpl.java

@@ -5,7 +5,7 @@
 
 import io.split.android.client.api.Key;
 import io.split.android.client.dtos.Event;
-import io.split.android.client.impressions.Impression;
+import io.split.android.client.impressions.DecoratedImpression;
 import io.split.android.client.service.synchronizer.Synchronizer;
 import io.split.android.client.service.synchronizer.SynchronizerSpy;
 import io.split.android.client.service.synchronizer.attributes.AttributesSynchronizer;
@@ -88,7 +88,7 @@ public void pushEvent(Event event) {
     }
 
     @Override
-    public void pushImpression(Impression impression) {
+    public void pushImpression(DecoratedImpression impression) {
         mSynchronizer.pushImpression(impression);
     }
 

src/main/java/io/split/android/client/EvaluationResult.java

@@ -1,24 +1,33 @@
 package io.split.android.client;
 
+import androidx.annotation.VisibleForTesting;
+
 public final class EvaluationResult {
     private final String mTreatment;
     private final String mLabel;
     private final Long mChangeNumber;
     private final String mConfigurations;
+    private final boolean mTrackImpression;
 
+    @VisibleForTesting
     public EvaluationResult(String treatment, String label) {
-        this(treatment, label, null);
+        this(treatment, label, null, null, true);
+    }
+
+    public EvaluationResult(String treatment, String label, boolean trackImpression) {
+        this(treatment, label, null, null, trackImpression);
     }
 
-    EvaluationResult(String treatment, String label, Long changeNumber) {
-        this(treatment, label, changeNumber, null);
+    EvaluationResult(String treatment, String label, Long changeNumber, boolean trackImpression) {
+        this(treatment, label, changeNumber, null, trackImpression);
     }
 
-    public EvaluationResult(String treatment, String label, Long changeNumber, String configurations) {
+    public EvaluationResult(String treatment, String label, Long changeNumber, String configurations, boolean trackImpression) {
         mTreatment = treatment;
         mLabel = label;
         mChangeNumber = changeNumber;
         mConfigurations = configurations;
+        mTrackImpression = trackImpression;
     }
 
     public String getTreatment() {
@@ -36,4 +45,8 @@ public Long getChangeNumber() {
     public String getConfigurations() {
         return mConfigurations;
     }
+
+    public boolean getTrackImpression() {
+        return mTrackImpression;
+    }
 }

src/main/java/io/split/android/client/EvaluatorImpl.java

@@ -28,16 +28,16 @@ public EvaluationResult getTreatment(String matchingKey, String bucketingKey, St
         try {
             ParsedSplit parsedSplit = mSplitParser.parse(mSplitsStorage.get(splitName), matchingKey);
             if (parsedSplit == null) {
-                return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.DEFINITION_NOT_FOUND);
+                return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.DEFINITION_NOT_FOUND, true);
             }
 
             return getTreatment(matchingKey, bucketingKey, parsedSplit, attributes);
         } catch (ChangeNumberExceptionWrapper ex) {
             Logger.e(ex, "Catch Change Number Exception");
-            return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.EXCEPTION, ex.changeNumber());
+            return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.EXCEPTION, ex.changeNumber(), true);
         } catch (Exception e) {
             Logger.e(e, "Catch All Exception");
-            return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.EXCEPTION);
+            return new EvaluationResult(Treatments.CONTROL, TreatmentLabels.EXCEPTION, true);
         }
     }
 
@@ -52,7 +52,7 @@ public EvaluationResult getTreatment(String matchingKey, String bucketingKey, St
     private EvaluationResult getTreatment(String matchingKey, String bucketingKey, ParsedSplit parsedSplit, Map<String, Object> attributes) throws ChangeNumberExceptionWrapper {
         try {
             if (parsedSplit.killed()) {
-                return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.KILLED, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()));
+                return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.KILLED, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()), parsedSplit.trackImpressions());
             }
 
             /*
@@ -75,7 +75,7 @@ private EvaluationResult getTreatment(String matchingKey, String bucketingKey, P
 
                         if (bucket > parsedSplit.trafficAllocation()) {
                             // out of split
-                            return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.NOT_IN_SPLIT, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()));
+                            return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.NOT_IN_SPLIT, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()), parsedSplit.trackImpressions());
                         }
 
                     }
@@ -84,11 +84,11 @@ private EvaluationResult getTreatment(String matchingKey, String bucketingKey, P
 
                 if (parsedCondition.matcher().match(matchingKey, bucketingKey, attributes, this)) {
                     String treatment = Splitter.getTreatment(bk, parsedSplit.seed(), parsedCondition.partitions(), parsedSplit.algo());
-                    return new EvaluationResult(treatment, parsedCondition.label(), parsedSplit.changeNumber(), configForTreatment(parsedSplit, treatment));
+                    return new EvaluationResult(treatment, parsedCondition.label(), parsedSplit.changeNumber(), configForTreatment(parsedSplit, treatment), parsedSplit.trackImpressions());
                 }
             }
 
-            return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.DEFAULT_RULE, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()));
+            return new EvaluationResult(parsedSplit.defaultTreatment(), TreatmentLabels.DEFAULT_RULE, parsedSplit.changeNumber(), configForTreatment(parsedSplit, parsedSplit.defaultTreatment()), parsedSplit.trackImpressions());
         } catch (Exception e) {
             throw new ChangeNumberExceptionWrapper(e, parsedSplit.changeNumber());
         }

src/main/java/io/split/android/client/SplitClientFactoryImpl.java

@@ -17,9 +17,9 @@
 import io.split.android.client.service.mysegments.MySegmentsTaskFactory;
 import io.split.android.client.service.synchronizer.SyncManager;
 import io.split.android.client.shared.SplitClientContainer;
-import io.split.android.client.storage.common.SplitStorageContainer;
 import io.split.android.client.storage.attributes.AttributesStorage;
 import io.split.android.client.storage.attributes.PersistentAttributesStorage;
+import io.split.android.client.storage.common.SplitStorageContainer;
 import io.split.android.client.storage.splits.SplitsStorage;
 import io.split.android.client.telemetry.TelemetrySynchronizer;
 import io.split.android.client.telemetry.storage.TelemetryInitProducer;
@@ -43,7 +43,7 @@ public class SplitClientFactoryImpl implements SplitClientFactory {
     private final SplitParser mSplitParser;
     private final AttributesManagerFactory mAttributesManagerFactory;
     private final TreatmentManagerFactory mTreatmentManagerFactory;
-    private final ImpressionListener mCustomerImpressionListener;
+    private final ImpressionListener.FederatedImpressionListener mCustomerImpressionListener;
     private final SplitValidatorImpl mSplitValidator;
     private final EventsTracker mEventsTracker;
 
@@ -57,7 +57,7 @@ public SplitClientFactoryImpl(@NonNull SplitFactory splitFactory,
                                   @NonNull ValidationMessageLogger validationLogger,
                                   @NonNull KeyValidator keyValidator,
                                   @NonNull EventsTracker eventsTracker,
-                                  @NonNull ImpressionListener customerImpressionListener,
+                                  @NonNull ImpressionListener.FederatedImpressionListener customerImpressionListener,
                                   @Nullable FlagSetsFilter flagSetsFilter) {
         mSplitFactory = checkNotNull(splitFactory);
         mClientContainer = checkNotNull(clientContainer);

src/main/java/io/split/android/client/SplitFactoryImpl.java

@@ -20,6 +20,7 @@
 import io.split.android.client.events.EventsManagerCoordinator;
 import io.split.android.client.factory.FactoryMonitor;
 import io.split.android.client.factory.FactoryMonitorImpl;
+import io.split.android.client.impressions.DecoratedImpressionListener;
 import io.split.android.client.impressions.ImpressionListener;
 import io.split.android.client.impressions.SyncImpressionListener;
 import io.split.android.client.lifecycle.SplitLifecycleManager;
@@ -243,17 +244,16 @@ private SplitFactoryImpl(@NonNull String apiToken, @NonNull Key key, @NonNull Sp
         }
 
         ExecutorService impressionsLoggingTaskExecutor = factoryHelper.getImpressionsLoggingTaskExecutor();
-        final ImpressionListener splitImpressionListener
+        final DecoratedImpressionListener splitImpressionListener
                 = new SyncImpressionListener(mSyncManager, impressionsLoggingTaskExecutor);
-        final ImpressionListener customerImpressionListener;
+        final ImpressionListener.FederatedImpressionListener customerImpressionListener;
 
+        List<ImpressionListener> impressionListeners = new ArrayList<>();
         if (config.impressionListener() != null) {
-            List<ImpressionListener> impressionListeners = new ArrayList<>();
-            impressionListeners.add(splitImpressionListener);
             impressionListeners.add(config.impressionListener());
-            customerImpressionListener = new ImpressionListener.FederatedImpressionListener(impressionListeners);
+            customerImpressionListener = new ImpressionListener.FederatedImpressionListener(splitImpressionListener, impressionListeners);
         } else {
-            customerImpressionListener = splitImpressionListener;
+            customerImpressionListener = new ImpressionListener.FederatedImpressionListener(splitImpressionListener, impressionListeners);
         }
         EventsTracker eventsTracker = buildEventsTracker();
         mUserConsentManager = new UserConsentManagerImpl(config,

src/main/java/io/split/android/client/impressions/DecoratedImpression.java

@@ -0,0 +1,20 @@
+package io.split.android.client.impressions;
+
+public class DecoratedImpression {
+
+    private final Impression mImpression;
+    private final boolean mTrackImpressions;
+
+    public DecoratedImpression(Impression impression, boolean trackImpressions) {
+        mImpression = impression;
+        mTrackImpressions = trackImpressions;
+    }
+
+    public Impression getImpression() {
+        return mImpression;
+    }
+
+    public boolean getTrackImpressions() {
+        return mTrackImpressions;
+    }
+}

src/main/java/io/split/android/client/impressions/DecoratedImpressionListener.java

@@ -0,0 +1,6 @@
+package io.split.android.client.impressions;
+
+public interface DecoratedImpressionListener {
+
+    void log(DecoratedImpression impression);
+}

src/main/java/io/split/android/client/impressions/ImpressionListener.java

@@ -19,22 +19,29 @@ public interface ImpressionListener {
      */
     void close();
 
-    final class NoopImpressionListener implements ImpressionListener {
+    final class NoopImpressionListener implements ImpressionListener, DecoratedImpressionListener {
         @Override
         public void log(Impression impression) {
             // noop
         }
 
+        @Override
+        public void log(DecoratedImpression impression) {
+
+        }
+
         @Override
         public void close() {
             // noop
         }
     }
 
-    final class FederatedImpressionListener implements ImpressionListener {
-        private List<ImpressionListener> _delegates;
+    final class FederatedImpressionListener implements ImpressionListener, DecoratedImpressionListener {
+        private final DecoratedImpressionListener mDecoratedImpressionListener;
+        private final List<ImpressionListener> _delegates;
 
-        public FederatedImpressionListener(List<ImpressionListener> delegates) {
+        public FederatedImpressionListener(DecoratedImpressionListener decoratedImpressionListener, List<ImpressionListener> delegates) {
+            mDecoratedImpressionListener = decoratedImpressionListener;
             _delegates = delegates;
         }
 
@@ -45,6 +52,11 @@ public void log(Impression impression) {
             }
         }
 
+        @Override
+        public void log(DecoratedImpression impression) {
+            mDecoratedImpressionListener.log(impression);
+        }
+
         @Override
         public void close() {
             for (ImpressionListener listener : _delegates) {

src/main/java/io/split/android/client/impressions/ImpressionLoggingTask.java

@@ -10,10 +10,10 @@
 class ImpressionLoggingTask implements Runnable {
 
     private final SyncManager mSyncManager;
-    private final Impression mImpression;
+    private final DecoratedImpression mImpression;
 
     ImpressionLoggingTask(@NonNull SyncManager syncManager,
-                          Impression impression) {
+                          DecoratedImpression impression) {
         mSyncManager = checkNotNull(syncManager);
         mImpression = impression;
     }

src/main/java/io/split/android/client/impressions/SyncImpressionListener.java

@@ -9,7 +9,7 @@
 import io.split.android.client.service.synchronizer.SyncManager;
 import io.split.android.client.utils.logger.Logger;
 
-public class SyncImpressionListener implements ImpressionListener {
+public class SyncImpressionListener implements DecoratedImpressionListener {
 
     private final SyncManager mSyncManager;
     private final ExecutorService mExecutorService;
@@ -21,15 +21,11 @@ public SyncImpressionListener(@NonNull SyncManager syncManager,
     }
 
     @Override
-    public void log(Impression impression) {
+    public void log(DecoratedImpression impression) {
         try {
             mExecutorService.submit(new ImpressionLoggingTask(mSyncManager, impression));
         } catch (Exception ex) {
             Logger.w("Error submitting impression logging task: " + ex.getLocalizedMessage());
         }
     }
-
-    @Override
-    public void close() {
-    }
 }

src/main/java/io/split/android/client/localhost/LocalhostImpressionsListener.java

@@ -1,13 +1,19 @@
 package io.split.android.client.localhost;
 
+import io.split.android.client.impressions.DecoratedImpression;
+import io.split.android.client.impressions.DecoratedImpressionListener;
 import io.split.android.client.impressions.Impression;
 import io.split.android.client.impressions.ImpressionListener;
 
-public class LocalhostImpressionsListener implements ImpressionListener {
+public class LocalhostImpressionsListener implements ImpressionListener, DecoratedImpressionListener {
     @Override
     public void log(Impression impression) {
     }
 
+    @Override
+    public void log(DecoratedImpression impression) {
+    }
+
     @Override
     public void close() {
     }

src/main/java/io/split/android/client/localhost/LocalhostSplitClient.java

@@ -263,11 +263,11 @@ public boolean track(String eventType, double value, Map<String, Object> propert
         return false;
     }
 
-    private ImpressionListener getImpressionsListener(SplitClientConfig config) {
+    private ImpressionListener.FederatedImpressionListener getImpressionsListener(SplitClientConfig config) {
         if (config.impressionListener() != null) {
-            return config.impressionListener();
+            return new ImpressionListener.FederatedImpressionListener(new ImpressionListener.NoopImpressionListener(), Collections.singletonList(config.impressionListener()));
         } else {
-            return new LocalhostImpressionsListener();
+            return new ImpressionListener.FederatedImpressionListener(new ImpressionListener.NoopImpressionListener(), Collections.emptyList());
         }
     }
 

src/main/java/io/split/android/client/service/impressions/ImpressionManager.java

@@ -1,10 +1,10 @@
 package io.split.android.client.service.impressions;
 
-import io.split.android.client.impressions.Impression;
+import io.split.android.client.impressions.DecoratedImpression;
 
 public interface ImpressionManager {
 
     void enableTracking(boolean enable);
 
-    void pushImpression(Impression impression);
+    void pushImpression(DecoratedImpression impression);
 }

src/main/java/io/split/android/client/service/impressions/StrategyImpressionManager.java

@@ -8,7 +8,7 @@
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicBoolean;
 
-import io.split.android.client.impressions.Impression;
+import io.split.android.client.impressions.DecoratedImpression;
 import io.split.android.client.service.impressions.strategy.PeriodicTracker;
 import io.split.android.client.service.impressions.strategy.ProcessStrategy;
 import io.split.android.client.utils.logger.Logger;
@@ -33,16 +33,16 @@ public StrategyImpressionManager(Pair<ProcessStrategy, PeriodicTracker> noneComp
     }
 
     @Override
-    public void pushImpression(Impression impression) {
+    public void pushImpression(DecoratedImpression impression) {
         if (!isTrackingEnabled.get()) {
             Logger.v("Impression not tracked because tracking is disabled");
             return;
         }
 
-        if (track(impression)) {
-            mProcessStrategy.apply(impression);
+        if (impression.getTrackImpressions()) {
+            mProcessStrategy.apply(impression.getImpression());
         } else {
-            mNoneStrategy.apply(impression);
+            mNoneStrategy.apply(impression.getImpression());
         }
     }
 
@@ -71,8 +71,4 @@ public void stopPeriodicRecording() {
             tracker.stopPeriodicRecording();
         }
     }
-
-    private static boolean track(Impression impression) {
-        return true; // TODO: Placeholder method
-    }
 }