Semver release

CHANGES.txt

@@ -1,3 +1,10 @@
+4.12.0 (May 15, 2024)
+- Added support for targeting rules based on semantic versions (https://semver.org/).
+- Added the logic to handle correctly when the SDK receives an unsupported Matcher type.
+- Enhanced SDK Headers for Authorization Frameworks
+- Cleaned unused imports and renaming some methods
+- Fixed empty token handler thanks to @hpark-miovision
+
 4.11.1 (Feb 29, 2024)
 - Fixed deadlock in UniqueKeysTracker when sending Unique Keys.
 
@@ -9,7 +16,7 @@
 - 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 9, 2023)
+4.10.1 (Nov 8, 2023)
 - Fixed handler for response http headers.
 
 4.10.0 (Nov 2, 2023)

client/pom.xml

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

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

@@ -0,0 +1,11 @@
+package io.split;
+
+public final class Spec {
+
+    private Spec() {
+        // restrict instantiation
+    }
+
+    public static final String SPEC_VERSION = "1.1";
+}
+

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

@@ -0,0 +1,15 @@
+package io.split.client;
+
+import io.split.client.dtos.RequestContext;
+
+import java.util.Map;
+import java.util.List;
+
+public interface CustomHeaderDecorator
+{
+    /**
+     * Get the additional headers needed for all http operations
+     * @return HashMap of addition headers
+     */
+    Map<String, List<String>> getHeaderOverrides(RequestContext context);
+}

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

@@ -2,26 +2,23 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import io.split.client.dtos.SegmentChange;
+import io.split.client.dtos.SplitHttpResponse;
 import io.split.client.utils.Json;
 import io.split.client.utils.Utils;
 import io.split.engine.common.FetchOptions;
 import io.split.engine.segments.SegmentChangeFetcher;
+import io.split.service.SplitHttpClient;
 import io.split.telemetry.domain.enums.HTTPLatenciesEnum;
 import io.split.telemetry.domain.enums.LastSynchronizationRecordsEnum;
 import io.split.telemetry.domain.enums.ResourceEnum;
 import io.split.telemetry.storage.TelemetryRuntimeProducer;
-import org.apache.hc.client5.http.classic.methods.HttpGet;
-import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
-import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
 import org.apache.hc.core5.http.HttpStatus;
-import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.apache.hc.core5.net.URIBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.nio.charset.StandardCharsets;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -33,20 +30,17 @@ public final class HttpSegmentChangeFetcher implements SegmentChangeFetcher {
 
     private static final String SINCE = "since";
     private static final String TILL = "till";
-    private static final String PREFIX = "segmentChangeFetcher";
-    private static final String CACHE_CONTROL_HEADER_NAME = "Cache-Control";
-    private static final String CACHE_CONTROL_HEADER_VALUE = "no-cache";
 
-    private final CloseableHttpClient _client;
+    private final SplitHttpClient _client;
     private final URI _target;
     private final TelemetryRuntimeProducer _telemetryRuntimeProducer;
 
-    public static HttpSegmentChangeFetcher create(CloseableHttpClient client, URI root, TelemetryRuntimeProducer telemetryRuntimeProducer)
+    public static HttpSegmentChangeFetcher create(SplitHttpClient client, URI root, TelemetryRuntimeProducer telemetryRuntimeProducer)
             throws URISyntaxException {
         return new HttpSegmentChangeFetcher(client, Utils.appendPath(root, "api/segmentChanges"), telemetryRuntimeProducer);
     }
 
-    private HttpSegmentChangeFetcher(CloseableHttpClient client, URI uri, TelemetryRuntimeProducer telemetryRuntimeProducer) {
+    private HttpSegmentChangeFetcher(SplitHttpClient client, URI uri, TelemetryRuntimeProducer telemetryRuntimeProducer) {
         _client = client;
         _target = uri;
         checkNotNull(_target);
@@ -57,8 +51,6 @@ private HttpSegmentChangeFetcher(CloseableHttpClient client, URI uri, TelemetryR
     public SegmentChange fetch(String segmentName, long since, FetchOptions options) {
         long start = System.currentTimeMillis();
 
-        CloseableHttpResponse response = null;
-
         try {
             String path = _target.getPath() + "/" + segmentName;
             URIBuilder uriBuilder = new URIBuilder(_target)
@@ -69,45 +61,27 @@ public SegmentChange fetch(String segmentName, long since, FetchOptions options)
             }
 
             URI uri = uriBuilder.build();
-            HttpGet request = new HttpGet(uri);
-
-            if(options.cacheControlHeadersEnabled()) {
-                request.setHeader(CACHE_CONTROL_HEADER_NAME, CACHE_CONTROL_HEADER_VALUE);
-            }
-
-            response = _client.execute(request);
-
-            int statusCode = response.getCode();
 
-            if (_log.isDebugEnabled()) {
-                _log.debug(String.format("[%s] %s. Status code: %s", request.getMethod(), uri.toURL(), statusCode));
-            }
+            SplitHttpResponse response = _client.get(uri, options, null);
 
-            if (statusCode < HttpStatus.SC_OK || statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SEGMENT_SYNC, statusCode);
-                _log.error(String.format("Response status was: %s. Reason: %s", statusCode , response.getReasonPhrase()));
-                if (statusCode == HttpStatus.SC_FORBIDDEN) {
+            if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SEGMENT_SYNC, response.statusCode());
+                if (response.statusCode() == HttpStatus.SC_FORBIDDEN) {
                     _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));
+                        segmentName, since, response.statusCode()));
             }
-
             _telemetryRuntimeProducer.recordSuccessfulSync(LastSynchronizationRecordsEnum.SEGMENTS, System.currentTimeMillis());
 
-            String json = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
-
-            return Json.fromJson(json, SegmentChange.class);
+            return Json.fromJson(response.body(), SegmentChange.class);
         } catch (Exception e) {
             throw new IllegalStateException(String.format("Error occurred when trying to sync segment: %s, since: %s. Details: %s",
                     segmentName, since, e), e);
         } finally {
             _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.SEGMENTS, System.currentTimeMillis()-start);
