DTR-2951: CIS ANSF: Reset journey when entity type is changed on CYA page (Apply to partnership and individual) (#73)

* DTR-2951: reset journey when entity type is changed on CYA page (Apply to partnership and individual)

* DTR-2951: apply scalafmtAll

* DTR-2951: update address type to InternationalAddress

* DTR-2951: add PartnershipMobileNumberPage and PartnershipPhoneNumberPage to removePartnershipSubcontractor

* DTR-2951: Fix reset journey in NormalMode (not CheckMode)

* DTR-2951: Clean up

* DTR-2951: clean up

* DTR-2951: Clean up

* DTR-2951: update test after merging main

* DTR-2951: remove commented out code

* DTR-2951: clean up

* DTR-2951: apply scalafmtAll

Author: edpau-hmrc

app/controllers/add/company/CompanyPhoneNumberController.scala

@@ -51,7 +51,7 @@ class CompanyPhoneNumberController @Inject() (
       .get(CompanyNamePage)
       .map { companyName =>
         val preparedForm = request.userAnswers.get(CompanyPhoneNumberPage) match {
-          case None => form
+          case None        => form
           case Some(value) => form.fill(value)
         }
 
@@ -72,7 +72,7 @@ class CompanyPhoneNumberController @Inject() (
               value =>
                 for {
                   updatedAnswers <- Future.fromTry(request.userAnswers.set(CompanyPhoneNumberPage, value))
-                  _ <- sessionRepository.set(updatedAnswers)
+                  _              <- sessionRepository.set(updatedAnswers)
                 } yield Redirect(navigator.nextPage(CompanyPhoneNumberPage, mode, updatedAnswers))
             )
         }

app/forms/add/company/CompanyPhoneNumberFormProvider.scala

@@ -34,6 +34,5 @@ class CompanyPhoneNumberFormProvider @Inject() extends Mappings {
             maxLength(Constants.MaxLength35, "companyPhoneNumber.error.length")
           )
         )
-
     )
 }

app/models/contact/ContactOptions.scala

@@ -25,9 +25,9 @@ sealed trait ContactOptions
 
 object ContactOptions extends Enumerable.Implicits {
 
-  case object Email    extends WithName("email")     with ContactOptions
-  case object Phone    extends WithName("phone")     with ContactOptions
-  case object Mobile   extends WithName("mobile")    with ContactOptions
+  case object Email extends WithName("email") with ContactOptions
+  case object Phone extends WithName("phone") with ContactOptions
+  case object Mobile extends WithName("mobile") with ContactOptions
   case object NoDetails extends WithName("noDetails") with ContactOptions
 
   private case object Or extends ContactOptions
@@ -47,7 +47,7 @@ object ContactOptions extends Enumerable.Implicits {
           value = Some(value.toString),
           id = Some(s"value_$index")
         )
-      case (Or, _) =>
+      case (Or, _)                  =>
         RadioItem(divider = Some(messages(s"$messagePrefix.or")))
     }
 

app/navigation/Navigator.scala

@@ -97,7 +97,7 @@ class Navigator @Inject() () {
       _ => controllers.add.partnership.routes.PartnershipMobileNumberController.onPageLoad(NormalMode)
     case PartnershipPhoneNumberPage                =>
       _ => controllers.add.partnership.routes.PartnershipPhoneNumberController.onPageLoad(NormalMode)
-    case CompanyPhoneNumberPage                   =>
+    case CompanyPhoneNumberPage                    =>
       _ => controllers.add.company.routes.CompanyPhoneNumberController.onPageLoad(NormalMode)
     case _                                         => _ => routes.IndexController.onPageLoad()
   }

app/pages/add/CheckYourAnswersSubmittedPage.scala

@@ -20,6 +20,6 @@ import pages.QuestionPage
 import play.api.libs.json.JsPath
 
 case object CheckYourAnswersSubmittedPage extends QuestionPage[Boolean] {
-  override def path: JsPath = JsPath \ toString
+  override def path: JsPath     = JsPath \ toString
   override def toString: String = "checkYourAnswersSubmitted"
 }

