TD-3917 SupervisorController - refactor (Controller-Service-Repository pattern)

Author: sherif-olaboye

DigitalLearningSolutions.Web.Tests/Controllers/SupervisorController/SupervisorControllerTests.cs

@@ -1,9 +1,6 @@
 namespace DigitalLearningSolutions.Web.Tests.Controllers.Support
 {
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.SelfAssessmentDataService;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
-    using DigitalLearningSolutions.Data.Services;
+
     using DigitalLearningSolutions.Data.Utilities;
     using DigitalLearningSolutions.Web.Controllers.SupervisorController;
     using DigitalLearningSolutions.Web.Services;
@@ -21,21 +18,19 @@ public class SupervisorControllerTests
         private IFrameworkNotificationService frameworkNotificationService = null!;
         private ISelfAssessmentService selfAssessmentService = null!;
         private IFrameworkService frameworkService = null!;
-        private IConfigDataService configDataService = null!;
+        private IConfigService configService = null!;
         private ICentreRegistrationPromptsService centreRegistrationPromptsService = null!;
-        private IUserDataService userDataService = null!;
+        private IUserService userService = null!;
         private ILogger<SupervisorController> logger = null!;
         private IConfiguration config = null!;
         private ISearchSortFilterPaginateService searchSortFilterPaginateService = null!;
         private IMultiPageFormService multiPageFormService = null!;
         private IRegistrationService registrationService = null!;
-        private ICentresDataService centresDataService = null!;
-        private IUserService userService = null!;
+        private ICentresService centresService = null!;
         private IEmailGenerationService emailGenerationService = null!;
         private IEmailService emailService = null!;
         private IClockUtility clockUtility = null!;
         private ICandidateAssessmentDownloadFileService candidateAssessmentDownloadFileService = null!;
-        private ISelfAssessmentDataService selfAssessmentDataService = null!;
 
         [SetUp]
         public void Setup()
@@ -45,21 +40,19 @@ public void Setup()
             frameworkNotificationService = A.Fake<IFrameworkNotificationService>();
             selfAssessmentService = A.Fake<ISelfAssessmentService>();
             frameworkService = A.Fake<IFrameworkService>();
-            configDataService = A.Fake<IConfigDataService>();
+            configService = A.Fake<IConfigService>();
             centreRegistrationPromptsService = A.Fake<ICentreRegistrationPromptsService>();
-            userDataService = A.Fake<IUserDataService>();
+            userService = A.Fake<IUserService>();
             logger = A.Fake<ILogger<SupervisorController>>();
             config = A.Fake<IConfiguration>();
             searchSortFilterPaginateService = A.Fake<ISearchSortFilterPaginateService>();
             multiPageFormService = A.Fake<IMultiPageFormService>();
             registrationService = A.Fake<IRegistrationService>();
-            centresDataService = A.Fake<ICentresDataService>();
-            userService = A.Fake<IUserService>();
+            centresService = A.Fake<ICentresService>();
             emailGenerationService = A.Fake<IEmailGenerationService>();
             emailService = A.Fake<IEmailService>();
             clockUtility = A.Fake<IClockUtility>();
             candidateAssessmentDownloadFileService = A.Fake<ICandidateAssessmentDownloadFileService>();
-            selfAssessmentDataService = A.Fake<ISelfAssessmentDataService>();
 
             A.CallTo(() => candidateAssessmentDownloadFileService.GetCandidateAssessmentDownloadFileForCentre(A<int>._, A<int>._, A<bool>._))
                 .Returns(new byte[] { });
@@ -76,20 +69,18 @@ public void ExportCandidateAssessment_should_return_file_object_with_file_name_i
                    frameworkNotificationService,
                    selfAssessmentService,
                    frameworkService,
-                   configDataService,
+                   configService,
                    centreRegistrationPromptsService,
-                   userDataService,
+                   userService,
                    logger,
                    config,
                    searchSortFilterPaginateService,
                    multiPageFormService,
                    registrationService,
-                   centresDataService,
-                   userService,
+                   centresService,
                    emailGenerationService,
                    emailService,
                    candidateAssessmentDownloadFileService,
-                   selfAssessmentDataService,
                    clockUtility
                );
             string expectedFileName = $"{((selfAssessmentName.Length > 30) ? selfAssessmentName.Substring(0, 30) : selfAssessmentName)} - {delegateName} - {clockUtility.UtcNow:yyyy-MM-dd}.xlsx";

