Renamed UserCustomHeaderDecorator to CustomHeaderDecorator

Bilal Al · Bilal Al · commit aa9aafdf3f16 · 2024-03-27T12:43:47.000-07:00
diff --git a/client/src/main/java/io/split/client/CustomHeaderDecorator.java b/client/src/main/java/io/split/client/CustomHeaderDecorator.java
@@ -3,7 +3,7 @@
 import java.util.Map;
 import java.util.List;
 
-public interface UserCustomHeaderDecorator
+public interface CustomHeaderDecorator
 {
     /**
      * Get the additional headers needed for all http operations
diff --git a/client/src/main/java/io/split/client/HttpSegmentChangeFetcher.java b/client/src/main/java/io/split/client/HttpSegmentChangeFetcher.java
@@ -64,18 +64,18 @@ public SegmentChange fetch(String segmentName, long since, FetchOptions options)
 
             SplitHttpResponse response = _client.get(uri, options, null);
 
-            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) {
+            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, response.statusCode));
+                        segmentName, since, response.statusCode()));
             }
             _telemetryRuntimeProducer.recordSuccessfulSync(LastSynchronizationRecordsEnum.SEGMENTS, System.currentTimeMillis());
 
-            return Json.fromJson(response.body, 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);
diff --git a/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java b/client/src/main/java/io/split/client/HttpSplitChangeFetcher.java
@@ -68,18 +68,18 @@ public SplitChange fetch(long since, FetchOptions options) {
             URI uri = uriBuilder.build();
             SplitHttpResponse response = _client.get(uri, options, null);
 
-            if (response.statusCode < HttpStatus.SC_OK || response.statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                if (response.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", response.statusCode, response.statusMessage));
+                    throw new UriTooLongException(String.format("Status code: %s. Message: %s", response.statusCode(), response.statusMessage()));
                 }
-                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.SPLIT_SYNC, response.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.format("Could not retrieve splitChanges since %s; http return code %s", since, response.statusCode())
                 );
             }
 
-            return Json.fromJson(response.body, 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 {
diff --git a/client/src/main/java/io/split/client/RequestDecorator.java b/client/src/main/java/io/split/client/RequestDecorator.java
@@ -8,7 +8,7 @@
 import java.util.Set;
 import java.util.List;
 
-class NoOpHeaderDecorator implements  UserCustomHeaderDecorator {
+class NoOpHeaderDecorator implements  CustomHeaderDecorator {
     public NoOpHeaderDecorator() {}
     @Override
     public Map<String, List<String>> getHeaderOverrides() {
@@ -17,7 +17,7 @@ public Map<String, List<String>> getHeaderOverrides() {
 }
 
 public final class RequestDecorator {
-    UserCustomHeaderDecorator _headerDecorator;
+    CustomHeaderDecorator _headerDecorator;
 
     private static final Set<String> forbiddenHeaders = new HashSet<>(Arrays.asList(
             "splitsdkversion",
@@ -34,7 +34,7 @@ public final class RequestDecorator {
             "x-fastly-debug"
     ));
 
-    public RequestDecorator(UserCustomHeaderDecorator headerDecorator) {
+    public RequestDecorator(CustomHeaderDecorator headerDecorator) {
         _headerDecorator = (headerDecorator == null)
                 ? new NoOpHeaderDecorator()
                 : headerDecorator;
diff --git a/client/src/main/java/io/split/client/SplitClientConfig.java b/client/src/main/java/io/split/client/SplitClientConfig.java
@@ -90,7 +90,7 @@ public class SplitClientConfig {
     private final long _lastSeenCacheSize;
     private final HashSet<String> _flagSetsFilter;
     private final int _invalidSets;
-    private final UserCustomHeaderDecorator _userCustomHeaderDecorator;
+    private final CustomHeaderDecorator _customHeaderDecorator;
 
 
     public static Builder builder() {
@@ -148,7 +148,7 @@ private SplitClientConfig(String endpoint,
                               ThreadFactory threadFactory,
                               HashSet<String> flagSetsFilter,
                               int invalidSets,
-                              UserCustomHeaderDecorator userCustomHeaderDecorator) {
+                              CustomHeaderDecorator customHeaderDecorator) {
         _endpoint = endpoint;
         _eventsEndpoint = eventsEndpoint;
         _featuresRefreshRate = pollForFeatureChangesEveryNSeconds;
@@ -200,7 +200,7 @@ private SplitClientConfig(String endpoint,
         _threadFactory = threadFactory;
         _flagSetsFilter = flagSetsFilter;
         _invalidSets = invalidSets;
-        _userCustomHeaderDecorator = userCustomHeaderDecorator;
+        _customHeaderDecorator = customHeaderDecorator;
 
         Properties props = new Properties();
         try {
@@ -397,8 +397,8 @@ public int getInvalidSets() {
         return _invalidSets;
     }
 
-    public UserCustomHeaderDecorator userCustomHeaderDecorator() {
-        return _userCustomHeaderDecorator;
+    public CustomHeaderDecorator customHeaderDecorator() {
+        return _customHeaderDecorator;
     }
 
     public static final class Builder {
@@ -457,7 +457,7 @@ public static final class Builder {
         private ThreadFactory _threadFactory;
         private HashSet<String> _flagSetsFilter = new HashSet<>();
         private int _invalidSetsCount = 0;
-        private UserCustomHeaderDecorator _userCustomHeaderDecorator = null;
+        private CustomHeaderDecorator _customHeaderDecorator = null;
 
         public Builder() {
         }
@@ -944,11 +944,11 @@ public Builder flagSetsFilter(List<String> flagSetsFilter) {
         /**
          * User Custom Header Decorator
          *
-         * @param userCustomHeaderDecorator
+         * @param customHeaderDecorator
          * @return this builder
          */
-        public Builder userCustomHeaderDecorator(UserCustomHeaderDecorator userCustomHeaderDecorator) {
-            _userCustomHeaderDecorator = userCustomHeaderDecorator;
+        public Builder customHeaderDecorator(CustomHeaderDecorator customHeaderDecorator) {
+            _customHeaderDecorator = customHeaderDecorator;
             return this;
         }
 
@@ -1112,7 +1112,7 @@ public SplitClientConfig build() {
                     _threadFactory,
                     _flagSetsFilter,
                     _invalidSetsCount,
-                    _userCustomHeaderDecorator);
+                    _customHeaderDecorator);
         }
     }
 }
