feat: add contact link to concurrent user error message

src/Dfe.PlanTech.Application/Content/Queries/GetNavigationQuery.cs

@@ -37,4 +37,17 @@ public async Task<IEnumerable<INavigationLink>> GetNavigationLinks(CancellationT
             return [];
         }
     }
+
+    public async Task<INavigationLink?> GetLinkById(string contentId, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            return await _cache.GetOrCreateAsync($"NavigationLink:{contentId}", () => repository.GetEntityById<NavigationLink?>(contentId, cancellationToken: cancellationToken));
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, ExceptionMessageContentful);
+            return null;
+        }
+    }
 }

src/Dfe.PlanTech.Domain/Content/Interfaces/IGetNavigationQuery.cs

@@ -10,4 +10,10 @@ public interface IGetNavigationQuery
     /// </summary>
     /// <returns>Found navigation links</returns>
     Task<IEnumerable<INavigationLink>> GetNavigationLinks(CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Retrieve link by id
+    /// </summary>
+    /// <returns>Found navigation link</returns>
+    Task<INavigationLink?> GetLinkById(string contentId, CancellationToken cancellationToken = default);
 }

src/Dfe.PlanTech.Web/Configuration/ContactOptions.cs

@@ -0,0 +1,6 @@
+namespace Dfe.PlanTech.Web.Configuration;
+
+public record ContactOptions
+{
+    public string LinkId { get; set; } = "";
+}

src/Dfe.PlanTech.Web/Configuration/ErrorMessages.cs

@@ -0,0 +1,6 @@
+namespace Dfe.PlanTech.Web.Configuration;
+
+public record ErrorMessages
+{
+    public string ConcurrentUsersOrContentChange { get; set; } = "";
+}

src/Dfe.PlanTech.Web/Controllers/PagesController.cs

@@ -5,19 +5,22 @@
 using Dfe.PlanTech.Domain.Users.Interfaces;
 using Dfe.PlanTech.Web.Authorisation;
 using Dfe.PlanTech.Web.Binders;
+using Dfe.PlanTech.Web.Configuration;
 using Dfe.PlanTech.Web.Helpers;
 using Dfe.PlanTech.Web.Models;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
 
 namespace Dfe.PlanTech.Web.Controllers;
 
 [LogInvalidModelState]
 [Route("/")]
