Remove Fragments from RequestEvent

Author: malaskowski

api/build.gradle.kts

@@ -27,7 +27,6 @@ plugins {
 // Dependencies
 // -----------------------------------------------------------------------------
 dependencies {
-    api("io.knotx:knotx-fragment-api:${project.version}")
     implementation("io.knotx:knotx-commons:${project.version}")
     implementation(group = "io.vertx", name = "vertx-web")
     implementation(group = "com.google.guava", name = "guava")

api/docs/asciidoc/dataobjects.adoc

@@ -87,9 +87,6 @@ Final <code>ClientResponse</code> object for this request context.
 |[[clientRequest]]`@clientRequest`|`link:dataobjects.html#ClientRequest[ClientRequest]`|+++
 Currently processed <code>ClientRequest</code> details.
 +++
-|[[fragments]]`@fragments`|`Array of link:dataobjects.html#Fragment[Fragment]`|+++
-List of <code>io.knotx.fragment.Fragment</code> that are processed in the scope of the current request.
-+++
 |[[payload]]`@payload`|`Json object`|+++
 A <code>JsonObject</code> that contains payload of currently processed request. It may contain any
  additional data that is added during processing of the Request.

api/src/main/java/io/knotx/server/api/context/RequestEvent.java

@@ -15,13 +15,8 @@
  */
 package io.knotx.server.api.context;
 
-import io.knotx.fragment.Fragment;
 import io.vertx.codegen.annotations.DataObject;
-import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.stream.Collectors;
 
 /**
  * Contains information about currently processed request event.
@@ -30,31 +25,23 @@
 public class RequestEvent {
 
   private static final String CLIENT_REQUEST_KEY = "clientRequest";
-  private static final String FRAGMENTS_KEY = "fragments";
   private static final String PAYLOAD_KEY = "payload";
 
   private final ClientRequest clientRequest;
-  private final List<Fragment> fragments;
   private final JsonObject payload;
 
-  public RequestEvent(ClientRequest clientRequest, List<Fragment> fragments, JsonObject payload) {
+  public RequestEvent(ClientRequest clientRequest, JsonObject payload) {
     this.clientRequest = clientRequest;
-    this.fragments = fragments;
     this.payload = payload;
   }
 
   public RequestEvent(ClientRequest clientRequest) {
     this.clientRequest = clientRequest;
-    this.fragments = new ArrayList<>();
     this.payload = new JsonObject();
   }
 
   public RequestEvent(JsonObject json) {
     this.clientRequest = new ClientRequest(json.getJsonObject(CLIENT_REQUEST_KEY));
-    this.fragments = json.getJsonArray(FRAGMENTS_KEY).stream()
-        .map(JsonObject.class::cast)
-        .map(Fragment::new)
-        .collect(Collectors.toList());
     this.payload = json.getJsonObject(PAYLOAD_KEY);
   }
 
@@ -66,15 +53,6 @@ public ClientRequest getClientRequest() {
     return clientRequest;
   }
 
-  /**
-   * List of {@code io.knotx.fragment.Fragment} that are processed in the scope of the current request.
-   *
-   * @return list of {@link Fragment} that are processed in the scope of the current request.
-   */
-  public List<Fragment> getFragments() {
-    return fragments;
-  }
-
   /**
    * A {@code JsonObject} that contains payload of currently processed request. It may contain any
    * additional data that is added during processing of the Request.
@@ -91,19 +69,15 @@ public JsonObject appendPayload(String key, Object value) {
   }
 
   public JsonObject toJson() {
-    final JsonArray fragmentsArray = new JsonArray();
-    fragments.forEach(entry -> fragmentsArray.add(entry.toJson()));
     return new JsonObject()
         .put(CLIENT_REQUEST_KEY, clientRequest.toJson())
-        .put(FRAGMENTS_KEY, fragmentsArray)
         .put(PAYLOAD_KEY, payload);
   }
 
   @Override
   public String toString() {
     return "RequestEvent{" +
         "clientRequest=" + clientRequest +
-        ", fragments=" + fragments +
         ", payload=" + payload +
         '}';
   }

assembler/build.gradle.kts

@@ -27,7 +27,8 @@ plugins {
 // Dependencies
 // -----------------------------------------------------------------------------
 dependencies {
-    implementation(project(":knotx-server-http-api"))
+    api(project(":knotx-server-http-api"))
+    api("io.knotx:knotx-fragment-api:${project.version}")
 
     implementation(group = "org.apache.commons", name = "commons-lang3")
     testImplementation(group = "org.mockito", name = "mockito-core")

assembler/src/main/java/io/knotx/assembler/FragmentAssemblerHandler.java

@@ -16,23 +16,58 @@
 package io.knotx.assembler;
 
 import io.knotx.fragment.Fragment;
+import io.knotx.server.api.context.RequestContext;
 import io.knotx.server.api.context.RequestEvent;
-import io.knotx.server.api.handler.RequestEventHandler;
+import io.knotx.server.api.handler.DefaultRequestContextEngine;
+import io.knotx.server.api.handler.RequestContextEngine;
 import io.knotx.server.api.handler.RequestEventHandlerResult;
 import io.netty.handler.codec.http.HttpResponseStatus;
+import io.vertx.core.Handler;
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.http.HttpHeaders;
+import io.vertx.core.logging.Logger;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.reactivex.core.MultiMap;
+import io.vertx.reactivex.ext.web.RoutingContext;
+import java.util.List;
 import java.util.stream.Collectors;
 import org.apache.commons.lang3.StringUtils;
 
-class FragmentAssemblerHandler extends RequestEventHandler {
+class FragmentAssemblerHandler implements Handler<RoutingContext> {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(FragmentAssemblerHandler.class);
+  private static final String MISSING_FRAGMENTS_PAYLOAD = "Expected 'fragments' in the routing context are missing!";
+
+  private final RequestContextEngine engine;
+
+  FragmentAssemblerHandler() {
+    engine = new DefaultRequestContextEngine(getClass().getSimpleName());
+  }
 
   @Override
-  protected RequestEventHandlerResult handle(RequestEvent requestEvent) {
-    final String responseBody = requestEvent.getFragments().stream()
-        .map(Fragment::getBody)
-        .collect(Collectors.joining());
+  public void handle(RoutingContext context) {
+    RequestContext requestContext = context.get(RequestContext.KEY);
+    try {
+      RequestEventHandlerResult result = joinFragmentsBodies(context, requestContext.getRequestEvent());
+      engine.processAndSaveResult(result, context, requestContext);
+    } catch (Exception e) {
+      engine.handleFatal(context, requestContext, e);
+    }
+  }
+
+  RequestEventHandlerResult joinFragmentsBodies(RoutingContext context,
+      RequestEvent requestEvent) {
+    final List<Fragment> fragments = context.get("fragments");
+    final String responseBody;
+
+    if (fragments != null) {
+      responseBody = fragments.stream()
+          .map(Fragment::getBody)
+          .collect(Collectors.joining());
+    } else {
+      responseBody = "";
+      LOGGER.warn(MISSING_FRAGMENTS_PAYLOAD);
+    }
     return createSuccessResponse(requestEvent, responseBody);
   }
 

assembler/src/test/java/io/knotx/assembler/FragmentAssemblerHandlerTest.java

@@ -17,6 +17,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.when;
 
 import io.knotx.fragment.Fragment;
 import io.knotx.server.api.context.ClientRequest;
@@ -26,7 +27,10 @@
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.http.HttpHeaders;
 import io.vertx.core.json.JsonObject;
+import io.vertx.reactivex.ext.web.RoutingContext;
 import java.util.Collections;
+import java.util.List;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -38,33 +42,39 @@ public class FragmentAssemblerHandlerTest {
   @Mock
   private ClientRequest clientRequest;
 
+  @Mock
+  private RoutingContext routingContext;
+
   @Test
+  @DisplayName("Expect NO_CONTENT and empty body when no fragments in the routing context")
   public void callAssemblerWithNoFragments_expectNoContentStatus() {
     // given
     FragmentAssemblerHandler assemblerHandler = new FragmentAssemblerHandler();
     RequestEvent requestEvent = new RequestEvent(clientRequest);
 
     // when
-    final RequestEventHandlerResult result = assemblerHandler.handle(requestEvent);
+    RequestEventHandlerResult result = assemblerHandler.joinFragmentsBodies(routingContext, requestEvent);
 
     // then
     assertTrue(result.getRequestEvent().isPresent());
     assertEquals(HttpResponseStatus.NO_CONTENT.code(), result.getStatusCode().intValue());
   }
 
   @Test
+  @DisplayName("Expect OK and fragments body merged to client response body when fragments present in the routing context")
   public void callAssemblerWithFragment_expectAssemblerResultWithBodyAndOkStatus() {
     // given
-    String expectedBody = "<h1>Some text</h1>\n"
-        + "<p>Some text</p>";
+    String expectedBody = "<h1>Some text</h1>\n" + "<p>Some text</p>";
     FragmentAssemblerHandler assemblerHandler = new FragmentAssemblerHandler();
 
-    RequestEvent requestEvent = new RequestEvent(clientRequest,
-        Collections.singletonList(new Fragment("_STATIC", new JsonObject(), expectedBody)),
-        new JsonObject());
+    List<Fragment> fragments = Collections
+        .singletonList(new Fragment("_STATIC", new JsonObject(), expectedBody));
+    when(routingContext.get("fragments")).thenReturn(fragments);
+
+    RequestEvent requestEvent = new RequestEvent(clientRequest, new JsonObject());
 
     // when
-    final RequestEventHandlerResult result = assemblerHandler.handle(requestEvent);
+    RequestEventHandlerResult result = assemblerHandler.joinFragmentsBodies(routingContext, requestEvent);
 
     // then
     assertTrue(result.getRequestEvent().isPresent());

splitter-html/build.gradle.kts

@@ -28,6 +28,7 @@ plugins {
 // -----------------------------------------------------------------------------
 dependencies {
     api(project(":knotx-server-http-api"))
+    api("io.knotx:knotx-fragment-api:${project.version}")
     implementation(group = "org.apache.commons", name = "commons-lang3")
 
     testImplementation(group = "org.mockito", name = "mockito-core")