Merge branch 'Develop/Feature/TD-6601-search-admin' into Develop/Features/TD-6212-azure-ai-search-implementation

Author: Binon

AdminUI/LearningHub.Nhs.AdminUI/Configuration/AzureSearchConfig.cs

@@ -0,0 +1,33 @@
+namespace LearningHub.Nhs.AdminUI.Configuration
+{
+    /// <summary>
+    /// Configuration settings for Azure AI Search.
+    /// </summary>
+    public class AzureSearchConfig
+    {
+        /// <summary>
+        /// Gets or sets the Azure Search service endpoint URL.
+        /// </summary>
+        public string ServiceEndpoint { get; set; }
+
+        /// <summary>
+        /// Gets or sets the admin API key for managing indexes and indexers.
+        /// </summary>
+        public string AdminApiKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the query API key for search operations.
+        /// </summary>
+        public string QueryApiKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the search index.
+        /// </summary>
+        public string IndexName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the indexer.
+        /// </summary>
+        public string IndexerName { get; set; }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Controllers/AzureSearchAdmin.cs

@@ -0,0 +1,119 @@
+namespace LearningHub.Nhs.AdminUI.Controllers
+{
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.AdminUI.Helpers;
+    using LearningHub.Nhs.AdminUI.Interfaces;
+    using LearningHub.Nhs.AdminUI.Models;
+    using Microsoft.AspNetCore.Hosting;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.Extensions.Logging;
+    using Microsoft.FeatureManagement;
+
+    /// <summary>
+    /// Controller for Azure Search administration.
+    /// </summary>
+    public class AzureSearchAdminController : BaseController
+    {
+        private readonly IAzureSearchAdminService azureSearchAdminService;
+        private readonly IFeatureManager featureManager;
+        private readonly ILogger<AzureSearchAdminController> logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureSearchAdminController"/> class.
+        /// </summary>
+        /// <param name="hostingEnvironment">The hosting environment.</param>
+        /// <param name="azureSearchAdminService">The Azure Search admin service.</param>
+        /// <param name="featureManager">The feature manager.</param>
+        /// <param name="logger">The logger.</param>
+        public AzureSearchAdminController(
+            IWebHostEnvironment hostingEnvironment,
+            IAzureSearchAdminService azureSearchAdminService,
+            IFeatureManager featureManager,
+            ILogger<AzureSearchAdminController> logger)
+            : base(hostingEnvironment)
+        {
+            this.azureSearchAdminService = azureSearchAdminService;
+            this.featureManager = featureManager;
+            this.logger = logger;
+        }
+
+        /// <summary>
+        /// Displays the Azure Search Admin dashboard.
+        /// </summary>
+        /// <returns>The view.</returns>
+        [HttpGet]
+        public async Task<IActionResult> Index()
+        {
+            if (!await this.featureManager.IsEnabledAsync(FeatureFlags.AzureSearch))
+            {
+                return this.NotFound();
+            }
+
+            var viewModel = new AzureSearchAdminViewModel
+            {
+                Indexers = await this.azureSearchAdminService.GetIndexersStatusAsync(),
+                Indexes = await this.azureSearchAdminService.GetIndexesStatusAsync(),
+            };
+
+            return this.View(viewModel);
+        }
+
+        /// <summary>
+        /// Triggers an indexer run.
+        /// </summary>
+        /// <param name="indexerName">The name of the indexer to run.</param>
+        /// <returns>Redirects to Index with status message.</returns>
+        [HttpPost]
+        [ValidateAntiForgeryToken]
+        public async Task<IActionResult> RunIndexer(string indexerName)
+        {
+            if (!await this.featureManager.IsEnabledAsync(FeatureFlags.AzureSearch))
+            {
+                return this.NotFound();
+            }
+
+            if (string.IsNullOrEmpty(indexerName))
+            {
+                return this.BadRequest("Indexer name is required.");
+            }
+
+            var success = await this.azureSearchAdminService.RunIndexerAsync(indexerName);
+
+            this.TempData["Message"] = success
+                ? $"Indexer '{indexerName}' has been triggered successfully."
+                : $"Failed to trigger indexer '{indexerName}'.";
+            this.TempData["IsError"] = !success;
+
+            return this.RedirectToAction("Index");
+        }
+
+        /// <summary>
+        /// Resets an indexer.
+        /// </summary>
+        /// <param name="indexerName">The name of the indexer to reset.</param>
+        /// <returns>Redirects to Index with status message.</returns>
+        [HttpPost]
+        [ValidateAntiForgeryToken]
+        public async Task<IActionResult> ResetIndexer(string indexerName)
+        {
+            if (!await this.featureManager.IsEnabledAsync(FeatureFlags.AzureSearch))
+            {
+                return this.NotFound();
+            }
+
+            if (string.IsNullOrEmpty(indexerName))
+            {
+                return this.BadRequest("Indexer name is required.");
+            }
+
+            var success = await this.azureSearchAdminService.ResetIndexerAsync(indexerName);
+
+            this.TempData["Message"] = success
+                ? $"Indexer '{indexerName}' has been reset successfully. You may now run it to perform a full re-index."
+                : $"Failed to reset indexer '{indexerName}'.";
+            this.TempData["IsError"] = !success;
+
+            return this.RedirectToAction("Index");
+        }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Interfaces/IAzureSearchAdminService.cs

@@ -0,0 +1,38 @@
+namespace LearningHub.Nhs.AdminUI.Interfaces
+{
+    using System.Collections.Generic;
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.AdminUI.Models;
+
+    /// <summary>
+    /// Interface for Azure Search administration operations.
+    /// </summary>
+    public interface IAzureSearchAdminService
+    {
+        /// <summary>
+        /// Gets the status of all indexers.
+        /// </summary>
+        /// <returns>A list of indexer statuses.</returns>
+        Task<List<IndexerStatusViewModel>> GetIndexersStatusAsync();
+
+        /// <summary>
+        /// Gets the status of all indexes.
+        /// </summary>
+        /// <returns>A list of index statuses.</returns>
+        Task<List<IndexStatusViewModel>> GetIndexesStatusAsync();
+
+        /// <summary>
+        /// Runs an indexer manually.
+        /// </summary>
+        /// <param name="indexerName">The name of the indexer to run.</param>
+        /// <returns>True if successful, false otherwise.</returns>
+        Task<bool> RunIndexerAsync(string indexerName);
+
+        /// <summary>
+        /// Resets an indexer (clears state and allows full reindex).
+        /// </summary>
+        /// <param name="indexerName">The name of the indexer to reset.</param>
+        /// <returns>True if successful, false otherwise.</returns>
+        Task<bool> ResetIndexerAsync(string indexerName);
+    }
+}

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.8" />
+		<PackageReference Include="LearningHub.Nhs.Models" Version="4.0.5" />
 		<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/LearningHub.Nhs.AdminUI.csproj.user

@@ -5,5 +5,9 @@
   </PropertyGroup>
   <PropertyGroup>
     <ActiveDebugProfile>Local IIS</ActiveDebugProfile>
+    <Controller_SelectedScaffolderID>MvcControllerEmptyScaffolder</Controller_SelectedScaffolderID>
+    <Controller_SelectedScaffolderCategoryPath>root/Common/MVC/Controller</Controller_SelectedScaffolderCategoryPath>
+    <View_SelectedScaffolderID>RazorViewEmptyScaffolder</View_SelectedScaffolderID>
+    <View_SelectedScaffolderCategoryPath>root/Common/MVC/View</View_SelectedScaffolderCategoryPath>
   </PropertyGroup>
 </Project>

AdminUI/LearningHub.Nhs.AdminUI/Models/AzureSearchAdminViewModel.cs

@@ -0,0 +1,30 @@
+namespace LearningHub.Nhs.AdminUI.Models
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// View model for Azure Search Admin page.
+    /// </summary>
+    public class AzureSearchAdminViewModel
+    {
+        /// <summary>
+        /// Gets or sets the list of indexer statuses.
+        /// </summary>
+        public List<IndexerStatusViewModel> Indexers { get; set; } = new List<IndexerStatusViewModel>();
+
+        /// <summary>
+        /// Gets or sets the list of index statuses.
+        /// </summary>
+        public List<IndexStatusViewModel> Indexes { get; set; } = new List<IndexStatusViewModel>();
+
+        /// <summary>
+        /// Gets or sets a message to display to the user.
+        /// </summary>
+        public string Message { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the message is an error.
+        /// </summary>
+        public bool IsError { get; set; }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Models/IndexStatusViewModel.cs

@@ -0,0 +1,23 @@
+namespace LearningHub.Nhs.AdminUI.Models
+{
+    /// <summary>
+    /// View model for Azure Search index status.
+    /// </summary>
+    public class IndexStatusViewModel
+    {
+        /// <summary>
+        /// Gets or sets the name of the index.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the document count in the index.
+        /// </summary>
+        public long? DocumentCount { get; set; }
+
+        /// <summary>
+        /// Gets or sets the storage size in bytes.
+        /// </summary>
+        public long? StorageSize { get; set; }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/Models/IndexerStatusViewModel.cs

@@ -0,0 +1,45 @@
+namespace LearningHub.Nhs.AdminUI.Models
+{
+    using System;
+
+    /// <summary>
+    /// View model for Azure Search indexer status.
+    /// </summary>
+    public class IndexerStatusViewModel
+    {
+        /// <summary>
+        /// Gets or sets the name of the indexer.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the current status of the indexer.
+        /// </summary>
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Gets or sets the last run time of the indexer.
+        /// </summary>
+        public DateTimeOffset? LastRunTime { get; set; }
+
+        /// <summary>
+        /// Gets or sets the last run status (success/failed/inProgress).
+        /// </summary>
+        public string LastRunStatus { get; set; }
+
+        /// <summary>
+        /// Gets or sets the error message if the last run failed.
+        /// </summary>
+        public string LastRunErrorMessage { get; set; }
+
+        /// <summary>
+        /// Gets or sets the number of documents indexed in the last run.
+        /// </summary>
+        public int? ItemsProcessed { get; set; }
+
+        /// <summary>
+        /// Gets or sets the number of documents that failed in the last run.
+        /// </summary>
+        public int? ItemsFailed { get; set; }
+    }
+}

AdminUI/LearningHub.Nhs.AdminUI/ServiceCollectionExtension.cs

@@ -108,6 +108,11 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
             services.AddScoped<IProviderService, ProviderService>();
             services.AddScoped<IMoodleApiService, MoodleApiService>();
 
+            // Configure Azure Search
+            services.Configure<AzureSearchConfig>(configuration.GetSection("AzureSearch"));
+            services.AddHttpClient("AzureSearch");
+            services.AddScoped<IAzureSearchAdminService, AzureSearchAdminService>();
+
             // web settings binding
             var webSettings = new WebSettings();
             configuration.Bind("WebSettings", webSettings);
@@ -160,12 +165,12 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
             }).AddCookie(
             "Cookies",
             options =>
-                {
-                    options.AccessDeniedPath = "/Authorisation/AccessDenied";
-                    options.ExpireTimeSpan = TimeSpan.FromMinutes(webSettings.AuthTimeout);
-                    options.SlidingExpiration = true;
-                    options.EventsType = typeof(CookieEventHandler);
-                }).AddOpenIdConnect(
+            {
+                options.AccessDeniedPath = "/Authorisation/AccessDenied";
+                options.ExpireTimeSpan = TimeSpan.FromMinutes(webSettings.AuthTimeout);
+                options.SlidingExpiration = true;
+                options.EventsType = typeof(CookieEventHandler);
+            }).AddOpenIdConnect(
                 "oidc",
                 options =>
                 {
@@ -185,12 +190,12 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
                     options.GetClaimsFromUserInfoEndpoint = true;
 
                     options.Events.OnRemoteFailure = async context =>
-                                         {
-                                             context.Response.Redirect("/"); // If login cancelled return to home page
-                                             context.HandleResponse();
+                    {
+                        context.Response.Redirect("/"); // If login cancelled return to home page
+                        context.HandleResponse();
 
-                                             await Task.CompletedTask;
-                                         };
+                        await Task.CompletedTask;
+                    };
 
                     options.ClaimActions.MapUniqueJsonKey("role", "role");
                     options.ClaimActions.MapUniqueJsonKey("name", "elfh_userName");
@@ -223,11 +228,11 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
 
             services.Configure<ForwardedHeadersOptions>(
                 options =>
-                    {
-                        options.ForwardedHeaders = ForwardedHeaders.XForwardedProto | ForwardedHeaders.XForwardedFor;
-                        options.KnownNetworks.Clear();
-                        options.KnownProxies.Clear();
-                    });
+                {
+                    options.ForwardedHeaders = ForwardedHeaders.XForwardedProto | ForwardedHeaders.XForwardedFor;
+                    options.KnownNetworks.Clear();
+                    options.KnownProxies.Clear();
+                });
 
             services.AddControllersWithViews(options =>
             {