[4.0.0] Development into master

client/CHANGES.txt

@@ -1,5 +1,12 @@
 CHANGES
 
+4.0.0 (Aug 19, 2020)
+- Added support for the new Split streaming architecture. When enabled (default), the SDK will not poll for updates but instead receive notifications every time there's a change in your environments, allowing to process those much quicker. If disabled or in the event of an issue, the SDK will fallback to the known polling mechanism to provide a seamless experience.
+- Updated the default of featuresRefreshRate to 60 seconds.
+
+3.3.4 (Jul 15, 2020)
+- Added Impression observer.
+
 3.3.3 (Apr 7, 2020)
  - Fix issue regarding special characters come from split/segments fetchers.
 

client/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.split.client</groupId>
         <artifactId>java-client-parent</artifactId>
-        <version>3.3.4</version>
+        <version>4.0.0</version>
     </parent>
     <artifactId>java-client</artifactId>
     <packaging>jar</packaging>
@@ -19,15 +19,15 @@
                 <version>3.3</version>
                 <inherited>false</inherited>
                 <configuration>
-                    <source>1.7</source>
-                    <target>1.7</target>
+                    <source>8</source>
+                    <target>8</target>
                 </configuration>
             </plugin>
             <!-- Shade dependencies to avoid conflicts with other customer's libs -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>2.4.3</version>
+                <version>3.2.4</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -47,9 +47,18 @@
                                     <include>org.apache.httpcomponents:httpcore</include>
                                     <include>com.google.code.gson:gson</include>
                                     <include>com.google.guava:guava</include>
-                                    <include>org.yaml.snakeyaml</include>
+                                    <include>org.yaml.snakeyaml.*</include>
+                                    <include>org.glassfish.*</include>
+                                    <include>jakarta.*</include>
+                                    <include>org.javassist:javassist</include>
+                                    <include>com.sun.activation:jakarta.activation</include>
+                                    <include>org.jvnet.*</include>
                                 </includes>
                             </artifactSet>
+                            <transformers>
+                            <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer" />
+                            <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
+                            </transformers>
                             <relocations>
                                 <relocation>
                                     <pattern>org.apache.http</pattern>
@@ -59,6 +68,26 @@
                                     <pattern>com.google</pattern>
                                     <shadedPattern>split.com.google</shadedPattern>
                                 </relocation>
+                                <relocation>
+                                    <pattern>org.glassfish</pattern>
+                                    <shadedPattern>split.org.glassfish</shadedPattern>
+                                </relocation>
+                                <relocation>
+                                    <pattern>jakarta</pattern>
+                                    <shadedPattern>split.jakarta</shadedPattern>
+                                </relocation>
+                                <relocation>
+                                    <pattern>org.javassist</pattern>
+                                    <shadedPattern>split.org.javassist</shadedPattern>
+                                </relocation>
+                                <relocation>
+                                    <pattern>com.sun.activation</pattern>
+                                    <shadedPattern>split.com.sun.activation</shadedPattern>
+                                </relocation>
+                                <relocation>
+                                    <pattern>org.jvnet</pattern>
+                                    <shadedPattern>split.org.jvnet</shadedPattern>
+                                </relocation>
                             </relocations>
                             <filters>
                                 <filter>
