Appt 1471 - Bulk upload toggle soft deletion status sites (#1117)

# Description

Update to the bulk upload endpoint to handle the soft deletion (and
re-activation) of sites

- If the value of `isDeleted` is null or non-existant for a site - set
it to true
- Otherwise flip the existing value thus soft deleting an active site or
re-activating a soft deleted site

Fixes # (issue)

# Checklist:

- [ ] My work is behind a feature toggle (if appropriate)
- [ ] If my work is behind a feature toggle, I've added a full suite of
tests for both the ON and OFF state
- [x] The ticket number is in the Pull Request title, with format
"APPT-XXX: My Title Here"
- [ ] I have ran npm tsc / lint (in the future these will be ran
automatically)
- [x] My code generates no new .NET warnings (in the future these will
be treated as errors)
- [ ] If I've added a new Function, it is disabled in all but one of the
terraform groups (e.g. http_functions)
- [ ] If I've added a new Function, it has both unit and integration
tests. Any request body validators have unit tests also
- [x] If I've made UI changes, I've added appropriate Playwright and
Jest tests
- [ ] If I've added/updated an end-point, I've added the appropriate
annotations and tested the Swagger documentation reflects the change

Author: ste-banks

postman-collection/Bulk Import.postman_collection.json

@@ -125,6 +125,46 @@
 				}
 			},
 			"response": []
+		},
+		{
+			"name": "site-status/import",
+			"request": {
+				"method": "POST",
+				"header": [
+					{
+						"key": "Authorization",
+						"value": "Bearer {{bearerToken}}",
+						"type": "text"
+					},
+					{
+						"key": "ClientId",
+						"value": "{{clientId}}",
+						"type": "text"
+					}
+				],
+				"body": {
+					"mode": "formdata",
+					"formdata": [
+						{
+							"key": "file",
+							"type": "file",
+							"src": []
+						}
+					]
+				},
+				"url": {
+					"raw": "{{baseUrl}}/api/site-status/import",
+					"host": [
+						"{{baseUrl}}"
+					],
+					"path": [
+						"api",
+						"site-status",
+						"import"
+					]
+				}
+			},
+			"response": []
 		}
 	]
 }

src/api/Nhs.Appointments.Api/Factories/DataImportHandlerFactory.cs

@@ -12,6 +12,7 @@ public class DataImportHandlerFactory(IServiceProvider serviceProvider) : IDataI
         BulkImportType.ApiUser => serviceProvider.GetService<IApiUserDataImportHandler>(),
         BulkImportType.Site => serviceProvider.GetService<ISiteDataImportHandler>(),
         BulkImportType.User => serviceProvider.GetService<IUserDataImportHandler>(),
+        BulkImportType.SiteStatus => serviceProvider.GetService<ISiteStatusDataImportHandler>(),
         _ => throw new NotSupportedException()
     };
 }

src/api/Nhs.Appointments.Api/FunctionConfigurationExtensions.cs

