Files
cmautobuy/admin/service/submit_test.go
T
chengmaandClaude Opus 5 5a5c1f1f68 feat: 新增幂等 Client 登记接口 (#12)
PUT /api/v1/client/registration —— 设置页点"保存"时调用,
只登记客户端,不碰任务。

为什么需要它
原设计"注册就在 claim 里做"有个真问题:设置页保存被迫调 claim,
而 claim 可能真的领到一个任务——Admin 那边已把任务标成 claimed,
Client 必须可靠落库否则任务就丢了。一个"保存设置"的动作
不该承担"领取任务并保证不丢"的责任。这违反了本项目自己的原则
(05 §1:界面上只有一个会产生外部后果的命令)。

实现
- ClientProfileRequest + Validate() 由**登记和领取共用**,
  避免两个入口的结构和校验各写一份、迟早漂移
- 校验:名称 <=50 字(按字符不按字节,中文一个字三字节)、
  supported_types 非空且只含 collect/purchase、platform 只支持 android、
  purchase_mode 必填且只允许 dry_run/live、schema_versions 均为正整数
- 非法内容返回 422 INVALID_CLIENT_PROFILE,错误消息指明具体字段
- UpsertClient 加 explicit 参数区分名称规则:
  显式登记(用户点保存)带非空名称时更新名称;
  隐式登记(claim 顺带)永不更新,否则操作员改的名字会被反复冲掉

已验证(Go 1.23.0)
- 单元测试 40 个全过,含"登记不产生任何任务副作用"的快照比对
- 端到端逐条走完手册 §5.2~5.7:重复登记记录数恒为 1;
  更新/空名称行为正确;插入任务后登记 3 次任务字段完全未变且仍可领取;
  四种非法输入均 422 且不写库;claim 不受影响

一处行为变更需注意
名称归属规则改了:原来是"Admin 操作员永远赢",现在是"最后一次
显式操作赢"——用户在 Client 点保存会覆盖 Admin 侧改的名字。
按 #12 文档实现,已拆成三个独立测试盯住三种情况。

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-06 17:31:38 +08:00

375 lines
12 KiB
Go

package service
import (
"database/sql"
"encoding/json"
"errors"
"sync"
"testing"
"time"
"cmautobuy/admin/model"
"cmautobuy/admin/repository"
)
// claimTask 走一遍完整的领取流程,让 task_claims 里留下记录。
func claimTask(t *testing.T, db *sql.DB, taskID, clientID string) {
t.Helper()
if err := RegisterClient(db, model.Client{ClientID: clientID}, true); err != nil {
t.Fatalf("注册客户端失败: %v", err)
}
task, err := ClaimNextTask(db, clientID, []string{"collect", "purchase"})
if err != nil {
t.Fatalf("领取失败: %v", err)
}
if task == nil || task.TaskID != taskID {
t.Fatalf("期望领到 %s,实际 %v", taskID, task)
}
}
func taskStatus(t *testing.T, db *sql.DB, taskID string) string {
t.Helper()
var s string
if err := db.QueryRow(`SELECT status FROM tasks WHERE task_id = ?`, taskID).Scan(&s); err != nil {
t.Fatalf("查询任务状态失败: %v", err)
}
return s
}
const resultBody = `{"task_version":1,"attempt_id":"a-1","result_type":"purchase",
"completed_at":"2026-08-06T08:03:00Z","pdd_data":{"schema_version":1,"goods":{"goods_id":"1"}}}`
// ── 正常路径 ───────────────────────────────────────────
func TestSubmitResult_成功落库并标记succeeded(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
resp, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody))
if err != nil {
t.Fatalf("提交失败: %v", err)
}
var got map[string]any
if err := json.Unmarshal([]byte(resp), &got); err != nil {
t.Fatalf("响应不是合法 JSON: %v", err)
}
if got["accepted"] != true {
t.Errorf("accepted 应为 true,实际 %v", got["accepted"])
}
if got["result_id"] == "" || got["result_id"] == nil {
t.Error("result_id 不应为空")
}
if s := taskStatus(t, db, "TASK-A"); s != "succeeded" {
t.Errorf("任务状态应为 succeeded,实际 %s", s)
}
}
// ── 幂等 ───────────────────────────────────────────────
func TestSubmitResult_同键同内容返回同一结果(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
first, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody))
if err != nil {
t.Fatalf("首次提交失败: %v", err)
}
second, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody))
if err != nil {
t.Fatalf("重复提交失败: %v", err)
}
if first != second {
t.Errorf("重复提交应返回完全相同的响应:\n第一次 %s\n第二次 %s", first, second)
}
// 而且不能重复落库
var n int
db.QueryRow(`SELECT COUNT(*) FROM idempotency_keys`).Scan(&n)
if n != 1 {
t.Errorf("幂等表应只有 1 条记录,实际 %d", n)
}
}
func TestSubmitResult_同键不同内容返回冲突(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
if _, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody)); err != nil {
t.Fatalf("首次提交失败: %v", err)
}
other := `{"task_version":1,"attempt_id":"a-1","result_type":"purchase","pdd_data":{"不一样":true}}`
_, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(other))
if !errors.Is(err, repository.ErrIdempotencyConflict) {
t.Errorf("期望幂等冲突,实际 %v", err)
}
}
// 并发重复提交:只能落库一次。
func TestSubmitResult_并发同键只处理一次(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
const workers = 6
var wg sync.WaitGroup
var mu sync.Mutex
responses := map[string]int{}
var lastErr error
for i := 0; i < workers; i++ {
wg.Add(1)
go func() {
defer wg.Done()
resp, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody))
mu.Lock()
defer mu.Unlock()
if err != nil {
lastErr = err
return
}
responses[resp]++
}()
}
wg.Wait()
if lastErr != nil {
t.Fatalf("并发提交出错: %v", lastErr)
}
if len(responses) != 1 {
t.Errorf("并发提交应返回同一个响应,实际出现 %d 种", len(responses))
}
var n int
db.QueryRow(`SELECT COUNT(*) FROM idempotency_keys`).Scan(&n)
if n != 1 {
t.Errorf("幂等表应只有 1 条记录,实际 %d", n)
}
}
// ── 无条件接受(本工单最要紧的三条)───────────────────
func TestSubmitResult_任务已取消仍然接受(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
// Admin 侧把任务取消了
if _, err := db.Exec(`UPDATE tasks SET status='cancelled' WHERE task_id='TASK-A'`); err != nil {
t.Fatal(err)
}
// 客户端并不知道,照样提交——必须被接受,
// 因为它可能真的已经在拼多多下过单了,这些数据必须留痕
if _, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody)); err != nil {
t.Fatalf("任务已取消时提交被拒绝了,这违反契约 §4.1: %v", err)
}
if s := taskStatus(t, db, "TASK-A"); s != "succeeded" {
t.Errorf("结果应被记录,状态应为 succeeded,实际 %s", s)
}
}
func TestSubmitResult_任务已重派仍然接受原客户端的结果(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
// 操作员把任务改派给了另一台
if _, err := db.Exec(
`UPDATE tasks SET assigned_client='client-002', status='assigned' WHERE task_id='TASK-A'`,
); err != nil {
t.Fatal(err)
}
// 原来那台还是把结果交上来了 —— 必须接受
if _, err := SubmitResult(db, "TASK-A", "client-001", "key-1", []byte(resultBody)); err != nil {
t.Fatalf("任务已重派时拒绝了原客户端,这违反契约 §4.1: %v", err)
}
}
func TestSubmitResult_同一任务接受多个客户端的多份结果(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
// 重派给第二台,让它也领一次
if _, err := db.Exec(
`UPDATE tasks SET assigned_client='client-002', status='assigned' WHERE task_id='TASK-A'`,
); err != nil {
t.Fatal(err)
}
claimTask(t, db, "TASK-A", "client-002")
// 两台都提交,用各自的幂等键
if _, err := SubmitResult(db, "TASK-A", "client-001", "key-c1", []byte(resultBody)); err != nil {
t.Fatalf("client-001 提交被拒: %v", err)
}
if _, err := SubmitResult(db, "TASK-A", "client-002", "key-c2", []byte(resultBody)); err != nil {
t.Fatalf("client-002 提交被拒: %v", err)
}
var n int
db.QueryRow(`SELECT COUNT(*) FROM idempotency_keys`).Scan(&n)
if n != 2 {
t.Errorf("两份结果应各留一条幂等记录,实际 %d", n)
}
}
// ── 唯一该拒绝的情况 ───────────────────────────────────
func TestSubmitResult_从没领过的客户端被拒绝(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
_, err := SubmitResult(db, "TASK-A", "client-999", "key-x", []byte(resultBody))
if !errors.Is(err, ErrNeverClaimed) {
t.Errorf("从没领过的客户端应被拒绝,实际 %v", err)
}
}
func TestSubmitResult_任务不存在(t *testing.T) {
db := newTestDB(t)
_, err := SubmitResult(db, "TASK-NOPE", "client-001", "key-x", []byte(resultBody))
if !errors.Is(err, ErrTaskNotFound) {
t.Errorf("期望任务不存在错误,实际 %v", err)
}
}
// ── 采集任务的结果要落到商品级 ─────────────────────────
func TestSubmitResult_采集结果写入商品级(t *testing.T) {
db := newTestDB(t)
now := model.NowISO()
if _, err := db.Exec(`
INSERT INTO shopee_products (goods_id, title, pdd_goods_url,
collect_status, created_at, updated_at)
VALUES ('G-1','测试商品','https://x/1','collecting',?,?)`, now, now); err != nil {
t.Fatal(err)
}
if _, err := db.Exec(`
INSERT INTO tasks (task_id, task_type, status, assigned_client, goods_id,
pdd_goods_url, created_at, updated_at)
VALUES ('TASK-C','collect','assigned','client-001','G-1','https://x/1',?,?)`,
now, now); err != nil {
t.Fatal(err)
}
claimTask(t, db, "TASK-C", "client-001")
body := `{"task_version":1,"attempt_id":"a-1","result_type":"collect","pdd_data":{"schema_version":1,"skus":[]}}`
if _, err := SubmitResult(db, "TASK-C", "client-001", "key-c", []byte(body)); err != nil {
t.Fatalf("提交采集结果失败: %v", err)
}
var status, data string
if err := db.QueryRow(
`SELECT collect_status, COALESCE(pdd_data,'') FROM shopee_products WHERE goods_id='G-1'`,
).Scan(&status, &data); err != nil {
t.Fatal(err)
}
if status != "collected" {
t.Errorf("采集状态应为 collected,实际 %s", status)
}
if data == "" {
t.Error("pdd_data 应被写入商品级,实际为空")
}
}
// ── 提交失败 ───────────────────────────────────────────
func TestSubmitFailure_状态映射(t *testing.T) {
cases := []struct {
reported string
want string
}{
{"retry_wait", "assigned"}, // 放回去等它再来领
{"manual_review", "manual_review"},
{"failed", "failed"},
{"cancelled", "cancelled"},
}
for _, tc := range cases {
t.Run(tc.reported, func(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
body := `{"task_version":1,"attempt_id":"a-1","status":"` + tc.reported +
`","error":{"code":"PDD_PAGE_TIMEOUT","message":"页面超时"}}`
if _, err := SubmitFailure(db, "TASK-A", "client-001", "k", []byte(body)); err != nil {
t.Fatalf("提交失败结果出错: %v", err)
}
if s := taskStatus(t, db, "TASK-A"); s != tc.want {
t.Errorf("%s 应映射为 %s,实际 %s", tc.reported, tc.want, s)
}
})
}
}
func TestSubmitFailure_非法状态被拒绝(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
body := `{"attempt_id":"a-1","status":"succeeded"}`
if _, err := SubmitFailure(db, "TASK-A", "client-001", "k", []byte(body)); err == nil {
t.Error("失败接口不该接受 succeeded 这种状态")
}
}
func TestSubmitFailure_采集失败写回商品级(t *testing.T) {
db := newTestDB(t)
now := model.NowISO()
db.Exec(`INSERT INTO shopee_products (goods_id,title,collect_status,created_at,updated_at)
VALUES ('G-1','测试商品','collecting',?,?)`, now, now)
db.Exec(`INSERT INTO tasks (task_id,task_type,status,assigned_client,goods_id,
pdd_goods_url,created_at,updated_at)
VALUES ('TASK-C','collect','assigned','client-001','G-1','https://x/1',?,?)`, now, now)
claimTask(t, db, "TASK-C", "client-001")
body := `{"attempt_id":"a-1","status":"failed",
"error":{"code":"PDD_PAGE_TIMEOUT","message":"商品页加载超时"}}`
if _, err := SubmitFailure(db, "TASK-C", "client-001", "k", []byte(body)); err != nil {
t.Fatalf("提交失败: %v", err)
}
var status, errMsg string
db.QueryRow(`SELECT collect_status, COALESCE(collect_error,'')
FROM shopee_products WHERE goods_id='G-1'`).Scan(&status, &errMsg)
if status != "failed" {
t.Errorf("采集状态应为 failed,实际 %s", status)
}
if errMsg == "" {
t.Error("失败原因应写入 collect_error,否则操作员看不到为什么采不到")
}
}
// ── 活动时间 ───────────────────────────────────────────
func TestSubmit_刷新客户端活动时间(t *testing.T) {
db := newTestDB(t)
insertTask(t, db, "TASK-A", "client-001")
claimTask(t, db, "TASK-A", "client-001")
// 把客户端改成很久没活动
db.Exec(`UPDATE clients SET last_seen_at='2020-01-01T00:00:00Z' WHERE client_id='client-001'`)
views, _ := ListClientViews(db, "", 10*time.Minute)
if views[0].Status != "离线" {
t.Fatalf("前置条件不对,应为离线")
}
if _, err := SubmitResult(db, "TASK-A", "client-001", "k", []byte(resultBody)); err != nil {
t.Fatalf("提交失败: %v", err)
}
views, _ = ListClientViews(db, "", 10*time.Minute)
if views[0].Status != "在线" {
t.Error("提交结果后应刷新活动时间——只在 claim 里刷新的话," +
"客户端执行长任务期间会被误判成离线")
}
}