Skip to content

todolist.md

Latest commit

 

History

History
191 lines (143 loc) · 4.92 KB

todolist.md

File metadata and controls

191 lines (143 loc) · 4.92 KB

Litefs 框架开发任务清单

当前版本: v0.8.0
目标版本: v0.9.0
更新日期: 2025-04-18

已完成任务

v0.8.0 及之前版本

任务 状态 完成日期 说明
WebSocket 支持 ✅ 完成 2024-Q1 实时通信、房间管理、心跳检测
Celery 任务队列 ✅ 完成 2024-Q1 异步任务、定时任务、健康检查
JWT 认证系统 ✅ 完成 2024-Q1 Token 生成/验证、权限装饰器
缓存系统 ✅ 完成 2024-Q1 Redis/Memcache/数据库缓存
数据库支持 ✅ 完成 2024-Q1 连接池、ORM 集成
调试工具 ✅ 完成 2024-Q1 请求检查、SQL 日志、性能分析
CORS 中间件 ✅ 完成 2024-Q1 跨域资源共享
CSRF 中间件 ✅ 完成 2024-Q1 CSRF Token 保护
限流中间件 ✅ 完成 2024-Q1 请求频率限制
安全头部中间件 ✅ 完成 2024-Q1 HTTP 安全头部
OpenAPI 文档 ✅ 完成 2024-Q1 Swagger UI 集成
插件系统 ✅ 完成 2024-Q1 生命周期管理
会话管理 ✅ 完成 2024-Q1 多后端存储
示例精简 ✅ 完成 2025-04 从 20 个精简到 5 个综合示例

v0.8.0 开发任务

架构说明: HTTPS 支持不在计划内，生产环境建议通过 Nginx/HAProxy 等反向代理处理 SSL 终止。

高优先级

任务 状态 预计工作量 负责人 说明
OAuth2 认证增强 🔲 待开始 5-6 天 - GitHub/Google/微信登录
Prometheus 监控指标 🔲 待开始 3-4 天 - 请求计数、延迟、错误率

中优先级

任务 状态 预计工作量 负责人 说明
数据库迁移工具 🔲 待开始 4-5 天 - Alembic 集成、CLI 命令
邮件发送支持 🔲 待开始 3-4 天 - SMTP、模板邮件、异步发送

低优先级

任务 状态 预计工作量 负责人 说明
i18n 国际化 🔲 待开始 4-5 天 - 多语言支持
类型注解完善 🔲 待开始 持续 - 核心模块类型提示
测试覆盖率提升 🔲 待开始 持续 - 目标 85%+

详细任务分解

1. OAuth2 认证增强

子任务:

  • OAuth2 基础框架
  • GitHub Provider
  • Google Provider
  • 微信 Provider
  • 企业微信 Provider
  • 用户身份映射
  • Token 刷新机制
  • 单元测试
  • 文档更新

技术要点:

  • 授权码流程
  • State 参数安全验证
  • PKCE 扩展支持

2. Prometheus 监控指标

子任务:

  • PrometheusMiddleware 实现
  • 请求指标（计数、延迟、错误）
  • 数据库连接池指标
  • 缓存命中率指标
  • 自定义指标接口
  • /metrics 端点
  • 文档更新

技术要点:

  • prometheus_client 库集成
  • Histogram buckets 配置
  • 标签设计

3. 数据库迁移工具

子任务:

  • Alembic 集成封装
  • 自动迁移脚本生成
  • CLI db 子命令
  • 多环境配置
  • 回滚支持
  • 文档更新

CLI 命令:

litefs db init          # 初始化迁移
litefs db migrate       # 生成迁移
litefs db upgrade       # 升级数据库
litefs db downgrade     # 回滚数据库
litefs db current       # 当前版本
litefs db history       # 迁移历史

4. 邮件发送支持

子任务:

  • SMTP 配置封装
  • Message 类实现
  • 模板邮件支持
  • 附件支持
  • 异步发送（Celery 集成）
  • 文档更新

技术要点:

  • 使用 smtplib 标准库
  • Jinja2 模板渲染
  • 与 Celery 任务队列集成

技术债务

项目 优先级 状态 说明
类型注解完善 中 🔲 待开始 核心模块添加类型提示
测试覆盖率 中 🔲 待开始 当前约 60%，目标 85%+
性能基准测试 低 🔲 待开始 建立性能回归测试
文档完善 中 🔲 待开始 API 文档覆盖率 100%

版本里程碑

v0.8.0-alpha (第 1 周末)

  • OAuth2 基础框架

v0.8.0-beta (第 2 周末)

  • OAuth2 完整实现
  • Prometheus 指标

v0.8.0-rc (第 3 周末)

  • 数据库迁移工具
  • 邮件发送支持
  • 集成测试完成

v0.8.0 (第 4 周末)

  • 正式发布
  • 文档完善
  • 示例更新

风险与阻塞

风险 影响 缓解措施 状态
OAuth2 提供商 API 变更 高 抽象层隔离 监控中
邮件模板兼容性 低 使用 Jinja2 已规划
测试环境依赖 低 Mock 服务 已准备

备注

  • 所有新功能需编写单元测试
  • 文档同步更新
  • 遵循语义化版本控制
  • 保持向后兼容性

下次更新: 每周五评审
文档维护: 开发团队