Merge pull request #2700 from TechnologyEnhancedLearning/Develop/feature/TD-3925-SystemNotificationsController-refactor

TD-3925-SystemNotificationsController - refactor

Author: rshrirohit

DigitalLearningSolutions.Web.Tests/Controllers/TrackingSystem/Centre/SystemNotificationControllerTests.cs

@@ -2,7 +2,6 @@
 {
     using System;
     using System.Collections.Generic;
-    using DigitalLearningSolutions.Data.DataServices;
     using DigitalLearningSolutions.Data.Models;    
     using DigitalLearningSolutions.Data.Utilities;
     using DigitalLearningSolutions.Web.Controllers.TrackingSystem.Centre;
@@ -23,18 +22,18 @@ public class SystemNotificationControllerTests
         private HttpRequest httpRequest = null!;
         private HttpResponse httpResponse = null!;
         private ISearchSortFilterPaginateService searchSortFilterPaginateService = null!;
-        private ISystemNotificationsDataService systemNotificationsDataService = null!;
+        private ISystemNotificationsService systemNotificationsService = null!;
 
         [SetUp]
         public void Setup()
         {
             httpRequest = A.Fake<HttpRequest>();
             httpResponse = A.Fake<HttpResponse>();
-            systemNotificationsDataService = A.Fake<ISystemNotificationsDataService>();
+            systemNotificationsService = A.Fake<ISystemNotificationsService>();
             searchSortFilterPaginateService = A.Fake<ISearchSortFilterPaginateService>();
             controller =
                 new SystemNotificationsController(
-                        systemNotificationsDataService,
+                        systemNotificationsService,
                         clockUtility,
                         searchSortFilterPaginateService
                     )
@@ -51,7 +50,7 @@ public void Index_sets_cookie_when_unacknowledged_notifications_exist()
             var testDate = new DateTime(2021, 8, 23);
             A.CallTo(() => clockUtility.UtcNow).Returns(testDate);
             var expectedExpiry = testDate.AddHours(24);
-            A.CallTo(() => systemNotificationsDataService.GetUnacknowledgedSystemNotifications(A<int>._))
+            A.CallTo(() => systemNotificationsService.GetUnacknowledgedSystemNotifications(A<int>._))
                 .Returns(new List<SystemNotification> { SystemNotificationTestHelper.GetDefaultSystemNotification() });
 
             // When
@@ -80,7 +79,7 @@ public void Post_acknowledges_notification_and_redirects()
             // Then
             using (new AssertionScope())
             {
-                A.CallTo(() => systemNotificationsDataService.AcknowledgeNotification(1, 7)).MustHaveHappened();
+                A.CallTo(() => systemNotificationsService.AcknowledgeNotification(1, 7)).MustHaveHappened();
                 result.Should().BeRedirectToActionResult().WithControllerName("SystemNotifications")
                     .WithActionName("Index");
             }
@@ -93,7 +92,7 @@ public void Index_deletes_cookie_if_one_exists_for_user_and_no_unacknowledged_no
             A.CallTo(() => httpRequest.Cookies).Returns(
                 ControllerContextHelper.SetUpFakeRequestCookieCollection(SystemNotificationCookieHelper.CookieName, "7")
             );
-            A.CallTo(() => systemNotificationsDataService.GetUnacknowledgedSystemNotifications(A<int>._))
+            A.CallTo(() => systemNotificationsService.GetUnacknowledgedSystemNotifications(A<int>._))
                 .Returns(new List<SystemNotification>());
 
             // When
@@ -110,7 +109,7 @@ public void Index_does_not_delete_cookie_if_one_exists_for_someone_other_than_cu
             A.CallTo(() => httpRequest.Cookies).Returns(
                 ControllerContextHelper.SetUpFakeRequestCookieCollection(SystemNotificationCookieHelper.CookieName, "8")
             );
-            A.CallTo(() => systemNotificationsDataService.GetUnacknowledgedSystemNotifications(A<int>._))
+            A.CallTo(() => systemNotificationsService.GetUnacknowledgedSystemNotifications(A<int>._))
                 .Returns(new List<SystemNotification>());
 
             // When
@@ -128,7 +127,7 @@ public void Index_does_not_delete_cookie_if_one_does_not_exist()
             A.CallTo(() => httpRequest.Cookies).Returns(
                 A.Fake<IRequestCookieCollection>()
             );
-            A.CallTo(() => systemNotificationsDataService.GetUnacknowledgedSystemNotifications(A<int>._))
+            A.CallTo(() => systemNotificationsService.GetUnacknowledgedSystemNotifications(A<int>._))
                 .Returns(new List<SystemNotification>());
 
             // When

DigitalLearningSolutions.Web/Controllers/TrackingSystem/Centre/SystemNotificationsController.cs

@@ -1,7 +1,6 @@
 namespace DigitalLearningSolutions.Web.Controllers.TrackingSystem.Centre
 {
     using System.Linq;
-    using DigitalLearningSolutions.Data.DataServices;
     using DigitalLearningSolutions.Data.Enums;
     using DigitalLearningSolutions.Data.Models.SearchSortFilterPaginate;
     using DigitalLearningSolutions.Data.Utilities;
@@ -23,15 +22,15 @@ public class SystemNotificationsController : Controller
     {
         private readonly IClockUtility clockUtility;
         private readonly ISearchSortFilterPaginateService searchSortFilterPaginateService;
-        private readonly ISystemNotificationsDataService systemNotificationsDataService;
+        private readonly ISystemNotificationsService systemNotificationsService;
 
         public SystemNotificationsController(
-            ISystemNotificationsDataService systemNotificationsDataService,
+            ISystemNotificationsService systemNotificationsService,
             IClockUtility clockUtility,
             ISearchSortFilterPaginateService searchSortFilterPaginateService
         )
         {
-            this.systemNotificationsDataService = systemNotificationsDataService;
+            this.systemNotificationsService = systemNotificationsService;
             this.clockUtility = clockUtility;
             this.searchSortFilterPaginateService = searchSortFilterPaginateService;
         }
@@ -42,7 +41,7 @@ public IActionResult Index(int page = 1)
         {
             var adminId = User.GetAdminId()!.Value;
             var unacknowledgedNotifications =
-                systemNotificationsDataService.GetUnacknowledgedSystemNotifications(adminId).ToList();
+                systemNotificationsService.GetUnacknowledgedSystemNotifications(adminId).ToList();
 
             if (unacknowledgedNotifications.Count > 0)
             {
@@ -74,7 +73,7 @@ public IActionResult Index(int page = 1)
         public IActionResult AcknowledgeNotification(int systemNotificationId, int page)
         {
             var adminId = User.GetAdminId()!.Value;
-            systemNotificationsDataService.AcknowledgeNotification(systemNotificationId, adminId);
+            systemNotificationsService.AcknowledgeNotification(systemNotificationId, adminId);
 
             return RedirectToAction("Index", "SystemNotifications", new { page });
         }

DigitalLearningSolutions.Web/Services/SystemNotificationsService.cs

@@ -0,0 +1,30 @@
+using DigitalLearningSolutions.Data.DataServices;
+using DigitalLearningSolutions.Data.Models;
+using System.Collections.Generic;
+
+namespace DigitalLearningSolutions.Web.Services
+{
+    public interface ISystemNotificationsService
+    {
+        public IEnumerable<SystemNotification> GetUnacknowledgedSystemNotifications(int adminId);
+
+        public void AcknowledgeNotification(int notificationId, int adminId);
+    }
+    public class SystemNotificationsService : ISystemNotificationsService
+    {
+        private readonly ISystemNotificationsDataService systemNotificationsDataService;
+        public SystemNotificationsService(ISystemNotificationsDataService systemNotificationsDataService)
+        {
+            this.systemNotificationsDataService = systemNotificationsDataService;
+        }
+        public void AcknowledgeNotification(int notificationId, int adminId)
+        {
+            systemNotificationsDataService.AcknowledgeNotification(notificationId, adminId);
+        }
+
+        public IEnumerable<SystemNotification> GetUnacknowledgedSystemNotifications(int adminId)
+        {
+            return systemNotificationsDataService.GetUnacknowledgedSystemNotifications(adminId);
+        }
+    }
+}

DigitalLearningSolutions.Web/Startup.cs

@@ -452,6 +452,7 @@ private static void RegisterServices(IServiceCollection services)
             services.AddScoped<IStoreAspService, StoreAspService>();
             services.AddScoped<ISupervisorDelegateService, SupervisorDelegateService>();
             services.AddScoped<ISupervisorService, SupervisorService>();
+            services.AddScoped<ISystemNotificationsService, SystemNotificationsService>();
             services.AddScoped<IDashboardInformationService, DashboardInformationService>();
             services.AddScoped<ITrackerService, TrackerService>();
             services.AddScoped<ITrackerActionService, TrackerActionService>();