DigitalLearningSolutions.Web/Controllers/SupervisorController/Supervisor.cs

@@ -51,7 +51,7 @@ public IActionResult MyStaffList(
             var loggedInUserId = User.GetUserId();
             var centreId = GetCentreId();
             var supervisorEmail = GetUserEmail();
-            var loggedInAdminUser = userDataService.GetAdminUserById(adminId);
+            var loggedInAdminUser = userService.GetAdminUserById(adminId);
             var centreRegistrationPrompts = centreRegistrationPromptsService.GetCentreRegistrationPromptsByCentreId(centreId);
             var supervisorDelegateDetails = supervisorService.GetSupervisorDelegateDetailsForAdminId(adminId);
             var isSupervisor = User.GetCustomClaimAsBool(CustomClaimTypes.IsSupervisor) ?? false;
@@ -314,7 +314,7 @@ public IActionResult DelegateProfileAssessments(int supervisorDelegateId, int de
             var adminId = GetAdminId();
             var superviseDelegate = supervisorService.GetSupervisorDelegateDetailsById(supervisorDelegateId, adminId, delegateUserId);
             var loggedInUserId = User.GetAdminId();
-            var loggedInAdminUser = userDataService.GetAdminUserById(loggedInUserId!.GetValueOrDefault());
+            var loggedInAdminUser = userService.GetAdminUserById(loggedInUserId!.GetValueOrDefault());
             var delegateSelfAssessments = supervisorService.GetSelfAssessmentsForSupervisorDelegateId(supervisorDelegateId, adminId);
             var model = new DelegateSelfAssessmentsViewModel()
             {
@@ -1025,7 +1025,7 @@ public IActionResult QuickAddSupervisor(int selfAssessmentId, int supervisorDele
             else
             {
 
-                var candidateAssessmentId = selfAssessmentDataService.GetCandidateAssessments(delegateUserId, selfAssessmentId).SingleOrDefault()?.Id;
+                var candidateAssessmentId = selfAssessmentService.GetCandidateAssessments(delegateUserId, selfAssessmentId).SingleOrDefault()?.Id;
                 var roleId = supervisorRoles.Where(x => x.SelfAssessmentID == selfAssessmentId).Select(x => x.ID).FirstOrDefault();
                 if (candidateAssessmentId != null)
                 {

DigitalLearningSolutions.Web/Controllers/SupervisorController/SupervisorController.cs

@@ -1,9 +1,5 @@
 namespace DigitalLearningSolutions.Web.Controllers.SupervisorController
 {
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.SelfAssessmentDataService;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
-    using DigitalLearningSolutions.Data.Services;
     using DigitalLearningSolutions.Data.Utilities;
     using DigitalLearningSolutions.Web.Helpers;
     using DigitalLearningSolutions.Web.Services;
@@ -23,14 +19,12 @@ public partial class SupervisorController : Controller
         private readonly IMultiPageFormService multiPageFormService;
         private readonly ISelfAssessmentService selfAssessmentService;
         private readonly ISupervisorService supervisorService;
-        private readonly IUserDataService userDataService;
-        private readonly IRegistrationService registrationService;
-        private readonly ICentresDataService centresDataService;
         private readonly IUserService userService;
+        private readonly IRegistrationService registrationService;
+        private readonly ICentresService centresService;
         private readonly IEmailGenerationService emailGenerationService;
         private readonly IEmailService emailService;
         private readonly ICandidateAssessmentDownloadFileService candidateAssessmentDownloadFileService;
-        private readonly ISelfAssessmentDataService selfAssessmentDataService;
         private readonly IClockUtility clockUtility;
 
         public SupervisorController(
@@ -39,20 +33,18 @@ public SupervisorController(
            IFrameworkNotificationService frameworkNotificationService,
            ISelfAssessmentService selfAssessmentService,
            IFrameworkService frameworkService,
-           IConfigDataService configDataService,
+           IConfigService configService,
            ICentreRegistrationPromptsService centreRegistrationPromptsService,
-           IUserDataService userDataService,
+           IUserService userService,
            ILogger<SupervisorController> logger,
            IConfiguration config,
            ISearchSortFilterPaginateService searchSortFilterPaginateService,
            IMultiPageFormService multiPageFormService,
            IRegistrationService registrationService,
-           ICentresDataService centresDataService,
-           IUserService userService,
+           ICentresService centresService,
            IEmailGenerationService emailGenerationService,
            IEmailService emailService,
            ICandidateAssessmentDownloadFileService candidateAssessmentDownloadFileService,
-           ISelfAssessmentDataService selfAssessmentDataService,
            IClockUtility clockUtility
            )
         {
@@ -61,16 +53,14 @@ IClockUtility clockUtility
             this.frameworkService = frameworkService;
             this.selfAssessmentService = selfAssessmentService;
             this.centreRegistrationPromptsService = centreRegistrationPromptsService;
-            this.userDataService = userDataService;
+            this.userService = userService;
             this.searchSortFilterPaginateService = searchSortFilterPaginateService;
             this.multiPageFormService = multiPageFormService;
             this.registrationService = registrationService;
-            this.centresDataService = centresDataService;
-            this.userService = userService;
+            this.centresService = centresService;
             this.emailGenerationService = emailGenerationService;
             this.emailService = emailService;
             this.candidateAssessmentDownloadFileService = candidateAssessmentDownloadFileService;
-            this.selfAssessmentDataService = selfAssessmentDataService;
             this.clockUtility = clockUtility;
         }
 
@@ -87,14 +77,14 @@ private int GetAdminId()
         private string GetUserEmail()
         {
             var adminId = GetAdminId();
-            var adminEntity = userDataService.GetAdminById(adminId);
+            var adminEntity = userService.GetAdminById(adminId);
             return adminEntity!.EmailForCentreNotifications;
         }
 
         private string? GetBannerText()
         {
             var centreId = (int)User.GetCentreId();
-            var bannerText = centresDataService.GetBannerText(centreId);
+            var bannerText = centresService.GetBannerText(centreId);
             return bannerText;
         }
     }

DigitalLearningSolutions.Web/Services/CandidateAssessmentDownloadFileService.cs

@@ -1,4 +1,4 @@
-namespace DigitalLearningSolutions.Data.Services
+namespace DigitalLearningSolutions.Web.Services
 {
     using ClosedXML.Excel;
     using DigitalLearningSolutions.Data.DataServices.SelfAssessmentDataService;

DigitalLearningSolutions.Web/Services/SelfAssessmentService.cs

@@ -148,6 +148,8 @@ public int GetSelfAssessmentActivityDelegatesExportCount(string searchString, st
         IEnumerable<Accessor> GetAccessor(int selfAssessmentId, int delegateUserID);
         ActivitySummaryCompetencySelfAssesment GetActivitySummaryCompetencySelfAssesment(int CandidateAssessmentSupervisorVerificationsId);
         bool IsUnsupervisedSelfAssessment(int selfAssessmentId);
+        IEnumerable<CandidateAssessment> GetCandidateAssessments(int delegateUserId, int selfAssessmentId);
+
     }
 
     public class SelfAssessmentService : ISelfAssessmentService
@@ -541,5 +543,9 @@ public bool IsUnsupervisedSelfAssessment(int selfAssessmentId)
         {
             return selfAssessmentDataService.IsUnsupervisedSelfAssessment(selfAssessmentId);
         }
+        public IEnumerable<CandidateAssessment> GetCandidateAssessments(int delegateUserId, int selfAssessmentId)
+        {
+            return selfAssessmentDataService.GetCandidateAssessments(delegateUserId,selfAssessmentId);
+        }
     }
 }