HDPI-3519: added page url tracking for feedback link

src/main/app.ts

@@ -7,7 +7,7 @@ import { glob } from 'glob';
 import favicon from 'serve-favicon';
 
 import { setupDev } from './development';
-import { caseReferenceParamMiddleware } from './middleware';
+import { caseReferenceParamMiddleware, pageTrackingUrlMiddleware } from './middleware';
 import * as modules from './modules';
 import { setupErrorHandlers } from './modules/error-handler';
 import { registerAllJourneys } from './routes/registerSteps';
@@ -38,6 +38,8 @@ app.use((req, res, next) => {
   next();
 });
 
+app.use(pageTrackingUrlMiddleware);
+
 // param middleware for caseReference
 app.param('caseReference', caseReferenceParamMiddleware);
 

src/main/assets/locales/cy/common.json

@@ -1,7 +1,7 @@
 {
   "serviceName": "cyRespond to a property possession claim",
   "phase": "cyALPHA",
-  "feedback": "cyThis is a new service – your <a href=\"#\" class=\"govuk-link\">feedback</a> will help us to improve it.",
+  "feedback": "cyThis is a new service – your <a href=\"https://www.smartsurvey.co.uk/s/Poss_feedback/?pageurl={{pageTrackingUrl}}\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"govuk-link\">feedback (opens in new tab)</a> will help us to improve it.",
   "languageToggle": "<a href=\"?lang=en\" class=\"govuk-link language\">English</a>",
   "logout": "cySign out",
   "navigationLabel": "cyService navigation",

src/main/assets/locales/en/common.json

@@ -1,7 +1,7 @@
 {
   "serviceName": "Respond to a property possession claim",
   "phase": "ALPHA",
-  "feedback": "This is a new service – your <a href=\"#\" class=\"govuk-link\">feedback</a> will help us to improve it.",
+  "feedback": "This is a new service – your <a href=\"https://www.smartsurvey.co.uk/s/Poss_feedback/?pageurl={{pageTrackingUrl}}\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"govuk-link\">feedback (opens in new tab)</a> will help us to improve it.",
   "languageToggle": "<a href=\"?lang=cy\" class=\"govuk-link language\">Cymraeg</a>",
   "logout": "Sign out",
   "navigationLabel": "Service navigation",

src/main/middleware/index.ts

@@ -1,2 +1,3 @@
 export * from './oidc';
 export * from './caseReference';
+export * from './pageTrackingUrl';

src/main/middleware/pageTrackingUrl.ts

@@ -0,0 +1,21 @@
+import { NextFunction, Request, Response } from 'express';
+
+const getPageTrackingUrl = (path: string): string => {
+  const segments = path.split('/').filter(Boolean);
+
+  if (segments[0] === 'dashboard') {
+    return 'dashboard';
+  }
+
+  if (segments[0] === 'case' && segments.length > 2) {
+    return `${segments.slice(2).join('/')}`;
+  }
+
+  return path;
+};
+
+export const pageTrackingUrlMiddleware = (req: Request, res: Response, next: NextFunction): void => {
+  const pageTrackingUrl = getPageTrackingUrl(req.path);
+  res.locals.pageTrackingUrl = pageTrackingUrl;
+  next();
+};

src/main/modules/i18n/index.ts

@@ -67,7 +67,6 @@ export type AllowedLang = (typeof allowedLanguages)[number];
 export const COMMON_TRANSLATION_KEYS = [
   'serviceName',
   'phase',
-  'feedback',
   'back',
   'languageToggle',
   'contactUsForHelp',

src/main/modules/steps/formBuilder/formContent.ts

@@ -72,7 +72,6 @@ export function buildFormContent(
     errorSummary,
     serviceName: t('serviceName'),
     phase: t('phase'),
-    feedback: t('feedback'),
     back: t('back'),
     contactUsForHelp: t('contactUsForHelp'),
     contactUsForHelpText: t('contactUsForHelpText'),

src/main/views/journeyTemplate.njk

@@ -34,7 +34,7 @@
   <div class="govuk-width-container">
     {{ govukPhaseBanner({
       tag: { text: t('phase', 'Alpha') },
-      html: (t('feedback') | safe)
+      html: (t('feedback', { pageTrackingUrl: pageTrackingUrl }) | safe)
     }) }}
 
   </div>

src/main/views/stepsTemplate.njk

@@ -46,7 +46,7 @@
       tag: {
         text: (phase or t('phase') or 'ALPHA') | safe
       },
-      html: ((feedback or t('feedback') or '')) | safe
+      html: ((feedback or t('feedback', { pageTrackingUrl: pageTrackingUrl }) or '')) | safe
     }) }}
   </div>
   {% if backUrl %}