diff --git a/client/src/main/java/io/split/client/SplitFactoryImpl.java b/client/src/main/java/io/split/client/SplitFactoryImpl.java
@@ -508,7 +508,7 @@ private static SplitHttpClient buildSplitHttpClient(String apiToken, SplitClient
             httpClientbuilder = setupProxy(httpClientbuilder, config);
         }
 
-        return SplitHttpClientImpl.create(httpClientbuilder.build(), new RequestDecorator(config.userCustomHeaderDecorator()));
+        return SplitHttpClientImpl.create(httpClientbuilder.build(), new RequestDecorator(config.customHeaderDecorator()));
     }
 
     private static CloseableHttpClient buildSSEdHttpClient(String apiToken, SplitClientConfig config, SDKMetadata sdkMetadata) {
diff --git a/client/src/main/java/io/split/client/dtos/SplitHttpResponse.java b/client/src/main/java/io/split/client/dtos/SplitHttpResponse.java
@@ -5,9 +5,30 @@
 /**
  * A structure for returning http call results information
  */
-public final class SplitHttpResponse {
-    public Integer statusCode;
-    public String statusMessage;
-    public String body;
-    public Header[] responseHeaders;
+public class SplitHttpResponse {
+    private final Integer _statusCode;
+    private final String _statusMessage;
+    private final String _body;
+    private final Header[] _responseHeaders;
+
+    public SplitHttpResponse(Integer statusCode, String statusMessage, String body, Header[] headers) {
+        _statusCode = statusCode;
+        _statusMessage = statusMessage;
+        _body = body;
+        _responseHeaders = headers;
+    }
+    public Integer statusCode() {
+        return _statusCode;
+    }
+    public String statusMessage() {
+        return _statusMessage;
+    }
+
+    public String body() {
+        return _body;
+    }
+
+    public Header[] responseHeaders() {
+        return _responseHeaders;
+    }
 }
diff --git a/client/src/main/java/io/split/client/impressions/HttpImpressionsSender.java b/client/src/main/java/io/split/client/impressions/HttpImpressionsSender.java
@@ -69,8 +69,8 @@ public void postImpressionsBulk(List<TestImpressions> impressions) {
             additionalHeader.put(IMPRESSIONS_MODE_HEADER, _mode.toString());
             SplitHttpResponse response = _client.post(_impressionBulkTarget, entity, additionalHeader);
 
-            if (response.statusCode < HttpStatus.SC_OK || response.statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.IMPRESSION_SYNC, response.statusCode);
+            if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.IMPRESSION_SYNC, response.statusCode());
             }
             _telemetryRuntimeProducer.recordSuccessfulSync(LastSynchronizationRecordsEnum.IMPRESSIONS, System.currentTimeMillis());
 
@@ -94,8 +94,8 @@ public void postCounters(HashMap<ImpressionCounter.Key, Integer> raw) {
                 Utils.toJsonEntity(ImpressionCount.fromImpressionCounterData(raw)),
                 null);
 
-            if (response.statusCode < HttpStatus.SC_OK || response.statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.IMPRESSION_COUNT_SYNC, response.statusCode);
+            if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+                _telemetryRuntimeProducer.recordSyncError(ResourceEnum.IMPRESSION_COUNT_SYNC, response.statusCode());
             }
             _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.IMPRESSIONS_COUNT, System.currentTimeMillis() - initTime);
             _telemetryRuntimeProducer.recordSuccessfulSync(LastSynchronizationRecordsEnum.IMPRESSIONS_COUNT, System.currentTimeMillis());
