Disco week and Update json localhost to be default treatment control

.github/workflows/ci.yml

@@ -28,6 +28,7 @@ jobs:
         jdk:
           - '8'
           - '11'
+          - '19'
     env:
       ARTIFACTORY_USER: ${{ secrets.ARTIFACTORY_USER }}
       ARTIFACTORY_TOKEN: ${{ secrets.ARTIFACTORY_TOKEN }}

CHANGES.txt

@@ -1,5 +1,9 @@
+4.7.2 (May 16, 2023)
+- Updated default treatment to be control for yaml and json localhost.
+- Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and javadoc comments.
+
 4.7.1 (Apr 10, 2023)
-- Added SHA for split and segment fetcher in localhost json.
+- Added SHA for feature flag and segment fetcher in localhost json.
 - Updated `org.yaml.snakeyaml` dependence to 2.0 for fixing a vulnerability.
 - Fixed Redis integration, changing []dtos.Key to dtos.Key
 - Fixed destroy for consumer mode.
@@ -53,7 +57,7 @@
 
 4.4.0 (Jan 11, 2022)
 - Added support for Redis to keep consistency across multiple SDK instances.
-- Added logic to fetch multiple splits at once on GetTreatments/GetTreatmentsWithChanges.
+- Added logic to fetch multiple feature flags at once on GetTreatments/GetTreatmentsWithChanges.
 
 4.3.0 (Oct 19, 2021)
 - Added support for the SDK to run with a custom implementation of it's internal storage modules, enabling customers to implement this caching in any storage technology of choice and connect it to the SDK instance itself which will use it instead of the in-memory structures.
@@ -67,7 +71,7 @@
 4.2.0 (Jun 7, 2021)
 - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
 - Improved the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
-- Fixed issue where the SDK was validating no Split had over 50 conditions (legacy code).
+- Fixed issue where the SDK was validating no Feature flag had over 50 conditions (legacy code).
 - Bumped guava version to 30.
 
 4.1.6 (Apr 15, 2021)
@@ -80,7 +84,7 @@
 - Updated Internal cache structure refactor.
 - Updated Streaming revamp with several bugfixes and improved log messages.
 - Added Cache-Control header for on-demand requests to sdk-server.
-- Updated Localhost Client revamp & bugfix for missing splits.
+- Updated Localhost Client revamp & bugfix for missing feature flags.
 
 4.1.3 (Dec 2, 2020)
 - Fix Issue when closing SSE Connection
@@ -111,7 +115,7 @@
 - Added Impression observer.
 
 3.3.3 (Apr 7, 2020)
- - Fix issue regarding special characters come from split/segments fetchers.
+ - Fix issue regarding special characters come from feature flags/segments fetchers.
 
 3.3.2 (Jan 24, 2020)
  - Shade com.google.guava as well
@@ -130,7 +134,7 @@
 - allow to push impressions more often than one every 30 seconds and events flush rate is now customizable
 
 3.2.2
-- log warn and not error when Split doesn't exist in the environment
+- log warn and not error when Feature flag doesn't exist in the environment
 
 3.2.1 (May 29, 2019)
 - Fix issue with events not forwarding the value when sending properties as well.
@@ -147,7 +151,7 @@
 - Support Yaml files for localhost mode
 
 3.0.9 (Mar 21, 2019)
-- Validate split names on getTreatment and manager calls
+- Validate feature flag names on getTreatment and manager calls
 - Validate traffic type name when calling track
 - Check for multiple factories instantiated
 
@@ -201,7 +205,7 @@
 
 2.1.0 (July 19th, 2017)
 - Add support for new boolean and regular expression matchers
-- Support for Dependency matcher: 'in split "xxx" treatments ["xxx","yyy"]'
+- Support for Dependency matcher: 'in feature flag "xxx" treatments ["xxx","yyy"]'
 
 2.0.4 (June 2nd, 2017)
 - Support to destroy all clients and background processes before shutdown via splitFactory.destroy() or splitClient.destroy()
@@ -260,7 +264,7 @@
 
 1.0.7
 - Implement Factory pattern and expose Split manager
-- Stop parsing a Split when there are more than 50 conditions to prevent DDOS.
+- Stop parsing a Feature flag when there are more than 50 conditions to prevent DDOS.
 
 1.0.6
 - Replaced Jersey with HttpComponents

README.md

