Merge pull request #2683 from TechnologyEnhancedLearning/Develop/Fixes/TD-3930-AllDelegatesControllerRefactor

TD-3930 AllDelegatesController Refactor

Author: rshrirohit

DigitalLearningSolutions.Web.Tests/Controllers/TrackingSystem/Delegates/AllDelegatesControllerTests.cs

@@ -1,8 +1,6 @@
 namespace DigitalLearningSolutions.Web.Tests.Controllers.TrackingSystem.Delegates
 {
     using System.Collections.Generic;
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Models.SearchSortFilterPaginate;
     using DigitalLearningSolutions.Data.Models.User;
     using DigitalLearningSolutions.Data.Utilities;
@@ -27,10 +25,10 @@ public class AllDelegatesControllerTests
         private IDelegateDownloadFileService delegateDownloadFileService = null!;
         private HttpRequest httpRequest = null!;
         private HttpResponse httpResponse = null!;
-        private IJobGroupsDataService jobGroupsDataService = null!;
+        private IJobGroupsService jobGroupsService = null!;
         private PromptsService promptsHelper = null!;
         private IPaginateService paginateService = null!;
-        private IUserDataService userDataService = null!;
+        private IUserService userService = null!;
         private IGroupsService groupsService = null!;
         private IConfiguration? configuration;
         private IWebHostEnvironment? env;
@@ -41,8 +39,8 @@ public void Setup()
             centreRegistrationPromptsService = A.Fake<ICentreRegistrationPromptsService>();
             delegateDownloadFileService = A.Fake<IDelegateDownloadFileService>();
             promptsHelper = new PromptsService(centreRegistrationPromptsService);
-            userDataService = A.Fake<IUserDataService>();
-            jobGroupsDataService = A.Fake<IJobGroupsDataService>();
+            userService = A.Fake<IUserService>();
+            jobGroupsService = A.Fake<IJobGroupsService>();
             paginateService = A.Fake<IPaginateService>();
             groupsService = A.Fake<IGroupsService>();
             configuration = A.Fake<IConfiguration>();
@@ -54,9 +52,9 @@ public void Setup()
 
             allDelegatesController = new AllDelegatesController(
                     delegateDownloadFileService,
-                    userDataService,
+                    userService,
                     promptsHelper,
-                    jobGroupsDataService,
+                    jobGroupsService,
                     paginateService,
                     groupsService,
                     configuration,
@@ -74,18 +72,18 @@ public void Index_calls_expected_methods_and_returns_view()
             // When
 
             var loggedInAdmin = UserTestHelper.GetDefaultAdminEntity();
-            A.CallTo(() => userDataService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
+            A.CallTo(() => userService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
 
             var result = allDelegatesController.Index();
 
             // Then
             using (new AssertionScope())
             {
-                A.CallTo(() => userDataService.GetDelegateUserCards(A<string>._, A<int>._, A<int>._, A<string>._,
+                A.CallTo(() => userService.GetDelegateUserCards(A<string>._, A<int>._, A<int>._, A<string>._,
                     A<string>._, A<int>._, A<string>._, A<string>._, A<string>._, A<string>._, A<string>._,
                     A<string>._, A<int>._, A<int?>._, A<string>._, A<string>._, A<string>._, A<string>._, A<string>._, A<string>._)
                 ).MustHaveHappened();
-                A.CallTo(() => jobGroupsDataService.GetJobGroupsAlphabetical())
+                A.CallTo(() => jobGroupsService.GetJobGroupsAlphabetical())
                     .MustHaveHappened();
                 A.CallTo(() => centreRegistrationPromptsService.GetCentreRegistrationPromptsByCentreId(A<int>._))
                     .MustHaveHappened();

DigitalLearningSolutions.Web/Controllers/TrackingSystem/Delegates/AllDelegatesController.cs

@@ -2,8 +2,6 @@
 {
     using System;
     using System.Linq;
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Enums;
     using DigitalLearningSolutions.Data.Helpers;
     using DigitalLearningSolutions.Data.Models.SearchSortFilterPaginate;
@@ -29,29 +27,29 @@ public class AllDelegatesController : Controller
     {
         private string DelegateFilterCookieName = "DelegateFilter";
         private readonly IDelegateDownloadFileService delegateDownloadFileService;
-        private readonly IJobGroupsDataService jobGroupsDataService;
+        private readonly IJobGroupsService jobGroupsService;
         private readonly PromptsService promptsService;
         private readonly IPaginateService paginateService;
-        private readonly IUserDataService userDataService;
+        private readonly IUserService userService;
         private readonly IGroupsService groupsService;
         private readonly IConfiguration configuration;
         private readonly IWebHostEnvironment env;
 
         public AllDelegatesController(
             IDelegateDownloadFileService delegateDownloadFileService,
-            IUserDataService userDataService,
+            IUserService userDataService,
             PromptsService promptsService,
-            IJobGroupsDataService jobGroupsDataService,
+            IJobGroupsService jobGroupsDataService,
             IPaginateService paginateService,
             IGroupsService groupsService,
             IConfiguration configuration,
             IWebHostEnvironment env
         )
         {
             this.delegateDownloadFileService = delegateDownloadFileService;
-            this.userDataService = userDataService;
+            this.userService = userDataService;
             this.promptsService = promptsService;
-            this.jobGroupsDataService = jobGroupsDataService;
+            this.jobGroupsService = jobGroupsDataService;
             this.paginateService = paginateService;
             this.groupsService = groupsService;
             this.configuration = configuration;
@@ -72,7 +70,7 @@ public IActionResult Index(
         )
         {
             searchString = searchString == null ? string.Empty : searchString.Trim();
-            var loggedInSuperAdmin = userDataService.GetAdminById(User.GetAdminId()!.Value);
+            var loggedInSuperAdmin = userService.GetAdminById(User.GetAdminId()!.Value);
             if (loggedInSuperAdmin.AdminAccount.Active == false)
             {
                 return NotFound();
@@ -94,7 +92,7 @@ public IActionResult Index(
             int offSet = ((page - 1) * itemsPerPage) ?? 0;
 
             var centreId = User.GetCentreIdKnownNotNull();
-            var jobGroups = jobGroupsDataService.GetJobGroupsAlphabetical();
+            var jobGroups = jobGroupsService.GetJobGroupsAlphabetical();
             var customPrompts = promptsService.GetCentreRegistrationPrompts(centreId).ToList();
             var groups = groupsService.GetActiveGroups(centreId);
 
@@ -197,14 +195,14 @@ public IActionResult Index(
                 }
             }
 
-            (var delegates, var resultCount) = this.userDataService.GetDelegateUserCards(searchString ?? string.Empty, offSet, itemsPerPage ?? 0, sortBy, sortDirection, centreId,
+            (var delegates, var resultCount) = this.userService.GetDelegateUserCards(searchString ?? string.Empty, offSet, itemsPerPage ?? 0, sortBy, sortDirection, centreId,
                                                 isActive, isPasswordSet, isAdmin, isUnclaimed, isEmailVerified, registrationType, jobGroupId, groupId,
                                                 answer1, answer2, answer3, answer4, answer5, answer6);
 
             if (delegates.Count() == 0 && resultCount > 0)
             {
                 page = 1; offSet = 0;
-                (delegates, resultCount) = this.userDataService.GetDelegateUserCards(searchString ?? string.Empty, offSet, itemsPerPage ?? 0, sortBy, sortDirection, centreId,
+                (delegates, resultCount) = this.userService.GetDelegateUserCards(searchString ?? string.Empty, offSet, itemsPerPage ?? 0, sortBy, sortDirection, centreId,
                                                 isActive, isPasswordSet, isAdmin, isUnclaimed, isEmailVerified, registrationType, jobGroupId, groupId,
                                                 answer1, answer2, answer3, answer4, answer5, answer6);
             }

DigitalLearningSolutions.Web/Services/UserService.cs

@@ -128,6 +128,10 @@ int userId
                 string centreSpecificEmail,
                 string registrationConfirmationHash
             );
+        (IEnumerable<DelegateUserCard>, int) GetDelegateUserCards(string searchString, int offSet, int itemsPerPage, string sortBy, string sortDirection, int centreId,
+                                    string isActive, string isPasswordSet, string isAdmin, string isUnclaimed, string isEmailVerified, string registrationType, int jobGroupId,
+                                    int? groupId, string answer1, string answer2, string answer3, string answer4, string answer5, string answer6);
+
         DelegateUserCard? GetDelegateUserCardById(int id);
         void DeactivateDelegateUser(int delegateId);
         void ActivateDelegateUser(int delegateId);
@@ -727,6 +731,15 @@ public void SetPrimaryEmailVerified(int userId, string email, DateTime verifiedD
         {
             return userDataService.GetUserIdAndCentreForCentreEmailRegistrationConfirmationHashPair(centreSpecificEmail, registrationConfirmationHash);
         }
+
+        public (IEnumerable<DelegateUserCard>, int) GetDelegateUserCards(string searchString, int offSet, int itemsPerPage, string sortBy, string sortDirection, int centreId,
+                                    string isActive, string isPasswordSet, string isAdmin, string isUnclaimed, string isEmailVerified, string registrationType, int jobGroupId,
+                                    int? groupId, string answer1, string answer2, string answer3, string answer4, string answer5, string answer6)
+        {
+            return userDataService.GetDelegateUserCards(searchString, offSet, itemsPerPage, sortBy, sortDirection, centreId,
+                                    isActive, isPasswordSet, isAdmin, isUnclaimed, isEmailVerified, registrationType, jobGroupId,
+                                    groupId, answer1, answer2, answer3, answer4, answer5, answer6);
+        }
         public DelegateUserCard? GetDelegateUserCardById(int id)
         {
             return userDataService.GetDelegateUserCardById(id);