EHD-461: Load Tests: Code changes: Make most background jobs singletons

cabinetoffice · Feb 11, 2025 · bd35974 · bd35974
1 parent e6b9f08
commit bd35974
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 14 deletions.
diff --git a/GenderPayGap.WebUI/BackgroundJobs/JobHelpers.cs b/GenderPayGap.WebUI/BackgroundJobs/JobHelpers.cs
@@ -1,3 +1,4 @@
+using System.Collections.Concurrent;
 using GenderPayGap.Core.Classes.Logger;
 using GenderPayGap.Extensions;
 using GenderPayGap.Extensions.AspNetCore;
@@ -12,9 +13,35 @@ internal enum JobErrorsLogged
 
     internal static class JobHelpers {
 
+        private static readonly ConcurrentDictionary<string, string> ActionsCurrentlyRunning = [];
+
+        public static void RunAndLogSingletonJob(Action action, string actionName, JobErrorsLogged logErrors = JobErrorsLogged.Automatically)
+        {
+            RunAndLogSingletonJob(unusedRunId => action(), actionName, logErrors);
+        }
+
+        public static void RunAndLogSingletonJob(Action<string> action, string actionName, JobErrorsLogged logErrors = JobErrorsLogged.Automatically)
+        {
+            if (ActionsCurrentlyRunning.TryAdd(actionName, ""))
+            {
+                try
+                {
+                    RunAndLogJob(action, actionName, logErrors);
+                }
+                finally
+                {
+                    ActionsCurrentlyRunning.Remove(actionName, out _);
+                }
+            }
+            else
+            {
+                CustomLogger.Information($"Function already running: {actionName}", new {environment = Config.EnvironmentName});
+            }
+        }
+
         public static void RunAndLogJob(Action action, string actionName, JobErrorsLogged logErrors = JobErrorsLogged.Automatically)
         {
-            RunAndLogJob(unusedRunId => action(), actionName, logErrors);
+            RunAndLogJob(_ => action(), actionName, logErrors);
         }
 
         public static void RunAndLogJob(Action<string> action, string actionName, JobErrorsLogged logErrors = JobErrorsLogged.Automatically)

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/AnonymiseRetiredDuplicateUsersJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/AnonymiseRetiredDuplicateUsersJob.cs
@@ -22,7 +22,7 @@ public AnonymiseRetiredDuplicateUsersJob(IDataRepository dataRepository)
         //Remove any duplicate retired user details
         public void AnonymiseRetiredDuplicateUsers()
         {
-            JobHelpers.RunAndLogJob(AnonymiseRetiredDuplicateUsersAction, nameof(AnonymiseRetiredDuplicateUsers));
+            JobHelpers.RunAndLogSingletonJob(AnonymiseRetiredDuplicateUsersAction, nameof(AnonymiseRetiredDuplicateUsers));
         }
 
         private void AnonymiseRetiredDuplicateUsersAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/AnonymiseThreeYearOldFeedbackJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/AnonymiseThreeYearOldFeedbackJob.cs
@@ -16,7 +16,7 @@ public AnonymiseThreeYearOldFeedbackJob(IDataRepository dataRepository)
 
         public void AnonymiseFeedback()
         {
-            JobHelpers.RunAndLogJob(GetAndAnonymiseFeedback, nameof(AnonymiseFeedback));
+            JobHelpers.RunAndLogSingletonJob(GetAndAnonymiseFeedback, nameof(AnonymiseFeedback));
         }
 
         public void GetAndAnonymiseFeedback()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/BackupDatabaseToJsonFileJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/BackupDatabaseToJsonFileJob.cs
@@ -28,7 +28,7 @@ public BackupDatabaseToJsonFileJob(
 
         public void RunBackup()
         {
-            JobHelpers.RunAndLogJob(RunBackupAction, nameof(RunBackup));
+            JobHelpers.RunAndLogSingletonJob(RunBackupAction, nameof(RunBackup));
         }
 
         private void RunBackupAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/FetchCompaniesHouseDataJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/FetchCompaniesHouseDataJob.cs
@@ -22,7 +22,7 @@ public FetchCompaniesHouseDataJob(
 
         public void FetchCompaniesHouseData()
         {
-            JobHelpers.RunAndLogJob(UpdateFromCompaniesHouse, nameof(FetchCompaniesHouseData));
+            JobHelpers.RunAndLogSingletonJob(UpdateFromCompaniesHouse, nameof(FetchCompaniesHouseData));
         }
 
         private void UpdateFromCompaniesHouse(string runId)

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/NotifyUsersAndRetireInactiveAccountsJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/NotifyUsersAndRetireInactiveAccountsJob.cs
@@ -20,7 +20,7 @@ public NotifyUsersAndRetireInactiveAccountsJob(IDataRepository dataRepository, E
 
         public void NotifyUsersAndRetireInactiveAccounts()
         {
-            JobHelpers.RunAndLogJob(NotifyUsersAndRetireInactiveAccountsAction, nameof(NotifyUsersAndRetireInactiveAccounts));
+            JobHelpers.RunAndLogSingletonJob(NotifyUsersAndRetireInactiveAccountsAction, nameof(NotifyUsersAndRetireInactiveAccounts));
         }
 
         private void NotifyUsersAndRetireInactiveAccountsAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeOrganisationsJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeOrganisationsJob.cs
@@ -25,7 +25,7 @@ public PurgeOrganisationsJob(IDataRepository dataRepository, AuditLogger auditLo
         //Remove any unverified users their addresses, UserOrgs, Org and addresses and archive to zip
         public void PurgeOrganisations()
         {
-            JobHelpers.RunAndLogJob(PurgeOrganisationsAction, nameof(PurgeOrganisations));
+            JobHelpers.RunAndLogSingletonJob(PurgeOrganisationsAction, nameof(PurgeOrganisations));
         }
 
         private void PurgeOrganisationsAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeRegistrationsJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeRegistrationsJob.cs
@@ -23,7 +23,7 @@ public PurgeRegistrationsJob(IDataRepository dataRepository, AuditLogger auditLo
         //Remove any incomplete registrations
         public void PurgeRegistrations()
         {
-            JobHelpers.RunAndLogJob(PurgeRegistrationsAction, nameof(PurgeRegistrations));
+            JobHelpers.RunAndLogSingletonJob(PurgeRegistrationsAction, nameof(PurgeRegistrations));
         }
 
         private void PurgeRegistrationsAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeUsersJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/PurgeUsersJob.cs
@@ -23,7 +23,7 @@ public PurgeUsersJob(IDataRepository dataRepository, AuditLogger auditLogger)
         //Remove any unverified users their addresses, UserOrgs, Org and addresses and archive to zip
         public void PurgeUsers()
         {
-            JobHelpers.RunAndLogJob(PurgeUsersAction, nameof(PurgeUsers));
+            JobHelpers.RunAndLogSingletonJob(PurgeUsersAction, nameof(PurgeUsers));
         }
 
         private void PurgeUsersAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/SendReminderEmailsJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/SendReminderEmailsJob.cs
@@ -29,7 +29,7 @@ public SendReminderEmailsJob(
 
         public void SendReminderEmails()
         {
-            JobHelpers.RunAndLogJob(SendReminderEmailsAction, nameof(SendReminderEmails));
+            JobHelpers.RunAndLogSingletonJob(SendReminderEmailsAction, nameof(SendReminderEmails));
         }
 
         private void SendReminderEmailsAction(string runId)

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/SetPresumedScopesJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/SetPresumedScopesJob.cs
@@ -20,7 +20,7 @@ public SetPresumedScopesJob(IDataRepository dataRepository)
         //Set presumed scope of previous years and current years
         public void SetPresumedScopes()
         {
-            JobHelpers.RunAndLogJob(SetPresumedScopesAction, nameof(SetPresumedScopes));
+            JobHelpers.RunAndLogSingletonJob(SetPresumedScopesAction, nameof(SetPresumedScopes));
         }
 
         private void SetPresumedScopesAction()

diff --git a/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/UpdatePublicFacingDownloadFilesJob.cs b/GenderPayGap.WebUI/BackgroundJobs/ScheduledJobs/UpdatePublicFacingDownloadFilesJob.cs
@@ -29,7 +29,7 @@ public UpdatePublicFacingDownloadFilesJob(
 
         public void UpdateDownloadFiles()
         {
-            JobHelpers.RunAndLogJob(UpdateDownloadFilesAction, nameof(UpdateDownloadFiles));
+            JobHelpers.RunAndLogSingletonJob(UpdateDownloadFilesAction, nameof(UpdateDownloadFiles));
         }
 
         private void UpdateDownloadFilesAction()

diff --git a/GenderPayGap.WebUI/Search/SearchCacheUpdaterService.cs b/GenderPayGap.WebUI/Search/SearchCacheUpdaterService.cs
@@ -7,6 +7,8 @@ public class SearchCacheUpdaterService : IHostedService, IDisposable
     {
         private Timer timer;
 
+        private bool updateInProgress = false;
+
         public Task StartAsync(CancellationToken stoppingToken)
         {
             CustomLogger.Information("Starting timer (SearchRepository.StartCacheUpdateThread)");
@@ -27,18 +29,29 @@ public Task StartAsync(CancellationToken stoppingToken)
 
         private void DoWork(object state)
         {
+            if (updateInProgress)
+            {
+                CustomLogger.Information("Cache update postponed - another update is already in progress (SearchRepository.StartCacheUpdateThread)");
+                return;
+            }
+
+            updateInProgress = true;
             CustomLogger.Information("Starting cache update (SearchRepository.StartCacheUpdateThread)");
 
             try
             {
                 SearchRepository.LoadSearchDataIntoCache();
+
+                CustomLogger.Information("Finished cache update (SearchRepository.StartCacheUpdateThread)");
             }
             catch (Exception ex)
             {
                 CustomLogger.Error($"Error during cache update (SearchRepository.StartCacheUpdateThread): {ex.Message} {ex.StackTrace}", ex);
             }
-
-            CustomLogger.Information("Finished cache update (SearchRepository.StartCacheUpdateThread)");
+            finally
+            {
+                updateInProgress = false;
+            }
         }
 
         public Task StopAsync(CancellationToken stoppingToken)