Merge branch 'master' into update-changes

Author: chillaq

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

.github/workflows/update-license-year.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -24,7 +24,7 @@ jobs:
         run: "echo PREVIOUS=$(($CURRENT-1)) >> $GITHUB_ENV"
 
       - name: Update LICENSE
-        uses: jacobtomlinson/gha-find-replace@v2
+        uses: jacobtomlinson/gha-find-replace@v3
         with:
           find: ${{ env.PREVIOUS }}
           replace: ${{ env.CURRENT }}
@@ -38,7 +38,7 @@ jobs:
           git commit -m "Updated License Year" -a
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           title: Update License Year

CHANGES.txt

@@ -1,3 +1,14 @@
+4.11.1 (Feb 29, 2024)
+- Fixed deadlock in UniqueKeysTracker when sending Unique Keys.
+
+4.11.0 (Jan 9, 2024)
+- Added impressionsListener method in the IntegrationConfig builder to set Sync or Async Listener execution.
+- Fixed localhost to read files with yml ending.
+
+4.10.2 (Dec 1, 2023)
+- Added getTreatmentsByFlagSets without attributes.
+- Fixed some issues for flag sets: Not logging a warning when using flag sets that don't contain cached feature flags.
+
 4.10.1 (Nov 8, 2023)
 - Fixed handler for response http headers.
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2023 Split Software, Inc.
+Copyright © 2024 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

client/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.split.client</groupId>
         <artifactId>java-client-parent</artifactId>
-        <version>4.10.1</version>
+        <version>4.11.1</version>
     </parent>
     <artifactId>java-client</artifactId>
     <packaging>jar</packaging>

client/src/main/java/io/split/client/SplitClient.java

@@ -256,7 +256,7 @@ public interface SplitClient {
     Map<String, SplitResult> getTreatmentsWithConfig(String key, List<String> featureFlagNames, Map<String, Object> attributes);
 
     /**
-     * Same as {@link #getTreatments(Key, List<String>, Map)} but it returns for each feature flag the configuration associated to the
+     * 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.
      *
      * @param key the matching and bucketing keys. MUST NOT be null.
@@ -268,6 +268,21 @@ public interface SplitClient {
      */
     Map<String, SplitResult> getTreatmentsWithConfig(Key key, List<String> featureFlagNames, Map<String, Object> attributes);
 
+    /**
+     * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
+     * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+     * <p/>
+     * <p/>
+     * 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.
+     * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+     */
+    Map<String, String> getTreatmentsByFlagSet(String key, String flagSet);
+
     /**
      * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
      * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
@@ -300,6 +315,21 @@ public interface SplitClient {
      */
     Map<String, String> getTreatmentsByFlagSet(Key key, String flagSet, Map<String, Object> attributes);
 
+    /**
+     * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
+     * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+     * <p/>
+     * <p/>
+     * 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.
+     * @return for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.
+     */
+    Map<String, String> getTreatmentsByFlagSets(String key, List<String> flagSets);
+
     /**
      * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
      * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
@@ -332,6 +362,22 @@ public interface SplitClient {
      */
     Map<String, String> getTreatmentsByFlagSets(Key key, List<String> flagSets, Map<String, Object> attributes);
 
+    /**
+     * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
+     * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+     * <p/>
+     * <p/>
+     * 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.
+     * @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<String, SplitResult> getTreatmentsWithConfigByFlagSet(String key, String flagSet);
+
     /**
      * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
      * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
@@ -366,6 +412,22 @@ public interface SplitClient {
      */
     Map<String, SplitResult> getTreatmentsWithConfigByFlagSet(Key key, String flagSet, Map<String, Object> attributes);
 
+    /**
+     * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
+     * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
+     * <p/>
+     * <p/>
+     * 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.
+     * @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<String, SplitResult> getTreatmentsWithConfigByFlagSets(String key, List<String> flagSets);
+
     /**
      * Same as {@link #getTreatments(String, List<String>, Map)} but it returns for each feature flag the configuration associated to the
      * matching treatment if any. Otherwise {@link SplitResult.configurations()} will be null.
@@ -444,7 +506,6 @@ public interface SplitClient {
      * @param key the identifier of the entity
      * @param trafficType the type of the event
      * @param eventType the type of the event
-     * @param value the value of the event
      *
      * @return true if the track was successful, false otherwise
      */

client/src/main/java/io/split/client/SplitClientImpl.java

@@ -48,6 +48,7 @@ public final class SplitClientImpl implements SplitClient {
     public static final SplitResult SPLIT_RESULT_CONTROL = new SplitResult(Treatments.CONTROL, null);
     private static final String CLIENT_DESTROY = "Client has already been destroyed - no calls possible";
     private static final String CATCHALL_EXCEPTION = "CatchAll Exception";
+    private static final String MATCHING_KEY = "matchingKey";
 
     private static final Logger _log = LoggerFactory.getLogger(SplitClientImpl.class);
 
@@ -150,6 +151,13 @@ public Map<String, SplitResult> getTreatmentsWithConfig(Key key, List<String> fe
                 MethodEnum.TREATMENTS_WITH_CONFIG);
     }
 
+    @Override
+    public Map<String, String> getTreatmentsByFlagSet(String key, String flagSet) {
+        return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+                null, MethodEnum.TREATMENTS_BY_FLAG_SET).entrySet().stream()
+                .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+    }
+
     @Override
     public Map<String, String> getTreatmentsByFlagSet(String key, String flagSet, Map<String, Object> attributes) {
         return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
@@ -164,6 +172,13 @@ public Map<String, String> getTreatmentsByFlagSet(Key key, String flagSet, Map<S
                 .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
     }
 
+    @Override
+    public Map<String, String> getTreatmentsByFlagSets(String key, List<String> flagSets) {
+        return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+                null, MethodEnum.TREATMENTS_BY_FLAG_SETS).entrySet().stream()
+                .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
+    }
+
     @Override
     public Map<String, String> getTreatmentsByFlagSets(String key, List<String> flagSets, Map<String, Object> attributes) {
         return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
@@ -178,6 +193,12 @@ public Map<String, String> getTreatmentsByFlagSets(Key key, List<String> flagSet
                 .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().treatment()));
     }
 