-public class PagesController(ILogger<PagesController> logger, IGetEntityFromContentfulQuery getEntityByIdQuery) : BaseController<PagesController>(logger)
+public class PagesController(ILogger<PagesController> logger, IGetNavigationQuery getNavigationQuery, IOptions<ContactOptions> contactOptions) : BaseController<PagesController>(logger)
 {
     private readonly ILogger _logger = logger;
-    private readonly IGetEntityFromContentfulQuery _getEntityFromContentfulQuery = getEntityByIdQuery;
+    private readonly IGetNavigationQuery _getNavigationQuery = getNavigationQuery;
+    private readonly ContactOptions _contactOptions = contactOptions.Value;
     public const string ControllerName = "Pages";
     public const string GetPageByRouteAction = nameof(GetByRoute);
     public const string NotFoundPage = "NotFoundError";
@@ -42,9 +45,9 @@
     => View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
 
     [HttpGet(UrlConstants.ServiceUnavailable, Name = UrlConstants.ServiceUnavailable)]
-    public async Task<IActionResult> ServiceUnavailable([FromServices] IConfiguration configuration)
+    public async Task<IActionResult> ServiceUnavailable()
     {
-        var contactLink = await _getEntityFromContentfulQuery.GetEntityById<NavigationLink>(configuration["ContactUs:LinkId"]);
+        var contactLink = await GetContactLinkAsync();
 
         var viewModel = new ServiceUnavailableViewModel
         {
@@ -55,11 +58,9 @@
     }
 
     [HttpGet(UrlConstants.NotFound, Name = UrlConstants.NotFound)]
-    public async Task<IActionResult> NotFoundError([FromServices] IConfiguration configuration)
+    public async Task<IActionResult> NotFoundError()
     {
-        var contentId = configuration["ContactUs:LinkId"];
-        var contactLink = await _getEntityFromContentfulQuery.GetEntityById<NavigationLink>(contentId) ??
-                throw new KeyNotFoundException($"Could not find navigation link with Id {contentId}");
+        var contactLink = await GetContactLinkAsync();
 
         var viewModel = new NotFoundViewModel
         {
@@ -68,4 +69,9 @@
 
         return View(viewModel);
     }
+
+    private async Task<INavigationLink> GetContactLinkAsync()
+    {
+        return await _getNavigationQuery.GetLinkById(_contactOptions.LinkId);
+    }
 }

src/Dfe.PlanTech.Web/Controllers/QuestionsController.cs

@@ -5,11 +5,13 @@
 using Dfe.PlanTech.Domain.Questionnaire.Models;
 using Dfe.PlanTech.Domain.Submissions.Interfaces;
 using Dfe.PlanTech.Domain.Users.Interfaces;
+using Dfe.PlanTech.Web.Configuration;
 using Dfe.PlanTech.Web.Helpers;
 using Dfe.PlanTech.Web.Models;
 using Dfe.PlanTech.Web.Routing;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
 
 namespace Dfe.PlanTech.Web.Controllers;
 
@@ -23,18 +25,27 @@ public class QuestionsController : BaseController<QuestionsController>
     private readonly IGetSectionQuery _getSectionQuery;
     private readonly IGetLatestResponsesQuery _getResponseQuery;
     private readonly IGetEntityFromContentfulQuery _getEntityFromContentfulQuery;
+    private readonly IGetNavigationQuery _getNavigationQuery;
     private readonly IUser _user;
+    private readonly ErrorMessages _errorMessages;
+    private readonly ContactOptions _contactOptions;
 
     public QuestionsController(ILogger<QuestionsController> logger,
                                IGetSectionQuery getSectionQuery,
                                IGetLatestResponsesQuery getResponseQuery,
                                IGetEntityFromContentfulQuery getEntityByIdQuery,
-                               IUser user) : base(logger)
+                               IGetNavigationQuery getNavigationQuery,
+                               IUser user,
+                               IOptions<ErrorMessages> errorMessageOptions,
+                               IOptions<ContactOptions> contactOptions) : base(logger)
     {
         _getResponseQuery = getResponseQuery;
         _getSectionQuery = getSectionQuery;
         _getEntityFromContentfulQuery = getEntityByIdQuery;
+        _getNavigationQuery = getNavigationQuery;
         _user = user;
+        _errorMessages = errorMessageOptions.Value;
+        _contactOptions = contactOptions.Value;
     }
 
     [LogInvalidModelState]
@@ -74,7 +85,6 @@ public async Task<IActionResult> GetQuestionPreviewById(string questionId,
     public async Task<IActionResult> GetNextUnansweredQuestion(string sectionSlug,
                                                                 [FromServices] IGetNextUnansweredQuestionQuery getQuestionQuery,
                                                                 [FromServices] IDeleteCurrentSubmissionCommand deleteCurrentSubmissionCommand,
-                                                                [FromServices] IConfiguration configuration,
                                                                 CancellationToken cancellationToken = default)
     {
         if (string.IsNullOrEmpty(sectionSlug))
@@ -97,14 +107,28 @@ public async Task<IActionResult> GetNextUnansweredQuestion(string sectionSlug,
         {
             // Remove the current invalid submission and redirect to self-assessment page
             await deleteCurrentSubmissionCommand.DeleteCurrentSubmission(section, cancellationToken);
-            TempData["SubtopicError"] = configuration["ErrorMessages:ConcurrentUsersOrContentChange"];
+
+            TempData["SubtopicError"] = await BuildErrorMessage();
             return RedirectToAction(
                 PagesController.GetPageByRouteAction,
                 PagesController.ControllerName,
                 new { route = "self-assessment" });
         }
     }
 
+    private async Task<string> BuildErrorMessage()
+    {
+        var contactLink = await _getNavigationQuery.GetLinkById(_contactOptions.LinkId);
+        var errorMessage = _errorMessages.ConcurrentUsersOrContentChange;
+
+        if (contactLink != null && !string.IsNullOrEmpty(contactLink.Href))
+        {
+            errorMessage = errorMessage.Replace("contact us", $"<a href=\"{contactLink.Href}\" target=\"_blank\">contact us</a>");
+        }
+
+        return errorMessage;
+    }
+
     [HttpPost("{sectionSlug}/{questionSlug}")]
     public async Task<IActionResult> SubmitAnswer(
         string sectionSlug,

src/Dfe.PlanTech.Web/Program.cs

@@ -4,6 +4,7 @@
 using Dfe.PlanTech.Infrastructure.ServiceBus;
 using Dfe.PlanTech.Infrastructure.SignIns;
 using Dfe.PlanTech.Web;
+using Dfe.PlanTech.Web.Configuration;
 using Dfe.PlanTech.Web.Middleware;
 using GovUk.Frontend.AspNetCore;
 
@@ -27,6 +28,8 @@
 }
 
 builder.Services.AddCustomTelemetry();
+builder.Services.Configure<ErrorMessages>(builder.Configuration.GetSection("ErrorMessages"));
+builder.Services.Configure<ContactOptions>(builder.Configuration.GetSection("ContactUs"));
 
 builder.AddContentAndSupportServices()
         .AddAuthorisationServices()

src/Dfe.PlanTech.Web/Views/Pages/Page.cshtml

@@ -39,7 +39,7 @@
                 </h2>
                 @if (!string.IsNullOrEmpty(error))
                 {
-                    <div class="govuk-error-summary__body whitespace-preline">@error</div>
+                    <div class="govuk-error-summary__body whitespace-preline">@Html.Raw(error)</div>
                 }
             </div>
         </div>

src/Dfe.PlanTech.Web/appsettings.json

@@ -60,7 +60,6 @@
     },
     "CacheTimeOutMs": 30000,
     "ContactUs": {
-        "Email": "technology.planning@education.gov.uk",
         "LinkId": "7ezhOgrTAdhP4NeGiNj8VY"
     },
     "ErrorMessages": {

tests/Dfe.PlanTech.Application.UnitTests/Content/Queries/GetNavigationQueryTests.cs

@@ -13,25 +13,35 @@
     private readonly IContentRepository _contentRepository = Substitute.For<IContentRepository>();
     private readonly ICmsCache _cache = Substitute.For<ICmsCache>();
 
-    private readonly IList<NavigationLink> _contentfulLinks = new List<NavigationLink>()
+    private readonly NavigationLink _contentfulLink = new NavigationLink
     {
-        new()
-        {
-            Href = "ContentfulHref",
-            DisplayText = "ContentfulDisplayText"
-        }
+        Href = "ContentfulHref",
+        DisplayText = "ContentfulDisplayText"
     };
 
+    private readonly IList<NavigationLink> _contentfulLinks;
+
     private readonly ILogger<GetNavigationQuery> _logger = Substitute.For<ILogger<GetNavigationQuery>>();
 
     public GetNavigationQueryTests()
     {
+        _contentfulLinks = new List<NavigationLink> { _contentfulLink };
+
         _cache.GetOrCreateAsync(Arg.Any<string>(), Arg.Any<Func<Task<IEnumerable<NavigationLink>>>>())
             .Returns(callInfo =>
             {
                 var func = callInfo.ArgAt<Func<Task<IEnumerable<NavigationLink>>>>(1);
                 return func();
             });
+
+        _cache.GetOrCreateAsync<NavigationLink?>(
+            Arg.Any<string>(),
+            Arg.Any<Func<Task<NavigationLink?>>>())
+            .Returns(callInfo =>
+            {
+                var func = callInfo.ArgAt<Func<Task<NavigationLink?>>>(1);
+                return func();
+            });
     }
 
     [Fact]
@@ -60,4 +70,28 @@
         Assert.Single(receivedLoggerMessages);
         Assert.Empty(result);
     }
+
+    [Fact]
+    public async Task Should_Retrieve_Nav_Link_By_Id_When_Exists()
+    {
+        _contentRepository.GetEntityById<NavigationLink>(Arg.Any<string>(), Arg.Any<int>(), Arg.Any<CancellationToken>()).Returns(_contentfulLink);
+        var navQuery = new GetNavigationQuery(_logger, _contentRepository, _cache);
+        var result = await navQuery.GetLinkById("contentId");
+
+        Assert.NotNull(result);
+        Assert.Equal(_contentfulLink.Href, result.Href);
+        Assert.Equal(_contentfulLink.DisplayText, result.DisplayText);
+    }
+
+    [Fact]
+    public async Task Should_Return_Null_When_Nav_Link_Does_Not_Exist()
+    {
+        _contentRepository.GetEntityById<NavigationLink?>(Arg.Any<string>(), Arg.Any<int>(), cancellationToken: CancellationToken.None).Returns((NavigationLink?)null);
+
+        var navQuery = new GetNavigationQuery(_logger, _contentRepository, _cache);
+
+        var result = await navQuery.GetLinkById("NonExistentId");
+
+        Assert.Null(result);
+    }
 }

tests/Dfe.PlanTech.Web.UnitTests/Controllers/PagesControllerTests.cs

@@ -5,14 +5,15 @@
 using Dfe.PlanTech.Domain.Cookie.Interfaces;
 using Dfe.PlanTech.Domain.Establishments.Models;
 using Dfe.PlanTech.Domain.Users.Interfaces;
+using Dfe.PlanTech.Web.Configuration;
 using Dfe.PlanTech.Web.Controllers;
 using Dfe.PlanTech.Web.Models;
 using Microsoft.AspNetCore.Authentication.Cookies;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ViewFeatures;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using NSubstitute;
 using Xunit;
 
@@ -25,21 +26,27 @@ public class PagesControllerTests
         private const string SELF_ASSESSMENT_SLUG = "self-assessment";
         readonly ICookieService cookiesSubstitute = Substitute.For<ICookieService>();
         readonly IUser userSubstitute = Substitute.For<IUser>();
-        private readonly IConfiguration _configuration = Substitute.For<IConfiguration>();
-        private readonly IGetEntityFromContentfulQuery _getEntityFromContentfulQuery;
+        private readonly IGetNavigationQuery _getNavigationQuery;
         private readonly PagesController _controller;
         private readonly ControllerContext _controllerContext;
+        private readonly IOptions<ContactOptions> _contactOptions;
 
         public PagesControllerTests()
         {
             var Logger = Substitute.For<ILogger<PagesController>>();
 
             _controllerContext = ControllerHelpers.SubstituteControllerContext();
 
-            _getEntityFromContentfulQuery = Substitute.For<IGetEntityFromContentfulQuery>();
-            _getEntityFromContentfulQuery.GetEntityById<NavigationLink>(Arg.Any<string>()).Returns(new NavigationLink { DisplayText = "contact us", Href = "/contact-us", OpenInNewTab = true });
+            _getNavigationQuery = Substitute.For<IGetNavigationQuery>();
+            _getNavigationQuery.GetLinkById(Arg.Any<string>()).Returns(new NavigationLink { DisplayText = "contact us", Href = "/contact-us", OpenInNewTab = true });
 
-            _controller = new PagesController(Logger, _getEntityFromContentfulQuery)
+            var contactUs = new ContactOptions
+            {
+                LinkId = "LinkId"
+            };
+            _contactOptions = Options.Create(contactUs);
+
+            _controller = new PagesController(Logger, _getNavigationQuery, _contactOptions)
             {
                 ControllerContext = _controllerContext,
                 TempData = Substitute.For<ITempDataDictionary>()
@@ -211,7 +218,7 @@ public async Task Should_Render_Service_Unavailable_Page()
 
             _controller.ControllerContext = controllerContext;
 
-            var result = _controller.ServiceUnavailable(_configuration);
+            var result = _controller.ServiceUnavailable();
 
             var viewResult = await result as ViewResult;
 
@@ -251,7 +258,7 @@ public async Task Should_Render_NotFound_Page()
                 HttpContext = httpContextSubstitute
             };
             _controller.ControllerContext = controllerContext;
-            var result = _controller.NotFoundError(_configuration);
+            var result = _controller.NotFoundError();
             var viewResult = await result as ViewResult;
             Assert.NotNull(viewResult);
         }