DLS-10979: HttpClientV2 upgrade for help-to-save-api.

vamsikrishnapujari · vamsikrishnapujari · commit 0a83092610d5 · 2024-10-22T13:21:05.000+01:00
diff --git a/app/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnector.scala b/app/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnector.scala
@@ -20,11 +20,12 @@ import com.google.inject.{ImplementedBy, Inject, Singleton}
 import play.api.Configuration
 import play.api.libs.json.{Json, Writes}
 import uk.gov.hmrc.helptosaveapi.connectors.HelpToSaveConnectorImpl.CreateAccountInfo
-import uk.gov.hmrc.helptosaveapi.http.HttpClient.HttpClientOps
 import uk.gov.hmrc.helptosaveapi.models.ValidateBankDetailsRequest
 import uk.gov.hmrc.helptosaveapi.models.createaccount.CreateAccountBody
 import uk.gov.hmrc.helptosaveapi.util.Logging
-import uk.gov.hmrc.http._
+import uk.gov.hmrc.http.{HeaderCarrier, HttpResponse, StringContextOps}
+import uk.gov.hmrc.http.HttpReads.Implicits._
+import uk.gov.hmrc.http.client.HttpClientV2
 
 import java.util.UUID
 import scala.concurrent.{ExecutionContext, Future}
@@ -63,7 +64,7 @@ trait HelpToSaveConnector {
 }
 
 @Singleton
-class HelpToSaveConnectorImpl @Inject() (config: Configuration, http: HttpClient)()
+class HelpToSaveConnectorImpl @Inject() (config: Configuration, http: HttpClientV2)()
     extends HelpToSaveConnector with Logging {
 
   private val htsBaseUrl = {
@@ -73,13 +74,13 @@ class HelpToSaveConnectorImpl @Inject() (config: Configuration, http: HttpClient
     s"$protocol://$host:$port/help-to-save"
   }
 
-  val createAccountUrl: String = s"$htsBaseUrl/create-account"
+  private val createAccountUrl: String = s"$htsBaseUrl/create-account"
 
   private val storeEmailURL = s"$htsBaseUrl/store-email"
 
   private val getEnrolmentStatusURL = s"$htsBaseUrl/enrolment-status"
 
-  val eligibilityCheckUrl: String = s"$htsBaseUrl/eligibility-check"
+  private val eligibilityCheckUrl: String = s"$htsBaseUrl/eligibility-check"
 
   def getAccountUrl(nino: String): String = s"$htsBaseUrl/$nino/account"
 
@@ -88,49 +89,66 @@ class HelpToSaveConnectorImpl @Inject() (config: Configuration, http: HttpClient
   override def createAccount(body: CreateAccountBody, correlationId: UUID, clientCode: String, eligibilityReason: Int)(
     implicit hc: HeaderCarrier,
     ec: ExecutionContext
-  ): Future[HttpResponse] =
-    http.post(
-      createAccountUrl,
-      CreateAccountInfo(body, eligibilityReason, clientCode),
-      Map(correlationIdHeaderName -> correlationId.toString)
-    )
+  ): Future[HttpResponse]= {
+    val reqBody = CreateAccountInfo(body, eligibilityReason, clientCode)
+    val headers: (String, String) = s"$correlationIdHeaderName" -> s"$correlationId"
+    http
+      .post(url"$createAccountUrl")
+      .transform(_.addHttpHeaders(headers))
+      .withBody(Json.toJson(reqBody))
+      .execute[HttpResponse]
+  }
 
   override def checkEligibility(
     nino: String,
     correlationId: UUID
-  )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
-    http.get(eligibilityCheckUrl, Map("nino" -> nino), Map(correlationIdHeaderName -> correlationId.toString))
+  )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] = {
+    val headers: (String, String) = s"$correlationIdHeaderName" -> s"$correlationId"
+    http.get(url"$eligibilityCheckUrl?nino=$nino").transform(_.addHttpHeaders(headers)).execute[HttpResponse]
+  }
 
   override def getAccount(nino: String, systemId: String, correlationId: UUID)(
     implicit hc: HeaderCarrier,
     ec: ExecutionContext
-  ): Future[HttpResponse] =
-    http.get(
-      getAccountUrl(nino),
-      Map("systemId"              -> systemId, "correlationId" -> correlationId.toString),
-      Map(correlationIdHeaderName -> correlationId.toString)
-    )
+  ): Future[HttpResponse] = {
+    val url = getAccountUrl(nino)
+    val headers: (String, String) = s"$correlationIdHeaderName" -> s"$correlationId"
+    val result = http
+      .get(url"$url")
+      .transform(_.addHttpHeaders(headers))
+      .execute[HttpResponse]
+    result
+  }
 
   override def storeEmail(encodedEmail: String, nino: String, correlationId: UUID)(
     implicit hc: HeaderCarrier,
     ec: ExecutionContext
-  ): Future[HttpResponse] =
-    http.get(
-      storeEmailURL,
-      Map("email"                 -> encodedEmail, "nino" -> nino),
-      Map(correlationIdHeaderName -> correlationId.toString)
-    )
+  ): Future[HttpResponse] = {
+    val headers: (String, String) = s"$correlationIdHeaderName" -> s"$correlationId"
+    http
+      .get(url"$storeEmailURL?email=$encodedEmail&nino=$nino")
+      .transform(_.addHttpHeaders(headers))
+      .execute[HttpResponse]
+  }
 
   override def validateBankDetails(
     request: ValidateBankDetailsRequest
   )(implicit hc: HeaderCarrier, ex: ExecutionContext): Future[HttpResponse] =
