Merge pull request #2694 from TechnologyEnhancedLearning/Develop/feature/TD-3905-RegisterController-refactor

TD-3905-RegisterController - refactor

Author: rshrirohit

DigitalLearningSolutions.Web.Tests/Controllers/Register/RegisterControllerTests.cs

@@ -2,8 +2,6 @@
 {
     using System.Collections.Generic;
     using System.Threading.Tasks;
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Enums;
     using DigitalLearningSolutions.Data.Exceptions;
     using DigitalLearningSolutions.Data.Models.Register;
@@ -28,27 +26,25 @@ public class RegisterControllerTests
     {
         private const string IpAddress = "1.1.1.1";
         private const int SupervisorDelegateId = 1;
-        private ICentresDataService centresDataService = null!;
+        private ICentresService centresService = null!;
         private RegisterController controller = null!;
         private ICryptoService cryptoService = null!;
         private IFeatureManager featureManager = null!;
-        private IJobGroupsDataService jobGroupsDataService = null!;
+        private IJobGroupsService jobGroupsService = null!;
         private PromptsService promptsService = null!;
         private IRegistrationService registrationService = null!;
         private HttpRequest request = null!;
         private ISupervisorDelegateService supervisorDelegateService = null!;
-        private IUserDataService userDataService = null!;
         private IUserService userService = null!;
         private ISupervisorService supervisorService = null!;
 
         [SetUp]
         public void Setup()
         {
-            centresDataService = A.Fake<ICentresDataService>();
+            centresService = A.Fake<ICentresService>();
             cryptoService = A.Fake<ICryptoService>();
-            jobGroupsDataService = A.Fake<IJobGroupsDataService>();
+            jobGroupsService = A.Fake<IJobGroupsService>();
             registrationService = A.Fake<IRegistrationService>();
-            userDataService = A.Fake<IUserDataService>();
             userService = A.Fake<IUserService>();
             promptsService = A.Fake<PromptsService>();
             featureManager = A.Fake<IFeatureManager>();
@@ -57,14 +53,13 @@ public void Setup()
             request = A.Fake<HttpRequest>();
 
             controller = new RegisterController(
-                    centresDataService,
-                    jobGroupsDataService,
+                    centresService,
+                    jobGroupsService,
                     registrationService,
                     cryptoService,
                     promptsService,
                     featureManager,
                     supervisorDelegateService,
-                    userDataService,
                     userService,
                     supervisorService
                 )
@@ -104,7 +99,7 @@ public void IndexGet_with_no_centreId_shows_index_page()
             var result = controller.Index();
 
             // Then
-            A.CallTo(() => centresDataService.GetCentreName(A<int>._)).MustNotHaveHappened();
+            A.CallTo(() => centresService.GetCentreName(A<int>._)).MustNotHaveHappened();
 
             using (new AssertionScope())
             {
@@ -120,7 +115,7 @@ public void IndexGet_with_centreId_shows_index_page()
             const int centreId = 1;
             const string centreName = "centre";
             const string inviteId = "invite";
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).Returns(centreName);
+            A.CallTo(() => centresService.GetCentreName(centreId)).Returns(centreName);
 
             // When
             var result = controller.Index(centreId, inviteId);
@@ -139,13 +134,13 @@ public void IndexGet_with_invalid_centreId_param_shows_error()
         {
             // Given
             const int centreId = 7;
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).Returns(null);
+            A.CallTo(() => centresService.GetCentreName(centreId)).Returns(null);
 
             // When
             var result = controller.Index(centreId);
 
             // Then
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
+            A.CallTo(() => centresService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
             result.Should().BeNotFoundResult();
         }
 
@@ -156,14 +151,13 @@ public void IndexGet_while_logged_in_redirects_to_register_at_new_centre_journey
             const int centreId = 1;
             const string inviteId = "invite";
             var authenticatedController = new RegisterController(
-                centresDataService,
-                jobGroupsDataService,
+                centresService,
+                jobGroupsService,
                 registrationService,
                 cryptoService,
                 promptsService,
                 featureManager,
                 supervisorDelegateService,
-                userDataService,
                 userService,
                 supervisorService
             ).WithDefaultContext().WithMockUser(true);
@@ -181,13 +175,13 @@ public void Start_with_invalid_centreId_param_shows_error()
         {
             // Given
             const int centreId = 7;
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).Returns(null);
+            A.CallTo(() => centresService.GetCentreName(centreId)).Returns(null);
 
             // When
             var result = controller.Start(centreId);
 
             // Then
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
+            A.CallTo(() => centresService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
             result.Should().BeNotFoundResult();
         }
 
@@ -196,13 +190,13 @@ public void Start_with_valid_centreId_param_sets_data_correctly()
         {
             // Given
             const int centreId = 7;
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).Returns("Some centre");
+            A.CallTo(() => centresService.GetCentreName(centreId)).Returns("Some centre");
 
             // When
             var result = controller.Start(centreId);
 
             // Then
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
+            A.CallTo(() => centresService.GetCentreName(centreId)).MustHaveHappened(1, Times.Exactly);
             var data = controller.TempData.Peek<DelegateRegistrationData>()!;
             data.Centre.Should().Be(centreId);
             data.IsCentreSpecificRegistration.Should().BeTrue();
@@ -216,7 +210,7 @@ public void Start_with_no_centreId_param_allows_normal_registration()
             var result = controller.Start();
 
             // Then
-            A.CallTo(() => centresDataService.GetCentreName(A<int>._)).MustNotHaveHappened();
+            A.CallTo(() => centresService.GetCentreName(A<int>._)).MustNotHaveHappened();
             var data = controller.TempData.Peek<DelegateRegistrationData>()!;
             data.Centre.Should().BeNull();
             data.IsCentreSpecificRegistration.Should().BeFalse();
@@ -231,19 +225,18 @@ public void Start_while_logged_in_redirects_to_register_at_new_centre_journey()
             const string centreName = "centre";
             const string inviteId = "invite";
             var authenticatedController = new RegisterController(
-                centresDataService,
-                jobGroupsDataService,
+                centresService,
+                jobGroupsService,
                 registrationService,
                 cryptoService,
                 promptsService,
                 featureManager,
                 supervisorDelegateService,
-                userDataService,
                 userService,
                 supervisorService
             ).WithDefaultContext().WithMockUser(true);
 
-            A.CallTo(() => centresDataService.GetCentreName(centreId)).Returns(centreName);
+            A.CallTo(() => centresService.GetCentreName(centreId)).Returns(centreName);
 
             // When
             var result = authenticatedController.Start(centreId, inviteId);
@@ -502,7 +495,7 @@ int userId
             );
 
             A.CallTo(
-                    () => userDataService.GetUserIdFromUsername(candidateNumber)
+                    () => userService.GetUserIdFromUsername(candidateNumber)
                 )
                 .Returns(userId);
         }

DigitalLearningSolutions.Web/Controllers/Register/RegisterController.cs

@@ -3,8 +3,6 @@ namespace DigitalLearningSolutions.Web.Controllers.Register
     using System;
     using System.Collections.Generic;
     using System.Threading.Tasks;
-    using DigitalLearningSolutions.Data.DataServices;
-    using DigitalLearningSolutions.Data.DataServices.UserDataService;
     using DigitalLearningSolutions.Data.Enums;
     using DigitalLearningSolutions.Data.Exceptions;
     using DigitalLearningSolutions.Web.Attributes;
@@ -23,38 +21,35 @@ namespace DigitalLearningSolutions.Web.Controllers.Register
     [SetSelectedTab(nameof(NavMenuTab.Register))]
     public class RegisterController : Controller
     {
-        private readonly ICentresDataService centresDataService;
+        private readonly ICentresService centresService;
         private readonly ICryptoService cryptoService;
         private readonly IFeatureManager featureManager;
-        private readonly IJobGroupsDataService jobGroupsDataService;
+        private readonly IJobGroupsService jobGroupsService;
         private readonly PromptsService promptsService;
         private readonly IRegistrationService registrationService;
         private readonly ISupervisorDelegateService supervisorDelegateService;
-        private readonly IUserDataService userDataService;
         private readonly IUserService userService;
         private readonly ISupervisorService supervisorService;
 
         public RegisterController(
-            ICentresDataService centresDataService,
-            IJobGroupsDataService jobGroupsDataService,
+            ICentresService centresService,
+            IJobGroupsService jobGroupsService,
             IRegistrationService registrationService,
             ICryptoService cryptoService,
             PromptsService promptsService,
             IFeatureManager featureManager,
             ISupervisorDelegateService supervisorDelegateService,
-            IUserDataService userDataService,
             IUserService userService,
             ISupervisorService supervisorService
         )
         {
-            this.centresDataService = centresDataService;
-            this.jobGroupsDataService = jobGroupsDataService;
+            this.centresService = centresService;
+            this.jobGroupsService = jobGroupsService;
             this.registrationService = registrationService;
             this.cryptoService = cryptoService;
             this.promptsService = promptsService;
             this.featureManager = featureManager;
             this.supervisorDelegateService = supervisorDelegateService;
-            this.userDataService = userDataService;
             this.supervisorService = supervisorService;
             this.userService = userService;
         }
@@ -348,7 +343,7 @@ public IActionResult Confirmation(
 
         private string? GetCentreName(int? centreId)
         {
-            return centreId == null ? null : centresDataService.GetCentreName(centreId.Value);
+            return centreId == null ? null : centresService.GetCentreName(centreId.Value);
         }
 
         private IEnumerable<EditDelegateRegistrationPromptViewModel>
@@ -385,9 +380,9 @@ DelegateRegistrationData data
 
         private void PopulatePersonalInformationExtraFields(PersonalInformationViewModel model)
         {
-            model.CentreName = model.Centre.HasValue ? centresDataService.GetCentreName(model.Centre.Value) : null;
+            model.CentreName = model.Centre.HasValue ? centresService.GetCentreName(model.Centre.Value) : null;
             model.CentreOptions = SelectListHelper.MapOptionsToSelectListItems(
-                centresDataService.GetCentresForDelegateSelfRegistrationAlphabetical(),
+                centresService.GetCentresForDelegateSelfRegistrationAlphabetical(),
                 model.Centre
             );
         }
@@ -400,15 +395,15 @@ DelegateRegistrationData data
             model.DelegateRegistrationPrompts =
                 GetEditDelegateRegistrationPromptViewModelsFromModel(model, data.Centre!.Value);
             model.JobGroupOptions = SelectListHelper.MapOptionsToSelectListItems(
-                jobGroupsDataService.GetJobGroupsAlphabetical(),
+                jobGroupsService.GetJobGroupsAlphabetical(),
                 model.JobGroup
             );
         }
 
         private void PopulateSummaryExtraFields(SummaryViewModel model, DelegateRegistrationData data)
         {
-            model.Centre = centresDataService.GetCentreName((int)data.Centre!);
-            model.JobGroup = jobGroupsDataService.GetJobGroupName((int)data.JobGroup!);
+            model.Centre = centresService.GetCentreName((int)data.Centre!);
+            model.JobGroup = jobGroupsService.GetJobGroupName((int)data.JobGroup!);
             model.DelegateRegistrationPrompts = GetDelegateRegistrationPromptsFromData(data);
         }
 

DigitalLearningSolutions.Web/Services/UserService.cs

@@ -142,6 +142,7 @@ string registrationConfirmationHash
         int? GetUserIdByAdminId(int adminId);
         AdminUser? GetAdminUserByEmailAddress(string emailAddress);
         DelegateAccount? GetDelegateAccountById(int id);
+        int? GetUserIdFromUsername(string username);
     }
 
     public class UserService : IUserService
@@ -785,5 +786,10 @@ public bool CentreSpecificEmailIsInUseAtCentre(string email, int centreId)
         {
             return userDataService.GetDelegateAccountById(id);
         }
+
+        public int? GetUserIdFromUsername(string username)
+        {
+            return userDataService.GetUserIdFromUsername(username);
+        }
     }
 }