This commit is contained in:
53
openspec/changes/add-polling-priority-queue/proposal.md
Normal file
53
openspec/changes/add-polling-priority-queue/proposal.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Change: 新增轮询管理 - 优先队列 API 前端对接(列表 + 人工优先入队 + 单项详情)
|
||||
|
||||
## Why
|
||||
|
||||
根据 `docs/产品迭代8月份/优先队列.md`。后端测试环境(`https://cmp-api.boss160.cn`,`Authorization: Bearer <token>`)已提供「轮询管理 - 优先队列」能力:
|
||||
|
||||
- 查询优先轮询项列表:`GET /api/admin/polling-priority-items`
|
||||
- 人工优先入队:`POST /api/admin/polling-priority-items`
|
||||
- 查询优先轮询项详情:`GET /api/admin/polling-priority-items/{id}`
|
||||
|
||||
该能力服务于:
|
||||
1. 查询优先轮询项:分页查询卡轮询优先项,按创建时间倒序,支持卡 `card_id`、任务类型 `task_type`、状态 `status`、触发类型 `trigger_type` 筛选;数据范围按卡所属店铺快照下推:代理只能看到自身及下级店铺资产,平台卡不可见。
|
||||
2. 人工优先入队:为该卡的全部纳入轮询任务类型(实名/流量/套餐/卡状态)建立或合并优先轮询项,原因必填(最长 500 字符)。`不受` 既有人工触发的每日次数上限与 24 小时去重约束;`不修改` 调度优先级,也 `不绕过` 既有并发上限。
|
||||
3. 查询优先轮询项详情:查询单条卡轮询优先项,越权与不存在返回同一响应,不产生可枚举差异,`不提供` 优先级分级、有效期与人工重触发入口。
|
||||
|
||||
## What Changes
|
||||
|
||||
- 新增能力 `polling-priority-queue`,提供:
|
||||
- 优先轮询项列表:
|
||||
- 分页:`GET /api/admin/polling-priority-items`,按创建时间倒序;
|
||||
- 筛选:卡 `card_id`、任务类型 `task_type`、状态 `status`(`pending/processing/completed/failed`)、触发类型 `trigger_type`(含 `manual_trigger` 人工入队);
|
||||
- 列表项字段:`id`/`card_id`/`iccid`/`task_type(_name)`/`status(_name)`/`trigger_type(_name)`/`trigger_types`/`trigger_count`/`attempt_count`/`result(_name)`/`failure_reason`/`shop_id_snapshot`/`source_order_id`/`source_package_usage_id`/`manual_operator_id(_name)`/`manual_reason`/`claimed_at`/`last_triggered_at`/`created_at`/`updated_at`;
|
||||
- 人工优先入队:`POST /api/admin/polling-priority-items`:
|
||||
- 请求 `{card_id, reason}`,`reason` 必填、最长 500 字符;
|
||||
- 语义:为该卡的全部纳入轮询任务类型(实名/流量/套餐/卡状态)建立或合并优先轮询项;
|
||||
- 约束:同一卡同一任务类型至多一条活动项,重复入队合并 `trigger_count` 与来源集合;
|
||||
- 边界:`不受` 既有人工触发的每日次数上限与 24 小时去重约束;
|
||||
- 边界:`不修改` 调度优先级,也 `不绕过` 既有并发上限;
|
||||
- 响应:`{card_id, created_count, merged_count, task_types, task_type_names, items[{item_id, task_type(_name), status(_name), trigger_count, created, last_triggered_at}]`
|
||||
- 优先轮询项详情:`GET /api/admin/polling-priority-items/{id}`:
|
||||
- 越权与不存在返回同一响应,不产生可枚举差异;
|
||||
- `不提供` 优先级分级、有效期与人工重触发入口。
|
||||
- 任务类型 `task_type`:`polling:realname` 实名检查 / `polling:carddata` 流量检查 / `polling:package` 套餐检查 / `polling:card_status` 卡状态检查。
|
||||
- 状态 `status`:`pending` 待执行 / `processing` 执行中 / `completed` 已完成 / `failed` 失败出队。
|
||||
- 触发类型 `trigger_type`:`purchase_activated` 主套餐购买后立即生效 / `renewal_activated` 续购套餐生效 / `queue_activated` 排队主套餐顺延生效 / `addon_activated` 加油包生效 / `no_valid_package` 资产无有效套餐 / `manual_trigger` 人工入队。
|
||||
- 执行结果 `result`:`success` 成功 / `failed` 失败 / 空值表示未出结果。
|
||||
- 错误响应:`400` 请求参数错误 / `401` 未认证或认证已过期 / `403` 无权访问 / `500` 服务器内部错误。
|
||||
|
||||
## Impact
|
||||
|
||||
- Affected specs:
|
||||
- `polling-priority-queue` — 新增能力
|
||||
- Affected code:
|
||||
- `src/api/modules/pollingPriorityQueue.ts`(新增)
|
||||
- `src/api/modules/index.ts`
|
||||
- `src/types/api/pollingPriorityQueue.ts`(新增)
|
||||
- `src/types/api/index.ts`
|
||||
- `src/config/constants/augustIteration.ts`
|
||||
- `src/views/polling-management/priority-queue/index.vue`(新增)
|
||||
- `src/router/routesAlias.ts`
|
||||
- `src/router/routes/asyncRoutes.ts`
|
||||
- `src/locales/langs/zh.json`
|
||||
- `src/locales/langs/en.json`
|
||||
@@ -0,0 +1,79 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: 优先轮询项列表
|
||||
|
||||
The admin frontend SHALL provide a paginated list of card polling priority items through `GET /api/admin/polling-priority-items`. The query SHALL support `page`(默认 1,最小 1)、`page_size`(默认 20,最大 100)以及筛选参数 `card_id`、`task_type`、`status`、`trigger_type`,并按创建时间倒序返回。
|
||||
|
||||
#### Scenario: 分页查询优先轮询项
|
||||
|
||||
- **WHEN** 用户进入优先队列页面或提交筛选条件
|
||||
- **THEN** 前端 MUST 调用 `GET /api/admin/polling-priority-items`
|
||||
- **AND** 携带 `page`、`page_size` 及所选筛选参数
|
||||
- **AND** 页面 MUST 使用响应中的 `data.items`、`data.page`、`data.size` 和 `data.total` 渲染列表
|
||||
|
||||
#### Scenario: 数据范围下推
|
||||
|
||||
- **WHEN** 当前登录账号为代理
|
||||
- **THEN** 列表 MUST 只返回自身及下级店铺资产对应的优先轮询项
|
||||
- **AND** 平台卡对应的优先轮询项 MUST NOT 出现在列表中
|
||||
|
||||
### Requirement: 人工优先入队
|
||||
|
||||
The admin frontend SHALL enqueue a card for priority polling through `POST /api/admin/polling-priority-items` with request body `{ card_id, reason }`. The `reason` SHALL be required and no longer than 500 characters. The operation SHALL create or merge priority items for all in-scope polling task types(实名/流量/套餐/卡状态)of the card. The frontend SHALL NOT apply any existing manual daily quota or 24-hour deduplication constraints, SHALL NOT modify scheduling priority, and SHALL NOT bypass existing concurrency limits.
|
||||
|
||||
#### Scenario: 人工入队成功
|
||||
|
||||
- **WHEN** 用户填写卡号与原因并提交人工入队
|
||||
- **THEN** 前端 MUST 调用 `POST /api/admin/polling-priority-items`
|
||||
- **AND** 请求体为 `{ "card_id": 卡ID, "reason": "加急原因" }`
|
||||
- **AND** 页面 MUST 展示响应中的 `created_count`、`merged_count`、`task_types`、`task_type_names` 与 `items`
|
||||
|
||||
#### Scenario: 重复入队合并
|
||||
|
||||
- **WHEN** 同一卡同一任务类型已存在活动优先轮询项且再次入队
|
||||
- **THEN** 该卡该任务类型至多保持一条活动项
|
||||
- **AND** 响应 MUST 返回合并后的项并将该次入队计入 `trigger_count`
|
||||
|
||||
#### Scenario: 原因校验
|
||||
|
||||
- **WHEN** `reason` 为空或超过 500 字符
|
||||
- **THEN** 前端 MUST 阻止提交并给出校验提示
|
||||
|
||||
### Requirement: 优先轮询项详情
|
||||
|
||||
The admin frontend SHALL query a single priority polling item through `GET /api/admin/polling-priority-items/{id}`. 越权与不存在的响应 MUST 保持一致,不产生可枚举差异。该能力 SHALL NOT 提供优先级分级、有效期与人工重触发入口。
|
||||
|
||||
#### Scenario: 查询单项详情
|
||||
|
||||
- **WHEN** 用户查看某条优先轮询项详情
|
||||
- **THEN** 前端 MUST 调用 `GET /api/admin/polling-priority-items/{id}`
|
||||
- **AND** 页面 MUST 展示卡、任务类型、状态、触发类型、执行结果、失败原因、操作者、触发与尝试次数及相关时间字段
|
||||
|
||||
#### Scenario: 越权与不存在不区分
|
||||
|
||||
- **WHEN** 当前账号无权访问该记录或该记录不存在
|
||||
- **THEN** 前端 MUST 按同一错误处理,不得通过响应差异区分越权与不存在
|
||||
|
||||
### Requirement: 枚举与状态映射
|
||||
|
||||
The admin frontend SHALL map and display the backend enums for task type, status, trigger type and result with their Chinese labels.
|
||||
|
||||
#### Scenario: 任务类型展示
|
||||
|
||||
- **WHEN** 列表返回 `task_type` 为 `polling:realname` / `polling:carddata` / `polling:package` / `polling:card_status`
|
||||
- **THEN** 页面 MUST 分别展示为 实名检查 / 流量检查 / 套餐检查 / 卡状态检查
|
||||
|
||||
#### Scenario: 状态与触发类型展示
|
||||
|
||||
- **WHEN** 列表返回 `status`(`pending`/`processing`/`completed`/`failed`)、`trigger_type`(`purchase_activated`/`renewal_activated`/`queue_activated`/`addon_activated`/`no_valid_package`/`manual_trigger`)与 `result`(`success`/`failed`/空)
|
||||
- **THEN** 页面 MUST 展示对应的中文名称与枚举值
|
||||
- **AND** `result` 为空时 MUST 展示为未出结果
|
||||
|
||||
### Requirement: 错误响应处理
|
||||
|
||||
The admin frontend SHALL handle the documented error responses for the priority queue APIs: `400` 请求参数错误、`401` 未认证或认证已过期、`403` 无权访问、`500` 服务器内部错误。
|
||||
|
||||
#### Scenario: 权限与参数错误提示
|
||||
|
||||
- **WHEN** 接口返回 `401`、`403` 或参数校验错误
|
||||
- **THEN** 页面 MUST 展示对应错误提示且不产生前端异常
|
||||
30
openspec/changes/add-polling-priority-queue/tasks.md
Normal file
30
openspec/changes/add-polling-priority-queue/tasks.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Tasks: 轮询管理 - 优先队列
|
||||
|
||||
## 1. 类型
|
||||
- [ ] 1.1 新增 `src/types/api/pollingPriorityQueue.ts`:优先轮询项 `PollingPriorityItem`(`id` / `card_id` / `iccid` / `task_type` / `task_type_name` / `status` / `status_name` / `trigger_type` / `trigger_type_name` / `trigger_types` / `trigger_count` / `attempt_count` / `result` / `result_name` / `failure_reason` / `shop_id_snapshot` / `source_order_id` / `source_package_usage_id` / `manual_operator_id` / `manual_operator_name` / `manual_reason` / `claimed_at` / `last_triggered_at` / `created_at` / `updated_at`)
|
||||
- [ ] 1.2 查询参数、分页响应 `PollingPriorityItemPageResult`、人工入队请求/响应、入队项 `PriorityItemResult` 类型
|
||||
- [ ] 1.3 `src/types/api/index.ts` 导出新类型
|
||||
|
||||
## 2. API
|
||||
- [ ] 2.1 新增 `src/api/modules/pollingPriorityQueue.ts`:
|
||||
- `getPriorityItems`:`GET /api/admin/polling-priority-items`,分页查询卡轮询优先项,按创建时间倒序,支持卡 `card_id`、任务类型 `task_type`、状态 `status`、触发类型 `trigger_type` 筛选
|
||||
- `createPriorityItems`:`POST /api/admin/polling-priority-items`,人工优先入队,请求 `{ card_id, reason }`
|
||||
- `getPriorityItemDetail`:`GET /api/admin/polling-priority-items/{id}`,查询单项详情
|
||||
- [ ] 2.2 `src/api/modules/index.ts` 导出新服务
|
||||
|
||||
## 3. 页面
|
||||
- [ ] 3.1 `src/router/routesAlias.ts` 新增优先队列路由别名,`src/router/routes/asyncRoutes.ts` 在轮询管理下注册路由与菜单
|
||||
- [ ] 3.2 新增 `src/views/polling-management/priority-queue/index.vue`:筛选(卡/任务类型/状态/触发类型)、分页、表格展示列表项字段
|
||||
- [ ] 3.3 实现任务类型、状态、触发类型、执行结果枚举映射与中文展示
|
||||
- [ ] 3.4 实现人工优先入队弹窗:选择卡、原因必填校验(最长 500 字符),提交后展示 created_count / merged_count / items
|
||||
- [ ] 3.5 实现单项详情查看(页面或抽屉),越权与不存在按同一错误处理
|
||||
|
||||
## 4. 常量与文案
|
||||
- [ ] 4.1 在 `src/config/constants/augustIteration.ts`(或新增常量文件)登记任务类型/状态/触发类型/结果枚举与中文名称
|
||||
- [ ] 4.2 `src/locales/langs/zh.json`、`src/locales/langs/en.json` 补充菜单与页面文案
|
||||
|
||||
## 5. Verification
|
||||
- [ ] 5.1 验证筛选与分页参数正确传递、列表按创建时间倒序
|
||||
- [ ] 5.2 验证人工入队成功/合并/原因校验(空与超长)
|
||||
- [ ] 5.3 验证详情接口与越权/不存在不区分
|
||||
- [ ] 5.4 运行 lint、类型检查与构建
|
||||
Reference in New Issue
Block a user