app/pages/add/Cleanup.scala

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2026 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package pages.add
+
+import models.UserAnswers
+import pages.add.partnership.*
+import pages.add.company.*
+
+import scala.util.Try
+
+trait Cleanup {
+
+  def removeIndividualSoleTraderSubcontractor(userAnswers: UserAnswers): Try[UserAnswers] =
+    userAnswers
+      .remove(AddressOfSubcontractorPage)
+      .flatMap(_.remove(NationalInsuranceNumberYesNoPage))
+      .flatMap(_.remove(SubAddressYesNoPage))
+      .flatMap(_.remove(SubContactDetailsPage))
+      .flatMap(_.remove(SubcontractorContactDetailsYesNoPage))
+      .flatMap(_.remove(SubcontractorNamePage))
+      .flatMap(_.remove(SubcontractorsUniqueTaxpayerReferencePage))
+      .flatMap(_.remove(SubNationalInsuranceNumberPage))
+      .flatMap(_.remove(SubTradingNameYesNoPage))
+      .flatMap(_.remove(TradingNameOfSubcontractorPage))
+      .flatMap(_.remove(UniqueTaxpayerReferenceYesNoPage))
+      .flatMap(_.remove(WorksReferenceNumberPage))
+      .flatMap(_.remove(WorksReferenceNumberYesNoPage))
+
+  // TODO Add unit test for removeLimitedCompanySubcontractor when company journey is done
+  def removeLimitedCompanySubcontractor(userAnswers: UserAnswers): Try[UserAnswers] =
+    userAnswers
+      .remove(CompanyAddressPage)
+      .flatMap(_.remove(CompanyAddressYesNoPage))
+      .flatMap(_.remove(CompanyContactOptionsPage))
+      .flatMap(_.remove(CompanyCrnPage))
+      .flatMap(_.remove(CompanyCrnYesNoPage))
+      .flatMap(_.remove(CompanyEmailAddressPage))
+      .flatMap(_.remove(CompanyMobileNumberPage))
+      .flatMap(_.remove(CompanyNamePage))
+      .flatMap(_.remove(CompanyPhoneNumberPage))
+      .flatMap(_.remove(CompanyUtrPage))
+      .flatMap(_.remove(CompanyUtrYesNoPage))
+      .flatMap(_.remove(CompanyWorksReferencePage))
+      .flatMap(_.remove(CompanyWorksReferenceYesNoPage))
+
+  def removePartnershipSubcontractor(userAnswers: UserAnswers): Try[UserAnswers] =
+    userAnswers
+      .remove(PartnershipAddressPage)
+      .flatMap(_.remove(PartnershipAddressYesNoPage))
+      .flatMap(_.remove(PartnershipChooseContactDetailsPage))
+      .flatMap(_.remove(PartnershipContactDetailsYesNoPage))
+      .flatMap(_.remove(PartnershipEmailAddressPage))
+      .flatMap(_.remove(PartnershipHasUtrYesNoPage))
+      .flatMap(_.remove(PartnershipMobileNumberPage))
+      .flatMap(_.remove(PartnershipNamePage))
+      .flatMap(_.remove(PartnershipNominatedPartnerCrnPage))
+      .flatMap(_.remove(PartnershipNominatedPartnerCrnYesNoPage))
+      .flatMap(_.remove(PartnershipNominatedPartnerNamePage))
+      .flatMap(_.remove(PartnershipNominatedPartnerNinoPage))
+      .flatMap(_.remove(PartnershipNominatedPartnerNinoYesNoPage))
+      .flatMap(_.remove(PartnershipNominatedPartnerUtrPage))
+      .flatMap(_.remove(PartnershipNominatedPartnerUtrYesNoPage))
+      .flatMap(_.remove(PartnershipPhoneNumberPage))
+      .flatMap(_.remove(PartnershipUniqueTaxpayerReferencePage))
+      .flatMap(_.remove(PartnershipWorksReferenceNumberPage))
+      .flatMap(_.remove(PartnershipWorksReferenceNumberYesNoPage))
+}

app/pages/add/TypeOfSubcontractorPage.scala

@@ -18,38 +18,33 @@ package pages.add
 
 import models.UserAnswers
 import models.add.TypeOfSubcontractor
+import models.add.TypeOfSubcontractor.*
 import pages.QuestionPage
 import play.api.libs.json.JsPath
 
 import scala.util.Try
 