src/main/views/template.njk

@@ -47,7 +47,7 @@
       tag: {
         text: (phase or t('phase') or 'ALPHA') | safe
       },
-      html: ((feedback or t('feedback') or '')) | safe
+      html: ((feedback or t('feedback', { pageTrackingUrl: pageTrackingUrl }) or '')) | safe
     }) }}
   </div>
   {% if backUrl %}

src/test/ui/data/page-data/confirmationOfNoticeGiven.page.data.ts

@@ -17,4 +17,6 @@ export const confirmationOfNoticeGiven = {
   selectIfNoticeOfIntentionGivenErrorMessage(claimantName: string): string {
     return `Select if ${claimantName} gave you notice of their intention to begin possession proceedings`;
   },
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `confirmation-of-notice-given`,
 };

src/test/ui/data/page-data/contactPreferenceEmailOrPost.page.data.ts

@@ -22,4 +22,6 @@ export const contactPreferenceEmailOrPost = {
   selectHowYouWantToReceiveUpdatesErrorMessage: `Select how you want to receive updates`,
   enterEmailAddressErrorMessage: `Enter your email address`,
   invalidEmailAddressErrorMessage: `Enter an email address in the correct format, like name@example.com`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `contact-preferences-email-or-post`,
 };

src/test/ui/data/page-data/contactPreferencesTelephone.page.data.ts

@@ -18,4 +18,6 @@ export const contactPreferencesTelephone = {
   selectWhetherHappyToBeContactedByTelephoneErrorMessage: `Select whether you’re happy to be contacted by telephone`,
   enterUKPhoneNumberErrorMessage: `Enter a UK phone number`,
   enterUKPhoneNumberFormatErrorMessage: `Enter a phone number, like 01632 960 001 or 07700 900 982`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `contact-preferences-telephone`,
 };

src/test/ui/data/page-data/contactPreferencesTextMessage.page.data.ts

@@ -11,4 +11,6 @@ export const contactPreferencesTextMessage = {
   backLink: `Back`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
   selectIfYouWantErrorMessage: `Select if you want to be contacted by text message.`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `contact-preferences-text-message`,
 };

src/test/ui/data/page-data/dateOfBirth.page.data.ts

@@ -25,4 +25,6 @@ export const dateOfBirth = {
   backLink: `Back`,
   saveAndContinueButton: `Save and continue`,
   saveForLaterButton: `Save for later`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `date-of-birth`,
 };

src/test/ui/data/page-data/defendantNameCapture.page.data.ts

@@ -14,4 +14,6 @@ export const defendantNameCapture = {
   enterYourLastNameErrorMessage: `Enter your last name`,
   enterFirstNameMaxLengthErrorMessage: `First name must be 60 characters or less`,
   enterLastNameMaxLengthErrorMessage: `Last name must be 60 characters or less`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `defendant-name-capture`,
 };

src/test/ui/data/page-data/defendantNameConfirmation.page.data.ts

@@ -24,4 +24,6 @@ export const defendantNameConfirmation = {
   enterYourLastNameErrorMessage: `Enter your last name`,
   enterFirstNameMaxLengthErrorMessage: `First name must be 60 characters or less`,
   enterLastNameMaxLengthErrorMessage: `Last name must be 60 characters or less`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `defendant-name-confirmation`,
 };

src/test/ui/data/page-data/disputeClaimInterstitial.page.data.ts

@@ -17,4 +17,6 @@ export const disputeClaimInterstitial = {
   cancelLink: `Cancel`,
   cymraegLink: `Cymraeg`,
   backLink: `Back`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `dispute-claim-interstitial`,
 };

