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.

Migrate 'Required products' region into BaseProductController (ARCH-001 Phase 1)

KrzysztofPajaka8a057450675
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs
index 0ead37cff..0c55f8238 100644
--- a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs
+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs
@@ -433,4 +433,122 @@ public class BaseProductControllerTests
Assert.IsNotNull(model);
Assert.AreEqual("store-1", model.StoreId);
}
+
+ // --- LoadProductFriendlyNames --------------------------------------------------------------------
+ // Filters the display list rather than denying the whole request: matches Store's CanAccessProduct
+ // loop and Vendor's HasAccessToProduct loop, both of which skip inaccessible products silently.
+
+ [TestMethod]
+ public async Task LoadProductFriendlyNames_EmptyInput_ReturnsEmptyText()
+ {
+ var result = await _controller.LoadProductFriendlyNames("");
+
+ var json = result as JsonResult;
+ Assert.IsNotNull(json);
+ Assert.AreEqual("", GetTextProperty(json.Value));
+ _productServiceMock.Verify(s => s.GetProductsByIds(It.IsAny<string[]>(), It.IsAny<bool>()), Times.Never);
+ }
+
+ [TestMethod]
+ public async Task LoadProductFriendlyNames_ScopeDeniesAccess_SkipsProduct()
+ {
+ var allowed = new Product { Id = "p1", Name = "Allowed" };
+ var denied = new Product { Id = "p2", Name = "Denied" };
+ _productServiceMock.Setup(p => p.GetProductsByIds(new[] { "p1", "p2" }, true))
+ .ReturnsAsync(new List<Product> { allowed, denied });
+ _scopeMock.Setup(s => s.HasAccess(allowed)).ReturnsAsync(true);
+ _scopeMock.Setup(s => s.HasAccess(denied)).ReturnsAsync(false);
+
+ var result = await _controller.LoadProductFriendlyNames("p1,p2");
+
+ var json = result as JsonResult;
+ Assert.IsNotNull(json);
+ // Faithful port of Store/Vendor's original index-based comma logic: it decides whether to
+ // append ", " from the loop index (i != products.Count - 1), not from whether a name was
+ // actually appended, so skipping the last product still leaves a trailing ", ". Pre-existing
+ // quirk in both original hosts, not introduced by this migration - characterized, not fixed.
+ Assert.AreEqual("Allowed, ", GetTextProperty(json.Value));
+ }
+
+ [TestMethod]
+ public async Task LoadProductFriendlyNames_ScopeGrantsAccess_IncludesAllProducts()
+ {
+ var p1 = new Product { Id = "p1", Name = "First" };
+ var p2 = new Product { Id = "p2", Name = "Second" };
+ _productServiceMock.Setup(p => p.GetProductsByIds(new[] { "p1", "p2" }, true))
+ .ReturnsAsync(new List<Product> { p1, p2 });
+ _scopeMock.Setup(s => s.HasAccess(It.IsAny<Product>())).ReturnsAsync(true);
+
+ var result = await _controller.LoadProductFriendlyNames("p1,p2");
+
+ var json = result as JsonResult;
+ Assert.IsNotNull(json);
+ Assert.AreEqual("First, Second", GetTextProperty(json.Value));
+ }
+
+ private static string GetTextProperty(object value) =>
+ (string)value.GetType().GetProperty("Text")!.GetValue(value);
+
+ // --- RequiredProductAddPopup ----------------------------------------------------------------------
+
+ [TestMethod]
+ public async Task RequiredProductAddPopup_UsesScopeDefaultStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");
+ _productViewModelServiceMock.Setup(s => s.PrepareAddRequiredProductModel("store-1"))
+ .ReturnsAsync(new ProductModel.AddRequiredProductModel());
+
+ var result = await _controller.RequiredProductAddPopup("input1") as ViewResult;
+
+ Assert.IsNotNull(result);
+ _productViewModelServiceMock.Verify(s => s.PrepareAddRequiredProductModel("store-1"), Times.Once);
+ Assert.AreEqual("input1", _controller.ViewBag.productIdsInput);
+ }
+
+ [TestMethod]
+ public async Task RequiredProductAddPopup_NoDefaultStoreId_PassesEmptyString()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+ _productViewModelServiceMock.Setup(s => s.PrepareAddRequiredProductModel(""))
+ .ReturnsAsync(new ProductModel.AddRequiredProductModel());
+
+ var result = await _controller.RequiredProductAddPopup("input1") as ViewResult;
+
+ Assert.IsNotNull(result);
+ _productViewModelServiceMock.Verify(s => s.PrepareAddRequiredProductModel(""), Times.Once);
+ }
+
+ // --- RequiredProductAddPopupList -------------------------------------------------------------------
+
+ [TestMethod]
+ public async Task RequiredProductAddPopupList_UsesScopeDefaultStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");
+ _productViewModelServiceMock
+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddRequiredProductModel>(), 0, 10))
+ .ReturnsAsync((new List<ProductModel>(), 0));
+
+ var model = new ProductModel.AddRequiredProductModel();
+ var result = await _controller.RequiredProductAddPopupList(
+ new Grand.Web.Common.DataSource.DataSourceRequest { Page = 0, PageSize = 10 }, model);
+
+ Assert.IsInstanceOfType<JsonResult>(result);
+ Assert.AreEqual("store-1", model.SearchStoreId);
+ }
+
+ [TestMethod]
+ public async Task RequiredProductAddPopupList_NoDefaultStoreId_DoesNotOverrideModelSearchStoreId()
+ {
+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);
+ _productViewModelServiceMock
+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddRequiredProductModel>(), 0, 10))
+ .ReturnsAsync((new List<ProductModel>(), 0));
+
+ var model = new ProductModel.AddRequiredProductModel { SearchStoreId = "explicit" };
+ var result = await _controller.RequiredProductAddPopupList(
+ new Grand.Web.Common.DataSource.DataSourceRequest { Page = 0, PageSize = 10 }, model);
+
+ Assert.IsInstanceOfType<JsonResult>(result);
+ Assert.AreEqual("explicit", model.SearchStoreId);
+ }
}
diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs
index 4f1ba75a4..655c5966f 100644
--- a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs
+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs
@@ -322,4 +322,70 @@ public abstract class BaseProductController(
}
#endregion
+
+ #region Required products
+
+ [PermissionAuthorizeAction(PermissionActionName.Edit)]
+ [HttpPost]
+ public async Task<IActionResult> LoadProductFriendlyNames(string productIds)
+ {
+ var result = "";
+
+ if (!string.IsNullOrWhiteSpace(productIds))
+ {
+ var ids = productIds
+ .Split([','], StringSplitOptions.RemoveEmptyEntries)
+ .Select(x => x.Trim())
+ .ToList();
+
+ var products = await productService.GetProductsByIds(ids.ToArray(), true);
+ for (var i = 0; i <= products.Count - 1; i++)
+ {
+ // Filters the friendly-name list, not a hard deny of the whole action: matches Store's
+ // CanAccessProduct loop and Vendor's HasAccessToProduct loop, both of which skip
+ // inaccessible products silently rather than erroring the whole request. Both are the
+ // strict rule (AccessToEntityByStore / VendorId equality), so HasAccess (not CanView) is
+ // correct here - this is filtering a display list, not opening/copying a single entity.
+ if (!await scope.HasAccess(products[i])) continue;
+
+ result += products[i].Name;
+ if (i != products.Count - 1)
+ result += ", ";
+ }
+ }
+
+ return Json(new { Text = result });
+ }
+
+ [PermissionAuthorizeAction(PermissionActionName.Edit)]
+ public async Task<IActionResult> RequiredProductAddPopup(string productIdsInput)
+ {
+ // scope.DefaultStoreId already encodes the per-host default exactly: null for Admin (global) and
+ // Vendor (not store-scoped), StaffStoreId for Store - matching Store's original
+ // PrepareAddRequiredProductModel(StaffStoreId) call and Admin/Vendor's parameterless call.
+ var model = await productViewModelService.PrepareAddRequiredProductModel(scope.DefaultStoreId ?? "");
+ // Unused by any of the three views (all three read productIdsInput straight off the query string
+ // via Context.Request.Query, not ViewBag), but Admin and Vendor both set it and Store silently
+ // drops its own parameter - kept here for parity; it is inert either way.
+ ViewBag.productIdsInput = productIdsInput;
+ return View(model);
+ }
+
+ [PermissionAuthorizeAction(PermissionActionName.Edit)]
+ [HttpPost]
+ public async Task<IActionResult> RequiredProductAddPopupList(DataSourceRequest command,
+ ProductModel.AddRequiredProductModel model)
+ {
+ if (scope.DefaultStoreId is not null) model.SearchStoreId = scope.DefaultStoreId;
+
+ var (products, totalCount) =
+ await productViewModelService.PrepareProductModel(model, command.Page, command.PageSize);
+ var gridModel = new DataSourceResult {
+ Data = products.ToList(),
+ Total = totalCount
+ };
+ return Json(gridModel);
+ }
+
+ #endregion
}