Merge branch 'master' into 2.0.x

Author: wangjoshuah

.travis.yml

@@ -22,3 +22,5 @@ branches:
   only:
   - master
   - /^\d+\.\d+\.\d+(-SNAPSHOT|-alpha|-beta)?\d*$/ # trigger builds on tags which are semantically versioned to ship the SDK.
+after_success:
+  - ./gradlew coveralls uploadArchives --console plain

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Optimizely Java X SDK Changelog
 
+## 1.9.0
+
+January 30, 2018
+
+This release adds support for bucketing id (By passing in `$opt_bucketing_id` in the attribute map to override the user id as the bucketing variable. This is useful when wanting a set of users to share the same experience such as two players in a game). 
+
+This release also depricates the old notification broadcaster in favor of a notification center that supports a wide range of notifications.  The notification listener is now registered for the specific notification type such as ACTIVATE and TRACK.  This is accomplished by allowing for a variable argument call to notify (a new var arg method added to the NotificationListener).  Specific abstract classes exist for the associated notification type (ActivateNotification and TrackNotification).  These abstract classes enforce the strong typing that exists in Java.  You may also add custom notification types and fire them through the notification center.  The notification center is implemented using this var arg approach in all Optimizely SDKs.
+
+### New Features
+
+- Added `$opt_bucketing_id` in the attribute map for overriding bucketing using the user id.  It is available as a static string in DecisionService.ATTRIBUTE_BUCKETING_ID
+- Optimizely notification center for activate and track notifications.
+
 ## 2.0.0 Beta 3
 January 5, 2018
 

build.gradle

@@ -12,13 +12,24 @@ buildscript {
 }
 
 plugins {
-    id 'nebula.optional-base' version '3.2.0'
+    id 'com.github.kt3k.coveralls' version '2.8.2'
+    id 'jacoco'
     id 'me.champeau.gradle.jmh' version '0.3.1'
+    id 'nebula.optional-base' version '3.2.0'
 }
 
 allprojects {
     group = 'com.optimizely.ab'
     apply plugin: 'idea'
+    apply plugin: 'jacoco'
+
+    repositories {
+        jcenter()
+    }
+
+    jacoco {
+        toolVersion = '0.8.0'
+    }
 }
 
 apply from: 'gradle/publish.gradle'
