GFORMS-2459 - Add new expression that returns the status of a task (#…

…2348)
hmrc · Dec 19, 2024 · 7b9f151 · 7b9f151
1 parent d9ed694
commit 7b9f151
Show file tree

Hide file tree

Showing 46 changed files with 423 additions and 153 deletions.
diff --git a/app/uk/gov/hmrc/gform/ApplicationLoader.scala b/app/uk/gov/hmrc/gform/ApplicationLoader.scala
@@ -176,7 +176,9 @@ class ApplicationModule(context: Context)
 
   private val taskListModule = new TaskListModule(
     configModule,
-    validationModule
+    validationModule,
+    gformBackendModule,
+    graphModule
   )
 
   private val gformModule = new GformModule(

diff --git a/app/uk/gov/hmrc/gform/addresslookup/AddressLookupController.scala b/app/uk/gov/hmrc/gform/addresslookup/AddressLookupController.scala
@@ -36,7 +36,7 @@ import uk.gov.hmrc.gform.lookup.LookupRegistry
 import uk.gov.hmrc.gform.models.{ Basic, Bracket, DataExpanded, FastForward, FormModel, FormModelBuilder, SectionSelectorType, Visibility }
 import uk.gov.hmrc.gform.models.optics.{ DataOrigin, FormModelVisibilityOptics }
 import uk.gov.hmrc.gform.monoidHtml
-import uk.gov.hmrc.gform.sharedmodel.form.{ FormComponentIdToFileIdMapping, FormData, FormModelOptics }
+import uk.gov.hmrc.gform.sharedmodel.form.{ FormComponentIdToFileIdMapping, FormData, FormModelOptics, TaskIdTaskStatusMapping }
 import uk.gov.hmrc.gform.sharedmodel.formtemplate.{ Address, Expr, FormComponent, FormComponentId, FormKind, FormTemplateContext, FormTemplateId, IsPostcodeLookup, Page, PostcodeLookup, Section, SectionNumber, SectionTitle4Ga, SuppressErrors }
 import uk.gov.hmrc.gform.sharedmodel.{ LocalisedString, SmartString }
 import uk.gov.hmrc.gform.sharedmodel.{ AccessCode, LangADT }
@@ -790,7 +790,8 @@ class AddressLookupController(
       maybeAccessCode,
       recalculation,
       FormComponentIdToFileIdMapping.empty,
-      lookupRegistry
+      lookupRegistry,
+      TaskIdTaskStatusMapping.empty
     )
 
     val data = syntheticCache.variadicFormData[SectionSelectorType.Normal]

diff --git a/app/uk/gov/hmrc/gform/addresslookup/AddressLookupService.scala b/app/uk/gov/hmrc/gform/addresslookup/AddressLookupService.scala
@@ -159,7 +159,8 @@ object AddressLookupService {
           formStatus = form.status,
           visitsIndex = form.visitsIndex,
           thirdPartyData = updatedThirdPartyData,
-          componentIdToFileId = form.componentIdToFileId
+          componentIdToFileId = form.componentIdToFileId,
+          taskIdTaskStatus = form.taskIdTaskStatus
         )
         gformConnector.updateUserData(formIdData, userData)
       } else
@@ -191,7 +192,8 @@ object AddressLookupService {
         formStatus = form.status,
         visitsIndex = form.visitsIndex,
         thirdPartyData = form.thirdPartyData,
-        componentIdToFileId = form.componentIdToFileId
+        componentIdToFileId = form.componentIdToFileId,
+        taskIdTaskStatus = form.taskIdTaskStatus
       )
       gformConnector.updateUserData(formIdData, userData)
     }
@@ -211,7 +213,8 @@ object AddressLookupService {
         formStatus = form.status,
         visitsIndex = form.visitsIndex,
         thirdPartyData = updatedThirdPartyData,
-        componentIdToFileId = form.componentIdToFileId
+        componentIdToFileId = form.componentIdToFileId,
+        taskIdTaskStatus = form.taskIdTaskStatus
       )
       gformConnector.updateUserData(formIdData, userData)
     }
