feat!: Context Values support, getEvaluationResult

.github/workflows/run-tests.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        java: [ "8", "11", "17", "21" ]
+        java: [ "11", "17", "21" ]
         distribution: [ "zulu", "adopt" ]
 
     steps:

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "src/test/java/com/flagsmith/flagengine/enginetestdata"]
 	path = src/test/java/com/flagsmith/flagengine/enginetestdata
 	url = [email protected]:Flagsmith/engine-test-data.git
-	branch = v1.0.0
+	branch = feat/context-values

pom.xml

@@ -38,9 +38,11 @@
   </scm>
 
   <properties>
+    <maven.compiler.source>11</maven.compiler.source>
+    <maven.compiler.target>11</maven.compiler.target>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <java.version>1.11</java.version>
+    <java.version>11</java.version>
     <jacksonVersion>2.15.2</jacksonVersion>
     <lombok.version>1.18.34</lombok.version>
     <slf4j.version>1.7.30</slf4j.version>
@@ -54,6 +56,11 @@
       <artifactId>okhttp</artifactId>
       <version>4.12.0</version>
     </dependency>
+    <dependency>
+      <groupId>com.jayway.jsonpath</groupId>
+      <artifactId>json-path</artifactId>
+      <version>2.9.0</version>
+    </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-annotations</artifactId>
@@ -181,6 +188,27 @@
   <build>
     <finalName>flagsmith-java-client-${project.version}</finalName>
     <plugins>
+      <plugin>
+        <groupId>org.jsonschema2pojo</groupId>
+        <artifactId>jsonschema2pojo-maven-plugin</artifactId>
+        <version>1.2.2</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <sourceType>jsonschema</sourceType>
+          <sourceDirectory>${project.basedir}/src/main/resources/schema</sourceDirectory>
+          <targetPackage>com.flagsmith.flagengine</targetPackage>
+          <outputDirectory>${project.build.directory}/generated-sources/jsonschema2pojo</outputDirectory>
+          <generateBuilders>true</generateBuilders>
+          <includeConstructors>true</includeConstructors>
+          <includeCopyConstructor>true</includeCopyConstructor>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.sonatype.central</groupId>
         <artifactId>central-publishing-maven-plugin</artifactId>
@@ -196,8 +224,15 @@
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.7.0</version>
         <configuration>
-          <source>1.8</source>
-          <target>1.8</target>
+          <source>11</source>
+          <target>11</target>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>org.projectlombok</groupId>
+              <artifactId>lombok</artifactId>
+              <version>${lombok.version}</version>
+            </path>
+          </annotationProcessorPaths>
         </configuration>
       </plugin>
       <plugin>
@@ -316,4 +351,4 @@
       </build>
     </profile>
   </profiles>
-</project>
+</project>

src/main/java/com/flagsmith/FlagsmithApiWrapper.java

@@ -1,15 +1,17 @@
 package com.flagsmith;
 
 import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.flagsmith.config.FlagsmithConfig;
 import com.flagsmith.exceptions.FlagsmithRuntimeError;
-import com.flagsmith.flagengine.environments.EnvironmentModel;
-import com.flagsmith.flagengine.features.FeatureStateModel;
-import com.flagsmith.flagengine.identities.traits.TraitModel;
+import com.flagsmith.flagengine.EvaluationContext;
 import com.flagsmith.interfaces.FlagsmithCache;
 import com.flagsmith.interfaces.FlagsmithSdk;
+import com.flagsmith.mappers.EngineMappers;
+import com.flagsmith.models.FeatureStateModel;
 import com.flagsmith.models.Flags;
+import com.flagsmith.models.TraitModel;
 import com.flagsmith.responses.FlagsAndTraitsResponse;
 import com.flagsmith.threads.AnalyticsProcessor;
 import com.flagsmith.threads.RequestProcessor;
@@ -20,7 +22,6 @@
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
-import lombok.Data;
 import lombok.Getter;
 import okhttp3.HttpUrl;
 import okhttp3.MediaType;