diff --git a/client/src/main/java/io/split/engine/sse/AuthApiClientImp.java b/client/src/main/java/io/split/engine/sse/AuthApiClientImp.java
@@ -38,15 +38,15 @@ public AuthenticationResponse Authenticate() {
             long initTime = System.currentTimeMillis();
             URI uri = new URIBuilder(_target).build();
             SplitHttpResponse response = _httpClient.get(uri, new FetchOptions.Builder().cacheControlHeaders(false).build(), null);
-            Integer statusCode = response.statusCode;
+            Integer statusCode = response.statusCode();
 
             if (statusCode == HttpStatus.SC_OK) {
                 _log.debug(String.format("Success connection to: %s", _target));
 
                 _telemetryRuntimeProducer.recordTokenRefreshes();
                 _telemetryRuntimeProducer.recordSuccessfulSync(LastSynchronizationRecordsEnum.TOKEN, System.currentTimeMillis());
                 _telemetryRuntimeProducer.recordSyncLatency(HTTPLatenciesEnum.TOKEN, System.currentTimeMillis()-initTime);
-                return getSuccessResponse(response.body);
+                return getSuccessResponse(response.body());
             }
 
             _log.error(String.format("Problem to connect to : %s. Response status: %s", _target, statusCode));
diff --git a/client/src/main/java/io/split/service/HttpPostImp.java b/client/src/main/java/io/split/service/HttpPostImp.java
@@ -29,8 +29,8 @@ public void post(URI uri, Object object, String posted, HttpParamsWrapper httpPa
 
         try {
             SplitHttpResponse response = _client.post(uri, entity, null);
-            if (response.statusCode < HttpStatus.SC_OK || response.statusCode >= HttpStatus.SC_MULTIPLE_CHOICES) {
-                _telemetryRuntimeProducer.recordSyncError(httpParamsWrapper.getResourceEnum(), response.statusCode);
+            if (response.statusCode() < HttpStatus.SC_OK || response.statusCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
+                _telemetryRuntimeProducer.recordSyncError(httpParamsWrapper.getResourceEnum(), response.statusCode());
                 return;
             }
             _telemetryRuntimeProducer.recordSyncLatency(httpParamsWrapper.getHttpLatenciesEnum(), System.currentTimeMillis() - initTime);
diff --git a/client/src/main/java/io/split/service/SplitHttpClientImpl.java b/client/src/main/java/io/split/service/SplitHttpClientImpl.java
@@ -61,16 +61,15 @@ public SplitHttpResponse get(URI uri, FetchOptions options, Map<String, String>
                 _log.debug(String.format("[%s] %s. Status code: %s", request.getMethod(), uri.toURL(), response.getCode()));
             }
 
-            SplitHttpResponse httpResponse = new SplitHttpResponse();
-            httpResponse.statusMessage = "";
-            httpResponse.responseHeaders = response.getHeaders();
+            String statusMessage = "";
             if (response.getCode() < HttpStatus.SC_OK || response.getCode() >= HttpStatus.SC_MULTIPLE_CHOICES) {
                 _log.warn(String.format("Response status was: %s. Reason: %s", response.getCode() , response.getReasonPhrase()));
-                httpResponse.statusMessage = response.getReasonPhrase();
+                statusMessage = response.getReasonPhrase();
             }
-            httpResponse.statusCode = response.getCode();
-            httpResponse.body = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
-            return httpResponse;
+            return new SplitHttpResponse(response.getCode(),
+                                         statusMessage,
+                                         EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8),
+                                         response.getHeaders());
         } catch (Exception e) {
             throw new IllegalStateException(String.format("Problem in http get operation: %s", e), e);
         } finally {
@@ -100,12 +99,7 @@ public SplitHttpResponse get(URI uri, FetchOptions options, Map<String, String>
                 statusMessage = response.getReasonPhrase();
                 _log.warn(String.format("Response status was: %s. Reason: %s", response.getCode(), response.getReasonPhrase()));
             }
-            SplitHttpResponse httpResponse = new SplitHttpResponse();
-            httpResponse.statusCode = response.getCode();
-            httpResponse.body = "";
-            httpResponse.statusMessage = statusMessage;
-            httpResponse.responseHeaders = response.getHeaders();
-            return httpResponse;
+            return new SplitHttpResponse(response.getCode(), statusMessage, "", response.getHeaders());
         } catch (Exception e) {
             throw new IOException(String.format("Problem in http post operation: %s", e), e);
         } finally {
diff --git a/client/src/test/java/io/split/client/RequestDecoratorTest.java b/client/src/test/java/io/split/client/RequestDecoratorTest.java
@@ -31,7 +31,7 @@ public void testNoOp() {
 
     @Test
     public void testAddCustomHeaders() throws ProtocolException {
-        class MyCustomHeaders implements UserCustomHeaderDecorator {
+        class MyCustomHeaders implements CustomHeaderDecorator {
             public MyCustomHeaders() {}
             @Override
             public Map<String, List<String>> getHeaderOverrides() {
@@ -65,7 +65,7 @@ public Map<String, List<String>> getHeaderOverrides() {
 
     @Test
     public void testAddBlockedHeaders() throws ProtocolException {
-        class MyCustomHeaders implements  UserCustomHeaderDecorator {
+        class MyCustomHeaders implements  CustomHeaderDecorator {
             public MyCustomHeaders() {}
             @Override
             public Map<String, List<String>> getHeaderOverrides() {
@@ -82,7 +82,7 @@ public Map<String, List<String>> getHeaderOverrides() {
                     put("content-length", Arrays.asList("xx"));
                     put("content-encoding", Arrays.asList("xx"));
                     put("ACCEPT", Arrays.asList("xx"));
-                    put("keep-alive", Arrays.asListf("xx"));
+                    put("keep-alive", Arrays.asList("xx"));
                     put("x-fastly-debug", Arrays.asList("xx"));
 
                 }};
@@ -98,7 +98,7 @@ public Map<String, List<String>> getHeaderOverrides() {
 
     @Test(expected = IllegalArgumentException.class)
     public void customDecoratorError() {
-        class MyCustomHeaders implements  UserCustomHeaderDecorator {
+        class MyCustomHeaders implements  CustomHeaderDecorator {
             public MyCustomHeaders() {}
             @Override
             public Map<String, List<String>> getHeaderOverrides() {
diff --git a/client/src/test/java/io/split/client/SplitClientConfigTest.java b/client/src/test/java/io/split/client/SplitClientConfigTest.java
@@ -239,18 +239,18 @@ public void IntegrationConfigAsyncNotNull() {
 
     @Test
     public void checkUserCustomdHeaderDecorator() {
-        UserCustomHeaderDecorator ucd = new UserCustomHeaderDecorator() {
+        CustomHeaderDecorator ucd = new CustomHeaderDecorator() {
             @Override
             public Map<String, List<String>> getHeaderOverrides() {
                 return null;
             }
         };
-        SplitClientConfig config = SplitClientConfig.builder().userCustomHeaderDecorator(ucd).build();
-        Assert.assertNotNull(config.userCustomHeaderDecorator());
-        Assert.assertEquals(ucd, config.userCustomHeaderDecorator());
+        SplitClientConfig config = SplitClientConfig.builder().customHeaderDecorator(ucd).build();
+        Assert.assertNotNull(config.customHeaderDecorator());
+        Assert.assertEquals(ucd, config.customHeaderDecorator());
 
         SplitClientConfig config2 = SplitClientConfig.builder().build();
-        Assert.assertNull(config2.userCustomHeaderDecorator());
+        Assert.assertNull(config2.customHeaderDecorator());
 
     }
 }
diff --git a/client/src/test/java/io/split/service/HttpSplitClientTest.java b/client/src/test/java/io/split/service/HttpSplitClientTest.java

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`import java.util.Map;`
`4`	`4`	`import java.util.List;`
`5`	`5`
`6`		`-public interface UserCustomHeaderDecorator`
	`6`	`+public interface CustomHeaderDecorator`
`7`	`7`	`{`
`8`	`8`	`/**`
`9`	`9`	`* Get the additional headers needed for all http operations`
Original file line number	Diff line number	Diff line change
`@@ -508,7 +508,7 @@ private static SplitHttpClient buildSplitHttpClient(String apiToken, SplitClient`
`508`	`508`	`httpClientbuilder = setupProxy(httpClientbuilder, config);`
`509`	`509`	`}`
`510`	`510`
`511`		`- return SplitHttpClientImpl.create(httpClientbuilder.build(), new RequestDecorator(config.userCustomHeaderDecorator()));`
	`511`	`+ return SplitHttpClientImpl.create(httpClientbuilder.build(), new RequestDecorator(config.customHeaderDecorator()));`
`512`	`512`	`}`
`513`	`513`
`514`	`514`	`private static CloseableHttpClient buildSSEdHttpClient(String apiToken, SplitClientConfig config, SDKMetadata sdkMetadata) {`