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 'Recommended products' region into BaseProductController (ARCH-001 Phase 1)
KrzysztofPajakfad7cc33ce28
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.csindex f9999d1be..3f51ccb35 100644--- a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseProductControllerTests.cs@@ -1714,4 +1714,216 @@ public class BaseProductControllerTestsAssert.AreSame(reprepared, view.Model);_productViewModelServiceMock.Verify(s => s.InsertCrossSellProductModel(It.IsAny<ProductModel.AddCrossSellProductModel>()), Times.Never);}++ // --- RecommendedProductList ---------------------------------------------------------------------+ // HasAccess (strict), not CanView: same shape as CrossSellProductList above. Admin's original+ // RecommendedProductList had no check at all. Vendor's original signature also dropped the+ // DataSourceRequest command parameter entirely - kept here for parity with Admin/Store.++ [TestMethod]+ public async Task RecommendedProductList_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.RecommendedProductList(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 RecommendedProductList_ScopeGrantsAccess_ReturnsGrid()+ {+ var product = new Product { Id = "p1" };+ product.RecommendedProduct.Add("p2");+ _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.RecommendedProductList(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);+ }++ // --- RecommendedProductDelete -------------------------------------------------------------------+ // Admin/Store/Vendor all throw ArgumentException when the product does not exist; Vendor's original+ // RecommendedProductDelete had no ownership check at all - closed here the same way as List above.++ [TestMethod]+ public async Task RecommendedProductDelete_ProductNotFound_Throws()+ {+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync((Product)null);+ var model = new ProductModel.RecommendedProductModel { ProductId = "p1", Id = "p2" };++ await Assert.ThrowsExactlyAsync<ArgumentException>(() => _controller.RecommendedProductDelete(model));+ }++ [TestMethod]+ public async Task RecommendedProductDelete_ScopeDeniesAccess_ReturnsErrorJson_DoesNotDelete()+ {+ var product = new Product { Id = "p1" };+ product.RecommendedProduct.Add("p2");+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(false);+ var model = new ProductModel.RecommendedProductModel { ProductId = "p1", Id = "p2" };++ var result = await _controller.RecommendedProductDelete(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ _productViewModelServiceMock.Verify(s => s.DeleteRecommendedProduct(It.IsAny<string>(), It.IsAny<string>()), Times.Never);+ }++ [TestMethod]+ public async Task RecommendedProductDelete_NoMatchingRecommendedProduct_Throws()+ {+ 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.RecommendedProductModel { ProductId = "p1", Id = "p2" };++ await Assert.ThrowsExactlyAsync<ArgumentException>(() => _controller.RecommendedProductDelete(model));+ }++ [TestMethod]+ public async Task RecommendedProductDelete_ScopeGrantsAccess_ValidModel_Deletes()+ {+ var product = new Product { Id = "p1" };+ product.RecommendedProduct.Add("p2");+ _productServiceMock.Setup(p => p.GetProductById("p1", false)).ReturnsAsync(product);+ _scopeMock.Setup(s => s.HasAccess(product)).ReturnsAsync(true);+ var model = new ProductModel.RecommendedProductModel { ProductId = "p1", Id = "p2" };++ var result = await _controller.RecommendedProductDelete(model);++ Assert.IsInstanceOfType<JsonResult>(result);+ _productViewModelServiceMock.Verify(s => s.DeleteRecommendedProduct("p1", "p2"), Times.Once);+ }++ // --- RecommendedProductAddPopup (GET) -------------------------------------------------------------++ [TestMethod]+ public async Task RecommendedProductAddPopupGet_UsesScopeDefaultStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");+ _productViewModelServiceMock.Setup(s => s.PrepareRecommendedProductModel("store-1"))+ .ReturnsAsync(new ProductModel.AddRecommendedProductModel());++ var result = await _controller.RecommendedProductAddPopup("p1") as ViewResult;++ Assert.IsNotNull(result);+ var model = result.Model as ProductModel.AddRecommendedProductModel;+ Assert.IsNotNull(model);+ Assert.AreEqual("p1", model.ProductId);+ _productViewModelServiceMock.Verify(s => s.PrepareRecommendedProductModel("store-1"), Times.Once);+ }++ [TestMethod]+ public async Task RecommendedProductAddPopupGet_NoDefaultStoreId_PassesEmptyString()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);+ _productViewModelServiceMock.Setup(s => s.PrepareRecommendedProductModel(""))+ .ReturnsAsync(new ProductModel.AddRecommendedProductModel());++ var result = await _controller.RecommendedProductAddPopup("p1") as ViewResult;++ Assert.IsNotNull(result);+ _productViewModelServiceMock.Verify(s => s.PrepareRecommendedProductModel(""), Times.Once);+ }++ // --- RecommendedProductAddPopupList ---------------------------------------------------------------++ [TestMethod]+ public async Task RecommendedProductAddPopupList_UsesScopeDefaultStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns("store-1");+ _productViewModelServiceMock+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddRecommendedProductModel>(), 0, 10))+ .ReturnsAsync((new List<ProductModel>(), 0));++ var model = new ProductModel.AddRecommendedProductModel();+ var result = await _controller.RecommendedProductAddPopupList(+ 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 RecommendedProductAddPopupList_NoDefaultStoreId_DoesNotOverrideModelSearchStoreId()+ {+ _scopeMock.Setup(s => s.DefaultStoreId).Returns((string)null);+ _productViewModelServiceMock+ .Setup(s => s.PrepareProductModel(It.IsAny<ProductModel.AddRecommendedProductModel>(), 0, 10))+ .ReturnsAsync((new List<ProductModel>(), 0));++ var model = new ProductModel.AddRecommendedProductModel { SearchStoreId = "explicit" };+ var result = await _controller.RecommendedProductAddPopupList(+ new Grand.Web.Common.DataSource.DataSourceRequest { Page = 0, PageSize = 10 }, model);++ Assert.IsInstanceOfType<JsonResult>(result);+ Assert.AreEqual("explicit", model.SearchStoreId);+ }++ // --- RecommendedProductAddPopup (POST) --------------------------------------------------------------+ // HasAccess (strict): closes a real gap - Vendor's original RecommendedProductAddPopup(POST) had no+ // ownership check at all, letting any vendor attach recommended-product mappings onto another+ // vendor's product by posting its id.++ [TestMethod]+ public async Task RecommendedProductAddPopupPost_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.AddRecommendedProductModel { ProductId = "p1", SelectedProductIds = ["p2"] };++ var result = await _controller.RecommendedProductAddPopup(model);++ Assert.IsInstanceOfType<ContentResult>(result);+ _translationServiceMock.Verify(t => t.GetResource("Admin.Catalog.Products.Permissions"), Times.Once);+ _productViewModelServiceMock.Verify(s => s.InsertRecommendedProductModel(It.IsAny<ProductModel.AddRecommendedProductModel>()), Times.Never);+ }++ [TestMethod]+ public async Task RecommendedProductAddPopupPost_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.AddRecommendedProductModel { ProductId = "p1", SelectedProductIds = ["p2"] };++ var result = await _controller.RecommendedProductAddPopup(model);++ var content = result as ContentResult;+ Assert.IsNotNull(content);+ Assert.AreEqual("", content.Content);+ _productViewModelServiceMock.Verify(s => s.InsertRecommendedProductModel(model), Times.Once);+ }++ [TestMethod]+ public async Task RecommendedProductAddPopupPost_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.AddRecommendedProductModel();+ _productViewModelServiceMock.Setup(s => s.PrepareRecommendedProductModel("store-1")).ReturnsAsync(reprepared);+ var model = new ProductModel.AddRecommendedProductModel { ProductId = "p1" };+ _controller.ModelState.AddModelError("x", "error");++ var result = await _controller.RecommendedProductAddPopup(model);++ var view = result as ViewResult;+ Assert.IsNotNull(view);+ Assert.AreSame(reprepared, view.Model);+ _productViewModelServiceMock.Verify(s => s.InsertRecommendedProductModel(It.IsAny<ProductModel.AddRecommendedProductModel>()), Times.Never);+ }}diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.csindex aba501ce9..28ce74b39 100644--- a/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseProductController.cs@@ -1102,4 +1102,126 @@ public abstract class BaseProductController(}#endregion++ #region Recommended products++ [PermissionAuthorizeAction(PermissionActionName.Preview)]+ [HttpPost]+ public async Task<IActionResult> RecommendedProductList(DataSourceRequest command, string productId)+ {+ var product = await productService.GetProductById(productId);++ // HasAccess (strict), not CanView: same shape as "Cross-sell products" above - mirrors Store's+ // CanAccessProduct and Vendor's CheckAccessToProduct gating this action on both hosts. Admin's+ // original RecommendedProductList had no check at all - applying HasAccess uniformly also closes+ // that gap without changing Admin's superuser behaviour (HasAccess is a no-op for Admin's scope).+ // Vendor's original signature also dropped the DataSourceRequest command parameter entirely+ // (unused by the body on any host either way) - kept here for parity with Admin/Store.+ if (!await scope.HasAccess(product))+ return ErrorForKendoGridJson(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ var recommendedProductsModel = new List<ProductModel.RecommendedProductModel>();+ foreach (var x in product.RecommendedProduct)+ recommendedProductsModel.Add(new ProductModel.RecommendedProductModel {+ Id = x,+ ProductId = product.Id,+ Product2Name = (await productService.GetProductById(x))?.Name+ });+ var gridModel = new DataSourceResult {+ Data = recommendedProductsModel,+ Total = recommendedProductsModel.Count+ };++ return Json(gridModel);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> RecommendedProductDelete(ProductModel.RecommendedProductModel model)+ {+ var product = await productService.GetProductById(model.ProductId);+ if (product == null) throw new ArgumentException("Product not exists");++ // HasAccess (strict): mirrors Store's CanAccessProduct check on this action. Vendor's original+ // RecommendedProductDelete had no check at all, letting any vendor delete another vendor's+ // recommended-product mappings by id - closed here the same way as the List gap above.+ if (!await scope.HasAccess(product))+ return ErrorForKendoGridJson(translationService.GetResource($"{scope.ResourceKeyPrefix}.Catalog.Products.Permissions"));++ var recommendedProduct = product.RecommendedProduct.FirstOrDefault(x => x == model.Id);+ if (string.IsNullOrEmpty(recommendedProduct))+ throw new ArgumentException("No recommended product found with the specified id");++ if (ModelState.IsValid)+ {+ await productViewModelService.DeleteRecommendedProduct(product.Id, recommendedProduct);+ return new JsonResult("");+ }++ return ErrorForKendoGridJson(ModelState);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ public async Task<IActionResult> RecommendedProductAddPopup(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+ // PrepareRecommendedProductModel(StaffStoreId) call and Admin/Vendor's parameterless call.+ var model = await productViewModelService.PrepareRecommendedProductModel(scope.DefaultStoreId ?? "");+ model.ProductId = productId;+ return View(model);+ }++ [PermissionAuthorizeAction(PermissionActionName.Edit)]+ [HttpPost]+ public async Task<IActionResult> RecommendedProductAddPopupList(DataSourceRequest command,+ ProductModel.AddRecommendedProductModel 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> RecommendedProductAddPopup(ProductModel.AddRecommendedProductModel model)+ {+ var product = await productService.GetProductById(model.ProductId);+ // HasAccess (strict): mirrors Store's CanAccessProduct check on this action. Vendor's original+ // RecommendedProductAddPopup(POST) had no check at all, letting any vendor add recommended-product+ // mappings onto another vendor's product by posting its id - closed here the same way as the+ // List/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.InsertRecommendedProductModel(model);+ return Content("");+ }++ return await InvalidRecommendedProductAddPopupResult(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> InvalidRecommendedProductAddPopupResult(ProductModel.AddRecommendedProductModel model)+ {+ Error(ModelState);+ model = await productViewModelService.PrepareRecommendedProductModel(scope.DefaultStoreId ?? "");+ return View(model);+ }++ #endregion}