@@ -45,19 +46,18 @@ public class FlagsmithApiWrapper implements FlagsmithSdk {
   /**
    * Instantiate with cache.
    *
-   * @param cache cache object
+   * @param cache         cache object
    * @param defaultConfig config object
    * @param customHeaders custom headers list
-   * @param logger logger object
-   * @param apiKey api key
+   * @param logger        logger object
+   * @param apiKey        api key
    */
   public FlagsmithApiWrapper(
       final FlagsmithCache cache,
       final FlagsmithConfig defaultConfig,
       final HashMap<String, String> customHeaders,
       final FlagsmithLogger logger,
-      final String apiKey
-  ) {
+      final String apiKey) {
     this(defaultConfig, customHeaders, logger, apiKey);
     this.cache = cache;
   }
@@ -67,42 +67,40 @@ public FlagsmithApiWrapper(
    *
    * @param defaultConfig config object
    * @param customHeaders custom headers list
-   * @param logger logger instance
-   * @param apiKey api key
+   * @param logger        logger instance
+   * @param apiKey        api key
    */
   public FlagsmithApiWrapper(
       final FlagsmithConfig defaultConfig,
       final HashMap<String, String> customHeaders,
       final FlagsmithLogger logger,
-      final String apiKey
-  ) {
+      final String apiKey) {
     this.defaultConfig = defaultConfig;
     this.customHeaders = customHeaders;
     this.logger = logger;
     this.apiKey = apiKey;
     requestor = new RequestProcessor(
         defaultConfig.getHttpClient(),
         logger,
-        defaultConfig.getRetries()
-    );
+        defaultConfig.getRetries());
   }
 
   /**
-   * Instantiate with config, custom headers, logger, apikey and request processor.
+   * Instantiate with config, custom headers, logger, apikey and request
+   * processor.
    *
-   * @param defaultConfig config object
-   * @param customHeaders custom headers list
-   * @param logger logger instance
-   * @param apiKey api key
+   * @param defaultConfig    config object
+   * @param customHeaders    custom headers list
+   * @param logger           logger instance
+   * @param apiKey           api key
    * @param requestProcessor request processor
    */
   public FlagsmithApiWrapper(
-          final FlagsmithConfig defaultConfig,
-          final HashMap<String, String> customHeaders,
-          final FlagsmithLogger logger,
-          final String apiKey,
-          final RequestProcessor requestProcessor
-  ) {
+      final FlagsmithConfig defaultConfig,
+      final HashMap<String, String> customHeaders,
+      final FlagsmithLogger logger,
+      final String apiKey,
+      final RequestProcessor requestProcessor) {
     this.defaultConfig = defaultConfig;
     this.customHeaders = customHeaders;
     this.logger = logger;
@@ -131,14 +129,13 @@ public Flags getFeatureFlags(boolean doThrow) {
 
     Future<List<FeatureStateModel>> featureFlagsFuture = requestor.executeAsync(
         request,
-        new TypeReference<List<FeatureStateModel>>() {},
-        doThrow
-    );
+        new TypeReference<List<FeatureStateModel>>() {
+        },
+        doThrow);
 
     try {
       List<FeatureStateModel> featureFlagsResponse = featureFlagsFuture.get(
-          TIMEOUT, TimeUnit.MILLISECONDS
-      );
+          TIMEOUT, TimeUnit.MILLISECONDS);
 
       if (featureFlagsResponse == null) {
         featureFlagsResponse = new ArrayList<>();
@@ -147,8 +144,7 @@ public Flags getFeatureFlags(boolean doThrow) {
       featureFlags = Flags.fromApiFlags(
           featureFlagsResponse,
           getConfig().getAnalyticsProcessor(),
-          getConfig().getFlagsmithFlagDefaults()
-      );
+          getConfig().getFlagsmithFlagDefaults());
 
       if (getCache() != null && getCache().getEnvFlagsCacheKey() != null) {
         getCache().getCache().put(getCache().getEnvFlagsCacheKey(), featureFlags);
@@ -172,8 +168,7 @@ public Flags getFeatureFlags(boolean doThrow) {
 
   @Override
   public Flags identifyUserWithTraits(
-      String identifier, List<? extends TraitModel> traits, boolean isTransient, boolean doThrow
-  ) {
+      String identifier, List<? extends TraitModel> traits, boolean isTransient, boolean doThrow) {
     assertValidUser(identifier);
     Flags flags = null;
     String cacheKey = null;
@@ -207,23 +202,22 @@ public Flags identifyUserWithTraits(
 
     Future<FlagsAndTraitsResponse> featureFlagsFuture = requestor.executeAsync(
         request,
-        new TypeReference<FlagsAndTraitsResponse>() {},
-        doThrow
-    );
+        new TypeReference<FlagsAndTraitsResponse>() {
+        },
+        doThrow);
 
     try {
       FlagsAndTraitsResponse flagsAndTraitsResponse = featureFlagsFuture.get(
-          TIMEOUT, TimeUnit.MILLISECONDS
-      );
+          TIMEOUT, TimeUnit.MILLISECONDS);
       List<FeatureStateModel> flagsArray = flagsAndTraitsResponse != null
           && flagsAndTraitsResponse.getFlags() != null
-          ? flagsAndTraitsResponse.getFlags() : new ArrayList<>();
+              ? flagsAndTraitsResponse.getFlags()
+              : new ArrayList<>();
 
       flags = Flags.fromApiFlags(
           flagsArray,
           getConfig().getAnalyticsProcessor(),
-          getConfig().getFlagsmithFlagDefaults()
-      );
+          getConfig().getFlagsmithFlagDefaults());
 
       if (cacheKey != null) {
         getCache().getCache().put(cacheKey, flags);
@@ -248,19 +242,23 @@ public Flags identifyUserWithTraits(
   }
 
   @Override
-  public EnvironmentModel getEnvironment() {
+  public EvaluationContext getEvaluationContext() {
     final Request request = newGetRequest(defaultConfig.getEnvironmentUri());
 
-    Future<EnvironmentModel> environmentFuture = requestor.executeAsync(request,
-        new TypeReference<EnvironmentModel>() {},
+    Future<JsonNode> environmentFuture = requestor.executeAsync(request,
+        new TypeReference<JsonNode>() {
+        },
         Boolean.TRUE);
 
     try {
-      return environmentFuture.get(TIMEOUT, TimeUnit.MILLISECONDS);
+      JsonNode environmentJson = environmentFuture.get(TIMEOUT, TimeUnit.MILLISECONDS);
+      return EngineMappers.mapEnvironmentDocumentToContext(environmentJson);
     } catch (TimeoutException ie) {
       logger.error("Timed out on fetching Feature flags.", ie);
     } catch (InterruptedException ie) {
       logger.error("Environment loading interrupted.", ie);
+    } catch (IllegalArgumentException iae) {
+      logger.error("Environment loading failed.", iae);
     } catch (ExecutionException ee) {
       logger.error("Execution failed on Environment loading.", ee);
       throw new FlagsmithRuntimeError(ee);
@@ -320,7 +318,7 @@ public Request newGetRequest(HttpUrl url) {
   /**
    * Returns a build request with GET.
    *
-   * @param url - URL to invoke
+   * @param url  - URL to invoke
    * @param body - body to post
    */
   @Override
@@ -332,7 +330,8 @@ public Request newPostRequest(HttpUrl url, RequestBody body) {
   }
 
   /**
-   * Close the FlagsmithAPIWrapper instance, cleaning up any dependent threads or services
+   * Close the FlagsmithAPIWrapper instance, cleaning up any dependent threads or
+   * services
    * which need cleaning up before the instance can be fully destroyed.
    */
   public void close() {