ADR-1360: startedTime added to UserAnswers, explicit audit events rem…

…oved from the service
hmrc · Oct 3, 2024 · 7466191 · 7466191
1 parent a236465
commit 7466191
Show file tree

Hide file tree

Showing 13 changed files with 16 additions and 332 deletions.
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/controllers/CacheController.scala b/app/uk/gov/hmrc/alcoholdutyreturns/controllers/CacheController.scala
@@ -22,11 +22,9 @@ import play.api.http.HttpEntity
 import play.api.libs.json._
 import play.api.mvc._
 import uk.gov.hmrc.alcoholdutyreturns.controllers.actions.AuthorisedAction
-import uk.gov.hmrc.alcoholdutyreturns.models.audit.AuditReturnStarted
-import uk.gov.hmrc.alcoholdutyreturns.models.{ErrorResponse, ObligationData, ReturnAndUserDetails, ReturnId, UserAnswers}
+import uk.gov.hmrc.alcoholdutyreturns.models.{ErrorResponse, ReturnAndUserDetails, ReturnId, UserAnswers}
 import uk.gov.hmrc.alcoholdutyreturns.repositories.{CacheRepository, UpdateFailure, UpdateSuccess}
-import uk.gov.hmrc.alcoholdutyreturns.service.{AccountService, AuditService, LockingService}
-import uk.gov.hmrc.http.HeaderCarrier
+import uk.gov.hmrc.alcoholdutyreturns.service.{AccountService, LockingService}
 import uk.gov.hmrc.play.bootstrap.backend.controller.BackendController
 
 import javax.inject.Inject
@@ -37,7 +35,6 @@ class CacheController @Inject() (
   cacheRepository: CacheRepository,
   lockingService: LockingService,
   accountService: AccountService,
-  auditService: AuditService,
   override val controllerComponents: ControllerComponents
 )(implicit executionContext: ExecutionContext)
     extends BackendController(controllerComponents)
@@ -99,7 +96,6 @@ class CacheController @Inject() (
                 val userAnswers                           =
                   UserAnswers.createUserAnswers(returnAndUserDetails, subscriptionSummary, obligationData)
                 cacheRepository.add(userAnswers).map { userAnswers =>
-                  auditReturnStarted(userAnswers, obligationData)
                   Created(Json.toJson(userAnswers))
                 }
               }
@@ -126,23 +122,6 @@ class CacheController @Inject() (
         .map(_ => Ok("Lock refreshed"))
     }
 