@@ -67,7 +96,9 @@
                                         <exclude>META-INF/license/**</exclude>
                                         <exclude>META-INF/*</exclude>
                                         <exclude>META-INF/maven/**</exclude>
-                                        <exclude>META-INF/services/**</exclude>
+                                        <!-- Disabled to allow Jersey implementation mappings/injector to work
+                                           <exclude>META-INF/services/**</exclude>
+                                        -->
                                         <exclude>LICENSE</exclude>
                                         <exclude>NOTICE</exclude>
                                         <exclude>/*.txt</exclude>
@@ -139,6 +170,17 @@
             <artifactId>snakeyaml</artifactId>
             <version>1.21</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.media</groupId>
+            <artifactId>jersey-media-sse</artifactId>
+            <version>2.31</version>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.inject</groupId>
+            <artifactId>jersey-hk2</artifactId>
+            <version>2.31</version>
+        </dependency>
+
         <!-- Test deps -->
         <dependency>
             <groupId>org.apache.commons</groupId>
@@ -169,5 +211,23 @@
             <version>1.7.21</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.containers</groupId>
+            <artifactId>jersey-container-grizzly2-http</artifactId>
+            <version>2.26</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>mockwebserver</artifactId>
+            <version>4.8.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.0.3</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

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

@@ -39,6 +39,11 @@ public class SplitClientConfig {
     private final boolean _destroyOnShutDown;
     private final String _splitFile;
     private final IntegrationsConfig _integrationsConfig;
+    private final boolean _streamingEnabled;
+    private final int _authRetryBackoffBase;
+    private final int _streamingReconnectBackoffBase;
+    private final String _authServiceURL;
+    private final String _streamingServiceURL;
 
     // Proxy configs
     private final HttpHost _proxy;
@@ -76,7 +81,12 @@ private SplitClientConfig(String endpoint,
                               int maxStringLength,
                               boolean destroyOnShutDown,
                               String splitFile,
-                              IntegrationsConfig integrationsConfig) {
+                              IntegrationsConfig integrationsConfig,
+                              boolean streamingEnabled,
+                              int authRetryBackoffBase,
+                              int streamingReconnectBackoffBase,
+                              String authServiceURL,
+                              String streamingServiceURL) {
         _endpoint = endpoint;
         _eventsEndpoint = eventsEndpoint;
         _featuresRefreshRate = pollForFeatureChangesEveryNSeconds;
@@ -101,6 +111,11 @@ private SplitClientConfig(String endpoint,
         _destroyOnShutDown = destroyOnShutDown;
         _splitFile = splitFile;
         _integrationsConfig = integrationsConfig;
+        _streamingEnabled = streamingEnabled;
+        _authRetryBackoffBase = authRetryBackoffBase;
+        _streamingReconnectBackoffBase = streamingReconnectBackoffBase;
+        _authServiceURL = authServiceURL;
+        _streamingServiceURL = streamingServiceURL;
 
         Properties props = new Properties();
         try {
@@ -207,13 +222,33 @@ public IntegrationsConfig integrationsConfig() {
         return _integrationsConfig;
     }
 
+    public boolean streamingEnabled() {
+        return _streamingEnabled;
+    }
+
+    public int authRetryBackoffBase() {
+        return _authRetryBackoffBase;
+    }
+
+    public int streamingReconnectBackoffBase() {
+        return _streamingReconnectBackoffBase;
+    }
+
+    public String authServiceURL() {
+        return _authServiceURL;
+    }
+
+    public String streamingServiceURL() {
+        return _streamingServiceURL;
+    }
+
     public static final class Builder {
 
         private String _endpoint = "https://sdk.split.io";
         private boolean _endpointSet = false;
         private String _eventsEndpoint = "https://events.split.io";
         private boolean _eventsEndpointSet = false;
-        private int _featuresRefreshRate = 5;
+        private int _featuresRefreshRate = 60;
         private int _segmentsRefreshRate = 60;
         private int _impressionsRefreshRate = 30;
         private int _impressionsQueueSize = 30000;
@@ -236,6 +271,11 @@ public static final class Builder {
         private boolean _destroyOnShutDown = true;
         private String _splitFile = null;
         private IntegrationsConfig _integrationsConfig = null;
+        private boolean _streamingEnabled = true;
+        private int _authRetryBackoffBase = 1;
+        private int _streamingReconnectBackoffBase = 1;
+        private String _authServiceURL = "https://auth.split.io/api/auth";
+        private String _streamingServiceURL = "https://streaming.split.io/event-stream";
 
         public Builder() {
         }
@@ -572,6 +612,55 @@ public Builder integrations(IntegrationsConfig config) {
             return this;
         }
 
+        /**
+         * Set if streaming is enabled or not. Default is true.
+         * @param streamingEnabled
+         * @return
+         */
+        public Builder streamingEnabled(boolean streamingEnabled) {
+            _streamingEnabled = streamingEnabled;
+            return this;
+        }
+
+        /**
+         * Set how many seconds to wait before re attempting to authenticate for push notifications. Default 1 second. Minimum 1 second.
+         * @param authRetryBackoffBase
+         * @return
+         */
+        public Builder authRetryBackoffBase(int authRetryBackoffBase) {
+            _authRetryBackoffBase = authRetryBackoffBase;
+            return this;
+        }
+
+        /**
+         * Set how many seconds to wait before re attempting to connect to streaming. Default 1 second. Minimum 1 second.
+         * @param streamingReconnectBackoffBase
+         * @return
+         */
+        public Builder streamingReconnectBackoffBase(int streamingReconnectBackoffBase) {
+            _streamingReconnectBackoffBase = streamingReconnectBackoffBase;
+            return this;
+        }
+
+        /**
+         * Set Authentication service URL.
+         * @param authServiceURL
+         * @return
+         */
+        public Builder authServiceURL(String authServiceURL) {
+            _authServiceURL = authServiceURL;
+            return this;
+        }
+
+        /**
+         * Set Streaming service URL.
+         * @param streamingServiceURL
+         * @return
+         */
+        public Builder streamingServiceURL(String streamingServiceURL) {
+            _streamingServiceURL = streamingServiceURL;
+            return this;
+        }
 
         public SplitClientConfig build() {
             if (_featuresRefreshRate < 5 ) {
@@ -622,6 +711,22 @@ public SplitClientConfig build() {
                 throw new IllegalArgumentException("Number of threads for fetching segments MUST be greater than zero");
             }
 
+            if (_authRetryBackoffBase <= 0) {
+                throw new IllegalArgumentException("authRetryBackoffBase: must be >= 1");
+            }
+
+            if (_streamingReconnectBackoffBase <= 0) {
+                throw new IllegalArgumentException("streamingReconnectBackoffBase: must be >= 1");
+            }
+
+            if (_authServiceURL == null) {
+                throw new IllegalArgumentException("authServiceURL must not be null");
+            }
+
+            if (_streamingServiceURL == null) {
+                throw new IllegalArgumentException("streamingServiceURL must not be null");
+            }
+
             return new SplitClientConfig(
                     _endpoint,
                     _eventsEndpoint,
@@ -646,10 +751,12 @@ public SplitClientConfig build() {
                     _maxStringLength,
                     _destroyOnShutDown,
                     _splitFile,
-                    _integrationsConfig);
+                    _integrationsConfig,
+                    _streamingEnabled,
+                    _authRetryBackoffBase,
+                    _streamingReconnectBackoffBase,
+                    _authServiceURL,
+                    _streamingServiceURL);
         }
-
     }
