feat: support tracking

Author: louis-launchdarkly

build.gradle

@@ -107,12 +107,14 @@ nexusPublishing {
 dependencies {
     implementation group: 'com.launchdarkly', name: 'launchdarkly-java-server-sdk', version: '[7.1.0, 8.0.0)'
 
-    implementation 'dev.openfeature:sdk:[1.7.0,2.0.0)'
+    implementation 'dev.openfeature:sdk:[1.14.0,2.0.0)'
 
     // Use JUnit test framework
     testImplementation(platform('org.junit:junit-bom:5.10.0'))
     testImplementation('org.junit.jupiter:junit-jupiter')
     testImplementation "org.mockito:mockito-core:3.+"
+    
+    testImplementation 'org.awaitility:awaitility:4.2.0'
 }
 
 test {

src/main/java/com/launchdarkly/openfeature/serverprovider/Provider.java

@@ -222,6 +222,34 @@ public void shutdown() {
         }
     }
 
+    @Override
+    public void track(String eventName, EvaluationContext ctx, TrackingEventDetails details) {
+        if(ctx == null) {
+            logger.info("Skipping this track call. LaunchDarkly SDK's track method requires a non-null EvaluationContext to work.");
+            return;
+        }
+
+        if(details != null) {
+            Double metricValue = null;
+            if (details.getValue().isPresent()) {
+                metricValue = (Double)details.getValue().get();
+            }
+            // Convert the Structure portion of the TrackingEventDetails into a key value map.
+            // This will not put the metricValue extracted above into the map.
+            LDValue data = valueConverter.toLdValue(new Value(details));
+
+            if (metricValue != null) {
+                client.trackMetric(eventName, evaluationContextConverter.toLdContext(ctx), data, metricValue);
+            } else if (!data.isNull() && data.size() > 0) {
+                client.trackData(eventName, evaluationContextConverter.toLdContext(ctx), data);
+            } else {
+                client.track(eventName, evaluationContextConverter.toLdContext(ctx));
+            }
+        } else {
+            client.track(eventName, evaluationContextConverter.toLdContext(ctx));
+        }
+    }
+
     /**
      * Get the LaunchDarkly client associated with this provider.
      * <p>

src/main/java/com/launchdarkly/openfeature/serverprovider/Version.java

@@ -4,5 +4,5 @@ abstract class Version {
   private Version() {}
 
   // This constant is updated automatically by our Gradle script during a release, if the project version has changed
-  static final String SDK_VERSION = "0.2.0";
+  static final String SDK_VERSION = "1.0.1";
 }

src/test/java/com/launchdarkly/openfeature/serverprovider/ProviderTest.java

@@ -9,6 +9,9 @@
 import org.junit.jupiter.api.Test;
 
 import static org.mockito.Mockito.*;
+
+import org.awaitility.Awaitility;
+
 import static org.junit.jupiter.api.Assertions.*;
 
 public class ProviderTest {
@@ -35,6 +38,11 @@ public void itCanDoABooleanEvaluation() {
 
         OpenFeatureAPI.getInstance().setProvider(ldProvider);
 
+        Awaitility.await().forever().until(() -> OpenFeatureAPI
+            .getInstance()
+            .getClient()
+            .getBooleanValue("the-key", false, evaluationContext));
+
         assertTrue(OpenFeatureAPI
             .getInstance()
             .getClient()
@@ -60,6 +68,11 @@ public void itCanDoAStringEvaluation() {
 
         OpenFeatureAPI.getInstance().setProvider(ldProvider);
 
+        Awaitility.await().forever().until(() -> OpenFeatureAPI
+            .getInstance()
+            .getClient()
+            .getStringValue("the-key", "default", evaluationContext).equals("evaluated"));
+
         assertEquals("evaluated", OpenFeatureAPI
             .getInstance()
             .getClient()
@@ -83,6 +96,12 @@ public void itCanDoADoubleEvaluation() {
             .thenReturn(EvaluationDetail.fromValue(1.0, 42, EvaluationReason.targetMatch()));
 
         OpenFeatureAPI.getInstance().setProvider(ldProvider);
+
+        Awaitility.await().forever().until(() -> OpenFeatureAPI
+            .getInstance()
+            .getClient()
+            .getDoubleValue("the-key", 0.0, evaluationContext) != 0.0);
+
         assertEquals(1.0, OpenFeatureAPI
             .getInstance()
             .getClient()
@@ -126,4 +145,79 @@ public void itCanDoAValueEvaluation() {
         assertEquals("84", detailed.getVariant());
         assertEquals("TARGETING_MATCH", detailed.getReason());
     }
+
+    @Test
+    public void itCanTrackNoTrackingEventDetails() {
+        EvaluationContext evaluationContext = new ImmutableContext("user-key");
+        EvaluationContextConverter evaluationContextConverter = new EvaluationContextConverter(null);
+
+        OpenFeatureAPI.getInstance().setProvider(ldProvider);
+
+        OpenFeatureAPI
+            .getInstance()
+            .getClient().track("metric-key", evaluationContext);
+
+        verify(mockedLdClient).track(
+            "metric-key",
+            evaluationContextConverter.toLdContext(evaluationContext));
+    }
+
+    @Test
+    public void itCanTrackEmptyTrackingEventDetails() {
+        EvaluationContext evaluationContext = new ImmutableContext("user-key");
+        EvaluationContextConverter evaluationContextConverter = new EvaluationContextConverter(null);
+
+        TrackingEventDetails trackingEventDetails = new MutableTrackingEventDetails(null);
+
+        OpenFeatureAPI.getInstance().setProvider(ldProvider);
+
+        OpenFeatureAPI
+            .getInstance()
+            .getClient().track("metric-key", evaluationContext, trackingEventDetails);
+            
+        verify(mockedLdClient).track(
+            "metric-key", 
+            evaluationContextConverter.toLdContext(evaluationContext));
+    }
+
+    @Test
+    public void itCanTrackTrackingEventDetailsWithNoValue() {
+        EvaluationContext evaluationContext = new ImmutableContext("user-key");
+        EvaluationContextConverter evaluationContextConverter = new EvaluationContextConverter(null);
+        ValueConverter valueConverter = new ValueConverter(null);
+
+        TrackingEventDetails trackingEventDetails = new MutableTrackingEventDetails(null).add("currency", "USD");
+
+        OpenFeatureAPI.getInstance().setProvider(ldProvider);
+
+        OpenFeatureAPI
+            .getInstance()
+            .getClient().track("metric-key", evaluationContext, trackingEventDetails);
+
+        verify(mockedLdClient).trackData(
+            "metric-key",
+            evaluationContextConverter.toLdContext(evaluationContext), 
+            valueConverter.toLdValue(new Value(trackingEventDetails)));
+    }
+
+    @Test
+    public void itCanTrackFullTrackingEventDetails() {
+        EvaluationContext evaluationContext = new ImmutableContext("user-key");
+        EvaluationContextConverter evaluationContextConverter = new EvaluationContextConverter(null);
+        ValueConverter valueConverter = new ValueConverter(null);
+
+        TrackingEventDetails trackingEventDetails = new MutableTrackingEventDetails(99.77).add("currency", "USD");
+
+        OpenFeatureAPI.getInstance().setProvider(ldProvider);
+
+        OpenFeatureAPI
+            .getInstance()
+            .getClient().track("metric-key", evaluationContext, trackingEventDetails);
+
+        verify(mockedLdClient).trackMetric(
+            "metric-key",
+            evaluationContextConverter.toLdContext(evaluationContext),
+            valueConverter.toLdValue(new Value(trackingEventDetails)),
+            99.77);
+    }
 }