-    http.post(s"$htsBaseUrl/validate-bank-details", request)
+    http
+      .post(url"$htsBaseUrl/validate-bank-details")
+      .withBody(Json.toJson(request))
+      .execute[HttpResponse]
 
   override def getUserEnrolmentStatus(
     nino: String,
     correlationId: UUID
-  )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
-    http.get(getEnrolmentStatusURL, Map("nino" -> nino), Map(correlationIdHeaderName -> correlationId.toString))
+  )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] = {
+    val headers: (String, String) = s"$correlationIdHeaderName" -> s"$correlationId"
+    http
+      .get(url"$getEnrolmentStatusURL?nino=$nino")
+      .transform(_.addHttpHeaders(headers))
+      .execute[HttpResponse]
+  }
 }
 
 object HelpToSaveConnectorImpl {
diff --git a/app/uk/gov/hmrc/helptosaveapi/http/HttpClient.scala b/app/uk/gov/hmrc/helptosaveapi/http/HttpClient.scala
@@ -14,37 +14,53 @@
  * limitations under the License.
  */
 
-package uk.gov.hmrc.helptosaveapi.http
-
-import play.api.libs.json.Writes
-import uk.gov.hmrc.http._
-
-import scala.concurrent.{ExecutionContext, Future}
-
-object HttpClient {
-
-  // this HttpReads instance for HttpResponse is preferred over the default
-  // uk.gov.hmrc.http.RawReads.readRaw as this custom one doesn't throw exceptions
-  private class RawHttpReads extends HttpReads[HttpResponse] {
-    override def read(method: String, url: String, response: HttpResponse): HttpResponse = response
-  }
-
-  private val rawHttpReads = new RawHttpReads
-
-  implicit class HttpClientOps(val http: HttpClient) extends AnyVal {
-    def get(
-      url: String,
-      queryParams: Map[String, String] = Map.empty[String, String],
-      headers: Map[String, String] = Map.empty[String, String]
-    )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
-      http.GET(url, queryParams.toSeq)(rawHttpReads, hc.withExtraHeaders(headers.toSeq: _*), ec)
-
-    def post[A](
-      url: String,
-      body: A,
-      headers: Map[String, String] = Map.empty[String, String]
-    )(implicit w: Writes[A], hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
-      http.POST(url, body, headers.toSeq)(w, rawHttpReads, hc, ec)
-  }
-
-}
+///*
+// * Copyright 2024 HM Revenue & Customs
+// *
+// * Licensed under the Apache License, Version 2.0 (the "License");
+// * you may not use this file except in compliance with the License.
+// * You may obtain a copy of the License at
+// *
+// *     http://www.apache.org/licenses/LICENSE-2.0
+// *
+// * Unless required by applicable law or agreed to in writing, software
+// * distributed under the License is distributed on an "AS IS" BASIS,
+// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// * See the License for the specific language governing permissions and
+// * limitations under the License.
+// */
+//
+//package uk.gov.hmrc.helptosaveapi.http
+//
+//import play.api.libs.json.Writes
+//import uk.gov.hmrc.http._
+//
+//import scala.concurrent.{ExecutionContext, Future}
+//
+//object HttpClient {
+//
+//  // this HttpReads instance for HttpResponse is preferred over the default
+//  // uk.gov.hmrc.http.RawReads.readRaw as this custom one doesn't throw exceptions
+//  private class RawHttpReads extends HttpReads[HttpResponse] {
+//    override def read(method: String, url: String, response: HttpResponse): HttpResponse = response
+//  }
+//
+//  private val rawHttpReads = new RawHttpReads
+//
+//  implicit class HttpClientOps(val http: HttpClient) extends AnyVal {
+//    def get(
+//      url: String,
+//      queryParams: Map[String, String] = Map.empty[String, String],
+//      headers: Map[String, String] = Map.empty[String, String]
+//    )(implicit hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
+//      http.GET(url, queryParams.toSeq)(rawHttpReads, hc.withExtraHeaders(headers.toSeq: _*), ec)
+//
+//    def post[A](
+//      url: String,
+//      body: A,
+//      headers: Map[String, String] = Map.empty[String, String]
+//    )(implicit w: Writes[A], hc: HeaderCarrier, ec: ExecutionContext): Future[HttpResponse] =
+//      http.POST(url, body, headers.toSeq)(w, rawHttpReads, hc, ec)
+//  }
+//
+//}
diff --git a/conf/application-json-logger.xml b/conf/application-json-logger.xml
diff --git a/conf/application.conf b/conf/application.conf
@@ -23,7 +23,9 @@ play.filters.enabled += "play.filters.headers.SecurityHeadersFilter"
 
 play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuthModule"
 
-play.modules.enabled += "uk.gov.hmrc.play.bootstrap.HttpClientModule"
+#play.modules.enabled += "uk.gov.hmrc.play.audit.AuditModule"
+
+play.modules.enabled += "uk.gov.hmrc.play.bootstrap.HttpClientV2Module"
 
 play.modules.enabled += "uk.gov.hmrc.mongo.play.PlayMongoModule"
 
diff --git a/project/AppDependencies.scala b/project/AppDependencies.scala
@@ -4,7 +4,7 @@ import sbt._
 object AppDependencies {
   val hmrc = "uk.gov.hmrc"
   val playVersion = "play-30"
-  val hmrcBootstrapVersion = "8.4.0"
+  val hmrcBootstrapVersion = "9.0.0"
   val hmrcMongoVersion = "1.7.0"
 
   val compile: Seq[ModuleID] = Seq(
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -6,7 +6,7 @@ resolvers += Resolver.typesafeRepo("releases")
 
 addSbtPlugin("uk.gov.hmrc" %% "sbt-auto-build" % "3.22.0")
 addSbtPlugin("uk.gov.hmrc" %% "sbt-distributables" % "2.5.0")
-addSbtPlugin("org.playframework" %% "sbt-plugin" % "3.0.1")
+addSbtPlugin("org.playframework" %% "sbt-plugin" % "3.0.3")
 addSbtPlugin("org.scoverage" %% "sbt-scoverage" % "2.0.10")
 addSbtPlugin("org.scalameta" %% "sbt-scalafmt" % "2.5.2")
 
diff --git a/test/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnectorImplSpec.scala b/test/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnectorImplSpec.scala
@@ -81,6 +81,7 @@ class HelpToSaveConnectorImplSpec
           HttpResponse(400, emptyJsonBody),
           HttpResponse(401, emptyJsonBody),
           HttpResponse(403, emptyJsonBody),
+          HttpResponse(404, emptyJsonBody),
           HttpResponse(500, emptyJsonBody),
           HttpResponse(502, emptyJsonBody),
           HttpResponse(503, emptyJsonBody)
@@ -92,7 +93,7 @@ class HelpToSaveConnectorImplSpec
             Map.empty,
             Map("X-Correlation-ID" -> correlationId.toString),
             Some(Json.toJson(CreateAccountInfo(createAccountBody, 8, "1234")).toString())
-          ) thenReturn (httpResponse.status, httpResponse.body)
+          ).thenReturn(httpResponse.status, httpResponse.body)
           val result = await(connector.createAccount(createAccountBody, correlationId, "1234", 8))
           result.status shouldBe httpResponse.status
           result.body shouldBe httpResponse.body
@@ -113,7 +114,7 @@ class HelpToSaveConnectorImplSpec
           eligibilityUrl,
           Map("nino" -> nino),
           headers
-        ) thenReturn (httpResponse.status, httpResponse.body)
+        ).thenReturn(httpResponse.status, httpResponse.body)
         val result = await(connector.checkEligibility(nino, correlationId))
         result.status shouldBe 200
         result.json shouldBe json