@@ -2,7 +2,7 @@
 ![Build Status](https://github.com/splitio/java-client/actions/workflows/ci-cd.yml/badge.svg?branch=master)
 
 ## Overview
-This SDK is designed to work with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
+This SDK is designed to work with Split, the platform for controlled rollouts, serving features to your users via feature flags to manage your complete customer experience.
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
@@ -22,19 +22,19 @@ public  class App {
         SplitClientConfig config = SplitClientConfig.builder()
                 .setBlockUntilReadyTimeout(10000)
                 .build();
-        SplitFactory splitFactory = SplitFactoryBuilder.build("SDK_API_KEY", config);
+        SplitFactory splitFactory = SplitFactoryBuilder.build("YOUR_SDK_KEY", config);
         SplitClient client = splitFactory.client();
         try {
             client.blockUntilReady();
         } catch (TimeoutException | InterruptedException e) {
             // log & handle
         }
 
-        String treatment = client.getTreatment("CUSTOMER_ID", "SPLIT_NAME");
+        String treatment = client.getTreatment("CUSTOMER_ID", "FEATURE_FLAG_NAME");
         if (treatment.equals("on")) {
-            // Feature is enabled for this user!
+            // Feature flag is enabled for this user!
         } else if (treatment.equals("off")) {
-            // Feature is disabled for this user!
+            // Feature flag is disabled for this user!
         } else {
             // Unable to perform evaluation.
         }
@@ -61,7 +61,8 @@ To learn more about Split, contact hello@split.io, or get started with feature f
 Split has built and maintains SDKs for:
 
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
@@ -70,6 +71,10 @@ Split has built and maintains SDKs for:
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
+* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
 
 For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

client/pom.xml

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

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

@@ -26,45 +26,45 @@ private static class ApyKeyCounterHolder
         private static final ApiKeyCounter INSTANCE = new ApiKeyCounter();
     }
 
-    public void add(String apiKey) {
+    public void add(String sdkKey) {
         String message;
-        if (USED_API_KEYS.contains(apiKey)) {
-            message = String.format("factory instantiation: You already have %s with this API Key. " +
+        if (USED_API_KEYS.contains(sdkKey)) {
+            message = String.format("factory instantiation: You already have %s with this SDK Key. " +
                             "We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing " +
                             "it throughout your application.",
-                    USED_API_KEYS.count(apiKey) == 1 ? "1 factory" : String.format("%s factories", USED_API_KEYS.count(apiKey)));
+                    USED_API_KEYS.count(sdkKey) == 1 ? "1 factory" : String.format("%s factories", USED_API_KEYS.count(sdkKey)));
             _log.warn(message);
         } else if (!USED_API_KEYS.isEmpty()) {
              message = "factory instantiation: You already have an instance of the Split factory. " +
                     "Make sure you definitely want this additional instance. We recommend keeping only one instance of " +
                     "the factory at all times (Singleton pattern) and reusing it throughout your application.“";
             _log.warn(message);
         }
-        USED_API_KEYS.add(apiKey);
+        USED_API_KEYS.add(sdkKey);
     }
 
-    public void remove(String apiKey) {
-        USED_API_KEYS.remove(apiKey);
+    public void remove(String sdkKey) {
+        USED_API_KEYS.remove(sdkKey);
     }
 
     /**
      * Just for test
-     * @param apiKey
+     * @param sdkKey
      * @return
      */
     @VisibleForTesting
-    boolean isApiKeyPresent(String apiKey) {
-        return USED_API_KEYS.contains(apiKey);
+    boolean isApiKeyPresent(String sdkKey) {
+        return USED_API_KEYS.contains(sdkKey);
     }
 
     /**
      * Just for test
-     * @param apiKey
+     * @param sdkKey
      * @return
      */
     @VisibleForTesting
-    int getCount(String apiKey) {
-        return USED_API_KEYS.count(apiKey);
+    int getCount(String sdkKey) {
+        return USED_API_KEYS.count(sdkKey);
     }
 
     public Map<String, Long> getFactoryInstances() {
@@ -79,4 +79,4 @@ public Map<String, Long> getFactoryInstances() {
     public void clearApiKeys() {
         USED_API_KEYS.clear();
     }
-}
+}

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

@@ -99,8 +99,8 @@ public SegmentChange fetch(String segmentName, long since, FetchOptions options)
                 _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SEGMENT_SYNC, statusCode);
                 _log.error(String.format("Response status was: %s. Reason: %s", statusCode , response.getReasonPhrase()));
                 if (statusCode == HttpStatus.SC_FORBIDDEN) {
-                    _log.error("factory instantiation: you passed a browser type api_key, " +
-                            "please grab an api key from the Split console that is of type sdk");
+                    _log.error("factory instantiation: you passed a client side type sdkKey, " +
+                            "please grab an sdk key from the Split user interface that is of type server side");
                 }
                 throw new IllegalStateException(String.format("Could not retrieve segment changes for %s, since %s; http return code %s", segmentName, since, statusCode));
             }

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

@@ -37,8 +37,8 @@ public SplitChange fetch(long since, FetchOptions options) {
             return processSplitChange(splitChange, since);
         } catch (FileNotFoundException f){
             _log.warn(String.format("There was no file named %s found. " +
-                            "We created a split client that returns default treatments for all features for all of your users. " +
-                            "If you wish to return a specific treatment for a feature, enter the name of that feature name and " +
+                            "We created a split client that returns default treatments for all feature flags for all of your users. " +
+                            "If you wish to return a specific treatment for a feature flag, enter the name of that feature flag name and " +
                             "treatment name separated by whitespace in %s; one pair per line. Empty lines or lines starting with '#' are considered comments",
                     _file.getPath(), _file.getPath()), f);
             throw new IllegalStateException("Problem fetching splitChanges: " + f.getMessage(), f);

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

@@ -5,6 +5,7 @@
 import io.split.client.dtos.Split;
 import io.split.client.dtos.SplitChange;
 import io.split.client.dtos.Status;
+import io.split.client.utils.LocalhostConstants;
 import io.split.client.utils.LocalhostSanitizer;
 import io.split.engine.common.FetchOptions;
 import io.split.engine.experiments.SplitChangeFetcher;
@@ -62,9 +63,9 @@ public SplitChange fetch(long since, FetchOptions options) {
                 }
                 split.status = Status.ACTIVE;
                 split.defaultTreatment = featureTreatment[1];
-                split.trafficTypeName = "user";
-                split.trafficAllocation = 100;
-                split.trafficAllocationSeed = 1;
+                split.trafficTypeName = LocalhostConstants.USER;
+                split.trafficAllocation = LocalhostConstants.SIZE_100;
+                split.trafficAllocationSeed = LocalhostConstants.SIZE_1;
 
                 Condition condition;
                 if (featureTreatment.length == 2) {
@@ -84,8 +85,8 @@ public SplitChange fetch(long since, FetchOptions options) {
             return splitChange;
         } catch (FileNotFoundException f) {
             _log.warn("There was no file named " + _splitFile.getPath() + " found. " +
-                    "We created a split client that returns default treatments for all features for all of your users. " +
-                    "If you wish to return a specific treatment for a feature, enter the name of that feature name and " +
+                    "We created a split client that returns default treatments for all feature flags for all of your users. " +
+                    "If you wish to return a specific treatment for a feature flag, enter the name of that feature flag name and " +
                     "treatment name separated by whitespace in " + _splitFile.getPath() +
                     "; one pair per line. Empty lines or lines starting with '#' are considered comments", f);
             throw new IllegalStateException("Problem fetching splitChanges: " + f.getMessage(), f);

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

@@ -76,12 +76,12 @@ public void blockUntilReady() throws TimeoutException, InterruptedException {
     }
 
     @Override
-    public SplitView split(String featureName) {
-        if (!_splitToTreatmentsMap.containsKey(featureName)) {
+    public SplitView split(String featureFlagName) {
+        if (!_splitToTreatmentsMap.containsKey(featureFlagName)) {
             return null;
         }
 
-        return toSplitView(featureName, _splitToTreatmentsMap.get(featureName));
+        return toSplitView(featureFlagName, _splitToTreatmentsMap.get(featureFlagName));
     }
 
     void updateFeatureToTreatmentMap(Map<SplitAndKey, LocalhostSplit> featureToTreatmentMap) {
@@ -91,9 +91,9 @@ void updateFeatureToTreatmentMap(Map<SplitAndKey, LocalhostSplit> featureToTreat
     }
 
 
-    private SplitView toSplitView(String featureName, Set<String> treatments) {
+    private SplitView toSplitView(String featureFlagName, Set<String> treatments) {
         SplitView view = new SplitView();
-        view.name = featureName;
+        view.name = featureFlagName;
         view.killed = false;
         view.trafficType = null;
         view.changeNumber = 0;