TD-3913-Controller refactor -DataService reference removed from the controller. Code modified to use service class methods.

Author: Auldrin-Possa

DigitalLearningSolutions.Web.Tests/Controllers/SuperAdmin/AdminAccountsControllerTests.cs

@@ -1,9 +1,7 @@
 namespace DigitalLearningSolutions.Web.Tests.Controllers.SuperAdmin
 {
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Models.SearchSortFilterPaginate;
-    using DigitalLearningSolutions.Data.Models.User;    
+    using DigitalLearningSolutions.Data.Models.User;
     using DigitalLearningSolutions.Web.Controllers.SuperAdmin.Administrators;
     using DigitalLearningSolutions.Web.Services;
     using DigitalLearningSolutions.Web.Tests.ControllerHelpers;
@@ -19,46 +17,43 @@
     public class AdminAccountsControllerTests
     {
         private AdminAccountsController administratorsController = null!;
-        private IUserDataService userDataService = null!;
         private IAdminDownloadFileService adminDownloadFileService = null!;
         private ISearchSortFilterPaginateService searchSortFilterPaginateService = null!;
-        private ICentresDataService centresDataService = null!;
-        private ICourseCategoriesDataService courseCategoriesDataService = null!;
+        private ICentresService centresService = null!;
+        private ICourseCategoriesService courseCategoriesService = null!;
         private IUserService userService = null!;
         private ICentreContractAdminUsageService centreContractAdminUsageService = null!;
-        private INotificationPreferencesDataService notificationPreferencesDataService = null!;
-        private INotificationDataService notificationDataService = null!;
+        private INotificationPreferencesService notificationPreferencesService = null!;
+        private INotificationService notificationService = null!;
         const string CookieName = "AdminFilter";
         private HttpRequest httpRequest = null!;
         private HttpResponse httpResponse = null!;
 
         [SetUp]
         public void Setup()
         {
-            userDataService = A.Fake <IUserDataService>();
-            centresDataService = A.Fake <ICentresDataService>();
-            searchSortFilterPaginateService = A.Fake <ISearchSortFilterPaginateService>();
-            adminDownloadFileService = A.Fake <IAdminDownloadFileService>();
-            courseCategoriesDataService = A.Fake<ICourseCategoriesDataService>();
+            centresService = A.Fake<ICentresService>();
+            searchSortFilterPaginateService = A.Fake<ISearchSortFilterPaginateService>();
+            adminDownloadFileService = A.Fake<IAdminDownloadFileService>();
+            courseCategoriesService = A.Fake<ICourseCategoriesService>();
             userService = A.Fake<IUserService>();
             centreContractAdminUsageService = A.Fake<ICentreContractAdminUsageService>();
-            notificationPreferencesDataService = A.Fake<INotificationPreferencesDataService>();
-            notificationDataService = A.Fake<INotificationDataService>();
+            notificationPreferencesService = A.Fake<INotificationPreferencesService>();
+            notificationService = A.Fake<INotificationService>();
 
-        httpRequest = A.Fake<HttpRequest>();
+            httpRequest = A.Fake<HttpRequest>();
             httpResponse = A.Fake<HttpResponse>();
             const string cookieValue = "Role|IsCentreAdmin|true";
 
             administratorsController = new AdminAccountsController(
-                    userDataService,
-                    centresDataService,
+                    centresService,
                     searchSortFilterPaginateService,
                     adminDownloadFileService,
-                    courseCategoriesDataService,
+                    courseCategoriesService,
                     userService,
                     centreContractAdminUsageService,
-                    notificationPreferencesDataService,
-                    notificationDataService
+                    notificationPreferencesService,
+                    notificationService
                 )
                 .WithMockHttpContext(httpRequest, CookieName, cookieValue, httpResponse)
                 .WithMockUser(true)
@@ -71,23 +66,23 @@ public void Index_calls_expected_methods_and_returns_view()
         {
             // Given
             var loggedInAdmin = UserTestHelper.GetDefaultAdminEntity();
-            A.CallTo(() => userDataService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
+            A.CallTo(() => userService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
 
             // When
             var result = administratorsController.Index();
 
             // Then
             using (new AssertionScope())
             {
-                A.CallTo(() => userDataService.GetAllAdmins(A<string>._, A<int>._, A<int>._, A<int>._, A<string>._, A<string>._, A<int>._, A<int>._)).MustHaveHappened();
-                A.CallTo(() => centresDataService.GetAllCentres(false)).MustHaveHappened();
+                A.CallTo(() => userService.GetAllAdmins(A<string>._, A<int>._, A<int>._, A<int>._, A<string>._, A<string>._, A<int>._, A<int>._)).MustHaveHappened();
+                A.CallTo(() => centresService.GetAllCentres(false)).MustHaveHappened();
                 A.CallTo(
                     () => searchSortFilterPaginateService.SearchFilterSortAndPaginate(
                         A<IEnumerable<AdminEntity>>._,
                         A<SearchSortFilterAndPaginateOptions>._
                     )
                 ).MustHaveHappened();
-                
+
                 result.Should().BeViewResult().WithDefaultViewName();
             }
         }
@@ -98,16 +93,16 @@ public void EditCentre_calls_expected_methods_and_returns_view()
             int adminId = 1;
             var loggedInAdmin = UserTestHelper.GetDefaultAdminEntity();
 
-            A.CallTo(() => userDataService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
+            A.CallTo(() => userService.GetAdminById(loggedInAdmin.AdminAccount.Id)).Returns(loggedInAdmin);
 
             // When
             var result = administratorsController.EditCentre(adminId);
 
             //Then
             using (new AssertionScope())
             {
-                A.CallTo(() => userDataService.GetAdminUserById(adminId)).MustHaveHappened();
-                A.CallTo(() => centresDataService.GetAllCentres(true)).MustHaveHappened();
+                A.CallTo(() => userService.GetAdminUserById(adminId)).MustHaveHappened();
+                A.CallTo(() => centresService.GetAllCentres(true)).MustHaveHappened();
                 result.Should().BeViewResult().WithDefaultViewName();
             }
         }

DigitalLearningSolutions.Web/Controllers/SuperAdmin/Administrators/AdminAccountsController.cs

@@ -1,7 +1,5 @@
 namespace DigitalLearningSolutions.Web.Controllers.SuperAdmin.Administrators
 {
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Enums;
     using DigitalLearningSolutions.Data.Helpers;
     using DigitalLearningSolutions.Data.Models.Common;
@@ -31,35 +29,33 @@
     [SetSelectedTab(nameof(NavMenuTab.Admins))]
     public class AdminAccountsController : Controller
     {
-        private readonly IUserDataService userDataService;
         private readonly IAdminDownloadFileService adminDownloadFileService;
         private readonly ISearchSortFilterPaginateService searchSortFilterPaginateService;
-        private readonly ICentresDataService centresDataService;
-        private readonly ICourseCategoriesDataService courseCategoriesDataService;
+        private readonly ICentresService centresService;
+        private readonly ICourseCategoriesService courseCategoriesService;
         private readonly IUserService userService;
         private readonly ICentreContractAdminUsageService centreContractAdminUsageService;
-        private readonly INotificationPreferencesDataService notificationPreferencesDataService;
-        private readonly INotificationDataService notificationDataService;
-        public AdminAccountsController(IUserDataService userDataService,
-            ICentresDataService centresDataService,
+        private readonly INotificationPreferencesService notificationPreferencesService;
+        private readonly INotificationService notificationService;
+        public AdminAccountsController(
+            ICentresService centresService,
             ISearchSortFilterPaginateService searchSortFilterPaginateService,
             IAdminDownloadFileService adminDownloadFileService,
-            ICourseCategoriesDataService courseCategoriesDataService,
+            ICourseCategoriesService courseCategoriesService,
             IUserService userService,
             ICentreContractAdminUsageService centreContractAdminUsageService,
-            INotificationPreferencesDataService notificationPreferencesDataService,
-            INotificationDataService notificationDataService
+            INotificationPreferencesService notificationPreferencesService,
+            INotificationService notificationService
             )
         {
-            this.userDataService = userDataService;
-            this.centresDataService = centresDataService;
+            this.centresService = centresService;
             this.searchSortFilterPaginateService = searchSortFilterPaginateService;
             this.adminDownloadFileService = adminDownloadFileService;
-            this.courseCategoriesDataService = courseCategoriesDataService;
+            this.courseCategoriesService = courseCategoriesService;
             this.userService = userService;
             this.centreContractAdminUsageService = centreContractAdminUsageService;
-            this.notificationPreferencesDataService = notificationPreferencesDataService;
-            this.notificationDataService = notificationDataService;
+            this.notificationPreferencesService = notificationPreferencesService;
+            this.notificationService = notificationService;
         }
 
         [Route("SuperAdmin/AdminAccounts/{page=0:int}")]
@@ -75,7 +71,7 @@ public IActionResult Index(
           string? ExistingFilterString = ""
         )
         {
-            var loggedInSuperAdmin = userDataService.GetAdminById(User.GetAdminId()!.Value);
+            var loggedInSuperAdmin = userService.GetAdminById(User.GetAdminId()!.Value);
             if (loggedInSuperAdmin.AdminAccount.Active == false)
             {
                 return NotFound();
@@ -134,9 +130,9 @@ public IActionResult Index(
                 }
             }
 
-            (var Admins, var ResultCount) = this.userDataService.GetAllAdmins(Search ?? string.Empty, offSet, itemsPerPage ?? 0, AdminId, UserStatus, Role, CentreId, AuthHelper.FailedLoginThreshold);
+            (var Admins, var ResultCount) = this.userService.GetAllAdmins(Search ?? string.Empty, offSet, itemsPerPage ?? 0, AdminId, UserStatus, Role, CentreId, AuthHelper.FailedLoginThreshold);
 
-            var centres = centresDataService.GetAllCentres().ToList();
+            var centres = centresService.GetAllCentres().ToList();
             centres.Insert(0, (0, "Any"));
 
             var searchSortPaginationOptions = new SearchSortFilterAndPaginateOptions(
@@ -203,14 +199,14 @@ public IActionResult Index(
         public IActionResult ManageRoles(int adminId)
         {
             var centreId = User.GetCentreIdKnownNotNull();
-            var adminUser = userDataService.GetAdminUserById(adminId);
+            var adminUser = userService.GetAdminUserById(adminId);
 
-            var categories = courseCategoriesDataService.GetCategoriesForCentreAndCentrallyManagedCourses(centreId);
+            var categories = courseCategoriesService.GetCategoriesForCentreAndCentrallyManagedCourses(centreId);
             categories = categories.Prepend(new Category { CategoryName = "All", CourseCategoryID = 0 });
             var numberOfAdmins = centreContractAdminUsageService.GetCentreAdministratorNumbers(centreId);
 
             var model = new ManageRoleViewModel(adminUser!, centreId, categories, numberOfAdmins);
-            var result = centresDataService.GetCentreDetailsById(centreId);
+            var result = centresService.GetCentreDetailsById(centreId);
             model.CentreName = result.CentreName;
 
             if (TempData["SearchString"] != null)
@@ -246,14 +242,14 @@ public IActionResult ManageRoles(AdminRolesFormData formData, int adminId)
                 formData.IsLocalWorkforceManager))
             {
                 var centreId = User.GetCentreIdKnownNotNull();
-                var adminUser = userDataService.GetAdminUserById(adminId);
+                var adminUser = userService.GetAdminUserById(adminId);
 
-                var categories = courseCategoriesDataService.GetCategoriesForCentreAndCentrallyManagedCourses(centreId);
+                var categories = courseCategoriesService.GetCategoriesForCentreAndCentrallyManagedCourses(centreId);
                 categories = categories.Prepend(new Category { CategoryName = "All", CourseCategoryID = 0 });
                 var numberOfAdmins = centreContractAdminUsageService.GetCentreAdministratorNumbers(centreId);
 
                 var model = new ManageRoleViewModel(adminUser!, centreId, categories, numberOfAdmins);
-                var result = centresDataService.GetCentreDetailsById(centreId);
+                var result = centresService.GetCentreDetailsById(centreId);
                 model.CentreName = result.CentreName;
                 model.ContentManagementRole = formData.ContentManagementRole;
                 model.IsCentreAdmin = formData.IsCentreAdmin;
@@ -291,7 +287,7 @@ public IActionResult ManageRoles(AdminRolesFormData formData, int adminId)
 
             TempData["AdminId"] = adminId;
             int? learningCategory = formData.LearningCategory == 0 ? null : formData.LearningCategory;
-            userDataService.UpdateAdminUserAndSpecialPermissions(
+            userService.UpdateAdminUserAndSpecialPermissions(
                 adminId,
                 formData.IsCentreAdmin,
                 formData.IsSupervisor,
@@ -313,10 +309,10 @@ public IActionResult ManageRoles(AdminRolesFormData formData, int adminId)
             int isCMSManager = (formData.ContentManagementRole.IsContentManager && !formData.ContentManagementRole.ImportOnly) ? 1 : 0;
             int isContentCreator = formData.IsContentCreator ? 1 : 0;
 
-            IEnumerable<int> notificationIds = notificationDataService.GetRoleBasedNotifications(isCentreManager, isCMSManager, isContentCreator);
-            int userId = userDataService.GetUserIdFromAdminId(adminId);
+            IEnumerable<int> notificationIds = notificationService.GetRoleBasedNotifications(isCentreManager, isCMSManager, isContentCreator);
+            int userId = userService.GetUserIdFromAdminId(adminId);
 
-            notificationPreferencesDataService.SetNotificationPreferencesForAdmin(userId, notificationIds);
+            notificationPreferencesService.SetNotificationPreferencesForAdmin(userId, notificationIds);
 
             return RedirectToAction("Index", "AdminAccounts", new { AdminId = adminId });
         }
@@ -360,23 +356,23 @@ public List<string> GetRoles()
         [Route("SuperAdmin/AdminAccounts/{adminId=0:int}/DeleteAdmin")]
         public IActionResult DeleteAdmin(int adminId = 0)
         {
-            userDataService.DeleteAdminAccount(adminId);
+            userService.DeleteAdminAccount(adminId);
             return RedirectToAction("Index", "AdminAccounts");
         }
 
         [Route("SuperAdmin/AdminAccounts/{adminId=0:int}/{actionType='':string}/UpdateAdminStatus")]
         public IActionResult UpdateAdminStatus(int adminId, string actionType)
         {
-            userDataService.UpdateAdminStatus(adminId, (actionType == "Reactivate"));
+            userService.UpdateAdminStatus(adminId, (actionType == "Reactivate"));
             TempData["AdminId"] = adminId;
             return RedirectToAction("Index", "AdminAccounts", new { AdminId = adminId });
         }
 
         [Route("SuperAdmin/AdminAccounts/{adminId=0:int}/ChangeCentre")]
         public IActionResult EditCentre(int adminId)
         {
-            var adminUser = userDataService.GetAdminUserById(adminId);
-            var centres = centresDataService.GetAllCentres(true).ToList();
+            var adminUser = userService.GetAdminUserById(adminId);
+            var centres = centresService.GetAllCentres(true).ToList();
             ViewBag.Centres = SelectListHelper.MapOptionsToSelectListItems(
                centres, adminUser.CentreId
            );
@@ -406,15 +402,15 @@ public IActionResult EditCentre(int adminId)
         public IActionResult EditCentre(int adminId, int centreId)
         {
             TempData["AdminId"] = adminId;
-            int? userId = userDataService.GetUserIdByAdminId(adminId);
-            if (userDataService.IsUserAlreadyAdminAtCentre(userId, centreId))
+            int? userId = userService.GetUserIdByAdminId(adminId);
+            if (userService.IsUserAlreadyAdminAtCentre(userId, centreId))
             {
                 TempData["CentreId"] = centreId;
                 return RedirectToAction("EditCentre", "AdminAccounts", new { AdminId = adminId });
             }
             else
             {
-                userDataService.UpdateAdminCentre(adminId, centreId);
+                userService.UpdateAdminCentre(adminId, centreId);
                 return RedirectToAction("Index", "AdminAccounts", new { AdminId = adminId });
             }
         }
@@ -428,7 +424,7 @@ public IActionResult RedirectToUser(int UserId) {
         [HttpGet]
         public IActionResult DeactivateOrDeleteAdmin(int adminId, ReturnPageQuery returnPageQuery)
         {
-            var admin = userDataService.GetAdminById(adminId);
+            var admin = userService.GetAdminById(adminId);
 
             if (!CurrentUserCanDeactivateAdmin(admin!.AdminAccount))
             {
@@ -443,7 +439,7 @@ public IActionResult DeactivateOrDeleteAdmin(int adminId, ReturnPageQuery return
         [HttpPost]
         public IActionResult DeactivateOrDeleteAdmin(int adminId, DeactivateAdminViewModel model)
         {
-            var admin = userDataService.GetAdminById(adminId);
+            var admin = userService.GetAdminById(adminId);
 
             if (!CurrentUserCanDeactivateAdmin(admin!.AdminAccount))
             {
@@ -462,7 +458,7 @@ public IActionResult DeactivateOrDeleteAdmin(int adminId, DeactivateAdminViewMod
 
         private bool CurrentUserCanDeactivateAdmin(AdminAccount adminToDeactivate)
         {
-            var loggedInAdmin = userDataService.GetAdminById(User.GetAdminId()!.GetValueOrDefault());
+            var loggedInAdmin = userService.GetAdminById(User.GetAdminId()!.GetValueOrDefault());
 
             return UserPermissionsHelper.LoggedInAdminCanDeactivateUser(adminToDeactivate, loggedInAdmin!.AdminAccount);
         }

DigitalLearningSolutions.Web/Services/NotificationPreferencesService.cs

@@ -10,6 +10,7 @@ public interface INotificationPreferencesService
     {
         IEnumerable<NotificationPreference> GetNotificationPreferencesForUser(UserType userType, int? userId);
         void SetNotificationPreferencesForUser(UserType userType, int? userId, IEnumerable<int> notificationIds);
+        void SetNotificationPreferencesForAdmin(int? adminId, IEnumerable<int> notificationIds);
     }
 
     public class NotificationPreferencesService : INotificationPreferencesService
@@ -36,6 +37,11 @@ public IEnumerable<NotificationPreference> GetNotificationPreferencesForUser(Use
             throw new Exception($"No code path for getting notification preferences for user type {userType}");
         }
 
+        public void SetNotificationPreferencesForAdmin(int? adminId, IEnumerable<int> notificationIds)
+        {
+            notificationPreferencesDataService.SetNotificationPreferencesForAdmin(adminId, notificationIds);
+        }
+
         public void SetNotificationPreferencesForUser(UserType userType, int? userId, IEnumerable<int> notificationIds)
         {
             if (userType.Equals(UserType.AdminUser))