BDOG-1421 Rename HttpClientImpl to PlayHttpClient

hmrc · Sep 29, 2021 · 08e685d · 08e685d
1 parent cd6fb44
commit 08e685d
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@
 | `withUserAgent` added | Minor | Optional change |
 | `withTransformRequest` added | Minor | Optional change |
 
-For the following changes, it is expected that you will be using the `uk.gov.hmrc.HttpClientImpl` implementation of `HttpClient` (which should be provided by bootstrap-play). They may not be supported on custom implementations of `HttpClient`.
+For the following changes, it is expected that you will be using the `uk.gov.hmrc.PlayHttpClient` implementation of `HttpClient` (which should be provided by bootstrap-play). They may not be supported on custom implementations of `HttpClient`.
 
 ### WSProxy
 

diff --git a/http-verbs-common/src/main/scala/uk/gov/hmrc/http/HttpClient.scala b/http-verbs-common/src/main/scala/uk/gov/hmrc/http/HttpClient.scala
@@ -17,36 +17,16 @@
 package uk.gov.hmrc.http
 
 import play.api.libs.ws.{WSRequest => PlayWSRequest}
-import uk.gov.hmrc.play.http.ws.WSProxyConfiguration
 
 trait HttpClient extends HttpGet with HttpPut with HttpPost with HttpDelete with HttpPatch {
-
-  // we could remove the dependency on PlayWsRequest (which should be in the play package only)
-  // by using `type Request`, which HttpClientImpl can fix to PlayWsRequest,
-  // however it would require all implementations to fix it (breaking clients)
-  // the default implementations here all depend on concrete PlayWSRequest...
-
-  private def replaceHeader(req: PlayWSRequest, header: (String, String)): PlayWSRequest = {
-    def denormalise(hdrs: Map[String, Seq[String]]): Seq[(String, String)] =
-      hdrs.toList.flatMap { case (k, vs) => vs.map(k -> _) }
-    val hdrsWithoutKey = req.headers.filterKeys(!_.equalsIgnoreCase(header._1)) // replace existing header
-    req.withHttpHeaders(denormalise(hdrsWithoutKey) :+ header : _*)
-  }
-
+  // implementations provided to not break clients (which won't be using the new functions)
+  // e.g. implementations of ProxyHttpClient, and the deprecated DefaultHttpClient in bootstrap.
   def withUserAgent(userAgent: String): HttpClient =
-    withTransformRequest { req =>
-      replaceHeader(req, "User-Agent" -> userAgent)
-    }
+    sys.error("Not implemented by your implementation of HttpClient. You can use uk.gov.hmrc.http.PlayHttpClient")
 
-  def withProxy: HttpClient = {
-    val optProxyServer = WSProxyConfiguration.buildWsProxyServer(configuration)
-    withTransformRequest { req =>
-      optProxyServer.foldLeft(req)(_ withProxyServer _)
-    }
-  }
+  def withProxy: HttpClient =
+    sys.error("Not implemented by your implementation of HttpClient. You can use uk.gov.hmrc.http.PlayHttpClient")
 
-  // implementation required to not break clients (which won't be using the new functions)
-  // e.g. implementations of ProxyHttpClient, and the deprecated DefaultHttpClient in bootstrap.
   def withTransformRequest(transform: PlayWSRequest => PlayWSRequest): HttpClient =
-    sys.error("Your implementation of HttpClient does not implement `withTransformRequest`. You can use uk.gov.hmrc.http.HttpClientImpl")
+    sys.error("Your implementation of HttpClient does not implement `withTransformRequest`. You can use uk.gov.hmrc.http.PlayHttpClient")
 }
diff --git a/...k/gov/hmrc/play/http/HttpClientImpl.scala → ...k/gov/hmrc/play/http/PlayHttpClient.scala b/...k/gov/hmrc/play/http/HttpClientImpl.scala → ...k/gov/hmrc/play/http/PlayHttpClient.scala
@@ -24,7 +24,7 @@ import uk.gov.hmrc.http.hooks.HttpHook
 import uk.gov.hmrc.play.http.ws._
 
 // class is final, since any overrides would be lost in the result of `withPlayWSRequest`