@@ -122,7 +122,8 @@ public static IFunctionsWorkerApplicationBuilder ConfigureFunctionDependencies(
             .AddScoped<IMetricsRecorder, InMemoryMetricsRecorder>()
             .AddUserNotifications(configuration)
             .AddAutoMapper(typeof(CosmosAutoMapperProfile))
-            .AddTransient<IAdminUserDataImportHandler, AdminUserDataImportHandler>();
+            .AddTransient<IAdminUserDataImportHandler, AdminUserDataImportHandler>()
+            .AddTransient<ISiteStatusDataImportHandler, SiteStatusDataImportHandler>();
 
         var leaseManagerConnection = Environment.GetEnvironmentVariable("LEASE_MANAGER_CONNECTION");
         if (leaseManagerConnection == "local")

src/api/Nhs.Appointments.Core/BulkImport/IDataImportHandler.cs

@@ -11,3 +11,4 @@ public interface IAdminUserDataImportHandler : IDataImportHandler { }
 public interface IApiUserDataImportHandler : IDataImportHandler { }
 public interface ISiteDataImportHandler : IDataImportHandler { }
 public interface IUserDataImportHandler : IDataImportHandler { }
+public interface ISiteStatusDataImportHandler : IDataImportHandler { }

src/api/Nhs.Appointments.Core/BulkImport/SiteStatusDataImportHandler.cs

@@ -0,0 +1,60 @@
+using Microsoft.AspNetCore.Http;
+
+namespace Nhs.Appointments.Core.BulkImport;
+public class SiteStatusDataImportHandler(ISiteService siteService) : ISiteStatusDataImportHandler
+{
+    public async Task<IEnumerable<ReportItem>> ProcessFile(IFormFile inputFile)
+    {
+        var siteRows = new List<SiteStatusImportRow>();
+        var processor = new CsvProcessor<SiteStatusImportRow, SiteStatusImportRowMap>(
+            sr => Task.Run(() => siteRows.Add(sr)),
+            sr => sr.Id,
+            () => new SiteStatusImportRowMap()
+        );
+        using TextReader fileReader = new StreamReader(inputFile.OpenReadStream());
+        var report = (await processor.ProcessFile(fileReader)).ToList();
+
+        var sites = await siteService.GetAllSites(includeDeleted: true);
+
+        var missingSites = FindMissingSites(siteRows, sites);
+        if (missingSites.Count > 0)
+        {
+            report.AddRange(missingSites.Select(ms => new ReportItem(-1, ms.Name, false, $"Could not find existing site with name {ms.Name} and ID: {ms.Id}")));
+        }
+
+        if (report.Any(r => !r.Success))
+        {
+            return report.Where(r => !r.Success);
+        }
+
+        foreach (var row in siteRows)
+        {
+            try
+            {
+                var result = await siteService.ToggleSiteSoftDeletionAsync(row.Id);
+                if (!result.Success)
+                {
+                    report.Add(new ReportItem(-1, row.Name, false, $"Failed to update the soft deletion status of site with name: {row.Name} and ID: {row.Id}"));
+                    continue;
+                }
+            }
+            catch (Exception ex)
+            {
+                report.Add(new ReportItem(-1, row.Name, false, ex.Message));
+            }
+        }
+
+        return report;
+    }
+
+    public static List<SiteStatusImportRow> FindMissingSites(List<SiteStatusImportRow> siteRows, IEnumerable<Site> sites)
+    {
+        return [.. siteRows.Where(sr => !sites.Any(s => s.Id == sr.Id && s.Name.Equals(sr.Name, StringComparison.CurrentCultureIgnoreCase)))];
+    }
+
+    public class SiteStatusImportRow
+    {
+        public string Id { get; set; }
+        public string Name { get; set; }
+    }
+}

src/api/Nhs.Appointments.Core/BulkImport/SiteStatusImportRowMap.cs

@@ -0,0 +1,30 @@
+using CsvHelper.Configuration;
+using static Nhs.Appointments.Core.BulkImport.SiteStatusDataImportHandler;
+
+namespace Nhs.Appointments.Core.BulkImport;
+public class SiteStatusImportRowMap : ClassMap<SiteStatusImportRow>
+{
+    public SiteStatusImportRowMap()
+    {
+        Map(m => m.Id).Convert(x =>
+        {
+            var site = x.Row.GetField<string>("Id");
+
+            if (!CsvFieldValidator.StringHasValue(site))
+                throw new ArgumentException("Site ID must have a value.");
+
+            return !Guid.TryParse(site, out _)
+                    ? throw new ArgumentException($"Invalid GUID string format for Site field: '{site}'")
+                    : site;
+        });
+        Map(m => m.Name).Convert(x =>
+        {
+            var name = x.Row.GetField<string>("Name");
+
+            if (!CsvFieldValidator.StringHasValue(name))
+                throw new ArgumentException("Site name must have a value.");
+
+            return name;
+        });
+    }
+}

src/api/Nhs.Appointments.Core/Constants/BulkImportType.cs

@@ -5,5 +5,6 @@ public static class BulkImportType
     // TODO: Can apiUser be removed completely?
     public const string ApiUser = "apiUser";
     public const string Site = "site";
+    public const string SiteStatus = "site-status";
     public const string User = "user";
 }

