Enhanced RequestContext with headerParams() methods, + fixed javadocs

Author: artem-v

services-api/src/main/java/io/scalecube/services/RequestContext.java

@@ -10,6 +10,7 @@
 import io.scalecube.services.exceptions.ForbiddenException;
 import io.scalecube.services.methods.MethodInfo;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Objects;
@@ -100,17 +101,40 @@ public Context delete(Object key) {
   /**
    * Returns request headers.
    *
-   * @return headers, or {@code null} if not set
+   * @return headers, or empty map if not set
    */
   public Map<String, String> headers() {
     return source.getOrDefault(HEADERS_KEY, Collections.emptyMap());
   }
 
+  /**
+   * Returns typed access to all request headers.
+   *
+   * @return typed parameters for headers
+   */
+  public TypedParameters headerParams() {
+    return new TypedParameters(headers());
+  }
+
+  /**
+   * Returns typed access to request headers filtered by the given prefix. Headers matching
+   * "{prefix}." are included with the prefix stripped from the key.
+   *
+   * @param prefix header prefix to filter by (if null or empty, returns all headers)
+   * @return typed parameters for filtered headers
+   */
+  public TypedParameters headerParams(String prefix) {
+    if (prefix == null || prefix.isEmpty()) {
+      return headerParams();
+    }
+    return new TypedParameters(filterByPrefix(headers(), prefix));
+  }
+
   /**
    * Puts request headers to the context.
    *
    * @param headers headers
-   * @return new {@code RequestContext} instance with updated headers
+   * @return new {@code RequestContext}
    */
   public RequestContext headers(Map<String, String> headers) {
     return put(HEADERS_KEY, headers);
@@ -129,7 +153,7 @@ public Object request() {
    * Puts request to the context.
    *
    * @param request request
-   * @return new {@code RequestContext} instance with updated request
+   * @return new {@code RequestContext}
    */
   public RequestContext request(Object request) {
     return put(REQUEST_KEY, request);
@@ -185,7 +209,7 @@ public Principal principal() {
    * Puts principal to the context.
    *
    * @param principal principal
-   * @return new {@code RequestContext} instance with the updated principal
+   * @return new {@code RequestContext}
    */
   public RequestContext principal(Principal principal) {
     return put(PRINCIPAL_KEY, principal);
@@ -224,7 +248,7 @@ public RequestContext methodInfo(MethodInfo methodInfo) {
   /**
    * Returns path parameters associated with the request.
    *
-   * @return path parameters, or {@code null} if not set
+   * @return path parameters, or empty map if not set
    */
   public TypedParameters pathParams() {
     return new TypedParameters(source.getOrDefault(PATH_PARAMS_KEY, Collections.emptyMap()));
@@ -233,7 +257,7 @@ public TypedParameters pathParams() {
   /**
    * Puts path parameters associated with the request.
    *
-   * @return path parameters, or {@code null} if not set
+   * @return new {@code RequestContext}
    */
   public RequestContext pathParams(Map<String, String> pathParams) {
     return put(PATH_PARAMS_KEY, pathParams);
@@ -310,6 +334,21 @@ public static Mono<RequestContext> deferSecured() {
             });
   }
 
+  private static Map<String, String> filterByPrefix(Map<String, String> map, String prefix) {
+    if (map == null || map.isEmpty()) {
+      return Map.of();
+    }
+    final var finalPrefix = prefix + ".";
+    final var result = new HashMap<String, String>();
+    map.forEach(
+        (k, v) -> {
+          if (k.startsWith(finalPrefix)) {
+            result.put(k.substring(finalPrefix.length()), v);
+          }
+        });
+    return result;
+  }
+
   @Override
   public String toString() {
     return new StringJoiner(", ", RequestContext.class.getSimpleName() + "[", "]")

services-gateway/src/test/java/io/scalecube/services/gateway/rest/RestGatewayTest.java

@@ -275,6 +275,29 @@ void testTrace() {
               })
           .verifyComplete();
     }
+
+    @Test
+    void testAttributesPropagation() {
+      StepVerifier.create(
+              serviceCall.requestOne(
+                  ServiceMessage.builder()
+                      .header("http.method", "GET")
+                      .header("http.header.X-String-Header", "abc")
+                      .header("http.header.X-Int-Header", "123456789")
+                      .header("http.query.debug", "true")
+                      .header("http.query.x", "1")
+                      .header("http.query.y", "2")
+                      .qualifier("v1/restService/propagate/123/bar456/baz789")
+                      .build(),
+                  SomeResponse.class))
+          .assertNext(
+              message -> {
+                final var someResponse = message.<SomeResponse>data();
+                assertNotNull(someResponse, "data");
+                assertNotNull(someResponse.name(), "someResponse.name");
+              })
+          .verifyComplete();
+    }
   }
 
   @Nested

services-gateway/src/test/java/io/scalecube/services/gateway/rest/RestService.java

@@ -1,5 +1,6 @@
 package io.scalecube.services.gateway.rest;
 
+import io.scalecube.services.annotations.RestMethod;
 import io.scalecube.services.annotations.Service;
 import io.scalecube.services.annotations.ServiceMethod;
 import reactor.core.publisher.Mono;
@@ -30,4 +31,8 @@ public interface RestService {
 
   @ServiceMethod("trace/:foo")
   Mono<SomeResponse> trace();
+
+  @RestMethod("GET")
+  @ServiceMethod("propagate/:foo/:bar/:baz")
+  Mono<SomeResponse> propagateRequestAttributes();
 }

services-gateway/src/test/java/io/scalecube/services/gateway/rest/RestServiceImpl.java

@@ -8,6 +8,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import io.scalecube.services.RequestContext;
+import java.util.UUID;
 import reactor.core.publisher.Mono;
 
 public class RestServiceImpl implements RestService {
@@ -142,4 +143,35 @@ public Mono<SomeResponse> trace() {
               return new SomeResponse().name(foo);
             });
   }
+
+  @Override
+  public Mono<SomeResponse> propagateRequestAttributes() {
+    return RequestContext.deferContextual()
+        .map(
+            context -> {
+              final var pathParams = context.pathParams();
+              assertEquals(123, pathParams.intValue("foo"), "foo");
+              assertEquals("bar456", pathParams.stringValue("bar"), "bar");
+              assertEquals("baz789", pathParams.stringValue("baz"), "baz");
+
+              final var headers = context.headers();
+              assertEquals("GET", headers.get("http.method"));
+              assertEquals("abc", headers.get("http.header.X-String-Header"));
+              assertEquals("123456789", headers.get("http.header.X-Int-Header"));
+              assertEquals("true", headers.get("http.query.debug"));
+              assertEquals("1", headers.get("http.query.x"));
+              assertEquals("2", headers.get("http.query.y"));
+
+              final var httpHeaders = context.headerParams("http.header");
+              assertEquals("abc", httpHeaders.stringValue("X-String-Header"));
+              assertEquals(123456789, httpHeaders.intValue("X-Int-Header"));
+
+              final var queryParams = context.headerParams("http.query");
+              assertEquals(true, queryParams.booleanValue("debug"));
+              assertEquals(1, queryParams.intValue("x"));
+              assertEquals(2, queryParams.intValue("y"));
+
+              return new SomeResponse().name(UUID.randomUUID().toString());
+            });
+  }
 }