Skip to content

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.

feat(arch001): add BaseOrderController skeleton with List region and LoadAuthorizedOrder helper

KrzysztofPajak845683456907
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderControllerTests.cs
new file mode 100644
index 000000000..64aaabcd8
--- /dev/null
+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderControllerTests.cs
@@ -0,0 +1,187 @@
+using Grand.Business.Core.Interfaces.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Business.Core.Interfaces.Common.Pdf;
+using Grand.Domain.Orders;
+using Grand.Infrastructure;
+using Grand.Web.AdminShared.Controllers;
+using Grand.Web.AdminShared.Interfaces;
+using Grand.Web.AdminShared.Models.Orders;
+using Grand.Web.Common.DataSource;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Routing;
+using Microsoft.AspNetCore.Mvc.ViewFeatures;
+using Microsoft.Extensions.Logging;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Moq;
+
+namespace Grand.Web.Admin.Tests.Controllers;
+
+[TestClass]
+public class BaseOrderControllerTests
+{
+ // BaseOrderController is abstract; minimal subclass so actions can be invoked directly.
+ private class TestOrderController(
+ IOrderViewModelService orderViewModelService,
+ IOrderService orderService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor,
+ IPdfService pdfService,
+ IAdminDataScope<Order> scope)
+ : BaseOrderController(orderViewModelService, orderService, translationService,
+ contextAccessor, pdfService, scope)
+ {
+ public Task<(Order order, IActionResult denied)> LoadAuthorizedOrderPublic(string id) =>
+ LoadAuthorizedOrder(id);
+ }
+
+ private TestOrderController _controller;
+ private Mock<IOrderService> _orderServiceMock;
+ private Mock<IOrderViewModelService> _orderViewModelServiceMock;
+ private Mock<IAdminDataScope<Order>> _scopeMock;
+
+ [TestInitialize]
+ public void Setup()
+ {
+ _orderServiceMock = new Mock<IOrderService>();
+ _orderViewModelServiceMock = new Mock<IOrderViewModelService>();
+ _scopeMock = new Mock<IAdminDataScope<Order>>();
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+
+ var translationServiceMock = new Mock<ITranslationService>();
+ translationServiceMock.Setup(t => t.GetResource(It.IsAny<string>())).Returns("resource");
+ var contextAccessorMock = new Mock<IContextAccessor>();
+
+ _controller = new TestOrderController(
+ _orderViewModelServiceMock.Object,
+ _orderServiceMock.Object,
+ translationServiceMock.Object,
+ contextAccessorMock.Object,
+ new Mock<IPdfService>().Object,
+ _scopeMock.Object);
+
+ var httpContext = new DefaultHttpContext();
+ var loggerFactoryMock = new Mock<ILoggerFactory>();
+ loggerFactoryMock.Setup(l => l.CreateLogger(It.IsAny<string>())).Returns(new Mock<ILogger>().Object);
+ var urlHelperFactoryMock = new Mock<IUrlHelperFactory>();
+ urlHelperFactoryMock.Setup(f => f.GetUrlHelper(It.IsAny<ActionContext>())).Returns(new Mock<IUrlHelper>().Object);
+ var requestServicesMock = new Mock<IServiceProvider>();
+ requestServicesMock.Setup(s => s.GetService(typeof(ILoggerFactory))).Returns(loggerFactoryMock.Object);
+ requestServicesMock.Setup(s => s.GetService(typeof(IUrlHelperFactory))).Returns(urlHelperFactoryMock.Object);
+ httpContext.RequestServices = requestServicesMock.Object;
+ _controller.ControllerContext = new ControllerContext { HttpContext = httpContext };
+ _controller.TempData = new TempDataDictionary(httpContext, new Mock<ITempDataProvider>().Object);
+ }
+
+ [TestMethod]
+ public async Task ListGet_CallsPrepareOrderListModel_WithScopeDefaultStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");
+ _orderViewModelServiceMock
+ .Setup(v => v.PrepareOrderListModel(null, null, null, null, "store-1", null))
+ .ReturnsAsync(new OrderListModel());
+
+ var result = await _controller.List();
+
+ Assert.IsInstanceOfType(result, typeof(ViewResult));
+ _orderViewModelServiceMock.Verify(v => v.PrepareOrderListModel(null, null, null, null, "store-1", null), Times.Once);
+ }
+
+ [TestMethod]
+ public async Task ListGet_GlobalScope_PassesEmptyStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+ _orderViewModelServiceMock
+ .Setup(v => v.PrepareOrderListModel(null, null, null, null, "", null))
+ .ReturnsAsync(new OrderListModel());
+
+ await _controller.List();
+
+ _orderViewModelServiceMock.Verify(v => v.PrepareOrderListModel(null, null, null, null, "", null), Times.Once);
+ }
+
+ [TestMethod]
+ public async Task ListPost_StoreScope_ForcesModelStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");
+ _orderViewModelServiceMock
+ .Setup(v => v.PrepareOrderModel(It.IsAny<OrderListModel>(), 1, 10))
+ .ReturnsAsync((Enumerable.Empty<OrderModel>(), 0));
+
+ var model = new OrderListModel { StoreId = "attacker-supplied" };
+ await _controller.OrderList(new DataSourceRequest { Page = 1, PageSize = 10 }, model);
+
+ Assert.AreEqual("store-1", model.StoreId);
+ }
+
+ [TestMethod]
+ public async Task ListPost_GlobalScope_LeavesSubmittedStoreIdUntouched()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+ _orderViewModelServiceMock
+ .Setup(v => v.PrepareOrderModel(It.IsAny<OrderListModel>(), 1, 10))
+ .ReturnsAsync((Enumerable.Empty<OrderModel>(), 0));
+
+ var model = new OrderListModel { StoreId = "admin-submitted" };
+ await _controller.OrderList(new DataSourceRequest { Page = 1, PageSize = 10 }, model);
+
+ Assert.AreEqual("admin-submitted", model.StoreId);
+ }
+
+ [TestMethod]
+ public async Task ListPost_VendorScope_ForcesModelVendorId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+ _scopeMock.Setup(s => s.DefaultVendorId).Returns("vendor-A");
+ _orderViewModelServiceMock
+ .Setup(v => v.PrepareOrderModel(It.IsAny<OrderListModel>(), 1, 10))
+ .ReturnsAsync((Enumerable.Empty<OrderModel>(), 0));
+
+ var model = new OrderListModel();
+ await _controller.OrderList(new DataSourceRequest { Page = 1, PageSize = 10 }, model);
+
+ Assert.AreEqual("vendor-A", model.VendorId);
+ }
+
+ [TestMethod]
+ public async Task LoadAuthorizedOrder_NotFound_ReturnsRedirectToList()
+ {
+ _orderServiceMock.Setup(s => s.GetOrderById("missing")).ReturnsAsync((Order)null);
+
+ var (order, denied) = await _controller.LoadAuthorizedOrderPublic("missing");
+
+ Assert.IsNull(order);
+ var redirect = denied as RedirectToActionResult;
+ Assert.IsNotNull(redirect);
+ Assert.AreEqual("List", redirect.ActionName);
+ _scopeMock.Verify(s => s.HasAccess(It.IsAny<Order>()), Times.Never);
+ }
+
+ [TestMethod]
+ public async Task LoadAuthorizedOrder_ScopeDenies_ReturnsRedirectToList()
+ {
+ var order = new Order { Id = "o1" };
+ _orderServiceMock.Setup(s => s.GetOrderById("o1")).ReturnsAsync(order);
+ _scopeMock.Setup(s => s.HasAccess(order)).ReturnsAsync(false);
+
+ var (resultOrder, denied) = await _controller.LoadAuthorizedOrderPublic("o1");
+
+ Assert.IsNull(resultOrder);
+ var redirect = denied as RedirectToActionResult;
+ Assert.IsNotNull(redirect);
+ Assert.AreEqual("List", redirect.ActionName);
+ }
+
+ [TestMethod]
+ public async Task LoadAuthorizedOrder_ScopeAllows_ReturnsOrderNoDenial()
+ {
+ var order = new Order { Id = "o1" };
+ _orderServiceMock.Setup(s => s.GetOrderById("o1")).ReturnsAsync(order);
+ _scopeMock.Setup(s => s.HasAccess(order)).ReturnsAsync(true);
+
+ var (resultOrder, denied) = await _controller.LoadAuthorizedOrderPublic("o1");
+
+ Assert.AreSame(order, resultOrder);
+ Assert.IsNull(denied);
+ }
+}
diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderController.cs
new file mode 100644
index 000000000..7e44505b0
--- /dev/null
+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderController.cs
@@ -0,0 +1,79 @@
+using Grand.Business.Core.Interfaces.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Business.Core.Interfaces.Common.Pdf;
+using Grand.Domain.Orders;
+using Grand.Domain.Permissions;
+using Grand.Infrastructure;
+using Grand.Web.AdminShared.Interfaces;
+using Grand.Web.AdminShared.Models.Orders;
+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;
+
+[PermissionAuthorize(PermissionSystemName.Orders)]
+[AutoValidateAntiforgeryToken]
+public abstract class BaseOrderController(
+ IOrderViewModelService orderViewModelService,
+ IOrderService orderService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor,
+ IPdfService pdfService,
+ IAdminDataScope<Order> scope)
+ : BaseController
+{
+ // Exposed for BaseOrderManagementController (primary-constructor parameters aren't visible to
+ // derived classes by name in C#).
+ protected IOrderViewModelService OrderViewModelService => orderViewModelService;
+ protected IOrderService OrderService => orderService;
+ protected ITranslationService TranslationService => translationService;
+ protected IContextAccessor ContextAccessor => contextAccessor;
+ protected IPdfService PdfService => pdfService;
+ protected IAdminDataScope<Order> Scope => scope;
+
+ /// <summary>DRY replacement for the ~20x-duplicated
+ /// "load order, redirect to List if not found or not authorized" pattern found identically in
+ /// both Admin's and Store's original controllers (every action in both files redirects to
+ /// "List", never "Edit", on either condition). Not a behavior change — every call site below
+ /// still individually returns RedirectToAction("List") exactly as both originals did.</summary>
+ protected async Task<(Order order, IActionResult denied)> LoadAuthorizedOrder(string id)
+ {
+ var order = await orderService.GetOrderById(id);
+ if (order == null) return (null, RedirectToAction("List"));
+ if (!await scope.HasAccess(order)) return (null, RedirectToAction("List"));
+ return (order, null);
+ }
+
+ #region Order list
+
+ public IActionResult Index() => RedirectToAction("List");
+
+ public async Task<IActionResult> List(int? orderStatusId = null, int? paymentStatusId = null,
+ int? shippingStatusId = null, DateTime? startDate = null, string code = null)
+ {
+ var model = await orderViewModelService.PrepareOrderListModel(orderStatusId, paymentStatusId,
+ shippingStatusId, startDate, scope.DefaultStoreId ?? "", code);
+ return View(model);
+ }
+
+ [PermissionAuthorizeAction(PermissionActionName.List)]
+ [HttpPost]
+ public async Task<IActionResult> OrderList(DataSourceRequest command, OrderListModel model)
+ {
+ if (scope.DefaultStoreId is not null) model.StoreId = scope.DefaultStoreId;
+ if (scope.DefaultVendorId is not null) model.VendorId = scope.DefaultVendorId;
+
+ var (orderModels, totalCount) =
+ await orderViewModelService.PrepareOrderModel(model, command.Page, command.PageSize);
+
+ var gridModel = new DataSourceResult {
+ Data = orderModels.ToList(),
+ Total = totalCount
+ };
+ return Json(gridModel);
+ }
+
+ #endregion
+}