GFORMS-1658 - Create individual user agent for each BARS implementati…

…on in a gForm (#1416)
hmrc · Jan 31, 2022 · af0313e · af0313e
1 parent ce9b85a
commit af0313e
Show file tree

Hide file tree

Showing 7 changed files with 134 additions and 78 deletions.
diff --git a/app/uk/gov/hmrc/gform/bars/BankAccountReputationConnector.scala b/app/uk/gov/hmrc/gform/bars/BankAccountReputationConnector.scala
@@ -18,6 +18,7 @@ package uk.gov.hmrc.gform.bars
 
 import org.slf4j.{ Logger, LoggerFactory }
 import play.api.libs.json.{ Format, Json }
+import uk.gov.hmrc.gform.sharedmodel.formtemplate.FormTemplateId
 import uk.gov.hmrc.gform.sharedmodel.{ CannotRetrieveResponse, ServiceCallResponse, ServiceResponse }
 import uk.gov.hmrc.gform.wshttp.WSHttp
 import uk.gov.hmrc.http.HttpReads.Implicits.readRaw
@@ -27,85 +28,103 @@ import scala.concurrent.{ ExecutionContext, Future }
 import scala.language.higherKinds
 
 trait BankAccountReputationConnector[F[_]] {
-  def validateBankDetails(account: ValidateBankDetails.Request)(implicit
+  def validateBankDetails(
+    formTemplateId: FormTemplateId,
+    account: ValidateBankDetails.Request
+  )(implicit
     hc: HeaderCarrier
   ): F[ServiceCallResponse[ValidateBankDetails.Response]]
-  def businessBankAccountExistence(account: BusinessBankAccountExistence.Request)(implicit
+  def businessBankAccountExistence(
+    formTemplateId: FormTemplateId,
+    account: BusinessBankAccountExistence.Request
+  )(implicit
     hc: HeaderCarrier
   ): F[ServiceCallResponse[BusinessBankAccountExistence.Response]]
 }
 
-class BankAccountReputationAsyncConnector(ws: WSHttp, baseUrl: String)(implicit ex: ExecutionContext)
+class BankAccountReputationAsyncConnector(ws: FormTemplateId => WSHttp, baseUrl: String)(implicit ex: ExecutionContext)
     extends BankAccountReputationConnector[Future] {
   private val logger: Logger = LoggerFactory.getLogger(getClass)
 
-  override def validateBankDetails(request: ValidateBankDetails.Request)(implicit
+  override def validateBankDetails(
+    formTemplateId: FormTemplateId,
+    request: ValidateBankDetails.Request
+  )(implicit
     hc: HeaderCarrier
   ): Future[ServiceCallResponse[ValidateBankDetails.Response]] =
-    ws.POST[ValidateBankDetails.Request, HttpResponse](
-      baseUrl + "/v2/validateBankDetails",
-      request
-    ).map { httpResponse =>
-      val status = httpResponse.status
-      status match {
-        case 200 =>
-          httpResponse.json
-            .validate[ValidateBankDetails.Response]
-            .fold(
-              invalid => {
-                logger.error(
-                  s"Calling validate bank details returned $status, but marshalling of data failed with: $invalid"
-                )
-                CannotRetrieveResponse
-              },
-              valid => {
-                logger.info(s"Calling validate bank details returned $status: Success.")
-                ServiceResponse(valid)
-              }
-            )
-        case other =>
-          logger.error(s"Problem when calling validate bank details. Http status: $other, body: ${httpResponse.body}")
-          CannotRetrieveResponse
+    ws(formTemplateId)
+      .POST[ValidateBankDetails.Request, HttpResponse](
+        baseUrl + "/v2/validateBankDetails",
+        request
+      )
+      .map { httpResponse =>
+        val status = httpResponse.status
+        status match {
+          case 200 =>
+            httpResponse.json
+              .validate[ValidateBankDetails.Response]
+              .fold(
+                invalid => {
+                  logger.error(
+                    s"Calling validate bank details returned $status, but marshalling of data failed with: $invalid"
+                  )
+                  CannotRetrieveResponse
+                },
+                valid => {
+                  logger.info(s"Calling validate bank details returned $status: Success.")
+                  ServiceResponse(valid)
+                }
+              )
+          case other =>
+            logger.error(s"Problem when calling validate bank details. Http status: $other, body: ${httpResponse.body}")
+            CannotRetrieveResponse
+        }
+      }
+      .recover { case ex =>
+        logger.error("Unknown problem when calling validate bank details", ex)
+        CannotRetrieveResponse
       }
-    }.recover { case ex =>
-      logger.error("Unknown problem when calling validate bank details", ex)
-      CannotRetrieveResponse
-    }
 
-  override def businessBankAccountExistence(request: BusinessBankAccountExistence.Request)(implicit
+  override def businessBankAccountExistence(
+    formTemplateId: FormTemplateId,
+    request: BusinessBankAccountExistence.Request
+  )(implicit
     hc: HeaderCarrier
   ): Future[ServiceCallResponse[BusinessBankAccountExistence.Response]] =
-    ws.POST[BusinessBankAccountExistence.Request, HttpResponse](
-      baseUrl + "/verify/business",
-      request
-    ).map { httpResponse =>
-      val status = httpResponse.status
-      status match {
-        case 200 =>
-          httpResponse.json
-            .validate[BusinessBankAccountExistence.Response]
-            .fold(
-              invalid => {
-                logger.error(
-                  s"Calling business bank account existence returned $status, but marshalling of data failed with: $invalid"
-                )
-                CannotRetrieveResponse
-              },
-              valid => {
-                logger.info(s"Calling business bank account existence returned $status: Success.")
-                ServiceResponse(valid)
-              }
+    ws(formTemplateId)
+      .POST[BusinessBankAccountExistence.Request, HttpResponse](
+        baseUrl + "/verify/business",
+        request
+      )
+      .map { httpResponse =>
+        val status = httpResponse.status
+        status match {
+          case 200 =>
+            httpResponse.json
+              .validate[BusinessBankAccountExistence.Response]
+              .fold(
+                invalid => {
+                  logger.error(
+                    s"Calling business bank account existence returned $status, but marshalling of data failed with: $invalid"
+                  )
+                  CannotRetrieveResponse
+                },
+                valid => {
+                  logger.info(s"Calling business bank account existence returned $status: Success.")
+                  ServiceResponse(valid)
+                }
+              )
+          case other =>
+            logger.error(
+              s"Problem when calling business bank account existence. Http status: $other, body: ${httpResponse.body}"
             )
-        case other =>
-          logger.error(
-            s"Problem when calling business bank account existence. Http status: $other, body: ${httpResponse.body}"
-          )
-          CannotRetrieveResponse
+            CannotRetrieveResponse
+        }
+      }
+      .recover { case ex =>
+        logger.error("Unknown problem when calling business bank account existence", ex)
+        CannotRetrieveResponse
       }
-    }.recover { case ex =>
-      logger.error("Unknown problem when calling business bank account existence", ex)
-      CannotRetrieveResponse
-    }
 }
 
 object ValidateBankDetails {

diff --git a/app/uk/gov/hmrc/gform/gform/DataRetrieveService.scala b/app/uk/gov/hmrc/gform/gform/DataRetrieveService.scala
@@ -23,13 +23,15 @@ import uk.gov.hmrc.gform.bars.BankAccountReputationConnector
 import uk.gov.hmrc.gform.models.optics.{ DataOrigin, FormModelVisibilityOptics }
 import uk.gov.hmrc.gform.sharedmodel.DataRetrieve.{ BusinessBankAccountExistence, ValidateBankDetails }
 import uk.gov.hmrc.gform.sharedmodel._
+import uk.gov.hmrc.gform.sharedmodel.formtemplate.FormTemplateId
 import uk.gov.hmrc.http.HeaderCarrier
 
 import scala.concurrent.{ ExecutionContext, Future }
 import scala.language.higherKinds
 
 sealed trait DataRetrieveService[T <: DataRetrieve, F[_]] {
   def retrieve(
+    formTemplateId: FormTemplateId,
     dataRetrieve: T,
     formModelVisibilityOptics: FormModelVisibilityOptics[DataOrigin.Browser],
     maybeRequestParams: Option[JsValue]
@@ -46,6 +48,7 @@ object DataRetrieveService {
   ): DataRetrieveService[ValidateBankDetails, Future] = new DataRetrieveService[ValidateBankDetails, Future] {
 
     override def retrieve(
+      formTemplateId: FormTemplateId,
       validateBankDetails: ValidateBankDetails,
       formModelVisibilityOptics: FormModelVisibilityOptics[DataOrigin.Browser],
       maybeRequestParams: Option[JsValue]
@@ -64,6 +67,7 @@ object DataRetrieveService {
       } else {
         bankAccountReputationConnector
           .validateBankDetails(
+            formTemplateId,
             bars.ValidateBankDetails.create(sortCode, accNumber)
           )
           .map {
@@ -92,6 +96,7 @@ object DataRetrieveService {
     new DataRetrieveService[BusinessBankAccountExistence, Future] {
 
       override def retrieve(
+        formTemplateId: FormTemplateId,
         businessBankAccountExistence: BusinessBankAccountExistence,
         formModelVisibilityOptics: FormModelVisibilityOptics[DataOrigin.Browser],
         maybeRequestParams: Option[JsValue]
@@ -122,6 +127,7 @@ object DataRetrieveService {
         } else {
           bankAccountReputationConnector
             .businessBankAccountExistence(
+              formTemplateId,
               bars.BusinessBankAccountExistence.create(sortCode, accNumber, companyName)
             )
             .map {

diff --git a/app/uk/gov/hmrc/gform/gform/GformModule.scala b/app/uk/gov/hmrc/gform/gform/GformModule.scala
@@ -133,7 +133,7 @@ class GformModule(
   private val barsBaseUrl = s"${configModule.serviceConfig.baseUrl("bars")}"
 
   val bankAccountReputationConnector =
-    new BankAccountReputationAsyncConnector(wSHttpModule.auditableWSHttp, barsBaseUrl)
+    new BankAccountReputationAsyncConnector(wSHttpModule.auditableWSHttpCustomAppName, barsBaseUrl)
 
   val addToListProcessor = new FormProcessor(
     playBuiltInsModule.i18nSupport,

diff --git a/app/uk/gov/hmrc/gform/gform/processor/FormProcessor.scala b/app/uk/gov/hmrc/gform/gform/processor/FormProcessor.scala
@@ -202,12 +202,22 @@ class FormProcessor(
                 val maybeRequestParams = DataRetrieve.requestParamsFromCache(cache.form, v.id)
                 implicit val b: BankAccountReputationConnector[Future] = bankAccountReputationConnector
                 DataRetrieveService[ValidateBankDetails, Future]
-                  .retrieve(v, processData.formModelOptics.formModelVisibilityOptics, maybeRequestParams)
+                  .retrieve(
+                    cache.formTemplateId,
+                    v,
+                    processData.formModelOptics.formModelVisibilityOptics,
+                    maybeRequestParams
+                  )
               case v: BusinessBankAccountExistence =>
                 val maybeRequestParams = DataRetrieve.requestParamsFromCache(cache.form, v.id)
                 implicit val b: BankAccountReputationConnector[Future] = bankAccountReputationConnector
                 DataRetrieveService[BusinessBankAccountExistence, Future]
-                  .retrieve(v, processData.formModelOptics.formModelVisibilityOptics, maybeRequestParams)
+                  .retrieve(
+                    cache.formTemplateId,
+                    v,
+                    processData.formModelOptics.formModelVisibilityOptics,
+                    maybeRequestParams
+                  )
             }
           )(_ => Option.empty.pure[Future])(_ => Option.empty.pure[Future])
         } else Option.empty.pure[Future]

diff --git a/app/uk/gov/hmrc/gform/wshttp/WSHttpModule.scala b/app/uk/gov/hmrc/gform/wshttp/WSHttpModule.scala
@@ -16,25 +16,41 @@
 
 package uk.gov.hmrc.gform.wshttp
 
+import com.typesafe.config.ConfigValueFactory
 import play.api.libs.ws.WSClient
 import play.api.libs.ws.ahc.AhcWSComponents
 import uk.gov.hmrc.gform.akka.AkkaModule
 import uk.gov.hmrc.gform.auditing.AuditingModule
 import uk.gov.hmrc.gform.config.ConfigModule
+import uk.gov.hmrc.gform.sharedmodel.formtemplate.FormTemplateId
 
 class WSHttpModule(
   auditingModule: AuditingModule,
   configModule: ConfigModule,
   akkaModule: AkkaModule,
   ahcWSComponents: AhcWSComponents
 ) {
-  lazy val auditableWSHttp: WSHttp = new WSHttpImpl(
+  val auditableWSHttp: WSHttp = new WSHttpImpl(
     configModule.appConfig.appName,
     auditingModule.auditConnector,
     configModule.typesafeConfig,
     akkaModule.actorSystem,
     wsClient
   )
 
+  val auditableWSHttpCustomAppName: FormTemplateId => WSHttp = formTemplateId => {
+    val appName = configModule.typesafeConfig.getString("appName")
+    val config =
+      configModule.typesafeConfig
+        .withValue("appName", ConfigValueFactory.fromAnyRef(appName + "/" + formTemplateId.value))
+    new WSHttpImpl(
+      configModule.appConfig.appName,
+      auditingModule.auditConnector,
+      config,
+      akkaModule.actorSystem,
+      wsClient
+    )
+  }
+
   def wsClient: WSClient = ahcWSComponents.wsClient
 }
diff --git a/test/uk/gov/hmrc/gform/SpecWithFakeApp.scala b/test/uk/gov/hmrc/gform/SpecWithFakeApp.scala
@@ -32,7 +32,7 @@ trait SpecWithFakeApp extends Spec with BaseOneServerPerSuite with FakeApplicati
   lazy val applicationModule = new ApplicationModule(context) {
     override val httpFilters = Nil
     override lazy val wSHttpModule = new WSHttpModule(null, null, null, null) {
-      override lazy val auditableWSHttp: WSHttp = new StubbedWSHttp(
+      override val auditableWSHttp: WSHttp = new StubbedWSHttp(
         HttpResponse(200, null)
       )
     }

diff --git a/test/uk/gov/hmrc/gform/bars/BankAccountReputationAsyncConnectorSpec.scala b/test/uk/gov/hmrc/gform/bars/BankAccountReputationAsyncConnectorSpec.scala
@@ -29,6 +29,7 @@ import play.api.libs.json.Json
 import play.api.libs.ws.WSClient
 import play.api.test.WsTestClient.InternalWSClient
 import uk.gov.hmrc.gform.WiremockSupport
+import uk.gov.hmrc.gform.sharedmodel.formtemplate.FormTemplateId
 import uk.gov.hmrc.gform.sharedmodel.{ CannotRetrieveResponse, ServiceResponse }
 import uk.gov.hmrc.gform.wshttp.WSHttp
 import uk.gov.hmrc.http.hooks.HttpHook
@@ -61,16 +62,18 @@ class BankAccountReputationAsyncConnectorSpec
 
   val url = s"http://localhost:$wiremockPort"
 
-  val wsHttp = new WSHttp {
-    override protected def actorSystem: ActorSystem = system
-    override protected def configuration: Config = ConfigFactory.parseString("""
-                                                                               |internalServiceHostPatterns = []
-                                                                               |bootstrap.http.headersAllowlist = []
-                                                                               |http-verbs.retries.intervals = []
-                                                                               |""".stripMargin)
-    override val hooks: Seq[HttpHook] = Seq.empty
-    override protected def wsClient: WSClient = new InternalWSClient("http", wiremockPort)
-  }
+  val wsHttp = (formTemplateId: FormTemplateId) =>
+    new WSHttp {
+      override protected def actorSystem: ActorSystem = system
+      override protected def configuration: Config = ConfigFactory.parseString(s"""
+                                                                                  |internalServiceHostPatterns = []
+                                                                                  |bootstrap.http.headersAllowlist = []
+                                                                                  |http-verbs.retries.intervals = []
+                                                                                  |appName = ${formTemplateId.value}
+                                                                                  |""".stripMargin)
+      override val hooks: Seq[HttpHook] = Seq.empty
+      override protected def wsClient: WSClient = new InternalWSClient("http", wiremockPort)
+    }
 
   val bankAccountReputationAsyncConnector = new BankAccountReputationAsyncConnector(wsHttp, url)
 
@@ -93,7 +96,7 @@ class BankAccountReputationAsyncConnectorSpec
     stubFor(
       WireMock
         .post(s"/v2/validateBankDetails")
-        .withHeader("User-Agent", equalTo("AHC/2.1"))
+        .withHeader("User-Agent", equalTo("fooBar"))
         .withHeader("Content-Type", equalTo("application/json"))
         .willReturn(
           ok(
@@ -107,6 +110,7 @@ class BankAccountReputationAsyncConnectorSpec
     )
 
     val future = bankAccountReputationAsyncConnector.validateBankDetails(
+      FormTemplateId("fooBar"),
       ValidateBankDetails.create(
         "112233",
         "12345678"
@@ -133,6 +137,7 @@ class BankAccountReputationAsyncConnectorSpec
     )
 
     val future = bankAccountReputationAsyncConnector.validateBankDetails(
+      FormTemplateId("fooBar"),
       ValidateBankDetails.create("", "")
     )