-  private def auditReturnStarted(userAnswers: UserAnswers, obligationData: ObligationData)(implicit
-    hc: HeaderCarrier
-  ): Unit = {
-    val eventDetail = AuditReturnStarted(
-      appaId = userAnswers.returnId.appaId,
-      periodKey = userAnswers.returnId.periodKey,
-      credentialId = userAnswers.internalId,
-      groupId = userAnswers.groupId,
-      obligationData = obligationData,
-      alcoholRegimes = userAnswers.regimes.regimes,
-      returnStartedTime = userAnswers.lastUpdated,
-      returnValidUntilTime = userAnswers.validUntil
-    )
-
-    auditService.audit(eventDetail)
-  }
-
   def error(errorResponse: ErrorResponse): Result = Result(
     header = ResponseHeader(errorResponse.status),
     body = HttpEntity.Strict(ByteString(Json.toBytes(Json.toJson(errorResponse))), Some("application/json"))

diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/models/UserAnswers.scala b/app/uk/gov/hmrc/alcoholdutyreturns/models/UserAnswers.scala
@@ -50,6 +50,7 @@ case class UserAnswers(
   internalId: String,
   regimes: AlcoholRegimes,
   data: JsObject = Json.obj(),
+  startedTime: Instant = Instant.now,
   lastUpdated: Instant = Instant.now,
   validUntil: Option[Instant] = None
 )
@@ -79,6 +80,7 @@ object UserAnswers {
         (__ \ "internalId").read[String] and
         AlcoholRegimes.alcoholRegimesFormat and
         (__ \ "data").read[JsObject] and
+        (__ \ "startedTime").read(MongoJavatimeFormats.instantFormat) and
         (__ \ "lastUpdated").read(MongoJavatimeFormats.instantFormat) and
         (__ \ "validUntil").readNullable(MongoJavatimeFormats.instantFormat)
     )(UserAnswers.apply _)
@@ -90,6 +92,7 @@ object UserAnswers {
         (__ \ "internalId").write[String] and
         AlcoholRegimes.alcoholRegimesFormat and
         (__ \ "data").write[JsObject] and
+        (__ \ "startedTime").write(MongoJavatimeFormats.instantFormat) and
         (__ \ "lastUpdated").write(MongoJavatimeFormats.instantFormat) and
         (__ \ "validUntil").writeNullable(MongoJavatimeFormats.instantFormat)
     )(unlift(UserAnswers.unapply))

diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditEventDetail.scala b/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditEventDetail.scala
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditReturnStarted.scala b/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditReturnStarted.scala
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditReturnSubmitted.scala b/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditReturnSubmitted.scala
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditType.scala b/app/uk/gov/hmrc/alcoholdutyreturns/models/audit/AuditType.scala
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/service/AuditService.scala b/app/uk/gov/hmrc/alcoholdutyreturns/service/AuditService.scala
diff --git a/app/uk/gov/hmrc/alcoholdutyreturns/service/ReturnsService.scala b/app/uk/gov/hmrc/alcoholdutyreturns/service/ReturnsService.scala
@@ -22,10 +22,9 @@ import com.google.inject.{Inject, Singleton}
 import play.api.Logging
 import uk.gov.hmrc.alcoholdutyreturns.connector.{CalculatorConnector, ReturnsConnector}
 import uk.gov.hmrc.alcoholdutyreturns.models.ErrorResponse.BadRequest
-import uk.gov.hmrc.alcoholdutyreturns.models.audit.AuditReturnSubmitted
 import uk.gov.hmrc.alcoholdutyreturns.models.calculation.CalculateDutyDueByTaxTypeRequest
-import uk.gov.hmrc.alcoholdutyreturns.models.{ErrorResponse, ReturnId, UserAnswers}
-import uk.gov.hmrc.alcoholdutyreturns.models.returns.{AdrReturnCreatedDetails, AdrReturnSubmission, ReturnCreate, ReturnCreatedDetails, TotalDutyDuebyTaxType}
+import uk.gov.hmrc.alcoholdutyreturns.models.{ErrorResponse, ReturnId}
+import uk.gov.hmrc.alcoholdutyreturns.models.returns.{AdrReturnSubmission, ReturnCreate, ReturnCreatedDetails, TotalDutyDuebyTaxType}
 import uk.gov.hmrc.alcoholdutyreturns.repositories.CacheRepository
 import uk.gov.hmrc.http.HeaderCarrier
 
@@ -36,7 +35,6 @@ class ReturnsService @Inject() (
   returnsConnector: ReturnsConnector,
   calculatorConnector: CalculatorConnector,
   cacheRepository: CacheRepository,
-  auditService: AuditService,
   schemaValidationService: SchemaValidationService
 )(implicit
   ec: ExecutionContext
@@ -81,37 +79,11 @@ class ReturnsService @Inject() (
               None
             }
         )
-      _                           = auditReturnSubmitted(
-                                      userAnswers,
-                                      returnToSubmit,
-                                      AdrReturnCreatedDetails.fromReturnCreatedDetails(returnCreatedDetails),
-                                      returnId
-                                    )
       _                          <- EitherT.right[ErrorResponse](
                                       cacheRepository
                                         .clearUserAnswersById(returnId)
                                     )
     } yield returnCreatedDetails
   }
 
