Files
wecom_it_smart_desk/docs/07-项目管理/任务说明书/任务说明书-89-P0-5-WS全字段透传.md
T

94 lines
2.7 KiB
Markdown
Raw Normal View History

# 任务说明书 — P0-5 WS new_message 前端全字段透传
> **版本**: v1.0 | **日期**: 2026-07-17
---
## 📋 基本信息
| 项目 | 内容 |
|------|------|
| **任务名称** | P0-5 修复 WS new_message 前端白名单丢字段(坐席图片/文件 H5 不渲染) |
| **任务ID** | #89 |
| **优先级** | 🔴 P0 |
| **类型** | Bug修复 |
| **状态** | 待开始 |
| **负责人** | 宋献 |
| **创建日期** | 2026-07-17 |
| **计划完成日期** | 2026-07-18 |
---
## 📥 输入项来源
### 问题证据(F3P0 Bug
| 来源 | 说明 |
|------|------|
| `backend/app/api/messages.py:278` | 后端 WS 已下发全量 MessageResponse(含 media_url/file_name/file_size/extra_data |
| `frontend-h5/src/stores/conversation.ts:395-429` | `handleNewMessage()` 白名单**只取 7 个字段**,丢弃 media_url/file_name/file_size/extra_data/reply_to_id |
| 结果 | 坐席端发的图片/文件经 WS 到达 H5 时**无法渲染**(WS 在线时轮询已停,不刷新页面就无法恢复) |
### 技术文档
| 来源文档 | 说明 |
|----------|------|
| `docs/02-技术文档/重构记录/00-v4.0重构总方案.md` | D4 决策(WS 契约单点化前半段) |
---
## 📤 输出成果要求
### 交付物清单
| # | 交付物 | 类型 | 说明 |
|---|--------|------|------|
| 1 | `stores/conversation.ts` `handleNewMessage()` | 代码 | 全字段透传:media_url/file_name/file_size/extra_data/reply_to_id 一并写入 messagescreated_at 用服务端值而非 `new Date()` |
| 2 | `api/conversation.ts` Message 类型 | 代码 | 补全可选字段声明(media_url/file_name/file_size/extra_data/reply_to_id |
### 部署顺序
- **前端可先发**:旧前端收到新字段会忽略,向后兼容,零风险
---
## 🔧 验证方式
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| 坐席发图片 | 坐席端发图片,H5 不刷新 | WS 实时渲染缩略图 |
| 坐席发文件 | 坐席端发文件,H5 不刷新 | WS 实时渲染文件卡片(可下载) |
| 多参与者场景 | 群聊中坐席发图 | 所有 H5 参与者实时渲染 |
---
## ✅ 完成标准
- [ ] handleNewMessage 全字段透传
- [ ] Message 类型补全
- [ ] 构建部署,坐席图片/文件实时渲染验证
- [ ] 状态看板已更新
---
## 📊 工作分解
| 子任务 | 预估工时 | 状态 |
|--------|----------|------|
| Message 类型补全 + handleNewMessage 改造 | 40min | ⬜ |
| 构建部署 + 坐席图片/文件验证 | 30min | ⬜ |
---
## 📞 依赖与阻塞
| 依赖 | 说明 | 状态 |
|------|------|------|
| 无 | 独立任务,前端先发 | — |
---
## 📈 变更记录
| 日期 | 变更内容 | 变更人 |
|------|----------|--------|
| 2026-07-17 | 创建任务 | 宋献 |