Matt/header forwarding

build.gradle

@@ -6,7 +6,7 @@ plugins {
   id "io.github.gradle-nexus.publish-plugin" version "1.1.0"
 }
 
-version "3.6.0" // x-release-please-version
+version "3.7.0-SNAPSHOT" // x-release-please-version
 
 def platformProject = "platform"
 def publishedProjects = [

common/src/main/java/com/mx/path/core/common/compression/CompressionService.java

@@ -0,0 +1,9 @@
+package com.mx.path.core.common.compression;
+
+public interface CompressionService {
+  boolean isCompressed(String data);
+
+  String compress(String data);
+
+  String decompress(String data);
+}

common/src/main/java/com/mx/path/core/common/compression/CompressionServiceException.java

@@ -0,0 +1,10 @@
+package com.mx.path.core.common.compression;
+
+import com.mx.path.core.common.exception.PathSystemException;
+
+public class CompressionServiceException extends PathSystemException {
+
+  public CompressionServiceException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

context/src/main/java/com/mx/path/core/context/Session.java

@@ -15,6 +15,7 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.mx.path.core.common.compression.CompressionService;
 import com.mx.path.core.common.lang.Strings;
 import com.mx.path.core.common.security.EncryptionService;
 import com.mx.path.core.common.serialization.LocalDateDeserializer;
@@ -39,6 +40,8 @@ public class Session implements SessionInfo {
 
   private static Supplier<EncryptionService> encryptionServiceSupplier = new EncryptionServiceSupplier();
 
+  private static Supplier<CompressionService> compressionServiceSupplier = null;
+
   private static final int DEFAULT_SESSION_EXPIRATION_MINUTES = 30;
 
   private static Duration defaultSessionExpiration = Duration.ofMinutes(DEFAULT_SESSION_EXPIRATION_MINUTES);
@@ -66,6 +69,22 @@ public static EncryptionService getEncryptionService() {
     return encryptionServiceSupplier.get();
   }
 
+  public static CompressionService getCompressionService() {
+    if (compressionServiceSupplier == null) {
+      return null;
+    }
+
+    return compressionServiceSupplier.get();
+  }
+
+  public static void setCompressionServiceSupplier(Supplier<CompressionService> supplier) {
+    compressionServiceSupplier = supplier;
+  }
+
+  static void resetCompressionService() {
+    compressionServiceSupplier = null;
+  }
+
   public static void setDefaultSessionExpiration(Duration sessionExpiry) {
     defaultSessionExpiration = sessionExpiry;
   }
@@ -522,7 +541,7 @@ public final void delete(ScopeKeyGenerator scope, String key) {
   @Deprecated
   public final String get(String key) {
     String value = getRepository().getValue(this, key);
-    return decryptValue(value);
+    return decompressValue(decryptValue(value));
   }
 
   /**
@@ -533,7 +552,7 @@ public final String get(String key) {
    */
   public final String get(ScopeKeyGenerator scope, String key) {
     String value = getRepository().getValue(this, buildScopeKey(scope, key));
-    return decryptValue(value);
+    return decompressValue(decryptValue(value));
   }
 
   /**
@@ -564,18 +583,17 @@ public final <T> T getObj(ScopeKeyGenerator scope, String key, Class<T> klass) {
    */
   @Deprecated
   public final void put(String key, String value) {
-    getRepository().saveValue(this, key, value);
+    getRepository().saveValue(this, key, compressValue(value));
   }
 
   /**
    * Put a key/value pair
    * @param scope
    * @param key
    * @param value
-   *
    */
   public final void put(ScopeKeyGenerator scope, String key, String value) {
-    getRepository().saveValue(this, buildScopeKey(scope, key), value);
+    getRepository().saveValue(this, buildScopeKey(scope, key), compressValue(value));
   }
 
   /**
@@ -585,7 +603,7 @@ public final void put(ScopeKeyGenerator scope, String key, String value) {
    * @param obj
    */
   public final void putObj(ScopeKeyGenerator scope, String key, Object obj) {
-    put(scope, key, gson.toJson(obj));
+    getRepository().saveValue(this, buildScopeKey(scope, key), compressValue(gson.toJson(obj)));
   }
 
   /**
@@ -598,7 +616,7 @@ public final void putObj(ScopeKeyGenerator scope, String key, Object obj) {
    * @param value
    */
   public final void sput(ScopeKeyGenerator scope, String key, String value) {
-    put(scope, key, encryptValue(value));
+    getRepository().saveValue(this, buildScopeKey(scope, key), encryptValue(compressValue(value)));
   }
 
   /**
@@ -611,7 +629,7 @@ public final void sput(ScopeKeyGenerator scope, String key, String value) {
    * @param value
    */
   public final void sputObj(ScopeKeyGenerator scope, String key, Object value) {
-    sput(scope, key, gson.toJson(value));
+    getRepository().saveValue(this, buildScopeKey(scope, key), encryptValue(compressValue(gson.toJson(value))));
   }
 
   /**
@@ -629,6 +647,24 @@ private String buildScopeKey(ScopeKeyGenerator scope, String key) {
     return scope.generate() + "." + key;
   }
 
+  private String compressValue(String value) {
+    CompressionService compressionService = getCompressionService();
+    if (compressionService == null) {
+      return value;
+    }
+
+    return compressionService.compress(value);
+  }
+
+  private String decompressValue(String value) {
+    CompressionService compressionService = getCompressionService();
+    if (compressionService == null) {
+      return value;
+    }
+
+    return compressionService.decompress(value);
+  }
+
   private String decryptValue(String value) {
     if (Objects.isNull(value) || Strings.isBlank(value)) {
       return value;

context/src/test/groovy/com/mx/path/core/context/SessionTest.groovy

@@ -1,9 +1,12 @@
 package com.mx.path.core.context
 
+import static org.mockito.Mockito.mock
 import static org.mockito.Mockito.spy
 
 import java.time.Duration
+import java.util.function.Supplier
 
+import com.mx.path.core.common.compression.CompressionService
 import com.mx.path.core.common.security.EncryptionService
 import com.mx.path.core.context.store.SessionRepository
 import com.mx.testing.HashSessionRepository
@@ -29,6 +32,7 @@ class SessionTest extends Specification {
   def cleanup() {
     Session.setRepositorySupplier(null)
     Session.setEncryptionServiceSupplier(null)
+    Session.resetCompressionService()
     Session.clearSession()
     Session.setDefaultSessionExpiration(Duration.ofMinutes(30))
   }
@@ -128,6 +132,25 @@ class SessionTest extends Specification {
     1 * repository.saveValue(subject, "scope.key1", "value1")
   }
 
+  def "putStoresInRepository with compressionService"() {
+    given:
+    def compressionService = Stub(CompressionService)
+
+    def Supplier<CompressionService> supplier = { -> compressionService }
+    Session.setCompressionServiceSupplier(supplier)
+
+    and:
+    compressionService.compress("value1") >> "compressed:value1"
+
+    when:
+    subject.put("key1", "value1")
+    subject.put(TestScope.Key, "key1", "value1")
+
+    then:
+    1 * repository.saveValue(subject, "key1", "compressed:value1")
+    1 * repository.saveValue(subject, "scope.key1", "compressed:value1")
+  }
+
   def "deleteRemovesFromRepository"() {
     when:
     subject.delete("key1")
@@ -173,7 +196,6 @@ class SessionTest extends Specification {
     1 * listener2.beforeSave(session)
   }
 
-
   def "clearSessionRemovesListeners"() {
     given:
     SessionEventListener listener = Mock()
@@ -336,6 +358,25 @@ class SessionTest extends Specification {
     1 * encryptionService.decrypt("encrypted:v1:(!ph3%") >> "plaintext"
   }
 
+  def "setCompressionServiceSupplier"() {
+    given:
+    def compressionService = mock(CompressionService)
+
+    def Supplier<CompressionService> supplier = new Supplier<CompressionService>() {
+          @Override
+          CompressionService get() {
+            return compressionService
+          }
+        }
+
+    when:
+    Session.setCompressionServiceSupplier(supplier)
+    def result = Session.getCompressionService()
+
+    then:
+    result == compressionService
+  }
+
   def "encryptsEmail"() {
     given:
     subject = spy(new Session())

gateway/src/main/java/com/mx/path/gateway/connect/filter/HeaderForwarderFilter.java

@@ -0,0 +1,30 @@
+package com.mx.path.gateway.connect.filter;
+
+import com.mx.path.core.common.connect.Request;
+import com.mx.path.core.common.connect.RequestFilterBase;
+import com.mx.path.core.common.connect.Response;
+import com.mx.path.core.context.RequestContext;
+import com.mx.path.core.context.UpstreamRequestConfiguration;
+
+/**
+ * Request Filter that adds forwarded headers to request
+ */
+public class HeaderForwarderFilter extends RequestFilterBase {
+
+  @Override
+  public final void execute(Request request, Response response) {
+    UpstreamRequestConfiguration upstreamRequestConfiguration = null;
+
+    if (RequestContext.current() != null) {
+      upstreamRequestConfiguration = RequestContext.current().getUpstreamRequestConfiguration();
+    }
+
+    if (upstreamRequestConfiguration != null && upstreamRequestConfiguration.getForwardedRequestHeaders() != null) {
+      upstreamRequestConfiguration.getForwardedRequestHeaders().forEach((key, value) -> {
+        request.withHeader(key, value.toString());
+      });
+    }
+
+    next(request, response);
+  }
+}

gateway/src/test/groovy/com/mx/path/gateway/connect/filter/HeaderForwarderFilterTest.groovy

@@ -0,0 +1,49 @@
+package com.mx.path.gateway.connect.filter
+
+import static org.mockito.Mockito.mock
+
+import com.mx.path.core.common.connect.Request
+import com.mx.path.core.common.connect.RequestFilter
+import com.mx.path.core.common.connect.Response
+import com.mx.path.core.context.RequestContext
+import com.mx.path.core.context.UpstreamRequestConfiguration
+
+import spock.lang.Specification
+
+class HeaderForwarderFilterTest extends Specification {
+  class TestRequest extends Request<TestRequest, TestResponse> {
+    TestRequest(RequestFilter filterChain) {
+      super(filterChain)
+    }
+
+    @Override
+    TestResponse execute() {
+      return null
+    }
+  }
+
+  class TestResponse extends Response<TestRequest, TestResponse> {
+  }
+
+  def "forwards all headers in current RequestContext forwardedHeader"() {
+    given:
+    def requestFilter = mock(RequestFilter)
+    def subject = new HeaderForwarderFilter()
+    def request = new TestRequest(requestFilter)
+    def response = new TestResponse()
+    RequestContext.builder()
+        .upstreamRequestConfiguration(UpstreamRequestConfiguration.builder()
+        .forwardedHeader("mx_forwarded_important_header", "12345")
+        .forwardedHeader("mx-forwarded-important-header", "12345")
+        .build())
+        .build()
+        .register()
+
+    when:
+    subject.execute(request, response)
+
+    then:
+    request.headers.containsKey("mx_forwarded_important_header")
+    request.headers.containsKey("mx-forwarded-important-header")
+  }
+}