@@ -255,7 +258,8 @@ object AddressLookupService {
         formStatus = form.status,
         visitsIndex = form.visitsIndex,
         thirdPartyData = form.thirdPartyData.confirmAddress(formComponentId),
-        componentIdToFileId = form.componentIdToFileId
+        componentIdToFileId = form.componentIdToFileId,
+        taskIdTaskStatus = form.taskIdTaskStatus
       )
       gformConnector.updateUserData(formIdData, userData)
     }

diff --git a/app/uk/gov/hmrc/gform/controllers/AuthenticatedRequestActions.scala b/app/uk/gov/hmrc/gform/controllers/AuthenticatedRequestActions.scala
@@ -626,7 +626,8 @@ case class AuthCacheWithForm(
           (s: GraphException) => new IllegalArgumentException(s.reportProblem)
         ),
         form.componentIdToFileId,
-        lookupRegistry
+        lookupRegistry,
+        form.taskIdTaskStatus
       )
       .dependencyGraphValidation
   }

diff --git a/app/uk/gov/hmrc/gform/eval/EvaluationContext.scala b/app/uk/gov/hmrc/gform/eval/EvaluationContext.scala
@@ -22,7 +22,7 @@ import uk.gov.hmrc.gform.auth.models.MaterialisedRetrievals
 import uk.gov.hmrc.gform.lookup.LookupRegistry
 import uk.gov.hmrc.gform.models.DataRetrieveAll
 import uk.gov.hmrc.gform.models.ids.{ BaseComponentId, ModelComponentId, ModelPageId }
-import uk.gov.hmrc.gform.sharedmodel.form.ThirdPartyData
+import uk.gov.hmrc.gform.sharedmodel.form.{ TaskIdTaskStatusMapping, ThirdPartyData }
 import uk.gov.hmrc.gform.sharedmodel.formtemplate._
 import uk.gov.hmrc.gform.sharedmodel.{ AccessCode, LangADT, SubmissionRef }
 import uk.gov.hmrc.http.HeaderCarrier
@@ -54,5 +54,6 @@ final case class EvaluationContext(
   addToListIds: Set[AddToListId],
   lookupRegistry: LookupRegistry,
   lookupRegister: Map[BaseComponentId, Register],
-  constraints: Map[BaseComponentId, TextConstraint]
+  constraints: Map[BaseComponentId, TextConstraint],
+  taskIdTaskStatus: TaskIdTaskStatusMapping
 )
diff --git a/app/uk/gov/hmrc/gform/eval/EvaluationResults.scala b/app/uk/gov/hmrc/gform/eval/EvaluationResults.scala
@@ -388,6 +388,7 @@ case class EvaluationResults(
       case ChoicesSelected(formComponentId) => getChoicesSelected(formComponentId, evaluationContext)
       case ChoicesAvailable(formComponentId) =>
         getChoicesAvailable(formComponentId, evaluationContext, booleanExprResolver, recData)
+      case TaskStatus(_) => unsupportedOperation("Number")(expr)
     }
 
     loop(typeInfo.expr)
@@ -735,7 +736,9 @@ case class EvaluationResults(
           StringResult(itmpRetrievals.flatMap(_.itmpAddress).flatMap(_.countryName).getOrElse(""))
         )
       case ChoicesRevealedField(fcId) => loop(FormCtx(fcId))
-      case _                          => unsupportedOperation("String")(expr)
+      case TaskStatus(taskId) =>
+        StringResult(evaluationContext.taskIdTaskStatus.mapping.get(taskId).map(_.asString).getOrElse(""))
+      case _ => unsupportedOperation("String")(expr)
     }
 
     loop(typeInfo.expr)

diff --git a/app/uk/gov/hmrc/gform/gform/ConcatFormatSubstituter.scala b/app/uk/gov/hmrc/gform/gform/ConcatFormatSubstituter.scala
@@ -73,6 +73,7 @@ object ConcatFormatSubstituter {
         case e: ChoicesRevealedField      => e
         case e: ChoicesSelected           => e
         case e: ChoicesAvailable          => e
+        case e: TaskStatus                => e
       }
     }
 

