Added url and headers to ApiHttpResponse

Author: viktor-podzigun

core/src/main/scala/scommons/api/http/ApiHttpClient.scala

@@ -91,7 +91,7 @@ object ApiHttpClient {
       Json.parse(body).validate[R] match {
         case JsSuccess(data, _) => data
         case JsError(error) =>
-          throw ApiHttpStatusException(s"Fail to parse http response, error: $error", url, res.status, body)
+          throw ApiHttpStatusException(s"Fail to parse http response, error: $error", res)
       }
 
     case Some(other) =>
@@ -107,7 +107,7 @@ object ApiHttpClient {
 
       maybeData match {
         case Some(data) => data
-        case None => throw ApiHttpStatusException("Received error response", url, other.status, body)
+        case None => throw ApiHttpStatusException("Received error response", other)
       }
   }
 

core/src/main/scala/scommons/api/http/ApiHttpResponse.scala

@@ -1,3 +1,6 @@
 package scommons.api.http
 
-case class ApiHttpResponse(status: Int, body: String)
+case class ApiHttpResponse(url: String,
+                           status: Int,
+                           headers: Map[String, Seq[String]],
+                           body: String)

core/src/main/scala/scommons/api/http/ApiHttpStatusException.scala

@@ -3,10 +3,8 @@ package scommons.api.http
 import scommons.api.http.ApiHttpStatusException._
 
 case class ApiHttpStatusException(error: String,
-                                  url: String,
-                                  status: Int,
-                                  body: String
-                                 ) extends RuntimeException(buildMessage(error, url, status, body))
+                                  resp: ApiHttpResponse
+                                 ) extends RuntimeException(buildMessage(error, resp.url, resp.status, resp.body))
 
 object ApiHttpStatusException {
 
@@ -15,9 +13,15 @@ object ApiHttpStatusException {
                    status: Int,
                    body: String): String = {
 
+    def printBody: String = {
+      val maxLen = 1024
+      if (body.length > maxLen) s"${body.take(maxLen)}..."
+      else body
+    }
+    
     s"""$error
        |  url: $url
        |  status: $status
-       |  body: $body""".stripMargin
+       |  body: $printBody""".stripMargin
   }
 }

core/src/test/scala/scommons/api/http/ApiHttpClientSpec.scala

@@ -47,7 +47,7 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     //given
     val url = s"/api/get/url"
     val expectedResult = List(TestRespData(1, "test"))
-    val expectedResponse = ApiHttpResponse(200, stringify(toJson(expectedResult)))
+    val expectedResponse = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(expectedResult)))
     val execute = stubExec
     val client = new TestHttpClient(execute)
 
@@ -66,7 +66,7 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     //given
     val url = s"/api/get/url"
     val expectedResult = List(TestRespData(1, "test"))
-    val expectedResponse = ApiHttpResponse(200, stringify(toJson(expectedResult)))
+    val expectedResponse = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(expectedResult)))
     val execute = stubExec
     val client = new TestHttpClient(execute)
 
@@ -86,7 +86,7 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     val url = s"/api/post/url"
     val data = TestReqData(1)
     val expectedResult = List(TestRespData(2, "test"))
-    val expectedResponse = ApiHttpResponse(200, stringify(toJson(expectedResult)))
+    val expectedResponse = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(expectedResult)))
     val execute = stubExec
     val client = new TestHttpClient(execute)
 
@@ -106,7 +106,7 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     val url = s"/api/put/url"
     val data = TestReqData(1)
     val expectedResult = List(TestRespData(2, "test"))
-    val expectedResponse = ApiHttpResponse(200, stringify(toJson(expectedResult)))
+    val expectedResponse = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(expectedResult)))
     val execute = stubExec
     val client = new TestHttpClient(execute)
 
@@ -126,7 +126,7 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     val url = s"/api/delete/url"
     val data = TestReqData(1)
     val expectedResult = List(TestRespData(2, "test"))
-    val expectedResponse = ApiHttpResponse(200, stringify(toJson(expectedResult)))
+    val expectedResponse = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(expectedResult)))
     val execute = stubExec
     val client = new TestHttpClient(execute)
 
@@ -165,20 +165,21 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     val url = s"/some/url"
     val statusCode = 200
     val data = """{"id": 1, "missing": "name"}"""
-    val response = ApiHttpResponse(statusCode, data)
+    val response = ApiHttpResponse(url, statusCode, Map.empty, data)
 
     //when
     val ex = the[ApiHttpStatusException] thrownBy {
       ApiHttpClient.parseResponse[TestRespData](url, Some(response))
     }
 
     //then
-    inside(ex) { case ApiHttpStatusException(error, resUrl, status, body) =>
+    inside(ex) { case ApiHttpStatusException(error, ApiHttpResponse(resUrl, status, resHeaders, body)) =>
       error shouldBe {
         "Fail to parse http response, error: List((/name,List(JsonValidationError(List(error.path.missing),WrappedArray()))))"
       }
       resUrl shouldBe url
       status shouldBe statusCode
+      resHeaders shouldBe Map.empty
       body shouldBe data
     }
 
@@ -194,18 +195,19 @@ class ApiHttpClientSpec extends AsyncFlatSpec
     val url = s"/some/url"
     val statusCode = 400
     val data = "testData"
-    val response = ApiHttpResponse(statusCode, data)
+    val response = ApiHttpResponse(url, statusCode, Map.empty, data)
 
     //when
     val ex = the[ApiHttpStatusException] thrownBy {
       ApiHttpClient.parseResponse[List[TestRespData]](url, Some(response))
     }
 
     //then
-    inside(ex) { case ApiHttpStatusException(error, resUrl, status, body) =>
+    inside(ex) { case ApiHttpStatusException(error, ApiHttpResponse(resUrl, status, resHeaders, body)) =>
       error shouldBe "Received error response"
       resUrl shouldBe url
       status shouldBe statusCode
+      resHeaders shouldBe Map.empty
       body shouldBe data
     }
 
@@ -217,23 +219,25 @@ class ApiHttpClientSpec extends AsyncFlatSpec
 
   it should "parse json for HTTP success response when parseResponse" in {
     //given
+    val url = "/api/url"
     val respData = List(TestRespData(1, "test"))
-    val response = ApiHttpResponse(200, stringify(toJson(respData)))
+    val response = ApiHttpResponse(url, 200, Map.empty, stringify(toJson(respData)))
 
     //when
-    val result = ApiHttpClient.parseResponse[List[TestRespData]](s"/api/url", Some(response))
+    val result = ApiHttpClient.parseResponse[List[TestRespData]](url, Some(response))
 
     //then
     result shouldBe respData
   }
 
   it should "parse json for HTTP failure json response when parseResponse" in {
     //given
+    val url = "/api/url"
     val respData = TestRespData(1, "test")
-    val response = ApiHttpResponse(500, stringify(toJson(respData)))
+    val response = ApiHttpResponse(url, 500, Map.empty, stringify(toJson(respData)))
 
     //when
-    val result = ApiHttpClient.parseResponse[TestRespData](s"/api/url", Some(response))
+    val result = ApiHttpClient.parseResponse[TestRespData](url, Some(response))
 
     //then
     result shouldBe respData

dom/src/main/scala/scommons/api/http/dom/DomApiHttpClient.scala

@@ -1,6 +1,7 @@
 package scommons.api.http.dom
 
 import org.scalajs.dom
+import scommons.api.http.dom.DomApiHttpClient._
 import scommons.api.http.{ApiHttpClient, ApiHttpResponse}
 
 import scala.concurrent.duration._
@@ -19,7 +20,7 @@ class DomApiHttpClient(baseUrl: String, defaultTimeout: FiniteDuration = 30.seco
                              timeout: FiniteDuration): Future[Option[ApiHttpResponse]] = {
 
     val req = createRequest()
-    req.open(method, DomApiHttpClient.getFullUrl(targetUrl, params))
+    req.open(method, getFullUrl(targetUrl, params))
     req.timeout = timeout.toMillis.toInt
 
     val allHeaders = {
@@ -33,7 +34,12 @@ class DomApiHttpClient(baseUrl: String, defaultTimeout: FiniteDuration = 30.seco
 
     execute(req, jsonBody).map {
       case res if res.status == 0 => None //timeout
-      case res => Some(ApiHttpResponse(res.status, res.responseText))
+      case res => Some(ApiHttpResponse(
+        url = targetUrl,
+        status = res.status,
+        headers = parseResponseHeaders(res.getAllResponseHeaders()),
+        body = res.responseText
+      ))
     }
   }
 
@@ -59,6 +65,16 @@ class DomApiHttpClient(baseUrl: String, defaultTimeout: FiniteDuration = 30.seco
 
 object DomApiHttpClient {
 
+  private val headersLineRegex = """[\r\n]+""".r
+  private val headersValueRegex = """: """.r
+  
+  private[dom] def parseResponseHeaders(headers: String): Map[String, Seq[String]] = {
+    headersLineRegex.split(headers.trim).map { line =>
+      val parts = headersValueRegex.pattern.split(line, 2)
+      (parts.head, parts.lastOption.toList)
+    }.toMap
+  }
+
   private[dom] def getFullUrl(url: String, params: List[(String, String)]): String = {
 
     def enc(p: String) = js.URIUtils.encodeURIComponent(p)

dom/src/test/scala/scommons/api/http/dom/DomApiHttpClientSpec.scala

@@ -37,7 +37,7 @@ class DomApiHttpClientSpec extends AsyncFlatSpec
     //given
     val targetUrl = s"$baseUrl/api/get/url"
     val body: Option[String] = None
-    val expectedResult = ApiHttpResponse(200, "some resp body")
+    val expectedResult = ApiHttpResponse(targetUrl, 200, Map("test" -> Seq("test value")), "some resp body")
     val req = stub[MockXMLHttpRequest]
     val resp = stub[MockXMLHttpRequest]
     val client = new TestDomClient(req, resp)
@@ -46,6 +46,7 @@ class DomApiHttpClientSpec extends AsyncFlatSpec
     (req.timeout_= _).when(*).returns(())
     (req.setRequestHeader _).when(*, *).returns(())
     (resp.status _).when().returns(expectedResult.status)
+    (resp.getAllResponseHeaders _).when().returns("test: test value\r\n")
     (resp.responseText _).when().returns(expectedResult.body)
 
     //when
@@ -65,7 +66,7 @@ class DomApiHttpClientSpec extends AsyncFlatSpec
     //given
     val targetUrl = s"$baseUrl/api/post/url"
     val body = Some("some req data")
-    val expectedResult = ApiHttpResponse(200, "some resp body")
+    val expectedResult = ApiHttpResponse(targetUrl, 200, Map("test" -> Seq("test value")), "some resp body")
     val req = stub[MockXMLHttpRequest]
     val resp = stub[MockXMLHttpRequest]
     val client = new TestDomClient(req, resp)
@@ -74,6 +75,7 @@ class DomApiHttpClientSpec extends AsyncFlatSpec
     (req.timeout_= _).when(*).returns(())
     (req.setRequestHeader _).when(*, *).returns(())
     (resp.status _).when().returns(expectedResult.status)
+    (resp.getAllResponseHeaders _).when().returns("test: test value\r\n")
     (resp.responseText _).when().returns(expectedResult.body)
 
     //when
@@ -144,6 +146,8 @@ object DomApiHttpClientSpec {
 
     def status: Int
 
+    def getAllResponseHeaders(): String
+
     def responseText: String
   }
 }

play-ws/src/main/scala/scommons/api/http/ws/WsApiHttpClient.scala

@@ -3,7 +3,7 @@ package scommons.api.http.ws
 import java.util.concurrent.TimeoutException
 
 import akka.actor.ActorSystem
-import akka.stream.ActorMaterializer
+import akka.stream.{ActorMaterializer, Materializer}
 import akka.util.ByteString
 import play.api.libs.ws.ahc.StandaloneAhcWSClient
 import play.api.libs.ws.{BodyWritable, InMemoryBody, StandaloneWSRequest, StandaloneWSResponse}
@@ -18,7 +18,7 @@ class WsApiHttpClient(baseUrl: String,
   extends ApiHttpClient(baseUrl, defaultTimeout)(system.dispatcher) {
 
   private implicit val ec: ExecutionContext = system.dispatcher
-  private implicit val materializer = ActorMaterializer()
+  private implicit val materializer: Materializer = ActorMaterializer()
 
   private[ws] val ws = StandaloneAhcWSClient()
 
@@ -45,7 +45,7 @@ class WsApiHttpClient(baseUrl: String,
       .withHttpHeaders(headers: _*)
       .withRequestTimeout(timeout)
     ).map { resp =>
-      Some(ApiHttpResponse(resp.status, resp.body))
+      Some(ApiHttpResponse(targetUrl, resp.status, resp.headers, resp.body))
     }.recover {
       case _: TimeoutException => None
     }

play-ws/src/test/scala/scommons/api/http/ws/WsApiHttpClientSpec.scala

@@ -55,6 +55,10 @@ class WsApiHttpClientSpec extends FlatSpec
     reset(client, response)
   }
 
+  override protected def afterEach(): Unit = {
+    verifyNoMoreInteractions(response)
+  }
+
   override protected def afterAll(): Unit = {
     reset(client.ws)
 
@@ -67,8 +71,10 @@ class WsApiHttpClientSpec extends FlatSpec
     //given
     val targetUrl = s"$baseUrl/api/get/url"
     val body: Option[String] = None
-    val expectedResult = ApiHttpResponse(200, "some resp body")
+    val respHeaders = Map("test" -> Seq("test value"))
+    val expectedResult = ApiHttpResponse(targetUrl, 200, respHeaders, "some resp body")
     when(response.status).thenReturn(expectedResult.status)
+    when(response.headers).thenReturn(respHeaders)
     when(response.body).thenReturn(expectedResult.body)
 
     //when
@@ -78,14 +84,21 @@ class WsApiHttpClientSpec extends FlatSpec
     result shouldBe Some(expectedResult)
 
     assertRequest("GET", targetUrl, params, headers, body, timeout)
+
+    verify(response).status
+    verify(response).headers
+    verify(response).body
+    verifyNoMoreInteractions(response)
   }
 
   it should "execute request with body" in {
     //given
     val targetUrl = s"$baseUrl/api/post/url"
     val body = Some("some req data")
-    val expectedResult = ApiHttpResponse(200, "some resp body")
+    val respHeaders = Map("test" -> Seq("test value"))
+    val expectedResult = ApiHttpResponse(targetUrl, 200, respHeaders, "some resp body")
     when(response.status).thenReturn(expectedResult.status)
+    when(response.headers).thenReturn(respHeaders)
     when(response.body).thenReturn(expectedResult.body)
 
     //when
@@ -95,6 +108,11 @@ class WsApiHttpClientSpec extends FlatSpec
     result shouldBe Some(expectedResult)
 
     assertRequest("POST", targetUrl, params, headers, body, timeout)
+
+    verify(response).status
+    verify(response).headers
+    verify(response).body
+    verifyNoMoreInteractions(response)
   }
 
   it should "return None if timed out when execute request" in {
@@ -111,6 +129,8 @@ class WsApiHttpClientSpec extends FlatSpec
     result shouldBe None
 
     assertRequest("GET", targetUrl, params, headers, None, timeout)
+
+    verifyZeroInteractions(response)
   }
 
   private def assertRequest(method: String,