+    @Override
+    public Map<String, SplitResult> getTreatmentsWithConfigByFlagSet(String key, String flagSet) {
+        return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
+                null, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
+    }
+
     @Override
     public Map<String, SplitResult> getTreatmentsWithConfigByFlagSet(String key, String flagSet, Map<String, Object> attributes) {
         return getTreatmentsBySetsWithConfigInternal(key, null, new ArrayList<>(Arrays.asList(flagSet)),
@@ -190,6 +211,12 @@ public Map<String, SplitResult> getTreatmentsWithConfigByFlagSet(Key key, String
                 attributes, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
     }
 
+    @Override
+    public Map<String, SplitResult> getTreatmentsWithConfigByFlagSets(String key, List<String> flagSets) {
+        return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
+                null, MethodEnum.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
+    }
+
     @Override
     public Map<String, SplitResult> getTreatmentsWithConfigByFlagSets(String key, List<String> flagSets, Map<String, Object> attributes) {
         return getTreatmentsBySetsWithConfigInternal(key, null, flagSets,
@@ -295,7 +322,7 @@ private SplitResult getTreatmentWithConfigInternal(String matchingKey, String bu
                 return SPLIT_RESULT_CONTROL;
             }
 
-            if (!KeyValidator.isValid(matchingKey, "matchingKey", _config.maxStringLength(), methodEnum.getMethod())) {
+            if (!KeyValidator.isValid(matchingKey, MATCHING_KEY, _config.maxStringLength(), methodEnum.getMethod())) {
                 return SPLIT_RESULT_CONTROL;
             }
 
@@ -381,14 +408,14 @@ private Map<String, SplitResult> getTreatmentsBySetsWithConfigInternal(String ma
             return new HashMap<>();
         }
         Set cleanFlagSets = cleanup(sets);
-        if (filterSetsAreInConfig(cleanFlagSets, methodEnum).isEmpty()) {
+        cleanFlagSets = filterSetsAreInConfig(cleanFlagSets, methodEnum);
+        if (cleanFlagSets.isEmpty()) {
             return new HashMap<>();
         }
         List<String> featureFlagNames = new ArrayList<>();
         try {
             checkSDKReady(methodEnum);
-            featureFlagNames = getAllFlags(cleanFlagSets);
-            Map<String, SplitResult> result = validateBeforeEvaluate(featureFlagNames, matchingKey, methodEnum,bucketingKey);
+            Map<String, SplitResult> result = validateBeforeEvaluateByFlagSets(matchingKey, methodEnum,bucketingKey);
             if(result != null) {
                 return result;
             }
@@ -405,7 +432,6 @@ private Map<String, SplitResult> getTreatmentsBySetsWithConfigInternal(String ma
             return createMapControl(featureFlagNames);
         }
     }
-
     private Map<String, SplitResult> processEvaluatorResult(Map<String, EvaluatorImp.TreatmentLabelAndChangeNumber> evaluatorResult,
                                                             MethodEnum methodEnum, String matchingKey, String bucketingKey, Map<String,
                                                             Object> attributes, long initTime){
@@ -430,13 +456,28 @@ private Map<String, SplitResult> processEvaluatorResult(Map<String, EvaluatorImp
         return result;
     }
 
+    private Map<String, SplitResult> validateBeforeEvaluateByFlagSets(String matchingKey, MethodEnum methodEnum,
+                                                            String bucketingKey) {
+        if (_container.isDestroyed()) {
+            _log.error(CLIENT_DESTROY);
+            return new HashMap<>();
+        }
+        if (!KeyValidator.isValid(matchingKey, MATCHING_KEY, _config.maxStringLength(), methodEnum.getMethod())) {
+            return new HashMap<>();
+        }
+        if (!KeyValidator.bucketingKeyIsValid(bucketingKey, _config.maxStringLength(), methodEnum.getMethod())) {
+            return new HashMap<>();
+        }
+        return null;
+    }
+
     private Map<String, SplitResult> validateBeforeEvaluate(List<String> featureFlagNames, String matchingKey, MethodEnum methodEnum,
                                                             String bucketingKey) {
         if (_container.isDestroyed()) {
             _log.error(CLIENT_DESTROY);
             return createMapControl(featureFlagNames);
         }
-        if (!KeyValidator.isValid(matchingKey, "matchingKey", _config.maxStringLength(), methodEnum.getMethod())) {
+        if (!KeyValidator.isValid(matchingKey, MATCHING_KEY, _config.maxStringLength(), methodEnum.getMethod())) {
             return createMapControl(featureFlagNames);
         }
         if (!KeyValidator.bucketingKeyIsValid(bucketingKey, _config.maxStringLength(), methodEnum.getMethod())) {
@@ -447,8 +488,8 @@ private Map<String, SplitResult> validateBeforeEvaluate(List<String> featureFlag
         }
         return null;
     }
-    private List<String> filterSetsAreInConfig(Set<String> sets, MethodEnum methodEnum) {
-        List<String> setsToReturn = new ArrayList<>();
+    private Set<String> filterSetsAreInConfig(Set<String> sets, MethodEnum methodEnum) {
+        Set<String> setsToReturn = new HashSet<>();
         for (String set : sets) {
             if (!_flagSetsFilter.intersect(set)) {
                 _log.warn(String.format("%s: you passed %s which is not part of the configured FlagSetsFilter, " +
@@ -459,16 +500,6 @@ private List<String> filterSetsAreInConfig(Set<String> sets, MethodEnum methodEn
         }
         return setsToReturn;
     }
-
-    private List<String> getAllFlags(Set<String> sets) {
-        Map<String, HashSet<String>> namesBySets = _splitCacheConsumer.getNamesByFlagSets(new ArrayList<>(sets));
-        HashSet<String> flags = new HashSet<>();
-        for (String set: namesBySets.keySet()) {
-            flags.addAll(namesBySets.get(set));
-        }
-        return new ArrayList<>(flags);
-    }
-
     private void recordStats(String matchingKey, String bucketingKey, String featureFlagName, long start, String result,
                              String operation, String label, Long changeNumber, Map<String, Object> attributes) {
         try {

client/src/main/java/io/split/client/SplitFactoryImpl.java

@@ -674,6 +674,7 @@ private SplitChangeFetcher createSplitChangeFetcher(SplitClientConfig splitClien
                 case JSON:
                     return new JsonLocalhostSplitChangeFetcher(inputStreamProvider);
                 case YAML:
+                case YML:
                     return new YamlLocalhostSplitChangeFetcher(inputStreamProvider);
                 default:
                     _log.warn(LEGACY_LOG_MESSAGE);