CARF-435 Change Link- Do you have a Unique Taxpayer Reference? (#152)

* CARF-435 main impl finished

* CARF-435 page tests done

* CARF-435 match flag and safe id in ua tests

* CARF-435 formatting

Author: simondrugan16

app/config/Constants.scala

@@ -17,6 +17,12 @@
 package config
 
 import models.countries.*
+import pages.IsThisYourBusinessPage
+import pages.individual.*
+import pages.individualWithoutId.*
+import pages.orgWithoutId.*
+import pages.organisation.*
+import queries.Settable
 
 import scala.util.matching.Regex
 
@@ -67,4 +73,31 @@ object Constants {
   val CARFID                                        = "CARFID"
   val registrationSuccessfulEmailTemplateId: String = "carf_registration_successful"
 
+  val indGeneralPage: List[Settable[_]]    = List(HaveNiNumberPage)
+  val indWithNinoPages: List[Settable[_]]  = List(NiNumberPage, WhatIsYourNameIndividualPage, RegisterDateOfBirthPage)
+  val indWithoutIdPages: List[Settable[_]] = List(
+    IndFindAddressAdditionalCallUa,
+    IndFindAddressPage,
+    WhereDoYouLivePage,
+    AddressLookupPage,
+    AddressUPRNUserAnswers,
+    IndWithoutNinoNamePage,
+    IndWithoutIdAddressNonUkPage,
+    IndWithoutIdAddressPagePrePop,
+    IndWithoutIdChooseAddressPage,
+    IndWithoutIdDateOfBirthPage,
+    IndWithoutIdSelectedChooseAddressPage,
+    IndWithoutIdUkAddressInUserAnswers
+  )
+  val orgWithoutIdPages: List[Settable[_]] =
+    List(HaveTradingNamePage, OrganisationBusinessAddressPage, OrgWithoutIdBusinessNamePage, TradingNamePage)
+
+  val withUtrPages: List[Settable[_]] =
+    List(
+      UniqueTaxpayerReferenceInUserAnswers,
+      WhatIsYourNamePage,
+      WhatIsTheNameOfYourBusinessPage,
+      IsThisYourBusinessPage
+    )
+
 }

app/controllers/individualWithoutId/IndFindAddressController.scala

@@ -20,10 +20,9 @@ import controllers.actions.*
 import forms.individualWithoutId.IndFindAddressFormProvider
 import models.countries.CountryUk
 import models.requests.DataRequest
-import models.{AddressUk, AddressesAndUPRN, IndFindAddress, Mode}
+import models.{AddressAndUPRN, AddressUk, IndFindAddress, Mode}
 import navigation.Navigator
 import pages.individualWithoutId.*
-import pages.{AddressLookupPage, AddressUPRNUserAnswers}
 import play.api.Logging
 import play.api.data.{Form, FormError}
 import play.api.i18n.{I18nSupport, MessagesApi}
@@ -94,7 +93,7 @@ class IndFindAddressController @Inject() (
 
   private def save(
       indFindAddress: IndFindAddress,
-      addressesAndUPRNs: Seq[AddressesAndUPRN],
+      addressesAndUPRNs: Seq[AddressAndUPRN],
       additionalCallMade: Boolean
   )(implicit
       request: DataRequest[AnyContent]

app/controllers/individualWithoutId/IndReviewConfirmAddressController.scala

@@ -20,8 +20,7 @@ import controllers.actions.*
 import controllers.routes
 import models.{Mode, NormalMode}
 import navigation.Navigator
-import pages.AddressLookupPage
-import pages.individualWithoutId.{IndReviewConfirmAddressPageForNavigatorOnly, IndWithoutIdUkAddressInUserAnswers}
+import pages.individualWithoutId.{AddressLookupPage, IndReviewConfirmAddressPageForNavigatorOnly, IndWithoutIdUkAddressInUserAnswers}
 import play.api.Logging
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}

app/controllers/individualWithoutId/IndWithoutChooseAddressController.scala

@@ -21,10 +21,9 @@ import controllers.actions.*
 import forms.IndWithoutChooseAddressFormProvider
 import models.countries.CountryUk
 import models.requests.DataRequest
-import models.{format, AddressUk, AddressesAndUPRN, IndFindAddress, Mode, UserAnswers}
+import models.{format, AddressAndUPRN, AddressUk, IndFindAddress, Mode, UserAnswers}
 import navigation.Navigator
-import pages.{AddressLookupPage, AddressUPRNUserAnswers}
-import pages.individualWithoutId.{IndFindAddressAdditionalCallUa, IndFindAddressPage, IndWithoutIdAddressPagePrePop, IndWithoutIdChooseAddressPage, IndWithoutIdSelectedChooseAddressPage, IndWithoutIdUkAddressInUserAnswers}
+import pages.individualWithoutId.*
 import play.api.Logging
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, Messages, MessagesApi}
@@ -54,7 +53,7 @@ class IndWithoutChooseAddressController @Inject() (
     with I18nSupport
     with Logging {
 
-  private case class WithRadiosResult(result: Result, addresses: Seq[AddressesAndUPRN])
+  private case class WithRadiosResult(result: Result, addresses: Seq[AddressAndUPRN])
 
   val form: Form[String] = formProvider()
 
@@ -119,7 +118,7 @@ class IndWithoutChooseAddressController @Inject() (
         )
   }
 
-  private def storeAddress(addressToStore: AddressesAndUPRN, userAnswer: UserAnswers): Future[UserAnswers] =
+  private def storeAddress(addressToStore: AddressAndUPRN, userAnswer: UserAnswers): Future[UserAnswers] =
     for {
       a                  <- Future.fromTry(userAnswer.set(IndWithoutIdSelectedChooseAddressPage, addressToStore.address))
       b                  <- Future.fromTry(a.set(IndWithoutIdUkAddressInUserAnswers, addressToStore.address))
@@ -128,7 +127,7 @@ class IndWithoutChooseAddressController @Inject() (
 
   private def findAddressToStore(mode: Mode, value: String)(implicit
       request: DataRequest[AnyContent]
-  ): Future[Option[AddressesAndUPRN]] = Future.fromTry {
+  ): Future[Option[AddressAndUPRN]] = Future.fromTry {
     val WithRadiosResult(_, addresses) = resultWithRadios(mode) { (_, _) =>
       Redirect(call = controllers.routes.JourneyRecoveryController.onPageLoad())
     }
@@ -140,7 +139,7 @@ class IndWithoutChooseAddressController @Inject() (
         if (value == noneOfTheseValue) {
           Success(None)
         } else {
-          Failure[Option[AddressesAndUPRN]](exception)
+          Failure[Option[AddressAndUPRN]](exception)
         }
       }(address => Success(Some(address)))
   }

app/controllers/individualWithoutId/IndWithoutIdAddressController.scala

@@ -21,7 +21,6 @@ import forms.individualWithoutId.IndWithoutIdAddressFormProvider
 import models.requests.DataRequest
 import models.{AddressUk, Mode}
 import navigation.Navigator
-import pages.AddressUPRNUserAnswers
 import pages.individualWithoutId.*
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}

app/controllers/individualWithoutId/IndWithoutIdAddressNonUkController.scala

@@ -20,7 +20,7 @@ import controllers.actions.*
 import forms.individualWithoutId.IndWithoutIdAddressNonUkFormProvider
 import models.Mode
 import navigation.Navigator
-import pages.individualWithoutId.IndWithoutIdAddressNonUkPage
+import pages.individualWithoutId.{AddressUPRNUserAnswers, IndWithoutIdAddressNonUkPage}
 import play.api.Logging
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
@@ -32,7 +32,6 @@ import views.html.individualWithoutId.IndWithoutIdAddressNonUkView
 import javax.inject.Inject
 import scala.concurrent.{ExecutionContext, Future}
 import models.countries.Country
-import pages.AddressUPRNUserAnswers
 
 class IndWithoutIdAddressNonUkController @Inject() (
     override val messagesApi: MessagesApi,

app/controllers/individualWithoutId/WhereDoYouLiveController.scala

@@ -20,7 +20,7 @@ import controllers.actions.*
 import forms.WhereDoYouLiveFormProvider
 import models.Mode
 import navigation.Navigator
-import pages.WhereDoYouLivePage
+import pages.individualWithoutId.WhereDoYouLivePage
 import play.api.Logging
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}

app/controllers/organisation/HaveUTRController.scala

@@ -17,16 +17,19 @@
 package controllers.organisation
 
 import controllers.actions.*
+import controllers.routes
 import forms.organisation.HaveUTRFormProvider
-import models.{Mode, UniqueTaxpayerReference}
+import models.{ChangeMode, Mode, NormalMode, ProvideMode, UserAnswers}
 import navigation.Navigator
+import pages.orgWithoutId.OrgWithoutIdBusinessNamePage
 import pages.organisation.HaveUTRPage
 import play.api.Logging
+import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}
-import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
+import play.api.mvc.{Action, AnyContent, Call, MessagesControllerComponents}
 import repositories.SessionRepository
-import services.RegistrationService
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
+import utils.UserAnswersHelper
 import views.html.organisation.HaveUTRView
 
 import javax.inject.Inject
@@ -40,17 +43,16 @@ class HaveUTRController @Inject() (
     getData: DataRetrievalAction,
     submissionLock: SubmissionLockAction,
     requireData: DataRequiredAction,
-    service: RegistrationService,
-    retrieveCtUTR: CtUtrRetrievalAction,
     formProvider: HaveUTRFormProvider,
     val controllerComponents: MessagesControllerComponents,
     view: HaveUTRView
 )(implicit ec: ExecutionContext)
     extends FrontendBaseController
     with I18nSupport
-    with Logging {
+    with Logging
+    with UserAnswersHelper {
 
-  val form = formProvider()
+  val form: Form[Boolean] = formProvider()
 
   def onPageLoad(mode: Mode): Action[AnyContent] =
     (identify() andThen getData() andThen submissionLock andThen requireData) { implicit request =>
@@ -70,7 +72,45 @@ class HaveUTRController @Inject() (
             for {
               updatedAnswers <- Future.fromTry(request.userAnswers.set(HaveUTRPage, value))
               _              <- sessionRepository.set(updatedAnswers)
-            } yield Redirect(navigator.nextPage(HaveUTRPage, mode, updatedAnswers))
+            } yield Redirect(
+              handleRedirect(
+                mode = mode,
+                oldUserAnswers = request.userAnswers,
+                newUserAnswers = updatedAnswers,
+                newValue = value
+              )
+            )
         )
   }
+
+  private def handleRedirect(
+      mode: Mode,
+      oldUserAnswers: UserAnswers,
+      newUserAnswers: UserAnswers,
+      newValue: Boolean
+  ): Call =
+    mode match {
+      case NormalMode => navigator.nextPage(HaveUTRPage, mode, newUserAnswers)
+      case _          =>
+        val hasChanged = !oldUserAnswers.get(HaveUTRPage).contains(newValue)
+        changeModeNavigation(newValue = newValue, hasChanged = hasChanged, newUserAnswers)
+    }
+
+  private def changeModeNavigation(newValue: Boolean, hasChanged: Boolean, newUserAnswers: UserAnswers): Call =
+    if (newValue) {
+      controllers.organisation.routes.YourUniqueTaxpayerReferenceController.onPageLoad(ChangeMode)
+    } else {
+      (hasChanged, isSoleTrader(newUserAnswers)) match {
+        case (true, true)   => controllers.individual.routes.HaveNiNumberController.onPageLoad(NormalMode)
+        case (true, false)  => controllers.orgWithoutId.routes.OrgWithoutIdBusinessNameController.onPageLoad(NormalMode)
+        case (false, true)  => controllers.individual.routes.HaveNiNumberController.onPageLoad(ChangeMode)
+        case (false, false) =>
+          if (newUserAnswers.get(OrgWithoutIdBusinessNamePage).isDefined) {
+            controllers.routes.CheckYourAnswersController.onPageLoad()
+          } else {
+            controllers.orgWithoutId.routes.OrgWithoutIdBusinessNameController.onPageLoad(NormalMode)
+          }
+      }
+    }
+
 }

app/models/AddressesAndUPRN.scala app/models/AddressAndUPRN.scalaapp/models/AddressesAndUPRN.scala renamed to app/models/AddressAndUPRN.scala

@@ -18,8 +18,8 @@ package models
 
 import play.api.libs.json.{Json, OFormat}
 
-case class AddressesAndUPRN(address: AddressUk, UPRN: Long)
+case class AddressAndUPRN(address: AddressUk, UPRN: Long)
 
-object AddressesAndUPRN {
-  implicit val format: OFormat[AddressesAndUPRN] = Json.format[AddressesAndUPRN]
+object AddressAndUPRN {
+  implicit val format: OFormat[AddressAndUPRN] = Json.format[AddressAndUPRN]
 }

app/models/responses/AddressResponse.scala

@@ -16,7 +16,7 @@
 
 package models.responses
 
-import models.{AddressUk, AddressesAndUPRN}
+import models.{AddressAndUPRN, AddressUk}
 import models.countries.CountryUk
 import models.error.{CarfError, ConversionError}
 import play.api.libs.json.{Json, OFormat}
@@ -33,12 +33,12 @@ object AddressResponse {
   implicit val format: OFormat[AddressResponse] = Json.format[AddressResponse]
 
   extension (addressResponse: AddressResponse)
-    def toDomainAddressUk: Either[CarfError, AddressesAndUPRN] = {
+    def toDomainAddressUk: Either[CarfError, AddressAndUPRN] = {
       val address = addressResponse.address
       address.lines match {
         case head :: next =>
           Right(
-            AddressesAndUPRN(
+            AddressAndUPRN(
               AddressUk(
                 addressLine1 = head,
                 addressLine2 = next.headOption,