src/test/ui/data/page-data/feedback.page.data.ts

@@ -0,0 +1,9 @@
+export const feedback = {
+  finishSurveyButton: `Finish Survey`,
+  tellUsWhatYouThinkParagraph: `Tell us what you think!`,
+  weReallyAppreciateYourFeedbackParagraph: `We'd really appreciate your feedback, but please note, you will not receive a reply to comments left here`,
+  ifYouHaveAProblemParagraph: `If you have a problem that needs a response, please contact us on;`,
+  telephoneNumberParagraph: `Phone: [telephone number tbc] (Opening times Monday to Friday, XXam to XXpm)`,
+  emailParagraph: `Email: [email TBC] (We aim to respond within 10 working days)`,
+  pleaseLeaveYourFeedbackHeader: `Please leave your feedback in the space below (make sure you do not include any personal or financial details).`,
+};

src/test/ui/data/page-data/freeLegalAdvice.page.data.ts

@@ -25,4 +25,6 @@ export const freeLegalAdvice = {
   backLink: `Back`,
   youMustSayAboutFreeLegalAdviceErrorMessage: `You must say if you've had any free legal advice`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `free-legal-advice`,
 };

src/test/ui/data/page-data/index.ts

@@ -25,3 +25,4 @@ export * from './tenancyDateDetails.page.data';
 export * from './dashboard.page.data';
 export * from './landlordLicensed.page.data';
 export * from './writtenTerms.page.data';
+export * from './feedback.page.data';

src/test/ui/data/page-data/landlordLicensed.page.data.ts

@@ -13,4 +13,6 @@ export const landlordLicensed = {
   cymraegLink: `Cymraeg`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
   selectIfYouAgreeWithLandlordsClaimLicensedErrorMessage: `Select if you agree with the landlord’s claim to be licensed`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `landlord-licensed`,
 };

src/test/ui/data/page-data/landlordRegistered.page.data.ts

@@ -13,4 +13,6 @@ export const landlordRegistered = {
   cymraegLink: `Cymraeg`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
   selectIfYouAgreeWithLandlordsClaimRegisteredErrorMessage: `Select if you agree with the landlord’s claim to be registered`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `landlord-registered`,
 };

src/test/ui/data/page-data/noticeDateWhenNotProvided.page.data.ts

@@ -14,4 +14,6 @@ export const noticeDateWhenNotProvided = {
   signOutLink: `Sign out`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
   theDateYouReceiveNoticeErrorMessage: `The date you received notice must either be today’s date or in the past`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `confirmation-of-notice-date-when-not-provided`,
 };

src/test/ui/data/page-data/noticeDateWhenProvided.page.data.ts

