MLPAB-1535: Vary certificate provider phone field label for paper don…

…ors (#1167)
ministryofjustice · Apr 9, 2024 · cbb9127 · cbb9127
1 parent 4b6aef2
commit cbb9127
Show file tree

Hide file tree

Showing 26 changed files with 298 additions and 72 deletions.
diff --git a/cmd/mlpa/main.go b/cmd/mlpa/main.go
@@ -288,7 +288,7 @@ func run(ctx context.Context, logger *slog.Logger) error {
 
 	mux := http.NewServeMux()
 	mux.HandleFunc(page.Paths.HealthCheck.Service.String(), func(w http.ResponseWriter, r *http.Request) {})
-	mux.Handle(page.Paths.HealthCheck.Dependency.String(), page.DependencyHealthCheck(logger, map[string]page.HealthChecker{
+	mux.Handle(page.Paths.HealthCheck.Dependency.String(), page.DependencyHealthCheck(map[string]page.HealthChecker{
 		"uid":      uidClient,
 		"onelogin": oneloginClient,
 		"lpaStore": lpaStoreClient,

diff --git a/cypress/e2e/certificate-provider/confirm-your-details.cy.js b/cypress/e2e/certificate-provider/confirm-your-details.cy.js
@@ -71,5 +71,12 @@ describe('Confirm your details', () => {
       cy.contains('button', 'Continue').click();
       cy.url().should('contain', '/your-role');
     });
+
+    it('shows contact number when donor acting on paper', () => {
+      cy.visit('/fixtures/certificate-provider?redirect=/confirm-your-details&donorChannel=paper');
+
+      cy.contains('Contact number').should('exist');
+      cy.contains('Mobile number').should('not.exist');
+    })
   })
 });
diff --git a/docker/mock-lpa-store/lpa-store.groovy b/docker/mock-lpa-store/lpa-store.groovy
@@ -2,12 +2,16 @@ def lpaStore = stores.open('lpa')
 
 switch (context.request.method) {
     case 'GET':
-        def parts = context.request.path.split('/')
-        def lpa = lpaStore.load(parts[2])
-        if (lpa) {
-            respond().withContent(lpa)
+        if (context.request.path.contains('/lpa')) {
+            def parts = context.request.path.split('/')
+            def lpa = lpaStore.load(parts[2])
+            if (lpa) {
+                respond().withContent(lpa)
+            } else {
+                respond().withStatusCode(404)
+            }
         } else {
-            respond().withStatusCode(404)
+            respond()
         }
         break
 

diff --git a/docs/conventions/template-logic.md b/docs/conventions/template-logic.md
@@ -0,0 +1,25 @@
+# Template logic
+
+Logic that varies content in page templates should be controlled in code rather than the template. For example:
+
+```gotemplate
+      {{ $detailsContent := "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentLay" }}
+
+      {{ if .Lpa.CertificateProvider.Relationship.IsProfessionally }}
+        {{ $detailsContent = "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentProfessional" }}
+      {{ end }}
+```
+
+should be set in a handler:
+
+```go
+data := &confirmYourDetailsData{
+    DetailComponentContent: "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentLay",
+}
+
+if lpa.CertificateProvider.Relationship.IsProfessionally() {
+    data.DetailComponentContent = "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentProfessional"
+}
+```
+
+This allows for easier testing in unit tests vs e2e tests and keeps logic in one place.
diff --git a/internal/actor/channel.go b/internal/actor/channel.go
@@ -0,0 +1,9 @@
+package actor
+
+//go:generate enumerator -type Channel -linecomment -empty -trimprefix
+type Channel uint8
+
+const (
+	ChannelPaper  Channel = iota + 1 // paper
+	ChannelOnline                    // online
+)
diff --git a/internal/actor/donor.go b/internal/actor/donor.go
@@ -30,6 +30,8 @@ type Donor struct {
 	ThinksCanSign YesNoMaybe
 	// CanSign is Yes if the donor has said they will sign online
 	CanSign form.YesNo
+	// Channel is how the Donor is applying for their LPA (paper or online)
+	Channel Channel
 }
 
 func (d Donor) FullName() string {

diff --git a/internal/actor/donor_provided_test.go b/internal/actor/donor_provided_test.go
@@ -27,12 +27,12 @@ func TestGenerateHash(t *testing.T) {
 	}}
 	hash, err := donor.GenerateHash()
 	assert.Nil(t, err)
-	assert.Equal(t, uint64(0x237cd6c0f6339a69), hash)
+	assert.Equal(t, uint64(0x297cf8fea06bba4f), hash)
 
 	donor.Attorneys.Attorneys[0].DateOfBirth = date.New("2001", "1", "2")
 	hash, err = donor.GenerateHash()
 	assert.Nil(t, err)
-	assert.Equal(t, uint64(0xf28a35e77ddfb6c0), hash)
+	assert.Equal(t, uint64(0xfb9a92b69eaeee6), hash)
 }
 
 func TestIdentityConfirmed(t *testing.T) {

diff --git a/internal/actor/enum_channel.go b/internal/actor/enum_channel.go
diff --git a/internal/app/app.go b/internal/app/app.go
@@ -124,13 +124,13 @@ func App(
 	handleRoot(page.Paths.Fixtures, None,
 		fixtures.Donor(tmpls.Get("fixtures.gohtml"), sessionStore, donorStore, certificateProviderStore, attorneyStore, documentStore, eventClient, lpaStoreClient))
 	handleRoot(page.Paths.CertificateProviderFixtures, None,
-		fixtures.CertificateProvider(tmpls.Get("certificate_provider_fixtures.gohtml"), sessionStore, shareCodeSender, donorStore, certificateProviderStore, eventClient, lpaStoreClient))
+		fixtures.CertificateProvider(tmpls.Get("certificate_provider_fixtures.gohtml"), sessionStore, shareCodeSender, donorStore, certificateProviderStore, eventClient, lpaStoreClient, lpaDynamoClient))
 	handleRoot(page.Paths.AttorneyFixtures, None,
 		fixtures.Attorney(tmpls.Get("attorney_fixtures.gohtml"), sessionStore, shareCodeSender, donorStore, certificateProviderStore, attorneyStore, eventClient, lpaStoreClient))
 	handleRoot(page.Paths.SupporterFixtures, None,
 		fixtures.Supporter(sessionStore, organisationStore, donorStore, memberStore, lpaDynamoClient, searchClient, shareCodeStore, certificateProviderStore, attorneyStore, documentStore, eventClient, lpaStoreClient))
 	handleRoot(page.Paths.DashboardFixtures, None,
-		fixtures.Dashboard(tmpls.Get("dashboard_fixtures.gohtml"), sessionStore, shareCodeSender, donorStore, certificateProviderStore, attorneyStore))
+		fixtures.Dashboard(tmpls.Get("dashboard_fixtures.gohtml"), sessionStore, donorStore, certificateProviderStore, attorneyStore))
 	handleRoot(page.Paths.YourLegalRightsAndResponsibilities, None,
 		page.Guidance(tmpls.Get("your_legal_rights_and_responsibilities_general.gohtml")))
 	handleRoot(page.Paths.Start, None,

diff --git a/internal/app/donor_store.go b/internal/app/donor_store.go
@@ -66,7 +66,8 @@ func (s *donorStore) Create(ctx context.Context) (*actor.DonorProvidedDetails, e
 		CreatedAt: s.now(),
 		Version:   1,
 		Donor: actor.Donor{
-			UID: donorUID,
+			UID:     donorUID,
+			Channel: actor.ChannelOnline,
 		},
 	}
 

diff --git a/internal/app/donor_store_test.go b/internal/app/donor_store_test.go
@@ -627,6 +627,7 @@ func TestDonorStoreCreate(t *testing.T) {
 					OtherNames:  previousDetails.Donor.OtherNames,
 					DateOfBirth: previousDetails.Donor.DateOfBirth,
 					Address:     previousDetails.Donor.Address,
+					Channel:     actor.ChannelOnline,
 				},
 			}
 			donor.Hash, _ = donor.GenerateHash()

diff --git a/internal/lpastore/resolving_service.go b/internal/lpastore/resolving_service.go
@@ -50,11 +50,13 @@ func (s *ResolvingService) Get(ctx context.Context) (*Lpa, error) {
 		// set to Professionally so we always show the certificate provider home
 		// address question
 		lpa.CertificateProvider.Relationship = actor.Professionally
+		lpa.Donor.Channel = actor.ChannelPaper
 	} else {
 		lpa.DonorIdentityConfirmed = donor.DonorIdentityConfirmed()
 		lpa.Submitted = !donor.SubmittedAt.IsZero()
 		lpa.Paid = donor.Tasks.PayForLpa.IsCompleted()
 		lpa.IsOrganisationDonor = strings.HasPrefix(donor.SK, dynamo.OrganisationKey(""))
+		lpa.Donor.Channel = actor.ChannelOnline
 
 		// copy the relationship as it isn't stored in the lpastore.
 		lpa.CertificateProvider.Relationship = donor.CertificateProvider.Relationship

diff --git a/internal/lpastore/resolving_service_test.go b/internal/lpastore/resolving_service_test.go
@@ -22,7 +22,7 @@ func TestResolvingServiceGet(t *testing.T) {
 		error    error
 		expected *Lpa
 	}{
-		"digital with all true": {
+		"online with all true": {
 			donor: &actor.DonorProvidedDetails{
 				SK:           dynamo.OrganisationKey("S"),
 				LpaID:        "1",
@@ -58,16 +58,18 @@ func TestResolvingServiceGet(t *testing.T) {
 					FirstNames:   "Paul",
 					Relationship: actor.Personally,
 				},
+				Donor: actor.Donor{Channel: actor.ChannelOnline},
 			},
 		},
-		"digital with no lpastore record": {
+		"online with no lpastore record": {
 			donor: &actor.DonorProvidedDetails{
 				SK:     dynamo.DonorKey("S"),
 				LpaUID: "M-1111",
 				CertificateProvider: actor.CertificateProvider{
 					FirstNames:   "John",
 					Relationship: actor.Personally,
 				},
+				Donor: actor.Donor{Channel: actor.ChannelOnline},
 			},
 			error: ErrNotFound,
 			expected: &Lpa{
@@ -76,9 +78,10 @@ func TestResolvingServiceGet(t *testing.T) {
 					FirstNames:   "John",
 					Relationship: actor.Personally,
 				},
+				Donor: actor.Donor{Channel: actor.ChannelOnline},
 			},
 		},
-		"digital with all false": {
+		"online with all false": {
 			donor: &actor.DonorProvidedDetails{
 				SK:     dynamo.DonorKey("S"),
 				LpaID:  "1",
@@ -88,6 +91,7 @@ func TestResolvingServiceGet(t *testing.T) {
 			expected: &Lpa{
 				LpaID:  "1",
 				LpaUID: "M-1111",
+				Donor:  actor.Donor{Channel: actor.ChannelOnline},
 			},
 		},
 		"paper": {
@@ -105,6 +109,7 @@ func TestResolvingServiceGet(t *testing.T) {
 				CertificateProvider: actor.CertificateProvider{
 					Relationship: actor.Professionally,
 				},
+				Donor: actor.Donor{Channel: actor.ChannelPaper},
 			},
 		},
 	}
@@ -151,6 +156,7 @@ func TestResolvingServiceGetWhenNotFound(t *testing.T) {
 	assert.Equal(t, &Lpa{
 		LpaID:  "1",
 		LpaUID: "M-1111",
+		Donor:  actor.Donor{Channel: actor.ChannelOnline},
 	}, lpa)
 	assert.Nil(t, err)
 }

diff --git a/internal/page/certificateprovider/confirm_your_details.go b/internal/page/certificateprovider/confirm_your_details.go
@@ -11,10 +11,13 @@ import (
 )
 
 type confirmYourDetailsData struct {
-	App                 page.AppData
-	Errors              validation.List
-	Lpa                 *lpastore.Lpa
-	CertificateProvider *actor.CertificateProviderProvidedDetails
+	App                    page.AppData
+	Errors                 validation.List
+	Lpa                    *lpastore.Lpa
+	CertificateProvider    *actor.CertificateProviderProvidedDetails
+	PhoneNumberLabel       string
+	AddressLabel           string
+	DetailComponentContent string
 }
 
 func ConfirmYourDetails(tmpl template.Template, lpaStoreResolvingService LpaStoreResolvingService, certificateProviderStore CertificateProviderStore) page.Handler {
@@ -45,9 +48,21 @@ func ConfirmYourDetails(tmpl template.Template, lpaStoreResolvingService LpaStor
 		}
 
 		data := &confirmYourDetailsData{
-			App:                 appData,
-			CertificateProvider: certificateProvider,
-			Lpa:                 lpa,
+			App:                    appData,
+			CertificateProvider:    certificateProvider,
+			Lpa:                    lpa,
+			PhoneNumberLabel:       "mobileNumber",
+			AddressLabel:           "address",
+			DetailComponentContent: "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentLay",
+		}
+
+		if lpa.Donor.Channel.IsPaper() {
+			data.PhoneNumberLabel = "contactNumber"
+		}
+
+		if lpa.CertificateProvider.Relationship.IsProfessionally() {
+			data.AddressLabel = "workAddress"
+			data.DetailComponentContent = "whatToDoIfAnyDetailsAreIncorrectCertificateProviderContentProfessional"
 		}
 
 		return tmpl(w, data)