@@ -33,8 +44,8 @@ allprojects {
 subprojects {
     apply plugin: 'com.jfrog.bintray'
     apply plugin: 'findbugs'
-    apply plugin: 'java'
     apply plugin: 'jacoco'
+    apply plugin: 'java'
     apply plugin: 'maven-publish'
     apply plugin: 'me.champeau.gradle.jmh'
     apply plugin: 'nebula.optional-base'
@@ -170,9 +181,49 @@ subprojects {
     task ship() {
         dependsOn('bintrayUpload')
     }
+
 }
 
 task ship() {
     dependsOn(':core-api:ship', ':core-httpclient-impl:ship')
 }
 
+// Only report code coverage for projects that are distributed
+def publishedProjects = subprojects.findAll { it.path != ':simulator' }
+
+task jacocoMerge(type: JacocoMerge) {
+    publishedProjects.each { subproject ->
+        executionData subproject.tasks.withType(Test)
+    }
+    doFirst {
+        executionData = files(executionData.findAll { it.exists() })
+    }
+}
+
+task jacocoRootReport(type: JacocoReport, group: 'Coverage reports') {
+    description = 'Generates an aggregate report from all subprojects'
+    dependsOn publishedProjects.test, jacocoMerge
+
+    additionalSourceDirs = files(publishedProjects.sourceSets.main.allSource.srcDirs)
+    sourceDirectories = files(publishedProjects.sourceSets.main.allSource.srcDirs)
+    classDirectories = files(publishedProjects.sourceSets.main.output)
+    executionData jacocoMerge.destinationFile
+
+    reports {
+        html.enabled = true // human readable
+        xml.enabled = true // required by coveralls
+    }
+}
+
+coveralls {
+    sourceDirs = publishedProjects.sourceSets.main.allSource.srcDirs.flatten()
+    jacocoReportPath = "${buildDir}/reports/jacoco/jacocoRootReport/jacocoRootReport.xml"
+}
+
+tasks.coveralls {
+    group = 'Coverage reports'
+    description = 'Uploads the aggregated coverage report to Coveralls'
+
+    dependsOn jacocoRootReport
+    onlyIf { System.env.'CI' && !JavaVersion.current().isJava9Compatible() }
+}

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -37,8 +37,7 @@
 import com.optimizely.ab.event.LogEvent;
 import com.optimizely.ab.event.internal.BuildVersionInfo;
 import com.optimizely.ab.event.internal.EventBuilder;
-import com.optimizely.ab.event.internal.EventBuilderV2;
-import com.optimizely.ab.event.internal.payload.Event.ClientEngine;
+import com.optimizely.ab.event.internal.payload.EventBatch.ClientEngine;
 import com.optimizely.ab.internal.EventTagUtils;
 import com.optimizely.ab.notification.NotificationBroadcaster;
 import com.optimizely.ab.notification.NotificationCenter;
@@ -948,7 +947,7 @@ public Optimizely build() throws ConfigParseException {
 
 
             if (eventBuilder == null) {
-                eventBuilder = new EventBuilderV2(clientEngine, clientVersion);
+                eventBuilder = new EventBuilder(clientEngine, clientVersion);
             }
 
             if (errorHandler == null) {

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2017, Optimizely and contributors
+ *    Copyright 2016-2018, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -16,27 +16,122 @@
  */
 package com.optimizely.ab.event.internal;
 
+import com.optimizely.ab.annotations.VisibleForTesting;
+import com.optimizely.ab.bucketing.DecisionService;
+import com.optimizely.ab.config.EventType;
 import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
-
+import com.optimizely.ab.event.internal.payload.Attribute;
+import com.optimizely.ab.event.internal.payload.Decision;
+import com.optimizely.ab.event.internal.payload.EventBatch;
+import com.optimizely.ab.event.internal.payload.Event;
+import com.optimizely.ab.event.internal.payload.Snapshot;
+import com.optimizely.ab.event.internal.payload.Visitor;
+import com.optimizely.ab.event.internal.serializer.DefaultJsonSerializer;
+import com.optimizely.ab.event.internal.serializer.Serializer;
+import com.optimizely.ab.internal.EventTagUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import javax.annotation.Nonnull;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
 import java.util.Map;
+import java.util.UUID;
+
+public class EventBuilder {
+    private static final Logger logger = LoggerFactory.getLogger(EventBuilder.class);
+    static final String ATTRIBUTE_KEY_FOR_BUCKETING_ATTRIBUTE = "optimizely_bucketing_id";
+    static final String EVENT_ENDPOINT = "https://logx.optimizely.com/v1/events";
+    static final String  ACTIVATE_EVENT_KEY = "campaign_activated";
+
+    private Serializer serializer;
+    @VisibleForTesting
+    public final String clientVersion;
+    @VisibleForTesting
+    public final EventBatch.ClientEngine clientEngine;
+
+    public EventBuilder() {
+        this(EventBatch.ClientEngine.JAVA_SDK, BuildVersionInfo.VERSION);
+    }
+
+    public EventBuilder(EventBatch.ClientEngine clientEngine, String clientVersion) {
+        this.clientEngine = clientEngine;
+        this.clientVersion = clientVersion;
+        this.serializer = DefaultJsonSerializer.getInstance();
+    }
 
-public abstract class EventBuilder {
 
-    public abstract LogEvent createImpressionEvent(@Nonnull ProjectConfig projectConfig,
+    public LogEvent createImpressionEvent(@Nonnull ProjectConfig projectConfig,
                                                    @Nonnull Experiment activatedExperiment,
                                                    @Nonnull Variation variation,
                                                    @Nonnull String userId,
-                                                   @Nonnull Map<String, String> attributes);
+                                                   @Nonnull Map<String, String> attributes) {
 
-    public abstract LogEvent createConversionEvent(@Nonnull ProjectConfig projectConfig,
+        Decision decision = new Decision(activatedExperiment.getLayerId(), activatedExperiment.getId(),
+                variation.getId(), false);
+        Event impressionEvent = new Event(System.currentTimeMillis(),UUID.randomUUID().toString(), activatedExperiment.getLayerId(),
+                ACTIVATE_EVENT_KEY, null, null, null, ACTIVATE_EVENT_KEY, null);
+        Snapshot snapshot = new Snapshot(Arrays.asList(decision), Arrays.asList(impressionEvent));
+
+        Visitor visitor = new Visitor(userId, null, buildAttributeList(projectConfig, attributes), Arrays.asList(snapshot));
+        List<Visitor> visitors = Arrays.asList(visitor);
+        EventBatch eventBatch = new EventBatch(clientEngine.getClientEngineValue(), clientVersion, projectConfig.getAccountId(), visitors, projectConfig.getAnonymizeIP(), projectConfig.getProjectId(), projectConfig.getRevision());
+        String payload = this.serializer.serialize(eventBatch);
+        return new LogEvent(LogEvent.RequestMethod.POST, EVENT_ENDPOINT, Collections.<String, String>emptyMap(), payload);
+    }
+
+    public LogEvent createConversionEvent(@Nonnull ProjectConfig projectConfig,
                                                    @Nonnull Map<Experiment, Variation> experimentVariationMap,
                                                    @Nonnull String userId,
                                                    @Nonnull String eventId,
                                                    @Nonnull String eventName,
                                                    @Nonnull Map<String, String> attributes,
-                                                   @Nonnull Map<String, ?> eventTags);
+                                                   @Nonnull Map<String, ?> eventTags) {
+
+        if (experimentVariationMap.isEmpty()) {
+            return null;
+        }
+
+        ArrayList<Decision> decisions = new ArrayList<Decision>();
+        for (Map.Entry<Experiment, Variation> entry : experimentVariationMap.entrySet()) {
+            Decision decision = new Decision(entry.getKey().getLayerId(), entry.getKey().getId(), entry.getValue().getId(), false);
+            decisions.add(decision);
+        }
+
+        EventType eventType = projectConfig.getEventNameMapping().get(eventName);
+
+        Event conversionEvent = new Event(System.currentTimeMillis(),UUID.randomUUID().toString(), eventType.getId(),
+                eventType.getKey(), null, EventTagUtils.getRevenueValue(eventTags), eventTags, eventType.getKey(), EventTagUtils.getNumericValue(eventTags));
+        Snapshot snapshot = new Snapshot(decisions, Arrays.asList(conversionEvent));
+
+        Visitor visitor = new Visitor(userId, null, buildAttributeList(projectConfig, attributes), Arrays.asList(snapshot));
+        List<Visitor> visitors = Arrays.asList(visitor);
+        EventBatch eventBatch = new EventBatch(clientEngine.getClientEngineValue(), clientVersion, projectConfig.getAccountId(), visitors, projectConfig.getAnonymizeIP(), projectConfig.getProjectId(), projectConfig.getRevision());
+        String payload = this.serializer.serialize(eventBatch);
+        return new LogEvent(LogEvent.RequestMethod.POST, EVENT_ENDPOINT, Collections.<String, String>emptyMap(), payload);
+    }
+
+    private List<Attribute> buildAttributeList(ProjectConfig projectConfig, Map<String, String> attributes) {
+        List<Attribute> attributesList = new ArrayList<Attribute>();
+
+        Map<String, com.optimizely.ab.config.Attribute> attributeMap = projectConfig.getAttributeKeyMapping();
+        for (Map.Entry<String, String> entry : attributes.entrySet()) {
+            com.optimizely.ab.config.Attribute projectAttribute = attributeMap.get(entry.getKey());
+            Attribute attribute = new Attribute((projectAttribute != null ? projectAttribute.getId() : null),
+                    entry.getKey(), Attribute.CUSTOM_ATTRIBUTE_TYPE, entry.getValue());
+
+            if (entry.getKey() == DecisionService.BUCKETING_ATTRIBUTE) {
+                attribute = new Attribute(com.optimizely.ab.bucketing.DecisionService.BUCKETING_ATTRIBUTE,
+                        ATTRIBUTE_KEY_FOR_BUCKETING_ATTRIBUTE, Attribute.CUSTOM_ATTRIBUTE_TYPE, entry.getValue());
+            }
+
+            attributesList.add(attribute);
+        }
+
+        return attributesList;
+    }
 }