Skip to content

CHANGELOG.md

Latest commit

 

History

History
186 lines (149 loc) · 11.2 KB

CHANGELOG.md

File metadata and controls

186 lines (149 loc) · 11.2 KB
Raw

Changelog

本文件记录 IMBoy 作为标准 SKU 对外发布的版本变更。 格式遵循 Keep a Changelog，版本号遵循 Semantic Versioning。

工作区包含三个可独立发布的子项目（imboy 后端、imboyapp 客户端、imboy-admin-frontend 管理后台）。 1.0.0 起版本号在 workspace 层统一管理，以根目录 VERSION 文件为权威。 子项目各自的内部小版本（如 backend 0.7.x、app 0.8.x）保留在各自仓库的 CHANGELOG 中。

Unreleased — 1.0.0-alpha.46 公测线

Changed

imboy（部署 / Deploy）

  • 生产反向代理从 Caddy 迁移到 nginx（nginx:1.27-alpine）+ certbot（certbot/certbot 自动签发/续期 Let's Encrypt）；首次部署执行一次 bash nginx/init-letsencrypt.sh 签发证书，.env 新增 CERTBOT_EMAIL；deploy/caddy/Caddyfile 已删除
    • Migrated the production reverse proxy from Caddy to nginx (nginx:1.27-alpine) + certbot (certbot/certbot, automatic Let's Encrypt issuance/renewal); run bash nginx/init-letsencrypt.sh once on first deploy to issue certificates; added CERTBOT_EMAIL to .env; removed deploy/caddy/Caddyfile

Fixed

imboy（后端 / Backend）

  • imboy/api/openapi.yaml：redocly content warnings 17→0（commit 607d943，2026-05-09）
    • 8 个 endpoint 补 '4XX' 错误响应（复用 Envelope schema，不新建 ApiError）
    • 4 个 operation descriptions + 4 个 param descriptions
    • server URL localhost → 127.0.0.1（绕过 redocly no-server-example.com 规则）
    • imboy/api/openapi.yaml: redocly content warnings 17→0 (commit 607d943, 2026-05-09)
    • 8 endpoints add '4XX' error responses (reusing Envelope schema)
    • 4 operation descriptions + 4 param descriptions
    • server URL localhost → 127.0.0.1 (bypass redocly no-server-example.com rule)
  • imboy/docs/CONVENTIONS.md §4：移除对 components.schemas.ErrorCode（已不存在）的陈旧引用，统一指向 include/error_code.hrl 宏（2026-05-12）
    • imboy/docs/CONVENTIONS.md §4: removed stale reference to components.schemas.ErrorCode; now points to include/error_code.hrl macros (2026-05-12)

imboy-admin-frontend（管理后台 / Admin Frontend）

  • TSID 类型债清零：custom/admin-tsid-numeric-misuse 规则 38 findings → 0（commit f7c930c，2026-05-09）
    • TSID type debt eliminated: custom/admin-tsid-numeric-misuse 38 findings → 0 (commit f7c930c, 2026-05-09)
  • src/lib/entityId.ts 抽取：将分散在 3 处的 coerceEntityId / coerceFeedbackId helper 统一为单一导出函数，fallback 参数支持哨兵值（2026-05-12）
    • src/lib/entityId.ts extracted: unified 3 scattered coerceEntityId / coerceFeedbackId helpers into a single exported function with fallback parameter for sentinel values (2026-05-12)

1.0.0-alpha.x - 2026-04 ~ 2026-08（公测线）

公测线持续交付。以下内容在 alpha 公测期间持续落地，尚未发布 rc.1 / 1.0.0 GA。 alpha → 1.0.0 的升级步骤见 docs/guides/operations/upgrade-runbook.md（草案）。

Added

治理与 CI/CD

  • G1 三端 CI 流水线：.github/workflows/ci.yml（DCO / backend / admin / app 四 job，cancel-in-progress）
  • G1 发版流水线：.github/workflows/release.yml（tag v* 触发，产物：Erlang tarball / bun build / Flutter APK）
  • G1 CodeQL 安全扫描：.github/workflows/codeql.yml（每周 + push，javascript-typescript security-extended）
  • G4 Dependabot：.github/dependabot.yml（npm / pub / github-actions 三路每周自动更新 PR）
  • G4 Trivy SARIF 扫描 + SBOM 生成：.github/workflows/security.yml
  • G5 Prometheus SLO 告警规则：deploy/prometheus/rules/imboy-alerts.yml（13 条规则：可用性 / p99 延迟 / 错误率 / Erlang VM / PG）
  • G6 ROADMAP.md（CE 1.0 / EE 1.x / 2.x 长期路线图）
  • G6 SUPPORT.md（社区支持渠道 + 响应时间表）
  • G6 README.en.md（英文镜像，与 README.md 同步维护）
  • G7 DCO sign-off 强制校验（timarcher/dco-action@v1，每个 PR commit 必须含 Signed-off-by）
  • CONTRIBUTING.md 贡献者协议章节（DCO 说明 + git commit -s 示例 + 批量补签命令）

交付层

  • S1 brand/ 品牌资源目录（logo / icon / tokens.json / 使用规范）
  • S2 script/seed_demo.sh — 幂等 demo 数据灌库（5 用户 / 2 群 / 群成员）
  • S3 Grafana + Prometheus 可观测性包（9-panel 总览面板 + 自动装配）
  • S4 imboy/doc/operations/upgrade-runbook.md — 完整升级剧本（relup / cold restart / PITR 回滚）
  • S5 imboy/doc/api/openapi.yaml — OpenAPI 3.1.0 扩充至 21 个稳定端点，含群作业 7 端点 + Group/GroupTask schema

测试覆盖

  • 群作业（group_task）集成测试三端全覆盖：
    • Erlang CT：imboy/test/ct/group_task_SUITE.erl（13 用例，真实 PostgreSQL 完整生命周期）
    • Flutter 组件测试：imboyapp/test/widget/group_task_page_test.dart（9 用例，FakeGroupTaskService）
    • Admin Playwright E2E：imboy-admin-frontend/tests/e2e/group-task.spec.ts（page.route() 拦截）
  • CI 三端测试步骤同步串联（CT / widget test / Playwright E2E）

Changed

  • README.md 增加语言切换链接 简体中文 | English，文档表格补充 ROADMAP / SUPPORT 入口
  • CONTRIBUTING.md 顶部增加 DCO 贡献者协议章节

Known gaps（延至 1.0.x）

  • 生产 Sentry DSN 注入流程文档化（文档齐全，需 opt-in）
  • iOS 上架流程（依赖开发者账户就位）
  • 单机百万连接可复现性能白皮书
  • docs-site VitePress 文档站

Highlights（alpha 线核心交付）

🔒 安全底座（Phase 1-2 CRITICAL / HIGH 共 12 步）

  • SQLCipher 加密本地数据库（客户端落地消息全加密）
  • PostgreSQL 凭据轮换 + 环境变量迁移 + 权限分离（imboy_user / imboy_app）
  • WAL 归档与 PITR 备份剧本（imboy/doc/operations/deployment/BACKUP-RESTORE.md）
  • Token 过期逻辑修复（此前反转导致过期 token 可续签）
  • WebSocket 消息路径速率限制 + Retry 拦截器固化专属 Dio 实例
  • Flutter 全局错误捕获 + HTTP 安全响应头（HSTS / CSP / X-Frame-Options 等）
  • 清理开发期测试端点开放路由（0 公网暴露）
  • P0-5 首启初始化向导：消除默认 admin/admin888 硬编码，/setup 免鉴权向导仅允许执行一次

🏎 稳定性与性能（Phase 3 MEDIUM 共 6 步）

  • TSID 分布式 ID 全量迁移（替换 BIGSERIAL，跨数据中心唯一 + 时间近似有序）
  • conv_seq 游标方案 B：消息永久存储的严格顺序依据（per-conversation 单调递增，不依赖 TSID 排序）
  • 热路径分页改游标分页（会话列表、消息历史、频道订阅）
  • conversation 表 varchar→bigint 迁移（ID 类型统一）
  • TimescaleDB hypertable 覆盖审计日志 / 消息时间线
  • Admin 密码 MD5 预处理修复 + pgBouncer 连接池评估完成

🔭 可观测性与可运维性（Phase 4 MEDIUM 共 6 步）

  • Sentry 集成（三端统一 DSN 通道，生产注入流程见 imboy/doc/operations/observability.md）
  • Erlang 后端结构化日志（lager → JSON）
  • CI/CD 基础流水线（lint / test / dialyze / 迁移校验）
  • 生产部署文档与一键 docker-compose.prod.yml + Caddy 自动 TLS
  • Flutter 核心流程集成测试补全（1274 通过 / 0 失败）
  • WebSocket 重连稳定性测试（4 步退避 2s→5s→7s→11s 压测验证）

🧱 架构与工程

  • 工作区架构：三端独立仓 + 共享 workspace 约束 + 根 VERSION 单源
  • 架构门禁：script/check_module_boundaries.sh 在 CI 防止跨域直接依赖
  • IMBoy v2 二进制帧协议（自托管 WS 帧包裹 JSON/Protobuf，向前兼容 v1 JSON）
  • 管理后台统一分页规范（DataTablePagination，默认 size=10，搜索/筛选时 page 强制重置 1）
  • 法务文本：隐私政策 7 节 + 服务条款 6 节完整正式文本（2026-01-01 生效）
  • 三端统一 LICENSE（MulanPSL-2.0）

Added

  • 10 大功能线代码完整度全部 100%
    • 单聊 (C2C) · 群聊 (C2G) · 会话管理 · 消息提醒（FCM + APNs）
    • WebSocket / ACK · 端到端加密 (E2EE) · Tag 标签 · 收藏
    • 频道（订阅/发布/付费/统计）· 朋友圈（ACL/评论/点赞/审核）
  • deploy/docker-compose.prod.yml + .env.example + deploy/README.md 一键生产部署包
  • script/preflight.sh 部署前置检查（磁盘 / 内存 / 端口 / DNS / PG 扩展）
  • 根 CHANGELOG.md（本文件）+ 根 VERSION + 三端统一 LICENSE
  • P0-5 首启初始化向导完整链路（后端 handler + logic + 前端 SetupPage + 路由守卫 + E2E）

Changed

  • 版本号：workspace 层当前为 1.0.0-alpha.46，三端历史小版本号停止独立递进
  • DB 访问：所有数据库操作强制通过 elib_pg 模块（架构门禁 CI 拦截）
  • ID 规范：客户端 ID 以 integer 传输，DB 存 BIGINT；不再使用 hashids 编码（elib_hashids 已于 2026-04-07 删除）
  • 消息顺序：需要严格顺序的业务统一依赖 conv_seq 游标，不再把 msg_id / TSID 当作全局顺序依据
  • WebSocket 字段命名：统一使用 to / from（binary TSID 字符串），不再使用 to_id / from_id（兼容层保留）
  • 管理员创建：从 erl remote_console 手工写库改为 /setup Web 向导（P0-5）

Removed

  • elib_hashids 模块及其所有调用点（2026-04-07）
  • 迁移文件 00000006_user.sql / 00000032_adm_user.sql 中 4 处 admin888 默认口令注释残留
  • 开发期测试端点（/test/*）从 imboy_router:open/0 白名单移除
  • 根 README.md 中的 erl shell 建测试账号笔记（迁移到 imboy/doc/dev/ws-repl-cheatsheet.md）

Fixed

  • Token 过期逻辑反转（此前过期 token 仍可续签）
  • Retry 拦截器泄漏裸 Dio 实例（绕过认证头）
  • get_staging_stats SQL 语法错误
  • APK SHA256 校验异常处理
  • Admin 密码 MD5 预处理流程修复

Security

  • 生产凭据全部从代码库移出到 .env / 环境变量
  • SQLCipher 加密客户端本地数据库
  • PostgreSQL 最小权限账号分离（DDL 与 DML 不同账号）
  • WAL 归档 + PITR 支持
  • adm.setup.completed_at 配置标志 + adm_user 表存在性双重防线防止首启向导被重复触发

Known gaps to 1.0.0 GA

  • 生产 Sentry DSN 注入流程尚未完全自动化（文档齐全但需手工 opt-in）
  • iOS 上架流程未启动（依赖开发者账户就位）
  • 单机百万连接的可复现性能白皮书（有压测数据但未整理成第三方可复现剧本）
  • Prometheus 告警规则（Grafana dashboard 已落地，告警阈值待实战打磨）
  • docs-site VitePress 文档站（暂以 README + CHANGELOG + doc/ 顶着）

历史版本（pre-SKU，仅作参考）

imboy backend

  • 0.7.3 - 最后的 pre-SKU 后端版本（2026-01-20）
  • 0.7.0 之前 - 详见 imboy/doc/changelog.md

imboyapp

  • 0.8.0 - 最后的 pre-SKU Flutter 版本

imboy-admin-frontend

  • 0.0.0 - 未正式计版