-
-
 }

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

@@ -12,6 +12,8 @@
 import io.split.client.metrics.FireAndForgetMetrics;
 import io.split.client.metrics.HttpMetrics;
 import io.split.engine.SDKReadinessGates;
+import io.split.engine.common.SyncManager;
+import io.split.engine.common.SyncManagerImp;
 import io.split.engine.experiments.RefreshableSplitFetcherProvider;
 import io.split.engine.experiments.SplitChangeFetcher;
 import io.split.engine.experiments.SplitParser;
@@ -209,6 +211,10 @@ public SplitFactoryImpl(String apiToken, SplitClientConfig config) throws URISyn
 
         final EventClient eventClient = EventClientImpl.create(httpclient, eventsRootTarget, config.eventsQueueSize(), config.eventFlushIntervalInMillis(), config.waitBeforeShutdown());
 
+        // SyncManager
+        final SyncManager syncManager = SyncManagerImp.build(config.streamingEnabled(), splitFetcherProvider, segmentFetcher, config.authServiceURL(), httpclient, config.streamingServiceURL(), config.authRetryBackoffBase());
+        syncManager.start();
+
         destroyer = new Runnable() {
             public void run() {
                 _log.info("Shutdown called for split");
@@ -227,6 +233,8 @@ public void run() {
                     _log.info("Successful shutdown of httpclient");
                     eventClient.close();
                     _log.info("Successful shutdown of httpclient");
+                    new Thread(syncManager::shutdown).start();
+                    _log.info("Successful shutdown of syncManager");
                 } catch (IOException e) {
                     _log.error("We could not shutdown split", e);
                 }

client/src/main/java/io/split/engine/common/Backoff.java

@@ -0,0 +1,27 @@
+package io.split.engine.common;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+public class Backoff {
+    private static final long BACKOFF_MAX_SECONDS_ALLOWED = 1800;
+
+    private final long _backoffBase;
+    private AtomicInteger _attempt;
+
+    public Backoff(long backoffBase) {
+        _backoffBase = checkNotNull(backoffBase);
+        _attempt = new AtomicInteger(0);
+    }
+
+    public long interval() {
+        long interval = _backoffBase * (long) Math.pow(2, _attempt.getAndIncrement());
+
+        return interval >= BACKOFF_MAX_SECONDS_ALLOWED ? BACKOFF_MAX_SECONDS_ALLOWED : interval;
+    }
+
+    public synchronized void reset() {
+        _attempt.set(0);
+    }
+}

client/src/main/java/io/split/engine/common/PushManager.java

@@ -0,0 +1,16 @@
+package io.split.engine.common;
+
+public interface PushManager {
+
+    enum Status {
+        STREAMING_READY,
+        STREAMING_BACKOFF,
+        STREAMING_DOWN,
+        STREAMING_OFF
+    }
+
+    void start();
+    void stop();
+    void startWorkers();
+    void stopWorkers();
+}