Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.
C# aspnet-corecsharpdockerdotnetecommerceecommerce-platformmongodbmulti-storemulti-vendornosqlonline-shopshoppingcart
ARCH-001 Phase 26: consolidate Admin/Store OnlineCustomerController into BaseOnlineCustomerController (#827)
Krzysztof Pajak9ec800399db3
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOnlineCustomerControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOnlineCustomerControllerTests.csnew file mode 100644index 000000000..daab348d2--- /dev/null+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOnlineCustomerControllerTests.cs@@ -0,0 +1,144 @@+using Grand.Business.Core.Interfaces.Common.Directory;+using Grand.Business.Core.Interfaces.Common.Localization;+using Grand.Business.Core.Interfaces.Customers;+using Grand.Domain;+using Grand.Domain.Customers;+using Grand.Infrastructure;+using Grand.Web.AdminShared.Controllers;+using Grand.Web.AdminShared.Models.Customers;+using Grand.Web.Common.DataSource;+using Microsoft.AspNetCore.Mvc;+using Microsoft.VisualStudio.TestTools.UnitTesting;+using Moq;++namespace Grand.Web.Admin.Tests.Controllers;++[TestClass]+public class BaseOnlineCustomerControllerTests+{+ // Concrete subclass exists only to instantiate the abstract base for direct-call unit tests -+ // same pattern as BaseTaxCategoryControllerTests/BaseEmailAccountControllerTests. Exposes the+ // protected SalesEmployeeIdFilter as a settable property so both the default (Store-shaped) and+ // overridden (Admin-shaped) branches can be exercised from one test class.+ private class TestOnlineCustomerController(+ ICustomerService customerService,+ IDateTimeService dateTimeService,+ CustomerSettings customerSettings,+ ITranslationService translationService,+ IContextAccessor contextAccessor)+ : BaseOnlineCustomerController(customerService, dateTimeService, customerSettings, translationService, contextAccessor)+ {+ public string SalesEmployeeIdFilterOverride { get; set; }+ protected override string SalesEmployeeIdFilter => SalesEmployeeIdFilterOverride;+ }++ private Mock<ICustomerService> _customerServiceMock = null!;+ private Mock<IDateTimeService> _dateTimeServiceMock = null!;+ private Mock<ITranslationService> _translationServiceMock = null!;+ private Mock<IContextAccessor> _contextAccessorMock = null!;+ private CustomerSettings _customerSettings = null!;++ [TestInitialize]+ public void Setup()+ {+ _customerServiceMock = new Mock<ICustomerService>();+ _dateTimeServiceMock = new Mock<IDateTimeService>();+ _dateTimeServiceMock+ .Setup(d => d.ConvertToUserTime(It.IsAny<DateTime>(), It.IsAny<DateTimeKind>()))+ .Returns((DateTime dt, DateTimeKind _) => dt);+ _translationServiceMock = new Mock<ITranslationService>();+ _translationServiceMock.Setup(t => t.GetResource(It.IsAny<string>())).Returns((string s) => s);+ _customerSettings = new CustomerSettings { OnlineCustomerMinutes = 20, StoreLastVisitedPage = true };++ _contextAccessorMock = new Mock<IContextAccessor>();+ var workContext = new Mock<IWorkContext>();+ workContext.Setup(w => w.CurrentCustomer).Returns(new Customer { StaffStoreId = "store-1", SeId = "se-1" });+ _contextAccessorMock.Setup(c => c.WorkContext).Returns(workContext.Object);+ }++ private TestOnlineCustomerController CreateController(string salesEmployeeIdFilter = null)+ {+ return new TestOnlineCustomerController(+ _customerServiceMock.Object,+ _dateTimeServiceMock.Object,+ _customerSettings,+ _translationServiceMock.Object,+ _contextAccessorMock.Object) { SalesEmployeeIdFilterOverride = salesEmployeeIdFilter };+ }++ [TestMethod]+ public async Task List_DefaultFilter_PassesNullSalesEmployeeId()+ {+ _customerServiceMock+ .Setup(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", null, 0, 10))+ .ReturnsAsync(new PagedList<Customer>());+ var controller = CreateController();++ var result = await controller.List(new DataSourceRequest { Page = 1, PageSize = 10 });++ var json = (JsonResult)result;+ var gridModel = (DataSourceResult)json.Value!;+ Assert.AreEqual(0, gridModel.Total);+ _customerServiceMock.Verify(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", null, 0, 10), Times.Once);+ }++ [TestMethod]+ public async Task List_OverriddenFilter_PassesSalesEmployeeId()+ {+ _customerServiceMock+ .Setup(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", "se-1", 0, 10))+ .ReturnsAsync(new PagedList<Customer>());+ var controller = CreateController("se-1");++ await controller.List(new DataSourceRequest { Page = 1, PageSize = 10 });++ _customerServiceMock.Verify(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", "se-1", 0, 10), Times.Once);+ }++ [TestMethod]+ public async Task List_MapsCustomersToModel_WithGuestFallbackAndLastVisitedPage()+ {+ var customers = new PagedList<Customer> {+ new() {+ Id = "c1", Email = "[email protected]", LastIpAddress = "127.0.0.1",+ LastActivityDateUtc = new DateTime(2026, 1, 1), LastVisitedPage = "/home"+ },+ new() {+ Id = "c2", Email = "", LastIpAddress = "127.0.0.2",+ LastActivityDateUtc = new DateTime(2026, 1, 2), LastVisitedPage = "/cart"+ }+ };+ _customerServiceMock+ .Setup(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", null, 0, 10))+ .ReturnsAsync(customers);+ var controller = CreateController();++ var result = await controller.List(new DataSourceRequest { Page = 1, PageSize = 10 });++ var gridModel = (DataSourceResult)((JsonResult)result).Value!;+ var items = (List<OnlineCustomerModel>)gridModel.Data;+ Assert.AreEqual(2, items.Count);+ Assert.AreEqual("[email protected]", items[0].CustomerInfo);+ Assert.AreEqual("Admin.Customers.Guest", items[1].CustomerInfo);+ Assert.AreEqual("/home", items[0].LastVisitedPage);+ }++ [TestMethod]+ public async Task List_StoreLastVisitedPageDisabled_ReturnsDisabledResource()+ {+ _customerSettings.StoreLastVisitedPage = false;+ var customers = new PagedList<Customer> {+ new() { Id = "c1", Email = "[email protected]", LastVisitedPage = "/home" }+ };+ _customerServiceMock+ .Setup(s => s.GetOnlineCustomers(It.IsAny<DateTime>(), null, "store-1", null, 0, 10))+ .ReturnsAsync(customers);+ var controller = CreateController();++ var result = await controller.List(new DataSourceRequest { Page = 1, PageSize = 10 });++ var gridModel = (DataSourceResult)((JsonResult)result).Value!;+ var items = (List<OnlineCustomerModel>)gridModel.Data;+ Assert.AreEqual("Admin.Dashboards.OnlineCustomers.Fields.LastVisitedPage.Disabled", items[0].LastVisitedPage);+ }+}diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/OnlineCustomerControllerAttributeTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/OnlineCustomerControllerAttributeTests.csnew file mode 100644index 000000000..8a4bf14f2--- /dev/null+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/OnlineCustomerControllerAttributeTests.cs@@ -0,0 +1,50 @@+using System.Linq;+using Grand.Web.Admin.Controllers;+using Grand.Web.AdminShared.Controllers;+using Grand.Web.Common.Filters;+using Microsoft.AspNetCore.Mvc;+using Microsoft.VisualStudio.TestTools.UnitTesting;++namespace Grand.Web.Admin.Tests.Controllers;++[TestClass]+public class OnlineCustomerControllerAttributeTests+{+ [TestMethod]+ public void IsSubclassOfBaseOnlineCustomerController()+ {+ Assert.IsTrue(typeof(BaseOnlineCustomerController).IsAssignableFrom(typeof(OnlineCustomerController)));+ Assert.AreEqual(typeof(BaseOnlineCustomerController), typeof(OnlineCustomerController).BaseType);+ }++ [TestMethod]+ public void HasAuthorizeAdminAttribute()+ {+ var attr = typeof(OnlineCustomerController).GetCustomAttributes(typeof(AuthorizeAdminAttribute), inherit: false);+ Assert.AreEqual(1, attr.Length);+ }++ [TestMethod]+ public void HasAreaAdminAttribute()+ {+ var attr = typeof(OnlineCustomerController)+ .GetCustomAttributes(typeof(AreaAttribute), inherit: false)+ .Cast<AreaAttribute>().Single();+ Assert.AreEqual("Admin", attr.RouteValue);+ }++ [TestMethod]+ public void HasAutoValidateAntiforgeryTokenAttribute()+ {+ var attr = typeof(OnlineCustomerController)+ .GetCustomAttributes(typeof(AutoValidateAntiforgeryTokenAttribute), inherit: true);+ Assert.AreEqual(1, attr.Length);+ }++ [TestMethod]+ public void HasAuthorizeMenuAttribute()+ {+ var attr = typeof(OnlineCustomerController).GetCustomAttributes(typeof(AuthorizeMenuAttribute), inherit: false);+ Assert.AreEqual(1, attr.Length);+ }+}diff --git a/src/Tests/Grand.Web.Store.Tests/Controllers/OnlineCustomerControllerAttributeTests.cs b/src/Tests/Grand.Web.Store.Tests/Controllers/OnlineCustomerControllerAttributeTests.csnew file mode 100644index 000000000..5ec6d7fc0--- /dev/null+++ b/src/Tests/Grand.Web.Store.Tests/Controllers/OnlineCustomerControllerAttributeTests.cs@@ -0,0 +1,50 @@+using System.Linq;+using Grand.Web.AdminShared.Controllers;+using Grand.Web.Common.Filters;+using Grand.Web.Store.Controllers;+using Microsoft.AspNetCore.Mvc;+using Microsoft.VisualStudio.TestTools.UnitTesting;++namespace Grand.Web.Store.Tests.Controllers;++[TestClass]+public class OnlineCustomerControllerAttributeTests+{+ [TestMethod]+ public void IsSubclassOfBaseOnlineCustomerController()+ {+ Assert.IsTrue(typeof(BaseOnlineCustomerController).IsAssignableFrom(typeof(OnlineCustomerController)));+ Assert.AreEqual(typeof(BaseOnlineCustomerController), typeof(OnlineCustomerController).BaseType);+ }++ [TestMethod]+ public void HasAuthorizeStoreAttribute()+ {+ var attr = typeof(OnlineCustomerController).GetCustomAttributes(typeof(AuthorizeStoreAttribute), inherit: false);+ Assert.AreEqual(1, attr.Length);+ }++ [TestMethod]+ public void HasAreaStoreAttribute()+ {+ var attr = typeof(OnlineCustomerController)+ .GetCustomAttributes(typeof(AreaAttribute), inherit: false)+ .Cast<AreaAttribute>().Single();+ Assert.AreEqual("Store", attr.RouteValue);+ }++ [TestMethod]+ public void HasAutoValidateAntiforgeryTokenAttribute()+ {+ var attr = typeof(OnlineCustomerController)+ .GetCustomAttributes(typeof(AutoValidateAntiforgeryTokenAttribute), inherit: true);+ Assert.AreEqual(1, attr.Length);+ }++ [TestMethod]+ public void HasAuthorizeMenuAttribute()+ {+ var attr = typeof(OnlineCustomerController).GetCustomAttributes(typeof(AuthorizeMenuAttribute), inherit: false);+ Assert.AreEqual(1, attr.Length);+ }+}diff --git a/src/Web/Grand.Web.Admin/Controllers/OnlineCustomerController.cs b/src/Web/Grand.Web.Admin/Controllers/OnlineCustomerController.csindex 64c52d59e..eee339356 100644--- a/src/Web/Grand.Web.Admin/Controllers/OnlineCustomerController.cs+++ b/src/Web/Grand.Web.Admin/Controllers/OnlineCustomerController.cs@@ -1,81 +1,32 @@-using Grand.Business.Core.Interfaces.Common.Directory;+using Grand.Business.Core.Interfaces.Common.Directory;using Grand.Business.Core.Interfaces.Common.Localization;using Grand.Business.Core.Interfaces.Customers;-using Grand.Domain.Permissions;using Grand.Domain.Customers;using Grand.Infrastructure;-using Grand.Web.AdminShared.Models.Customers;-using Grand.Web.Common.DataSource;-using Grand.Web.Common.Security.Authorization;+using Grand.Web.Admin.Extensions;+using Grand.Web.AdminShared.Controllers;+using Grand.Web.Common.Filters;using Microsoft.AspNetCore.Mvc;namespace Grand.Web.Admin.Controllers;-[PermissionAuthorize(PermissionSystemName.Customers)]-public class OnlineCustomerController : BaseAdminController+// Reduced to a thin subclass of BaseOnlineCustomerController (ARCH-001). List (GET+POST) lives in the+// shared base; this class only supplies Admin's DI wiring plus the attributes that used to arrive+// transitively via BaseAdminController - BaseOnlineCustomerController can't inherit any single host's+// base controller (it's shared across Admin/Store), so each subclass restates its own host's+// attribute set explicitly. Admin also overrides SalesEmployeeIdFilter to restrict the online-customer+// list to the current Sales-Manager's own customers - Store has no such concept.+[AuthorizeAdmin]+[AutoValidateAntiforgeryToken]+[Area(Constants.AreaAdmin)]+[AuthorizeMenu]+public class OnlineCustomerController(+ ICustomerService customerService,+ IDateTimeService dateTimeService,+ CustomerSettings customerSettings,+ ITranslationService translationService,+ IContextAccessor contextAccessor)+ : BaseOnlineCustomerController(customerService, dateTimeService, customerSettings, translationService, contextAccessor){- #region Constructors-- public OnlineCustomerController(ICustomerService customerService,- IDateTimeService dateTimeService,- CustomerSettings customerSettings,- ITranslationService translationService,- IContextAccessor contextAccessor)- {- _customerService = customerService;- _dateTimeService = dateTimeService;- _customerSettings = customerSettings;- _translationService = translationService;- _contextAccessor = contextAccessor;- }-- #endregion-- #region Fields-- private readonly ICustomerService _customerService;- private readonly IDateTimeService _dateTimeService;- private readonly CustomerSettings _customerSettings;- private readonly ITranslationService _translationService;- private readonly IContextAccessor _contextAccessor;-- #endregion-- #region Methods-- public IActionResult List()- {- return View();- }-- [HttpPost]- [PermissionAuthorizeAction(PermissionActionName.List)]- public async Task<IActionResult> List(DataSourceRequest command)- {- var customers = await _customerService.GetOnlineCustomers(- DateTime.UtcNow.AddMinutes(-_customerSettings.OnlineCustomerMinutes),- null, _contextAccessor.WorkContext.CurrentCustomer.StaffStoreId, _contextAccessor.WorkContext.CurrentCustomer.SeId, command.Page - 1,- command.PageSize);- var items = new List<OnlineCustomerModel>();- foreach (var x in customers)- {- var item = new OnlineCustomerModel {- Id = x.Id,- CustomerInfo = !string.IsNullOrEmpty(x.Email) ? x.Email : _translationService.GetResource("Admin.Customers.Guest"),- LastIpAddress = x.LastIpAddress,- LastActivityDate = _dateTimeService.ConvertToUserTime(x.LastActivityDateUtc, DateTimeKind.Utc),- LastVisitedPage = _customerSettings.StoreLastVisitedPage ? x.LastVisitedPage : _translationService.GetResource("Admin.Dashboards.OnlineCustomers.Fields.LastVisitedPage.Disabled")- };- items.Add(item);- }-- var gridModel = new DataSourceResult {- Data = items,- Total = customers.TotalCount- };-- return Json(gridModel);- }-- #endregion-}\ No newline at end of file+ protected override string SalesEmployeeIdFilter => contextAccessor.WorkContext.CurrentCustomer.SeId;+}diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseOnlineCustomerController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseOnlineCustomerController.csnew file mode 100644index 000000000..0ac9b553c--- /dev/null+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseOnlineCustomerController.cs@@ -0,0 +1,66 @@+using Grand.Business.Core.Interfaces.Common.Directory;+using Grand.Business.Core.Interfaces.Common.Localization;+using Grand.Business.Core.Interfaces.Customers;+using Grand.Domain.Customers;+using Grand.Domain.Permissions;+using Grand.Infrastructure;+using Grand.Web.AdminShared.Models.Customers;+using Grand.Web.Common.Controllers;+using Grand.Web.Common.DataSource;+using Grand.Web.Common.Security.Authorization;+using Microsoft.AspNetCore.Mvc;++namespace Grand.Web.AdminShared.Controllers;++// ARCH-001: Admin's and Store's original OnlineCustomerController were near-identical - no entity,+// no per-store/per-vendor scope beyond the StaffStoreId filter both hosts already applied+// identically, so no IAdminDataScope is needed here (same shape as BasePictureController). The one+// real difference is Admin's Sales-Manager restriction (GetOnlineCustomers' salesEmployeeId filter);+// Store has no such concept and always passes null. Parameterized with a protected virtual member,+// the same idiom this repo's pre-existing BaseLoginController already uses for its own+// host-specific GetCurrentArea() value. Vendor never had its own copy.+[PermissionAuthorize(PermissionSystemName.Customers)]+[AutoValidateAntiforgeryToken]+public abstract class BaseOnlineCustomerController(+ ICustomerService customerService,+ IDateTimeService dateTimeService,+ CustomerSettings customerSettings,+ ITranslationService translationService,+ IContextAccessor contextAccessor)+ : BaseController+{+ /// <summary>+ /// Sales-Manager restriction on the online-customers list. Admin restricts to the current+ /// Sales-Manager's own customers; Store has no such concept and never restricts by it.+ /// </summary>+ protected virtual string SalesEmployeeIdFilter => null;++ public IActionResult List()+ {+ return View();+ }++ [HttpPost]+ [PermissionAuthorizeAction(PermissionActionName.List)]+ public virtual async Task<IActionResult> List(DataSourceRequest command)+ {+ var customers = await customerService.GetOnlineCustomers(+ DateTime.UtcNow.AddMinutes(-customerSettings.OnlineCustomerMinutes),+ null, contextAccessor.WorkContext.CurrentCustomer.StaffStoreId, SalesEmployeeIdFilter, command.Page - 1,+ command.PageSize);+ var items = customers.Select(x => new OnlineCustomerModel {+ Id = x.Id,+ CustomerInfo = !string.IsNullOrEmpty(x.Email) ? x.Email : translationService.GetResource("Admin.Customers.Guest"),+ LastIpAddress = x.LastIpAddress,+ LastActivityDate = dateTimeService.ConvertToUserTime(x.LastActivityDateUtc, DateTimeKind.Utc),+ LastVisitedPage = customerSettings.StoreLastVisitedPage ? x.LastVisitedPage : translationService.GetResource("Admin.Dashboards.OnlineCustomers.Fields.LastVisitedPage.Disabled")+ }).ToList();++ var gridModel = new DataSourceResult {+ Data = items,+ Total = customers.TotalCount+ };++ return Json(gridModel);+ }+}diff --git a/src/Web/Grand.Web.Store/Controllers/OnlineCustomerController.cs b/src/Web/Grand.Web.Store/Controllers/OnlineCustomerController.csindex 68901307b..bbec3421a 100644--- a/src/Web/Grand.Web.Store/Controllers/OnlineCustomerController.cs+++ b/src/Web/Grand.Web.Store/Controllers/OnlineCustomerController.cs@@ -1,80 +1,34 @@using Grand.Business.Core.Interfaces.Common.Directory;using Grand.Business.Core.Interfaces.Common.Localization;using Grand.Business.Core.Interfaces.Customers;-using Grand.Domain.Permissions;using Grand.Domain.Customers;using Grand.Infrastructure;-using Grand.Web.AdminShared.Models.Customers;-using Grand.Web.Common.DataSource;-using Grand.Web.Common.Security.Authorization;+using Grand.Web.AdminShared.Controllers;+using Grand.Web.Common.Filters;+using Grand.Web.Store.Extensions;using Microsoft.AspNetCore.Mvc;-using System.Linq;namespace Grand.Web.Store.Controllers;/// <summary>/// Lets a store manager see the customers of his own store who are currently online./// </summary>-[PermissionAuthorize(PermissionSystemName.Customers)]-public class OnlineCustomerController : BaseStoreController+// Reduced to a thin subclass of BaseOnlineCustomerController (ARCH-001). List (GET+POST) lives in the+// shared base; this class only supplies Store's DI wiring plus the attributes that used to arrive+// transitively via BaseStoreController - BaseOnlineCustomerController can't inherit any single host's+// base controller (it's shared across Admin/Store), so each subclass restates its own host's+// attribute set explicitly. Store has no Sales-Manager concept, so it keeps the base's default+// (unrestricted) SalesEmployeeIdFilter.+[AutoValidateAntiforgeryToken]+[Area(Constants.AreaStore)]+[AuthorizeStore]+[AuthorizeMenu]+public class OnlineCustomerController(+ ICustomerService customerService,+ IDateTimeService dateTimeService,+ CustomerSettings customerSettings,+ ITranslationService translationService,+ IContextAccessor contextAccessor)+ : BaseOnlineCustomerController(customerService, dateTimeService, customerSettings, translationService, contextAccessor){- #region Constructors-- public OnlineCustomerController(ICustomerService customerService,- IDateTimeService dateTimeService,- CustomerSettings customerSettings,- ITranslationService translationService,- IContextAccessor contextAccessor)- {- _customerService = customerService;- _dateTimeService = dateTimeService;- _customerSettings = customerSettings;- _translationService = translationService;- _contextAccessor = contextAccessor;- }-- #endregion-- #region Fields-- private readonly ICustomerService _customerService;- private readonly IDateTimeService _dateTimeService;- private readonly CustomerSettings _customerSettings;- private readonly ITranslationService _translationService;- private readonly IContextAccessor _contextAccessor;-- #endregion-- #region Methods-- public IActionResult List()- {- return View();- }-- [HttpPost]- [PermissionAuthorizeAction(PermissionActionName.List)]- public async Task<IActionResult> List(DataSourceRequest command)- {- var customers = await _customerService.GetOnlineCustomers(- DateTime.UtcNow.AddMinutes(-_customerSettings.OnlineCustomerMinutes),- null, _contextAccessor.WorkContext.CurrentCustomer.StaffStoreId, null, command.Page - 1,- command.PageSize);- var items = customers.Select(x => new OnlineCustomerModel {- Id = x.Id,- CustomerInfo = !string.IsNullOrEmpty(x.Email) ? x.Email : _translationService.GetResource("Admin.Customers.Guest"),- LastIpAddress = x.LastIpAddress,- LastActivityDate = _dateTimeService.ConvertToUserTime(x.LastActivityDateUtc, DateTimeKind.Utc),- LastVisitedPage = _customerSettings.StoreLastVisitedPage ? x.LastVisitedPage : _translationService.GetResource("Admin.Dashboards.OnlineCustomers.Fields.LastVisitedPage.Disabled")- }).ToList();-- var gridModel = new DataSourceResult {- Data = items,- Total = customers.TotalCount- };-- return Json(gridModel);- }-- #endregion}