TD-6874: Implement GovNotify History in LH Admin UI

AdminUI/LearningHub.Nhs.AdminUI/Controllers/GovNotifyDashboardController.cs

@@ -0,0 +1,120 @@
+using LearningHub.Nhs.AdminUI.Configuration;
+using LearningHub.Nhs.AdminUI.Extensions;
+using LearningHub.Nhs.AdminUI.Interfaces;
+using LearningHub.Nhs.Models.Paging;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
+using System.Collections.Generic;
+using System.Linq;
+using System;
+using System.Threading.Tasks;
+using LearningHub.Nhs.Models.GovNotifyMessaging;
+
+namespace LearningHub.Nhs.AdminUI.Controllers
+{
+    /// <summary>
+    /// Defines the <see cref="GovNotifyDashboardController" />.
+    /// </summary>
+    public class GovNotifyDashboardController : BaseController
+    {
+        /// <summary>
+        /// Defines the websettings.
+        /// </summary>
+        private readonly IOptions<WebSettings> websettings;
+
+        /// <summary>
+        /// Defines the govNotifyDashboardService.
+        /// </summary>
+        private IGovNotifyDashboardService govNotifyDashboardService;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GovNotifyDashboardController"/> class.
+        /// </summary>
+        /// <param name="hostingEnvironment">The hostingEnvironment<see cref="IWebHostEnvironment"/>.</param>
+        /// <param name="govNotifyDashboardService">The govNotifyDashboardService<see cref="IGovNotifyDashboardService"/>.</param>
+        /// <param name="websettings">The websettings<see cref="IOptions{WebSettings}"/>.</param>
+        public GovNotifyDashboardController(IWebHostEnvironment hostingEnvironment,
+            IGovNotifyDashboardService govNotifyDashboardService,
+            IOptions<WebSettings> websettings)
+            : base(hostingEnvironment)
+        {
+            this.websettings = websettings;
+            this.govNotifyDashboardService = govNotifyDashboardService;
+        }
+
+        /// <summary>
+        /// Initial call to get paginated result.
+        /// </summary>
+        /// <returns>The <see cref="Task{IActionResult}"/>.</returns>
+        public async Task<IActionResult> Index()
+        {
+            return await this.GetMessageRequests(
+                new PagingRequestModel
+                {
+                    Page = 1,
+                    PageSize = this.websettings.Value.DefaultPageSize,
+                    SortColumn = "CreatedAt",
+                    SortDirection = "D",
+                });
+        }
+
+        /// <summary>
+        /// Get paginated result based on the filters.
+        /// </summary>
+        /// <param name="pagingRequestModel"></param>
+        /// <returns>The <see cref="Task{IActionResult}"/>.</returns>
+        [HttpPost]
+        public async Task<IActionResult> Index(string pagingRequestModel)
+        {
+            var requestModel = JsonConvert.DeserializeObject<PagingRequestModel>(pagingRequestModel);
+            return await this.GetMessageRequests(requestModel);
+        }
+
+        /// <summary>
+        /// Get message request details by id.
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns>The <see cref="Task{IActionResult}"/>.</returns>
+        [HttpGet]
+        public async Task<IActionResult> Details(int id)
+        {
+            var notification = await this.govNotifyDashboardService.GetMessageRequestById(id);
+            return this.View(notification);
+        }
+
+        private async Task<IActionResult> GetMessageRequests(PagingRequestModel requestModel)
+        {
+            requestModel.Sanitize();
+            requestModel.PageSize = this.websettings.Value.DefaultPageSize;
+
+            var model = new TablePagingViewModel<MessageRequestViewModel>
+            {
+                Results = await this.govNotifyDashboardService.GetPagedAsync(requestModel),
+                SortColumn = requestModel.SortColumn,
+                SortDirection = requestModel.SortDirection,
+                Filter = requestModel.Filter,
+            };
+
+            model.Paging = new PagingViewModel
+            {
+                CurrentPage = requestModel.Page,
+                HasItems = model.Results.Items.Any(),
+                PageSize = this.websettings.Value.DefaultPageSize,
+                TotalItems = model.Results.TotalItemCount,
+            };
+
+            model.ListPageHeader = new ListPageHeaderViewModel
+            {
+                TotalItemCount = model.Results.TotalItemCount,
+                DisplayedCount = model.Results.Items.Count(),
+                DefaultPageSize = this.websettings.Value.DefaultPageSize,
+                FilterCount = model.Filter != null ? model.Filter.Count() : 0,
+                CreateRequired = false,
+            };
+
+            return this.View(model);
+        }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Interfaces/IGovNotifyDashboardService.cs

@@ -0,0 +1,27 @@
+namespace LearningHub.Nhs.AdminUI.Interfaces
+{
+    using LearningHub.Nhs.Models.Common;
+    using LearningHub.Nhs.Models.GovNotifyMessaging;
+    using LearningHub.Nhs.Models.Paging;
+    using System.Threading.Tasks;
+
+    /// <summary>
+    /// Defines the <see cref="IGovNotifyDashboardService" />.
+    /// </summary>
+    public interface IGovNotifyDashboardService
+    {
+        /// <summary>
+        /// The GetPagedAsync.
+        /// </summary>
+        /// <param name="pagingRequestModel">The pagingRequestModel<see cref="PagingRequestModel"/>.</param>
+        /// <returns>The <see cref="PagedResultSet{MessageRequestViewModel}"/>.</returns>
+        Task<PagedResultSet<MessageRequestViewModel>> GetPagedAsync(PagingRequestModel pagingRequestModel);
+
+        /// <summary>
+        /// Get Message Request By Id.
+        /// </summary>
+        /// <param name="id">id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<MessageRequestViewModel> GetMessageRequestById(int id);
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/LearningHub.Nhs.AdminUI.csproj

@@ -89,7 +89,7 @@
 		<PackageReference Include="HtmlSanitizer" Version="6.0.453" />
 		<PackageReference Include="IdentityModel" Version="4.6.0" />
 		<PackageReference Include="LearningHub.Nhs.Caching" Version="2.0.2" />
-		<PackageReference Include="LearningHub.Nhs.Models" Version="4.0.13" />
+		<PackageReference Include="LearningHub.Nhs.Models" Version="4.0.14" />
 		<PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.19.0" />
 		<PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="6.0.36" />
 		<PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.36" />

AdminUI/LearningHub.Nhs.AdminUI/ServiceCollectionExtension.cs

@@ -107,6 +107,7 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
             services.AddTransient<IInternalSystemService, InternalSystemService>();
             services.AddScoped<IProviderService, ProviderService>();
             services.AddScoped<IMoodleApiService, MoodleApiService>();
+            services.AddScoped<IGovNotifyDashboardService, GovNotifyDashboardService>();
 
             // Configure Azure Search
             services.Configure<AzureSearchConfig>(configuration.GetSection("AzureSearch"));

AdminUI/LearningHub.Nhs.AdminUI/Services/GovNotifyDashboardService.cs

@@ -0,0 +1,130 @@
+using LearningHub.Nhs.AdminUI.Interfaces;
+using LearningHub.Nhs.Models.Common;
+using LearningHub.Nhs.Models.Paging;
+using Newtonsoft.Json;
+using System.Threading.Tasks;
+using System;
+using LearningHub.Nhs.Models.GovNotifyMessaging;
+using Newtonsoft.Json.Converters;
+using System.Collections.Generic;
+
+namespace LearningHub.Nhs.AdminUI.Services
+{
+    /// <summary>
+    /// Defines the <see cref="GovNotifyDashboardService" />.
+    /// </summary>
+    public class GovNotifyDashboardService: BaseService, IGovNotifyDashboardService
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GovNotifyDashboardService"/> class.
+        /// </summary>
+        /// <param name="learningHubHttpClient"></param>
+        /// <param name="openApiHttpClient"></param>
+        public GovNotifyDashboardService(ILearningHubHttpClient learningHubHttpClient, IOpenApiHttpClient openApiHttpClient)
+            :base(learningHubHttpClient, openApiHttpClient)
+        {
+        }
+
+        /// <summary>
+        /// The GetPagedAsync.
+        /// </summary>
+        /// <param name="pagingRequestModel">The pagingRequestModel<see cref="PagingRequestModel"/>.</param>
+        /// <returns>The <see cref="PagedResultSet{MessageRequestViewModel}"/>.</returns>
+        public async Task<PagedResultSet<MessageRequestViewModel>> GetPagedAsync(PagingRequestModel pagingRequestModel)
+        {
+            try
+            {
+                PagedResultSet<MessageRequestViewModel> viewmodel = null;
+                var sortDirection = " ";
+
+                if (string.IsNullOrEmpty(pagingRequestModel.SortColumn))
+                {
+                    pagingRequestModel.SortColumn = " ";
+                }
+
+                if (string.IsNullOrEmpty(pagingRequestModel.SortDirection))
+                {
+                    pagingRequestModel.SortDirection = " ";
+                }
+                else
+                {
+                    sortDirection = pagingRequestModel.SortDirection == "A" ? "ASC" :
+                        pagingRequestModel.SortDirection == "D" ? "DESC" : "ASC";
+                }
+
+                var settings = new JsonSerializerSettings
+                {
+                    Converters = new List<JsonConverter>
+                        {
+                            new StringEnumConverter()
+                        }
+                };
+
+                var filter = JsonConvert.SerializeObject(pagingRequestModel.Filter, settings);
+                var client = await this.OpenApiHttpClient.GetClientAsync();
+
+                var request = $"GovNotifyMessage/GetMessageRequests"
+                    + $"/{pagingRequestModel.Page}"
+                    + $"/{pagingRequestModel.PageSize}"
+                    + $"/{pagingRequestModel.SortColumn}"
+                    + $"/{sortDirection}"
+                    +$"/{Uri.EscapeDataString(filter)}";
+
+                var response = await client.GetAsync(request).ConfigureAwait(false);
+
+                if (response.IsSuccessStatusCode)
+                {
+                    var result = response.Content.ReadAsStringAsync().Result;
+                    viewmodel = JsonConvert.DeserializeObject<PagedResultSet<MessageRequestViewModel>>(result);
+                }
+                else if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized
+                            ||
+                         response.StatusCode == System.Net.HttpStatusCode.Forbidden)
+                {
+                    throw new Exception("AccessDenied");
+                }
+
+                return viewmodel;
+            }
+            catch (Exception ex)
+            {
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// Get message request details by id.
+        /// </summary>
+        /// <param name="id">id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        public async Task<MessageRequestViewModel> GetMessageRequestById(int id)
+        {
+            try
+            {
+                MessageRequestViewModel viewmodel = null;
+                var client = await this.OpenApiHttpClient.GetClientAsync();
+
+                var request = $"GovNotifyMessage/GetMessageRequestById/{id}";
+                var response = await client.GetAsync(request).ConfigureAwait(false);
+
+                if (response.IsSuccessStatusCode)
+                {
+                    var result = response.Content.ReadAsStringAsync().Result;
+                    viewmodel = JsonConvert.DeserializeObject<MessageRequestViewModel>(result);
+                }
+                else if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized
+                            ||
+                         response.StatusCode == System.Net.HttpStatusCode.Forbidden)
+                {
+                    throw new Exception("AccessDenied");
+                }
+
+                return viewmodel;
+            }
+            catch (Exception ex)
+            {
+                return null;
+            }
+        }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Views/GovNotifyDashboard/Details.cshtml

@@ -0,0 +1,80 @@
+@model LearningHub.Nhs.Models.GovNotifyMessaging.MessageRequestViewModel
+@using LearningHub.Nhs.AdminUI.Services
+
+@{
+    ViewData["Title"] = "Details";
+}
+@section SideMenu {
+    @{
+        await Html.RenderPartialAsync("_NavSection");
+    }
+}
+
+<div class="panel-body admin-body">
+    <div class="d-flex flex-row justify-content-between col-12">
+        <a href="@Url.Action("Index", "GovNotifyDashboard")" class="pl-3"><i class="fa-solid fa-chevron-left">&nbsp;</i> Go back</a>
+    </div>
+    <div class="admin-section">
+        <div class="col-12">
+            <div class="id-container">ID @Model.Id</div>
+            <dl>
+                <dt>
+                    Recipient
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.Recipient)
+                </dd>
+                <dt>
+                    Request type
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.RequestType)
+                </dd>
+                <dt>
+                    Request status
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.RequestStatus)
+                </dd>
+                <dt>
+                    Retry count
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.RetryCount)
+                </dd>
+                <dt>
+                    Created date
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.CreatedAt)
+                </dd>
+                <dt>
+                    Deliver after date
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.DeliverAfter)
+                </dd>
+                <dt>
+                    Sent Date
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.SentAt)
+                </dd>
+                <dt>
+                    Last attempt date
+                </dt>
+                <dd>
+                    @Html.DisplayFor(model => model.LastAttemptAt)
+                </dd>
+                <dt>
+                    Error message
+                </dt>
+                <dd>
+                    @Html.Raw(OutputSanitizer.SanitizeOutputHtml(Model.ErrorMessage))
+                </dd>
+            </dl>
+        </div>
+    </div>
+
+</div>
+