activity_discount_repo.go 18 KB

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