Bugfix: response header not reflecting correct version of http #1689 (#…

…1890)

* change to be reverted

* remove http protocol hardcoded value in Response.java

* revert readme change

* format the files

* handle review comments

Co-authored-by: poojitha <poojitha.dubba@thoughtworks.com>

src/main/java/com/github/tomakehurst/wiremock/extension/requestfilter/RequestWrapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2021 Thomas Akehurst
+ * Copyright (C) 2018-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -279,6 +279,11 @@ public Optional<Request> getOriginalRequest() {
     return delegate.getOriginalRequest();
   }
 
+  @Override
+  public String getProtocol() {
+    return delegate.getProtocol();
+  }
+
   public static class Builder {
 
     private RequestMethod requestMethod;

src/main/java/com/github/tomakehurst/wiremock/http/AbstractRequestHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011-2021 Thomas Akehurst
+ * Copyright (C) 2011-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,6 +72,7 @@ public void handle(Request request, HttpResponder httpResponder) {
     ResponseDefinition responseDefinition = serveEvent.getResponseDefinition();
     responseDefinition.setOriginalRequest(processedRequest);
     Response response = responseRenderer.render(serveEvent);
+    response = Response.Builder.like(response).protocol(request.getProtocol()).build();
     ServeEvent completedServeEvent =
         serveEvent.complete(response, (int) stopwatch.elapsed(MILLISECONDS));
 

src/main/java/com/github/tomakehurst/wiremock/http/Request.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011-2021 Thomas Akehurst
+ * Copyright (C) 2011-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,4 +77,6 @@ interface Part {
   boolean isBrowserProxyRequest();
 
   Optional<Request> getOriginalRequest();
+
+  String getProtocol();
 }

src/main/java/com/github/tomakehurst/wiremock/http/Response.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011-2021 Thomas Akehurst
+ * Copyright (C) 2011-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,10 +39,11 @@ public class Response {
   private final boolean fromProxy;
   private final long initialDelay;
   private final ChunkedDribbleDelay chunkedDribbleDelay;
+  private final String protocol;
 
   public static Response notConfigured() {
     return new Response(
-        HTTP_NOT_FOUND, null, (byte[]) null, noHeaders(), false, null, 0, null, false);
+        HTTP_NOT_FOUND, null, (byte[]) null, noHeaders(), false, null, 0, null, false, null);
   }
 
   public static Builder response() {
@@ -58,7 +59,8 @@ public Response(
       Fault fault,
       long initialDelay,
       ChunkedDribbleDelay chunkedDribbleDelay,
-      boolean fromProxy) {
+      boolean fromProxy,
+      String protocol) {
     this.status = status;
     this.statusMessage = statusMessage;
     this.bodyStreamSource = StreamSources.forBytes(body);
@@ -68,6 +70,7 @@ public Response(
     this.initialDelay = initialDelay;
     this.chunkedDribbleDelay = chunkedDribbleDelay;
     this.fromProxy = fromProxy;
+    this.protocol = protocol;
   }
 
   public Response(
@@ -79,7 +82,8 @@ public Response(
       Fault fault,
       long initialDelay,
       ChunkedDribbleDelay chunkedDribbleDelay,
-      boolean fromProxy) {
+      boolean fromProxy,
+      String protocol) {
     this.status = status;
     this.statusMessage = statusMessage;
     this.bodyStreamSource = streamSource;
@@ -89,6 +93,7 @@ public Response(
     this.initialDelay = initialDelay;
     this.chunkedDribbleDelay = chunkedDribbleDelay;
     this.fromProxy = fromProxy;
+    this.protocol = protocol;
   }
 
   public Response(
@@ -100,7 +105,8 @@ public Response(
       Fault fault,
       long initialDelay,
       ChunkedDribbleDelay chunkedDribbleDelay,
-      boolean fromProxy) {
+      boolean fromProxy,
+      String protocol) {
     this.status = status;
     this.statusMessage = statusMessage;
     this.headers = headers;
@@ -110,6 +116,7 @@ public Response(
     this.initialDelay = initialDelay;
     this.chunkedDribbleDelay = chunkedDribbleDelay;
     this.fromProxy = fromProxy;
+    this.protocol = protocol;
   }
 
   public int getStatus() {
@@ -170,11 +177,7 @@ public boolean isFromProxy() {
 
   @Override
   public String toString() {
-    StringBuilder sb = new StringBuilder();
-    sb.append("HTTP/1.1 ").append(status).append("\n");
-    sb.append(headers).append("\n");
-    // no longer printing body
-    return sb.toString();
+    return protocol + " " + status + "\n" + headers;
   }
 
   public static class Builder {
@@ -189,6 +192,7 @@ public static class Builder {
     private boolean fromProxy;
     private long initialDelay;
     private ChunkedDribbleDelay chunkedDribbleDelay;
+    private String protocol;
 
     public static Builder like(Response response) {
       Builder responseBuilder = new Builder();
@@ -320,7 +324,8 @@ public Response build() {
             fault,
             initialDelay,
             chunkedDribbleDelay,
-            fromProxy);
+            fromProxy,
+            protocol);
       } else if (bodyString != null) {
         return new Response(
             status,
@@ -331,7 +336,8 @@ public Response build() {
             fault,
             initialDelay,
             chunkedDribbleDelay,
-            fromProxy);
+            fromProxy,
+            protocol);
       } else if (bodyStream != null) {
         return new Response(
             status,
@@ -342,7 +348,8 @@ public Response build() {
             fault,
             initialDelay,
             chunkedDribbleDelay,
-            fromProxy);
+            fromProxy,
+            protocol);
       } else {
         return new Response(
             status,
@@ -353,8 +360,14 @@ public Response build() {
             fault,
             initialDelay,
             chunkedDribbleDelay,
-            fromProxy);
+            fromProxy,
+            protocol);
       }
     }
+
+    public Builder protocol(final String protocol) {
+      this.protocol = protocol;
+      return this;
+    }
   }
 }

src/main/java/com/github/tomakehurst/wiremock/servlet/WireMockHttpServletRequestAdapter.java

@@ -326,4 +326,9 @@ public Optional<Request> getOriginalRequest() {
   public String toString() {
     return request.toString() + getBodyAsString();
   }
+
+  @Override
+  public String getProtocol() {
+    return request.getProtocol();
+  }
 }

src/main/java/com/github/tomakehurst/wiremock/verification/LoggedRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011-2021 Thomas Akehurst
+ * Copyright (C) 2011-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,6 +56,7 @@ public class LoggedRequest implements Request {
   private final boolean isBrowserProxyRequest;
   private final Date loggedDate;
   private final Collection<Part> multiparts;
+  private final String protocol;
 
   public static LoggedRequest createFrom(Request request) {
     return new LoggedRequest(
@@ -68,7 +69,8 @@ public static LoggedRequest createFrom(Request request) {
         request.isBrowserProxyRequest(),
         new Date(),
         request.getBody(),
-        request.getParts());
+        request.getParts(),
+        request.getProtocol());
   }
 
   @JsonCreator
@@ -83,7 +85,8 @@ public LoggedRequest(
       @JsonProperty("loggedDate") Date loggedDate,
       @JsonProperty("bodyAsBase64") String bodyAsBase64,
       @JsonProperty("body") String ignoredBodyOnlyUsedForBinding,
-      @JsonProperty("multiparts") Collection<Part> multiparts) {
+      @JsonProperty("multiparts") Collection<Part> multiparts,
+      @JsonProperty("protocol") String protocol) {
     this(
         url,
         absoluteUrl,
@@ -94,7 +97,8 @@ public LoggedRequest(
         isBrowserProxyRequest,
         loggedDate,
         decodeBase64(bodyAsBase64),
-        multiparts);
+        multiparts,
+        protocol);
   }
 
   public LoggedRequest(
@@ -107,7 +111,8 @@ public LoggedRequest(
       boolean isBrowserProxyRequest,
       Date loggedDate,
       byte[] body,
-      Collection<Part> multiparts) {
+      Collection<Part> multiparts,
+      String protocol) {
     this.url = url;
 
     this.absoluteUrl = absoluteUrl;
@@ -131,6 +136,7 @@ public LoggedRequest(
     this.isBrowserProxyRequest = isBrowserProxyRequest;
     this.loggedDate = loggedDate;
     this.multiparts = multiparts;
+    this.protocol = protocol;
   }
 
   @Override
@@ -258,6 +264,11 @@ public Optional<Request> getOriginalRequest() {
     return Optional.absent();
   }
 
+  @Override
+  public String getProtocol() {
+    return protocol;
+  }
+
   public Date getLoggedDate() {
     return loggedDate;
   }

src/main/java/com/github/tomakehurst/wiremock/verification/diff/EmptyToStringRequestWrapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2021 Thomas Akehurst
+ * Copyright (C) 2018-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -144,6 +144,11 @@ public Optional<Request> getOriginalRequest() {
     return target.getOriginalRequest();
   }
 
+  @Override
+  public String getProtocol() {
+    return target.getProtocol();
+  }
+
   @Override
   public String toString() {
     return " ";

src/test/java/com/github/tomakehurst/wiremock/http/ProxyResponseRendererTest.java

@@ -231,7 +231,8 @@ private ServeEvent serveEvent(String path, boolean isBrowserProxyRequest, byte[]
             /* isBrowserProxyRequest = */ isBrowserProxyRequest,
             /* loggedDate = */ new Date(),
             /* body = */ body,
-            /* multiparts = */ null);
+            /* multiparts = */ null,
+            /* protocol = */ "HTTP/1.1");
     ResponseDefinition responseDefinition = aResponse().proxiedFrom(origin.baseUrl()).build();
     responseDefinition.setOriginalRequest(loggedRequest);
 

src/test/java/com/github/tomakehurst/wiremock/matching/MockRequest.java

@@ -48,6 +48,7 @@ public class MockRequest implements Request {
   private String clientIp = "1.1.1.1";
   private Collection<Part> multiparts = null;
   private boolean isBrowserProxyRequest = false;
+  private String protocol = "HTTP/1.1";
 
   public static MockRequest mockRequest() {
     return new MockRequest();
@@ -122,6 +123,11 @@ public MockRequest isBrowserProxyRequest(boolean isBrowserProxyRequest) {
     return this;
   }
 
+  public MockRequest protocol(String protocol) {
+    this.protocol = protocol;
+    return this;
+  }
+
   @Override
   public String getUrl() {
     return url;
@@ -230,6 +236,11 @@ public Optional<Request> getOriginalRequest() {
     return Optional.absent();
   }
 
+  @Override
+  public String getProtocol() {
+    return protocol;
+  }
+
   public LoggedRequest asLoggedRequest() {
     return LoggedRequest.createFrom(this);
   }

src/test/java/com/github/tomakehurst/wiremock/stubbing/StubRequestHandlerTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011-2021 Thomas Akehurst
+ * Copyright (C) 2011-2022 Thomas Akehurst
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -75,17 +75,30 @@ public void returnsResponseIndicatedByMappings() {
     when(stubServer.serveStubFor(any(Request.class)))
         .thenReturn(
             ServeEvent.of(
-                mockRequest().asLoggedRequest(), new ResponseDefinition(200, "Body content")));
-
-    Response mockResponse = response().status(200).body("Body content").build();
+                mockRequest().protocol("HTTP/2").asLoggedRequest(),
+                new ResponseDefinition(200, "Body content")));
+
+    Response mockResponse =
+        response()
+            .status(200)
+            .body("Body content")
+            .headers(
+                new HttpHeaders(
+                    new HttpHeader("Content-Type", "application/json"),
+                    new HttpHeader("Matched-Stub-Id", "123")))
+            .build();
     when(responseRenderer.render(any(ServeEvent.class))).thenReturn(mockResponse);
 
-    Request request = aRequest().withUrl("/the/required/resource").withMethod(GET).build();
+    Request request =
+        aRequest().withUrl("/the/required/resource").withMethod(GET).withProtocol("HTTP/2").build();
     requestHandler.handle(request, httpResponder);
     Response response = httpResponder.response;
 
     assertThat(response.getStatus(), is(200));
     assertThat(response.getBodyAsString(), is("Body content"));
+    assertThat(
+        response.toString(),
+        is("HTTP/2 200\nContent-Type: [application/json]\nMatched-Stub-Id: [123]\n"));
   }
 
   @Test