-case object TypeOfSubcontractorPage extends QuestionPage[TypeOfSubcontractor] {
+case object TypeOfSubcontractorPage extends QuestionPage[TypeOfSubcontractor] with Cleanup {
 
   override def path: JsPath = JsPath \ toString
 
   override def toString: String = "typeOfSubcontractor"
 
-  override def cleanup(value: Option[TypeOfSubcontractor], ua: UserAnswers): Try[UserAnswers] = {
-    val previousValue = ua.get(TypeOfSubcontractorPage)
-
-    (previousValue, value) match {
-      case (Some(oldValue), Some(newValue)) if oldValue != newValue =>
-        ua.remove(AddressOfSubcontractorPage)
-          .flatMap(_.remove(NationalInsuranceNumberYesNoPage))
-          .flatMap(_.remove(SubAddressYesNoPage))
-          .flatMap(_.remove(SubContactDetailsPage))
-          .flatMap(_.remove(SubcontractorContactDetailsYesNoPage))
-          .flatMap(_.remove(SubcontractorNamePage))
-          .flatMap(_.remove(SubcontractorsUniqueTaxpayerReferencePage))
-          .flatMap(_.remove(SubNationalInsuranceNumberPage))
-          .flatMap(_.remove(SubTradingNameYesNoPage))
-          .flatMap(_.remove(TradingNameOfSubcontractorPage))
-          .flatMap(_.remove(UniqueTaxpayerReferenceYesNoPage))
-          .flatMap(_.remove(WorksReferenceNumberPage))
-          .flatMap(_.remove(WorksReferenceNumberYesNoPage))
-      // add any new page if added in future
-      case _                                                        =>
+  override def cleanup(value: Option[TypeOfSubcontractor], ua: UserAnswers): Try[UserAnswers] =
+    value match {
+      case Some(Individualorsoletrader) =>
+        removePartnershipSubcontractor(ua)
+          .flatMap(removeLimitedCompanySubcontractor)
+
+      case Some(Limitedcompany) =>
+        removeIndividualSoleTraderSubcontractor(ua)
+          .flatMap(removePartnershipSubcontractor)
+
+      case Some(Partnership) =>
+        removeIndividualSoleTraderSubcontractor(ua)
+          .flatMap(removeLimitedCompanySubcontractor)
+
+      case _ =>
         super.cleanup(value, ua)
     }
-  }
 }

app/viewmodels/checkAnswers/add/TypeOfSubcontractorSummary.scala

@@ -16,7 +16,7 @@
 
 package viewmodels.checkAnswers.add
 
-import models.{CheckMode, UserAnswers}
+import models.{NormalMode, UserAnswers}
 import pages.add.TypeOfSubcontractorPage
 import play.api.i18n.Messages
 import play.twirl.api.HtmlFormat
@@ -42,7 +42,7 @@ object TypeOfSubcontractorSummary {
         actions = Seq(
           ActionItemViewModel(
             "site.change",
-            controllers.add.routes.TypeOfSubcontractorController.onPageLoad(CheckMode).url
+            controllers.add.routes.TypeOfSubcontractorController.onPageLoad(NormalMode).url
           )
             .withVisuallyHiddenText(messages("typeOfSubcontractor.change.hidden"))
             .withAttribute("id" -> "type-of-subcontractor")

test/controllers/add/TypeOfSubcontractorControllerSpec.scala

@@ -35,7 +35,8 @@ import scala.concurrent.Future
 
 class TypeOfSubcontractorControllerSpec extends SpecBase with MockitoSugar {
 
-  lazy val subcontractorTypesRoute = controllers.add.routes.TypeOfSubcontractorController.onPageLoad(NormalMode).url
+  private lazy val subcontractorTypesRoute =
+    controllers.add.routes.TypeOfSubcontractorController.onPageLoad(NormalMode).url
 
   val formProvider = new TypeOfSubcontractorFormProvider()
   val form         = formProvider()
@@ -225,6 +226,5 @@ class TypeOfSubcontractorControllerSpec extends SpecBase with MockitoSugar {
         contentAsString(result) must include(messages(application)("typeOfSubcontractor.error.required"))
       }
     }
-
   }
 }

test/forms/add/company/CompanyPhoneNumberFormProviderSpec.scala

@@ -118,4 +118,4 @@ class CompanyPhoneNumberFormProviderSpec extends StringFieldBehaviours {
       result.value.value mustBe "123 456"
     }
   }
-}
+}