src/api/Nhs.Appointments.Core/ISiteStore.cs

@@ -24,4 +24,5 @@ Task<OperationResult> SaveSiteAsync(string siteId, string odsCode, string name,
     Task<OperationResult> UpdateSiteStatusAsync(string siteId, SiteStatus status);
 
     Task<IEnumerable<Site>> GetSitesInIcbAsync(string icb);
+    Task<OperationResult> ToggleSiteSoftDeletionAsync(string siteId);
 }

src/api/Nhs.Appointments.Core/SiteService.cs

@@ -28,6 +28,7 @@ Task<OperationResult> SaveSiteAsync(string siteId, string odsCode, string name,
     Task<OperationResult> SetSiteStatus(string siteId, SiteStatus status);
     Task<IEnumerable<Site>> GetSitesInIcbAsync(string icb);
     Task<IEnumerable<SiteWithDistance>> QuerySitesAsync(SiteFilter[] filters, int maxRecords, bool ignoreCache);
+    Task<OperationResult> ToggleSiteSoftDeletionAsync(string siteId);
 }
 
 public class SiteService(
@@ -169,7 +170,7 @@ public async Task<IEnumerable<Site>> GetAllSites(bool includeDeleted = false, bo
         // whereas DisableSiteCache is a global setting affecting all uses
         if (ignoreCache || options.Value.DisableSiteCache)
         {
-            return await siteStore.GetAllSites();
+            return await siteStore.GetAllSites(includeDeleted);
         }
 
         var sites = memoryCache.Get(options.Value.SiteCacheKey) as IEnumerable<Site>;
@@ -228,6 +229,22 @@ public async Task<OperationResult> SetSiteStatus(string siteId, SiteStatus statu
     public async Task<IEnumerable<Site>> GetSitesInIcbAsync(string icb)
         => await siteStore.GetSitesInIcbAsync(icb);
 
+    public async Task<OperationResult> ToggleSiteSoftDeletionAsync(string siteId)
+    {
+        var result = await siteStore.ToggleSiteSoftDeletionAsync(siteId);
+        if (!result.Success)
+        {
+            return result;
+        }
+
+        if (!options.Value.DisableSiteCache && memoryCache.TryGetValue(options.Value.SiteCacheKey, out _))
+        {
+            memoryCache.Remove(options.Value.SiteCacheKey);
+        }
+
+        return result;
+    }
+
     public async Task<IEnumerable<SiteWithDistance>> QuerySitesAsync(SiteFilter[] filters, int maxRecords, bool ignoreCache)
     {
         var sites = await GetAllSites(false, ignoreCache);

src/api/Nhs.Appointments.Persistance/SiteStore.cs

@@ -191,4 +191,23 @@ public async Task<OperationResult> UpdateSiteStatusAsync(string siteId, SiteStat
 
     public async Task<IEnumerable<Site>> GetSitesInIcbAsync(string icb)
         => await cosmosStore.RunQueryAsync<Site>(s => s.DocumentType == "site" && s.IntegratedCareBoard == icb);
+
+    public async Task<OperationResult> ToggleSiteSoftDeletionAsync(string siteId)
+    {
+        var originalDocument = await GetOrDefault(siteId);
+        if (originalDocument is null)
+        {
+            return new OperationResult(false, $"The specified site: {siteId} was not found.");
+        }
+
+        var docType = cosmosStore.GetDocumentType();
+
+        var patchOperation = originalDocument.isDeleted is null
+            ? PatchOperation.Add("/isDeleted", true)
+            : PatchOperation.Replace("/isDeleted", !originalDocument.isDeleted);
+
+        await cosmosStore.PatchDocument(docType, siteId, [patchOperation]);
+        return new OperationResult(true);
+        
+    }
 }