diff --git a/app/uk/gov/hmrc/gform/gform/EnrolmentController.scala b/app/uk/gov/hmrc/gform/gform/EnrolmentController.scala
@@ -45,9 +45,8 @@ import uk.gov.hmrc.gform.models.optics.FormModelRenderPageOptics
 import uk.gov.hmrc.gform.models.{ DataExpanded, FormModel, SectionSelectorType, Singleton }
 import uk.gov.hmrc.gform.models.optics.{ DataOrigin, FormModelVisibilityOptics }
 import uk.gov.hmrc.gform.sharedmodel.SmartString
-import uk.gov.hmrc.gform.sharedmodel.form.FormComponentIdToFileIdMapping
+import uk.gov.hmrc.gform.sharedmodel.form.{ FormComponentIdToFileIdMapping, FormModelOptics, TaskIdTaskStatusMapping }
 import uk.gov.hmrc.gform.sharedmodel.{ LangADT, ServiceCallResponse, ServiceResponse }
-import uk.gov.hmrc.gform.sharedmodel.form.FormModelOptics
 import uk.gov.hmrc.gform.sharedmodel.formtemplate._
 import uk.gov.hmrc.gform.eval.smartstring.SmartStringEvaluatorFactory
 import uk.gov.hmrc.gform.sharedmodel.taxenrolments.TaxEnrolmentsResponse
