feat!: Context Values support, getEvaluationResult (#184)

Author: khvn26

.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
+	tag = v2.5.0

pom.xml

@@ -38,14 +38,16 @@
   </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>
     <maven.checkstyle.version>3.4.0</maven.checkstyle.version>
-    <junit.jupiter.version>5.9.2</junit.jupiter.version>
+    <junit.jupiter.version>5.14.0</junit.jupiter.version>
   </properties>
 
   <dependencies>
@@ -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>
@@ -257,7 +292,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>2.22.0</version>
+        <version>3.5.4</version>
       </plugin>
     </plugins>
   </build>

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

@@ -1,15 +1,18 @@
 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.Flags;
+import com.flagsmith.models.TraitModel;
+import com.flagsmith.models.environments.EnvironmentModel;
+import com.flagsmith.models.features.FeatureStateModel;
 import com.flagsmith.responses.FlagsAndTraitsResponse;
 import com.flagsmith.threads.AnalyticsProcessor;
 import com.flagsmith.threads.RequestProcessor;
@@ -20,7 +23,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;
@@ -248,19 +250,22 @@ 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>() {},
         Boolean.TRUE);
 
     try {
-      return environmentFuture.get(TIMEOUT, TimeUnit.MILLISECONDS);
+      EnvironmentModel environment = environmentFuture.get(TIMEOUT, TimeUnit.MILLISECONDS);
+      return EngineMappers.mapEnvironmentToContext(environment);
     } 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);