hmrc · TomRafferty · Feb 1, 2024 · Feb 1, 2024 · Feb 5, 2024
diff --git a/app/uk/gov/hmrc/helptosaveapi/auth/Auth.scala b/app/uk/gov/hmrc/helptosaveapi/auth/Auth.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnector.scala b/app/uk/gov/hmrc/helptosaveapi/connectors/HelpToSaveConnector.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,19 +16,17 @@
 
 package uk.gov.hmrc.helptosaveapi.connectors
 
-import java.util.UUID
-
 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.helptosaveapi.models.ValidateBankDetailsRequest
-import uk.gov.hmrc.http.{HeaderCarrier, HttpResponse}
 import uk.gov.hmrc.http._
 
+import java.util.UUID
 import scala.concurrent.{ExecutionContext, Future}
 
 @ImplementedBy(classOf[HelpToSaveConnectorImpl])

diff --git a/app/uk/gov/hmrc/helptosaveapi/controllers/DocumentationController.scala b/app/uk/gov/hmrc/helptosaveapi/controllers/DocumentationController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -19,8 +19,6 @@ package uk.gov.hmrc.helptosaveapi.controllers
 import akka.stream.Materializer
 import com.typesafe.config.Config
 import controllers.Assets
-
-import javax.inject.{Inject, Singleton}
 import play.api.Configuration
 import play.api.libs.json.{Format, Json}
 import play.api.mvc.{Action, AnyContent, ControllerComponents}
@@ -30,6 +28,7 @@ import uk.gov.hmrc.helptosaveapi.controllers.DocumentationController.APIAccess.V
 import uk.gov.hmrc.helptosaveapi.views.txt
 import uk.gov.hmrc.play.bootstrap.backend.controller.BackendController
 
+import javax.inject.{Inject, Singleton}
 import scala.concurrent.ExecutionContext
 
 @Singleton

diff --git a/app/uk/gov/hmrc/helptosaveapi/controllers/HelpToSaveController.scala b/app/uk/gov/hmrc/helptosaveapi/controllers/HelpToSaveController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,8 +16,6 @@
 
 package uk.gov.hmrc.helptosaveapi.controllers
 
-import java.time.LocalDate
-import java.util.UUID
 import cats.instances.string._
 import cats.syntax.eq._
 import com.google.inject.Inject
@@ -38,6 +36,8 @@ import uk.gov.hmrc.helptosaveapi.util.{LogMessageTransformer, Logging, toFuture}
 import uk.gov.hmrc.http.HeaderCarrier
 import uk.gov.hmrc.play.bootstrap.backend.controller.BackendController
 