@@ -437,7 +436,8 @@ class EnrolmentController(
                   cache.toCacheData,
                   recalculation,
                   None,
-                  FormComponentIdToFileIdMapping.empty
+                  FormComponentIdToFileIdMapping.empty,
+                  TaskIdTaskStatusMapping.empty
                 )
               def handleContinueWithData(formModelOptics: FormModelOptics[DataOrigin.Mongo]) = {
                 val formModelVisibilityOptics = formModelOptics.formModelVisibilityOptics

diff --git a/app/uk/gov/hmrc/gform/gform/ExprUpdater.scala b/app/uk/gov/hmrc/gform/gform/ExprUpdater.scala
@@ -71,6 +71,7 @@ class ExprUpdater(index: Int, baseIds: List[FormComponentId]) {
     case ChoicesRevealedField(formComponentId) => ChoicesRevealedField(expandFcId(formComponentId))
     case ChoicesSelected(formComponentId)      => ChoicesSelected(expandFcId(formComponentId))
     case ChoicesAvailable(formComponentId)     => ChoicesAvailable(expandFcId(formComponentId))
+    case TaskStatus(_)                         => expr
   }
 
   private def expandDateFunc(dateFunc: DateProjection): DateProjection = dateFunc match {

diff --git a/app/uk/gov/hmrc/gform/gform/FastForwardService.scala b/app/uk/gov/hmrc/gform/gform/FastForwardService.scala
@@ -236,7 +236,8 @@ class FastForwardService(
                      .setTo(processData.obligations)
                      .modify(_.booleanExprCache)
                      .setTo(processData.booleanExprCache),
-                   cache.form.componentIdToFileId
+                   cache.form.componentIdToFileId,
+                   cache.form.taskIdTaskStatus
                  )
       res <- gformConnector
                .updateUserData(FormIdData.fromForm(cache.form, maybeAccessCode), userData)

diff --git a/app/uk/gov/hmrc/gform/gform/FormComponentIdSubstituter.scala b/app/uk/gov/hmrc/gform/gform/FormComponentIdSubstituter.scala
@@ -73,6 +73,7 @@ object FormComponentIdSubstituter {
         case ChoicesRevealedField(fcId)   => ChoicesRevealedField(substitutions.updateFormComponentId(fcId))
         case ChoicesSelected(fcId)        => ChoicesSelected(substitutions.updateFormComponentId(fcId))
         case ChoicesAvailable(fcId)       => ChoicesAvailable(substitutions.updateFormComponentId(fcId))
+        case e: TaskStatus                => e
       }
     }
 

diff --git a/app/uk/gov/hmrc/gform/gform/LanguageSwitchController.scala b/app/uk/gov/hmrc/gform/gform/LanguageSwitchController.scala
@@ -118,7 +118,8 @@ class LanguageSwitchController(
               formStatus = form.status,
               visitsIndex = form.visitsIndex,
               thirdPartyData = form.thirdPartyData,
-              componentIdToFileId = form.componentIdToFileId
+              componentIdToFileId = form.componentIdToFileId,
+              taskIdTaskStatus = form.taskIdTaskStatus
             )
             gformConnector.updateUserData(formIdData, userData).flatMap { _ =>
               switchToLanguage(language)(request)

diff --git a/app/uk/gov/hmrc/gform/gform/SaveAcknowledgementController.scala b/app/uk/gov/hmrc/gform/gform/SaveAcknowledgementController.scala
@@ -260,7 +260,8 @@ class SaveAcknowledgementController(
                 Validated,
                 cache.form.visitsIndex,
                 cache.form.thirdPartyData,
-                cache.form.componentIdToFileId
+                cache.form.componentIdToFileId,
+                cache.form.taskIdTaskStatus
               )
             )
             .flatMap { _ =>

diff --git a/app/uk/gov/hmrc/gform/gform/SummaryController.scala b/app/uk/gov/hmrc/gform/gform/SummaryController.scala
@@ -205,7 +205,8 @@ class SummaryController(
           Validated,
           cache.form.visitsIndex,
           cache.form.thirdPartyData,
-          cache.form.componentIdToFileId
+          cache.form.componentIdToFileId,
+          cache.form.taskIdTaskStatus
         )
       )
       .flatMap { _ =>

diff --git a/app/uk/gov/hmrc/gform/gform/SummaryExprSubstituter.scala b/app/uk/gov/hmrc/gform/gform/SummaryExprSubstituter.scala
@@ -104,6 +104,7 @@ object SummarySubstituter {
       case e: ChoicesRevealedField      => e
       case e: ChoicesSelected           => e
       case e: ChoicesAvailable          => e
+      case e: TaskStatus                => e
     }
   }
 

diff --git a/app/uk/gov/hmrc/gform/gform/processor/FormProcessor.scala b/app/uk/gov/hmrc/gform/gform/processor/FormProcessor.scala
@@ -40,9 +40,10 @@ import uk.gov.hmrc.gform.models.ids.{ ModelComponentId, ModelPageId }
 import uk.gov.hmrc.gform.models.optics.DataOrigin.Mongo
 import uk.gov.hmrc.gform.models.optics.{ DataOrigin, FormModelVisibilityOptics }
 import uk.gov.hmrc.gform.sharedmodel._
-import uk.gov.hmrc.gform.sharedmodel.form.{ FormComponentIdToFileIdMapping, FormModelOptics, ThirdPartyData, VisitIndex }
+import uk.gov.hmrc.gform.sharedmodel.form.{ FormComponentIdToFileIdMapping, FormModelOptics, TaskIdTaskStatusMapping, ThirdPartyData, VisitIndex }
 import uk.gov.hmrc.gform.sharedmodel.formtemplate.SectionTitle4Ga.sectionTitle4GaFactory
 import uk.gov.hmrc.gform.sharedmodel.formtemplate._
+import uk.gov.hmrc.gform.tasklist.TaskListUtils
 import uk.gov.hmrc.gform.validation.ValidationService
 import uk.gov.hmrc.http.HeaderCarrier
 
@@ -395,6 +396,14 @@ class FormProcessor(
             }
         } else Option.empty.pure[Future]
 
+      taskIdTaskStatusMapping <- if (sectionNumber.isTaskList) {
+                                   evalTaskIdTaskStatus(
+                                     cache,
+                                     envelopeWithMapping,
+                                     DataOrigin.swapDataOrigin(processData.formModelOptics)
+                                   )
+                                 } else TaskIdTaskStatusMapping.empty.pure[Future]
+
       res <- {
         val oldData: VariadicFormData[SourceOrigin.Current] = processData.formModelOptics.pageOpticsData
 
@@ -425,7 +434,8 @@ class FormProcessor(
               .copy(
                 thirdPartyData = updatedThirdPartyData.copy(obligations = processData.obligations),
                 formData = formDataU,
-                visitsIndex = updatedVisitsIndex
+                visitsIndex = updatedVisitsIndex,
+                taskIdTaskStatus = taskIdTaskStatusMapping
               )
           )
 
@@ -454,6 +464,24 @@ class FormProcessor(
     } yield res
   }
 