-            Utils.forceClose(response);
         }
-
-
     }
 
     @VisibleForTesting

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

@@ -1,29 +1,28 @@
 package io.split.client;
 
 import com.google.common.annotations.VisibleForTesting;
+
 import io.split.client.dtos.SplitChange;
+import io.split.client.dtos.SplitHttpResponse;
 import io.split.client.exceptions.UriTooLongException;
 import io.split.client.utils.Json;
 import io.split.client.utils.Utils;
 import io.split.engine.common.FetchOptions;
 import io.split.engine.experiments.SplitChangeFetcher;
+import io.split.service.SplitHttpClient;
 import io.split.telemetry.domain.enums.HTTPLatenciesEnum;
 import io.split.telemetry.domain.enums.ResourceEnum;
 import io.split.telemetry.storage.TelemetryRuntimeProducer;
-import org.apache.hc.client5.http.classic.methods.HttpGet;
-import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
-import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
 import org.apache.hc.core5.http.HttpStatus;
-import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.apache.hc.core5.net.URIBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.nio.charset.StandardCharsets;
 
 import static com.google.common.base.Preconditions.checkNotNull;
+import static io.split.Spec.SPEC_VERSION;
 
 /**
  * Created by adilaijaz on 5/30/15.
@@ -34,20 +33,17 @@ public final class HttpSplitChangeFetcher implements SplitChangeFetcher {
     private static final String SINCE = "since";
     private static final String TILL = "till";
     private static final String SETS = "sets";
-
-    private static final String HEADER_CACHE_CONTROL_NAME = "Cache-Control";
-    private static final String HEADER_CACHE_CONTROL_VALUE = "no-cache";
-
-    private final CloseableHttpClient _client;
+    private static final String SPEC = "s";
+    private final SplitHttpClient _client;
     private final URI _target;
     private final TelemetryRuntimeProducer _telemetryRuntimeProducer;
 
-    public static HttpSplitChangeFetcher create(CloseableHttpClient client, URI root, TelemetryRuntimeProducer telemetryRuntimeProducer)
+    public static HttpSplitChangeFetcher create(SplitHttpClient client, URI root, TelemetryRuntimeProducer telemetryRuntimeProducer)
             throws URISyntaxException {
         return new HttpSplitChangeFetcher(client, Utils.appendPath(root, "api/splitChanges"), telemetryRuntimeProducer);
     }
 
-    private HttpSplitChangeFetcher(CloseableHttpClient client, URI uri, TelemetryRuntimeProducer telemetryRuntimeProducer) {
+    private HttpSplitChangeFetcher(SplitHttpClient client, URI uri, TelemetryRuntimeProducer telemetryRuntimeProducer) {
         _client = client;
         _target = uri;
         checkNotNull(_target);
@@ -64,49 +60,34 @@ public SplitChange fetch(long since, FetchOptions options) {
 
         long start = System.currentTimeMillis();
 
-        CloseableHttpResponse response = null;
-
         try {
-            URIBuilder uriBuilder = new URIBuilder(_target).addParameter(SINCE, "" + since);
-            if (options.hasCustomCN()) {
-                uriBuilder.addParameter(TILL, "" + options.targetCN());
-            }
+            URIBuilder uriBuilder = new URIBuilder(_target).addParameter(SPEC, "" + SPEC_VERSION);
+            uriBuilder.addParameter(SINCE, "" + since);
             if (!options.flagSetsFilter().isEmpty()) {
                 uriBuilder.addParameter(SETS, "" + options.flagSetsFilter());
             }
-            URI uri = uriBuilder.build();
-
-            HttpGet request = new HttpGet(uri);
-            if(options.cacheControlHeadersEnabled()) {
-                request.setHeader(HEADER_CACHE_CONTROL_NAME, HEADER_CACHE_CONTROL_VALUE);
-            }
-
-            response = _client.execute(request);
-
-            int statusCode = response.getCode();
-
-            if (_log.isDebugEnabled()) {
-                _log.debug(String.format("[%s] %s. Status code: %s", request.getMethod(), uri.toURL(), statusCode));
+            if (options.hasCustomCN()) {
+                uriBuilder.addParameter(TILL, "" + options.targetCN());
             }
+            URI uri = uriBuilder.build();
+            SplitHttpResponse response = _client.get(uri, options, null);
 
-            if (statusCode < HttpStatus.SC_OK || statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SPLIT_SYNC, statusCode);
-                if (statusCode == HttpStatus.SC_REQUEST_URI_TOO_LONG) {
+            if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+                if (response.statusCode() == HttpStatus.SC_REQUEST_URI_TOO_LONG) {
                     _log.error("The amount of flag sets provided are big causing uri length error.");
-                    throw new UriTooLongException(String.format("Status code: %s. Message: %s", statusCode, response.getReasonPhrase()));
+                    throw new UriTooLongException(String.format("Status code: %s. Message: %s", response.statusCode(), response.statusMessage()));
                 }
-                _log.warn(String.format("Response status was: %s. Reason: %s", statusCode , response.getReasonPhrase()));
-                throw new IllegalStateException(String.format("Could not retrieve splitChanges since %s; http return code %s", since, statusCode));
+                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SPLIT_SYNC, response.statusCode());
+                throw new IllegalStateException(
+                        String.format("Could not retrieve splitChanges since %s; http return code %s", since, response.statusCode())
+                );
             }
 
-            String json = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
-
-            return Json.fromJson(json, SplitChange.class);
+            return Json.fromJson(response.body(), SplitChange.class);
         } catch (Exception e) {
             throw new IllegalStateException(String.format("Problem fetching splitChanges since %s: %s", since, e), e);
         } finally {
             _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.SPLITS, System.currentTimeMillis()-start);
-            Utils.forceClose(response);
         }
     }
 

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

@@ -0,0 +1,18 @@
+package io.split.client;
+
+import io.split.client.CustomHeaderDecorator;
+import io.split.client.dtos.RequestContext;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+class NoOpHeaderDecorator implements CustomHeaderDecorator {
+    public NoOpHeaderDecorator() {
+    }
+
+    @Override
+    public Map<String, List<String>> getHeaderOverrides(RequestContext context) {
+        return new HashMap<>();
+    }
+}

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

@@ -0,0 +1,77 @@
+package io.split.client;
+
+import io.split.client.dtos.RequestContext;
+
+import org.apache.hc.core5.http.HttpRequest;
+import org.apache.hc.core5.http.Header;
+
+import java.util.HashSet;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Arrays;
+import java.util.ArrayList;
+import java.util.Set;
+import java.util.List;
+
+public final class RequestDecorator {
+    CustomHeaderDecorator _headerDecorator;
+
+    private static final Set<String> forbiddenHeaders = new HashSet<>(Arrays.asList(
+            "splitsdkversion",
+            "splitmachineip",
+            "splitmachinename",
+            "splitimpressionsmode",
+            "host",
+            "referrer",
+            "content-type",
+            "content-length",
+            "content-encoding",
+            "accept",
+            "keep-alive",
+            "x-fastly-debug"));
+
+    public RequestDecorator(CustomHeaderDecorator headerDecorator) {
+        _headerDecorator = (headerDecorator == null)
+                ? new NoOpHeaderDecorator()
+                : headerDecorator;
+    }
+
+    public HttpRequest decorateHeaders(HttpRequest request) {
+        try {
+            Map<String, List<String>> headers = _headerDecorator
+                    .getHeaderOverrides(new RequestContext(convertToMap(request.getHeaders())));
+            for (Map.Entry<String, List<String>> entry : headers.entrySet()) {
+                if (isHeaderAllowed(entry.getKey())) {
+                    List<String> values = entry.getValue();
+                    for (int i = 0; i < values.size(); i++) {
+                        if (i == 0) {
+                            request.setHeader(entry.getKey(), values.get(i));
+                        } else {
+                            request.addHeader(entry.getKey(), values.get(i));
+                        }
+                    }
+                }
+            }
+        } catch (Exception e) {
+            throw new IllegalArgumentException(
+                    String.format("Problem adding custom headers to request decorator: %s", e), e);
+        }
+
+        return request;
+    }
+
+    private boolean isHeaderAllowed(String headerName) {
+        return !forbiddenHeaders.contains(headerName.toLowerCase());
+    }
+
+    private Map<String, List<String>> convertToMap(Header[] to_convert) {
+        Map<String, List<String>> to_return = new HashMap<String, List<String>>();
+        for (Integer i = 0; i < to_convert.length; i++) {
+            if (!to_return.containsKey(to_convert[i].getName())) {
+                to_return.put(to_convert[i].getName(), new ArrayList<String>());
+            }
+            to_return.get(to_convert[i].getName()).add(to_convert[i].getValue());
+        }
+        return to_return;
+    }
+}