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
Migrate 'Similar products' region into BaseProductController (ARCH-001 Phase 1)
KrzysztofPajaka13edc351f99
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.csindex c9cac27c7..bf3cc798b 100644--- a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs@@ -1069,4 +1069,221 @@ public class BaseProductControllerTestsAssert.AreSame(reprepared, view.Model);_productViewModelServiceMock.Verify(s => s.InsertRelatedProductModel(It.IsAny<ProductModel.AddRelatedProductModel>()), Times.Never);}++ // --- SimilarProductList ------------------------------------------------------------------------+ // HasAccess (strict), not CanView: same shape as RelatedProductList above.++ [TestMethod]+ public async Task SimilarProductList_ScopeDeniesAccess_ReturnsErrorJson()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(false);++ var result = await _controller.SimilarProductList(new Grand.Web.Common.DataSource.DataSourceRequest(), "p1");++ Assert.IsInstanceOfType<JsonResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ }++ [TestMethod]+ public async Task SimilarProductList_ScopeGrantsAccess_ReturnsGrid()+ {+ var product = new Product { Id = "p1" };+ product.SimilarProducts.Add(new SimilarProduct { Id = "r1", ProductId2 = "p2", DisplayOrder = 0 });+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _productServiceMock.Setup(p => p.GetProductById("p2", false)).ReturnsAsync(new Product { Id = "p2", Name = "Second" });+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);++ var result = await _controller.SimilarProductList(new Grand.Web.Common.DataSource.DataSourceRequest(), "p1");++ var json = result as JsonResult;+ Assert.IsNotNull(json);+ var gridModel = json.Value as Grand.Web.Common.DataSource.DataSourceResult;+ Assert.IsNotNull(gridModel);+ Assert.AreEqual(1, gridModel.Total);+ }++ // --- SimilarProductUpdate ----------------------------------------------------------------------++ [TestMethod]+ public async Task SimilarProductUpdate_ScopeDeniesAccess_ReturnsErrorJson_DoesNotUpdate()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(false);+ var model = new ProductModel.SimilarProductModel { ProductId1 = "p1" };++ var result = await _controller.SimilarProductUpdate(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ _productViewModelServiceMock.Verify(s => s.UpdateSimilarProductModel(It.IsAny<ProductModel.SimilarProductModel>()), Times.Never);+ }++ [TestMethod]+ public async Task SimilarProductUpdate_ScopeGrantsAccess_ValidModel_Updates()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);+ var model = new ProductModel.SimilarProductModel { ProductId1 = "p1" };++ var result = await _controller.SimilarProductUpdate(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _productViewModelServiceMock.Verify(s => s.UpdateSimilarProductModel(model), Times.Once);+ }++ // --- SimilarProductDelete ----------------------------------------------------------------------++ [TestMethod]+ public async Task SimilarProductDelete_ScopeDeniesAccess_ReturnsErrorJson_DoesNotDelete()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(false);+ var model = new ProductModel.SimilarProductModel { ProductId1 = "p1" };++ var result = await _controller.SimilarProductDelete(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ _productViewModelServiceMock.Verify(s => s.DeleteSimilarProductModel(It.IsAny<ProductModel.SimilarProductModel>()), Times.Never);+ }++ [TestMethod]+ public async Task SimilarProductDelete_ScopeGrantsAccess_ValidModel_Deletes()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);+ var model = new ProductModel.SimilarProductModel { ProductId1 = "p1" };++ var result = await _controller.SimilarProductDelete(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _productViewModelServiceMock.Verify(s => s.DeleteSimilarProductModel(model), Times.Once);+ }++ // --- SimilarProductAddPopup (GET) --------------------------------------------------------------++ [TestMethod]+ public async Task SimilarProductAddPopupGet_UsesScopeDefaultStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");+ _productViewModelServiceMock.Setup(s => s.PrepareSimilarProductModel("store-1"))+ .ReturnsAsync(new ProductModel.AddSimilarProductModel());++ var result = await _controller.SimilarProductAddPopup("p1") as ViewResult;++ Assert.IsNotNull(result);+ var model = result.Model as ProductModel.AddSimilarProductModel;+ Assert.IsNotNull(model);+ Assert.AreEqual("p1", model.ProductId);+ _productViewModelServiceMock.Verify(s => s.PrepareSimilarProductModel("store-1"), Times.Once);+ }++ [TestMethod]+ public async Task SimilarProductAddPopupGet_NoDefaultStoreId_PassesEmptyString()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);+ _productViewModelServiceMock.Setup(s => s.PrepareSimilarProductModel(""))+ .ReturnsAsync(new ProductModel.AddSimilarProductModel());++ var result = await _controller.SimilarProductAddPopup("p1") as ViewResult;++ Assert.IsNotNull(result);+ _productViewModelServiceMock.Verify(s => s.PrepareSimilarProductModel(""), Times.Once);+ }++ // --- SimilarProductAddPopupList -----------------------------------------------------------------++ [TestMethod]+ public async Task SimilarProductAddPopupList_UsesScopeDefaultStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");+ _productViewModelServiceMock+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddSimilarProductModel>(), 0, 10))+ .ReturnsAsync((new List<ProductModel>(), 0));++ var model = new ProductModel.AddSimilarProductModel();+ var result = await _controller.SimilarProductAddPopupList(+ 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 SimilarProductAddPopupList_NoDefaultStoreId_DoesNotOverrideModelSearchStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);+ _productViewModelServiceMock+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddSimilarProductModel>(), 0, 10))+ .ReturnsAsync((new List<ProductModel>(), 0));++ var model = new ProductModel.AddSimilarProductModel { SearchStoreId = "explicit" };+ var result = await _controller.SimilarProductAddPopupList(+ new Grand.Web.Common.DataSource.DataSourceRequest { Page = 0, PageSize = 10 }, model);++ Assert.IsInstanceOfType<JsonResult>(result);+ Assert.AreEqual("explicit", model.SearchStoreId);+ }++ // --- SimilarProductAddPopup (POST) --------------------------------------------------------------+ // HasAccess (strict): closes a real gap - Vendor's original SimilarProductAddPopup(POST) had no+ // ownership check at all, letting any vendor attach similar-product mappings onto another vendor's+ // product by posting its id.++ [TestMethod]+ public async Task SimilarProductAddPopupPost_ScopeDeniesAccess_ReturnsContentMessage_DoesNotInsert()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(false);+ var model = new ProductModel.AddSimilarProductModel { ProductId = "p1", SelectedProductIds = ["p2"] };++ var result = await _controller.SimilarProductAddPopup(model);++ Assert.IsInstanceOfType<ContentResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ _productViewModelServiceMock.Verify(s => s.InsertSimilarProductModel(It.IsAny<ProductModel.AddSimilarProductModel>()), Times.Never);+ }++ [TestMethod]+ public async Task SimilarProductAddPopupPost_ScopeGrantsAccess_ValidModel_Inserts()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);+ var model = new ProductModel.AddSimilarProductModel { ProductId = "p1", SelectedProductIds = ["p2"] };++ var result = await _controller.SimilarProductAddPopup(model);++ var content = result as ContentResult;+ Assert.IsNotNull(content);+ Assert.AreEqual("", content.Content);+ _productViewModelServiceMock.Verify(s => s.InsertSimilarProductModel(model), Times.Once);+ }++ [TestMethod]+ public async Task SimilarProductAddPopupPost_ScopeGrantsAccess_InvalidModel_ReturnsViewWithRepreparedModel()+ {+ var product = new Product { Id = "p1" };+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");+ var reprepared = new ProductModel.AddSimilarProductModel();+ _productViewModelServiceMock.Setup(s => s.PrepareSimilarProductModel("store-1")).ReturnsAsync(reprepared);+ var model = new ProductModel.AddSimilarProductModel { ProductId = "p1" };+ _controller.ModelState.AddModelError("x", "error");++ var result = await _controller.SimilarProductAddPopup(model);++ var view = result as ViewResult;+ Assert.IsNotNull(view);+ Assert.AreSame(reprepared, view.Model);+ _productViewModelServiceMock.Verify(s => s.InsertSimilarProductModel(It.IsAny<ProductModel.AddSimilarProductModel>()), Times.Never);+ }}diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.csindex 4411b1aa3..9fc59a236 100644--- a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs@@ -714,4 +714,137 @@ public abstract class BaseProductController(}#endregion++ #region Similar products++ [PermissionAuthorizeAction(PermissionActionName.Preview)]+ [HttpPost]+ public async Task<IActionResult> SimilarProductList(DataSourceRequest command, string productId)+ {+ var product = await productService.GetProductById(productId);++ // HasAccess (strict), not CanView: same shape as "Related products" above - mirrors Store's+ // CanAccessProduct check on this action. Applying it uniformly also closes a real gap: Vendor's+ // original SimilarProductUpdate/Delete/AddPopup(GET/POST) (below) had no ownership check at all -+ // only List checked (via CheckAccessToProduct) - letting any vendor mutate another vendor's+ // similar-product mappings by id.+ if (!await scope.HasAccess(product))+ return ErrorForKendoGridJson(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ var similarProducts = product.SimilarProducts.OrderBy(x => x.DisplayOrder);+ var similarProductsModel = new List<ProductModel.SimilarProductModel>();+ foreach (var x in similarProducts)+ similarProductsModel.Add(new ProductModel.SimilarProductModel {+ Id = x.Id,+ ProductId1 = productId,+ ProductId2 = x.ProductId2,+ Product2Name = (await productService.GetProductById(x.ProductId2))?.Name,+ DisplayOrder = x.DisplayOrder+ });++ var gridModel = new DataSourceResult {+ Data = similarProductsModel,+ Total = similarProductsModel.Count+ };++ return Json(gridModel);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> SimilarProductUpdate(ProductModel.SimilarProductModel model)+ {+ var product = await productService.GetProductById(model.ProductId1);+ if (!await scope.HasAccess(product))+ return ErrorForKendoGridJson(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ if (ModelState.IsValid)+ {+ await productViewModelService.UpdateSimilarProductModel(model);+ return new JsonResult("");+ }++ return ErrorForKendoGridJson(ModelState);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> SimilarProductDelete(ProductModel.SimilarProductModel model)+ {+ var product = await productService.GetProductById(model.ProductId1);+ if (!await scope.HasAccess(product))+ return ErrorForKendoGridJson(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ if (ModelState.IsValid)+ {+ await productViewModelService.DeleteSimilarProductModel(model);+ return new JsonResult("");+ }++ return ErrorForKendoGridJson(ModelState);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ public async Task<IActionResult> SimilarProductAddPopup(string productId)+ {+ // No access check here in any of the three original hosts (Admin/Store/Vendor all open this+ // popup unconditionally once the Edit permission is satisfied) - only the mutating POST below+ // ties access to a specific product. scope.DefaultStoreId ?? "" matches Store's+ // PrepareSimilarProductModel(StaffStoreId) call and Admin/Vendor's parameterless call.+ var model = await productViewModelService.PrepareSimilarProductModel(scope.DefaultStoreId ?? "");+ model.ProductId = productId;+ return View(model);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> SimilarProductAddPopupList(DataSourceRequest command,+ ProductModel.AddSimilarProductModel 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);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> SimilarProductAddPopup(ProductModel.AddSimilarProductModel model)+ {+ var product = await productService.GetProductById(model.ProductId);+ // HasAccess (strict): mirrors Store's CanAccessProduct check on this action. Vendor's original+ // SimilarProductAddPopup(POST) had no check at all, letting any vendor add similar-product+ // mappings onto another vendor's product by posting its id - closed here the same way as the+ // List/Update/Delete gap above.+ if (!await scope.HasAccess(product))+ return Content(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ if (ModelState.IsValid)+ {+ if (model.SelectedProductIds != null) await productViewModelService.InsertSimilarProductModel(model);+ return Content("");+ }++ return await InvalidSimilarProductAddPopupResult(model);+ }++ /// <summary>Hook for the host-specific invalid-model-state response of the AddPopup(POST) action+ /// above. Admin and Store both re-prepare the popup model and return the View; Vendor instead+ /// returns Content(ModelState.GetErrors()) - a Vendor-only extension method that AdminShared cannot+ /// reference. Default here matches Admin/Store; a future Vendor subclass overrides it once hosts are+ /// subclassed onto BaseProductController (Task 11).</summary>+ protected virtual async Task<IActionResult> InvalidSimilarProductAddPopupResult(ProductModel.AddSimilarProductModel model)+ {+ Error(ModelState);+ model = await productViewModelService.PrepareSimilarProductModel(scope.DefaultStoreId ?? "");+ return View(model);+ }++ #endregion}