@@ -18,6 +18,8 @@ export const noticeDateWhenProvided = {
   signOutLink: `Sign out`,
   thereIsAProblemErrorMessageHeader: `There is a problem`,
   theDateYouReceiveNoticeErrorMessage: `The date you received notice must either be today’s date or in the past`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `confirmation-of-notice-date-when-provided`,
 };
 
 export function convertDateFormat(dateString: string): string {

src/test/ui/data/page-data/paymentInterstitial.page.data.ts

@@ -10,4 +10,6 @@ export const paymentInterstitial = {
   continueButton: `Continue`,
   cancelLink: `Cancel`,
   backLink: `Back`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `payment-interstitial`,
 };

src/test/ui/data/page-data/repaymentsMade.page.data.ts

@@ -15,4 +15,6 @@ export const repaymentsMade = {
   mustBeUnderCharacterLimitErrorMessage: `Must be 500 characters or fewer`,
   saveForLaterButton: `Save for later`,
   backLink: `Back`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `repayments-made`,
 };

src/test/ui/data/page-data/startNow.page.data.ts

@@ -23,4 +23,6 @@ export const startNow = {
   contactUsForHelpText: `Contact us for help`,
   backLink: `Back`,
   cymraegLink: `Cymraeg`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `start-now`,
 };

src/test/ui/data/page-data/tenancyDateDetails.page.data.ts

@@ -27,6 +27,8 @@ export const tenancyDateDetails = {
   monthMissingErrorMessage: `Your tenancy start date must include a month`,
   yearMissingErrorMessage: `Your tenancy start date must include a year`,
   futureDateErrorMessage: `Tenancy start date must be in the past`,
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `tenancy-date-details`,
 };
 
 export function convertDateFormatTenancyDate(dateString: string): string {

src/test/ui/data/page-data/tenancyDateUnknown.page.data.ts

@@ -17,4 +17,6 @@ export const tenancyDateUnknown = {
   yearMissingErrorMessage: 'Your tenancy start date must include a year',
   realDateErrorMessage: 'Tenancy start date must be a real date',
   backLink: 'Back',
+  feedbackLink: `feedback (opens in new tab)`,
+  pageSlug: `tenancy-date-unknown`,
 };

src/test/ui/e2eTest/respondToClaimWales.spec.ts

@@ -24,6 +24,7 @@ const home_url = config.get('e2e.testUrl') as string;
 test.beforeEach(async ({ page }) => {
   initializeExecutor(page);
   process.env.WALES_POSTCODE = 'YES';
+  process.env.CLAIMANT_NAME = submitCaseApiDataWales.submitCasePayload.claimantName;
   await performAction('createCaseAPI', { data: createCaseApiWalesData.createCasePayload });
   await performAction('submitCaseAPI', { data: submitCaseApiDataWales.submitCasePayload });
   await performAction('fetchPINsAPI');

src/test/ui/functional/confirmationOfNoticeGiven.pft.ts

@@ -1,5 +1,5 @@
 import { submitCaseApiData } from '../data/api-data';
-import { confirmationOfNoticeGiven, dashboard, tenancyDateUnknown } from '../data/page-data';
+import { confirmationOfNoticeGiven, dashboard, feedback, tenancyDateUnknown } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 let claimantName = '';
@@ -19,6 +19,10 @@ export async function confirmationOfNoticeGivenErrorValidation(): Promise<void>
 }
 
 export async function confirmationOfNoticeGivenNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', confirmationOfNoticeGiven.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: confirmationOfNoticeGiven.pageSlug,
+  });
   await performValidation('pageNavigation', confirmationOfNoticeGiven.backLink, tenancyDateUnknown.mainHeader);
   await performAction('clickRadioButton', confirmationOfNoticeGiven.yesRadioOption);
   await performValidation('pageNavigation', confirmationOfNoticeGiven.saveForLaterButton, dashboard.mainHeader);

src/test/ui/functional/contactPreferenceEmailOrPost.pft.ts

@@ -1,4 +1,4 @@
-import { contactPreferenceEmailOrPost } from '../data/page-data';
+import { contactPreferenceEmailOrPost, feedback } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 export async function contactPreferenceEmailOrPostErrorValidation(): Promise<void> {
@@ -85,9 +85,14 @@ export async function contactPreferenceEmailOrPostErrorValidation(): Promise<voi
     message: contactPreferenceEmailOrPost.invalidEmailAddressErrorMessage,
   });
 }
-//--The below method is commented out as we have an open bug - HDPI-5396
-/*export async function contactPreferenceEmailOrPostNavigationTests(): Promise<void> {
-  if (process.env.CORRESPONDENCE_ADDRESS === 'UNKNOWN') {
+
+export async function contactPreferenceEmailOrPostNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', contactPreferenceEmailOrPost.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: contactPreferenceEmailOrPost.pageSlug,
+  });
+  //--The below line is commented out as we have an open bug - HDPI-5396
+  /*if (process.env.CORRESPONDENCE_ADDRESS === 'UNKNOWN') {
     await performValidation(
       'pageNavigation',
       contactPreferenceEmailOrPost.backLink,
@@ -102,4 +107,5 @@ export async function contactPreferenceEmailOrPostErrorValidation(): Promise<voi
   }
   await performAction('clickRadioButton', contactPreferenceEmailOrPost.byPostRadioOption);
   await performValidation('pageNavigation', contactPreferenceEmailOrPost.saveForLaterButton, dashboard.mainHeader);
-}*/
+   */
+}