-final class HttpClientImpl (
+final class PlayHttpClient (
   override val configuration   : Config,
   override val hooks           : Seq[HttpHook],
   override val wsClient        : WSClient,
@@ -33,12 +33,31 @@ final class HttpClientImpl (
 ) extends HttpClient
      with WSHttp {
 
-  override def withTransformRequest(transformRequest: PlayWSRequest => PlayWSRequest): HttpClientImpl =
-    new HttpClientImpl(
+  override def withTransformRequest(transformRequest: PlayWSRequest => PlayWSRequest): PlayHttpClient =
+    new PlayHttpClient(
       this.configuration,
       this.hooks,
       this.wsClient,
       this.actorSystem,
       this.transformRequest.andThen(transformRequest)
     )
+
+  private def replaceHeader(req: PlayWSRequest, header: (String, String)): PlayWSRequest = {
+    def denormalise(hdrs: Map[String, Seq[String]]): Seq[(String, String)] =
+      hdrs.toList.flatMap { case (k, vs) => vs.map(k -> _) }
+    val hdrsWithoutKey = req.headers.filterKeys(!_.equalsIgnoreCase(header._1)) // replace existing header
+    req.withHttpHeaders(denormalise(hdrsWithoutKey) :+ header : _*)
+  }
+
+  override def withUserAgent(userAgent: String): HttpClient =
+    withTransformRequest { req =>
+      replaceHeader(req, "User-Agent" -> userAgent)
+    }
+
+  override def withProxy: HttpClient = {
+    val optProxyServer = WSProxyConfiguration.buildWsProxyServer(configuration)
+    withTransformRequest { req =>
+      optProxyServer.foldLeft(req)(_ withProxyServer _)
+    }
+  }
 }
diff --git a/http-verbs-common/src/test/scala/uk/gov/hmrc/http/HeadersSpec.scala b/http-verbs-common/src/test/scala/uk/gov/hmrc/http/HeadersSpec.scala
@@ -28,7 +28,7 @@ import play.api.inject.guice.GuiceApplicationBuilder
 import play.api.libs.json.{JsValue, Json}
 import play.api.libs.ws.WSClient
 import uk.gov.hmrc.http.test.WireMockSupport
-import uk.gov.hmrc.play.http.HttpClientImpl
+import uk.gov.hmrc.play.http.PlayHttpClient
 
 import scala.concurrent.ExecutionContext.Implicits.global
 import uk.gov.hmrc.http.HttpReads.Implicits._
@@ -51,7 +51,7 @@ class HeadersSpec
   ).withExtraHeaders("extra-header" -> "my-extra-header")
 
   private lazy val httpClient =
-    new HttpClientImpl(
+    new PlayHttpClient(
       configuration    = app.configuration.underlying,
       hooks            = Seq.empty,
       wsClient         = app.injector.instanceOf[WSClient],

diff --git a/...v/hmrc/play/http/HttpClientImplSpec.scala → ...v/hmrc/play/http/PlayHttpClientSpec.scala b/...v/hmrc/play/http/HttpClientImplSpec.scala → ...v/hmrc/play/http/PlayHttpClientSpec.scala
@@ -34,7 +34,7 @@ import java.util.concurrent.atomic.AtomicReference
 import scala.concurrent.ExecutionContext.Implicits.global
 import uk.gov.hmrc.http.HttpReads.Implicits._
 
-class HttpClientImplSpec
+class PlayHttpClientSpec
   extends AnyWordSpecLike
      with Matchers
      with OptionValues
@@ -46,9 +46,9 @@ class HttpClientImplSpec
     HeaderCarrier(extraHeaders = Seq("x-test" -> "test-val"))
 
   WsTestClient.withClient { wsClient =>
-    "HttpClientImpl.withUserAgent" should {
+    "PlayHttpClient.withUserAgent" should {
       val httpClient =
-        new HttpClientImpl(
+        new PlayHttpClient(
           configuration    = ConfigFactory.parseString("appName=myApp")
                               .withFallback(ConfigFactory.load()),
           hooks            = Seq.empty,
@@ -78,7 +78,7 @@ class HttpClientImplSpec
       }
     }
 
-    "HttpClientImpl.withProxy" should {
+    "PlayHttpClient.withProxy" should {
       val proxyProtocol = "http"
       val proxyHost     = "proxy.com"
       val proxyPort     = PortFinder.findFreePort(portRange = 6001 to 7000, excluded = wireMockPort)
@@ -88,7 +88,7 @@ class HttpClientImplSpec
       val proxyRef = new AtomicReference[Option[WSProxyServer]]
 
       val httpClient =
-        new HttpClientImpl(
+        new PlayHttpClient(
           configuration    = ConfigFactory
                                .parseString(
                                  s"""|proxy.enabled=true

diff --git a/http-verbs-test-common/src/main/scala/uk/gov/hmrc/http/test/HttpClientSupport.scala b/http-verbs-test-common/src/main/scala/uk/gov/hmrc/http/test/HttpClientSupport.scala
@@ -21,7 +21,7 @@ import akka.stream.{ActorMaterializer, Materializer}
 import com.github.ghik.silencer.silent
 import com.typesafe.config.{Config, ConfigFactory}
 import uk.gov.hmrc.http.HttpClient
-import uk.gov.hmrc.play.http.HttpClientImpl
+import uk.gov.hmrc.play.http.PlayHttpClient
 import play.api.libs.ws.ahc.{AhcWSClient, AhcWSClientConfigFactory}
 
 trait HttpClientSupport {
@@ -33,7 +33,7 @@ trait HttpClientSupport {
     @silent("deprecated")
     implicit val mat: Materializer = ActorMaterializer() // explicitly required for play-26
 
-    new HttpClientImpl(
+    new PlayHttpClient(
       configuration    = config,
       hooks            = Seq.empty,
       wsClient         = AhcWSClient(AhcWSClientConfigFactory.forConfig(config)),