divide_tree_service.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. // 分账树查询服务(端点 38 分账树 / 端点 43 分账流水)——AC-13。
  2. //
  3. // 依据:unified/03-migration/academic-frontend-contract-v1.md
  4. // - §3.4 B 表端点 38:`tree:[{userId, realName, parentUserId|null, quota:金额,
  5. // cumulativeIncome:金额, children:[…]}]`;**`quota` = 每次分成金额(`DECIMAL(12,2)`),
  6. // 不是 0~1 比率**(§1.5 B2,mock 曾错成比率)
  7. // - §3.4 C 表端点 43:`分页`;行 `{id, findUserId, studentId, orderNo, money, remark, createTime}`;
  8. // 该端点**无 dump SP 对照** ⇒ 排序与窗口由 Go 定(Go 新增查询)
  9. // - 设计 §3.3 #22~#25(分账 4 SP,AC-09 已交付)/ §1.7「全局无作用域表·例外二」
  10. //
  11. // ---------------------------------------------------------------------------
  12. // 为什么本服务要做「树不变式校验」而不是直接拼 JSON
  13. // ---------------------------------------------------------------------------
  14. //
  15. // Nested Set 的 `left_val/right_val` 是**位移**维护的(插入 +2、删除 −2),
  16. // 一旦某次位移漏了一行或错了 root 限定,树的形状就坏了,但**单看某一行数据完全正常**:
  17. // 响应体照常能拼出来、前端照常能渲染一棵"看起来对"的树。这类损坏的症状是
  18. // "分账金额算错/某层级消失",排查成本极高。
  19. //
  20. // 因此本服务在拼树的同时**断言四条不变式**(任何一条不成立就不返回树,直接报数据损坏):
  21. //
  22. // I1 `left < right` 且所有 `left/right` 恰为 `1..2N` 的**无重复无空洞**排列;
  23. // I2 任意两节点区间**嵌套或相离**(不允许部分重叠);
  24. // I3 父区间**严格包含**子区间;
  25. // I4 `layer = parent.layer + 1`(根 `layer = 1`,且根的 `parent_user_id` 为 NULL)。
  26. //
  27. // 这四条正是"测试绿但树坏了"唯一能抓住的东西,也是端点 38 用例的断言主体。
  28. package service
  29. import (
  30. "context"
  31. "sort"
  32. "strings"
  33. "time"
  34. "gorm.io/gorm"
  35. "yuansiwei/unified-backend/internal/academic/model"
  36. "yuansiwei/unified-backend/internal/academic/money"
  37. "yuansiwei/unified-backend/internal/academic/repository"
  38. infraerrors "yuansiwei/unified-backend/internal/infra/errors"
  39. appscope "yuansiwei/unified-backend/internal/infra/scope"
  40. )
  41. // RealNameResolver 用户姓名解析器(可选依赖;nil 时 `realName` 返回空串)。
  42. //
  43. // 为什么做成可选函数而不是硬编码查表:姓名住在 identity/org 域(`t_user.real_name`),
  44. // academic 不持有该表的结构(设计 §1.3 跨域只读要经 port)。
  45. // 生产装配由 AC-14 在 main 注入真实实现;未注入时字段留空——**不编造**姓名。
  46. type RealNameResolver func(ctx context.Context, userIDs []string) (map[string]string, error)
  47. // DivideTreeService 分账树 / 分账流水查询服务(只读,无事务)。
  48. //
  49. // 字段:
  50. // - repo 分账仓储(Nested Set 节点 + 流水);
  51. // - names 姓名解析器(可 nil);
  52. // - sc 请求作用域(可 nil:系统任务视角)。
  53. type DivideTreeService struct {
  54. repo *repository.DivideRepo
  55. names RealNameResolver
  56. sc *appscope.Scope
  57. }
  58. // NewDivideTreeService 构造分账查询服务。
  59. //
  60. // 入参:db *gorm.DB(必填);sc *appscope.Scope(请求作用域);names RealNameResolver(可 nil)。
  61. // 出参:*DivideTreeService。
  62. func NewDivideTreeService(db *gorm.DB, sc *appscope.Scope, names RealNameResolver) *DivideTreeService {
  63. return &DivideTreeService{repo: repository.NewDivideRepo(db), names: names, sc: sc}
  64. }
  65. // ---------------------------------------------------------------- 端点 38:分账树
  66. // DivideTreeNode 分账树节点(契约 §3.4 B 表端点 38 逐字段对齐)。
  67. //
  68. // 量纲纪律(**mock 曾在此错一次**):
  69. // - `Quota` = **金额**(元/次分成,`DECIMAL(12,2)`,两位小数字符串);
  70. // - `CumulativeIncome` = **金额**(累计分成收入)。
  71. //
  72. // 两者都**不是** 0~1 的比率,也不得写成 number。
  73. type DivideTreeNode struct {
  74. // UserID 节点用户(ULID)。
  75. UserID string `json:"userId"`
  76. // RealName 姓名(未注入姓名解析器时为空串——**不编造**)。
  77. RealName string `json:"realName"`
  78. // ParentUserID 上级用户(根为 null)。
  79. ParentUserID *string `json:"parentUserId"`
  80. // Quota 每次分成金额(元;`quota` 是金额不是比率)。
  81. Quota money.Amount `json:"quota"`
  82. // CumulativeIncome 累计分成收入(元)。
  83. CumulativeIncome money.Amount `json:"cumulativeIncome"`
  84. // Layer 层级(根=1;用于前端缩进与"层数上限 100"提示)。
  85. Layer int32 `json:"layer"`
  86. // Children 子节点(空 → `[]`,绝不 null)。
  87. Children []*DivideTreeNode `json:"children"`
  88. }
  89. // DivideTreeResult 分账树响应(**包一层 `tree`**,契约 §3.4 结构约定 2 的显式例外)。
  90. type DivideTreeResult struct {
  91. // Tree 森林(多棵树时按根 user_id 升序;空 → `[]`)。
  92. Tree []*DivideTreeNode `json:"tree"`
  93. // NodeCount 节点总数(前端可做"共 N 人"提示,也便于对账)。
  94. NodeCount int `json:"nodeCount"`
  95. // RootCount 树的棵数(多根场景下前端分组渲染)。
  96. RootCount int `json:"rootCount"`
  97. }
  98. // GetTree 组装分账树并校验 Nested Set 不变式(端点 38)。
  99. //
  100. // 入参:ctx。
  101. // 出参:
  102. // - *DivideTreeResult:森林(按根 `user_id` 升序、子节点按 `left_val` 升序);
  103. // - ErrInternal(5001) + 明确文案:**树不变式被破坏**(数据损坏,不能返回一棵"看起来对"的树);
  104. // - ErrDBError(5002):读库失败;金额字面量非法时同样 5002。
  105. //
  106. // 空表:返回 `{tree: [], nodeCount: 0, rootCount: 0}`(不是 nil、不是错误)。
  107. func (s *DivideTreeService) GetTree(ctx context.Context) (*DivideTreeResult, error) {
  108. rows, err := s.repo.ListAllNodes(ctx)
  109. if err != nil {
  110. return nil, err
  111. }
  112. if len(rows) == 0 {
  113. return &DivideTreeResult{Tree: []*DivideTreeNode{}, NodeCount: 0, RootCount: 0}, nil
  114. }
  115. if err := assertNestedSetInvariants(rows); err != nil {
  116. return nil, err
  117. }
  118. names := map[string]string{}
  119. if s.names != nil {
  120. ids := make([]string, 0, len(rows))
  121. for i := range rows {
  122. ids = append(ids, rows[i].UserID)
  123. }
  124. if resolved, nerr := s.names(ctx, ids); nerr == nil && resolved != nil {
  125. names = resolved
  126. }
  127. // 姓名解析失败**不阻断**树查询(姓名是展示位;树与金额才是数据)——
  128. // 这条与"金额/树结构任何异常都阻断"的不对称是有意的:前者是装饰、后者是对账依据。
  129. }
  130. nodes := make(map[string]*DivideTreeNode, len(rows))
  131. for i := range rows {
  132. quota, perr := money.Parse(rows[i].Quota)
  133. if perr != nil {
  134. return nil, infraerrors.WithCause(infraerrors.ErrDBError, perr)
  135. }
  136. income, perr := money.Parse(rows[i].TotalIncome)
  137. if perr != nil {
  138. return nil, infraerrors.WithCause(infraerrors.ErrDBError, perr)
  139. }
  140. nodes[rows[i].UserID] = &DivideTreeNode{
  141. UserID: rows[i].UserID, RealName: names[rows[i].UserID],
  142. ParentUserID: rows[i].ParentUserID, Quota: quota, CumulativeIncome: income,
  143. Layer: rows[i].Layer, Children: []*DivideTreeNode{},
  144. }
  145. }
  146. roots := make([]*DivideTreeNode, 0, 4)
  147. for i := range rows { // rows 已按 (root_user_id, left_val) 排序 ⇒ 子节点天然有序
  148. node := nodes[rows[i].UserID]
  149. if rows[i].ParentUserID == nil || strings.TrimSpace(*rows[i].ParentUserID) == "" {
  150. roots = append(roots, node)
  151. continue
  152. }
  153. parent, ok := nodes[*rows[i].ParentUserID]
  154. if !ok {
  155. // 父节点缺失 = 数据损坏(孤儿行)。dump 的 SP30 有"孤儿行跳过"先例(A16),
  156. // 但**查询树**不能静默丢行:丢行会让"分成总额少了某人"看起来像正常数据。
  157. return nil, infraerrors.WithCause(infraerrors.ErrInternal,
  158. errString("service: 分账树存在孤儿节点(parent_user_id 指向不存在的用户: "+
  159. *rows[i].ParentUserID+")"))
  160. }
  161. parent.Children = append(parent.Children, node)
  162. }
  163. sort.Slice(roots, func(a, b int) bool { return roots[a].UserID < roots[b].UserID })
  164. return &DivideTreeResult{Tree: roots, NodeCount: len(rows), RootCount: len(roots)}, nil
  165. }
  166. // assertNestedSetInvariants 校验 Nested Set 四条不变式(I1~I4,见文件头)。
  167. //
  168. // 入参:rows 全部节点(**同一棵树内可比;多棵树按 root_user_id 分组后各自校验**)。
  169. // 出参:nil 通过;ErrInternal(5001) + 具体违反项。
  170. //
  171. // 为什么不"自动修复":位移错位无法从当前数据推断"原本该是多少";
  172. // 猜测式修复会把"确定性错误"变成"随机正确"。这里的职责是**让损坏可见**。
  173. func assertNestedSetInvariants(rows []model.UserDivideInto) error {
  174. // 按 root 分组(root_user_id 为 NULL 时退化为自身为根)
  175. groups := map[string][]model.UserDivideInto{}
  176. order := make([]string, 0, 4)
  177. for i := range rows {
  178. root := rows[i].UserID
  179. if rows[i].RootUserID != nil && strings.TrimSpace(*rows[i].RootUserID) != "" {
  180. root = *rows[i].RootUserID
  181. }
  182. if _, ok := groups[root]; !ok {
  183. order = append(order, root)
  184. }
  185. groups[root] = append(groups[root], rows[i])
  186. }
  187. for _, root := range order {
  188. nodes := groups[root]
  189. // I1a:left < right
  190. seen := make(map[int32]string, len(nodes)*2)
  191. pairs := make([]struct{ left, right int32 }, 0, len(nodes))
  192. for i := range nodes {
  193. if nodes[i].LeftVal >= nodes[i].RightVal {
  194. return infraerrors.WithCause(infraerrors.ErrInternal,
  195. errString("service: 分账树不变式 I1 破(left >= right): user="+nodes[i].UserID))
  196. }
  197. for _, v := range []int32{nodes[i].LeftVal, nodes[i].RightVal} {
  198. if v < 1 {
  199. return infraerrors.WithCause(infraerrors.ErrInternal,
  200. errString("service: 分账树不变式 I1 破(区间值 < 1): user="+nodes[i].UserID))
  201. }
  202. if prev, dup := seen[v]; dup {
  203. return infraerrors.WithCause(infraerrors.ErrInternal,
  204. errString("service: 分账树不变式 I1 破(区间值重复 "+itoa32(v)+
  205. ":user="+prev+" 与 user="+nodes[i].UserID+")"))
  206. }
  207. seen[v] = nodes[i].UserID
  208. }
  209. pairs = append(pairs, struct{ left, right int32 }{nodes[i].LeftVal, nodes[i].RightVal})
  210. }
  211. // I1b:恰为 1..2N 无空洞
  212. want := 2 * len(nodes)
  213. if len(seen) != want {
  214. return infraerrors.WithCause(infraerrors.ErrInternal,
  215. errString("service: 分账树不变式 I1 破(区间值数量 "+itoa32(int32(len(seen)))+
  216. " ≠ 2N="+itoa32(int32(want))+")"))
  217. }
  218. for v := 1; v <= want; v++ {
  219. if _, ok := seen[int32(v)]; !ok {
  220. return infraerrors.WithCause(infraerrors.ErrInternal,
  221. errString("service: 分账树不变式 I1 破(区间值有空洞,缺 "+itoa32(int32(v))+")"))
  222. }
  223. }
  224. // I2:任意两节点区间嵌套或相离(不允许部分重叠)
  225. for i := 0; i < len(pairs); i++ {
  226. for j := i + 1; j < len(pairs); j++ {
  227. a, b := pairs[i], pairs[j]
  228. nested := (a.left < b.left && b.right < a.right) || (b.left < a.left && a.right < b.right)
  229. disjoint := a.right < b.left || b.right < a.left
  230. if !nested && !disjoint {
  231. return infraerrors.WithCause(infraerrors.ErrInternal,
  232. errString("service: 分账树不变式 I2 破(区间部分重叠: ["+
  233. itoa32(a.left)+","+itoa32(a.right)+"] 与 ["+
  234. itoa32(b.left)+","+itoa32(b.right)+"])"))
  235. }
  236. }
  237. }
  238. }
  239. // I3/I4:父区间严格包含子区间 + layer = parent.layer + 1
  240. byUser := make(map[string]model.UserDivideInto, len(rows))
  241. for i := range rows {
  242. byUser[rows[i].UserID] = rows[i]
  243. }
  244. for i := range rows {
  245. node := rows[i]
  246. if node.ParentUserID == nil || strings.TrimSpace(*node.ParentUserID) == "" {
  247. if node.Layer != 1 {
  248. return infraerrors.WithCause(infraerrors.ErrInternal,
  249. errString("service: 分账树不变式 I4 破(根节点 layer≠1): user="+node.UserID))
  250. }
  251. continue
  252. }
  253. parent, ok := byUser[*node.ParentUserID]
  254. if !ok {
  255. return infraerrors.WithCause(infraerrors.ErrInternal,
  256. errString("service: 分账树不变式 I3/I4 破(父节点不存在): user="+node.UserID))
  257. }
  258. if !(parent.LeftVal < node.LeftVal && node.RightVal < parent.RightVal) {
  259. return infraerrors.WithCause(infraerrors.ErrInternal,
  260. errString("service: 分账树不变式 I3 破(父区间未严格包含子区间): user="+node.UserID))
  261. }
  262. if node.Layer != parent.Layer+1 {
  263. return infraerrors.WithCause(infraerrors.ErrInternal,
  264. errString("service: 分账树不变式 I4 破(layer≠parent.layer+1): user="+node.UserID))
  265. }
  266. }
  267. return nil
  268. }
  269. // itoa32 最小 int32 → string 转换(避免为一个错误文案引入 strconv 依赖)。
  270. //
  271. // 入参:v 整数。出参:十进制字符串(负数带前导 '-')。
  272. func itoa32(v int32) string {
  273. if v == 0 {
  274. return "0"
  275. }
  276. negative := v < 0
  277. if negative {
  278. v = -v
  279. }
  280. buf := [12]byte{}
  281. pos := len(buf)
  282. for v > 0 {
  283. pos--
  284. buf[pos] = byte('0' + v%10)
  285. v /= 10
  286. }
  287. if negative {
  288. pos--
  289. buf[pos] = '-'
  290. }
  291. return string(buf[pos:])
  292. }
  293. // ---------------------------------------------------------------- 端点 43:分账流水
  294. // DivideLogQuery 分账流水查询入参(端点 43)。
  295. type DivideLogQuery struct {
  296. // FindUserID 分成获得者(空 = 不筛)。
  297. FindUserID string
  298. // StudentID 学生(空 = 不筛)。
  299. StudentID string
  300. // From 起始时间(含;零值 = 不筛)。
  301. From *time.Time
  302. // To 结束时间(**不含**;零值 = 不筛)。
  303. To *time.Time
  304. // Page / PageSize 分页(<=0 归一;>200 钳 200)。
  305. Page int
  306. PageSize int
  307. }
  308. // DivideLogView 分账流水行(契约 §3.4 C 表端点 43 逐字段)。
  309. type DivideLogView struct {
  310. // ID 流水 ID。
  311. ID int64 `json:"id"`
  312. // FindUserID 分成获得者(ULID)。
  313. FindUserID string `json:"findUserId"`
  314. // StudentID 学生(ULID)。
  315. StudentID string `json:"studentId"`
  316. // OrderNo 订单号(可空 → "")。
  317. OrderNo string `json:"orderNo"`
  318. // Money 分成金额(元)。
  319. Money money.Amount `json:"money"`
  320. // Remark 备注。
  321. Remark string `json:"remark"`
  322. // CreateTime 业务时间(RFC3339)。
  323. CreateTime time.Time `json:"createTime"`
  324. }
  325. // ListLogs 分页查分账流水(端点 43)。
  326. //
  327. // 入参:ctx;q DivideLogQuery。
  328. // 出参:([]DivideLogView, total, error);`from > to` → 2001。
  329. func (s *DivideTreeService) ListLogs(ctx context.Context, q DivideLogQuery) ([]DivideLogView, int64, error) {
  330. if q.From != nil && q.To != nil && q.From.After(*q.To) {
  331. return nil, 0, infraerrors.WithCause(infraerrors.ErrBadParam,
  332. errString("service: 分账流水的 from 不能晚于 to"))
  333. }
  334. page := repository.PageQuery{Page: q.Page, PageSize: q.PageSize}
  335. rows, total, err := s.repo.ListLogsFiltered(ctx, repository.DivideLogFilter{
  336. FindUserID: strings.TrimSpace(q.FindUserID),
  337. StudentID: strings.TrimSpace(q.StudentID),
  338. From: q.From, To: q.To,
  339. }, page)
  340. if err != nil {
  341. return nil, 0, err
  342. }
  343. views := make([]DivideLogView, 0, len(rows))
  344. for i := range rows {
  345. amount, perr := money.Parse(rows[i].Money)
  346. if perr != nil {
  347. return nil, 0, infraerrors.WithCause(infraerrors.ErrDBError, perr)
  348. }
  349. view := DivideLogView{
  350. // 表列 `user_id` → 契约响应字段 `findUserId`(名字听前端的,语义听 dump 的)
  351. ID: rows[i].ID, FindUserID: rows[i].UserID, StudentID: rows[i].StudentID,
  352. Money: amount, CreateTime: rows[i].CreateTime,
  353. }
  354. if rows[i].OrderNo != nil {
  355. view.OrderNo = *rows[i].OrderNo
  356. }
  357. if rows[i].Remark != nil {
  358. view.Remark = *rows[i].Remark
  359. }
  360. views = append(views, view)
  361. }
  362. return views, total, nil
  363. }