diff --git a/client/src/main/java/io/split/Spec.java b/client/src/main/java/io/split/Spec.java
index 9e03a59ab..847e19e1c 100644
--- a/client/src/main/java/io/split/Spec.java
+++ b/client/src/main/java/io/split/Spec.java
@@ -6,6 +6,8 @@ private Spec() {
// restrict instantiation
}
- public static final String SPEC_VERSION = "1.1";
+ public static String SPEC_VERSION = "1.3";
+ public static final String SPEC_1_3 = "1.3";
+ public static final String SPEC_1_1 = "1.1";
}
diff --git a/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java b/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java
index a3e234a3e..980bc067c 100644
--- a/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java
+++ b/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java
@@ -2,6 +2,7 @@
import com.google.common.annotations.VisibleForTesting;
+import io.split.Spec;
import io.split.client.dtos.SplitChange;
import io.split.client.dtos.SplitHttpResponse;
import io.split.client.exceptions.UriTooLongException;
@@ -31,6 +32,7 @@ public final class HttpSplitChangeFetcher implements SplitChangeFetcher {
private static final Logger _log = LoggerFactory.getLogger(HttpSplitChangeFetcher.class);
private static final String SINCE = "since";
+ private static final String RB_SINCE = "rbSince";
private static final String TILL = "till";
private static final String SETS = "sets";
private static final String SPEC = "s";
@@ -56,38 +58,48 @@ long makeRandomTill() {
}
@Override
- public SplitChange fetch(long since, FetchOptions options) {
+ public SplitChange fetch(long since, long sinceRBS, FetchOptions options) {
long start = System.currentTimeMillis();
+ for (int i=0; i<2; i++) {
+ try {
+ URIBuilder uriBuilder = new URIBuilder(_target).addParameter(SPEC, "" + SPEC_VERSION);
+ uriBuilder.addParameter(SINCE, "" + since);
+ if (SPEC_VERSION.equals(Spec.SPEC_1_3)) {
+ uriBuilder.addParameter(RB_SINCE, "" + sinceRBS);
+ }
+ if (!options.flagSetsFilter().isEmpty()) {
+ uriBuilder.addParameter(SETS, "" + options.flagSetsFilter());
+ }
+ if (options.hasCustomCN()) {
+ uriBuilder.addParameter(TILL, "" + options.targetCN());
+ }
+ URI uri = uriBuilder.build();
+ SplitHttpResponse response = _client.get(uri, options, null);
- try {
- URIBuilder uriBuilder = new URIBuilder(_target).addParameter(SPEC, "" + SPEC_VERSION);
- uriBuilder.addParameter(SINCE, "" + since);
- if (!options.flagSetsFilter().isEmpty()) {
- uriBuilder.addParameter(SETS, "" + options.flagSetsFilter());
- }
- if (options.hasCustomCN()) {
- uriBuilder.addParameter(TILL, "" + options.targetCN());
- }
- URI uri = uriBuilder.build();
- SplitHttpResponse response = _client.get(uri, options, null);
-
- if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
- if (response.statusCode() == HttpStatus.SC_REQUEST_URI_TOO_LONG) {
- _log.error("The amount of flag sets provided are big causing uri length error.");
- throw new UriTooLongException(String.format("Status code: %s. Message: %s", response.statusCode(), response.statusMessage()));
+ if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+ if (response.statusCode() == HttpStatus.SC_REQUEST_URI_TOO_LONG) {
+ _log.error("The amount of flag sets provided are big causing uri length error.");
+ throw new UriTooLongException(String.format("Status code: %s. Message: %s", response.statusCode(), response.statusMessage()));
+ }
+ if (response.statusCode() == HttpStatus.SC_BAD_REQUEST && response.statusMessage().equals("unknown spec")) {
+ _log.warn(String.format("Detected old spec response, falling back to spec 1.1"));
+ SPEC_VERSION = Spec.SPEC_1_1;
+ continue;
+ }
+ _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SPLIT_SYNC, response.statusCode());
+ throw new IllegalStateException(
+ String.format("Could not retrieve splitChanges since %s; http return code %s", since, response.statusCode())
+ );
}
- _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SPLIT_SYNC, response.statusCode());
- throw new IllegalStateException(
- String.format("Could not retrieve splitChanges since %s; http return code %s", since, response.statusCode())
- );
+ return Json.fromJson(response.body(), SplitChange.class);
+ } catch (Exception e) {
+ throw new IllegalStateException(String.format("Problem fetching splitChanges since %s: %s", since, e), e);
+ } finally {
+ _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.SPLITS, System.currentTimeMillis() - start);
}
- return Json.fromJson(response.body(), SplitChange.class);
- } catch (Exception e) {
- throw new IllegalStateException(String.format("Problem fetching splitChanges since %s: %s", since, e), e);
- } finally {
- _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.SPLITS, System.currentTimeMillis()-start);
}
+ return null;
}
@VisibleForTesting
diff --git a/client/src/main/java/io/split/client/JsonLocalhostSplitChangeFetcher.java b/client/src/main/java/io/split/client/JsonLocalhostSplitChangeFetcher.java
index e2cb5d5c9..502d44182 100644
--- a/client/src/main/java/io/split/client/JsonLocalhostSplitChangeFetcher.java
+++ b/client/src/main/java/io/split/client/JsonLocalhostSplitChangeFetcher.java
@@ -29,7 +29,7 @@ public JsonLocalhostSplitChangeFetcher(InputStreamProvider inputStreamProvider)
}
@Override
- public SplitChange fetch(long since, FetchOptions options) {
+ public SplitChange fetch(long since, long RBsince, FetchOptions options) {
try {
JsonReader jsonReader = new JsonReader(new BufferedReader(new InputStreamReader(_inputStreamProvider.get(), StandardCharsets.UTF_8)));
SplitChange splitChange = Json.fromJson(jsonReader, SplitChange.class);
diff --git a/client/src/main/java/io/split/client/LegacyLocalhostSplitChangeFetcher.java b/client/src/main/java/io/split/client/LegacyLocalhostSplitChangeFetcher.java
index a35c92cfe..f2f83d653 100644
--- a/client/src/main/java/io/split/client/LegacyLocalhostSplitChangeFetcher.java
+++ b/client/src/main/java/io/split/client/LegacyLocalhostSplitChangeFetcher.java
@@ -34,7 +34,7 @@ public LegacyLocalhostSplitChangeFetcher(String directory) {
}
@Override
- public SplitChange fetch(long since, FetchOptions options) {
+ public SplitChange fetch(long since, long sinceRBS, FetchOptions options) {
try (BufferedReader reader = new BufferedReader(new FileReader(_splitFile))) {
SplitChange splitChange = new SplitChange();
diff --git a/client/src/main/java/io/split/client/SplitClient.java b/client/src/main/java/io/split/client/SplitClient.java
index a07718b1f..e12b5319f 100644
--- a/client/src/main/java/io/split/client/SplitClient.java
+++ b/client/src/main/java/io/split/client/SplitClient.java
@@ -2,6 +2,7 @@
import io.split.client.api.Key;
import io.split.client.api.SplitResult;
+import io.split.client.dtos.EvaluationOptions;
import java.util.List;
import java.util.Map;
@@ -96,7 +97,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatment(String, String)} but it returns the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -112,7 +113,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatment(String, String, Map)} but it returns the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -129,7 +130,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatment(Key, String, Map)} but it returns the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
* @param key the matching and bucketing keys. MUST NOT be null.
* @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
@@ -224,7 +225,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List)} but it returns the configuration associated to the
- * matching treatments if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatments if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -240,7 +241,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -257,7 +258,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(Key, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
* @param key the matching and bucketing keys. MUST NOT be null.
* @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
@@ -270,7 +271,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -285,7 +286,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -301,7 +302,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -317,7 +318,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -332,7 +333,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -348,7 +349,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -364,7 +365,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -380,7 +381,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -397,7 +398,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -414,7 +415,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -430,7 +431,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -447,7 +448,7 @@ public interface SplitClient {
/**
* Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
- * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
*
*
* Examples include showing a different treatment to users on trial plan
@@ -462,6 +463,488 @@ public interface SplitClient {
*/
Map getTreatmentsWithConfigByFlagSets(Key key, List flagSets, Map attributes);
+ /**
+ * Returns the treatment to show this key for this feature flag. The set of treatments
+ * for a feature flag can be configured on the Split user interface.
+ *
+ *
+ * This method returns the string 'control' if:
+ *
+ * - Any of the parameters were null
+ * - There was an exception in evaluating the treatment
+ * - The SDK does not know of the existence of this feature flag
+ * - The feature flag was deleted through the Split user interface.
+ *
+ * 'control' is a reserved treatment (you cannot create a treatment with the
+ * same name) to highlight these exceptional circumstances.
+ *
+ *
+ * The sdk returns the default treatment of this feature flag if:
+ *
+ * - The feature flag was killed
+ * - The key did not match any of the conditions in the feature flag roll-out plan
+ *
+ * The default treatment of a feature flag is set on the Split user interface.
+ *
+ *
+ * This method does not throw any exceptions. It also never returns null.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ String getTreatment(String key, String featureFlagName, EvaluationOptions evaluationOptions);
+
+ /**
+ * This method is useful when you want to determine the treatment to show
+ * to an customer (user, account etc.) based on an attribute of that customer
+ * instead of it's key.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ String getTreatment(String key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * To understand why this method is useful, consider the following simple Feature Flag as an example:
+ *
+ * if user is in segment employees then feature flag 100%:on
+ * else if user is in segment all then feature flag 20%:on,80%:off
+ *
+ * There are two concepts here: matching and bucketing. Matching
+ * refers to ‘user is in segment employees’ or ‘user is in segment
+ * all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’.
+ *
+ * By default, the same customer key is used for both matching and
+ * bucketing. However, for some advanced use cases, you may want
+ * to use different keys. For such cases, use this method.
+ *
+ * As an example, suppose you want to rollout to percentages of
+ * users in specific accounts. You can achieve that by matching
+ * via account id, but bucketing by user id.
+ *
+ * Another example is when you want to ensure that a user continues to get
+ * the same treatment after they sign up for your product that they used
+ * to get when they were simply a visitor to your site. In that case,
+ * before they sign up, you can use their visitor id for both matching and bucketing, but
+ * post log-in you can use their user id for matching and visitor id for bucketing.
+ *
+ *
+ * @param key the matching and bucketing keys. MUST NOT be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param attributes of the entity (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ *
+ * @return the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ String getTreatment(Key key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Returns a map of feature flag name and treatments to show this key for these feature flags. The set of treatments
+ * for a feature flag can be configured on the Split user interface.
+ *
+ *
+ * This method returns for each feature flag the string 'control' if:
+ *
+ * - Any of the parameters were null
+ * - There was an exception in evaluating the treatment
+ * - The SDK does not know of the existence of this feature flag
+ * - The feature flag was deleted through the Split user interface.
+ *
+ * 'control' is a reserved treatment (you cannot create a treatment with the
+ * same name) to highlight these exceptional circumstances.
+ *
+ *
+ * The sdk returns for each feature flag the default treatment of this feature flag if:
+ *
+ * - The feature flag was killed
+ * - The key did not match any of the conditions in the feature flag roll-out plan
+ *
+ * The default treatment of a feature flag is set on the Split user interface.
+ *
+ *
+ * This method does not throw any exceptions. It also never returns null.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment for each feature flag, or 'control'.
+ */
+ Map getTreatments(String key, List featureFlagNames, EvaluationOptions evaluationOptions);
+
+ /**
+ * This method is useful when you want to determine the treatments to show
+ * to a customer (user, account etc.) based on an attribute of that customer
+ * instead of their key.
+ *
+ *
+ * Examples include showing different treatments to users on trial plan
+ * vs. premium plan. Another example is to show different treatments
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatments(String key, List featureFlagNames, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * To understand why this method is useful, consider the following simple Feature Flag as an example:
+ *
+ * if user is in segment employees then feature flag 100%:on
+ * else if user is in segment all then feature flag 20%:on,80%:off
+ *
+ * There are two concepts here: matching and bucketing. Matching
+ * refers to ‘user is in segment employees’ or ‘user is in segment
+ * all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’.
+ *
+ * By default, the same customer key is used for both matching and
+ * bucketing. However, for some advanced use cases, you may want
+ * to use different keys. For such cases, use this method.
+ *
+ * As an example, suppose you want to rollout to percentages of
+ * users in specific accounts. You can achieve that by matching
+ * via account id, but bucketing by user id.
+ *
+ * Another example is when you want to ensure that a user continues to get
+ * the same treatment after they sign up for your product that they used
+ * to get when they were simply a visitor to your site. In that case,
+ * before they sign up, you can use their visitor id for both matching and bucketing, but
+ * post log-in you can use their user id for matching and visitor id for bucketing.
+ *
+ *
+ * @param key the matching and bucketing keys. MUST NOT be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param attributes of the entity (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ *
+ * @return for each feature flag the evaluated treatment, the default treatment of the feature flag, or 'control'.
+ */
+ Map getTreatments(Key key, List featureFlagNames, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatment(String, String)} but it returns the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and
+ * a configuration associated to this treatment if set.
+ */
+ SplitResult getTreatmentWithConfig(String key, String featureFlagName, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatment(Key, String, Map)} but it returns the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ * @param key the matching and bucketing keys. MUST NOT be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param attributes of the entity (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ *
+ * @return SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and
+ * a configuration associated to this treatment if set.
+ */
+ SplitResult getTreatmentWithConfig(Key key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatment(String, String, Map)} but it returns the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagName the name of the feature flag we want to evaluate. MUST NOT be null.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and
+ * a configuration associated to this treatment if set.
+ */
+ SplitResult getTreatmentWithConfig(String key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and
+ * a configuration associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfig(String key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List)} but it returns the configuration associated to the
+ * matching treatments if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return Map containing for each feature flag the evaluated treatment (the default treatment of
+ * this feature flag, or 'control') and a configuration associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfig(String key, List featureFlagNames, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSet(String key, String flagSet, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSets(String key, List flagSets, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSets(String key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSet(String key, String flagSet, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSets(String key, List flagSets, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSets(String key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSet(String key, String flagSet, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(Key, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ * @param key the matching and bucketing keys. MUST NOT be null.
+ * @param featureFlagNames the names of the feature flags we want to evaluate. MUST NOT be null.
+ * @param attributes of the entity (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ *
+ * @return for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and
+ * a configuration associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfig(Key key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSet(String key, String flagSet, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key the matching and bucketing keys. MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSet(Key key, String flagSet, Map attributes, EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key the matching and bucketing keys. MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+ */
+ Map getTreatmentsByFlagSets(Key key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key the matching and bucketing keys. MUST not be null or empty.
+ * @param flagSet the Flag Set name that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSet(Key key, String flagSet, Map attributes,
+ EvaluationOptions evaluationOptions);
+
+ /**
+ * Same as {@link #getTreatments(String, List, Map)} but it returns for each feature flag the configuration associated to the
+ * matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
+ *
+ *
+ * Examples include showing a different treatment to users on trial plan
+ * vs. premium plan. Another example is to show a different treatment
+ * to users created after a certain date.
+ *
+ * @param key the matching and bucketing keys. MUST not be null or empty.
+ * @param flagSets the names of Flag Sets that you want to evaluate. MUST not be null or empty.
+ * @param attributes of the customer (user, account etc.) to use in evaluation. Can be null or empty.
+ * @param evaluationOptions additional data to attach to the impression.
+ * @return for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration
+ * associated to this treatment if set.
+ */
+ Map getTreatmentsWithConfigByFlagSets(Key key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions);
+
/**
* Destroys the background processes and clears the cache, releasing the resources used by
* the any instances of SplitClient or SplitManager generated by the client's parent SplitFactory
diff --git a/client/src/main/java/io/split/client/SplitClientImpl.java b/client/src/main/java/io/split/client/SplitClientImpl.java
index 1ff143ed2..b73a2c24a 100644
--- a/client/src/main/java/io/split/client/SplitClientImpl.java
+++ b/client/src/main/java/io/split/client/SplitClientImpl.java
@@ -1,8 +1,12 @@
package io.split.client;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonParser;
import io.split.client.api.Key;
import io.split.client.api.SplitResult;
import io.split.client.dtos.DecoratedImpression;
+import io.split.client.dtos.EvaluationOptions;
import io.split.client.dtos.Event;
import io.split.client.events.EventsStorageProducer;
import io.split.client.impressions.Impression;
@@ -17,10 +21,12 @@
import io.split.inputValidation.KeyValidator;
import io.split.inputValidation.SplitNameValidator;
import io.split.inputValidation.TrafficTypeValidator;
+import io.split.inputValidation.ImpressionPropertiesValidator;
import io.split.storages.SplitCacheConsumer;
import io.split.telemetry.domain.enums.MethodEnum;
import io.split.telemetry.storage.TelemetryConfigProducer;
import io.split.telemetry.storage.TelemetryEvaluationProducer;
+import io.split.client.utils.Json;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -93,27 +99,30 @@ public String getTreatment(String key, String featureFlagName) {
@Override
public String getTreatment(String key, String featureFlagName, Map attributes) {
- return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, MethodEnum.TREATMENT).treatment();
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, new EvaluationOptions(null), MethodEnum.TREATMENT).treatment();
}
@Override
public String getTreatment(Key key, String featureFlagName, Map attributes) {
- return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, MethodEnum.TREATMENT).treatment();
+ return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, new EvaluationOptions(null),
+ MethodEnum.TREATMENT).treatment();
}
@Override
public SplitResult getTreatmentWithConfig(String key, String featureFlagName) {
- return getTreatmentWithConfigInternal(key, null, featureFlagName, Collections.emptyMap(), MethodEnum.TREATMENT_WITH_CONFIG);
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, Collections.emptyMap(), new EvaluationOptions(null),
+ MethodEnum.TREATMENT_WITH_CONFIG);
}
@Override
public SplitResult getTreatmentWithConfig(String key, String featureFlagName, Map attributes) {
- return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, MethodEnum.TREATMENT_WITH_CONFIG);
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, new EvaluationOptions(null), MethodEnum.TREATMENT_WITH_CONFIG);
}
@Override
public SplitResult getTreatmentWithConfig(Key key, String featureFlagName, Map attributes) {
- return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, MethodEnum.TREATMENT_WITH_CONFIG);
+ return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, new EvaluationOptions(null),
+ MethodEnum.TREATMENT_WITH_CONFIG);
}
@Override
@@ -123,111 +132,277 @@ public Map getTreatments(String key, List featureFlagNam
@Override
public Map getTreatments(String key, List featureFlagNames, Map attributes) {
- return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes, MethodEnum.TREATMENTS)
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS)
.entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatments(Key key, List featureFlagNames, Map attributes) {
- return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes, MethodEnum.TREATMENTS)
+ return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes,
+ new EvaluationOptions(null), MethodEnum.TREATMENTS)
.entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsWithConfig(String key, List featureFlagNames) {
- return getTreatmentsWithConfigInternal(key, null, featureFlagNames, Collections.emptyMap(),
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, Collections.emptyMap(), new EvaluationOptions(null),
MethodEnum.TREATMENTS_WITH_CONFIG);
}
@Override
public Map getTreatmentsWithConfig(String key, List featureFlagNames, Map attributes) {
- return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes, MethodEnum.TREATMENTS_WITH_CONFIG);
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes,
+ new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG);
}
@Override
public Map getTreatmentsWithConfig(Key key, List featureFlagNames, Map attributes) {
- return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes,
+ return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes, new EvaluationOptions(null),
MethodEnum.TREATMENTS_WITH_CONFIG);
}
@Override
public Map getTreatmentsByFlagSet(String key, String flagSet) {
return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
- null, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ null, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsByFlagSet(String key, String flagSet, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
- attributes, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsByFlagSet(Key key, String flagSet, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), new ArrayList<>(Arrays.asList(flagSet)),
- attributes, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsByFlagSets(String key, List flagSets) {
return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
- null, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ null, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsByFlagSets(String key, List flagSets, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
- attributes, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsByFlagSets(Key key, List flagSets, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), flagSets,
- attributes, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
}
@Override
public Map getTreatmentsWithConfigByFlagSet(String key, String flagSet) {
return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
- null, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ null, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
}
@Override
public Map getTreatmentsWithConfigByFlagSet(String key, String flagSet, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
- attributes, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
}
@Override
public Map getTreatmentsWithConfigByFlagSet(Key key, String flagSet, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), new ArrayList<>(Arrays.asList(flagSet)),
- attributes, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
}
@Override
public Map getTreatmentsWithConfigByFlagSets(String key, List flagSets) {
return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
- null, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ null, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
}
@Override
public Map getTreatmentsWithConfigByFlagSets(String key, List flagSets, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
- attributes, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
}
@Override
public Map getTreatmentsWithConfigByFlagSets(Key key, List flagSets, Map attributes) {
return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), flagSets,
- attributes, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ attributes, new EvaluationOptions(null), MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ }
+
+ @Override
+ public String getTreatment(String key, String featureFlagName, EvaluationOptions evaluationOptions) {
+ return getTreatment(key, featureFlagName, Collections.emptyMap(), evaluationOptions);
+ }
+
+ @Override
+ public String getTreatment(String key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions) {
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, evaluationOptions, MethodEnum.TREATMENT).treatment();
+ }
+
+ @Override
+ public String getTreatment(Key key, String featureFlagName, Map attributes, EvaluationOptions evaluationOptions) {
+ return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, evaluationOptions,
+ MethodEnum.TREATMENT).treatment();
+ }
+
+ @Override
+ public Map getTreatments(String key, List featureFlagNames,
+ EvaluationOptions evaluationOptions) {
+ return getTreatments(key, featureFlagNames, Collections.emptyMap(), evaluationOptions);
+ }
+
+ @Override
+ public Map getTreatments(String key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes, evaluationOptions, MethodEnum.TREATMENTS)
+ .entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatments(Key key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes, evaluationOptions,
+ MethodEnum.TREATMENTS)
+ .entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public SplitResult getTreatmentWithConfig(String key, String featureFlagName, EvaluationOptions evaluationOptions) {
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, Collections.emptyMap(), evaluationOptions,
+ MethodEnum.TREATMENT_WITH_CONFIG);
+ }
+
+ @Override
+ public SplitResult getTreatmentWithConfig(Key key, String featureFlagName, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagName, attributes, evaluationOptions,
+ MethodEnum.TREATMENT_WITH_CONFIG);
+ }
+
+ @Override
+ public SplitResult getTreatmentWithConfig(String key, String featureFlagName, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentWithConfigInternal(key, null, featureFlagName, attributes, evaluationOptions,
+ MethodEnum.TREATMENT_WITH_CONFIG);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfig(String key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, attributes, evaluationOptions,
+ MethodEnum.TREATMENTS_WITH_CONFIG);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfig(String key, List featureFlagNames, EvaluationOptions evaluationOptions) {
+ return getTreatmentsWithConfigInternal(key, null, featureFlagNames, null, evaluationOptions,
+ MethodEnum.TREATMENTS_WITH_CONFIG);
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSet(String key, String flagSet, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSets(String key, List flagSets, EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+ null, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSets(String key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSet(String key, String flagSet, EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+ null, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSet(String key, String flagSet, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSets(String key, List flagSets, EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+ null, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSets(String key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSet(String key, String flagSet, EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+ null, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsWithConfig(Key key, List featureFlagNames, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsWithConfigInternal(key.matchingKey(), key.bucketingKey(), featureFlagNames, attributes, evaluationOptions,
+ MethodEnum.TREATMENTS_WITH_CONFIG);
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSet(Key key, String flagSet, Map attributes, EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), new ArrayList<>(Arrays.asList(flagSet)),
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsByFlagSets(Key key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), flagSets,
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSet(Key key, String flagSet, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), new ArrayList<>(Arrays.asList(flagSet)),
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+ }
+
+ @Override
+ public Map getTreatmentsWithConfigByFlagSets(Key key, List flagSets, Map attributes,
+ EvaluationOptions evaluationOptions) {
+ return getTreatmentsBySetsWithConfigInternal(key.matchingKey(), key.bucketingKey(), flagSets,
+ attributes, evaluationOptions, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
}
@Override
@@ -313,7 +488,7 @@ private boolean track(Event event) {
}
private SplitResult getTreatmentWithConfigInternal(String matchingKey, String bucketingKey, String featureFlag, Map attributes, MethodEnum methodEnum) {
+ Object> attributes, EvaluationOptions evaluationOptions, MethodEnum methodEnum) {
long initTime = System.currentTimeMillis();
try {
checkSDKReady(methodEnum, Arrays.asList(featureFlag));
@@ -336,7 +511,6 @@ private SplitResult getTreatmentWithConfigInternal(String matchingKey, String bu
return SPLIT_RESULT_CONTROL;
}
featureFlag = splitNameResult.get();
-
long start = System.currentTimeMillis();
EvaluatorImp.TreatmentLabelAndChangeNumber result = _evaluator.evaluateFeature(matchingKey, bucketingKey, featureFlag, attributes);
@@ -358,7 +532,8 @@ private SplitResult getTreatmentWithConfigInternal(String matchingKey, String bu
_config.labelsEnabled() ? result.label : null,
result.changeNumber,
attributes,
- result.track
+ result.track,
+ validateProperties(evaluationOptions.getProperties())
);
_telemetryEvaluationProducer.recordLatency(methodEnum, System.currentTimeMillis() - initTime);
return new SplitResult(result.treatment, result.configurations);
@@ -373,8 +548,19 @@ private SplitResult getTreatmentWithConfigInternal(String matchingKey, String bu
}
}
+ private String validateProperties(Map properties) {
+ if (properties == null){
+ return null;
+ }
+
+ ImpressionPropertiesValidator.ImpressionPropertiesValidatorResult iPValidatorResult = ImpressionPropertiesValidator.propertiesAreValid(
+ properties);
+ return new GsonBuilder().create().toJson(iPValidatorResult.getValue()).toString();
+ }
+
private Map getTreatmentsWithConfigInternal(String matchingKey, String bucketingKey, List featureFlagNames,
- Map attributes, MethodEnum methodEnum) {
+ Map attributes,
+ EvaluationOptions evaluationOptions, MethodEnum methodEnum) {
long initTime = System.currentTimeMillis();
if (featureFlagNames == null) {
_log.error(String.format("%s: featureFlagNames must be a non-empty array", methodEnum.getMethod()));
@@ -389,7 +575,9 @@ private Map getTreatmentsWithConfigInternal(String matching
featureFlagNames = SplitNameValidator.areValid(featureFlagNames, methodEnum.getMethod());
Map evaluatorResult = _evaluator.evaluateFeatures(matchingKey,
bucketingKey, featureFlagNames, attributes);
- return processEvaluatorResult(evaluatorResult, methodEnum, matchingKey, bucketingKey, attributes, initTime);
+
+ return processEvaluatorResult(evaluatorResult, methodEnum, matchingKey, bucketingKey, attributes, initTime,
+ validateProperties(evaluationOptions.getProperties()));
} catch (Exception e) {
try {
_telemetryEvaluationProducer.recordException(methodEnum);
@@ -402,7 +590,9 @@ private Map getTreatmentsWithConfigInternal(String matching
}
private Map getTreatmentsBySetsWithConfigInternal(String matchingKey, String bucketingKey,
- List sets, Map attributes, MethodEnum methodEnum) {
+ List sets, Map attributes,
+ EvaluationOptions evaluationOptions,
+ MethodEnum methodEnum) {
long initTime = System.currentTimeMillis();
if (sets == null || sets.isEmpty()) {
@@ -423,7 +613,9 @@ private Map getTreatmentsBySetsWithConfigInternal(String ma
}
Map evaluatorResult = _evaluator.evaluateFeaturesByFlagSets(matchingKey,
bucketingKey, new ArrayList<>(cleanFlagSets), attributes);
- return processEvaluatorResult(evaluatorResult, methodEnum, matchingKey, bucketingKey, attributes, initTime);
+
+ return processEvaluatorResult(evaluatorResult, methodEnum, matchingKey, bucketingKey, attributes, initTime,
+ validateProperties(evaluationOptions.getProperties()));
} catch (Exception e) {
try {
_telemetryEvaluationProducer.recordException(methodEnum);
@@ -436,7 +628,7 @@ private Map getTreatmentsBySetsWithConfigInternal(String ma
}
private Map processEvaluatorResult(Map evaluatorResult,
MethodEnum methodEnum, String matchingKey, String bucketingKey, Map attributes, long initTime){
+ Object> attributes, long initTime, String properties){
List decoratedImpressions = new ArrayList<>();
Map result = new HashMap<>();
evaluatorResult.keySet().forEach(t -> {
@@ -450,7 +642,7 @@ private Map processEvaluatorResult(Map filterSetsAreInConfig(Set sets, MethodEnum methodEnu
return setsToReturn;
}
private void recordStats(String matchingKey, String bucketingKey, String featureFlagName, long start, String result,
- String operation, String label, Long changeNumber, Map attributes, boolean track) {
+ String operation, String label, Long changeNumber, Map attributes, boolean track, String properties) {
try {
_impressionManager.track(Stream.of(
new DecoratedImpression(
new Impression(matchingKey, bucketingKey, featureFlagName, result, System.currentTimeMillis(),
- label, changeNumber, attributes),
+ label, changeNumber, attributes, properties),
track)).collect(Collectors.toList()));
} catch (Throwable t) {
_log.error("Exception", t);
diff --git a/client/src/main/java/io/split/client/SplitFactoryImpl.java b/client/src/main/java/io/split/client/SplitFactoryImpl.java
index 848b50e86..454206d80 100644
--- a/client/src/main/java/io/split/client/SplitFactoryImpl.java
+++ b/client/src/main/java/io/split/client/SplitFactoryImpl.java
@@ -53,6 +53,7 @@
import io.split.engine.experiments.SplitFetcher;
import io.split.engine.experiments.SplitFetcherImp;
import io.split.engine.experiments.SplitParser;
+import io.split.engine.experiments.RuleBasedSegmentParser;
import io.split.engine.experiments.SplitSynchronizationTask;
import io.split.engine.segments.SegmentChangeFetcher;
import io.split.engine.segments.SegmentSynchronizationTaskImp;
@@ -66,8 +67,11 @@
import io.split.storages.SplitCache;
import io.split.storages.SplitCacheConsumer;
import io.split.storages.SplitCacheProducer;
+import io.split.storages.RuleBasedSegmentCacheConsumer;
+import io.split.storages.RuleBasedSegmentCache;
import io.split.storages.enums.OperationMode;
import io.split.storages.memory.InMemoryCacheImp;
+import io.split.storages.memory.RuleBasedSegmentCacheInMemoryImp;
import io.split.storages.memory.SegmentCacheInMemoryImpl;
import io.split.storages.pluggable.adapters.UserCustomEventAdapterProducer;
import io.split.storages.pluggable.adapters.UserCustomImpressionAdapterConsumer;
@@ -123,8 +127,7 @@
public class SplitFactoryImpl implements SplitFactory {
private static final org.slf4j.Logger _log = LoggerFactory.getLogger(SplitFactoryImpl.class);
private static final String LEGACY_LOG_MESSAGE = "The sdk initialize in localhost mode using Legacy file. The splitFile or "
- +
- "inputStream doesn't add it to the config.";
+ + "inputStream were not added to the config.";
private final static long SSE_CONNECT_TIMEOUT = 30000;
private final static long SSE_SOCKET_TIMEOUT = 70000;
@@ -204,6 +207,7 @@ public SplitFactoryImpl(String apiToken, SplitClientConfig config) throws URISyn
SegmentCache segmentCache = new SegmentCacheInMemoryImpl();
FlagSetsFilter flagSetsFilter = new FlagSetsFilterImpl(config.getSetsFilter());
SplitCache splitCache = new InMemoryCacheImp(flagSetsFilter);
+ RuleBasedSegmentCache ruleBasedSegmentCache = new RuleBasedSegmentCacheInMemoryImp();
ImpressionsStorage impressionsStorage = new InMemoryImpressionsStorage(config.impressionsQueueSize());
_splitCache = splitCache;
_segmentCache = segmentCache;
@@ -215,8 +219,11 @@ public SplitFactoryImpl(String apiToken, SplitClientConfig config) throws URISyn
_segmentSynchronizationTaskImp = buildSegments(config, segmentCache, splitCache);
SplitParser splitParser = new SplitParser();
+ RuleBasedSegmentParser ruleBasedSegmentParser = new RuleBasedSegmentParser();
+
// SplitFetcher
- _splitFetcher = buildSplitFetcher(splitCache, splitParser, flagSetsFilter);
+ _splitFetcher = buildSplitFetcher(splitCache, splitParser, flagSetsFilter, ruleBasedSegmentParser, ruleBasedSegmentCache);
+
// SplitSynchronizationTask
_splitSynchronizationTask = new SplitSynchronizationTask(_splitFetcher,
@@ -244,7 +251,7 @@ public SplitFactoryImpl(String apiToken, SplitClientConfig config) throws URISyn
config.getThreadFactory());
// Evaluator
- _evaluator = new EvaluatorImp(splitCache, segmentCache);
+ _evaluator = new EvaluatorImp(splitCache, segmentCache, ruleBasedSegmentCache);
// SplitClient
_client = new SplitClientImpl(this,
@@ -301,6 +308,9 @@ protected SplitFactoryImpl(String apiToken, SplitClientConfig config, CustomStor
customStorageWrapper);
UserCustomSplitAdapterConsumer userCustomSplitAdapterConsumer = new UserCustomSplitAdapterConsumer(
customStorageWrapper);
+ // TODO Update the instance to UserCustomRuleBasedSegmentAdapterConsumer
+ RuleBasedSegmentCacheConsumer userCustomRuleBasedSegmentAdapterConsumer = new RuleBasedSegmentCacheInMemoryImp();
+
// TODO migrate impressions sender to Task instead manager and not instantiate
// Producer here.
UserCustomImpressionAdapterConsumer userCustomImpressionAdapterConsumer = new UserCustomImpressionAdapterConsumer();
@@ -333,7 +343,7 @@ protected SplitFactoryImpl(String apiToken, SplitClientConfig config, CustomStor
_gates = new SDKReadinessGates();
_telemetrySynchronizer = new TelemetryConsumerSubmitter(customStorageWrapper, _sdkMetadata);
- _evaluator = new EvaluatorImp(userCustomSplitAdapterConsumer, userCustomSegmentAdapterConsumer);
+ _evaluator = new EvaluatorImp(userCustomSplitAdapterConsumer, userCustomSegmentAdapterConsumer, userCustomRuleBasedSegmentAdapterConsumer);
_impressionsSender = PluggableImpressionSender.create(customStorageWrapper);
_uniqueKeysTracker = createUniqueKeysTracker(config);
_impressionsManager = buildImpressionsManager(config, userCustomImpressionAdapterConsumer,
@@ -391,6 +401,7 @@ protected SplitFactoryImpl(SplitClientConfig config) {
SegmentCache segmentCache = new SegmentCacheInMemoryImpl();
FlagSetsFilter flagSetsFilter = new FlagSetsFilterImpl(config.getSetsFilter());
+ RuleBasedSegmentCache ruleBasedSegmentCache = new RuleBasedSegmentCacheInMemoryImp();
SplitCache splitCache = new InMemoryCacheImp(flagSetsFilter);
_splitCache = splitCache;
_gates = new SDKReadinessGates();
@@ -413,10 +424,11 @@ protected SplitFactoryImpl(SplitClientConfig config) {
// SplitFetcher
SplitChangeFetcher splitChangeFetcher = createSplitChangeFetcher(config);
+ RuleBasedSegmentParser ruleBasedSegmentParser = new RuleBasedSegmentParser();
SplitParser splitParser = new SplitParser();
_splitFetcher = new SplitFetcherImp(splitChangeFetcher, splitParser, splitCache, _telemetryStorageProducer,
- flagSetsFilter);
+ flagSetsFilter, ruleBasedSegmentParser, ruleBasedSegmentCache);
// SplitSynchronizationTask
_splitSynchronizationTask = new SplitSynchronizationTask(_splitFetcher, splitCache,
@@ -428,7 +440,7 @@ protected SplitFactoryImpl(SplitClientConfig config) {
_impressionsManager, null, null, null);
// Evaluator
- _evaluator = new EvaluatorImp(splitCache, segmentCache);
+ _evaluator = new EvaluatorImp(splitCache, segmentCache, ruleBasedSegmentCache);
EventsStorage eventsStorage = new NoopEventsStorageImp();
@@ -609,11 +621,12 @@ private SegmentSynchronizationTaskImp buildSegments(SplitClientConfig config,
}
private SplitFetcher buildSplitFetcher(SplitCacheProducer splitCacheProducer, SplitParser splitParser,
- FlagSetsFilter flagSetsFilter) throws URISyntaxException {
+ FlagSetsFilter flagSetsFilter, RuleBasedSegmentParser ruleBasedSegmentParser,
+ RuleBasedSegmentCache ruleBasedSegmentCache) throws URISyntaxException {
SplitChangeFetcher splitChangeFetcher = HttpSplitChangeFetcher.create(_splitHttpClient, _rootTarget,
_telemetryStorageProducer);
return new SplitFetcherImp(splitChangeFetcher, splitParser, splitCacheProducer, _telemetryStorageProducer,
- flagSetsFilter);
+ flagSetsFilter,ruleBasedSegmentParser, ruleBasedSegmentCache);
}
private ImpressionsManagerImpl buildImpressionsManager(SplitClientConfig config,
diff --git a/client/src/main/java/io/split/client/YamlLocalhostSplitChangeFetcher.java b/client/src/main/java/io/split/client/YamlLocalhostSplitChangeFetcher.java
index e90ca1389..5e6836579 100644
--- a/client/src/main/java/io/split/client/YamlLocalhostSplitChangeFetcher.java
+++ b/client/src/main/java/io/split/client/YamlLocalhostSplitChangeFetcher.java
@@ -32,7 +32,7 @@ public YamlLocalhostSplitChangeFetcher(InputStreamProvider inputStreamProvider)
}
@Override
- public SplitChange fetch(long since, FetchOptions options) {
+ public SplitChange fetch(long since, long sinceRBS, FetchOptions options) {
try {
Yaml yaml = new Yaml();
List>> yamlSplits = yaml.load(_inputStreamProvider.get());
diff --git a/client/src/main/java/io/split/client/dtos/EvaluationOptions.java b/client/src/main/java/io/split/client/dtos/EvaluationOptions.java
new file mode 100644
index 000000000..b38125a49
--- /dev/null
+++ b/client/src/main/java/io/split/client/dtos/EvaluationOptions.java
@@ -0,0 +1,14 @@
+package io.split.client.dtos;
+
+import java.util.Map;
+
+public class EvaluationOptions {
+ private Map _properties;
+
+ public EvaluationOptions(Map properties) {
+ _properties = properties;
+ }
+ public Map getProperties() {
+ return _properties;
+ };
+}
diff --git a/client/src/main/java/io/split/client/dtos/Excluded.java b/client/src/main/java/io/split/client/dtos/Excluded.java
new file mode 100644
index 000000000..bc544d97d
--- /dev/null
+++ b/client/src/main/java/io/split/client/dtos/Excluded.java
@@ -0,0 +1,8 @@
+package io.split.client.dtos;
+
+import java.util.List;
+
+public class Excluded {
+ public List keys;
+ public List segments;
+}
diff --git a/client/src/main/java/io/split/client/dtos/KeyImpression.java b/client/src/main/java/io/split/client/dtos/KeyImpression.java
index 9b6713aac..1e0ef540e 100644
--- a/client/src/main/java/io/split/client/dtos/KeyImpression.java
+++ b/client/src/main/java/io/split/client/dtos/KeyImpression.java
@@ -15,6 +15,9 @@ public class KeyImpression {
/* package private */ static final String FIELD_TIME = "m";
/* package private */ static final String FIELD_CHANGE_NUMBER = "c";
/* package private */ static final String FIELD_PREVIOUS_TIME = "pt";
+ /* package private */ static final String FIELD_PROPERTIES = "properties";
+
+ public static int MAX_PROPERTIES_LENGTH_BYTES = 32 * 1024;
public transient String feature; // Non-serializable
@@ -39,6 +42,9 @@ public class KeyImpression {
@SerializedName(FIELD_PREVIOUS_TIME)
public Long previousTime;
+ @SerializedName(FIELD_PROPERTIES)
+ public String properties;
+
@Override
public boolean equals(Object o) {
if (this == o) return true;
@@ -50,6 +56,7 @@ public boolean equals(Object o) {
if (!Objects.equals(feature, that.feature)) return false;
if (!keyName.equals(that.keyName)) return false;
if (!treatment.equals(that.treatment)) return false;
+ if (properties != null && !properties.equals(that.properties)) return false;
if (bucketingKey == null) {
return that.bucketingKey == null;
@@ -78,6 +85,7 @@ public static KeyImpression fromImpression(Impression i) {
ki.treatment = i.treatment();
ki.label = i.appliedRule();
ki.previousTime = i.pt();
+ ki.properties = i.properties();
return ki;
}
}
diff --git a/client/src/main/java/io/split/client/dtos/RuleBasedSegment.java b/client/src/main/java/io/split/client/dtos/RuleBasedSegment.java
new file mode 100644
index 000000000..ec1cc68ae
--- /dev/null
+++ b/client/src/main/java/io/split/client/dtos/RuleBasedSegment.java
@@ -0,0 +1,12 @@
+package io.split.client.dtos;
+
+import java.util.List;
+
+public class RuleBasedSegment {
+ public String name;
+ public Status status;
+ public String trafficTypeName;
+ public long changeNumber;
+ public List conditions;
+ public Excluded excluded;
+}
diff --git a/client/src/main/java/io/split/client/dtos/RuleBasedSegmentChange.java b/client/src/main/java/io/split/client/dtos/RuleBasedSegmentChange.java
new file mode 100644
index 000000000..9f475003c
--- /dev/null
+++ b/client/src/main/java/io/split/client/dtos/RuleBasedSegmentChange.java
@@ -0,0 +1,9 @@
+package io.split.client.dtos;
+
+import java.util.List;
+
+public class RuleBasedSegmentChange {
+ public List ruleBasedSegments;
+ public long since;
+ public long till;
+}
diff --git a/client/src/main/java/io/split/client/dtos/SplitChange.java b/client/src/main/java/io/split/client/dtos/SplitChange.java
index ba1130886..f7eb9a3d7 100644
--- a/client/src/main/java/io/split/client/dtos/SplitChange.java
+++ b/client/src/main/java/io/split/client/dtos/SplitChange.java
@@ -6,4 +6,7 @@ public class SplitChange {
public List splits;
public long since;
public long till;
+ public List ruleBasedSegments;
+ public long sinceRBS;
+ public long tillRBS;
}
diff --git a/client/src/main/java/io/split/client/impressions/Impression.java b/client/src/main/java/io/split/client/impressions/Impression.java
index 31678f2bd..fc7b73141 100644
--- a/client/src/main/java/io/split/client/impressions/Impression.java
+++ b/client/src/main/java/io/split/client/impressions/Impression.java
@@ -16,10 +16,11 @@ public class Impression {
private final Long _changeNumber;
private Long _pt;
private final Map _attributes;
+ private final String _properties;
public Impression(String key, String bucketingKey, String featureFlag, String treatment, long time, String appliedRule,
- Long changeNumber, Map atributes) {
+ Long changeNumber, Map atributes, String properties) {
_key = key;
_bucketingKey = bucketingKey;
_split = featureFlag;
@@ -28,6 +29,7 @@ public Impression(String key, String bucketingKey, String featureFlag, String tr
_appliedRule = appliedRule;
_changeNumber = changeNumber;
_attributes = atributes;
+ _properties = properties;
}
public String key() {
@@ -67,4 +69,8 @@ public Long pt() {
}
public Impression withPreviousTime(Long pt) { _pt = pt; return this; }
+
+ public String properties() {
+ return _properties;
+ }
}
diff --git a/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionDebug.java b/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionDebug.java
index 1fcd1615b..0ac5a20d9 100644
--- a/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionDebug.java
+++ b/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionDebug.java
@@ -19,6 +19,9 @@ public ProcessImpressionDebug(boolean listenerEnabled, ImpressionObserver impres
@Override
public ImpressionsResult process(List impressions) {
for(Impression impression : impressions) {
+ if (impression.properties() != null) {
+ continue;
+ }
impression.withPreviousTime(_impressionObserver.testAndSet(impression));
}
List impressionForListener = this._listenerEnabled ? impressions : null;
diff --git a/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionOptimized.java b/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionOptimized.java
index 1af51a209..3bfdc8185 100644
--- a/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionOptimized.java
+++ b/client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionOptimized.java
@@ -32,6 +32,10 @@ public ProcessImpressionOptimized(boolean listenerEnabled, ImpressionObserver im
public ImpressionsResult process(List impressions) {
List impressionsToQueue = new ArrayList<>();
for(Impression impression : impressions) {
+ if (impression.properties() != null) {
+ impressionsToQueue.add(impression);
+ continue;
+ }
impression = impression.withPreviousTime(_impressionObserver.testAndSet(impression));
if(!Objects.isNull(impression.pt()) && impression.pt() != 0){
_impressionCounter.inc(impression.split(), impression.time(), 1);
diff --git a/client/src/main/java/io/split/client/utils/FeatureFlagProcessor.java b/client/src/main/java/io/split/client/utils/FeatureFlagProcessor.java
index f6e4878a9..9b62415af 100644
--- a/client/src/main/java/io/split/client/utils/FeatureFlagProcessor.java
+++ b/client/src/main/java/io/split/client/utils/FeatureFlagProcessor.java
@@ -1,10 +1,14 @@
package io.split.client.utils;
+import io.split.client.dtos.RuleBasedSegment;
import io.split.client.dtos.Split;
import io.split.client.dtos.Status;
import io.split.client.interceptors.FlagSetsFilter;
+import io.split.engine.experiments.ParsedRuleBasedSegment;
import io.split.engine.experiments.ParsedSplit;
+import io.split.engine.experiments.RuleBasedSegmentParser;
import io.split.engine.experiments.SplitParser;
+import io.split.storages.RuleBasedSegmentCacheProducer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -40,4 +44,27 @@ public static FeatureFlagsToUpdate processFeatureFlagChanges(SplitParser splitPa
}
return new FeatureFlagsToUpdate(toAdd, toRemove, segments);
}
+
+ public static RuleBasedSegmentsToUpdate processRuleBasedSegmentChanges(RuleBasedSegmentParser ruleBasedSegmentParser,
+ List ruleBasedSegments) {
+ List toAdd = new ArrayList<>();
+ List toRemove = new ArrayList<>();
+ Set segments = new HashSet<>();
+ for (RuleBasedSegment ruleBasedSegment : ruleBasedSegments) {
+ if (ruleBasedSegment.status != Status.ACTIVE) {
+ // archive.
+ toRemove.add(ruleBasedSegment.name);
+ continue;
+ }
+ ParsedRuleBasedSegment parsedRuleBasedSegment = ruleBasedSegmentParser.parse(ruleBasedSegment);
+ if (parsedRuleBasedSegment == null) {
+ _log.debug(String.format("We could not parse the rule based segment definition for: %s", ruleBasedSegment.name));
+ continue;
+ }
+ segments.addAll(parsedRuleBasedSegment.getSegmentsNames());
+ toAdd.add(parsedRuleBasedSegment);
+ }
+ return new RuleBasedSegmentsToUpdate(toAdd, toRemove, segments);
+ }
+
}
\ No newline at end of file
diff --git a/client/src/main/java/io/split/client/utils/RuleBasedSegmentsToUpdate.java b/client/src/main/java/io/split/client/utils/RuleBasedSegmentsToUpdate.java
new file mode 100644
index 000000000..22f10fbc0
--- /dev/null
+++ b/client/src/main/java/io/split/client/utils/RuleBasedSegmentsToUpdate.java
@@ -0,0 +1,31 @@
+package io.split.client.utils;
+
+import io.split.engine.experiments.ParsedRuleBasedSegment;
+import io.split.engine.experiments.ParsedSplit;
+
+import java.util.List;
+import java.util.Set;
+
+public class RuleBasedSegmentsToUpdate {
+ List toAdd;
+ List toRemove;
+ Set segments;
+
+ public RuleBasedSegmentsToUpdate(List toAdd, List toRemove, Set segments) {
+ this.toAdd = toAdd;
+ this.toRemove = toRemove;
+ this.segments = segments;
+ }
+
+ public List getToAdd() {
+ return toAdd;
+ }
+
+ public List getToRemove() {
+ return toRemove;
+ }
+
+ public Set getSegments() {
+ return segments;
+ }
+}
\ No newline at end of file
diff --git a/client/src/main/java/io/split/engine/common/FetchOptions.java b/client/src/main/java/io/split/engine/common/FetchOptions.java
index 926137135..ff7a3d49d 100644
--- a/client/src/main/java/io/split/engine/common/FetchOptions.java
+++ b/client/src/main/java/io/split/engine/common/FetchOptions.java
@@ -12,6 +12,7 @@ public Builder() {}
public Builder(FetchOptions opts) {
_targetCN = opts._targetCN;
+ _targetCnRBS = opts._targetCnRBS;
_cacheControlHeaders = opts._cacheControlHeaders;
_flagSetsFilter = opts._flagSetsFilter;
}
@@ -26,16 +27,22 @@ public Builder targetChangeNumber(long targetCN) {
return this;
}
+ public Builder targetChangeNumberRBS(long targetCnRBS) {
+ _targetCnRBS = targetCnRBS;
+ return this;
+ }
+
public Builder flagSetsFilter(String flagSetsFilter) {
_flagSetsFilter = flagSetsFilter;
return this;
}
public FetchOptions build() {
- return new FetchOptions(_cacheControlHeaders, _targetCN, _flagSetsFilter);
+ return new FetchOptions(_cacheControlHeaders, _targetCN, _targetCnRBS, _flagSetsFilter);
}
private long _targetCN = DEFAULT_TARGET_CHANGENUMBER;
+ private long _targetCnRBS = DEFAULT_TARGET_CHANGENUMBER;
private boolean _cacheControlHeaders = false;
private String _flagSetsFilter = "";
}
@@ -46,6 +53,8 @@ public boolean cacheControlHeadersEnabled() {
public long targetCN() { return _targetCN; }
+ public long targetCnRBS() { return _targetCnRBS; }
+
public boolean hasCustomCN() { return _targetCN != DEFAULT_TARGET_CHANGENUMBER; }
public String flagSetsFilter() {
@@ -54,9 +63,11 @@ public String flagSetsFilter() {
private FetchOptions(boolean cacheControlHeaders,
long targetCN,
+ long targetCnRBS,
String flagSetsFilter) {
_cacheControlHeaders = cacheControlHeaders;
_targetCN = targetCN;
+ _targetCnRBS = targetCnRBS;
_flagSetsFilter = flagSetsFilter;
}
@@ -70,6 +81,7 @@ public boolean equals(Object obj) {
return Objects.equals(_cacheControlHeaders, other._cacheControlHeaders)
&& Objects.equals(_targetCN, other._targetCN)
+ && Objects.equals(_targetCnRBS, other._targetCnRBS)
&& Objects.equals(_flagSetsFilter, other._flagSetsFilter);
}
@@ -81,5 +93,6 @@ public int hashCode() {
private final boolean _cacheControlHeaders;
private final long _targetCN;
+ private final long _targetCnRBS;
private final String _flagSetsFilter;
}
\ No newline at end of file
diff --git a/client/src/main/java/io/split/engine/evaluator/EvaluationContext.java b/client/src/main/java/io/split/engine/evaluator/EvaluationContext.java
index 7aab69578..9c3ee7036 100644
--- a/client/src/main/java/io/split/engine/evaluator/EvaluationContext.java
+++ b/client/src/main/java/io/split/engine/evaluator/EvaluationContext.java
@@ -1,5 +1,7 @@
package io.split.engine.evaluator;
+import io.split.storages.RuleBasedSegmentCacheConsumer;
+
import io.split.storages.SegmentCacheConsumer;
import static com.google.common.base.Preconditions.checkNotNull;
@@ -7,10 +9,13 @@
public class EvaluationContext {
private final Evaluator _evaluator;
private final SegmentCacheConsumer _segmentCacheConsumer;
+ private final RuleBasedSegmentCacheConsumer _ruleBasedSegmentCacheConsumer;
- public EvaluationContext(Evaluator evaluator, SegmentCacheConsumer segmentCacheConsumer) {
+ public EvaluationContext(Evaluator evaluator, SegmentCacheConsumer segmentCacheConsumer,
+ RuleBasedSegmentCacheConsumer ruleBasedSegmentCacheConsumer) {
_evaluator = checkNotNull(evaluator);
_segmentCacheConsumer = checkNotNull(segmentCacheConsumer);
+ _ruleBasedSegmentCacheConsumer = checkNotNull(ruleBasedSegmentCacheConsumer);
}
public Evaluator getEvaluator() {
@@ -20,4 +25,8 @@ public Evaluator getEvaluator() {
public SegmentCacheConsumer getSegmentCache() {
return _segmentCacheConsumer;
}
+
+ public RuleBasedSegmentCacheConsumer getRuleBasedSegmentCache() {
+ return _ruleBasedSegmentCacheConsumer;
+ }
}
diff --git a/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java b/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java
index af165ca36..350f359d8 100644
--- a/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java
+++ b/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java
@@ -6,8 +6,10 @@
import io.split.engine.experiments.ParsedSplit;
import io.split.engine.splitter.Splitter;
import io.split.grammar.Treatments;
+import io.split.storages.RuleBasedSegmentCacheConsumer;
import io.split.storages.SegmentCacheConsumer;
import io.split.storages.SplitCacheConsumer;
+import static io.split.Spec.SPEC_VERSION;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -23,13 +25,16 @@ public class EvaluatorImp implements Evaluator {
private static final Logger _log = LoggerFactory.getLogger(EvaluatorImp.class);
private final SegmentCacheConsumer _segmentCacheConsumer;
+ private final RuleBasedSegmentCacheConsumer _ruleBasedSegmentCacheConsumer;
private final EvaluationContext _evaluationContext;
private final SplitCacheConsumer _splitCacheConsumer;
- public EvaluatorImp(SplitCacheConsumer splitCacheConsumer, SegmentCacheConsumer segmentCache) {
+ public EvaluatorImp(SplitCacheConsumer splitCacheConsumer, SegmentCacheConsumer segmentCache,
+ RuleBasedSegmentCacheConsumer ruleBasedSegmentCacheConsumer) {
_splitCacheConsumer = checkNotNull(splitCacheConsumer);
_segmentCacheConsumer = checkNotNull(segmentCache);
- _evaluationContext = new EvaluationContext(this, _segmentCacheConsumer);
+ _ruleBasedSegmentCacheConsumer = checkNotNull(ruleBasedSegmentCacheConsumer);
+ _evaluationContext = new EvaluationContext(this, _segmentCacheConsumer, ruleBasedSegmentCacheConsumer);
}
@Override
diff --git a/client/src/main/java/io/split/engine/experiments/ParsedRuleBasedSegment.java b/client/src/main/java/io/split/engine/experiments/ParsedRuleBasedSegment.java
new file mode 100644
index 000000000..fc6b5d008
--- /dev/null
+++ b/client/src/main/java/io/split/engine/experiments/ParsedRuleBasedSegment.java
@@ -0,0 +1,133 @@
+package io.split.engine.experiments;
+
+import com.google.common.collect.ImmutableList;
+import io.split.engine.matchers.AttributeMatcher;
+import io.split.engine.matchers.UserDefinedSegmentMatcher;
+
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * a value class representing an io.codigo.dtos.Experiment. Why are we not using
+ * that class? Because it does not have the logic of matching. ParsedExperiment
+ * has the matchers that also encapsulate the logic of matching. We
+ * can easily cache this object.
+ *
+ * @author adil
+ */
+public class ParsedRuleBasedSegment {
+
+ private final String _ruleBasedSegment;
+ private final ImmutableList _parsedCondition;
+ private final String _trafficTypeName;
+ private final long _changeNumber;
+ private final List _excludedKeys;
+ private final List _excludedSegments;
+
+ public static ParsedRuleBasedSegment createParsedRuleBasedSegmentForTests(
+ String ruleBasedSegment,
+ List matcherAndSplits,
+ String trafficTypeName,
+ long changeNumber,
+ List excludedKeys,
+ List excludedSegments
+ ) {
+ return new ParsedRuleBasedSegment(
+ ruleBasedSegment,
+ matcherAndSplits,
+ trafficTypeName,
+ changeNumber,
+ excludedKeys,
+ excludedSegments
+ );
+ }
+
+ public ParsedRuleBasedSegment(
+ String ruleBasedSegment,
+ List matcherAndSplits,
+ String trafficTypeName,
+ long changeNumber,
+ List excludedKeys,
+ List excludedSegments
+ ) {
+ _ruleBasedSegment = ruleBasedSegment;
+ _parsedCondition = ImmutableList.copyOf(matcherAndSplits);
+ _trafficTypeName = trafficTypeName;
+ _changeNumber = changeNumber;
+ _excludedKeys = excludedKeys;
+ _excludedSegments = excludedSegments;
+ }
+
+ public String ruleBasedSegment() {
+ return _ruleBasedSegment;
+ }
+
+ public List parsedConditions() {
+ return _parsedCondition;
+ }
+
+ public String trafficTypeName() {return _trafficTypeName;}
+
+ public long changeNumber() {return _changeNumber;}
+
+ public List excludedKeys() {return _excludedKeys;}
+ public List excludedSegments() {return _excludedSegments;}
+
+ @Override
+ public int hashCode() {
+ int result = 17;
+ result = 31 * result + _ruleBasedSegment.hashCode();
+ result = 31 * result + _parsedCondition.hashCode();
+ result = 31 * result + (_trafficTypeName == null ? 0 : _trafficTypeName.hashCode());
+ result = 31 * result + (int)(_changeNumber ^ (_changeNumber >>> 32));
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == null) return false;
+ if (this == obj) return true;
+ if (!(obj instanceof ParsedRuleBasedSegment)) return false;
+
+ ParsedRuleBasedSegment other = (ParsedRuleBasedSegment) obj;
+
+ return _ruleBasedSegment.equals(other._ruleBasedSegment)
+ && _parsedCondition.equals(other._parsedCondition)
+ && _trafficTypeName == null ? other._trafficTypeName == null : _trafficTypeName.equals(other._trafficTypeName)
+ && _changeNumber == other._changeNumber;
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder bldr = new StringBuilder();
+ bldr.append("name:");
+ bldr.append(_ruleBasedSegment);
+ bldr.append(", parsedConditions:");
+ bldr.append(_parsedCondition);
+ bldr.append(", trafficTypeName:");
+ bldr.append(_trafficTypeName);
+ bldr.append(", changeNumber:");
+ bldr.append(_changeNumber);
+ return bldr.toString();
+
+ }
+
+ public Set getSegmentsNames() {
+ return parsedConditions().stream()
+ .flatMap(parsedCondition -> parsedCondition.matcher().attributeMatchers().stream())
+ .filter(ParsedRuleBasedSegment::isSegmentMatcher)
+ .map(ParsedRuleBasedSegment::asSegmentMatcherForEach)
+ .map(UserDefinedSegmentMatcher::getSegmentName)
+ .collect(Collectors.toSet());
+ }
+
+ private static boolean isSegmentMatcher(AttributeMatcher attributeMatcher) {
+ return ((AttributeMatcher.NegatableMatcher) attributeMatcher.matcher()).delegate() instanceof UserDefinedSegmentMatcher;
+ }
+
+ private static UserDefinedSegmentMatcher asSegmentMatcherForEach(AttributeMatcher attributeMatcher) {
+ return (UserDefinedSegmentMatcher) ((AttributeMatcher.NegatableMatcher) attributeMatcher.matcher()).delegate();
+ }
+
+}
diff --git a/client/src/main/java/io/split/engine/experiments/RuleBasedSegmentParser.java b/client/src/main/java/io/split/engine/experiments/RuleBasedSegmentParser.java
new file mode 100644
index 000000000..c734f425a
--- /dev/null
+++ b/client/src/main/java/io/split/engine/experiments/RuleBasedSegmentParser.java
@@ -0,0 +1,220 @@
+package io.split.engine.experiments;
+
+import com.google.common.collect.Lists;
+import io.split.client.dtos.*;
+import io.split.client.dtos.Matcher;
+import io.split.engine.evaluator.Labels;
+import io.split.engine.matchers.*;
+import io.split.engine.matchers.collections.ContainsAllOfSetMatcher;
+import io.split.engine.matchers.collections.ContainsAnyOfSetMatcher;
+import io.split.engine.matchers.collections.EqualToSetMatcher;
+import io.split.engine.matchers.collections.PartOfSetMatcher;
+import io.split.engine.matchers.strings.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+import java.util.Objects;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Converts io.codigo.dtos.Experiment to io.codigo.engine.splits.ParsedExperiment.
+ *
+ * @author adil
+ */
+public final class RuleBasedSegmentParser {
+
+ private static final Logger _log = LoggerFactory.getLogger(RuleBasedSegmentParser.class);
+
+ public RuleBasedSegmentParser() {
+ }
+
+ public ParsedRuleBasedSegment parse(RuleBasedSegment ruleBasedSegment) {
+ try {
+ return parseWithoutExceptionHandling(ruleBasedSegment);
+ } catch (Throwable t) {
+ _log.error("Could not parse rule based segment: " + ruleBasedSegment, t);
+ return null;
+ }
+ }
+
+ private ParsedRuleBasedSegment parseWithoutExceptionHandling(RuleBasedSegment ruleBasedSegment) {
+ List parsedConditionList = Lists.newArrayList();
+ for (Condition condition : ruleBasedSegment.conditions) {
+ List partitions = condition.partitions;
+ if (checkUnsupportedMatcherExist(condition.matcherGroup.matchers)) {
+ _log.error("Unsupported matcher type found for rule based segment: " + ruleBasedSegment.name +
+ " , will revert to default template matcher.");
+ parsedConditionList.clear();
+ parsedConditionList.add(getTemplateCondition());
+ break;
+ }
+ CombiningMatcher matcher = toMatcher(condition.matcherGroup);
+ parsedConditionList.add(new ParsedCondition(condition.conditionType, matcher, partitions, condition.label));
+ }
+
+ return new ParsedRuleBasedSegment(
+ ruleBasedSegment.name,
+ parsedConditionList,
+ ruleBasedSegment.trafficTypeName,
+ ruleBasedSegment.changeNumber,
+ ruleBasedSegment.excluded.keys,
+ ruleBasedSegment.excluded.segments);
+ }
+
+ private boolean checkUnsupportedMatcherExist(List matchers) {
+ MatcherType typeCheck = null;
+ for (Matcher matcher : matchers) {
+ typeCheck = null;
+ try {
+ typeCheck = matcher.matcherType;
+ } catch (NullPointerException e) {
+ // If the exception is caught, it means unsupported matcher
+ break;
+ }
+ }
+ if (typeCheck != null) return false;
+ return true;
+ }
+
+ private ParsedCondition getTemplateCondition() {
+ List templatePartitions = Lists.newArrayList();
+ Partition partition = new Partition();
+ partition.treatment = "control";
+ partition.size = 100;
+ templatePartitions.add(partition);
+ return new ParsedCondition(
+ ConditionType.ROLLOUT,
+ CombiningMatcher.of(new AllKeysMatcher()),
+ templatePartitions,
+ Labels.UNSUPPORTED_MATCHER);
+ }
+
+ private CombiningMatcher toMatcher(MatcherGroup matcherGroup) {
+ List matchers = matcherGroup.matchers;
+ checkArgument(!matchers.isEmpty());
+
+ List toCombine = Lists.newArrayList();
+
+ for (Matcher matcher : matchers) {
+ toCombine.add(toMatcher(matcher));
+ }
+
+ return new CombiningMatcher(matcherGroup.combiner, toCombine);
+ }
+
+
+ private AttributeMatcher toMatcher(Matcher matcher) {
+ io.split.engine.matchers.Matcher delegate = null;
+ switch (matcher.matcherType) {
+ case ALL_KEYS:
+ delegate = new AllKeysMatcher();
+ break;
+ case IN_SEGMENT:
+ checkNotNull(matcher.userDefinedSegmentMatcherData);
+ String segmentName = matcher.userDefinedSegmentMatcherData.segmentName;
+ delegate = new UserDefinedSegmentMatcher(segmentName);
+ break;
+ case WHITELIST:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new WhitelistMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case EQUAL_TO:
+ checkNotNull(matcher.unaryNumericMatcherData);
+ delegate = new EqualToMatcher(matcher.unaryNumericMatcherData.value, matcher.unaryNumericMatcherData.dataType);
+ break;
+ case GREATER_THAN_OR_EQUAL_TO:
+ checkNotNull(matcher.unaryNumericMatcherData);
+ delegate = new GreaterThanOrEqualToMatcher(matcher.unaryNumericMatcherData.value, matcher.unaryNumericMatcherData.dataType);
+ break;
+ case LESS_THAN_OR_EQUAL_TO:
+ checkNotNull(matcher.unaryNumericMatcherData);
+ delegate = new LessThanOrEqualToMatcher(matcher.unaryNumericMatcherData.value, matcher.unaryNumericMatcherData.dataType);
+ break;
+ case BETWEEN:
+ checkNotNull(matcher.betweenMatcherData);
+ delegate = new BetweenMatcher(matcher.betweenMatcherData.start, matcher.betweenMatcherData.end, matcher.betweenMatcherData.dataType);
+ break;
+ case EQUAL_TO_SET:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new EqualToSetMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case PART_OF_SET:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new PartOfSetMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case CONTAINS_ALL_OF_SET:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new ContainsAllOfSetMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case CONTAINS_ANY_OF_SET:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new ContainsAnyOfSetMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case STARTS_WITH:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new StartsWithAnyOfMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case ENDS_WITH:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new EndsWithAnyOfMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case CONTAINS_STRING:
+ checkNotNull(matcher.whitelistMatcherData);
+ delegate = new ContainsAnyOfMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case MATCHES_STRING:
+ checkNotNull(matcher.stringMatcherData);
+ delegate = new RegularExpressionMatcher(matcher.stringMatcherData);
+ break;
+ case IN_SPLIT_TREATMENT:
+ checkNotNull(matcher.dependencyMatcherData,
+ "MatcherType is " + matcher.matcherType
+ + ". matcher.dependencyMatcherData() MUST NOT BE null");
+ delegate = new DependencyMatcher(matcher.dependencyMatcherData.split, matcher.dependencyMatcherData.treatments);
+ break;
+ case EQUAL_TO_BOOLEAN:
+ checkNotNull(matcher.booleanMatcherData,
+ "MatcherType is " + matcher.matcherType
+ + ". matcher.booleanMatcherData() MUST NOT BE null");
+ delegate = new BooleanMatcher(matcher.booleanMatcherData);
+ break;
+ case EQUAL_TO_SEMVER:
+ checkNotNull(matcher.stringMatcherData, "stringMatcherData is required for EQUAL_TO_SEMVER matcher type");
+ delegate = new EqualToSemverMatcher(matcher.stringMatcherData);
+ break;
+ case GREATER_THAN_OR_EQUAL_TO_SEMVER:
+ checkNotNull(matcher.stringMatcherData, "stringMatcherData is required for GREATER_THAN_OR_EQUAL_TO_SEMVER matcher type");
+ delegate = new GreaterThanOrEqualToSemverMatcher(matcher.stringMatcherData);
+ break;
+ case LESS_THAN_OR_EQUAL_TO_SEMVER:
+ checkNotNull(matcher.stringMatcherData, "stringMatcherData is required for LESS_THAN_OR_EQUAL_SEMVER matcher type");
+ delegate = new LessThanOrEqualToSemverMatcher(matcher.stringMatcherData);
+ break;
+ case IN_LIST_SEMVER:
+ checkNotNull(matcher.whitelistMatcherData, "whitelistMatcherData is required for IN_LIST_SEMVER matcher type");
+ delegate = new InListSemverMatcher(matcher.whitelistMatcherData.whitelist);
+ break;
+ case BETWEEN_SEMVER:
+ checkNotNull(matcher.betweenStringMatcherData, "betweenStringMatcherData is required for BETWEEN_SEMVER matcher type");
+ delegate = new BetweenSemverMatcher(matcher.betweenStringMatcherData.start, matcher.betweenStringMatcherData.end);
+ break;
+ default:
+ throw new IllegalArgumentException("Unknown matcher type: " + matcher.matcherType);
+ }
+
+ checkNotNull(delegate, "We were not able to create a matcher for: " + matcher.matcherType);
+
+ String attribute = null;
+ if (matcher.keySelector != null && matcher.keySelector.attribute != null) {
+ attribute = matcher.keySelector.attribute;
+ }
+
+ boolean negate = matcher.negate;
+
+
+ return new AttributeMatcher(attribute, delegate, negate);
+ }
+}
\ No newline at end of file
diff --git a/client/src/main/java/io/split/engine/experiments/SplitChangeFetcher.java b/client/src/main/java/io/split/engine/experiments/SplitChangeFetcher.java
index 7c5fbe76e..da6e185fa 100644
--- a/client/src/main/java/io/split/engine/experiments/SplitChangeFetcher.java
+++ b/client/src/main/java/io/split/engine/experiments/SplitChangeFetcher.java
@@ -32,5 +32,5 @@ public interface SplitChangeFetcher {
* @return SegmentChange
* @throws java.lang.RuntimeException if there was a problem computing split changes
*/
- SplitChange fetch(long since, FetchOptions options);
+ SplitChange fetch(long since, long sinceRBS, FetchOptions options);
}
diff --git a/client/src/main/java/io/split/engine/experiments/SplitFetcherImp.java b/client/src/main/java/io/split/engine/experiments/SplitFetcherImp.java
index 84b6a287d..6834ecaeb 100644
--- a/client/src/main/java/io/split/engine/experiments/SplitFetcherImp.java
+++ b/client/src/main/java/io/split/engine/experiments/SplitFetcherImp.java
@@ -1,9 +1,12 @@
package io.split.engine.experiments;
+import io.split.Spec;
import io.split.client.dtos.SplitChange;
import io.split.client.exceptions.UriTooLongException;
import io.split.client.interceptors.FlagSetsFilter;
import io.split.client.utils.FeatureFlagsToUpdate;
+import io.split.client.utils.RuleBasedSegmentsToUpdate;
+import io.split.storages.RuleBasedSegmentCacheProducer;
import io.split.storages.SplitCacheProducer;
import io.split.telemetry.domain.enums.LastSynchronizationRecordsEnum;
import io.split.telemetry.storage.TelemetryRuntimeProducer;
@@ -16,6 +19,7 @@
import static com.google.common.base.Preconditions.checkNotNull;
import static io.split.client.utils.FeatureFlagProcessor.processFeatureFlagChanges;
+import static io.split.client.utils.FeatureFlagProcessor.processRuleBasedSegmentChanges;
/**
* An ExperimentFetcher that refreshes experiment definitions periodically.
@@ -32,6 +36,8 @@ public class SplitFetcherImp implements SplitFetcher {
private final Object _lock = new Object();
private final TelemetryRuntimeProducer _telemetryRuntimeProducer;
private final FlagSetsFilter _flagSetsFilter;
+ private final RuleBasedSegmentCacheProducer _ruleBasedSegmentCacheProducer;
+ private final RuleBasedSegmentParser _parserRBS;
/**
* Contains all the traffic types that are currently being used by the splits and also the count
@@ -44,10 +50,13 @@ public class SplitFetcherImp implements SplitFetcher {
*/
public SplitFetcherImp(SplitChangeFetcher splitChangeFetcher, SplitParser parser, SplitCacheProducer splitCacheProducer,
- TelemetryRuntimeProducer telemetryRuntimeProducer, FlagSetsFilter flagSetsFilter) {
+ TelemetryRuntimeProducer telemetryRuntimeProducer, FlagSetsFilter flagSetsFilter,
+ RuleBasedSegmentParser parserRBS, RuleBasedSegmentCacheProducer ruleBasedSegmentCacheProducer) {
_splitChangeFetcher = checkNotNull(splitChangeFetcher);
_parser = checkNotNull(parser);
+ _parserRBS = checkNotNull(parserRBS);
_splitCacheProducer = checkNotNull(splitCacheProducer);
+ _ruleBasedSegmentCacheProducer = checkNotNull(ruleBasedSegmentCacheProducer);
_telemetryRuntimeProducer = checkNotNull(telemetryRuntimeProducer);
_flagSetsFilter = flagSetsFilter;
}
@@ -56,21 +65,31 @@ public SplitFetcherImp(SplitChangeFetcher splitChangeFetcher, SplitParser parser
public FetchResult forceRefresh(FetchOptions options) {
_log.debug("Force Refresh feature flags starting ...");
final long INITIAL_CN = _splitCacheProducer.getChangeNumber();
+ final long RBS_INITIAL_CN = _ruleBasedSegmentCacheProducer.getChangeNumber();
Set segments = new HashSet<>();
try {
while (true) {
long start = _splitCacheProducer.getChangeNumber();
+ long startRBS = _ruleBasedSegmentCacheProducer.getChangeNumber();
segments.addAll(runWithoutExceptionHandling(options));
long end = _splitCacheProducer.getChangeNumber();
+ long endRBS = _ruleBasedSegmentCacheProducer.getChangeNumber();
+ long targetChaneNumber = -1;
+ long targetChaneNumberRBS = -1;
// If the previous execution was the first one, clear the `cdnBypass` flag
// for the next fetches. (This will clear a local copy of the fetch options,
// not the original object that was passed to this method).
- if (INITIAL_CN == start) {
- options = new FetchOptions.Builder(options).targetChangeNumber(FetchOptions.DEFAULT_TARGET_CHANGENUMBER).build();
+ if (((INITIAL_CN == start || RBS_INITIAL_CN == startRBS) && Spec.SPEC_VERSION.equals(Spec.SPEC_1_3)) ||
+ (INITIAL_CN == start && Spec.SPEC_VERSION.equals(Spec.SPEC_1_1))) {
+ if (INITIAL_CN == start) targetChaneNumber = FetchOptions.DEFAULT_TARGET_CHANGENUMBER;
+ if (RBS_INITIAL_CN == startRBS) targetChaneNumberRBS = FetchOptions.DEFAULT_TARGET_CHANGENUMBER;
+ options = new FetchOptions.Builder(options).targetChangeNumber(targetChaneNumber).
+ targetChangeNumberRBS(targetChaneNumberRBS).build();
}
- if (start >= end) {
+ if ((start >= end && startRBS >= endRBS && Spec.SPEC_VERSION.equals(Spec.SPEC_1_3)) ||
+ (start >= end && Spec.SPEC_VERSION.equals(Spec.SPEC_1_1))) {
return new FetchResult(true, false, segments);
}
}
@@ -82,6 +101,7 @@ public FetchResult forceRefresh(FetchOptions options) {
return new FetchResult(false, true, new HashSet<>());
} catch (Exception e) {
_log.error("RefreshableSplitFetcher failed: " + e.getMessage());
+ _log.error("Reason:", e);
if (_log.isDebugEnabled()) {
_log.debug("Reason:", e);
}
@@ -95,36 +115,64 @@ public void run() {
}
private Set