+import java.time.LocalDate
+import java.util.UUID
 import scala.concurrent.{ExecutionContext, Future}
 
 class HelpToSaveController @Inject() (

diff --git a/app/uk/gov/hmrc/helptosaveapi/http/HttpClient.scala b/app/uk/gov/hmrc/helptosaveapi/http/HttpClient.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/metrics/Metrics.scala b/app/uk/gov/hmrc/helptosaveapi/metrics/Metrics.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/AccessType.scala b/app/uk/gov/hmrc/helptosaveapi/models/AccessType.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/Account.scala b/app/uk/gov/hmrc/helptosaveapi/models/Account.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/ApiError.scala b/app/uk/gov/hmrc/helptosaveapi/models/ApiError.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/BonusTerm.scala b/app/uk/gov/hmrc/helptosaveapi/models/BonusTerm.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,13 +16,13 @@
 
 package uk.gov.hmrc.helptosaveapi.models
 
-import java.time.LocalDate
-import java.time.format.DateTimeFormatter
-
 import play.api.libs.json.Reads.localDateReads
 import play.api.libs.json.Writes.temporalWrites
 import play.api.libs.json.{Format, Json}
 
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+
 case class BonusTerm(startDate: LocalDate, endDate: LocalDate, bonusEstimate: BigDecimal)
 
 object BonusTerm {

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/EligibilityResponse.scala b/app/uk/gov/hmrc/helptosaveapi/models/EligibilityResponse.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/EnrolmentStatus.scala b/app/uk/gov/hmrc/helptosaveapi/models/EnrolmentStatus.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/HtsAccount.scala b/app/uk/gov/hmrc/helptosaveapi/models/HtsAccount.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,10 +16,10 @@
 
 package uk.gov.hmrc.helptosaveapi.models
 
-import java.time.LocalDate
-
 import play.api.libs.json.{Format, Json}
 
+import java.time.LocalDate
+
 case class HtsBonusTerm(
   bonusEstimate: BigDecimal,
   bonusPaid: BigDecimal,

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/Registration.scala b/app/uk/gov/hmrc/helptosaveapi/models/Registration.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/ValidateBankDetailsRequest.scala b/app/uk/gov/hmrc/helptosaveapi/models/ValidateBankDetailsRequest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountBody.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountBody.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,14 +16,14 @@
 
 package uk.gov.hmrc.helptosaveapi.models.createaccount
 
-import java.time.LocalDate
-import java.time.format.DateTimeFormatter
-
 import play.api.libs.json.Reads.localDateReads
 import play.api.libs.json.Writes.temporalWrites
 import play.api.libs.json._
 import uk.gov.hmrc.helptosaveapi.models.createaccount.CreateAccountBody.{BankDetails, ContactDetails}
 
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+
 case class CreateAccountBody(
   nino: String,
   forename: String,

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountField.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountField.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountHeader.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountHeader.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,15 +16,15 @@
 
 package uk.gov.hmrc.helptosaveapi.models.createaccount
 
-import java.time.ZonedDateTime
-import java.time.format.DateTimeFormatter
-import java.util.UUID
-
 import cats.Show
 import play.api.libs.json.Reads.zonedDateTimeReads
 import play.api.libs.json.Writes.temporalWrites
 import play.api.libs.json._
 
+import java.time.ZonedDateTime
+import java.time.format.DateTimeFormatter
+import java.util.UUID
+
 case class CreateAccountHeader(
   version: String,
   createdTimestamp: ZonedDateTime,

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountRequest.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountRequest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountSuccess.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/CreateAccountSuccess.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.

diff --git a/app/uk/gov/hmrc/helptosaveapi/models/createaccount/RetrievedUserDetails.scala b/app/uk/gov/hmrc/helptosaveapi/models/createaccount/RetrievedUserDetails.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,9 +16,10 @@
 
 package uk.gov.hmrc.helptosaveapi.models.createaccount
 
-import java.time.LocalDate
 import uk.gov.hmrc.auth.core.retrieve.ItmpAddress
 
+import java.time.LocalDate
+
 case class RetrievedUserDetails(
   nino: Option[String],
   forename: Option[String],

diff --git a/app/uk/gov/hmrc/helptosaveapi/repo/EligibilityStore.scala b/app/uk/gov/hmrc/helptosaveapi/repo/EligibilityStore.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 HM Revenue & Customs
+ * 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.
@@ -16,19 +16,19 @@
 
 package uk.gov.hmrc.helptosaveapi.repo
 
-import java.util.UUID
-
 import cats.data.OptionT
 import cats.instances.either._
 import cats.syntax.either._
 import com.google.inject.{ImplementedBy, Inject, Singleton}
 import play.api.libs.json.{Format, JsValue, Json}
 import uk.gov.hmrc.helptosaveapi.models.EligibilityResponse
 import uk.gov.hmrc.helptosaveapi.repo.EligibilityStore.EligibilityResponseWithNINO
-import uk.gov.hmrc.mongo.{CurrentTimestampSupport, MongoComponent}
 import uk.gov.hmrc.mongo.cache.{CacheIdType, DataKey, MongoCacheRepository}
+import uk.gov.hmrc.mongo.{CurrentTimestampSupport, MongoComponent}
 import uk.gov.hmrc.play.bootstrap.config.ServicesConfig
+import uk.gov.hmrc.play.http.logging.Mdc.preservingMdc
 
+import java.util.UUID
 import scala.concurrent.{ExecutionContext, Future}
 
 @ImplementedBy(classOf[MongoEligibilityStore])
@@ -72,21 +72,21 @@ class MongoEligibilityStore @Inject() (mongoComponent: MongoComponent, servicesC
   override def get(
     correlationId: UUID
   )(implicit ec: ExecutionContext): Future[Either[String, Option[EligibilityResponseWithNINO]]] =
-    doFindById(correlationId.toString)
-      .map { maybeCache =>
-        val response: OptionT[EitherStringOr, EligibilityResponseWithNINO] = for {
-          cache <- OptionT.fromOption[EitherStringOr](maybeCache)
-          data  <- OptionT.fromOption[EitherStringOr](Some(cache.data))
-          result <- OptionT.liftF[EitherStringOr, EligibilityResponseWithNINO](
-                     (data \ "eligibility")
-                       .validate[EligibilityResponseWithNINO]
-                       .asEither
-                       .leftMap(e => s"Could not parse data: ${e.mkString("; ")}")
-                   )
-        } yield result
-
-        response.value
-      }
+      doFindById(correlationId.toString)
+        .map { maybeCache =>
+          val response: OptionT[EitherStringOr, EligibilityResponseWithNINO] = for {
+            cache <- OptionT.fromOption[EitherStringOr](maybeCache)
+            data <- OptionT.fromOption[EitherStringOr](Some(cache.data))
+            result <- OptionT.liftF[EitherStringOr, EligibilityResponseWithNINO](
+              (data \ "eligibility")
+                .validate[EligibilityResponseWithNINO]
+                .asEither
+                .leftMap(e => s"Could not parse data: ${e.mkString("; ")}")
+            )
+          } yield result
+
+          response.value
+        }
       .recover {
         case e =>
           Left(e.getMessage)
@@ -95,11 +95,11 @@ class MongoEligibilityStore @Inject() (mongoComponent: MongoComponent, servicesC
   override def put(correlationId: UUID, eligibility: EligibilityResponse, nino: String)(
     implicit ec: ExecutionContext
   ): Future[Either[String, Unit]] =
-    doCreateOrUpdate(
-      correlationId.toString,
-      "eligibility",
-      Json.toJson(EligibilityResponseWithNINO(eligibility, nino))
-    ).map[Either[String, Unit]] { dbUpdate =>
+      doCreateOrUpdate(
+        correlationId.toString,
+        "eligibility",
+        Json.toJson(EligibilityResponseWithNINO(eligibility, nino))
+      ).map[Either[String, Unit]] { dbUpdate =>
         Right(())
       }
       .recover {
@@ -108,8 +108,12 @@ class MongoEligibilityStore @Inject() (mongoComponent: MongoComponent, servicesC
       }
 
   private[repo] def doFindById(id: String) =
-    mongoRepo.findById(id)
+    preservingMdc {
+      mongoRepo.findById(id)
+    }
 
   private[repo] def doCreateOrUpdate(id: String, key: String, toCache: JsValue) =
-    mongoRepo.put(id)(DataKey(key), toCache)
+    preservingMdc {
+      mongoRepo.put(id)(DataKey(key), toCache)
+    }
 }