Add Android TV SDK client engine type to Event (#73)

Author: onufryk

core-api/src/main/java/com/optimizely/ab/event/internal/payload/Event.java

@@ -24,7 +24,8 @@ public class Event {
 
  public enum ClientEngine {
  JAVA_SDK ("java-sdk"),
- ANDROID_SDK ("android-sdk");
+ ANDROID_SDK ("android-sdk"),
+ ANDROID_TV_SDK ("android-tv-sdk");
 
  private final String clientEngineValue;
 

core-api/src/test/java/com/optimizely/ab/OptimizelyBuilderTest.java

@@ -130,14 +130,23 @@ public void withDefaultClientEngine() throws Exception {
  }
 
  @Test
- public void withCustomClientEngine() throws Exception {
+ public void withAndroidSDKClientEngine() throws Exception {
  Optimizely optimizelyClient = Optimizely.builder(validConfigJsonV2(), mockEventHandler)
  .withClientEngine(ClientEngine.ANDROID_SDK)
  .build();
 
  assertThat(((EventBuilderV2)optimizelyClient.eventBuilder).clientEngine, is(ClientEngine.ANDROID_SDK));
  }
 
+ @Test
+ public void withAndroidTVSDKClientEngine() throws Exception {
+ Optimizely optimizelyClient = Optimizely.builder(validConfigJsonV2(), mockEventHandler)
+ .withClientEngine(ClientEngine.ANDROID_TV_SDK)
+ .build();
+
+ assertThat(((EventBuilderV2)optimizelyClient.eventBuilder).clientEngine, is(ClientEngine.ANDROID_TV_SDK));
+ }
+
  @Test
  public void withDefaultClientVersion() throws Exception {
  Optimizely optimizelyClient = Optimizely.builder(validConfigJsonV2(), mockEventHandler)

core-api/src/test/java/com/optimizely/ab/event/internal/EventBuilderV2Test.java

@@ -136,7 +136,7 @@ public void createImpressionEventIgnoresUnknownAttributes() throws Exception {
  * events being sent with the overriden values.
  */
  @Test
- public void createImpressionEventCustomClientEngineClientVersion() throws Exception {
+ public void createImpressionEventAndroidClientEngineClientVersion() throws Exception {
  EventBuilderV2 builder = new EventBuilderV2(ClientEngine.ANDROID_SDK, "0.0.0");
  ProjectConfig projectConfig = ProjectConfigTestUtils.validProjectConfigV2();
  Experiment activatedExperiment = projectConfig.getExperiments().get(0);
@@ -153,6 +153,29 @@ public void createImpressionEventCustomClientEngineClientVersion() throws Except
  assertThat(impression.getClientVersion(), is("0.0.0"));
  }
 
+ /**
+ * Verify that supplying {@link EventBuilderV2} with a custom Android TV client engine and client version
+ * results in impression events being sent with the overriden values.
+ */
+ @Test
+ public void createImpressionEventAndroidTVClientEngineClientVersion() throws Exception {
+ String clientVersion = "0.0.0";
+ EventBuilderV2 builder = new EventBuilderV2(ClientEngine.ANDROID_TV_SDK, clientVersion);
+ ProjectConfig projectConfig = ProjectConfigTestUtils.validProjectConfigV2();
+ Experiment activatedExperiment = projectConfig.getExperiments().get(0);
+ Variation bucketedVariation = activatedExperiment.getVariations().get(0);
+ Attribute attribute = projectConfig.getAttributes().get(0);
+ String userId = "userId";
+ Map<String, String> attributeMap = Collections.singletonMap(attribute.getKey(), "value");
+
+ LogEvent impressionEvent = builder.createImpressionEvent(projectConfig, activatedExperiment, bucketedVariation,
+ userId, attributeMap);
+ Impression impression = gson.fromJson(impressionEvent.getBody(), Impression.class);
+
+ assertThat(impression.getClientEngine(), is(ClientEngine.ANDROID_TV_SDK.getClientEngineValue()));
+ assertThat(impression.getClientVersion(), is(clientVersion));
+ }
+
  /**
  * Verify that passing a non-null session ID to
  * {@link EventBuilder#createImpressionEvent(ProjectConfig, Experiment, Variation, String, Map, String)} properly
@@ -370,7 +393,7 @@ public void createConversionEventExperimentStatusPrecedesForcedVariation() {
  * events being sent with the overriden values.
  */
  @Test
- public void createConversionEventCustomClientEngineClientVersion() throws Exception {
+ public void createConversionEventAndroidClientEngineClientVersion() throws Exception {
  EventBuilderV2 builder = new EventBuilderV2(ClientEngine.ANDROID_SDK, "0.0.0");
  ProjectConfig projectConfig = ProjectConfigTestUtils.validProjectConfigV2();
  Attribute attribute = projectConfig.getAttributes().get(0);
@@ -393,6 +416,35 @@ public void createConversionEventCustomClientEngineClientVersion() throws Except
  assertThat(conversion.getClientVersion(), is("0.0.0"));
  }
 
+ /**
+ * Verify that supplying {@link EventBuilderV2} with a Android TV client engine and client version results in
+ * conversion events being sent with the overriden values.
+ */
+ @Test
+ public void createConversionEventAndroidTVClientEngineClientVersion() throws Exception {
+ String clientVersion = "0.0.0";
+ EventBuilderV2 builder = new EventBuilderV2(ClientEngine.ANDROID_TV_SDK, clientVersion);
+ ProjectConfig projectConfig = ProjectConfigTestUtils.validProjectConfigV2();
+ Attribute attribute = projectConfig.getAttributes().get(0);
+ EventType eventType = projectConfig.getEventTypes().get(0);
+ String userId = "userId";
+
+ Bucketer mockBucketAlgorithm = mock(Bucketer.class);
+ for (Experiment experiment : projectConfig.getExperiments()) {
+ when(mockBucketAlgorithm.bucket(experiment, userId))
+ .thenReturn(experiment.getVariations().get(0));
+ }
+
+ Map<String, String> attributeMap = Collections.singletonMap(attribute.getKey(), "value");
+ LogEvent conversionEvent = builder.createConversionEvent(projectConfig, mockBucketAlgorithm, userId,
+ eventType.getId(), eventType.getKey(), attributeMap);
+
+ Conversion conversion = gson.fromJson(conversionEvent.getBody(), Conversion.class);
+
+ assertThat(conversion.getClientEngine(), is(ClientEngine.ANDROID_TV_SDK.getClientEngineValue()));
+ assertThat(conversion.getClientVersion(), is(clientVersion));
+ }
+
  /**
  * Verify that {@link EventBuilderV2} doesn't add experiments with a "Launched" status to the bucket map
  */