activity_discount_repo.go 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. // 活动赠送金额池仓储(t_courses_activity_user_discount / _user_discount_log / _used_log)——AC-06。
  2. //
  3. // 依据:unified/03-migration/academic-domain-design.md §3.2 #14~#19(赠送金额池 4 SP)/ §1.5(金额)
  4. // / §1.7(scoping)。
  5. //
  6. // 覆盖 SP 映射:
  7. //
  8. // user_discount_usable → SumUsable(dump 3 参汇总口径:schoolid + campusid + userid)
  9. // user_discount_use → ListUsable(ASC) + IncUsed/IncUsedBatch + InsertDiscountLog(负值)
  10. // user_discount_refund → ListUsable(DESC) + IncUsed(负 delta) + InsertDiscountLog(正值)
  11. // user_discount_refund_user_activity → ListUsable(DESC)(同活动池优先退回)
  12. // use_activity_recommend → IncUsed + InsertUsedLog(老带新结算写负值)
  13. //
  14. // 金额口径(红线):库里 discount_amount / discount_amount_used 是 decimal(12,2) **字符串列**,
  15. // Go 侧一律转 money.Amount(int64 分)再运算;SQL 侧只用字符串字面量做加减(decimal 精确),
  16. // **绝不**把金额转 float64(sqlite 的 SUM() 返回 REAL,会让分位失真——见 SumUsable 实现说明)。
  17. package repository
  18. import (
  19. "context"
  20. "strings"
  21. "gorm.io/gorm"
  22. "yuansiwei/unified-backend/internal/academic/model"
  23. "yuansiwei/unified-backend/internal/academic/money"
  24. infraerrors "yuansiwei/unified-backend/internal/infra/errors"
  25. appscope "yuansiwei/unified-backend/internal/infra/scope"
  26. )
  27. // UsedDelta 批量累加「已使用赠送金额」的单元素(id + 增量)。
  28. //
  29. // 字段:
  30. // - DiscountID int64:优惠账户 ID(t_courses_activity_user_discount.id;<=0 的条目被跳过)。
  31. // - Delta money.Amount:discount_amount_used 的增量(正=消费/占用,负=退回冲正;单位:分)。
  32. type UsedDelta struct {
  33. // DiscountID 优惠账户 ID(DB 自增主键)。
  34. DiscountID int64
  35. // Delta 已使用金额增量(正=消费,负=退回;单位:分)。
  36. Delta money.Amount
  37. }
  38. // ActivityDiscountRepo 活动赠送金额池仓储。
  39. //
  40. // 表:
  41. // - t_courses_activity_user_discount(池:可用 = discount_amount − discount_amount_used);
  42. // - t_courses_activity_user_discount_log(使用/退回流水,只增,负=消费/正=退回);
  43. // - t_courses_activity_used_log(老带新获得/使用记录,结算写负值)。
  44. //
  45. // 作用域:三表均带 institution_id + campus_id(campus_id=0 = 机构所有自营校区)→ scopedCampusRows。
  46. type ActivityDiscountRepo struct {
  47. *BaseRepo
  48. }
  49. // NewActivityDiscountRepo 构造赠送金额池仓储。
  50. //
  51. // 入参:db *gorm.DB / sc *appscope.Scope(语义同 NewActivityRepo)。
  52. // 出参:*ActivityDiscountRepo(CampusScoped=false,校区维度走 IN (campus,0) 超集语义)。
  53. func NewActivityDiscountRepo(db *gorm.DB, sc *appscope.Scope) *ActivityDiscountRepo {
  54. r := &ActivityDiscountRepo{BaseRepo: NewBaseRepo(db, sc)}
  55. r.CampusScoped = false
  56. return r
  57. }
  58. // db 取查询句柄(ctx 内含 tx 时复用同一事务)。
  59. func (r *ActivityDiscountRepo) db(ctx context.Context) (*gorm.DB, error) {
  60. if r == nil || r.DB == nil {
  61. return nil, infraerrors.WithCause(infraerrors.ErrInternal, errString("repository: ActivityDiscountRepo.DB 为 nil"))
  62. }
  63. if tx := TxFromContext(ctx); tx != nil {
  64. return tx, nil
  65. }
  66. if ctx == nil {
  67. return r.DB, nil
  68. }
  69. return r.DB.WithContext(ctx), nil
  70. }
  71. // ListUsable 列出用户可用赠送金额池(**活动维度**,dump `yuansiwei_finance.sql:763216`)。
  72. //
  73. // 入参:
  74. // - ctx 请求上下文;
  75. // - userID 学生(canonical_user_id ULID;空 → ErrBadParam);
  76. // - activityID 活动 ID(**>0 时只取该活动的赠送池**,对齐 dump `WHERE userid=? AND activityid=?`;
  77. // **0 = 不限活动**,仅"汇总所有活动可用额"的场景使用——扣减路径必须传具体 activityID,
  78. // 否则会把 A 活动的消费扣到 B 活动的池上);
  79. // - order 游标方向(**顺序不可改**,源自 dump):
  80. // OrderAsc = user_discount_use 使用顺序(先入先出);
  81. // OrderDesc = user_discount_refund 退回顺序(后入先退)。
  82. //
  83. // 出参:
  84. // - []model.CoursesActivityUserDiscount:可用行(`discount_amount > discount_amount_used`),
  85. // 金额为字符串原文,调用方用 money.Parse 转 Amount;
  86. // - ErrBadParam / ErrDBError。
  87. //
  88. // 可用口径(dump user_discount_usable 一致):仅累加 discount_amount > discount_amount_used 的行
  89. // (负赠送/已用尽的行不参与),故本方法只返回正可用行。
  90. func (r *ActivityDiscountRepo) ListUsable(ctx context.Context, userID string, activityID int64, order string) ([]model.CoursesActivityUserDiscount, error) {
  91. if strings.TrimSpace(userID) == "" {
  92. return nil, infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: ListUsable 需要 user_id"))
  93. }
  94. if activityID < 0 {
  95. return nil, infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: ListUsable activity_id 不得为负"))
  96. }
  97. dir, err := normalizeOrder(order)
  98. if err != nil {
  99. return nil, err
  100. }
  101. db, err := r.db(ctx)
  102. if err != nil {
  103. return nil, err
  104. }
  105. q := scopedCampusRows(db.Model(&model.CoursesActivityUserDiscount{}), r.Sc, "")
  106. q = q.Where("user_id = ?", userID).
  107. Where("discount_amount > discount_amount_used")
  108. if activityID > 0 {
  109. q = q.Where("activity_id = ?", activityID)
  110. }
  111. // dump 的 usable 无显式 ORDER BY;InnoDB 等值/主键扫描等价于主键升序,故 asc 口径与 dump 一致
  112. q = q.Order("id " + dir)
  113. var rows []model.CoursesActivityUserDiscount
  114. if err := q.Find(&rows).Error; err != nil {
  115. return nil, infraerrors.WithCause(infraerrors.ErrDBError, err)
  116. }
  117. return rows, nil
  118. }
  119. // SumUsable 汇总用户可用赠送金额(**对齐 dump `usable` 的 3 参口径**:机构 + 校区 + 用户)。
  120. //
  121. // 入参:
  122. // - ctx 请求上下文;
  123. // - userID 学生(ULID;空 → ErrBadParam);
  124. // - institutionID 机构 ID(原 schoolid;**<=0 = 平台视角:不加任何机构过滤**);
  125. // - campusID 校区 ID(原 campusid;**>0 = 该校区等值**;0 = 不限定校区)。
  126. //
  127. // 出参:
  128. // - money.Amount:可用额度合计(单位:分;无可用行为 0);
  129. // - ErrBadParam / ErrDBError。
  130. //
  131. // 作用域(audit A7,dump `yuansiwei_finance.sql:763182-763183`):
  132. //
  133. // dump 的 usable(schoolid, campusid, userid) 三个条件都是**等值**:`schoolid=? AND campusid=? AND userid=?`,
  134. // 且 schoolid/campusid 传 0 时不参与过滤(平台/机构级汇总视角)。
  135. // - `institutionID > 0` → `institution_id = ?`(等值,**不再用 `IN (?,0)` 超集**——
  136. // 超集会把"机构级池(campus=0)"混进"指定校区可用额",与 dump 差一个池);
  137. // - `campusID > 0` → `campus_id = ?`(等值);
  138. // - `institutionID<=0` → **不加**机构/校区过滤(平台视角,字段语义见下);
  139. // 越权防线**不在本方法**:按裁定移到 Handler 角色白名单(平台视角只对 super_admin/academic 开放)。
  140. //
  141. // 实现说明(金额精度):**不用 SQL SUM()**。sqlite 把 decimal 存 NUMERIC 时 SUM 返回 REAL,
  142. // 会把分位带进浮点;MySQL 返回 DECIMAL(字符串) 虽精确,但两库行为不一致。
  143. // 因此这里只让 DB 做过滤,**逐行在 Go 侧用 money.Amount(int64 分)累加**(用户池行数极小,
  144. // 性能可忽略),换取"零浮点"的确定性。
  145. func (r *ActivityDiscountRepo) SumUsable(ctx context.Context, userID string, institutionID, campusID int64) (money.Amount, error) {
  146. if strings.TrimSpace(userID) == "" {
  147. return 0, infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: SumUsable 需要 user_id"))
  148. }
  149. if institutionID < 0 || campusID < 0 {
  150. return 0, infraerrors.WithCause(infraerrors.ErrBadParam,
  151. errString("repository: SumUsable 机构/校区参数不得为负(0=不筛)"))
  152. }
  153. db, err := r.db(ctx)
  154. if err != nil {
  155. return 0, err
  156. }
  157. q := db.Model(&model.CoursesActivityUserDiscount{}).
  158. Where("user_id = ?", userID).
  159. Where("discount_amount > discount_amount_used")
  160. // dump 763182-763183:机构与校区都是**等值**条件;传 0 视为不筛(平台/机构级汇总视角)
  161. if institutionID > 0 {
  162. q = q.Where("institution_id = ?", institutionID)
  163. }
  164. if campusID > 0 {
  165. q = q.Where("campus_id = ?", campusID)
  166. }
  167. var rows []model.CoursesActivityUserDiscount
  168. if err := q.Find(&rows).Error; err != nil {
  169. return 0, infraerrors.WithCause(infraerrors.ErrDBError, err)
  170. }
  171. total := money.Amount(0)
  172. for i := range rows {
  173. totalAmount, perr := money.Parse(rows[i].DiscountAmount)
  174. if perr != nil {
  175. return 0, infraerrors.WithCause(infraerrors.ErrDBError, perr)
  176. }
  177. usedAmount, perr := money.Parse(rows[i].DiscountAmountUsed)
  178. if perr != nil {
  179. return 0, infraerrors.WithCause(infraerrors.ErrDBError, perr)
  180. }
  181. total = total.Add(totalAmount.Sub(usedAmount))
  182. }
  183. return total, nil
  184. }
  185. // ListDiscountLogsByStudentCourse 按报课记录取**赠送金额退回对象**(audit A11,dump `:763057`)。
  186. //
  187. // 入参:
  188. // - ctx 请求上下文;
  189. // - coursesStudentID 报课记录 ID(t_courses_student.id;<=0 → ErrBadParam)。
  190. //
  191. // 出参:
  192. // - []model.CoursesActivityUserDiscountLog:该报课记录产生的**负值流水**(消费行,`discount_amount_used < 0`),
  193. // 按 id **降序**(最近使用优先,dump 退回路径固定顺序);空结果返回非 nil 切片;
  194. // - ErrBadParam / ErrDBError。
  195. //
  196. // SQL(dump 763057 原文口径 + 多租户作用域 JOIN):
  197. //
  198. // SELECT dlog.* FROM t_courses_activity_user_discount_log dlog
  199. // JOIN t_courses_activity_user_discount pool ON pool.id = dlog.activity_user_discount_id
  200. // WHERE dlog.courses_student_id = ? AND dlog.discount_amount_used < 0
  201. // AND pool.institution_id = ? AND pool.campus_id IN (?, 0) -- 作用域(普通角色)
  202. // ORDER BY dlog.id DESC
  203. //
  204. // 为什么只取负值行:退回时要按"当初扣了多少"逐笔等额回冲,正值行是退回动作本身(不能拿来回冲);
  205. // 排序固定 DESC(dump 无参数化方向)——**本方法不接受方向参数**,从根上消除 ORDER BY 注入面。
  206. //
  207. // 与旧 `ListSignedByStudentCourse` 的区别(audit A11):那条路径(signed ← pool ← log 三表 join)
  208. // **在 dump 中没有任何对应 SP 依据**,已删除;退回对象一律以本方法为准(流水是唯一事实来源)。
  209. func (r *ActivityDiscountRepo) ListDiscountLogsByStudentCourse(ctx context.Context, coursesStudentID int64) ([]model.CoursesActivityUserDiscountLog, error) {
  210. if coursesStudentID <= 0 {
  211. return nil, infraerrors.WithCause(infraerrors.ErrBadParam,
  212. errString("repository: ListDiscountLogsByStudentCourse 需要 courses_student_id"))
  213. }
  214. db, err := r.db(ctx)
  215. if err != nil {
  216. return nil, err
  217. }
  218. rows := make([]model.CoursesActivityUserDiscountLog, 0, 8)
  219. // 流水表**自身无作用域列**(DDL:id/discount/pool_id/courses_student_id/…,无 institution_id),
  220. // 故作用域从"流水 → 池"JOIN 取得(池有 institution_id + campus_id),语义与活动域一致(campus 超集)。
  221. q := db.Table("t_courses_activity_user_discount_log AS dlog").
  222. Select("dlog.*").
  223. Joins("JOIN t_courses_activity_user_discount AS pool ON pool.id = dlog.activity_user_discount_id").
  224. Where("dlog.courses_student_id = ?", coursesStudentID).
  225. Where("dlog.discount_amount_used < 0")
  226. q = scopedCampusRows(q, r.Sc, "pool")
  227. if err := q.Order("dlog.id DESC").Find(&rows).Error; err != nil {
  228. return nil, infraerrors.WithCause(infraerrors.ErrDBError, err)
  229. }
  230. if rows == nil {
  231. rows = make([]model.CoursesActivityUserDiscountLog, 0)
  232. }
  233. return rows, nil
  234. }
  235. // IncUsed 累加优惠账户的「已使用赠送金额」(单账户原子增减)。
  236. //
  237. // 入参:
  238. // - ctx 请求上下文;
  239. // - tx 事务句柄(**必传**);
  240. // - id 优惠账户 ID(<=0 → ErrBadParam);
  241. // - delta 增量(正=消费,负=退回冲正;单位:分;0 → 空操作)。
  242. //
  243. // 出参:
  244. // - int64:受影响行数(0 = 账户不存在/不在作用域内);
  245. // - ErrBadParam / ErrDBError。
  246. //
  247. // 红线:
  248. // - `discount_amount_used <= discount_amount` 的业务约束由 **Service** 在扣减前用可用额校验
  249. // (不足 → 3109),本方法**不做截断**——静默截断会破坏"池余额 = 流水累计"的对账恒等式;
  250. // - 与流水写入(InsertDiscountLog)必须同事务。
  251. func (r *ActivityDiscountRepo) IncUsed(ctx context.Context, tx *gorm.DB, id int64, delta money.Amount) (int64, error) {
  252. if err := requireTx(tx, "IncUsed"); err != nil {
  253. return 0, err
  254. }
  255. if id <= 0 {
  256. return 0, infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: IncUsed 需要 discount id"))
  257. }
  258. if delta.IsZero() {
  259. return 0, nil
  260. }
  261. if err := delta.Validate(); err != nil {
  262. return 0, infraerrors.WithCause(infraerrors.ErrBadParam, err)
  263. }
  264. q := scopedCampusRows(tx.Model(&model.CoursesActivityUserDiscount{}), r.Sc, "")
  265. res := q.Where("id = ?", id).
  266. UpdateColumn("discount_amount_used", gorm.Expr("discount_amount_used + ?", delta.String()))
  267. if res.Error != nil {
  268. return 0, infraerrors.WithCause(infraerrors.ErrDBError, res.Error)
  269. }
  270. return res.RowsAffected, nil
  271. }
  272. // IncUsedBatch 批量累加多个优惠账户的「已使用赠送金额」(**单语句 CASE WHEN**,禁止逐行 UPDATE)。
  273. //
  274. // 入参:
  275. // - ctx 请求上下文;
  276. // - tx 事务句柄(**必传**);
  277. // - items 增量集合(同一 id 出现多次时**后者覆盖前者**;<=0 的 id 与零增量条目被忽略)。
  278. //
  279. // 出参:
  280. // - int64:受影响行数;
  281. // - ErrBadParam / ErrDBError(空集合 → 0, nil,不发 SQL)。
  282. //
  283. // 为什么必须单语句(性能/正确性双约束):
  284. // - 一次跨多个池扣减若逐行 UPDATE,N 个账户 = N 次往返 + N 个独立执行计划;
  285. // - 单语句在事务内原子生效,减少锁持有时间(并发退费场景)。
  286. //
  287. // SQL:
  288. //
  289. // UPDATE t_courses_activity_user_discount
  290. // SET discount_amount_used = discount_amount_used + CASE id WHEN ? THEN ? ... ELSE 0 END
  291. // WHERE id IN (...) [AND institution_id = ? AND campus_id IN (?,0)]
  292. //
  293. // 红线:金额以**字符串**字面量入场(decimal 精确),禁止 float。
  294. func (r *ActivityDiscountRepo) IncUsedBatch(ctx context.Context, tx *gorm.DB, items []UsedDelta) (int64, error) {
  295. if err := requireTx(tx, "IncUsedBatch"); err != nil {
  296. return 0, err
  297. }
  298. // 归一:去重(后者覆盖)+ 过滤非法 id/零增量,保持入参顺序(CASE 分支顺序可预期,便于断言)
  299. order := make([]int64, 0, len(items))
  300. deltaByID := make(map[int64]money.Amount, len(items))
  301. for _, it := range items {
  302. if it.DiscountID <= 0 || it.Delta.IsZero() {
  303. continue
  304. }
  305. if err := it.Delta.Validate(); err != nil {
  306. return 0, infraerrors.WithCause(infraerrors.ErrBadParam, err)
  307. }
  308. if _, ok := deltaByID[it.DiscountID]; !ok {
  309. order = append(order, it.DiscountID)
  310. }
  311. deltaByID[it.DiscountID] = it.Delta
  312. }
  313. if len(order) == 0 {
  314. return 0, nil
  315. }
  316. var sqlText strings.Builder
  317. sqlText.WriteString("discount_amount_used + CASE id")
  318. caseArgs := make([]any, 0, len(order)*2)
  319. for _, id := range order {
  320. sqlText.WriteString(" WHEN ? THEN ?")
  321. caseArgs = append(caseArgs, id, deltaByID[id].String())
  322. }
  323. sqlText.WriteString(" ELSE 0 END")
  324. q := scopedCampusRows(tx.Model(&model.CoursesActivityUserDiscount{}), r.Sc, "")
  325. res := q.Where("id IN ?", order).UpdateColumn("discount_amount_used", gorm.Expr(sqlText.String(), caseArgs...))
  326. if res.Error != nil {
  327. return 0, infraerrors.WithCause(infraerrors.ErrDBError, res.Error)
  328. }
  329. return res.RowsAffected, nil
  330. }
  331. // InsertDiscountLog 写入赠送金额使用/退回流水(**只增**)。
  332. //
  333. // 入参:
  334. // - ctx 请求上下文;
  335. // - tx 事务句柄(**必传**);
  336. // - row 流水行(ActivityUserDiscountID>0;DiscountAmountUsed 负=消费/正=退回)。
  337. //
  338. // 出参:nil 成功;ErrBadParam / ErrDBError。
  339. //
  340. // 红线:流水与池余额变动(IncUsed)必须同事务;流水禁止 UPDATE/DELETE(审计底线)。
  341. func (r *ActivityDiscountRepo) InsertDiscountLog(ctx context.Context, tx *gorm.DB, row *model.CoursesActivityUserDiscountLog) error {
  342. if err := requireTx(tx, "InsertDiscountLog"); err != nil {
  343. return err
  344. }
  345. if row == nil {
  346. return infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: discount log 为 nil"))
  347. }
  348. if row.ActivityUserDiscountID <= 0 {
  349. return infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: discount log 缺少 activity_user_discount_id"))
  350. }
  351. if err := tx.WithContext(ctxOrBackground(ctx)).Create(row).Error; err != nil {
  352. return infraerrors.WithCause(infraerrors.ErrDBError, err)
  353. }
  354. return nil
  355. }
  356. // InsertUsedLog 写入老带新活动金额获得/使用记录(**只增**)。
  357. //
  358. // 入参:
  359. // - ctx 请求上下文;
  360. // - tx 事务句柄(**必传**);
  361. // - row 记录行(ActivityID>0、UserID 非空;老带新结算写**负值** activity_money_used)。
  362. //
  363. // 出参:nil 成功;ErrBadParam / ErrDBError。
  364. //
  365. // 红线:符号方向固定(结算负值);撤销报名前置校验按 (activity_id, user_id) 判存在(3108),
  366. // 故本表写入必须与 signed 状态推进同事务。
  367. func (r *ActivityDiscountRepo) InsertUsedLog(ctx context.Context, tx *gorm.DB, row *model.CoursesActivityUsedLog) error {
  368. if err := requireTx(tx, "InsertUsedLog"); err != nil {
  369. return err
  370. }
  371. if row == nil {
  372. return infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: used log 为 nil"))
  373. }
  374. if row.ActivityID <= 0 || strings.TrimSpace(row.UserID) == "" {
  375. return infraerrors.WithCause(infraerrors.ErrBadParam, errString("repository: used log 缺少 activity_id/user_id"))
  376. }
  377. if err := tx.WithContext(ctxOrBackground(ctx)).Create(row).Error; err != nil {
  378. return infraerrors.WithCause(infraerrors.ErrDBError, err)
  379. }
  380. return nil
  381. }