-  private def auditReturnSubmitted(
-    userAnswers: Option[UserAnswers],
-    returnToSubmit: ReturnCreate,
-    returnCreatedDetails: AdrReturnCreatedDetails,
-    returnId: ReturnId
-  )(implicit
-    hc: HeaderCarrier
-  ): Unit = {
-    val eventDetail = AuditReturnSubmitted(
-      appaId = returnId.appaId,
-      periodKey = returnId.periodKey,
-      credentialId = userAnswers.map(_.internalId),
-      groupId = userAnswers.map(_.groupId),
-      returnSubmittedTime = returnCreatedDetails.processingDate,
-      alcoholRegimes = userAnswers.map(_.regimes.regimes),
-      requestPayload = returnToSubmit,
-      responsePayload = returnCreatedDetails
-    )
-    auditService.audit(eventDetail)
-  }
 }
diff --git a/test-utils/helpers/TestData.scala b/test-utils/helpers/TestData.scala
@@ -52,6 +52,7 @@ trait TestData extends ModelGenerators {
     groupId,
     internalId,
     allAlcoholRegimes,
+    startedTime = Instant.now(clock),
     lastUpdated = Instant.now(clock)
   )
 
@@ -61,6 +62,7 @@ trait TestData extends ModelGenerators {
     internalId,
     allAlcoholRegimes,
     JsObject(Seq(ObligationData.toString -> Json.toJson(getObligationData(LocalDate.now(clock))))),
+    startedTime = Instant.now(clock),
     lastUpdated = Instant.now(clock)
   )
 

diff --git a/test/uk/gov/hmrc/alcoholdutyreturns/controllers/CacheControllerSpec.scala b/test/uk/gov/hmrc/alcoholdutyreturns/controllers/CacheControllerSpec.scala
@@ -25,23 +25,21 @@ import play.api.mvc.Result
 import uk.gov.hmrc.alcoholdutyreturns.base.SpecBase
 import uk.gov.hmrc.alcoholdutyreturns.models.{ApprovalStatus, ErrorResponse}
 import uk.gov.hmrc.alcoholdutyreturns.repositories.{CacheRepository, UpdateFailure, UpdateSuccess}
-import uk.gov.hmrc.alcoholdutyreturns.service.{AccountService, AuditService, FakeLockingService, LockingService}
+import uk.gov.hmrc.alcoholdutyreturns.service.{AccountService, FakeLockingService, LockingService}
 
 import java.time.LocalDate
 import scala.concurrent.Future
 
 class CacheControllerSpec extends SpecBase {
   val mockCacheRepository: CacheRepository = mock[CacheRepository]
   val mockAccountService: AccountService   = mock[AccountService]
-  val mockAuditService: AuditService       = mock[AuditService]
   val mockLockingService: LockingService   = new FakeLockingService
 
   val controller = new CacheController(
     fakeAuthorisedAction,
     mockCacheRepository,
     mockLockingService,
     mockAccountService,
-    mockAuditService,
     cc
   )
 
@@ -76,7 +74,6 @@ class CacheControllerSpec extends SpecBase {
         mockCacheRepository,
         mockLockingService,
         mockAccountService,
-        mockAuditService,
         cc
       )
 
@@ -124,7 +121,6 @@ class CacheControllerSpec extends SpecBase {
         mockCacheRepository,
         lockingService,
         mockAccountService,
-        mockAuditService,
         cc
       )
 
@@ -165,7 +161,6 @@ class CacheControllerSpec extends SpecBase {
         mockCacheRepository,
         mockLockingService,
         mockAccountService,
-        mockAuditService,
         cc
       )
 
@@ -239,7 +234,6 @@ class CacheControllerSpec extends SpecBase {
         mockCacheRepository,
         mockLockingService,
         mockAccountService,
-        mockAuditService,
         cc
       )
 
@@ -260,7 +254,6 @@ class CacheControllerSpec extends SpecBase {
         mockCacheRepository,
         mockLockingService,
         mockAccountService,
-        mockAuditService,
         cc
       )