@@ -151,11 +152,10 @@ class HelpToSaveConnectorImplSpec
       "call the correct url and return the response as is" in {
         val httpResponse = HttpResponse(200, json, Map.empty[String, Seq[String]])
         when(
-          GET,
-          getAccountUrl,
-          Map("systemId" -> systemId, "correlationId" -> correlationId.toString),
-          headers
-        ) thenReturn (httpResponse.status, httpResponse.body)
+          method = GET,
+          uri = getAccountUrl,
+          headers= headers
+        ).thenReturn(httpResponse.status, httpResponse.body)
         val result = await(connector.getAccount(nino, systemId, correlationId))
         result.status shouldBe 200
         result.json shouldBe json
@@ -172,8 +172,7 @@ class HelpToSaveConnectorImplSpec
           storeEmailUrl,
           Map("email" -> email, "nino" -> nino),
           headers
-        ) thenReturn (httpResponse.status, httpResponse.body)
-
+        ).thenReturn(httpResponse.status, httpResponse.body)
         val result = await(connector.storeEmail(email, nino, correlationId))
         result.status shouldBe 200
       }
@@ -188,11 +187,25 @@ class HelpToSaveConnectorImplSpec
           "/help-to-save/validate-bank-details",
           headers = Map.empty,
           body = Some(Json.toJson(request).toString())
-        ) thenReturn (httpResponse.status, httpResponse.body)
+        ).thenReturn(httpResponse.status, httpResponse.body)
         val result = await(connector.validateBankDetails(request))
         result.status shouldBe httpResponse.status
         result.body shouldBe httpResponse.body
       }
     }
+
+    "handling user enrolment status" must {
+      "return http response when it calling getUserEnrolmentStatus" in {
+        val enrollmentStatusUrl = "/help-to-save/enrolment-status"
+        val httpResponse = HttpResponse(200, "")
+        when(GET,
+          enrollmentStatusUrl,
+          Map("nino" -> nino),
+          headers
+        ).thenReturn(httpResponse.status, httpResponse.body)
+        val result = await(connector.getUserEnrolmentStatus(nino,correlationId))
+        result.status shouldBe 200
+      }
+    }
   }
 }
diff --git a/test/uk/gov/hmrc/helptosaveapi/util/HttpResponseOpsSpec.scala b/test/uk/gov/hmrc/helptosaveapi/util/HttpResponseOpsSpec.scala