+  private def evalTaskIdTaskStatus(
+    cache: AuthCacheWithForm,
+    envelope: EnvelopeWithMapping,
+    formModelOptics: FormModelOptics[DataOrigin.Mongo]
+  )(implicit
+    hc: HeaderCarrier,
+    messages: Messages,
+    l: LangADT,
+    sse: SmartStringEvaluator
+  ): Future[TaskIdTaskStatusMapping] =
+    if (TaskListUtils.hasTaskStatusExpr(cache, formModelOptics))
+      for {
+        statusesLookup <-
+          TaskListUtils.evalStatusLookup(cache.toCacheData, envelope, formModelOptics, validationService)
+      } yield TaskListUtils.evalTaskIdTaskStatusMapping(cache, statusesLookup)
+    else
+      TaskIdTaskStatusMapping.empty.pure[Future]
+
   def getSectionTitle4Ga(processData: ProcessData, sectionNumber: SectionNumber)(implicit
     messages: Messages
   ): SectionTitle4Ga = {

diff --git a/app/uk/gov/hmrc/gform/gformbackend/GformBackEndService.scala b/app/uk/gov/hmrc/gform/gformbackend/GformBackEndService.scala
@@ -318,7 +318,8 @@ class GformBackEndService(
           updatedForm.status,
           updatedForm.visitsIndex,
           updatedForm.thirdPartyData,
-          updatedForm.componentIdToFileId
+          updatedForm.componentIdToFileId,
+          updatedForm.taskIdTaskStatus
         )
       )
 

diff --git a/app/uk/gov/hmrc/gform/models/FileUploadUtils.scala b/app/uk/gov/hmrc/gform/models/FileUploadUtils.scala
@@ -36,7 +36,8 @@ object FileUploadUtils {
       InProgress,
       form.visitsIndex,
       form.thirdPartyData,
-      mappingUpd
+      mappingUpd,
+      form.taskIdTaskStatus
     )
   }
 

diff --git a/app/uk/gov/hmrc/gform/models/FormModelBuilder.scala b/app/uk/gov/hmrc/gform/models/FormModelBuilder.scala
@@ -31,7 +31,7 @@ import uk.gov.hmrc.gform.models.ids.ModelComponentId
 import uk.gov.hmrc.gform.models.optics.{ DataOrigin, FormModelRenderPageOptics, FormModelVisibilityOptics }
 import uk.gov.hmrc.gform.sharedmodel.SourceOrigin.OutOfDate
 import uk.gov.hmrc.gform.sharedmodel._
-import uk.gov.hmrc.gform.sharedmodel.form.{ EnvelopeId, FormComponentIdToFileIdMapping, FormModelOptics, ThirdPartyData }
+import uk.gov.hmrc.gform.sharedmodel.form.{ EnvelopeId, FormComponentIdToFileIdMapping, FormModelOptics, TaskIdTaskStatusMapping, ThirdPartyData }
 import uk.gov.hmrc.gform.sharedmodel.formtemplate._
 import uk.gov.hmrc.http.HeaderCarrier
 
