Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Record manual stock changes in InventoryJournal

未关闭
#880 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
csharp, mongodb
领域
backend, databases

调研方向

Start with InventoryManageService and IInventoryManageService, then trace the listed stock-update paths in ProductViewModelService, BaseProductController, and the API command handlers. Review InventoryJournal and InventoryManageServiceTests before estimating how the shared adjustment flow fits. Done means all listed adjustment paths, notification behavior, no-op handling, and the specified tests meet the acceptance criteria.

由索引模型根据 Issue 内容生成。

描述

enhancement

Problem

Manual stock changes leave no trace. InventoryJournal (src/Core/Grand.Domain/Catalog/InventoryJournal.cs) is written only for shipments: InventoryManageService.InsertInventoryJournal (src/Business/Grand.Business.Catalog/Services/Products/InventoryManageService.cs) is called with ObjectType = nameof(Shipment). When an administrator or an API client edits a quantity, the old value is simply overwritten, so there is no answer to "who changed this, when, from what to what, and why".

Code paths that change StockQuantity / ProductWarehouseInventory / combination stock without a journal entry:

  • Product edit - ProductViewModelService (src/Web/Grand.Web.AdminShared/Services/ProductViewModelService.cs): StockQuantity is mapped from the model on update, and SaveProductWarehouseInventory (~L439) writes per-warehouse StockQuantity and then sums to product.StockQuantity. Same flow for create (~L771) and update (~L830).
  • Bulk edit (grid) - same file, ~L1362-1367: product.StockQuantity = pModel.StockQuantity.
  • Attribute combinations - same file, ~L2200-2260: combination.StockQuantity, PrepareCombinationWarehouseInventory (per-warehouse ProductCombinationWarehouseInventory), and the recalculated product.StockQuantity. Also the "generate all combinations" path (BaseProductController, ~L2949 resets StockQuantity = 0).
  • Out-of-stock subscription notifications live in this view-model layer (OutOfStockNotifications, ~L189 and ~L223), so they only fire for panel edits.
  • Store owner and Vendor panels reuse the same AdminShared services/controllers, so they have the same gap.
  • Backend API (src/Modules/Grand.Module.Api):
    • PUT /Product and PATCH /Product/{key} -> UpdateProductCommandHandler maps StockQuantity from the DTO and calls UpdateProduct; it has its own, partial copy of the back-in-stock logic.
    • POST /Product/{key}/UpdateStock -> UpdateProductStockCommandHandler sets product.StockQuantity or the ProductWarehouseInventory row; it duplicates OutOfStockNotifications a third time.
    • ProductAttributeCombinationDto.StockQuantity is part of the DTO, so combination stock can change through product update as well.

Product import (ProductImportDataObject) also sets StockQuantity; it is a bulk path and is probably better handled as a follow-up.

The panels do not display InventoryJournal anywhere (no reference in Grand.Web.*); the collection is currently write-only from shipments and read nowhere.

Proposal

Add a core method to IInventoryManageService, for example:

Task AdjustStock(Product product, ProductAttributeCombination combination, string warehouseId,
    int newQuantity, string reason, string reference);

(or a delta-based overload). It should:

  • apply the new quantity to the product / warehouse row / combination (and its warehouse row), recompute the aggregates, and call UpdateStockProduct so LowStock / auto-unpublish keep working as today;
  • insert an InventoryJournal entry with a new ObjectType for manual adjustments (e.g. "StockAdjustment"), InQty / OutQty derived from the delta, ProductId, Attributes (combination), WarehouseId, Comments = reason, Reference = who/what (user e-mail, "api");
  • do nothing (no journal entry) when the quantity did not change;
  • own the out-of-stock subscription notifications: move OutOfStockNotifications from ProductViewModelService into core so the panel and every API path share one implementation, and delete the copies in the API handlers.

Route every path listed above through it: product edit and warehouse inventory, bulk edit, combination create/edit, API PUT/PATCH/UpdateStock.

Out of scope / follow-ups

  • A journal view per product in the admin panel (read side of InventoryJournal).
  • An optional "reason" field in the panel UI (until then Comments can be a default text such as "Manual adjustment").
  • Journal entries for product import.

Acceptance criteria

  • IInventoryManageService exposes a stock adjustment method covering product, warehouse and combination (+ combination warehouse) quantities.
  • Each adjustment writes one InventoryJournal entry with a dedicated ObjectType, correct InQty/OutQty, Comments and Reference.
  • Unchanged quantities produce no entry.
  • Admin, Store and Vendor product edit, bulk edit and combination edit go through the new method.
  • API PUT, PATCH and UpdateStock go through the new method; Reference identifies the API caller.
  • LowStock flag, auto-unpublish / out-of-stock behaviour and back-in-stock notifications behave as before, from a single implementation in core.
  • Unit tests in InventoryManageServiceTests cover product, warehouse and combination adjustments, no-op, and notification triggering.

Notes

  • Add an index on InventoryJournal (ProductId, CreateDateUtc) - needed as soon as a per-product view reads it.
  • No migration needed for existing data; history starts from the release that ships this.
主要语言
C#
星标
1.3k
派生
549
平均合并
7 小时 58 分钟
30 天内合并 PR
52

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

grandnode/grandnode2 的其他 Issue

查看 grandnode/grandnode2 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。