Merge pull request #111 from splitio/feature/disableIpAddress

Feature/disable ip address

Author: mredolatti

CONTRIBUTORS-GUIDE.md

@@ -0,0 +1,28 @@
+# Contributing to the Split Java SDK
+
+Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
+
+## Development
+
+### Development process
+
+1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
+2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
+3. Make sure to add tests for both positive and negative cases.
+4. Run the build script and make sure it runs with no errors.
+5. Run all tests and make sure there are no failures.
+6. `git push` your changes to GitHub within your topic branch.
+7. Open a Pull Request(PR) from your forked repo and into the `development` branch of the original repository.
+8. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
+9. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `development`.
+10. Keep an eye out for any feedback or comments from Split's SDK team.
+
+### Building the SDK
+- `mvn clean build`
+
+### Running tests
+- `mvn clean install`
+
+# Contact
+
+If you have any other questions or need to contact us directly in a private manner send us a note at sdks@split.io

Detailed-README.md

@@ -1,42 +1,79 @@
 # Split Java SDK
 
-This SDK is designed to work with [Split](https://www.split.io), the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
-
-### Quick setup
-
-For specific instructions on how to set up the Split SDK refer to our [Detailed-README](Detailed-README.md) or our [official SDK documentation](http://docs.split.io/docs/sdk-overview).
-
-### Commitment to Quality:
-
-Split’s SDKs are in active development and are constantly tested for quality. Unit tests are developed for each SDK based on the unique needs of that language, and integration tests, load and performance tests, and behavior consistency tests are running 24/7 via automated bots. In addition, monitoring instrumentation ensures that these SDKs behave under the expected parameters of memory, CPU, and I/O.
-
-### About Split:
-
-Split is the leading platform for feature experimentation, empowering businesses of all sizes to make smarter product decisions. Companies like Vevo, Twilio, and LendingTree rely on Split to securely release new features, target them to customers, and measure the impact of features on their customer experience metrics. Founded in 2015, Split's team comes from some of the most innovative enterprises in Silicon Valley, including Google, LinkedIn, Salesforce and Databricks. Split is based in Redwood City, California and backed by Accel Partners and Lightspeed Venture Partners.
-
-Our platform is a unified solution for continuous delivery and full-stack experimentation. Split unifies DevOps and product management, helping agile engineering and product teams accelerate the pace of product delivery and make data-driven decisions, through our robust feature flagging and extensive experimentation capabilities. With Split, organizations can now accelerate time to value, mitigate risk, and drive better outcomes, all in a unified platform.
-
-To learn more about Split, contact hello@split.io, or start a 14-day trial at https://www.split.io/signup/.
-
-Split has built and maintains a SDKs for:
-
-* Java [Github](https://github.com/splitio/java-client) [Docs](http://docs.split.io/docs/java-sdk-guide)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](http://docs.split.io/docs/javascript-sdk-overview)
-* Node [Github](https://github.com/splitio/javascript-client) [Docs](http://docs.split.io/docs/nodejs-sdk-overview)
-* .NET [Github](https://github.com/splitio/.net-client) [Docs](http://docs.split.io/docs/net-sdk-overview)
-* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](http://docs.split.io/docs/ruby-sdk-overview)
-* PHP [Github](https://github.com/splitio/php-client) [Docs](http://docs.split.io/docs/php-sdk-overview)
-* Python [Github](https://github.com/splitio/python-client) [Docs](http://docs.split.io/docs/python-sdk-overview)
-* GO [Github](https://github.com/splitio/go-client) [Docs](http://docs.split.io/docs/go-sdk-overview)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/docs/android-sdk-overview)
-* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/docs/ios-sdk-overview)
-
-For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
-
-**Learn more about Split:** 
-
-Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [docs.split.io](http://docs.split.io) for more detailed information.
-
-**System Status:**
-
-We use a status page to monitor the availability of Split’s various services. You can check the current status at [status.split.io](http://status.split.io).
+[![Build Status](https://api.travis-ci.com/splitio/java-client.svg?branch=master)](https://api.travis-ci.com/splitio/java-client)
+
+## 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.
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
+
+## Compatibility
+This SDK is compatible with Java 6 and higher.
+
+## Getting started
+Below is a simple example that describes the instantiation and most basic usage of our SDK:
+
+```java
+import io.split.client.SplitFactoryBuilder;
+import io.split.client.SplitClient;
+
+public  class App {
+
+    public static void main() {
+        SplitClientConfig config = SplitClientConfig.builder()
+                .setBlockUntilReadyTimeout(10000)
+                .build();
+        SplitFactory splitFactory = SplitFactoryBuilder.build("SDK_API_KEY", config);
+        SplitClient client = splitFactory.client();
+        try {
+            client.blockUntilReady();
+        } catch (TimeoutException | InterruptedException e) {
+            // log & handle 
+        }
+
+        String treatment = client.getTreatment("CUSTOMER_ID", "SPLIT_NAME");
+        if (treatment.equals("on")) {
+            // Feature is enabled for this user!
+        } else if (treatment.equals("off")) {
+            // Feature is disabled for this user!
+        } else {
+            // Unable to perform evaluation.
+        }
+    }
+}
+```
+
+## Submitting issues
+ 
+The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/java-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
+
+## Contributing
+Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
+
+## License
+Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
+
+## About Split
+ 
+Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
+ 
+To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
+ 
+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)
+* 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/.net-core-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)
+* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
+* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
+* 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)
+ 
+For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
+ 
+**Learn more about Split:**
+ 
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.

README.md

@@ -1,38 +1,40 @@
 CHANGES
+3.3.1 (Nov 1, 2019)
+ - Allow client to disable sending the IP address & hostname.
 
-3.3.0 (Sept 23rd, 2019)
+3.3.0 (Sep 23, 2019)
 - rename version.properties to splitversion.properties to avoid conflicts with other tools that use the former file name and causes this SDK to not properly report the version
 - Adds New Relic Integration. Now if the New Relic agent is running, it will attach Impression data to the current transaction in New Relic,
 
-3.2.4
+3.2.4 (Sep 9, 2019)
 - Fix small issue regarding traffic type validation on .track() calls.
 
-3.2.3
+3.2.3 (Aug 1, 2019)
 - allow to push impressions more often than one every 30 seconds and events flush rate is now customizable
 
-3.2.2
+3.2.2 
 - log warn and not error when Split doesn't exist in the environment
 
-3.2.1
+3.2.1 (May 29, 2019)
 - Fix issue with events not forwarding the value when sending properties as well.
 
-3.2.0
+3.2.0 (May 24, 2019)
 - Add ability to send events with properties
 
-3.1.1
+3.1.1 (May 2, 2019)
 - Fix issue with locating localhost mode in windows
 - Fix issue when user falls out of traffic allocation and has config data
 
-3.1.0
+3.1.0 (Apr 16, 2019)
 - Add Dynamic Configurations
 - Support Yaml files for localhost mode
 
-3.0.9
+3.0.9 (Mar 21, 2019)
 - Validate split names on getTreatment and manager calls
 - Validate traffic type name when calling track
 - Check for multiple factories instantiated
 
-3.0.8
+3.0.8 (Mar 7, 2019)
 - Ability to disable automatic destroy() on graceful shutdowns.
 
 3.0.7
@@ -42,40 +44,40 @@ CHANGES
 3.0.6
 - Setting CookieSpec to Standard
 
-3.0.5
+3.0.5 (Jan 5, 2019)
 - Adding input validation for fast feedback of incorrect use of the client.
 
-3.0.4
+3.0.4 (Dec 14, 2018)
 - Fix potential race condition when segment wait for readiness before they are registered to the readiness gates
 
-3.0.3
+3.0.3 (Dec 12, 2018)
 - Expose param to increase thread pool size for segments
 
-3.0.2
+3.0.2 (Dec 12, 2018)
 - Fixed traffic allocation issue on 1%
 
-3.0.1
+3.0.1 
 - Fix Metric Counters when using Split Proxy.
 
 3.0.0
 - Moving block until ready out of the factory into the split client and manager client
 
-2.3.2
+2.3.2 (Jul 18, 2018)
 - Add support for handling different relative path in the endpoints of the Split Synchronizer
 
-2.3.1
+2.3.1 (Apr 18, 2018)
 - Added support for key overrides in localhost mode
 
-2.3.0
+2.3.0 (Jan 15, 2018)
 - Add support for .track()
 
-2.2.2
+2.2.2 (Dec 22, 2017)
 - Patch for localhost mode to daemonize the thread which currently prevents the JVM from exiting.
 
-2.2.1
+2.2.1 (Dec 22, 2017)
 - Transitioning from "no rule matched" to "default rule" and from "rules not found" to "definition not found"
 
-2.2.0
+2.2.0 (Sep 22, 2017)
 - Patch DependencyMatcherData to not error out when dependencies are used
 - Default logging is less verbose now
 - Add support for Proxy
@@ -96,30 +98,30 @@ CHANGES
 2.0.1 (May 3rd, 2017)
 - Fix issue for Java 7 and compatibility with TLS1.2
 
-2.0
+2.0 (Apr 26, 2017)
 - Transitioning to Murmur3 for key hashing
 - Hashing Algorithm dependent on Split algo field
 
-1.1.7
+1.1.7 (Mar 31, 2017)
 - We can now specify a percentage of traffic that can be in the Split - i.e. traffic allocation.
 - You can now register your own ImpressionListener. SplitClientConfig#impressionListener.
 - You can no longer set any refresh rates to be less than 30 seconds.
 
-1.1.6
+1.1.6 (Feb 27, 2017)
 - Allowing users to set the Off-The-Grid directory
 - Adding Live Reload of Split File in Off-The-Grid mode
 
-1.1.5
+1.1.5 (Feb 8, 2017)
 - Introducing SplitClientForTest and SplitTestRunner for JUnit. More information at split.io/blog/feature-flag-testing
 
-1.1.4
+1.1.4 (Feb 8, 2017)
 - Use less guava.
 
-1.1.3
+1.1.3 (Jan 9, 2017)
 - Impression to include the changeNumber of the Split that served a getTreatment call.
 - expose disableLabels
 
-1.1.2
+1.1.2 (Dec 19, 2016)
 - Adding SplitManager.splitNames() support to retrieve feature names.
 - Improving Java 1.7 compatibility for Hashcodes
 

client/CHANGES.txt

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

client/pom.xml

@@ -30,6 +30,7 @@ public class SplitClientConfig {
     private final int _numThreadsForSegmentFetch;
     private final boolean _debugEnabled;
     private final boolean _labelsEnabled;
+    private final boolean _ipAddressEnabled;
     private final int _ready;
     private final int _waitBeforeShutdown;
     private final int _eventsQueueSize;
@@ -65,6 +66,7 @@ private SplitClientConfig(String endpoint,
                               int ready,
                               boolean debugEnabled,
                               boolean labelsEnabled,
+                              boolean ipAddressEnabled,
                               int waitBeforeShutdown,
                               HttpHost proxy,
                               String proxyUsername,
@@ -88,6 +90,7 @@ private SplitClientConfig(String endpoint,
         _ready = ready;
         _debugEnabled = debugEnabled;
         _labelsEnabled = labelsEnabled;
+        _ipAddressEnabled = ipAddressEnabled;
         _waitBeforeShutdown = waitBeforeShutdown;
         _proxy = proxy;
         _proxyUsername = proxyUsername;
@@ -158,6 +161,8 @@ public boolean debugEnabled() {
 
     public boolean labelsEnabled() { return _labelsEnabled;}
 
+    public boolean ipAddressEnabled() { return _ipAddressEnabled; }
+
     public int blockUntilReady() {
         return _ready;
     }
@@ -219,6 +224,7 @@ public static final class Builder {
         private int _ready = -1; // -1 means no blocking
         private int _metricsRefreshRate = 60;
         private boolean _labelsEnabled = true;
+        private  boolean _ipAddressEnabled = true;
         private int _waitBeforeShutdown = 5000;
         private String _proxyHost = "localhost";
         private int _proxyPort = -1;
@@ -444,6 +450,10 @@ public Builder disableLabels() {
             return this;
         }
 
+        public Builder disableIPAddress() {
+            _ipAddressEnabled = false;
+            return this;
+        }
 
         /**
          * The SDK kicks off background threads to download data necessary
@@ -626,6 +636,7 @@ public SplitClientConfig build() {
                     _ready,
                     _debugEnabled,
                     _labelsEnabled,
+                    _ipAddressEnabled,
                     _waitBeforeShutdown,
                     proxy(),
                     _proxyUsername,

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

@@ -98,7 +98,7 @@ public SplitFactoryImpl(String apiToken, SplitClientConfig config) throws URISyn
                 .setConnectionManager(cm)
                 .setDefaultRequestConfig(requestConfig)
                 .setSSLSocketFactory(sslsf)
-                .addInterceptorLast(AddSplitHeadersFilter.instance(apiToken))
+                .addInterceptorLast(AddSplitHeadersFilter.instance(apiToken, config.ipAddressEnabled()))
                 .addInterceptorLast(new GzipEncoderRequestInterceptor())
                 .addInterceptorLast(new GzipDecoderResponseInterceptor());