Add support scheduled rollout

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

Author: thomaspoignant

providers/go-feature-flag/src/main/java/dev/openfeature/contrib/providers/gofeatureflag/bean/Flag.java

@@ -1,22 +1,14 @@
 package dev.openfeature.contrib.providers.gofeatureflag.bean;
 
 import java.util.List;
-import java.util.Map;
 import lombok.Data;
+import lombok.EqualsAndHashCode;
 
 /**
  * Flag is a class that represents a feature flag for GO Feature Flag.
  */
+@EqualsAndHashCode(callSuper = true)
 @Data
-public class Flag {
-    private Map<String, Object> variations;
-    private List<Rule> targeting;
-    private String bucketingKey;
-    private Rule defaultRule;
-    private ExperimentationRollout experimentation;
-    private Boolean trackEvents;
-    private Boolean disable;
-    private String version;
-    private Map<String, Object> metadata;
-    // TODO: scheduledRollout
+public class Flag extends FlagBase {
+    private List<ScheduledStep> scheduledRollout;
 }

providers/go-feature-flag/src/main/java/dev/openfeature/contrib/providers/gofeatureflag/bean/FlagBase.java

@@ -0,0 +1,21 @@
+package dev.openfeature.contrib.providers.gofeatureflag.bean;
+
+import java.util.List;
+import java.util.Map;
+import lombok.Data;
+
+/**
+ * FlagBase is a class that represents the base structure of a feature flag for GO Feature Flag.
+ */
+@Data
+public abstract class FlagBase {
+    private Map<String, Object> variations;
+    private List<Rule> targeting;
+    private String bucketingKey;
+    private Rule defaultRule;
+    private ExperimentationRollout experimentation;
+    private Boolean trackEvents;
+    private Boolean disable;
+    private String version;
+    private Map<String, Object> metadata;
+}

providers/go-feature-flag/src/main/java/dev/openfeature/contrib/providers/gofeatureflag/bean/ScheduledStep.java

@@ -0,0 +1,14 @@
+package dev.openfeature.contrib.providers.gofeatureflag.bean;
+
+import java.util.Date;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * ScheduledStep is a class that represents a scheduled step in the rollout of a feature flag.
+ */
+@EqualsAndHashCode(callSuper = true)
+@Data
+public class ScheduledStep extends FlagBase {
+    private Date date;
+}

providers/go-feature-flag/src/main/java/dev/openfeature/contrib/providers/gofeatureflag/service/EvaluationService.java

@@ -20,7 +20,9 @@
  */
 @AllArgsConstructor
 public class EvaluationService {
-    /** The evaluator used to evaluate the flags. */
+    /**
+     * The evaluator used to evaluate the flags.
+     */
     private IEvaluator evaluator;
 
     /**
@@ -33,12 +35,16 @@ public boolean isFlagTrackable(final String flagKey) {
         return this.evaluator.isFlagTrackable(flagKey);
     }
 
-    /** Init the evaluator. */
+    /**
+     * Init the evaluator.
+     */
     public void init() {
         this.evaluator.init();
     }
 
-    /** Destroy the evaluator. */
+    /**
+     * Destroy the evaluator.
+     */
     public void destroy() {
         this.evaluator.destroy();
     }
@@ -62,6 +68,16 @@ public <T> ProviderEvaluation<T> getEvaluation(
 
         val goffResp = evaluator.evaluate(flagKey, defaultValue, evaluationContext);
 
+        // If we have an error code, we return the error directly.
+        if (goffResp.getErrorCode() != null && !goffResp.getErrorCode().isEmpty()) {
+            return ProviderEvaluation.<T>builder()
+                    .errorCode(mapErrorCode(goffResp.getErrorCode()))
+                    .errorMessage(goffResp.getErrorDetails())
+                    .reason(Reason.ERROR.name())
+                    .value(defaultValue)
+                    .build();
+        }
+
         if (Reason.DISABLED.name().equalsIgnoreCase(goffResp.getReason())) {
             // we don't set a variant since we are using the default value,
             // and we are not able to know which variant it is.

providers/go-feature-flag/src/main/java/dev/openfeature/contrib/providers/gofeatureflag/util/Const.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.util.StdDateFormat;
 import java.time.Duration;
 
 /**
@@ -24,6 +25,7 @@ public class Const {
     public static final ObjectMapper DESERIALIZE_OBJECT_MAPPER =
             new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
     public static final ObjectMapper SERIALIZE_OBJECT_MAPPER = new ObjectMapper();
-    public static final ObjectMapper SERIALIZE_WASM_MAPPER =
-            new ObjectMapper().setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL);
+    public static final ObjectMapper SERIALIZE_WASM_MAPPER = new ObjectMapper()
+            .setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)
+            .setDateFormat(new StdDateFormat().withColonInTimeZone(true));
 }

providers/go-feature-flag/src/test/java/dev/openfeature/contrib/providers/gofeatureflag/GoFeatureFlagProviderTest.java

@@ -537,6 +537,65 @@ void shouldIgnoreConfigurationIfEtagIsDifferentByLastModifiedIsOlder() {
             Thread.sleep(300L);
             assertFalse(configurationChangedCalled.get());
         }
+
+        @DisplayName("Should apply a scheduled rollout step")
+        @SneakyThrows
+        @Test
+        void shouldApplyAScheduledRolloutStep() {
+            try (val s = new MockWebServer()) {
+                val goffAPIMock = new GoffApiMock(GoffApiMock.MockMode.SCHEDULED_ROLLOUT_FLAG_CONFIG);
+                s.setDispatcher(goffAPIMock.dispatcher);
+                GoFeatureFlagProvider provider = new GoFeatureFlagProvider(GoFeatureFlagProviderOptions.builder()
+                        .endpoint(s.url("").toString())
+                        .evaluationType(EvaluationType.IN_PROCESS)
+                        .timeout(1000)
+                        .build());
+                OpenFeatureAPI.getInstance().setProviderAndWait(testName, provider);
+                val client = OpenFeatureAPI.getInstance().getClient(testName);
+                val got = client.getBooleanDetails("my-flag", false, TestUtils.defaultEvaluationContext);
+                val want = FlagEvaluationDetails.<Boolean>builder()
+                        .value(true)
+                        .variant("enabled")
+                        .flagKey("my-flag")
+                        .reason(Reason.TARGETING_MATCH.name())
+                        .flagMetadata(ImmutableMetadata.builder()
+                                .addString("description", "this is a test flag")
+                                .addBoolean("defaultValue", false)
+                                .build())
+                        .build();
+                assertEquals(want, got);
+            }
+        }
+
+        @DisplayName("Should not apply a scheduled rollout step if the date is in the future")
+        @SneakyThrows
+        @Test
+        void shouldNotApplyAScheduledRolloutStepIfTheDateIsInTheFuture() {
+            try (val s = new MockWebServer()) {
+                val goffAPIMock = new GoffApiMock(GoffApiMock.MockMode.SCHEDULED_ROLLOUT_FLAG_CONFIG);
+                s.setDispatcher(goffAPIMock.dispatcher);
+                GoFeatureFlagProvider provider = new GoFeatureFlagProvider(GoFeatureFlagProviderOptions.builder()
+                        .endpoint(s.url("").toString())
+                        .evaluationType(EvaluationType.IN_PROCESS)
+                        .timeout(1000)
+                        .build());
+                OpenFeatureAPI.getInstance().setProviderAndWait(testName, provider);
+                val client = OpenFeatureAPI.getInstance().getClient(testName);
+                val got = client.getBooleanDetails(
+                        "my-flag-scheduled-in-future", true, TestUtils.defaultEvaluationContext);
+                val want = FlagEvaluationDetails.<Boolean>builder()
+                        .value(false)
+                        .variant("disabled")
+                        .flagKey("my-flag-scheduled-in-future")
+                        .reason(Reason.STATIC.name())
+                        .flagMetadata(ImmutableMetadata.builder()
+                                .addString("description", "this is a test flag")
+                                .addBoolean("defaultValue", false)
+                                .build())
+                        .build();
+                assertEquals(want, got);
+            }
+        }
     }
 
     @Nested
@@ -555,7 +614,7 @@ void shouldSendTheEvaluationInformationToTheDataCollector() {
             val client = OpenFeatureAPI.getInstance().getClient(testName);
             client.getIntegerDetails("integer_key", 1000, TestUtils.defaultEvaluationContext);
             client.getIntegerDetails("integer_key", 1000, TestUtils.defaultEvaluationContext);
-            Thread.sleep(400L);
+            Thread.sleep(250L);
             assertEquals(1, goffAPIMock.getCollectorRequestsHistory().size());
         }
 

providers/go-feature-flag/src/test/java/dev/openfeature/contrib/providers/gofeatureflag/util/GoffApiMock.java

@@ -24,7 +24,9 @@ public class GoffApiMock {
     private int collectorCallCount = 0;
 
     private int configurationCallCount = 0;
-    /** lastRequestBody contains the body of the last request. */
+    /**
+     * lastRequestBody contains the body of the last request.
+     */
     @Getter
     private String lastRequestBody = null;
 
@@ -120,6 +122,9 @@ public MockResponse handleCollector(RecordedRequest request) {
     public MockResponse handleFlagConfiguration(RecordedRequest request) {
         var configLocation = "valid-all-types.json";
         switch (mode) {
+            case SCHEDULED_ROLLOUT_FLAG_CONFIG:
+                configLocation = "valid-scheduled-rollout.json";
+                break;
             case ENDPOINT_ERROR_404:
                 return new MockResponse().setResponseCode(404);
             case SERVE_OLD_CONFIGURATION:
@@ -187,5 +192,6 @@ public enum MockMode {
         SIMPLE_CONFIG,
         DEFAULT,
         SERVE_OLD_CONFIGURATION,
+        SCHEDULED_ROLLOUT_FLAG_CONFIG,
     }
 }

providers/go-feature-flag/src/test/resources/flag_config_responses/valid-scheduled-rollout.json

@@ -0,0 +1,58 @@
+{
+  "flags": {
+    "my-flag": {
+      "variations": {
+        "disabled": false,
+        "enabled": true
+      },
+      "defaultRule": {
+        "percentage": {
+          "enabled": 0,
+          "disabled": 100
+        }
+      },
+      "metadata": {
+        "description": "this is a test flag",
+        "defaultValue": false
+      },
+      "scheduledRollout": [
+        {
+          "targeting": [
+            {
+              "query": "targetingKey eq \"d45e303a-38c2-11ed-a261-0242ac120002\"",
+              "variation": "enabled"
+            }
+          ],
+          "date": "2022-07-31T22:00:00.100Z"
+        }
+      ]
+    },
+    "my-flag-scheduled-in-future": {
+      "variations": {
+        "disabled": false,
+        "enabled": true
+      },
+      "defaultRule": {
+        "percentage": {
+          "enabled": 0,
+          "disabled": 100
+        }
+      },
+      "metadata": {
+        "description": "this is a test flag",
+        "defaultValue": false
+      },
+      "scheduledRollout": [
+        {
+          "targeting": [
+            {
+              "query": "targetingKey eq \"d45e303a-38c2-11ed-a261-0242ac120002\"",
+              "variation": "enabled"
+            }
+          ],
+          "date": "3022-07-31T22:00:00.100Z"
+        }
+      ]
+    }
+  }
+}