Eppo Client with shared UFC tests passing (#23)

* tests passing for rule evaluator, flag evaluator, and eppo value

* work in progress

* shared UFC tests passing

* don't check in test data

* changes from self-review of PR

* apply spotless linter

* working on tests

* better test logging

* use make test for tests

Author: aarsilv

.github/workflows/lint-test-sdk.yml

@@ -32,4 +32,4 @@ jobs:
           gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
       - name: Run tests
-        run: ./gradlew check --no-daemon
+        run: make test

.gitignore

@@ -1,3 +1,4 @@
+src/test/resources/shared
 .gradle
 build/
 !gradle/wrapper/gradle-wrapper.jar

Makefile

@@ -0,0 +1,48 @@
+# Make settings - @see https://tech.davis-hansson.com/p/make/
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+
+# Log levels
+DEBUG := $(shell printf "\e[2D\e[35m")
+INFO  := $(shell printf "\e[2D\e[36m🔵 ")
+OK    := $(shell printf "\e[2D\e[32m🟢 ")
+WARN  := $(shell printf "\e[2D\e[33m🟡 ")
+ERROR := $(shell printf "\e[2D\e[31m🔴 ")
+END   := $(shell printf "\e[0m")
+
+
+.PHONY: default
+default: help
+
+## help - Print help message.
+.PHONY: help
+help: Makefile
+	@echo "usage: make <target>"
+	@sed -n 's/^##//p' $<
+
+.PHONY: build
+build: test-data
+	./gradlew assemble
+
+## test-data
+testDataDir := src/test/resources/shared
+tempDir := ${testDataDir}/temp
+gitDataDir := ${tempDir}/sdk-test-data
+branchName := main
+githubRepoLink := https://github.com/Eppo-exp/sdk-test-data.git
+.PHONY: test-data
+test-data:
+	rm -rf $(testDataDir)
+	mkdir -p ${tempDir}
+	git clone -b ${branchName} --depth 1 --single-branch ${githubRepoLink} ${gitDataDir}
+	cp -r ${gitDataDir}/ufc ${testDataDir}
+	rm ${testDataDir}/ufc/bandit-tests/*.dynamic-typing.json
+	rm -rf ${tempDir}
+
+.PHONY: test
+test: test-data build
+	./gradlew check --no-daemon

build.gradle

@@ -11,6 +11,9 @@ ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
 
 dependencies {
   implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2'
+  implementation 'com.github.zafarkhaja:java-semver:0.10.2'
+  implementation "com.squareup.okhttp3:okhttp:4.12.0"
+
   // For UFC DTOs
   implementation 'commons-codec:commons-codec:1.17.0'
   implementation 'org.slf4j:slf4j-api:2.0.13'
@@ -19,10 +22,18 @@ dependencies {
   testImplementation 'org.skyscreamer:jsonassert:1.5.3'
   testImplementation 'commons-io:commons-io:2.11.0'
   testImplementation "com.google.truth:truth:1.4.4"
+  testImplementation 'org.mockito:mockito-core:4.11.0'
 }
 
 test {
   useJUnitPlatform()
+  testLogging {
+    events "started", "passed", "skipped", "failed"
+    exceptionFormat "full"
+    showExceptions true
+    showCauses true
+    showStackTraces true
+  }
 }
 
 spotless {
@@ -138,6 +149,9 @@ signing {
 
 
 javadoc {
+  failOnError = false
+  options.addStringOption('Xdoclint:none', '-quiet')
+  options.addBooleanOption('failOnError', false)
   if (JavaVersion.current().isJava9Compatible()) {
     options.addBooleanOption('html5', true)
   }

src/main/java/cloud/eppo/ConfigurationRequestor.java

@@ -0,0 +1,40 @@
+package cloud.eppo;
+
+import cloud.eppo.ufc.dto.FlagConfig;
+import java.io.IOException;
+import okhttp3.Response;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+// TODO: handle bandit stuff
+public class ConfigurationRequestor {
+  private static final Logger log = LoggerFactory.getLogger(ConfigurationRequestor.class);
+
+  private final EppoHttpClient client;
+  private final ConfigurationStore configurationStore;
+
+  public ConfigurationRequestor(ConfigurationStore configurationStore, EppoHttpClient client) {
+    this.configurationStore = configurationStore;
+    this.client = client;
+  }
+
+  public void load() {
+    log.debug("Fetching configuration");
+    Response response = client.get("/api/flag-config/v1/config");
+    try {
+      if (!response.isSuccessful()) {
+        throw new RuntimeException("Failed to fetch configuration");
+      }
+      configurationStore.setFlagsFromJsonString(response.body().string());
+    } catch (IOException e) {
+      // TODO: better exception handling?
+      throw new RuntimeException(e);
+    }
+  }
+
+  // TODO: async loading for android
+
+  public FlagConfig getConfiguration(String flagKey) {
+    return configurationStore.getFlag(flagKey);
+  }
+}

src/main/java/cloud/eppo/ConfigurationStore.java

@@ -0,0 +1,53 @@
+package cloud.eppo;
+
+import cloud.eppo.ufc.dto.BanditParameters;
+import cloud.eppo.ufc.dto.FlagConfig;
+import cloud.eppo.ufc.dto.FlagConfigResponse;
+import cloud.eppo.ufc.dto.adapters.EppoModule;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.util.concurrent.ConcurrentHashMap;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ConfigurationStore {
+  private static final Logger log = LoggerFactory.getLogger(ConfigurationStore.class);
+  private final ObjectMapper mapper = new ObjectMapper().registerModule(EppoModule.eppoModule());
+
+  private ConcurrentHashMap<String, FlagConfig> flags;
+  private ConcurrentHashMap<String, BanditParameters> banditParameters; // TODO: bandit stuff
+  // TODO: another map of bandit flag variations to handle no action case
+  static ConfigurationStore instance = null;
+
+  public ConfigurationStore() {
+    // TODO: handle caching
+  }
+
+  public void setFlagsFromJsonString(String jsonString) throws JsonProcessingException {
+    FlagConfigResponse config = mapper.readValue(jsonString, FlagConfigResponse.class);
+    if (config == null || config.getFlags() == null) {
+      log.warn("Flags missing in configuration response");
+      flags = new ConcurrentHashMap<>();
+    } else {
+      // TODO: atomic flags to prevent clobbering like android does
+      // Record that flags were set from a response so we don't later clobber them with a
+      // slow cache read
+      flags = new ConcurrentHashMap<>(config.getFlags());
+      log.debug("Loaded " + flags.size() + " flags from configuration response");
+    }
+  }
+
+  public BanditParameters getBanditParameters(String banditKey) {
+    return this.banditParameters.get(banditKey);
+  }
+
+  public FlagConfig getFlag(String flagKey) {
+    if (flags == null) {
+      log.warn("Request for flag " + flagKey + " before flags have been loaded");
+      return null;
+    } else if (flags.isEmpty()) {
+      log.warn("Request for flag " + flagKey + " with empty flags");
+    }
+    return flags.get(flagKey);
+  }
+}

src/main/java/cloud/eppo/rac/Constants.java renamed to src/main/java/cloud/eppo/Constants.java

@@ -1,4 +1,4 @@
-package cloud.eppo.rac;
+package cloud.eppo;
 
 /** Constants Class */
 public class Constants {