Config v6

build.gradle

@@ -36,12 +36,15 @@ dependencies {
     api 'com.google.code.gson:gson:2.9.0'
     api 'commons-codec:commons-codec:1.15'
     api 'de.skuzzle:semantic-version:2.1.0'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
-    testImplementation 'org.slf4j:slf4j-simple:2.0.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
+    testImplementation 'ch.qos.logback:logback-classic:1.3.11'
+    testImplementation 'ch.qos.logback:logback-core:1.3.11'
     testImplementation 'com.squareup.okhttp3:mockwebserver:4.11.0'
     testImplementation 'org.mockito:mockito-core:4.2.0'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
-    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.8.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter-params:5.10.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.0'
+    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.10.0'
+
 }
 
 jar {

src/main/java/com/configcat/Condition.java

@@ -0,0 +1,30 @@
+package com.configcat;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * Represents a condition.
+ */
+public class Condition implements ConditionAccessor {
+    @SerializedName(value = "u")
+    private UserCondition userCondition;
+    @SerializedName(value = "s")
+    private SegmentCondition segmentCondition;
+    @SerializedName(value = "p")
+    private PrerequisiteFlagCondition prerequisiteFlagCondition;
+
+    @Override
+    public UserCondition getUserCondition() {
+        return userCondition;
+    }
+
+    @Override
+    public SegmentCondition getSegmentCondition() {
+        return segmentCondition;
+    }
+
+    @Override
+    public PrerequisiteFlagCondition getPrerequisiteFlagCondition() {
+        return prerequisiteFlagCondition;
+    }
+}

src/main/java/com/configcat/ConditionAccessor.java

@@ -0,0 +1,12 @@
+package com.configcat;
+
+/**
+ * The interface for the data classes which can be passed to the RolloutEvaluator.evaluateConditions method.
+ */
+public interface ConditionAccessor {
+    UserCondition getUserCondition();
+
+    SegmentCondition getSegmentCondition();
+
+    PrerequisiteFlagCondition getPrerequisiteFlagCondition();
+}

src/main/java/com/configcat/ConfigModels.java → src/main/java/com/configcat/Config.java

@@ -5,16 +5,36 @@
 import java.util.HashMap;
 import java.util.Map;
 
-class Config {
+/**
+ * Details of a ConfigCat config.
+ */
+public class Config {
+
+    /**
+     * The config preferences.
+     */
     @SerializedName(value = "p")
     private Preferences preferences;
+    /**
+     * The map of settings.
+     */
     @SerializedName(value = "f")
-    private Map<String, Setting> entries = new HashMap<>();
+    private final Map<String, Setting> entries = new HashMap<>();
+
+    /**
+     * The list of segments.
+     */
+    @SerializedName(value = "s")
+    private Segment[] segments;
 
     public Preferences getPreferences() {
         return preferences;
     }
 
+    public Segment[] getSegments() {
+        return segments;
+    }
+
     public Map<String, Setting> getEntries() {
         return entries;
     }
@@ -24,20 +44,4 @@ boolean isEmpty() {
     }
 
     public static final Config EMPTY = new Config();
-}
-
-class Preferences {
-    @SerializedName(value = "u")
-    private String baseUrl;
-    @SerializedName(value = "r")
-    private int redirect;
-
-    public String getBaseUrl() {
-        return baseUrl;
-    }
-
-    public int getRedirect() {
-        return redirect;
-    }
-}
-
+}

src/main/java/com/configcat/ConfigCatLogMessages.java

@@ -34,7 +34,7 @@ final class ConfigCatLogMessages {
     /**
      * Log message for Fetch Failed Due To Unexpected error. The log eventId is 1103.
      */
-    public static final String FETCH_FAILED_DUE_TO_UNEXPECTED_ERROR = "Unexpected error occurred while trying to fetch config JSON.";
+    public static final String FETCH_FAILED_DUE_TO_UNEXPECTED_ERROR = "Unexpected error occurred while trying to fetch config JSON. It is most likely due to a local network issue. Please make sure your application can reach the ConfigCat CDN servers (or your proxy server) over HTTP.";
 
     /**
      * Log message for Fetch Failed Due To Invalid Sdk Key error. The log eventId is 1100.
@@ -46,7 +46,7 @@ private ConfigCatLogMessages() { /* prevent from instantiation*/ }
     /**
      * Log message for Config Json Is Not Presented errors when the method returns with default value. The log eventId is 1000.
      *
-     * @param key The feature flag key.
+     * @param key               The feature flag key.
      * @param defaultParamName  The default parameter name.
      * @param defaultParamValue The default parameter value.
      * @return The formatted error message.
@@ -188,15 +188,65 @@ public static String getClientIsAlreadyCreated(final String sdkKey) {
     }
 
     /**
-     * Log message for Targeting Is Not Possible warning. The log eventId 3001.
+     * Log message for User Object is missing warning. The log eventId 3001.
      *
      * @param key The feature flag setting key.
      * @return The formatted warn message.
      */
-    public static String getTargetingIsNotPossible(final String key) {
+    public static String getUserObjectMissing(final String key) {
         return "Cannot evaluate targeting rules and % options for setting '" + key + "' (User Object is missing). You should pass a User Object to the evaluation methods like `getValue()`/`getValueAsync()` in order to make targeting work properly. Read more: https://configcat.com/docs/advanced/user-object/";
     }
 
+    /**
+     * Log message for User Attribute is missing warning. The log eventId 3003.
+     *
+     * @param key           The feature flag setting key.
+     * @param userCondition The user condition where the attribute is checked.
+     * @param attributeName The user attribute name.
+     * @return The formatted warn message.
+     */
+    public static String getUserAttributeMissing(final String key, final UserCondition userCondition, final String attributeName) {
+        return "Cannot evaluate condition (" + LogHelper.formatUserCondition(userCondition) + ") for setting '" + key + "' (the User." + attributeName + " attribute is missing). You should set the User." + attributeName + " attribute in order to make targeting work properly. Read more: https://configcat.com/docs/advanced/user-object/";
+    }
+
+    /**
+     * Log message for User Attribute is missing warning. The log eventId 3003.
+     *
+     * @param key           The feature flag setting key.
+     * @param attributeName The user attribute name.
+     * @return The formatted warn message.
+     */
+    public static String getUserAttributeMissing(final String key, final String attributeName) {
+        return "Cannot evaluate % options for setting '" + key + "' (the User." + attributeName + " attribute is missing). You should set the User." + attributeName + " attribute in order to make targeting work properly. Read more: https://configcat.com/docs/advanced/user-object/";
+    }
+
+    /**
+     * Log message for User Attribute is invalid warning. The log eventId 3004.
+     *
+     * @param key           The feature flag setting key.
+     * @param userCondition The user condition where the attribute is checked.
+     * @param reason        Why the attribute is invalid.
+     * @param attributeName The user attribute name.
+     * @return The formatted warn message.
+     */
+    public static String getUserAttributeInvalid(final String key, final UserCondition userCondition, final String reason, final String attributeName) {
+        return "Cannot evaluate condition (" + LogHelper.formatUserCondition(userCondition) + ") for setting '" + key + "' (" + reason + "). Please check the User." + attributeName + " attribute and make sure that its value corresponds to the comparison operator.";
+    }
+
+
+    /**
+     * Log message for User Attribute value is automatically converted warning. The log eventId 3005.
+     *
+     * @param key            The feature flag setting key.
+     * @param userCondition  The condition where the circularity is detected.
+     * @param attributeName  The user attribute name.
+     * @param attributeValue The user attribute value.
+     * @return The formatted warn message.
+     */
+    public static String getUserObjectAttributeIsAutoConverted(String key, UserCondition userCondition, String attributeName, String attributeValue) {
+        return "Evaluation of condition (" + LogHelper.formatUserCondition(userCondition) + ") for setting '" + key + "' may not produce the expected result (the User." + attributeName + " attribute is not a string value, thus it was automatically converted to the string value '" + attributeValue + "'). Please make sure that using a non-string value was intended.";
+    }
+
     /**
      * Log message for Config Service Method Has No Effect Due To Closed Client warning. The log eventId 3201.
      *

src/main/java/com/configcat/ConfigCatLogger.java

@@ -30,26 +30,26 @@ public void warn(int eventId, String message) {
     public void error(int eventId, String message, Exception exception) {
         if (this.configCatHooks != null) this.configCatHooks.invokeOnError(message);
         if (this.logLevel.ordinal() <= LogLevel.ERROR.ordinal()) {
-            this.logger.error("[{}] {}",eventId, message, exception);
+            this.logger.error("[{}] {}", eventId, message, exception);
         }
     }
 
     public void error(int eventId, String message) {
         if (this.configCatHooks != null) this.configCatHooks.invokeOnError(message);
         if (this.logLevel.ordinal() <= LogLevel.ERROR.ordinal()) {
-            this.logger.error("[{}] {}",eventId, message);
+            this.logger.error("[{}] {}", eventId, message);
         }
     }
 
     public void info(int eventId, String message) {
         if (this.logLevel.ordinal() <= LogLevel.INFO.ordinal()) {
-            this.logger.info("[{}] {}",eventId, message);
+            this.logger.info("[{}] {}", eventId, message);
         }
     }
 
     public void debug(String message) {
         if (this.logLevel.ordinal() <= LogLevel.DEBUG.ordinal()) {
-            this.logger.debug("[{}] {}",0, message);
+            this.logger.debug("[{}] {}", 0, message);
         }
     }
 }

src/main/java/com/configcat/ConfigFetcher.java

@@ -55,9 +55,8 @@ private CompletableFuture<FetchResponse> executeFetchAsync(int executionCount, S
                 if (config.getPreferences() == null) {
                     return CompletableFuture.completedFuture(fetchResponse);
                 }
-
                 String newUrl = config.getPreferences().getBaseUrl();
-                if (newUrl.equals(this.url)) {
+                if (newUrl == null || newUrl.isEmpty() || this.url.equals(newUrl)) {
                     return CompletableFuture.completedFuture(fetchResponse);
                 }
 
@@ -178,7 +177,7 @@ Request getRequest(String etag) {
 
     private Result<Config> deserializeConfig(String json) {
         try {
-            return Result.success(Utils.gson.fromJson(json, Config.class));
+            return Result.success(Utils.deserializeConfig(json));
         } catch (Exception e) {
             String message = ConfigCatLogMessages.FETCH_RECEIVED_200_WITH_INVALID_BODY_ERROR;
             this.logger.error(1105, message, e);

src/main/java/com/configcat/ConfigurationProvider.java

@@ -13,7 +13,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param defaultValue in case of any failure, this value will be returned.
      * @param <T>          the type of the desired feature flag or setting.
@@ -24,7 +24,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T asynchronously identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param user         the user object.
      * @param defaultValue in case of any failure, this value will be returned.
@@ -36,7 +36,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param defaultValue in case of any failure, this value will be returned.
      * @param <T>          the type of the desired feature flag or setting.
@@ -47,7 +47,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T asynchronously identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param user         the user object.
      * @param defaultValue in case of any failure, this value will be returned.
@@ -59,7 +59,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param defaultValue in case of any failure, this value will be returned.
      * @param <T>          the type of the desired feature flag or setting.
@@ -70,7 +70,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param user         the user object.
      * @param defaultValue in case of any failure, this value will be returned.
@@ -82,7 +82,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T asynchronously identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param defaultValue in case of any failure, this value will be returned.
      * @param <T>          the type of the desired feature flag or setting.
@@ -93,7 +93,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the value of a feature flag or setting as T asynchronously identified by the given {@code key}.
      *
-     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT     the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param key          the identifier of the feature flag or setting.
      * @param user         the user object.
      * @param defaultValue in case of any failure, this value will be returned.
@@ -165,7 +165,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the key of a setting and its value identified by the given Variation ID (analytics).
      *
-     * @param classOfT    the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT    the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param variationId the Variation ID.
      * @param <T>         the type of the desired feature flag or setting.
      * @return the key of a setting and its value.
@@ -175,7 +175,7 @@ public interface ConfigurationProvider extends Closeable {
     /**
      * Gets the key of a setting and its value identified by the given Variation ID (analytics).
      *
-     * @param classOfT    the class of T. Only {@link String}, {@link Integer}, {@link Double} or {@link Boolean} types are supported.
+     * @param classOfT    the class of T. Only {@link String}, {@link Integer}, {@link Double}, {@link Boolean} or {@link Object} types are supported.
      * @param variationId the Variation ID.
      * @param <T>         the type of the desired feature flag or setting.
      * @return a future which computes the key of a setting and its value.

src/main/java/com/configcat/Constants.java

@@ -5,8 +5,13 @@ private Constants() { /* prevent from instantiation*/ }
 
     static final long DISTANT_FUTURE = Long.MAX_VALUE;
     static final long DISTANT_PAST = 0;
-    static final String CONFIG_JSON_NAME = "config_v5.json";
+    static final String CONFIG_JSON_NAME = "config_v6.json";
     static final String SERIALIZATION_FORMAT_VERSION = "v2";
-
     static final String VERSION = "8.4.0";
+
+    static final String SDK_KEY_PROXY_PREFIX = "configcat-proxy/";
+    static final String SDK_KEY_PREFIX = "configcat-sdk-1";
+
+    static final int SDK_KEY_SECTION_LENGTH = 22;
+
 }