APB-10940 Sole trader journey enabled inc individual journey (#212)

Author: nubz

app/uk/gov/hmrc/agentregistrationfrontend/RoutesExports.scala

@@ -18,6 +18,7 @@ package uk.gov.hmrc.agentregistrationfrontend
 
 object RoutesExports:
 
+  export uk.gov.hmrc.play.bootstrap.binders.RedirectUrl
   export uk.gov.hmrc.agentregistration.shared.BusinessType
   export uk.gov.hmrc.agentregistration.shared.AgentType
   export uk.gov.hmrc.agentregistration.shared.LinkId

app/uk/gov/hmrc/agentregistrationfrontend/config/AppConfig.scala

@@ -77,6 +77,7 @@ class AppConfig @Inject() (
     .addParam("affinityGroup", affinityGroup.toString.toLowerCase)
 
   def applicationLink(linkId: String): Uri = uri"$thisFrontendBaseUrl/agent-registration/provide-details/start/$linkId"
+  def soleTraderProvideDetailsLink(linkId: String): Uri = uri"$thisFrontendBaseUrl/agent-registration/provide-details/match-application/$linkId"
 
   val welshLanguageSupportEnabled: Boolean = configuration.getOptional[Boolean]("features.welsh-language-support").getOrElse(false)
   val contactFrontendId: String = configuration.get[String]("contact-frontend.serviceId") // TODO placeholder
@@ -85,6 +86,8 @@ class AppConfig @Inject() (
     .getOptional[Boolean]("ignoreEmailVerification")
     .getOrElse(false)
 
+  val allowedRedirectHosts: Set[String] = configuration.getOptional[Seq[String]]("allowed-redirect-hosts").getOrElse(Nil).toSet
+
   /*
    * GRS CONFIG START
    */

app/uk/gov/hmrc/agentregistrationfrontend/controllers/AppRoutes.scala

@@ -27,6 +27,7 @@ import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.checkfailed.r
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.applicantcontactdetails.routes as applicantcontactdetailsRoutes
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.agentdetails.routes as agentdetailsRoutes
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.routes as listdetailsRoutes
+import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.soletrader.routes as listdetailsSoleTraderRoutes
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.nonincorporated.routes as listdetailsNonIncorporatedRoutes
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.incorporated.routes as listdetailsIncorporatedRoutes
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.otherrelevantindividuals.routes as listdetailsOthersRoutes
@@ -94,6 +95,10 @@ object AppRoutes:
 
       val CheckYourAnswersController = listdetailsRoutes.CheckYourAnswersController
 
+      object soletrader:
+
+        val ProveIdentityController = listdetailsSoleTraderRoutes.ProveIdentityController
+
       object nonincorporated:
 
         val NumberOfKeyIndividualsController = listdetailsNonIncorporatedRoutes.NumberOfKeyIndividualsController

app/uk/gov/hmrc/agentregistrationfrontend/controllers/SignOutController.scala

@@ -20,10 +20,11 @@ import play.api.mvc.Action
 import play.api.mvc.AnyContent
 import play.api.mvc.DefaultActionBuilder
 import play.api.mvc.MessagesControllerComponents
-import play.api.mvc.Result
 import sttp.model.Uri.UriContext
 import uk.gov.hmrc.agentregistrationfrontend.config.AppConfig
+import uk.gov.hmrc.agentregistrationfrontend.util.RequestSupport.validateRedirectUrl
 import uk.gov.hmrc.agentregistrationfrontend.views.html.TimedOutPage
+import uk.gov.hmrc.play.bootstrap.binders.RedirectUrl
 
 import javax.inject.Inject
 import javax.inject.Singleton
@@ -37,17 +38,18 @@ class SignOutController @Inject() (
 )
 extends FrontendControllerBase(mcc):
 
-  private def signOutWithContinue(continue: String): Result =
-    val signOutAndRedirectUrl: String = uri"""${appConfig.basFrontendSignOutUrlBase}?${Map("continue" -> continue)}""".toString
+  def signOutWithContinue(continue: RedirectUrl): Action[AnyContent] = defaultActionBuilder:
+    val validatedRedirect = validateRedirectUrl(continue, appConfig.allowedRedirectHosts)
+    val signOutAndRedirectUrl: String = uri"""${appConfig.basFrontendSignOutUrlBase}?${Map("continue" -> validatedRedirect)}""".toString
     Redirect(signOutAndRedirectUrl)
 
   def signOut: Action[AnyContent] = defaultActionBuilder:
     val continueUrl = uri"${appConfig.thisFrontendBaseUrl + AppRoutes.apply.AgentApplicationController.landing.url}"
-    signOutWithContinue(continueUrl.toString)
+    Redirect(AppRoutes.SignOutController.signOutWithContinue(RedirectUrl(continueUrl.toString)))
 
   def timeOut: Action[AnyContent] = defaultActionBuilder:
     val continueUrl = uri"${appConfig.thisFrontendBaseUrl + AppRoutes.SignOutController.timedOut.url}"
-    signOutWithContinue(continueUrl.toString)
+    Redirect(AppRoutes.SignOutController.signOutWithContinue(RedirectUrl(continueUrl.toString)))
 
   def timedOut: Action[AnyContent] = defaultActionBuilder:
     implicit request =>

app/uk/gov/hmrc/agentregistrationfrontend/controllers/applicant/aboutyourbusiness/UserRoleController.scala

@@ -20,6 +20,7 @@ import play.api.mvc.*
 import uk.gov.hmrc.agentregistration.shared.BusinessType
 import uk.gov.hmrc.agentregistration.shared.BusinessType.SoleTrader
 import uk.gov.hmrc.agentregistration.shared.UserRole
+import uk.gov.hmrc.agentregistration.shared.util.SafeEquals.===
 import uk.gov.hmrc.agentregistrationfrontend.action.applicant.ApplicantActions
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.FrontendController
 import uk.gov.hmrc.agentregistrationfrontend.forms.UserRoleForm
@@ -49,9 +50,10 @@ extends FrontendController(mcc, actions):
       .ensureValidForm(UserRoleForm.form, implicit request => view(_, userRoleOptionForBusinessType(request.getBusinessType))):
         implicit request =>
           val userRole: UserRole = request.get
-          Redirect(
-            AppRoutes.apply.aboutyourbusiness.TypeOfSignInController.show.url
-          ).addToSession(userRole)
+          // TODO: currently no support for non-business owners on the sole trader journey, but there will be once designed
+          if request.getBusinessType === SoleTrader && userRole === UserRole.Authorised
+          then Redirect(AppRoutes.apply.AgentApplicationController.genericExitPage).addToSession(userRole)
+          else Redirect(AppRoutes.apply.aboutyourbusiness.TypeOfSignInController.show.url).addToSession(userRole)
 
   private def userRoleOptionForBusinessType(
     businessType: BusinessType

app/uk/gov/hmrc/agentregistrationfrontend/controllers/applicant/internal/GrsController.scala

@@ -32,10 +32,10 @@ import uk.gov.hmrc.agentregistration.shared.businessdetails.BusinessDetailsSoleT
 import uk.gov.hmrc.agentregistration.shared.util.Errors.getOrThrowExpectedDataMissing
 import uk.gov.hmrc.agentregistration.shared.util.SafeEquals.===
 import uk.gov.hmrc.agentregistrationfrontend.action.applicant.ApplicantActions
-import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.internal.GrsController.*
 import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.FrontendController
-import uk.gov.hmrc.agentregistrationfrontend.model.grs.JourneyId
+import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.internal.GrsController.*
 import uk.gov.hmrc.agentregistrationfrontend.model.grs.JourneyData
+import uk.gov.hmrc.agentregistrationfrontend.model.grs.JourneyId
 import uk.gov.hmrc.agentregistrationfrontend.model.grs.RegistrationStatus
 import uk.gov.hmrc.agentregistrationfrontend.services.GrsService
 import uk.gov.hmrc.agentregistrationfrontend.services.applicant.AgentApplicationService

app/uk/gov/hmrc/agentregistrationfrontend/controllers/applicant/listdetails/soletrader/ProveIdentityController.scala

@@ -0,0 +1,107 @@
+/*
+ * Copyright 2025 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 uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.listdetails.soletrader
+
+import com.softwaremill.quicklens.modify
+import play.api.mvc.Action
+import play.api.mvc.AnyContent
+import play.api.mvc.MessagesControllerComponents
+import uk.gov.hmrc.agentregistration.shared.AgentApplication
+import uk.gov.hmrc.agentregistration.shared.AgentApplicationSoleTrader
+import uk.gov.hmrc.agentregistration.shared.UserRole
+import uk.gov.hmrc.agentregistration.shared.businessdetails.BusinessDetailsSoleTrader
+import uk.gov.hmrc.agentregistration.shared.contactdetails.ApplicantContactDetails
+import uk.gov.hmrc.agentregistration.shared.individual.IndividualProvidedDetails
+import uk.gov.hmrc.agentregistration.shared.individual.IndividualVerifiedEmailAddress
+import uk.gov.hmrc.agentregistration.shared.individual.ProvidedDetailsState
+import uk.gov.hmrc.agentregistration.shared.lists.IndividualName
+import uk.gov.hmrc.agentregistration.shared.util.SafeEquals.===
+import uk.gov.hmrc.agentregistrationfrontend.action.applicant.ApplicantActions
+import uk.gov.hmrc.agentregistrationfrontend.controllers.applicant.FrontendController
+import uk.gov.hmrc.agentregistrationfrontend.services.individual.IndividualProvideDetailsService
+import uk.gov.hmrc.agentregistrationfrontend.views.html.applicant.listdetails.soletrader.ProveIdentityPage
+
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class ProveIdentityController @Inject() (
+  mcc: MessagesControllerComponents,
+  actions: ApplicantActions,
+  view: ProveIdentityPage,
+  individualProvideDetailsService: IndividualProvideDetailsService
+)
+extends FrontendController(mcc, actions):
+
+  private type DataWithSoleTrader = IndividualProvidedDetails *: List[IndividualProvidedDetails] *: DataWithApplication
+
+  private val baseAction: ActionBuilderWithData[DataWithSoleTrader] = actions
+    .getApplicationInProgress
+    .refine(implicit request =>
+      val agentApplication: AgentApplication = request.get
+      individualProvideDetailsService.findAllByApplicationId(agentApplication.agentApplicationId).map: individualsList =>
+        request.add[List[IndividualProvidedDetails]](individualsList)
+    )
+    .refine(implicit request =>
+      val existingList: List[IndividualProvidedDetails] = request.get
+      val agentApplication: AgentApplication = request.get
+      existingList match
+        case Nil =>
+          agentApplication match
+            case agentApplication: AgentApplicationSoleTrader =>
+              val soleTraderDetails: BusinessDetailsSoleTrader = agentApplication.getBusinessDetails
+              val applicantContactDetails: ApplicantContactDetails = agentApplication.getApplicantContactDetails
+              val newRecord = individualProvideDetailsService.create(
+                agentApplicationId = agentApplication.agentApplicationId,
+                individualName = IndividualName(s"${soleTraderDetails.fullName.firstName} ${soleTraderDetails.fullName.lastName}"),
+                isPersonOfControl = agentApplication.getUserRole === UserRole.Owner
+              )
+                .modify(_.providedDetailsState)
+                .setTo(ProvidedDetailsState.AccessConfirmed) // no link to send - access to individual journey is provided by the task list
+                .modify(_.isPersonOfControl)
+                .setTo(agentApplication.getUserRole === UserRole.Owner)
+                .modify(_.telephoneNumber)
+                .setTo(applicantContactDetails.telephoneNumber)
+                .modify(_.emailAddress)
+                .setTo(Some(IndividualVerifiedEmailAddress(
+                  emailAddress = applicantContactDetails.getVerifiedEmail,
+                  isVerified = true
+                )))
+                .modify(_.hasApprovedApplication)
+                .setTo(Some(true)) // Sole trader owners applicants are always approved as they are the same person
+                .modify(_.hmrcStandardForAgentsAgreed)
+                .setTo(agentApplication.hmrcStandardForAgentsAgreed)
+              individualProvideDetailsService
+                .upsertForApplication(newRecord)
+                .map: _ =>
+                  request.add[IndividualProvidedDetails](newRecord)
+            case _: AgentApplication.IsNotSoleTrader =>
+              logger.warn(s"Unexpected application type for sole trader details, applicationId:[${agentApplication.agentApplicationId}], redirect to task list for overview")
+              Redirect(AppRoutes.apply.TaskListController.show)
+        case soleTrader :: Nil => request.add[IndividualProvidedDetails](soleTrader) // we have already visited this page and the record has been created
+        case _ =>
+          logger.warn(s"Unexpected multiple provided details records for sole trader application, applicationId:[${agentApplication.agentApplicationId}], cannot recover from this state so exiting")
+          Redirect(AppRoutes.apply.AgentApplicationController.genericExitPage)
+    )
+
+  def show: Action[AnyContent] = baseAction:
+    implicit request =>
+      val individualProvidedDetails: IndividualProvidedDetails = request.get
+      Ok(view(
+        agentApplication = request.get[AgentApplication],
+        hasProvedIdentity = individualProvidedDetails.hasFinished
+      ))

app/uk/gov/hmrc/agentregistrationfrontend/controllers/individual/CheckYourAnswersController.scala

@@ -22,6 +22,7 @@ import play.api.mvc.Action
 import play.api.mvc.AnyContent
 import play.api.mvc.MessagesControllerComponents
 import com.softwaremill.quicklens.modify
+import uk.gov.hmrc.agentregistration.shared.AgentApplication
 import uk.gov.hmrc.agentregistration.shared.LinkId
 import uk.gov.hmrc.agentregistration.shared.StateOfAgreement
 import uk.gov.hmrc.agentregistration.shared.individual.IndividualProvidedDetails
@@ -76,6 +77,19 @@ extends FrontendController(mcc, actions):
       implicit request =>
         Redirect(AppRoutes.providedetails.IndividualHmrcStandardForAgentsController.show(linkId).url)
     )
+    .ensure(
+      // we have all the answers complete
+      // but only show the CYA page if not sole trader
+      // as sole trader answers were copied in from the application
+      !_.get[AgentApplication].isSoleTrader,
+      implicit request =>
+        individualProvideDetailsService.upsert(
+          request.get[IndividualProvidedDetails]
+            .modify(_.providedDetailsState)
+            .setTo(Finished)
+        ).map: _ =>
+          Redirect(AppRoutes.providedetails.IndividualConfirmationController.show(linkId).url)
+    )
 
   def show(linkId: LinkId): Action[AnyContent] =
     baseAction(linkId):
@@ -94,3 +108,9 @@ extends FrontendController(mcc, actions):
             .setTo(Finished)
         ).map: _ =>
           Redirect(AppRoutes.providedetails.IndividualConfirmationController.show(linkId))
+
+  extension (agentApplication: AgentApplication)
+    def isSoleTrader: Boolean =
+      agentApplication match
+        case _: AgentApplication.IsSoleTrader => true
+        case _ => false

app/uk/gov/hmrc/agentregistrationfrontend/controllers/individual/IndividualConfirmationController.scala

@@ -54,5 +54,10 @@ extends FrontendController(mcc, actions):
         .map: optBpr =>
           Ok(individualConfirmationPage(
             applicantName = applicantName.value,
-            entityName = optBpr.map(_.getEntityName).getOrThrowExpectedDataMissing("BPR is missing")
+            entityName = optBpr.map(_.getEntityName).getOrThrowExpectedDataMissing("BPR is missing"),
+            isSoleTrader =
+              agentApplication match {
+                case _: AgentApplication.IsSoleTrader => true
+                case _ => false
+              }
           ))

app/uk/gov/hmrc/agentregistrationfrontend/model/AgentApplicationExt.scala

@@ -45,9 +45,12 @@ extension (agentApplication: AgentApplication)
         case a: AgentApplication.IsIncorporated =>
           NumberOfIndividuals.isKeyIndividualListComplete(existingList.count(_.isPersonOfControl), a.numberOfIndividuals)
           && otherRelevantIndividualsComplete(existingList)
-        case _ => false
+        case _: AgentApplication.IsSoleTrader => true
 
-    val listProgressComplete = listDetailsCompleted(existingList) && existingList.forall(_.hasFinished)
+    val listProgressComplete =
+      existingList.nonEmpty
+        && listDetailsCompleted(existingList)
+        && existingList.forall(_.hasFinished)
     // any state other than Precreated indicates the link has been sent; require the list to be non-empty
     val listSharingComplete =
       listDetailsCompleted(existingList) &&