src/test/ui/functional/contactPreferencesTelephone.pft.ts

@@ -1,4 +1,4 @@
-import { contactPreferenceEmailOrPost, contactPreferencesTelephone, dashboard } from '../data/page-data';
+import { contactPreferenceEmailOrPost, contactPreferencesTelephone, dashboard, feedback } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 export async function contactPreferencesTelephoneErrorValidation(): Promise<void> {
@@ -46,6 +46,10 @@ export async function contactPreferencesTelephoneErrorValidation(): Promise<void
 }
 
 export async function contactPreferencesTelephoneNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', contactPreferencesTelephone.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: contactPreferencesTelephone.pageSlug,
+  });
   await performValidation(
     'pageNavigation',
     contactPreferencesTelephone.backLink,

src/test/ui/functional/contactPreferencesTextMessage.pft.ts

@@ -1,4 +1,4 @@
-import { contactPreferencesTelephone, contactPreferencesTextMessage, dashboard } from '../data/page-data';
+import { contactPreferencesTelephone, contactPreferencesTextMessage, dashboard, feedback } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 export async function contactPreferencesTextMessageErrorValidation(): Promise<void> {
@@ -10,6 +10,10 @@ export async function contactPreferencesTextMessageErrorValidation(): Promise<vo
 }
 
 export async function contactPreferencesTextMessageNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', contactPreferencesTextMessage.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: contactPreferencesTextMessage.pageSlug,
+  });
   await performValidation(
     'pageNavigation',
     contactPreferencesTextMessage.backLink,

src/test/ui/functional/dateOfBirth.pft.ts

@@ -1,7 +1,11 @@
-import { dashboard, dateOfBirth, defendantNameCapture } from '../data/page-data';
+import { dashboard, dateOfBirth, defendantNameCapture, feedback } from '../data/page-data';
 import { performValidation } from '../utils/controller';
 
 export async function dateOfBirthNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', dateOfBirth.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: dateOfBirth.pageSlug,
+  });
   await performValidation('pageNavigation', dateOfBirth.backLink, defendantNameCapture.mainHeader);
   await performValidation('pageNavigation', dateOfBirth.saveForLaterButton, dashboard.mainHeader);
 }

src/test/ui/functional/defendantNameCapture.pft.ts

@@ -1,4 +1,4 @@
-import { dashboard, defendantNameCapture, freeLegalAdvice } from '../data/page-data';
+import { dashboard, defendantNameCapture, feedback, freeLegalAdvice } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 const overMaxLengthString = 'A'.repeat(61);
@@ -33,6 +33,10 @@ export async function defendantNameCaptureErrorValidation(): Promise<void> {
   });
 }
 export async function defendantNameCaptureNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', defendantNameCapture.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: defendantNameCapture.pageSlug,
+  });
   await performValidation('pageNavigation', defendantNameCapture.backLink, freeLegalAdvice.mainHeader);
   await defendantNameCaptureInputValuesPrePopulated();
 }

src/test/ui/functional/defendantNameConfirmation.pft.ts

@@ -1,4 +1,4 @@
-import { defendantNameConfirmation, freeLegalAdvice } from '../data/page-data';
+import { defendantNameConfirmation, feedback, freeLegalAdvice } from '../data/page-data';
 import { performAction, performValidation } from '../utils/controller';
 
 import { defendantNameCaptureInputValuesPrePopulated } from './defendantNameCapture.pft';
@@ -46,6 +46,10 @@ export async function defendantNameConfirmationErrorValidation(): Promise<void>
   });
 }
 export async function defendantNameConfirmationNavigationTests(): Promise<void> {
+  await performValidation('pageNavigation', defendantNameConfirmation.feedbackLink, {
+    element: feedback.tellUsWhatYouThinkParagraph,
+    pageSlug: defendantNameConfirmation.pageSlug,
+  });
   await performValidation('pageNavigation', defendantNameConfirmation.backLink, freeLegalAdvice.mainHeader);
   await performAction('clickRadioButton', {
     question: defendantNameConfirmation.mainHeader,