Readd current RefProvider and split into V1 and V2 namespaces

jsed-nhs · jsed-nhs · commit 424e9d4691b7 · 2025-10-30T14:07:21.000Z
diff --git a/src/api/Nhs.Appointments.Api/FunctionConfigurationExtensions.cs b/src/api/Nhs.Appointments.Api/FunctionConfigurationExtensions.cs
@@ -28,9 +28,12 @@
 using Nhs.Appointments.Core.Messaging;
 using Nhs.Appointments.Core.Okta;
 using Nhs.Appointments.Core.ReferenceNumber;
+using Nhs.Appointments.Core.ReferenceNumber.V1;
+using Nhs.Appointments.Core.ReferenceNumber.V2;
 using Nhs.Appointments.Core.Reports;
 using Nhs.Appointments.Core.Reports.SiteSummary;
 using Nhs.Appointments.Persistance;
+using Nhs.Appointments.Persistance.Reference;
 
 namespace Nhs.Appointments.Api;
 
@@ -70,6 +73,7 @@ public static IFunctionsWorkerApplicationBuilder ConfigureFunctionDependencies(
 
         builder.Services
             .Configure<CosmosDataStoreOptions>(opts => opts.DatabaseName = "appts")
+            .Configure<ReferenceGroupOptions>(opts => opts.InitialGroupCount = 100)
             .Configure<SiteSummaryOptions>(opts =>
             {
                 opts.DaysForward = configuration.GetValue<int>("SITE_SUMMARY_DAYS_FORWARD");
@@ -94,11 +98,13 @@ public static IFunctionsWorkerApplicationBuilder ConfigureFunctionDependencies(
             .AddTransient<IAvailabilityCreatedEventStore, AvailabilityCreatedEventDocumentStore>()
             .AddTransient<IBookingsDocumentStore, BookingCosmosDocumentStore>()
             .AddTransient<IBookingReferenceDocumentStore, BookingReferenceCosmosDocumentStore>()
+            .AddTransient<IReferenceNumberDocumentStore, ReferenceGroupCosmosDocumentStore>()
             .AddTransient<IEulaStore, EulaStore>()
             .AddTransient<IUserStore, UserStore>()
             .AddTransient<IRolesStore, RolesStore>()
             .AddTransient<IRolesService, RolesService>()
             .AddTransient<ISiteStore, SiteStore>()
+            .AddTransient<IReferenceNumberProvider, ReferenceNumberProvider>()
             .AddTransient<IEmailWhitelistStore, EmailWhitelistStore>()
             .AddTransient<INotificationConfigurationStore, NotificationConfigurationStore>()
             .AddTransient<IAccessibilityDefinitionsStore, AccessibilityDefinitionsStore>()
diff --git a/src/api/Nhs.Appointments.Core/BookingWriteService.cs b/src/api/Nhs.Appointments.Core/BookingWriteService.cs
@@ -3,6 +3,8 @@
 using Nhs.Appointments.Core.Messaging;
 using Nhs.Appointments.Core.Messaging.Events;
 using Nhs.Appointments.Core.ReferenceNumber;
+using Nhs.Appointments.Core.ReferenceNumber.V1;
+using Nhs.Appointments.Core.ReferenceNumber.V2;
 
 namespace Nhs.Appointments.Core;
 
@@ -43,7 +45,8 @@ Task<BookingRecalculationsStatistics> RecalculateAppointmentStatuses(string site
 public class BookingWriteService(
     IBookingsDocumentStore bookingDocumentStore,
     IBookingQueryService bookingQueryService,
-    IProvider provider,
+    IReferenceNumberProvider referenceNumberProviderV1,
+    IProvider referenceNumberProviderV2,
     ISiteLeaseManager siteLeaseManager,
     IBookingAvailabilityStateService bookingAvailabilityStateService,
     IBookingEventFactory eventFactory,
@@ -71,7 +74,10 @@ public class BookingWriteService(
         }
 
         booking.Created = time.GetUtcNow();
-        booking.Reference = await provider.GetReferenceNumber();
+        
+        booking.Reference = await referenceNumberProviderV1.GetReferenceNumber(booking.Site);
+        
+        booking.Reference = await referenceNumberProviderV2.GetReferenceNumber();
         booking.ReminderSent = false;
         booking.AvailabilityStatus = AvailabilityStatus.Supported;
         await bookingDocumentStore.InsertAsync(booking);
diff --git a/src/api/Nhs.Appointments.Core/Features/Flags.cs b/src/api/Nhs.Appointments.Core/Features/Flags.cs
@@ -9,6 +9,7 @@ public static class Flags
     public const string CancelDay = "CancelDay";
     public const string ChangeSessionUpliftedJourney = "ChangeSessionUpliftedJourney";
     public const string QuerySites = "QuerySites";
+    public const string BookingReferenceV2 = "BookingReferenceV2";
 
     #region TestFlags
     //a simple on/off global flag
diff --git a/src/api/Nhs.Appointments.Core/ISiteStore.cs b/src/api/Nhs.Appointments.Core/ISiteStore.cs
@@ -1,21 +1,25 @@
 namespace Nhs.Appointments.Core;
 
 public interface ISiteStore
-{    
+{
     Task<Site> GetSiteById(string siteId);
     Task<OperationResult> UpdateAccessibilities(string siteId, IEnumerable<Accessibility> accessibilities);
     Task<OperationResult> UpdateInformationForCitizens(string siteId, string informationForCitizens);
 
     Task<OperationResult> UpdateSiteDetails(string siteId, string name, string address, string phoneNumber,
         decimal? longitude,
         decimal? latitude);
-    
+
     Task<OperationResult> UpdateSiteReferenceDetails(string siteId, string odsCode, string icb, string region);
-    
+
     Task<IEnumerable<Site>> GetAllSites(bool includeDeleted = false);
 
+    Task AssignPrefix(string site, int prefix);
+    Task<int> GetReferenceNumberGroup(string site);
+
     Task<OperationResult> SaveSiteAsync(string siteId, string odsCode, string name, string address, string phoneNumber,
-        string icb, string region, Location location, IEnumerable<Accessibility> accessibilities, string type, SiteStatus? siteStatus = null, bool? isDeleted = null);
+        string icb, string region, Location location, IEnumerable<Accessibility> accessibilities, string type,
+        SiteStatus? siteStatus = null, bool? isDeleted = null);
 
     Task<IEnumerable<Site>> GetSitesInRegionAsync(string region);
 
diff --git a/src/api/Nhs.Appointments.Core/ReferenceNumber/V1/Provider.cs b/src/api/Nhs.Appointments.Core/ReferenceNumber/V1/Provider.cs
@@ -0,0 +1,43 @@
+namespace Nhs.Appointments.Core.ReferenceNumber.V1;
+
+public interface IReferenceNumberProvider
+{
+    Task<string> GetReferenceNumber(string siteId);
+}
+
+public class ReferenceNumberProvider : IReferenceNumberProvider
+{
+    private readonly ISiteStore _siteStore;
+    private readonly IReferenceNumberDocumentStore _referenceNumberDocumentStore;
+    private readonly TimeProvider _timeProvider;
+    public ReferenceNumberProvider(
+        ISiteStore siteStore,
+        IReferenceNumberDocumentStore referenceNumberDocumentStore,
+        TimeProvider timeProvider)
+    {
+        _siteStore = siteStore;
+        _referenceNumberDocumentStore = referenceNumberDocumentStore;
+        _timeProvider = timeProvider;
+    }
+    public async Task<string> GetReferenceNumber(string siteId)
+    {        
+        var referenceGroup = await _siteStore.GetReferenceNumberGroup(siteId);
+        if (referenceGroup == 0)
+        {
+            referenceGroup = await _referenceNumberDocumentStore.AssignReferenceGroup();
+            await _siteStore.AssignPrefix(siteId, referenceGroup);
+        }
+
+        var sequence = await _referenceNumberDocumentStore.GetNextSequenceNumber(referenceGroup);
+        var now = _timeProvider.GetUtcNow();
+        var rng = now.Day + now.Second;
+
+        return $"{referenceGroup:00}-{rng:00}-{sequence:000000}";
+    }
+}
+
+public interface IReferenceNumberDocumentStore
+{
+    Task<int> AssignReferenceGroup();
+    Task<int> GetNextSequenceNumber(int prefix);
+}
diff --git a/src/api/Nhs.Appointments.Core/ReferenceNumber/V2/Options.cs b/src/api/Nhs.Appointments.Core/ReferenceNumber/V2/Options.cs
@@ -1,4 +1,4 @@
-namespace Nhs.Appointments.Core.ReferenceNumber;
+namespace Nhs.Appointments.Core.ReferenceNumber.V2;
 
 public class ReferenceNumberOptions
 {
diff --git a/src/api/Nhs.Appointments.Core/ReferenceNumber/V2/Provider.cs b/src/api/Nhs.Appointments.Core/ReferenceNumber/V2/Provider.cs
@@ -6,7 +6,7 @@
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Options;
 
-namespace Nhs.Appointments.Core.ReferenceNumber;
+namespace Nhs.Appointments.Core.ReferenceNumber.V2;
 
 public interface IProvider
 {
diff --git a/src/api/Nhs.Appointments.Persistance/Models/Reference/BookingReferenceDocument.cs b/src/api/Nhs.Appointments.Persistance/Models/Reference/BookingReferenceDocument.cs
@@ -1,4 +1,4 @@
-namespace Nhs.Appointments.Persistance.Models;
+namespace Nhs.Appointments.Persistance.Models.Reference;
 
 [CosmosDocumentType("system")]
 public class BookingReferenceDocument : CoreDataCosmosDocument
diff --git a/src/api/Nhs.Appointments.Persistance/Models/Reference/ReferenceGroupDocument.cs b/src/api/Nhs.Appointments.Persistance/Models/Reference/ReferenceGroupDocument.cs
@@ -0,0 +1,14 @@
+namespace Nhs.Appointments.Persistance.Models.Reference;
+
+[CosmosDocumentType("reference_group")]
+public class ReferenceGroupDocument : CoreDataCosmosDocument
+{
+    public ReferenceGroup[] Groups { get; set; }
+}
+
+public class ReferenceGroup
+{
+    public int Prefix { get; set; }
+    public int SiteCount { get; set; }
+    public int Sequence { get; set; }
+}
diff --git a/src/api/Nhs.Appointments.Persistance/Models/SiteDocument.cs b/src/api/Nhs.Appointments.Persistance/Models/SiteDocument.cs
@@ -33,7 +33,10 @@ public class SiteDocument : CoreDataCosmosDocument
     /// </summary>
     public double? Latitude => Location?.Coordinates[1];
 
-    [JsonProperty("informationForCitizens")] public string InformationForCitizens { get; set; }
+    [JsonProperty("informationForCitizens")]
+    public string InformationForCitizens { get; set; }
+
+    [JsonProperty("referenceNumberGroup")] public int ReferenceNumberGroup { get; set; }
 
     [JsonProperty("accessibilities")] public Accessibility[] Accessibilities { get; set; }
 
diff --git a/src/api/Nhs.Appointments.Persistance/Reference/BookingReferenceCosmosDocumentStore.cs b/src/api/Nhs.Appointments.Persistance/Reference/BookingReferenceCosmosDocumentStore.cs
@@ -1,8 +1,8 @@
 using Microsoft.Azure.Cosmos;
-using Nhs.Appointments.Core.ReferenceNumber;
-using Nhs.Appointments.Persistance.Models;
+using Nhs.Appointments.Core.ReferenceNumber.V2;
+using Nhs.Appointments.Persistance.Models.Reference;
 
-namespace Nhs.Appointments.Persistance
+namespace Nhs.Appointments.Persistance.Reference
 {
     public class BookingReferenceCosmosDocumentStore(ITypedDocumentCosmosStore<BookingReferenceDocument> cosmosStore)
         : IBookingReferenceDocumentStore
diff --git a/src/api/Nhs.Appointments.Persistance/Reference/ReferenceGroupCosmosDocumentStore.cs b/src/api/Nhs.Appointments.Persistance/Reference/ReferenceGroupCosmosDocumentStore.cs
@@ -0,0 +1,65 @@
+using Microsoft.Azure.Cosmos;
+using Microsoft.Extensions.Options;
+using Nhs.Appointments.Core.ReferenceNumber.V1;
+using Nhs.Appointments.Persistance.Models.Reference;
+
+namespace Nhs.Appointments.Persistance.Reference
+{
+    public class ReferenceGroupCosmosDocumentStore : IReferenceNumberDocumentStore
+    {
+        private const string DocumentId = "main";
+        private readonly ITypedDocumentCosmosStore<ReferenceGroupDocument> _cosmosStore;
+        private readonly ReferenceGroupOptions _options;
+
+        public ReferenceGroupCosmosDocumentStore(ITypedDocumentCosmosStore<ReferenceGroupDocument> cosmosStore, IOptions<ReferenceGroupOptions> options)
+        {
+            _cosmosStore = cosmosStore;
+            _options = options.Value;
+        }
+
+        public async Task<int> AssignReferenceGroup()
+        {
+            ReferenceGroupDocument referenceGroupDocument;
+            var docType = _cosmosStore.GetDocumentType();
+            try
+            {
+                referenceGroupDocument = await _cosmosStore.GetByIdAsync<ReferenceGroupDocument>("main");
+            }
+            catch(CosmosException ex) when (ex.StatusCode == System.Net.HttpStatusCode.NotFound)
+            {
+                referenceGroupDocument = new ReferenceGroupDocument
+                {
+                    DocumentType = docType,
+                    Id = DocumentId,
+                    Groups = Enumerable.Range(0, _options.InitialGroupCount).Select(x => new ReferenceGroup
+                    {
+                        Prefix = x,
+                        Sequence = 0,
+                        SiteCount = 0
+                    }).ToArray()
+                };
+
+                await _cosmosStore.WriteAsync(referenceGroupDocument);
+            }
+
+            var target = referenceGroupDocument!.Groups.Where(g => g.Prefix > 0).OrderBy(g => g.SiteCount).ThenBy(g => g.Prefix).First();
+            var siteCountIncrement = PatchOperation.Increment($"/Groups/{target.Prefix}/SiteCount", 1);
+
+            await _cosmosStore.PatchDocument(docType, DocumentId, siteCountIncrement);
+            return target.Prefix;
+        }
+
+        public async Task<int> GetNextSequenceNumber(int prefix)
+        {
+            var incrementSequencePatch = PatchOperation.Increment($"/Groups/{prefix}/Sequence", 1);
+            var docType = _cosmosStore.GetDocumentType();
+            var referenceGroupDocument = await _cosmosStore.PatchDocument(docType, DocumentId, incrementSequencePatch);
+            return referenceGroupDocument.Groups.Single(gr => gr.Prefix == prefix).Sequence;
+        }
+    }
+
+    public class ReferenceGroupOptions
+    {
+        public int InitialGroupCount { get; set; }
+    }
+}
diff --git a/src/api/Nhs.Appointments.Persistance/SiteStore.cs b/src/api/Nhs.Appointments.Persistance/SiteStore.cs
@@ -14,13 +14,29 @@ public Task<Site> GetSiteById(string siteId)
 
     public Task<IEnumerable<Site>> GetAllSites(bool includeDeleted = false)
     {
-        return cosmosStore.RunQueryAsync<Site>(sd => sd.DocumentType == "site" && (includeDeleted || sd.IsDeleted == null || !sd.IsDeleted.HasValue || !sd.IsDeleted.Value));
+        return cosmosStore.RunQueryAsync<Site>(sd =>
+            sd.DocumentType == "site" &&
+            (includeDeleted || sd.IsDeleted == null || !sd.IsDeleted.HasValue || !sd.IsDeleted.Value));
     }
 
-    public async Task<OperationResult> UpdateSiteReferenceDetails(string siteId, string odsCode, string icb, string region)
+    public async Task<int> GetReferenceNumberGroup(string site)
+    {
+        var siteDocument = await cosmosStore.GetDocument<SiteDocument>(site);
+        return siteDocument.ReferenceNumberGroup;
+    }
+
+    public Task AssignPrefix(string site, int prefix)
+    {
+        var updatePrefix = PatchOperation.Set("/referenceNumberGroup", prefix);
+        var partitionKey = cosmosStore.GetDocumentType();
+        return cosmosStore.PatchDocument(partitionKey, site, updatePrefix);
+    }
+
+    public async Task<OperationResult> UpdateSiteReferenceDetails(string siteId, string odsCode, string icb,
+        string region)
     {
         var originalDocument = await GetOrDefault(siteId);
-        if (originalDocument == null || 
+        if (originalDocument == null ||
             !ValidateUpdateToSiteAllowed(originalDocument))
         {
             return new OperationResult(false, "The specified site was not found.");
@@ -51,11 +67,14 @@ public async Task<OperationResult> UpdateAccessibilities(string siteId, IEnumera
         {
             return new OperationResult(false, "The specified site was not found.");
         }
+
         var documentType = cosmosStore.GetDocumentType();
-        var siteDocumentPatch = PatchOperation.Add("/accessibilities", accessibilities.Where(a => !string.IsNullOrEmpty(a.Value)));
+        var siteDocumentPatch =
+            PatchOperation.Add("/accessibilities", accessibilities.Where(a => !string.IsNullOrEmpty(a.Value)));
         await cosmosStore.PatchDocument(documentType, siteId, siteDocumentPatch);
         return new OperationResult(true);
     }
+
     public async Task<OperationResult> UpdateInformationForCitizens(string siteId, string informationForCitizens)
     {
         var originalDocument = await GetOrDefault(siteId);
@@ -64,6 +83,7 @@ public async Task<OperationResult> UpdateInformationForCitizens(string siteId, s
         {
             return new OperationResult(false, "The specified site was not found.");
         }
+
         var documentType = cosmosStore.GetDocumentType();
         var siteDocumentPatch = PatchOperation.Set("/informationForCitizens", informationForCitizens);
         await cosmosStore.PatchDocument(documentType, siteId, siteDocumentPatch);
@@ -74,13 +94,14 @@ public async Task<OperationResult> UpdateSiteDetails(string siteId, string name,
         decimal? longitude, decimal? latitude)
     {
         decimal?[] coords = (longitude != null) & (latitude != null) ? [longitude, latitude] : [];
-        
+
         var originalDocument = await GetOrDefault(siteId);
         if (originalDocument == null ||
             !ValidateUpdateToSiteAllowed(originalDocument))
         {
             return new OperationResult(false, "The specified site was not found.");
         }
+
         var documentType = cosmosStore.GetDocumentType();
         PatchOperation[] detailsPatchOperations =
         [
@@ -93,7 +114,7 @@ public async Task<OperationResult> UpdateSiteDetails(string siteId, string name,
         await cosmosStore.PatchDocument(documentType, siteId, detailsPatchOperations);
         return new OperationResult(true);
     }
-    
+
     private async Task<Site> GetOrDefault(string siteId)
     {
         try
@@ -106,8 +127,10 @@ private async Task<Site> GetOrDefault(string siteId)
         }
     }
 
-    public async Task<OperationResult> SaveSiteAsync(string siteId, string odsCode, string name, string address, string phoneNumber,
-        string icb, string region, Location location, IEnumerable<Accessibility> accessibilities, string type, SiteStatus? siteStatus = null, bool? isDeleted = null)
+    public async Task<OperationResult> SaveSiteAsync(string siteId, string odsCode, string name, string address,
+        string phoneNumber,
+        string icb, string region, Location location, IEnumerable<Accessibility> accessibilities, string type,
+        SiteStatus? siteStatus = null, bool? isDeleted = null)
     {
         var originalDocument = await GetOrDefault(siteId);
         if (originalDocument is null)
@@ -141,7 +164,8 @@ public async Task<OperationResult> SaveSiteAsync(string siteId, string odsCode,
                 return new OperationResult(false, "The specified site can not be updated.");
             }
 
-            var updateSite = UpdateSiteDetails(siteId, name, address, phoneNumber, (decimal)location.Coordinates[0], (decimal)location.Coordinates[1]);
+            var updateSite = UpdateSiteDetails(siteId, name, address, phoneNumber, (decimal)location.Coordinates[0],
+                (decimal)location.Coordinates[1]);
             var updateAccessiblities = UpdateAccessibilities(siteId, accessibilities);
 
             await Task.WhenAll(updateSite, updateAccessiblities);
@@ -170,7 +194,7 @@ public async Task<OperationResult> UpdateSiteStatusAsync(string siteId, SiteStat
             ? PatchOperation.Add("/status", status)
             : PatchOperation.Replace("/status", status);
 
-        PatchOperation[] patchOperations = [ patchOperation ];
+        PatchOperation[] patchOperations = [patchOperation];
 
         await cosmosStore.PatchDocument(documentType, siteId, patchOperations);
         return new OperationResult(true);
diff --git a/tests/Nhs.Appointments.Core.UnitTests/BookingWriteServiceTests.cs b/tests/Nhs.Appointments.Core.UnitTests/BookingWriteServiceTests.cs
diff --git a/tests/Nhs.Appointments.Core.UnitTests/ReferenceNumber/V1/ReferenceNumberProviderTests.cs b/tests/Nhs.Appointments.Core.UnitTests/ReferenceNumber/V1/ReferenceNumberProviderTests.cs
diff --git a/tests/Nhs.Appointments.Core.UnitTests/ReferenceNumber/V2/ProviderTests.cs b/tests/Nhs.Appointments.Core.UnitTests/ReferenceNumber/V2/ProviderTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Nhs.Appointments.Core.ReferenceNumber;`
	`1`	`+namespace Nhs.Appointments.Core.ReferenceNumber.V2;`
`2`	`2`
`3`	`3`	`public class ReferenceNumberOptions`
`4`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`using Microsoft.Extensions.Caching.Memory;`
`7`	`7`	`using Microsoft.Extensions.Options;`
`8`	`8`
`9`		`-namespace Nhs.Appointments.Core.ReferenceNumber;`
	`9`	`+namespace Nhs.Appointments.Core.ReferenceNumber.V2;`
`10`	`10`
`11`	`11`	`public interface IProvider`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Nhs.Appointments.Persistance.Models;`
	`1`	`+namespace Nhs.Appointments.Persistance.Models.Reference;`
`2`	`2`
`3`	`3`	`[CosmosDocumentType("system")]`
`4`	`4`	`public class BookingReferenceDocument : CoreDataCosmosDocument`