@@ -43,7 +43,8 @@ object FormModelBuilder {
     cacheData: CacheData,
     recalculation: Recalculation[F, E],
     componentIdToFileId: FormComponentIdToFileIdMapping,
-    lookupRegistry: LookupRegistry
+    lookupRegistry: LookupRegistry,
+    taskIdTaskStatus: TaskIdTaskStatusMapping
   )(implicit
     hc: HeaderCarrier,
     me: MonadError[F, E]
@@ -56,7 +57,8 @@ object FormModelBuilder {
       cache.accessCode,
       recalculation,
       componentIdToFileId,
-      lookupRegistry
+      lookupRegistry,
+      taskIdTaskStatus
     )
 
   def evalRemoveItemIf[T <: PageMode](
@@ -199,7 +201,8 @@ class FormModelBuilder[E, F[_]: Functor](
   maybeAccessCode: Option[AccessCode],
   recalculation: Recalculation[F, E],
   componentIdToFileId: FormComponentIdToFileIdMapping,
-  lookupRegistry: LookupRegistry
+  lookupRegistry: LookupRegistry,
+  taskIdTaskStatus: TaskIdTaskStatusMapping
 )(implicit
   hc: HeaderCarrier,
   me: MonadError[F, E]
@@ -239,7 +242,8 @@ class FormModelBuilder[E, F[_]: Functor](
         formModel.addToListIds,
         lookupRegistry,
         formModel.lookupRegister,
-        formModel.constraints
+        formModel.constraints,
+        taskIdTaskStatus
       )
 
     recalculation

diff --git a/app/uk/gov/hmrc/gform/objectStore/ObjectStoreController.scala b/app/uk/gov/hmrc/gform/objectStore/ObjectStoreController.scala
@@ -392,7 +392,8 @@ class ObjectStoreController(
                          cacheWithFileRemoved.form.status,
                          cacheWithFileRemoved.form.visitsIndex,
                          cacheWithFileRemoved.form.thirdPartyData,
-                         cacheWithFileRemoved.form.componentIdToFileId
+                         cacheWithFileRemoved.form.componentIdToFileId,
+                         cacheWithFileRemoved.form.taskIdTaskStatus
                        )
                      )
             } yield {

diff --git a/app/uk/gov/hmrc/gform/sharedmodel/form/Form.scala b/app/uk/gov/hmrc/gform/sharedmodel/form/Form.scala
@@ -38,19 +38,23 @@ case class Form(
   visitsIndex: VisitIndex,
   thirdPartyData: ThirdPartyData,
   envelopeExpiryDate: Option[EnvelopeExpiryDate],
-  componentIdToFileId: FormComponentIdToFileIdMapping
+  componentIdToFileId: FormComponentIdToFileIdMapping,
+  taskIdTaskStatus: TaskIdTaskStatusMapping
 )
 
 object Form {
 
   private val thirdPartyData = "thirdPartyData"
   private val componentIdToFileId = "componentIdToFileId"
   private val formTemplateVersion = "version"
+  private val taskIdTaskStatus = "taskIdTaskStatus"
 
   private val thirdPartyDataWithFallback: Reads[ThirdPartyData] =
     (__ \ thirdPartyData).read[ThirdPartyData]
   private val componentIdToFileIdReads: Reads[FormComponentIdToFileIdMapping] =
     (__ \ componentIdToFileId).read[FormComponentIdToFileIdMapping]
+  private val taskIdTaskStatusMappingReads: Reads[TaskIdTaskStatusMapping] =
+    (__ \ taskIdTaskStatus).read[TaskIdTaskStatusMapping]
 
   private val formTemplateVersionWithFallback: Reads[Option[FormTemplateVersion]] =
     (__ \ formTemplateVersion)
@@ -74,7 +78,8 @@ object Form {
       VisitIndex.format and
       thirdPartyDataWithFallback and
       EnvelopeExpiryDate.optionFormat and
-      componentIdToFileIdReads
+      componentIdToFileIdReads and
+      taskIdTaskStatusMappingReads
   )(Form.apply _)
 
   private val writes: OWrites[Form] = OWrites[Form](form =>
@@ -88,7 +93,8 @@ object Form {
       VisitIndex.format.writes(form.visitsIndex) ++
       Json.obj(thirdPartyData -> ThirdPartyData.format.writes(form.thirdPartyData)) ++
       EnvelopeExpiryDate.optionFormat.writes(form.envelopeExpiryDate) ++
-      Json.obj(componentIdToFileId -> FormComponentIdToFileIdMapping.format.writes(form.componentIdToFileId))
+      Json.obj(componentIdToFileId -> FormComponentIdToFileIdMapping.format.writes(form.componentIdToFileId)) ++
+      Json.obj(taskIdTaskStatus -> TaskIdTaskStatusMapping.format.writes(form.taskIdTaskStatus))
   )
 
   implicit val format: OFormat[Form] = OFormat[Form](reads, writes)