Compare commits
47
Commits
v0.0.3
..
a398bc418d
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a398bc418d | ||
|
|
38b731a334 | ||
|
|
f178fb4044 | ||
|
|
61f85e5fa4 | ||
|
|
e992edccce | ||
|
|
d2c18634ed | ||
|
|
4105336cb2 | ||
|
|
3a22fdeef3 | ||
|
|
e12c57222b | ||
|
|
a8dcd0601b | ||
|
|
1c1b15e709 | ||
|
|
bbda26fa41 | ||
|
|
c75665446b | ||
|
|
47d0e0d248 | ||
|
|
ab48f06150 | ||
|
|
cfcd7f13d9 | ||
|
|
f50268b70f | ||
|
|
95b8611bd9 | ||
|
|
cb550e3d5c | ||
|
|
3a8120a33a | ||
|
|
dcdf634457 | ||
|
|
c771a98d4d | ||
|
|
4665336a63 | ||
|
|
420aa22342 | ||
|
|
3fc703de0b | ||
|
|
28d54186ad | ||
|
|
258a2d21f6 | ||
|
|
b3d8e29f52 | ||
|
|
c5a6e6a2c0 | ||
|
|
2e4cffeff1 | ||
|
|
c04184a611 | ||
|
|
19cc5f948d | ||
|
|
7dc04a2671 | ||
|
|
f5994ad77e | ||
|
|
3cc00de8f6 | ||
|
|
70f020f87c | ||
|
|
d827bfadb1 | ||
|
|
da056681b6 | ||
|
|
2c502ebbec | ||
|
|
e552b979b6 | ||
|
|
0a69aa1d43 | ||
|
|
9203fdd0c2 | ||
|
|
4ce33d8c7d | ||
|
|
91d9b9ce85 | ||
|
|
fa1df71eac | ||
|
|
0328f9e3d2 | ||
|
|
6aa9fed621 |
@@ -3,12 +3,18 @@ node_modules/
|
|||||||
dist/
|
dist/
|
||||||
coverage/
|
coverage/
|
||||||
*.tsbuildinfo
|
*.tsbuildinfo
|
||||||
|
playwright-report/
|
||||||
|
test-results/
|
||||||
|
|
||||||
# 本地环境与密钥
|
# 本地环境与密钥
|
||||||
.env
|
.env
|
||||||
.env.*
|
.env.*
|
||||||
!.env.example
|
!.env.example
|
||||||
|
*.env
|
||||||
|
*.env.*
|
||||||
|
!*.env.example
|
||||||
*.local
|
*.local
|
||||||
|
.local/
|
||||||
|
|
||||||
# 编辑器与操作系统
|
# 编辑器与操作系统
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
engine-strict=true
|
||||||
|
save-exact=true
|
||||||
|
strict-peer-dependencies=true
|
||||||
|
only-built-dependencies[]=esbuild
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# 自动生成或不可变发布产物
|
||||||
|
AGENTS.md
|
||||||
|
pnpm-lock.yaml
|
||||||
|
database/schema-baselines/
|
||||||
|
|
||||||
|
# 历史功能档案与人类维护文档不由代码格式器改写,追溯内容保持原样。
|
||||||
|
docs/
|
||||||
|
|
||||||
|
# 已有治理脚本保留原历史格式;其行为由专项测试门禁覆盖。
|
||||||
|
tools/database/
|
||||||
|
tools/governance/
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"singleQuote": true,
|
||||||
|
"trailingComma": "all",
|
||||||
|
"printWidth": 100,
|
||||||
|
"semi": true
|
||||||
|
}
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
|
|
||||||
## 强制要求
|
## 强制要求
|
||||||
|
|
||||||
1. 修改生产代码前必须执行 `npm run governance:start -- <功能编号> <短名称>`,刷新 GitNexus,并完成开发前影响分析。
|
1. 开发下一版本前必须先执行 `npm run schema:baseline` 和 `npm run schema:verify`,将上一已发布版本的开发库 Schema 基线用中文提交推送 Gitea;随后才能执行 `npm run governance:start -- <功能编号> <短名称>`,刷新 GitNexus 并完成开发前影响分析。
|
||||||
2. 修改完成后必须执行测试、构建、视觉验证和 `npm run governance:finish -- <功能编号> <短名称>`,再次刷新 GitNexus并保存前后对比。
|
2. 修改完成后必须执行测试、构建、视觉验证和 `npm run governance:finish -- <功能编号> <短名称>`,再次刷新 GitNexus并保存前后对比。
|
||||||
3. 任何功能必须先有 `docs/features/<功能编号>-<短名称>/` 功能档案;没有 PRD、需求、设计、计划和回退说明不得视为完成。
|
3. 任何功能必须先有 `docs/features/<功能编号>-<短名称>/` 功能档案;没有 PRD、需求、设计、计划和回退说明不得视为完成。
|
||||||
4. Git 提交必须使用中文 Conventional Commit,并带功能编号;禁止英文摘要和含糊提交信息。
|
4. Git 提交必须使用中文 Conventional Commit,并带功能编号;禁止英文摘要和含糊提交信息。
|
||||||
@@ -19,11 +19,17 @@
|
|||||||
8. 禁止提交密钥、密码、访问令牌、生产数据、`.env` 和 GitNexus 本地索引;凭据不得写入远程 URL、文档、脚本或命令参数。
|
8. 禁止提交密钥、密码、访问令牌、生产数据、`.env` 和 GitNexus 本地索引;凭据不得写入远程 URL、文档、脚本或命令参数。
|
||||||
9. 开发完成后必须先通过代码 Review 和开发规范符合性 Review,再进入发布;Review 结论和问题处置必须写入功能档案。
|
9. 开发完成后必须先通过代码 Review 和开发规范符合性 Review,再进入发布;Review 结论和问题处置必须写入功能档案。
|
||||||
10. 每次提交验证通过后必须立即推送当前分支到项目 Gitea;本次新建标签必须单独推送。推送失败时任务不得标记完成,禁止强推或自动覆盖未知远程提交。
|
10. 每次提交验证通过后必须立即推送当前分支到项目 Gitea;本次新建标签必须单独推送。推送失败时任务不得标记完成,禁止强推或自动覆盖未知远程提交。
|
||||||
|
11. Schema 基线只能读取 `APP_ENV=development` 的 `a_share_analysis_dev`,启用时主机必须命中代码内固定开发白名单(开发机回环地址或 `112.192.20.11`);禁止连接、探测或读取生产数据库。MySQL 未启用时只允许生成可验证的 `not_applicable` 清单,启用但无对象时生成 `captured_empty` 清单,禁止用空 SQL 冒充基线。`governance:start` 还必须确认基线已提交、已推送且远程标签一致。
|
||||||
|
12. 功能和缺陷修复开发前必须用 GitNexus 评估直接、间接及跨模块影响,并逐项判断 HTTP/OpenAPI、Web API、消息、数据库、Redis、API、Scheduler、Worker、部署、测试和文档是否同步修改;`partial` 结果不得视为无影响。
|
||||||
|
13. 设计、测试计划和 Review 必须包含安全策略、性能目标、验证证据及残余风险;不适用项必须写明原因与边界。
|
||||||
|
14. 每个未发布功能必须有独立 `development-summary.md`,明确原始需求、范围变化、实际完成、修复缺陷、延期项、关键提交和验证证据,不得合并到发布说明。
|
||||||
|
15. 后端以业务模块为一级目录并在模块内按需分层,小模块不凑目录;前端统一由 `web/src/utils/request.ts` 封装 Axios,业务请求只能位于 `web/src/api/<业务域>/index.ts`,OpenAPI 类型继续作为契约来源。
|
||||||
|
16. 复用代码只有在真实重复和稳定职责出现后才能抽取;新增依赖必须先评估用途、替代、安全、许可证、体积或运行成本、维护和退出方案。
|
||||||
|
|
||||||
<!-- gitnexus:start -->
|
<!-- gitnexus:start -->
|
||||||
# GitNexus — Code Intelligence
|
# GitNexus — Code Intelligence
|
||||||
|
|
||||||
This project is indexed by GitNexus as **a-share-analysis** (432 symbols, 458 relationships, 0 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
This project is indexed by GitNexus as **a-share-analysis** (1847 symbols, 2522 relationships, 50 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
||||||
|
|
||||||
> If any GitNexus tool warns the index is stale, run `npx gitnexus analyze` in terminal first.
|
> If any GitNexus tool warns the index is stale, run `npx gitnexus analyze` in terminal first.
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,39 @@
|
|||||||
|
|
||||||
本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。
|
本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
- 新增安全、性能、GitNexus 跨模块影响和独立开发总结的可执行治理门禁。
|
||||||
|
- 约定后端业务模块内按需分层,以及前端 Axios 统一封装、API 分域和 OpenAPI 类型契约。
|
||||||
|
- 项目生产交付统一为 Ubuntu 源码部署,移除 Dockerfile、Compose、镜像校验和容器测试入口。
|
||||||
|
- 本地 Redis、MySQL 5.7.42 与 RocketMQ 5.x 均作为外部服务,项目不再提供自动启动或容器兜底。
|
||||||
|
- 新增源码发布门禁,校验 Web/Server 构建产物与 systemd、Nginx 配置一致性。
|
||||||
|
|
||||||
|
## 0.0.7 - 2026-08-13
|
||||||
|
|
||||||
|
- 将项目唯一消息队列技术基线由 RabbitMQ 调整为 RocketMQ 5.x。
|
||||||
|
- 建立 MessageBusAdapter、Topic/Group、重试、死信和顺序消息约束。
|
||||||
|
- 更新 Scheduler/Worker 环境模板和双部署文档,并记录本机 NameServer 分层连接验证。
|
||||||
|
|
||||||
|
## 0.0.6 - 2026-08-13
|
||||||
|
|
||||||
|
- 建立上一发布版本开发数据库 Schema 基线生成、规范化和自动校验工具。
|
||||||
|
- 固定只读开发库安全边界、完整 MySQL 5.7 对象范围和禁止覆盖规则。
|
||||||
|
- 为 MySQL 未启用状态建立可验证的不适用记录,并接入治理前后门禁。
|
||||||
|
|
||||||
|
## 0.0.5 - 2026-08-13
|
||||||
|
|
||||||
|
- 建立开发与生产环境配置契约及八份无秘密模板。
|
||||||
|
- 增加仅运行 Redis 的本地开发 Compose。
|
||||||
|
- 建立 Docker Compose 与 Ubuntu 源码生产部署边界、systemd 和 Nginx 示例。
|
||||||
|
- 增加环境配置自动化契约测试。
|
||||||
|
|
||||||
|
## 0.0.4 - 2026-08-13
|
||||||
|
|
||||||
|
- 固定 MySQL 5.7.x、`utf8mb4` 和 `utf8mb4_general_ci` 技术基线。
|
||||||
|
- 增加 MySQL 8.x 禁用能力、迁移、索引、比较语义和 Review 规则。
|
||||||
|
- 新增数据库基线自动化契约测试。
|
||||||
|
|
||||||
## 0.0.3 - 2026-08-12
|
## 0.0.3 - 2026-08-12
|
||||||
|
|
||||||
- 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。
|
- 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。
|
||||||
|
|||||||
@@ -9,12 +9,19 @@ A read-only A-share market overview and analysis tool.
|
|||||||
## Projects
|
## Projects
|
||||||
|
|
||||||
- `web/`: Vue 3 market terminal frontend.
|
- `web/`: Vue 3 market terminal frontend.
|
||||||
- `server/`: NestJS API, scheduler, and workers. Added in a later module.
|
- `server/`: NestJS API、Scheduler 与 Worker 三个独立进程。
|
||||||
- `deploy/`: MySQL, Redis, and RabbitMQ deployment configuration. Added with the backend module.
|
- `deploy/`: MySQL 5.7、Redis、RocketMQ 5.x 的配置契约,以及 systemd/Nginx 源码部署模板。
|
||||||
- `docs/`: Product and implementation specifications.
|
- `docs/`: Product and implementation specifications.
|
||||||
|
|
||||||
The first implementation slice is the market overview screen in `web/`.
|
The first implementation slice is the market overview screen in `web/`.
|
||||||
|
|
||||||
|
## 环境与部署
|
||||||
|
|
||||||
|
- [本地开发环境](docs/deployment/local-development.md):使用开发机已有 Redis,应用全部从源码运行。
|
||||||
|
- [Ubuntu 源码生产部署](docs/deployment/ubuntu-source-production.md):项目唯一生产部署方式,支持 Ubuntu 22.04/24.04 LTS x86_64。
|
||||||
|
|
||||||
|
无秘密环境模板位于 `deploy/env/`。生产配置不进入 Git 或发布目录;Node.js 22.x、pnpm 10.25.0、Nginx 和外部基础设施由服务器管理员提供。项目不安装、启动、停止或删除 Redis、MySQL 和 RocketMQ。
|
||||||
|
|
||||||
## 开发入口
|
## 开发入口
|
||||||
|
|
||||||
- [文档索引](docs/index.md)
|
- [文档索引](docs/index.md)
|
||||||
@@ -25,9 +32,13 @@ The first implementation slice is the market overview screen in `web/`.
|
|||||||
开始任何模块前,先阅读根目录 `AGENTS.md`,然后运行:
|
开始任何模块前,先阅读根目录 `AGENTS.md`,然后运行:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
npm run schema:baseline
|
||||||
|
npm run schema:verify
|
||||||
npm run governance:start -- FEAT-MO-001 market-overview
|
npm run governance:start -- FEAT-MO-001 market-overview
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Schema 命令只允许处理固定开发库;当前 MySQL 未启用时会为上一发布版本生成可验证的不适用清单,不会连接数据库或创建空 SQL。完整规则见 [开发流程规范](docs/governance/development-workflow.md)。
|
||||||
|
|
||||||
## 项目仓库
|
## 项目仓库
|
||||||
|
|
||||||
- Gitea:<https://git.foximao.com/FoXiMao/a-share-analysis>
|
- Gitea:<https://git.foximao.com/FoXiMao/a-share-analysis>
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"format_version": 1,
|
||||||
|
"status": "not_applicable",
|
||||||
|
"application_version": "v0.0.5",
|
||||||
|
"git_commit": "0a69aa1d43f40093c6482f48a13d9d222f6faec5",
|
||||||
|
"source_environment": "development",
|
||||||
|
"database_name": "a_share_analysis_dev",
|
||||||
|
"mysql_client_version": "not_enabled",
|
||||||
|
"mysqldump_client_version": "not_enabled",
|
||||||
|
"mysql_server_version": "not_enabled",
|
||||||
|
"charset": "utf8mb4",
|
||||||
|
"collation": "utf8mb4_general_ci",
|
||||||
|
"generated_at": "2026-08-13T03:15:28.832Z",
|
||||||
|
"generator": "schema-baseline/1.0.0",
|
||||||
|
"reason": "mysql_disabled",
|
||||||
|
"schema_sha256": "not_applicable",
|
||||||
|
"objects": {
|
||||||
|
"tables": false,
|
||||||
|
"views": false,
|
||||||
|
"triggers": false,
|
||||||
|
"routines": false,
|
||||||
|
"events": false
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"format_version": 1,
|
||||||
|
"status": "not_applicable",
|
||||||
|
"application_version": "v0.0.6",
|
||||||
|
"git_commit": "70f020f87c0cf9e19512581d798a3491c9aae5f6",
|
||||||
|
"source_environment": "development",
|
||||||
|
"database_name": "a_share_analysis_dev",
|
||||||
|
"mysql_client_version": "not_enabled",
|
||||||
|
"mysqldump_client_version": "not_enabled",
|
||||||
|
"mysql_server_version": "not_enabled",
|
||||||
|
"charset": "utf8mb4",
|
||||||
|
"collation": "utf8mb4_general_ci",
|
||||||
|
"generated_at": "2026-08-13T05:58:53.506Z",
|
||||||
|
"generator": "schema-baseline/1.0.0",
|
||||||
|
"reason": "mysql_disabled",
|
||||||
|
"schema_sha256": "not_applicable",
|
||||||
|
"objects": {
|
||||||
|
"tables": false,
|
||||||
|
"views": false,
|
||||||
|
"triggers": false,
|
||||||
|
"routines": false,
|
||||||
|
"events": false
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"format_version": 1,
|
||||||
|
"status": "not_applicable",
|
||||||
|
"application_version": "v0.0.7",
|
||||||
|
"git_commit": "7dc04a267199fb3a11c2ac43c2914ae5e1460cb9",
|
||||||
|
"source_environment": "development",
|
||||||
|
"database_name": "a_share_analysis_dev",
|
||||||
|
"mysql_client_version": "not_enabled",
|
||||||
|
"mysqldump_client_version": "not_enabled",
|
||||||
|
"mysql_server_version": "not_enabled",
|
||||||
|
"charset": "utf8mb4",
|
||||||
|
"collation": "utf8mb4_general_ci",
|
||||||
|
"generated_at": "2026-08-13T06:55:43.710Z",
|
||||||
|
"generator": "schema-baseline/1.0.0",
|
||||||
|
"reason": "mysql_disabled",
|
||||||
|
"schema_sha256": "not_applicable",
|
||||||
|
"objects": {
|
||||||
|
"tables": false,
|
||||||
|
"views": false,
|
||||||
|
"triggers": false,
|
||||||
|
"routines": false,
|
||||||
|
"events": false
|
||||||
|
}
|
||||||
|
}
|
||||||
+32
@@ -0,0 +1,32 @@
|
|||||||
|
# 运行环境;本地源码运行固定为 development。
|
||||||
|
APP_ENV=development
|
||||||
|
# API 只监听本机,避免开发服务暴露到局域网。
|
||||||
|
API_HOST=127.0.0.1
|
||||||
|
API_PORT=3000
|
||||||
|
LOG_LEVEL=debug
|
||||||
|
|
||||||
|
# 第一阶段实际启用的 Redis。
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=0
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
# 第一阶段关闭 MySQL;启用后下列连接变量变为必填。
|
||||||
|
MYSQL_ENABLED=false
|
||||||
|
MYSQL_HOST=127.0.0.1
|
||||||
|
MYSQL_PORT=3306
|
||||||
|
MYSQL_DATABASE=a_share_analysis_dev
|
||||||
|
MYSQL_USERNAME=
|
||||||
|
MYSQL_PASSWORD=
|
||||||
|
MYSQL_CHARSET=utf8mb4
|
||||||
|
MYSQL_COLLATION=utf8mb4_general_ci
|
||||||
|
MYSQL_TIMEZONE=+08:00
|
||||||
|
|
||||||
|
# 第一阶段关闭付费 AI;启用后 BASE_URL、API_KEY 和 MODEL 变为必填。
|
||||||
|
AI_ENABLED=false
|
||||||
|
AI_BASE_URL=
|
||||||
|
AI_API_KEY=
|
||||||
|
AI_MODEL=
|
||||||
|
AI_TIMEOUT_MS=30000
|
||||||
+19
@@ -0,0 +1,19 @@
|
|||||||
|
# Scheduler 只负责触发时间和调度锁。
|
||||||
|
APP_ENV=development
|
||||||
|
LOG_LEVEL=debug
|
||||||
|
SCHEDULER_TIMEZONE=Asia/Shanghai
|
||||||
|
SCHEDULER_ENABLED=true
|
||||||
|
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=1
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
# 第一阶段关闭 RocketMQ,任务通过服务内 MessageBusAdapter 调用。
|
||||||
|
ROCKETMQ_ENABLED=false
|
||||||
|
ROCKETMQ_NAMESRV_ADDR=127.0.0.1:9876
|
||||||
|
ROCKETMQ_ENDPOINT=127.0.0.1:8081
|
||||||
|
ROCKETMQ_TOPIC_PREFIX=a-share-analysis
|
||||||
|
ROCKETMQ_SEND_TIMEOUT_MS=3000
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
# VITE 变量会进入浏览器,只允许公开配置。
|
||||||
|
VITE_APP_ENV=development
|
||||||
|
VITE_APP_TITLE=A-Share Analysis
|
||||||
|
VITE_API_BASE_URL=
|
||||||
|
VITE_ENABLE_DEVTOOLS=true
|
||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
# 开发环境使用确定性模拟行情,不访问生产数据源。
|
||||||
|
APP_ENV=development
|
||||||
|
LOG_LEVEL=debug
|
||||||
|
MARKET_DATA_MODE=mock
|
||||||
|
MARKET_DATA_PROVIDER=deterministic-fixture
|
||||||
|
MARKET_DATA_BASE_URL=
|
||||||
|
MARKET_DATA_API_KEY=
|
||||||
|
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=2
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
MYSQL_ENABLED=false
|
||||||
|
MYSQL_HOST=127.0.0.1
|
||||||
|
MYSQL_PORT=3306
|
||||||
|
MYSQL_DATABASE=a_share_analysis_dev
|
||||||
|
MYSQL_USERNAME=
|
||||||
|
MYSQL_PASSWORD=
|
||||||
|
MYSQL_CHARSET=utf8mb4
|
||||||
|
MYSQL_COLLATION=utf8mb4_general_ci
|
||||||
|
MYSQL_TIMEZONE=+08:00
|
||||||
|
|
||||||
|
ROCKETMQ_ENABLED=false
|
||||||
|
ROCKETMQ_NAMESRV_ADDR=127.0.0.1:9876
|
||||||
|
ROCKETMQ_ENDPOINT=127.0.0.1:8081
|
||||||
|
ROCKETMQ_TOPIC_PREFIX=a-share-analysis
|
||||||
|
ROCKETMQ_CONSUMER_GROUP=a-share-analysis-worker
|
||||||
|
ROCKETMQ_CONSUMER_CONCURRENCY=4
|
||||||
|
|
||||||
|
AI_ENABLED=false
|
||||||
|
AI_BASE_URL=
|
||||||
|
AI_API_KEY=
|
||||||
|
AI_MODEL=
|
||||||
|
AI_TIMEOUT_MS=30000
|
||||||
+29
@@ -0,0 +1,29 @@
|
|||||||
|
# 生产进程必须显式使用 production,禁止回退开发默认值。
|
||||||
|
APP_ENV=production
|
||||||
|
API_HOST=127.0.0.1
|
||||||
|
API_PORT=3000
|
||||||
|
LOG_LEVEL=info
|
||||||
|
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=0
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
# 第一阶段关闭;启用后必须填写真实生产连接,但不得提交本文件副本。
|
||||||
|
MYSQL_ENABLED=false
|
||||||
|
MYSQL_HOST=127.0.0.1
|
||||||
|
MYSQL_PORT=3306
|
||||||
|
MYSQL_DATABASE=a_share_analysis
|
||||||
|
MYSQL_USERNAME=
|
||||||
|
MYSQL_PASSWORD=
|
||||||
|
MYSQL_CHARSET=utf8mb4
|
||||||
|
MYSQL_COLLATION=utf8mb4_general_ci
|
||||||
|
MYSQL_TIMEZONE=+08:00
|
||||||
|
|
||||||
|
AI_ENABLED=false
|
||||||
|
AI_BASE_URL=
|
||||||
|
AI_API_KEY=
|
||||||
|
AI_MODEL=
|
||||||
|
AI_TIMEOUT_MS=30000
|
||||||
+17
@@ -0,0 +1,17 @@
|
|||||||
|
APP_ENV=production
|
||||||
|
LOG_LEVEL=info
|
||||||
|
SCHEDULER_TIMEZONE=Asia/Shanghai
|
||||||
|
SCHEDULER_ENABLED=true
|
||||||
|
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=1
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
ROCKETMQ_ENABLED=false
|
||||||
|
ROCKETMQ_NAMESRV_ADDR=
|
||||||
|
ROCKETMQ_ENDPOINT=
|
||||||
|
ROCKETMQ_TOPIC_PREFIX=a-share-analysis
|
||||||
|
ROCKETMQ_SEND_TIMEOUT_MS=3000
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
# VITE 变量会进入浏览器,只允许公开配置。
|
||||||
|
VITE_APP_ENV=production
|
||||||
|
VITE_APP_TITLE=A-Share Analysis
|
||||||
|
VITE_API_BASE_URL=
|
||||||
|
VITE_ENABLE_DEVTOOLS=false
|
||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
# 生产环境必须使用 live,启动校验拒绝 mock。
|
||||||
|
APP_ENV=production
|
||||||
|
LOG_LEVEL=info
|
||||||
|
MARKET_DATA_MODE=live
|
||||||
|
MARKET_DATA_PROVIDER=
|
||||||
|
MARKET_DATA_BASE_URL=
|
||||||
|
MARKET_DATA_API_KEY=
|
||||||
|
|
||||||
|
REDIS_HOST=127.0.0.1
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_USERNAME=
|
||||||
|
REDIS_PASSWORD=
|
||||||
|
REDIS_DATABASE=2
|
||||||
|
REDIS_TLS=false
|
||||||
|
|
||||||
|
MYSQL_ENABLED=false
|
||||||
|
MYSQL_HOST=127.0.0.1
|
||||||
|
MYSQL_PORT=3306
|
||||||
|
MYSQL_DATABASE=a_share_analysis
|
||||||
|
MYSQL_USERNAME=
|
||||||
|
MYSQL_PASSWORD=
|
||||||
|
MYSQL_CHARSET=utf8mb4
|
||||||
|
MYSQL_COLLATION=utf8mb4_general_ci
|
||||||
|
MYSQL_TIMEZONE=+08:00
|
||||||
|
|
||||||
|
ROCKETMQ_ENABLED=false
|
||||||
|
ROCKETMQ_NAMESRV_ADDR=
|
||||||
|
ROCKETMQ_ENDPOINT=
|
||||||
|
ROCKETMQ_TOPIC_PREFIX=a-share-analysis
|
||||||
|
ROCKETMQ_CONSUMER_GROUP=a-share-analysis-worker
|
||||||
|
ROCKETMQ_CONSUMER_CONCURRENCY=4
|
||||||
|
|
||||||
|
AI_ENABLED=false
|
||||||
|
AI_BASE_URL=
|
||||||
|
AI_API_KEY=
|
||||||
|
AI_MODEL=
|
||||||
|
AI_TIMEOUT_MS=30000
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
root /opt/a-share-analysis/current/web/dist;
|
||||||
|
index index.html;
|
||||||
|
|
||||||
|
location /api/ {
|
||||||
|
proxy_pass http://127.0.0.1:3000;
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.html;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=A Share Analysis API
|
||||||
|
After=network-online.target
|
||||||
|
Wants=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=a-share
|
||||||
|
Group=a-share
|
||||||
|
WorkingDirectory=/opt/a-share-analysis/current
|
||||||
|
EnvironmentFile=/etc/a-share-analysis/api.env
|
||||||
|
ExecStart=/usr/bin/node /opt/a-share-analysis/current/server/dist/apps/api/main.js
|
||||||
|
ExecStartPre=/usr/bin/test -r /etc/a-share-analysis/api.env
|
||||||
|
Restart=on-failure
|
||||||
|
RestartSec=5
|
||||||
|
NoNewPrivileges=true
|
||||||
|
PrivateTmp=true
|
||||||
|
ProtectSystem=strict
|
||||||
|
ProtectHome=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=A Share Analysis Scheduler
|
||||||
|
After=network-online.target
|
||||||
|
Wants=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=a-share
|
||||||
|
Group=a-share
|
||||||
|
WorkingDirectory=/opt/a-share-analysis/current
|
||||||
|
EnvironmentFile=/etc/a-share-analysis/scheduler.env
|
||||||
|
ExecStart=/usr/bin/node /opt/a-share-analysis/current/server/dist/apps/scheduler/main.js
|
||||||
|
ExecStartPre=/usr/bin/test -r /etc/a-share-analysis/scheduler.env
|
||||||
|
Restart=on-failure
|
||||||
|
RestartSec=5
|
||||||
|
NoNewPrivileges=true
|
||||||
|
PrivateTmp=true
|
||||||
|
ProtectSystem=strict
|
||||||
|
ProtectHome=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=A Share Analysis Worker
|
||||||
|
After=network-online.target
|
||||||
|
Wants=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=a-share
|
||||||
|
Group=a-share
|
||||||
|
WorkingDirectory=/opt/a-share-analysis/current
|
||||||
|
EnvironmentFile=/etc/a-share-analysis/worker.env
|
||||||
|
ExecStart=/usr/bin/node /opt/a-share-analysis/current/server/dist/apps/worker/main.js
|
||||||
|
ExecStartPre=/usr/bin/test -r /etc/a-share-analysis/worker.env
|
||||||
|
Restart=on-failure
|
||||||
|
RestartSec=5
|
||||||
|
NoNewPrivileges=true
|
||||||
|
PrivateTmp=true
|
||||||
|
ProtectSystem=strict
|
||||||
|
ProtectHome=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# ADR-0003:采用 RocketMQ 5.x 作为唯一消息队列
|
||||||
|
|
||||||
|
- 状态:accepted
|
||||||
|
- 日期:2026-08-13
|
||||||
|
- 关联功能:GOV-008
|
||||||
|
|
||||||
|
## 背景
|
||||||
|
|
||||||
|
项目此前在架构和环境模板中约定 RabbitMQ,但尚未实现消息客户端、Topic 或业务消费流程。产品需要分钟级盘中分析、定时采集、指标计算、AI 分析和失败重试,决定在实现前统一切换到 RocketMQ。
|
||||||
|
|
||||||
|
## 决策
|
||||||
|
|
||||||
|
- 项目唯一消息队列为 RocketMQ 5.x,不维护 RabbitMQ 双栈。
|
||||||
|
- Scheduler 和 Worker 只依赖项目级 `MessageBusAdapter` 与版本化事件契约。
|
||||||
|
- Node.js 客户端优先通过 RocketMQ 5.x Proxy 接入;若改用直接 NameServer/Broker 客户端,必须通过兼容性和可靠性验证。
|
||||||
|
- Topic、Tag、Producer Group、Consumer Group、顺序键、重试与死信语义必须在功能设计中明确。
|
||||||
|
- 本地和生产基础设施独立于应用发布;NameServer、Broker、Proxy 不随应用版本自动创建或删除。
|
||||||
|
|
||||||
|
## 原因
|
||||||
|
|
||||||
|
RocketMQ 对定时/延迟任务、重试、死信、顺序消息和后续任务规模扩展更符合预期。Adapter 边界用于控制 Node 客户端成熟度和接入协议变化带来的风险。
|
||||||
|
|
||||||
|
## 代价
|
||||||
|
|
||||||
|
- 本地和生产运维复杂度高于单节点 RabbitMQ,需要区分 NameServer、Broker 和 Proxy。
|
||||||
|
- Node.js 生态需要在 Server 脚手架阶段单独验证,不能仅凭 NameServer 端口可达决定客户端可用。
|
||||||
|
- 所有消费者必须按至少一次投递设计幂等和受控重放。
|
||||||
|
|
||||||
|
## 验证
|
||||||
|
|
||||||
|
GOV-008 只验证配置、文档契约和本机 NameServer 状态。真实 Topic 生产/消费必须在 Broker/Proxy 可用且 Server 客户端选定后补充契约测试。
|
||||||
@@ -7,8 +7,10 @@
|
|||||||
```text
|
```text
|
||||||
web/ Vue 3 前端
|
web/ Vue 3 前端
|
||||||
server/ NestJS API、Scheduler 与 Worker
|
server/ NestJS API、Scheduler 与 Worker
|
||||||
contracts/ HTTP 与 RabbitMQ 版本化契约
|
server/openapi/ HTTP OpenAPI 产物
|
||||||
deploy/ MySQL、Redis、RabbitMQ 和运行配置
|
server/libs/http-contracts/ 后端 HTTP DTO
|
||||||
|
server/libs/message-contracts/ 后端 RocketMQ 版本化契约
|
||||||
|
deploy/ MySQL、Redis、RocketMQ 5.x 和运行配置
|
||||||
docs/ 规范、架构、ADR 与功能档案
|
docs/ 规范、架构、ADR 与功能档案
|
||||||
tools/ 可重复执行的治理和开发工具
|
tools/ 可重复执行的治理和开发工具
|
||||||
```
|
```
|
||||||
@@ -20,7 +22,8 @@ tools/ 可重复执行的治理和开发工具
|
|||||||
```text
|
```text
|
||||||
免费数据源
|
免费数据源
|
||||||
→ Scheduler 定时投递
|
→ Scheduler 定时投递
|
||||||
→ RabbitMQ
|
→ MessageBusAdapter
|
||||||
|
→ RocketMQ 5.x
|
||||||
→ 行情采集 Worker
|
→ 行情采集 Worker
|
||||||
→ 指标计算 Worker
|
→ 指标计算 Worker
|
||||||
→ 规则 / AI / 混合分析
|
→ 规则 / AI / 混合分析
|
||||||
@@ -30,12 +33,48 @@ tools/ 可重复执行的治理和开发工具
|
|||||||
```
|
```
|
||||||
|
|
||||||
- Scheduler只负责触发时间。
|
- Scheduler只负责触发时间。
|
||||||
- RabbitMQ只负责任务传递、确认、重试和死信。
|
- MessageBusAdapter 隔离业务与 RocketMQ 客户端,禁止业务模块直接依赖 SDK。
|
||||||
|
- RocketMQ 只负责任务传递、确认、重试、延迟消息和死信;重复投递由 Worker 幂等处理。
|
||||||
- Worker负责采集、标准化、计算和分析。
|
- Worker负责采集、标准化、计算和分析。
|
||||||
- MySQL保存可追溯事实与历史报告。
|
- MySQL保存可追溯事实与历史报告。
|
||||||
- Redis保存最新快照、缓存、锁和限流状态。
|
- Redis保存最新快照、缓存、锁和限流状态。
|
||||||
- Vue前端只读后端 API,不直接接触外部数据源和密钥。
|
- Vue前端只读后端 API,不直接接触外部数据源和密钥。
|
||||||
|
|
||||||
## 3. 当前实施顺序
|
## 3. 前后端模块边界
|
||||||
|
|
||||||
|
后端以业务模块为一级目录,模块内部按实际职责建立 Controller、Service、DTO、Domain、Repository 和 Adapter。小模块不强制凑齐目录,禁止把全部 Controller/Service 堆入全局目录,也禁止无业务逻辑的透传层。领域规则只依赖项目端口,MySQL、Redis、RocketMQ、免费数据源和 AI Provider 由基础设施 Adapter 实现。
|
||||||
|
|
||||||
|
前端 HTTP 数据流固定为:
|
||||||
|
|
||||||
|
```text
|
||||||
|
NestJS DTO 与 Swagger 元数据
|
||||||
|
→ server/openapi/openapi.json
|
||||||
|
→ openapi-typescript 生成 web/src/api/generated/schema.ts
|
||||||
|
→ web/src/api/<业务域>/index.ts
|
||||||
|
→ web/src/utils/request.ts(Axios)
|
||||||
|
→ 功能 adapter / ViewModel
|
||||||
|
→ 页面、组件和 Store
|
||||||
|
```
|
||||||
|
|
||||||
|
OpenAPI 负责描述本项目 HTTP 契约,Axios 负责浏览器实际请求。页面、组件、Store 和 Composable 不直接发 HTTP。兼容 OpenAI API 指未来后端 AI Provider 的外部协议,与前端请求库无关。
|
||||||
|
|
||||||
|
## 4. 数据库技术基线
|
||||||
|
|
||||||
|
- 数据库服务端固定使用 MySQL 5.7.42;开发、测试和生产环境禁止使用其他补丁版本或 MySQL 8.x 代替兼容性验证。
|
||||||
|
- 数据库与表默认字符集固定为 `utf8mb4`,排序规则固定为 `utf8mb4_general_ci`。
|
||||||
|
- 数据库初始化、表结构、连接会话、ORM 配置和迁移脚本必须显式声明或验证该字符集与排序规则,不能依赖服务器默认值。
|
||||||
|
- 正式启用持久化前,必须在真实 MySQL 5.7 环境验证服务端版本、Schema/表排序规则、迁移和关键查询。
|
||||||
|
- 第一阶段市场概览只定义 MySQL Repository 接口并使用内存实现,不启动数据库、不建立生产连接;后续启用时不得改变前端 API 和核心分析契约。
|
||||||
|
|
||||||
|
## 5. 当前实施顺序
|
||||||
|
|
||||||
第一阶段先实现可交互的市场综合概览和稳定数据契约,再接入正式行情采集链路。用户、邀请、权限、会员和支付后置,不进入当前核心架构。
|
第一阶段先实现可交互的市场综合概览和稳定数据契约,再接入正式行情采集链路。用户、邀请、权限、会员和支付后置,不进入当前核心架构。
|
||||||
|
|
||||||
|
## 6. 环境与部署基线
|
||||||
|
|
||||||
|
- 应用运行环境只定义 `development` 与 `production`;生产环境禁止模拟数据、热更新、调试端口和开发默认值回退。
|
||||||
|
- API、Scheduler、Worker、Web 分别拥有开发和生产模板;同一进程跨环境使用相同变量名,通过启动 Schema 校验条件必填项。
|
||||||
|
- 本地开发直接连接开发机已开机自启的 Redis `127.0.0.1:6379`,应用进程从源码运行;第一阶段 MySQL 与 RocketMQ 保持关闭,需要联调时连接开发者独立维护的外部服务。
|
||||||
|
- 生产只支持 Ubuntu 22.04/24.04 LTS x86_64 源码部署,不提供容器运行、构建、测试或部署入口。
|
||||||
|
- 源码部署由管理员预装 Node.js 22.x、pnpm 10.25.0、Nginx 和外部基础设施;项目只验证,不安装、启动、停止或删除系统服务。
|
||||||
|
- 源码部署使用不可变发布目录、`a-share` 用户和 systemd 独立进程配置;生产 env 存放在 `/etc/a-share-analysis/`,不随代码版本切换覆盖。
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# 本地开发环境
|
||||||
|
|
||||||
|
本地开发由开发机提供 Node.js 22.x、pnpm 10.25.0 和已开机自启的 Redis `127.0.0.1:6379`。Web、API、Scheduler 与 Worker 全部从源码启动;MySQL 5.7.42 和 RocketMQ 5.x 也是外部服务,项目脚本不负责安装、启动、停止或删除任何基础设施。
|
||||||
|
|
||||||
|
## 首次准备
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node --version
|
||||||
|
pnpm --version
|
||||||
|
redis-cli -h 127.0.0.1 -p 6379 ping
|
||||||
|
pnpm install --frozen-lockfile
|
||||||
|
pnpm check:runtime
|
||||||
|
```
|
||||||
|
|
||||||
|
Redis 必须返回 `PONG`。如果不可达,应先修复开发机外部服务;测试和应用不会创建替代实例。
|
||||||
|
|
||||||
|
把 `deploy/env/development/*.env.example` 复制为同目录的 `*.env.local`。四份 local 文件被 Git 忽略:Web 只能含 `VITE_` 公开变量;API、Scheduler、Worker 按最小权限分别读取自己的配置,不共享一份全能 env。
|
||||||
|
|
||||||
|
固定开发 MySQL 只允许 `a_share_analysis_dev`,主机必须是回环地址或代码内白名单 `112.192.20.11`,服务端固定为 MySQL 5.7.42,字符集为 `utf8mb4`、排序规则为 `utf8mb4_general_ci`、会话时区为 `+08:00`。Schema 工具和开发检查禁止连接、探测或读取生产库。
|
||||||
|
|
||||||
|
## 启动顺序
|
||||||
|
|
||||||
|
建议分别打开四个终端,依次运行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm --filter @a-share-analysis/server dev:api
|
||||||
|
pnpm --filter @a-share-analysis/server dev:scheduler
|
||||||
|
pnpm --filter @a-share-analysis/server dev:worker
|
||||||
|
pnpm --filter @a-share-analysis/web dev
|
||||||
|
```
|
||||||
|
|
||||||
|
API 健康端点是 `http://127.0.0.1:3000/api/v1/health`,Web 是 `http://127.0.0.1:5173/`。Scheduler 与 Worker 在 GOV-009 中保持 `ROCKETMQ_ENABLED=false`;没有经过验证的 Node RocketMQ 客户端时,启用配置会直接失败,不使用内存队列伪降级。
|
||||||
|
|
||||||
|
## 日常验证与停止
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm check:contracts
|
||||||
|
pnpm verify
|
||||||
|
pnpm verify:release
|
||||||
|
```
|
||||||
|
|
||||||
|
应用进程通过各自终端或信号正常停止,外部 Redis/MySQL/RocketMQ 生命周期不由项目管理。RocketMQ 的 TCP 端口可达不等于生产消费链路通过,完整联调仍需验证 Topic 路由和实际生产/消费。
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
# Ubuntu 源码生产部署
|
||||||
|
|
||||||
|
这是项目唯一生产部署方式,支持 Ubuntu 22.04 LTS 与 Ubuntu 24.04 LTS x86_64。服务器管理员预先提供 Node.js 22.x、pnpm 10.25.0、Nginx,以及外部 MySQL 5.7.42、Redis、RocketMQ 5.x;项目不负责安装、升级、启动、停止、删除或修改这些系统软件与服务。
|
||||||
|
|
||||||
|
## 构建发布目录
|
||||||
|
|
||||||
|
在固定提交的干净工作区执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uname -m
|
||||||
|
node --version
|
||||||
|
pnpm --version
|
||||||
|
pnpm install --frozen-lockfile
|
||||||
|
pnpm verify:release
|
||||||
|
```
|
||||||
|
|
||||||
|
架构必须为 `x86_64`,Node.js 必须为 22.x,pnpm 必须为 10.25.0。发布门禁会完成测试、Web/Server 构建、双视口浏览器检查,并核对 Web、API、Scheduler、Worker 产物与 systemd/Nginx 模板。
|
||||||
|
|
||||||
|
每次发布使用 `/opt/a-share-analysis/releases/<版本或提交>/` 新目录。完整传输并验证目录后,再把 `/opt/a-share-analysis/current` 原子切换到目标目录;禁止在 `current` 中原地覆盖文件,也禁止只发布部分进程产物。
|
||||||
|
|
||||||
|
## 配置与 systemd
|
||||||
|
|
||||||
|
生产配置放在 `/etc/a-share-analysis/api.env`、`scheduler.env`、`worker.env`,建议权限 `root:a-share 0640`;Web 的 `VITE_` 公开变量在构建前注入。三个 systemd 单元通过各自的 `EnvironmentFile=` 只读取本进程需要的键,运行用户为非登录系统用户 `a-share`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo install -m 0644 deploy/systemd/a-share-api.service.example /etc/systemd/system/a-share-api.service
|
||||||
|
sudo install -m 0644 deploy/systemd/a-share-scheduler.service.example /etc/systemd/system/a-share-scheduler.service
|
||||||
|
sudo install -m 0644 deploy/systemd/a-share-worker.service.example /etc/systemd/system/a-share-worker.service
|
||||||
|
sudo install -m 0644 deploy/nginx/a-share-analysis.conf.example /etc/nginx/conf.d/a-share-analysis.conf
|
||||||
|
sudo systemd-analyze verify /etc/systemd/system/a-share-api.service
|
||||||
|
sudo systemd-analyze verify /etc/systemd/system/a-share-scheduler.service
|
||||||
|
sudo systemd-analyze verify /etc/systemd/system/a-share-worker.service
|
||||||
|
sudo nginx -t
|
||||||
|
sudo systemctl daemon-reload
|
||||||
|
sudo systemctl restart a-share-api.service
|
||||||
|
sudo systemctl restart a-share-scheduler.service
|
||||||
|
sudo systemctl restart a-share-worker.service
|
||||||
|
sudo systemctl status a-share-api.service a-share-scheduler.service a-share-worker.service
|
||||||
|
sudo journalctl -u a-share-api.service -u a-share-scheduler.service -u a-share-worker.service --since '5 minutes ago'
|
||||||
|
curl --fail http://127.0.0.1:3000/api/v1/health
|
||||||
|
curl --fail http://127.0.0.1/
|
||||||
|
```
|
||||||
|
|
||||||
|
当前工程尚无业务表迁移;后续新增迁移后必须在切换 `current` 前单独执行并记录结果。生产环境禁止 `synchronize: true`,开发流程也禁止用生产数据库做 Schema 基线或连接测试。
|
||||||
|
|
||||||
|
## 检查与回退
|
||||||
|
|
||||||
|
使用 `systemctl status`、`journalctl -u`、HTTP 健康端点和 Nginx 同源访问结果确认发布。任一验证失败时,把 `/opt/a-share-analysis/current` 原子切回上一完整发布目录,重启三个 systemd 服务并重复健康检查。
|
||||||
|
|
||||||
|
`/etc/a-share-analysis/*.env` 和外部 Redis、MySQL、RocketMQ 数据不随应用目录切换而覆盖或删除。RocketMQ 的 NameServer、Broker、Proxy 与 CommitLog 由运维独立维护。
|
||||||
@@ -23,7 +23,7 @@
|
|||||||
## 非目标
|
## 非目标
|
||||||
|
|
||||||
- 不做自选股、持仓、笔记、交易计划、社区、荐股、跟单和公开组合。
|
- 不做自选股、持仓、笔记、交易计划、社区、荐股、跟单和公开组合。
|
||||||
- 本切片不接正式行情源、RabbitMQ、MySQL、Redis和付费 AI。
|
- 本切片不接正式行情源、RocketMQ、MySQL、Redis和付费 AI。
|
||||||
- 本切片不实现用户、邀请、会员、订阅和支付。
|
- 本切片不实现用户、邀请、会员、订阅和支付。
|
||||||
- ETF监控、两融数据、大盘云图和实时消息仍是独立一级模块。
|
- ETF监控、两融数据、大盘云图和实时消息仍是独立一级模块。
|
||||||
|
|
||||||
|
|||||||
@@ -14,4 +14,5 @@ gitnexus_comparison: gitnexus/comparison.md
|
|||||||
code_review: review/code-review.md
|
code_review: review/code-review.md
|
||||||
standards_review: review/standards-review.md
|
standards_review: review/standards-review.md
|
||||||
implementation_commit: 2a16e9f
|
implementation_commit: 2a16e9f
|
||||||
|
release_commit: d1e54dc
|
||||||
release: v0.0.3
|
release: v0.0.3
|
||||||
|
|||||||
@@ -23,4 +23,5 @@
|
|||||||
- 计划提交 `2d2502c` 已推送,并验证远程 `main` 与本地 SHA 一致。
|
- 计划提交 `2d2502c` 已推送,并验证远程 `main` 与本地 SHA 一致。
|
||||||
- 实现提交 `2a16e9f` 已推送,远程 `main` SHA 与本地一致。
|
- 实现提交 `2a16e9f` 已推送,远程 `main` SHA 与本地一致。
|
||||||
- 既有 `v0.0.0`、`v0.0.1`、`v0.0.2` 已分别精确推送;远程 peeled tag 提交与本地标签提交一致。
|
- 既有 `v0.0.0`、`v0.0.1`、`v0.0.2` 已分别精确推送;远程 peeled tag 提交与本地标签提交一致。
|
||||||
- `v0.0.3` 在封存提交后创建、精确推送并执行最终引用核对。
|
- `v0.0.3` 已在封存提交 `d1e54dc` 创建并精确推送;远程 peeled tag 提交与本地标签提交一致。
|
||||||
|
- 最终远程核对:`origin/main` 与本地 `main` 一致,四个版本标签全部存在且分别指向预期提交。
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
## v0.0.3
|
## v0.0.3
|
||||||
|
|
||||||
- 实现提交:`2a16e9f`。
|
- 实现提交:`2a16e9f`。
|
||||||
|
- 发布封存提交:`d1e54dc`;带注释标签 `v0.0.3` 已精确推送并核对。
|
||||||
- 把当前分支推送设为每次提交后的固定完成步骤。
|
- 把当前分支推送设为每次提交后的固定完成步骤。
|
||||||
- 本次创建的新标签采用精确推送,禁止用 `--tags` 批量发布其他标签。
|
- 本次创建的新标签采用精确推送,禁止用 `--tags` 批量发布其他标签。
|
||||||
- 推送失败将阻断任务完成,并禁止强推或自动覆盖未知远程历史。
|
- 推送失败将阻断任务完成,并禁止强推或自动覆盖未知远程历史。
|
||||||
|
|||||||
@@ -0,0 +1,80 @@
|
|||||||
|
# MySQL 5.7 字符集与兼容性基线设计规格
|
||||||
|
|
||||||
|
- 功能编号:GOV-005
|
||||||
|
- 规格版本:0.1
|
||||||
|
- 状态:approved_for_review
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 背景与目标
|
||||||
|
|
||||||
|
系统架构和开发规范已经选择 MySQL,但尚未固定服务端版本、字符集和排序规则。不同开发环境如果分别使用 MySQL 5.7、8.x 或不同排序规则,会造成迁移语法、索引行为、字符串比较和排序结果不一致。
|
||||||
|
|
||||||
|
本功能建立项目级数据库兼容性基线:所有正式实现固定使用 MySQL 5.7.x,字符集固定为 `utf8mb4`,排序规则固定为 `utf8mb4_general_ci`。虽然市场概览第一阶段只定义持久化接口、不启用 MySQL,该约束仍从数据模型设计开始生效。
|
||||||
|
|
||||||
|
## 约束方案
|
||||||
|
|
||||||
|
### 采用方案:全链路显式声明
|
||||||
|
|
||||||
|
数据库实例/Schema、连接会话、迁移脚本、表、需要覆盖默认值的文本列,以及 Docker、测试和 CI 环境都显式声明或验证版本和字符集规则。
|
||||||
|
|
||||||
|
采用原因:只设置服务器默认值无法防止迁移脚本、ORM 连接或外部工具创建出不同排序规则的对象。全链路显式声明能够在代码审查和自动测试中直接验证。
|
||||||
|
|
||||||
|
### 不采用:仅依赖服务器默认值
|
||||||
|
|
||||||
|
部署配置简单,但开发机、测试环境或后续迁移工具可能使用不同默认值,无法保证可复现,不采用。
|
||||||
|
|
||||||
|
### 不采用:允许 MySQL 8.x 向下兼容
|
||||||
|
|
||||||
|
在 8.x 开发、声称兼容 5.7,容易无意引入 CTE、窗口函数、函数索引和 8.x 行为差异。项目明确要求不使用 8.x,因此不采用。
|
||||||
|
|
||||||
|
## 技术基线
|
||||||
|
|
||||||
|
- 数据库服务端:MySQL `5.7.x`,部署镜像和测试环境必须固定到明确的 5.7 补丁版本;禁止 `latest`、`8` 或 `8.x`。
|
||||||
|
- 默认字符集:`utf8mb4`。
|
||||||
|
- 默认排序规则:`utf8mb4_general_ci`。
|
||||||
|
- 数据库创建语句必须包含 `DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci`。
|
||||||
|
- 表创建或迁移必须显式保持 `DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci`。
|
||||||
|
- ORM/数据库驱动连接配置必须设置 `charset=utf8mb4`,连接建立后验证会话排序规则为 `utf8mb4_general_ci`,不能假设服务器默认值正确。
|
||||||
|
- 文本列原则上继承表级规则;只有确实需要不同比较语义时才允许列级覆盖,并必须另建 ADR 获得批准。
|
||||||
|
|
||||||
|
## MySQL 5.7 兼容边界
|
||||||
|
|
||||||
|
代码、查询、迁移和测试不得使用仅在 MySQL 8.x 可用或行为不同的能力,包括但不限于:
|
||||||
|
|
||||||
|
- 公用表表达式 `WITH` 和递归 CTE。
|
||||||
|
- 窗口函数,例如 `ROW_NUMBER()`、`RANK()` 和 `OVER (...)`。
|
||||||
|
- 函数索引和不可见索引。
|
||||||
|
- `CHECK` 约束在 8.x 的强制执行语义;5.7 中业务约束必须由应用校验、普通索引或可验证的数据写入逻辑保证。
|
||||||
|
- `utf8mb4_0900_*` 排序规则。
|
||||||
|
- 依赖 MySQL 8.x 默认认证插件、保留字、数据字典或 JSON 增强能力的实现。
|
||||||
|
|
||||||
|
JSON 字段只有在需求能够由 MySQL 5.7 原生 JSON 能力稳定完成时才能使用;查询和索引设计必须有 5.7 实际测试证据。
|
||||||
|
|
||||||
|
## 排序规则语义
|
||||||
|
|
||||||
|
`utf8mb4_general_ci` 为不区分大小写的通用排序规则。业务代码不得把数据库字符串比较误认为大小写敏感;证券代码、外部事件 ID、幂等键等需要严格身份语义的字段,应通过规范化输入、二进制字段/排序规则或明确的唯一键设计解决,并在具体功能设计中说明。
|
||||||
|
|
||||||
|
索引长度必须按 MySQL 5.7、`utf8mb4` 最多四字节字符进行预算。迁移设计不得假设 MySQL 8.x 的默认索引能力;超长文本标识应使用长度受控字段、前缀索引或稳定摘要,并提供碰撞与唯一性处理说明。
|
||||||
|
|
||||||
|
## 配置落点
|
||||||
|
|
||||||
|
- `docs/architecture/system-architecture.md`:记录数据库技术基线、第一阶段接口边界和未来启用条件。
|
||||||
|
- `docs/governance/code-development-standards.md`:把版本、字符集、排序规则、禁用能力、迁移和 Review 检查设为强制规范。
|
||||||
|
- 后续 `deploy/`:MySQL 镜像固定 5.7 补丁版本,初始化参数显式声明字符集和排序规则。
|
||||||
|
- 后续 `server/`:ORM 与连接配置、迁移、Repository 实现按本规格验证。
|
||||||
|
- 后续测试:连接真实 MySQL 5.7 检查 `SELECT VERSION()`、数据库/表排序规则和查询兼容性。
|
||||||
|
|
||||||
|
## 实施范围
|
||||||
|
|
||||||
|
本功能只更新架构、开发规范、版本记录和 GOV-005 追溯档案,不创建数据库、不启动容器、不引入 ORM,也不启用市场概览的 MySQL Repository。正式部署配置和代码实现由后续业务功能按照本基线完成。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 系统架构明确 MySQL 5.7.x、`utf8mb4` 和 `utf8mb4_general_ci`。
|
||||||
|
- 开发规范明确数据库、表、连接、迁移、测试和 Review 的全链路要求。
|
||||||
|
- 开发规范明确禁止依赖 MySQL 8.x 专属能力和 `utf8mb4_0900_*` 排序规则。
|
||||||
|
- 文档说明 `utf8mb4_general_ci` 不区分大小写及对身份字段、唯一键和索引长度的影响。
|
||||||
|
- 市场概览第一阶段仍只定义 MySQL Repository 接口,不实际启用数据库。
|
||||||
|
- GOV-005 具备 PRD、需求、设计、实施计划、测试、GitNexus 前后对比、双 Review、发布和回退档案。
|
||||||
|
- 治理测试、文档一致性检查、敏感信息检查和 GitNexus 变更检测通过。
|
||||||
|
- 中文提交和 `v0.0.4` 标签均精确推送到 Gitea。
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GitNexus 开发后结果
|
||||||
|
|
||||||
|
- 执行:`npx gitnexus analyze`。
|
||||||
|
- 工作区索引:528 个节点、553 条关系、5 个集群、0 条执行流程。
|
||||||
|
- 增量分析:6 个已修改文件、18 个新增文件、0 个删除文件,并新增 1 个导入关系到可写集合。
|
||||||
|
- 最终索引提交:`91d9b9c`。
|
||||||
|
- 状态:up-to-date。
|
||||||
|
|
||||||
|
实现提交后再次分析,索引已锚定到确定提交。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GitNexus 开发前基线
|
||||||
|
|
||||||
|
- 功能编号:GOV-005
|
||||||
|
- 记录时间:2026年8月13日 GMT+8 09:45:51
|
||||||
|
- 分支:main
|
||||||
|
- 基线提交:6aa9fed62158
|
||||||
|
|
||||||
|
## 工作区
|
||||||
|
|
||||||
|
```text
|
||||||
|
(干净)
|
||||||
|
```
|
||||||
|
|
||||||
|
## GitNexus 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/12/2026, 6:45:56 PM
|
||||||
|
Indexed commit: 6aa9fed
|
||||||
|
Current commit: 6aa9fed
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 后续人工分析
|
||||||
|
|
||||||
|
在修改代码前,将 GitNexus query、context、impact 的结论写入 `gitnexus/impact-plan.md`。高风险结果必须先获得用户确认。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GitNexus 前后对比
|
||||||
|
|
||||||
|
| 项目 | 开发前 | 开发后工作区 | 变化 |
|
||||||
|
|---|---:|---:|---:|
|
||||||
|
| 节点 | 432 | 528 | +96 |
|
||||||
|
| 关系 | 458 | 553 | +95 |
|
||||||
|
| 集群 | 5 | 5 | 0 |
|
||||||
|
| 执行流程 | 0 | 0 | 0 |
|
||||||
|
|
||||||
|
增长来自数据库规范、契约测试与完整 GOV-005 档案;生产执行流程保持不变,符合影响预估。最终索引锚定实现提交 `91d9b9c`。
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# GitNexus 变更检测
|
||||||
|
|
||||||
|
- 命令:`npx gitnexus detect-changes --repo a-share-analysis --scope staged`。
|
||||||
|
- 最终暂存区:23 个文件、45 个符号。
|
||||||
|
- 受影响流程:0。
|
||||||
|
- 风险等级:低。
|
||||||
|
|
||||||
|
识别范围包含系统架构、开发规范、GOV-005 档案、测试与文档索引;版本纯文本和 Changelog 通过 Git diff 另行核对。
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# GitNexus 开发前影响分析
|
||||||
|
|
||||||
|
- 查询主题:`MySQL 5.7 utf8mb4 general ci compatibility architecture standards`。
|
||||||
|
- 主要关联:`docs/architecture/system-architecture.md`、`docs/governance/code-development-standards.md`、README、文档索引和治理 Review。
|
||||||
|
- 本次不修改既有函数、类或方法;新增测试文件不参与生产调用链,因此没有生产符号需要上游影响分析。
|
||||||
|
- GitNexus 查询没有识别业务执行流程,预计影响限于架构规范、治理测试和版本档案。
|
||||||
|
- 风险控制:测试先行锁定文字契约;不连接数据库、不创建部署配置、不声称已验证真实 MySQL 实例。
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
# MySQL 5.7 字符集与兼容性基线实施计划
|
||||||
|
|
||||||
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||||
|
|
||||||
|
**Goal:** 将 MySQL 5.7.x、`utf8mb4`、`utf8mb4_general_ci` 和禁止 MySQL 8.x 专属能力写入系统架构与开发规范,并以自动化测试锁定。
|
||||||
|
|
||||||
|
**Architecture:** 约束以系统架构定义全局技术基线,以代码开发规范定义实现与 Review 门禁。新增独立 Node.js 静态契约测试读取这两份文档,防止后续删除版本、字符集、排序规则或兼容性要求。
|
||||||
|
|
||||||
|
**Tech Stack:** Markdown、Node.js 内置测试运行器、GitNexus、Git/Gitea。
|
||||||
|
|
||||||
|
## Global Constraints
|
||||||
|
|
||||||
|
- 数据库服务端固定 MySQL 5.7.x,禁止 MySQL 8.x。
|
||||||
|
- 字符集固定 `utf8mb4`,排序规则固定 `utf8mb4_general_ci`。
|
||||||
|
- 数据库、表、连接、迁移和测试环境必须显式声明或验证基线。
|
||||||
|
- 禁止依赖 CTE、窗口函数、函数索引、不可见索引和 `utf8mb4_0900_*`。
|
||||||
|
- 当前只建立规范,不创建数据库、容器、ORM 或生产连接。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Task 1: 建立失败的数据库基线契约测试
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `tools/governance/mysql-baseline.test.mjs`
|
||||||
|
- Modify: `package.json`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: `docs/architecture/system-architecture.md` 与 `docs/governance/code-development-standards.md`。
|
||||||
|
- Produces: `npm run test:mysql-baseline`,验证数据库基线的机器可读证据。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 编写测试**
|
||||||
|
|
||||||
|
测试必须断言两份文档包含 `MySQL 5.7`、`utf8mb4`、`utf8mb4_general_ci`,并断言开发规范包含 MySQL 8.x 禁用能力、大小写语义、索引长度、迁移与 Review 要求。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 验证测试因规范缺失而失败**
|
||||||
|
|
||||||
|
运行:`npm run test:mysql-baseline`
|
||||||
|
|
||||||
|
预期:失败原因明确指向系统架构或开发规范缺少 MySQL 基线文本。
|
||||||
|
|
||||||
|
### Task 2: 更新架构与开发规范
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `docs/architecture/system-architecture.md`
|
||||||
|
- Modify: `docs/governance/code-development-standards.md`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: Task 1 的断言。
|
||||||
|
- Produces: 所有后续数据库、ORM、迁移和部署功能必须遵守的规范。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 更新系统架构**
|
||||||
|
|
||||||
|
增加数据库技术基线、第一阶段接口边界以及正式启用 MySQL 时的验证条件。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 更新开发规范**
|
||||||
|
|
||||||
|
增加 Schema/表/连接/迁移显式配置、5.7 禁用能力、排序语义、索引预算和 Review 检查。
|
||||||
|
|
||||||
|
- [ ] **Step 3: 验证测试转绿**
|
||||||
|
|
||||||
|
运行:`npm run test:mysql-baseline && npm run test:governance`
|
||||||
|
|
||||||
|
预期:全部通过。
|
||||||
|
|
||||||
|
### Task 3: 完成追溯、Review 与发布
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/manifest.yaml`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/prd.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/requirements.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/test-plan.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/gitnexus/impact-plan.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/gitnexus/after.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/gitnexus/detected-changes.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/gitnexus/comparison.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/qa/test-results.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/qa/visual-qa.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/review/code-review.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/review/standards-review.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/release-notes.md`
|
||||||
|
- Create: `docs/features/GOV-005-mysql57-charset-baseline/rollback.md`
|
||||||
|
- Modify: `docs/index.md`
|
||||||
|
- Modify: `CHANGELOG.md`
|
||||||
|
- Modify: `VERSION`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: 通过测试的架构和规范。
|
||||||
|
- Produces: 可审查、可发布、可回退的 GOV-005 完整档案和 `v0.0.4`。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 完成 GitNexus 分析和全部档案**
|
||||||
|
|
||||||
|
重新索引,检测完整暂存区,记录前后节点、关系、流程和风险。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 完成双 Review 与门禁**
|
||||||
|
|
||||||
|
运行:`npm run governance:finish -- GOV-005 mysql57-charset-baseline`
|
||||||
|
|
||||||
|
预期:两份 Review 均为 `passed`,门禁退出码为 0。
|
||||||
|
|
||||||
|
- [ ] **Step 3: 中文提交、推送与标签**
|
||||||
|
|
||||||
|
提交规范变化并推送 `main`;封存验证结果后创建带注释 `v0.0.4`,精确推送该标签并核对远程引用。
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
id: GOV-005
|
||||||
|
name: MySQL 5.7 字符集与兼容性基线
|
||||||
|
slug: mysql57-charset-baseline
|
||||||
|
status: released
|
||||||
|
owner: project
|
||||||
|
created_at: 2026-08-13
|
||||||
|
prd: prd.md
|
||||||
|
requirements: requirements.md
|
||||||
|
design: design.md
|
||||||
|
implementation_plan: implementation-plan.md
|
||||||
|
gitnexus_before: gitnexus/before.md
|
||||||
|
gitnexus_after: gitnexus/after.md
|
||||||
|
gitnexus_comparison: gitnexus/comparison.md
|
||||||
|
code_review: review/code-review.md
|
||||||
|
standards_review: review/standards-review.md
|
||||||
|
implementation_commit: 91d9b9c
|
||||||
|
release: v0.0.4
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# MySQL 5.7 字符集与兼容性基线 PRD
|
||||||
|
|
||||||
|
- 功能编号:GOV-005
|
||||||
|
- PRD 版本:0.1
|
||||||
|
- 状态:approved
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 问题
|
||||||
|
|
||||||
|
项目只写明使用 MySQL,没有固定版本、字符集和排序规则。开发或部署人员可能使用 MySQL 8.x 或不同默认排序规则,造成 SQL、迁移、索引和字符串比较行为不一致。
|
||||||
|
|
||||||
|
## 目标
|
||||||
|
|
||||||
|
- 固定 MySQL 5.7.x、`utf8mb4` 和 `utf8mb4_general_ci`。
|
||||||
|
- 在架构和开发规范中覆盖数据库、表、连接、迁移、测试与 Review。
|
||||||
|
- 禁止无意引入 MySQL 8.x 专属能力。
|
||||||
|
- 用自动化契约测试防止规范回退。
|
||||||
|
|
||||||
|
## 非目标
|
||||||
|
|
||||||
|
- 不安装或启动 MySQL。
|
||||||
|
- 不创建 Schema、表、迁移或 ORM 配置。
|
||||||
|
- 不连接开发或生产数据库。
|
||||||
|
- 不启用市场概览持久化。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 系统架构明确 MySQL 5.7.x、字符集和排序规则。
|
||||||
|
- 开发规范明确全链路显式配置、禁止能力、大小写语义和索引预算。
|
||||||
|
- 新契约测试在旧规范上失败,在新规范上通过。
|
||||||
|
- 原治理测试无回归。
|
||||||
|
- 双 Review 和完成门禁通过。
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# 测试结果
|
||||||
|
|
||||||
|
## 测试先行证据
|
||||||
|
|
||||||
|
新增 `mysql-baseline.test.mjs` 后首次运行:2 个测试失败。架构测试明确因缺少 `MySQL 5.7` 失败,开发规范测试明确因缺少数据库基线失败,证明测试能够捕获目标缺陷。
|
||||||
|
|
||||||
|
补充架构和开发规范后复测:
|
||||||
|
|
||||||
|
- `npm run test:mysql-baseline`:2 个通过,0 个失败。
|
||||||
|
- `npm run test:governance`:5 个通过,0 个失败。
|
||||||
|
- `git diff --check`:通过。
|
||||||
|
- GitNexus 最终暂存区:23 个文件、45 个符号、0 条流程,风险为低。
|
||||||
|
|
||||||
|
## 适用性
|
||||||
|
|
||||||
|
本功能只建立设计与规范,没有 MySQL 实例、Schema 或连接,因此不执行数据库连通性测试。真实 MySQL 5.7 验证属于首次启用持久化的后续功能门禁。
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# 视觉验证
|
||||||
|
|
||||||
|
本功能只修改架构、开发规范、治理测试和追溯文档,不改变任何页面或交互,因此视觉验证不适用。
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# 发布说明
|
||||||
|
|
||||||
|
## v0.0.4
|
||||||
|
|
||||||
|
- 实现提交:`91d9b9c`。
|
||||||
|
- 固定 MySQL 5.7.x、`utf8mb4` 和 `utf8mb4_general_ci`。
|
||||||
|
- 增加 MySQL 8.x 禁用能力、排序语义、索引和迁移规范。
|
||||||
|
- 新增数据库基线契约测试。
|
||||||
|
- 第一阶段仍不启用 MySQL,只为后续 Repository 实现建立兼容基线。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# 工程需求
|
||||||
|
|
||||||
|
- 系统架构增加独立数据库技术基线章节。
|
||||||
|
- 开发规范固定 MySQL 5.7.x、`utf8mb4`、`utf8mb4_general_ci`。
|
||||||
|
- 禁止 CTE、窗口函数、函数索引、不可见索引和 `utf8mb4_0900_*`。
|
||||||
|
- 解释默认排序不区分大小写对身份字段和唯一键的影响。
|
||||||
|
- 规定 MySQL 5.7 下索引长度预算、JSON 使用边界和 `CHECK` 约束替代方案。
|
||||||
|
- 迁移必须从上一版本基线正向验证,禁止直接修改共享表代替迁移。
|
||||||
|
- 新增 Node.js 静态契约测试并加入 npm 脚本。
|
||||||
|
- 第一阶段只定义 Repository 接口,不启用 MySQL。
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# 代码与规范 Review
|
||||||
|
|
||||||
|
- reviewer_type:self
|
||||||
|
- reviewer:Codex
|
||||||
|
- 基线提交:`6aa9fed`
|
||||||
|
- 设计提交:`0328f9e`
|
||||||
|
- 实现提交:`91d9b9c`
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## PRD 与设计符合性
|
||||||
|
|
||||||
|
架构固定数据库服务端、字符集、排序规则和第一阶段接口边界;开发规范覆盖 Schema、表、连接、迁移、查询、索引、测试和 Review;自动化测试锁定关键文本。
|
||||||
|
|
||||||
|
## 发现与处置
|
||||||
|
|
||||||
|
| 严重程度 | 发现 | 处置 |
|
||||||
|
|---|---|---|
|
||||||
|
| Important | 只写 MySQL 无法防止开发环境使用 8.x | 架构和规范固定 5.7.x,并要求真实环境验证 |
|
||||||
|
| Important | 只依赖服务器默认字符集可能产生混合排序规则 | 要求数据库、表、连接与迁移显式声明或验证 |
|
||||||
|
| Important | `utf8mb4_general_ci` 不区分大小写,身份字段可能发生碰撞 | 规范要求输入标准化或经批准的二进制比较与唯一键 |
|
||||||
|
| Minor | 纯文档约束容易被后续编辑删除 | 新增静态契约测试并完成红绿验证 |
|
||||||
|
|
||||||
|
## 验证
|
||||||
|
|
||||||
|
- 数据库基线测试 2/2 通过。
|
||||||
|
- 治理测试 5/5 通过。
|
||||||
|
- GitNexus 最终暂存区检测为 23 个文件、45 个符号、0 条流程、低风险。
|
||||||
|
- 未连接或修改任何数据库。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 开发规范符合性 Review
|
||||||
|
|
||||||
|
- reviewer_type:self
|
||||||
|
- reviewer:Codex
|
||||||
|
- 实现提交:`91d9b9c`
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 检查结果
|
||||||
|
|
||||||
|
- [x] 开发前运行治理启动和 GitNexus 查询。
|
||||||
|
- [x] 设计经用户确认后实施。
|
||||||
|
- [x] 新行为先有失败测试,再修改规范使其通过。
|
||||||
|
- [x] 变更集中在架构、开发规范和一个可连续阅读的测试文件。
|
||||||
|
- [x] 没有连接生产或开发数据库。
|
||||||
|
- [x] 没有新增依赖、秘密、环境配置或业务数据。
|
||||||
|
- [x] MySQL 5.7、字符集、排序规则和 8.x 禁用能力均可机器验证。
|
||||||
|
- [x] 无界面变化,视觉验证标记不适用。
|
||||||
|
|
||||||
|
没有未解决的 Critical 或 Important 不符合项。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# 回退说明
|
||||||
|
|
||||||
|
本功能没有连接或修改数据库,回退不涉及数据操作。规则发布后如需修正,使用新的治理功能编号和中文修复提交更新架构、规范与测试,不移动或删除共享版本标签。
|
||||||
|
|
||||||
|
回退到 `v0.0.3` 只能用于读取升级前文档;后续已经按 MySQL 5.7 基线创建的迁移或部署不得通过改写历史撤销。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# 测试计划
|
||||||
|
|
||||||
|
- 先运行新增数据库基线测试,证明旧架构与规范因缺少 MySQL 5.7 约束而失败。
|
||||||
|
- 更新文档后复测,要求数据库基线测试 2 个通过、0 个失败。
|
||||||
|
- 运行治理测试,要求 5 个通过、0 个失败。
|
||||||
|
- 运行 `git diff --check`。
|
||||||
|
- 扫描仓库和暂存区,确认没有凭据或生产配置。
|
||||||
|
- 执行 GitNexus 增量分析与最终暂存区变更检测。
|
||||||
|
- 执行 `npm run governance:finish -- GOV-005 mysql57-charset-baseline`。
|
||||||
|
- 本功能无界面变化,视觉验证不适用。
|
||||||
@@ -0,0 +1,177 @@
|
|||||||
|
# 开发、生产环境与双部署方式设计规格
|
||||||
|
|
||||||
|
- 功能编号:GOV-006
|
||||||
|
- 规格版本:0.1
|
||||||
|
- 状态:approved_for_review
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 背景与目标
|
||||||
|
|
||||||
|
项目已经明确前后端和基础设施技术栈,但目前只有 `.gitignore` 排除 `.env`,没有正式的开发/生产配置契约、模板结构、加载优先级和部署边界。缺少这些规则会导致本地开发误用生产配置、生产回退到模拟数据、不同部署方式使用不同变量,以及密钥进入仓库或构建产物。
|
||||||
|
|
||||||
|
本功能建立统一的环境配置体系,并同时支持 Docker Compose 与 Ubuntu 源码生产部署。两种生产方式必须使用相同变量名、配置校验、进程边界和发布版本,不允许形成两套行为不同的应用。
|
||||||
|
|
||||||
|
## 环境模型
|
||||||
|
|
||||||
|
项目只定义两个应用运行环境:
|
||||||
|
|
||||||
|
- `development`:本地开发、热更新、确定性模拟数据和开发 Redis。
|
||||||
|
- `production`:线上运行,禁止热更新、调试端口、模拟数据和开发默认值回退。
|
||||||
|
|
||||||
|
测试运行使用测试工具自己的隔离配置,不把 `test` 作为可部署环境。应用启动必须显式获得环境值;生产环境缺少配置或出现非法组合时立即退出,不能静默使用开发默认值。
|
||||||
|
|
||||||
|
业务代码不得到处分支判断环境。环境差异在配置加载、依赖注入和基础设施 Adapter 边界收敛,纯业务计算保持一致。
|
||||||
|
|
||||||
|
## 仓库模板结构
|
||||||
|
|
||||||
|
仓库提交完整但不含秘密的模板:
|
||||||
|
|
||||||
|
```text
|
||||||
|
deploy/env/
|
||||||
|
├── development/
|
||||||
|
│ ├── api.env.example
|
||||||
|
│ ├── scheduler.env.example
|
||||||
|
│ ├── worker.env.example
|
||||||
|
│ └── web.env.example
|
||||||
|
└── production/
|
||||||
|
├── api.env.example
|
||||||
|
├── scheduler.env.example
|
||||||
|
├── worker.env.example
|
||||||
|
└── web.env.example
|
||||||
|
```
|
||||||
|
|
||||||
|
每个模板必须为每项变量写明用途、示例格式、是否必填、敏感性和启用条件。密码、Token 和 API Key 使用空值,不使用看似真实的占位凭据。
|
||||||
|
|
||||||
|
真实开发配置使用同目录或项目约定位置的 `*.env.local`,由 Git 忽略。真实生产配置永远不放在仓库、发布目录、镜像层或前端构建产物中。
|
||||||
|
|
||||||
|
## 配置契约与校验
|
||||||
|
|
||||||
|
API、Scheduler、Worker 使用独立 Schema 校验各自配置,遵守最小知情范围:
|
||||||
|
|
||||||
|
- API:HTTP 监听、Redis、当前快照、按需历史读取和 AI 调用配置。
|
||||||
|
- Scheduler:时区、交易日调度、Redis 分布式锁;RabbitMQ 未启用时使用服务内调度 Adapter。
|
||||||
|
- Worker:数据源、Redis、分析配置;未来启用时增加 MySQL、RabbitMQ 和 AI 变量。
|
||||||
|
- Web:只允许公开的 `VITE_*` 构建变量,例如 API 相对路径和应用标题。
|
||||||
|
|
||||||
|
功能开关控制条件必填:MySQL、RabbitMQ、正式数据源或 AI 未启用时,其连接变量可以为空;一旦开关启用,相关变量缺失、格式错误或不安全时必须拒绝启动。
|
||||||
|
|
||||||
|
前端构建环境变量会进入浏览器代码,任何数据库、Redis、RabbitMQ、数据源或 AI 凭据都不得使用 `VITE_*` 前缀。
|
||||||
|
|
||||||
|
## 本地开发方式
|
||||||
|
|
||||||
|
本地开发默认使用 Docker Compose 只启动 Redis。Web、API、Scheduler 和 Worker 直接从源码运行,使用热更新和开发配置,便于调试。
|
||||||
|
|
||||||
|
第一阶段不启动 MySQL 和 RabbitMQ:
|
||||||
|
|
||||||
|
- MySQL 只定义 Repository 接口并使用内存实现。
|
||||||
|
- RabbitMQ 只定义消息契约和发布接口,Scheduler 通过服务内 Adapter 调用任务。
|
||||||
|
- Redis 是第一阶段唯一实际启用的外部基础设施,用于当前快照、缓存、刷新锁和调度锁。
|
||||||
|
|
||||||
|
开发 Compose 文件不得加载生产配置,不得连接生产地址。开发服务名、网络和数据目录必须使用项目专用前缀,避免影响其他项目。
|
||||||
|
|
||||||
|
## Docker Compose 生产部署
|
||||||
|
|
||||||
|
生产 Compose 支持运行 Web/Nginx、API、Scheduler、Worker,以及按部署选择连接内部或外部 Redis、MySQL 5.7 和 RabbitMQ。第一阶段未启用的组件不应为了形式完整而启动。
|
||||||
|
|
||||||
|
要求:
|
||||||
|
|
||||||
|
- 镜像对应明确 Git 提交或版本标签,禁止使用浮动 `latest` 作为可回退版本。
|
||||||
|
- 使用外部指定的生产 env 文件加载同一配置契约,不把秘密写入 Compose YAML。
|
||||||
|
- 禁止源码挂载、热更新、调试端口和开发命令。
|
||||||
|
- 服务提供健康检查、日志边界、启动顺序和优雅停止。
|
||||||
|
- 数据目录使用明确宿主机路径或经确认的持久化方案,升级不得删除数据。
|
||||||
|
|
||||||
|
## Ubuntu 源码生产部署
|
||||||
|
|
||||||
|
正式支持平台:
|
||||||
|
|
||||||
|
- Ubuntu 22.04 LTS x86_64。
|
||||||
|
- Ubuntu 24.04 LTS x86_64。
|
||||||
|
|
||||||
|
服务器管理员预先提供并维护:
|
||||||
|
|
||||||
|
- Node.js 22 LTS。
|
||||||
|
- pnpm 10。
|
||||||
|
- Nginx。
|
||||||
|
- MySQL 5.7、Redis、RabbitMQ 或对应外部服务。
|
||||||
|
|
||||||
|
项目只验证版本和连通性,不修改软件源,不安装或升级 Node.js、pnpm、Nginx、MySQL、Redis 或 RabbitMQ。版本不符合要求时部署立即终止并给出明确错误。
|
||||||
|
|
||||||
|
依赖安装必须使用 `pnpm install --frozen-lockfile`。Web 构建为静态文件后由 Nginx 托管;API、Scheduler 和 Worker 运行编译后的 JavaScript,禁止在生产运行 TypeScript、Vite 开发服务器、Nest watch 或源码热更新。
|
||||||
|
|
||||||
|
## systemd 与生产配置位置
|
||||||
|
|
||||||
|
源码部署使用单个非登录系统用户 `a-share` 运行 API、Scheduler 和 Worker。第一阶段先降低部署复杂度,但仍把配置拆为独立文件,为以后按进程拆系统用户保留边界。
|
||||||
|
|
||||||
|
生产配置固定存放在发布目录之外:
|
||||||
|
|
||||||
|
```text
|
||||||
|
/etc/a-share-analysis/
|
||||||
|
├── api.env
|
||||||
|
├── scheduler.env
|
||||||
|
├── worker.env
|
||||||
|
└── web.env
|
||||||
|
```
|
||||||
|
|
||||||
|
systemd 单元通过 `EnvironmentFile=/etc/a-share-analysis/<进程>.env` 在启动时注入变量。切换 `/opt/a-share-analysis/current` 指向的应用版本不会覆盖配置。
|
||||||
|
|
||||||
|
API、Scheduler 和 Worker 分别只引用自己的 env 文件。第一阶段文件所有者为 `root:a-share`,包含秘密的文件权限为 `0640`;Web 配置只含公开构建变量,可由部署构建步骤读取。未来接入高价值数据源和 AI 密钥时,评估拆分独立系统用户和更细的文件组权限。
|
||||||
|
|
||||||
|
## 发布目录与进程边界
|
||||||
|
|
||||||
|
源码部署建议使用不可变版本目录:
|
||||||
|
|
||||||
|
```text
|
||||||
|
/opt/a-share-analysis/
|
||||||
|
├── releases/<版本或提交>/
|
||||||
|
└── current -> releases/<当前版本>/
|
||||||
|
```
|
||||||
|
|
||||||
|
更新时先在新目录安装、构建和校验,再原子切换 `current` 并重启服务。回退切回上一完整版本,不在旧目录上覆盖文件。
|
||||||
|
|
||||||
|
Nginx 托管当前版本 Web 静态产物并反向代理 API。API、Scheduler、Worker 为独立 systemd 服务;任一后台进程异常不得由 API 请求临时替代执行全市场采集任务。
|
||||||
|
|
||||||
|
## MySQL 兼容约束
|
||||||
|
|
||||||
|
两种部署方式和两个环境都受 GOV-005 约束:MySQL 固定 5.7.x,字符集 `utf8mb4`,排序规则 `utf8mb4_general_ci`。项目启动或迁移必须验证该条件,不得在开发环境使用 8.x 再假设向下兼容。
|
||||||
|
|
||||||
|
第一阶段 MySQL 未启用,因此配置模板保留功能开关和条件变量,但默认不连接数据库。
|
||||||
|
|
||||||
|
## 安全与防误用
|
||||||
|
|
||||||
|
- `.env`、`.env.*` 和 `*.env.local` 默认忽略,只允许提交 `*.env.example`。
|
||||||
|
- 模板、日志、错误和诊断输出不得包含真实秘密。
|
||||||
|
- 生产启动必须检查 `APP_ENV=production`,并拒绝模拟数据、开发 URL、调试模式和空的已启用服务凭据。
|
||||||
|
- 开发配置不得包含或连接生产主机;项目脚本禁止读取生产数据库进行开发验证。
|
||||||
|
- Docker Compose 与源码部署使用相同变量名称和 Schema,不用环境专属别名隐藏差异。
|
||||||
|
- Web 配置仅含公开值;所有付费 AI 和数据源密钥只存在服务端配置。
|
||||||
|
|
||||||
|
## 运维文档范围
|
||||||
|
|
||||||
|
两种生产部署方式都必须提供:
|
||||||
|
|
||||||
|
- 前置条件和版本检查。
|
||||||
|
- 初次部署、配置填充、构建和启动步骤。
|
||||||
|
- 健康检查、日志读取和进程状态检查。
|
||||||
|
- 使用确定版本的升级流程。
|
||||||
|
- 配置不变的应用回退流程。
|
||||||
|
- 数据服务备份职责声明和故障边界。
|
||||||
|
|
||||||
|
源码部署文档不提供基础设施安装脚本。Docker Compose 文档不能暗示其配置可以直接用于本地开发。
|
||||||
|
|
||||||
|
## 实施范围
|
||||||
|
|
||||||
|
GOV-006 建立环境规范、变量模板、开发 Redis Compose、生产部署骨架、systemd/Nginx 示例及验证脚本的设计与追溯基础。由于 Web、Server、Scheduler 和 Worker 尚未实现,当前可先提供结构完整的模板和部署规范;具体应用启动命令在相应项目脚手架落地后通过后续功能验证,不得伪造已可运行状态。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 仓库包含开发与生产环境下 API、Scheduler、Worker、Web 的八份无秘密模板。
|
||||||
|
- 本地开发仅通过 Compose 启动项目专用 Redis,应用从源码运行。
|
||||||
|
- 生产同时有 Docker Compose 和 Ubuntu 22.04/24.04 x86_64 源码部署规范。
|
||||||
|
- 源码部署明确管理员提供 Node.js 22 LTS、pnpm 10、Nginx 和基础设施,项目只验证不安装。
|
||||||
|
- 源码部署明确单个 `a-share` 用户、独立 EnvironmentFile 和发布目录边界。
|
||||||
|
- Docker Compose 与源码部署共用配置变量和校验规则。
|
||||||
|
- 生产环境无法回退到模拟数据、开发默认值、热更新或调试配置。
|
||||||
|
- MySQL 条件配置符合 GOV-005,第一阶段默认不启用 MySQL 和 RabbitMQ。
|
||||||
|
- 治理测试、模板静态检查、敏感信息检查、GitNexus 变更检测和双 Review 通过。
|
||||||
|
- 中文提交和对应版本标签精确推送到 Gitea。
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GitNexus 开发后结果
|
||||||
|
|
||||||
|
- 执行:`npx gitnexus analyze`。
|
||||||
|
- 工作区索引:620 个节点、651 条关系、7 个集群、0 条执行流程。
|
||||||
|
- 增量分析:7 个已修改文件、25 个新增文件、0 个删除文件。
|
||||||
|
- 最终索引提交:`9203fdd`。
|
||||||
|
- 状态:up-to-date。
|
||||||
|
|
||||||
|
实现提交后再次分析,索引已锚定最终提交。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GitNexus 开发前基线
|
||||||
|
|
||||||
|
- 功能编号:GOV-006
|
||||||
|
- 记录时间:2026年8月13日 GMT+8 10:34:15
|
||||||
|
- 分支:main
|
||||||
|
- 基线提交:0328f9e3d27d
|
||||||
|
|
||||||
|
## 工作区
|
||||||
|
|
||||||
|
```text
|
||||||
|
M AGENTS.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## GitNexus 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/13/2026, 10:34:14 AM
|
||||||
|
Indexed commit: 0328f9e
|
||||||
|
Current commit: 0328f9e
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 后续人工分析
|
||||||
|
|
||||||
|
在修改代码前,将 GitNexus query、context、impact 的结论写入 `gitnexus/impact-plan.md`。高风险结果必须先获得用户确认。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GitNexus 前后对比
|
||||||
|
|
||||||
|
| 项目 | 开发前 | 开发后工作区 | 变化 |
|
||||||
|
|---|---:|---:|---:|
|
||||||
|
| 节点 | 452 | 620 | +168 |
|
||||||
|
| 关系 | 477 | 651 | +174 |
|
||||||
|
| 集群 | 5 | 7 | +2 |
|
||||||
|
| 执行流程 | 0 | 0 | 0 |
|
||||||
|
|
||||||
|
新增集群来自环境模板与部署文档边界;没有生产执行流程变化,符合影响预估。最终索引锚定实现提交 `9203fdd`。
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# GitNexus 变更检测
|
||||||
|
|
||||||
|
- 命令:`npx gitnexus detect-changes --repo a-share-analysis --scope staged`。
|
||||||
|
- 最终暂存区:43 个文件、77 个符号。
|
||||||
|
- 受影响流程:0。
|
||||||
|
- 风险等级:低。
|
||||||
|
|
||||||
|
范围包含配置模板、Compose、systemd、Nginx、部署文档、现行治理入口、契约测试和 GOV-006 档案。
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# GitNexus 开发前影响分析
|
||||||
|
|
||||||
|
- 查询主题:`development production environment templates Docker Compose Ubuntu source deployment systemd`。
|
||||||
|
- 关联范围:README、开发流程、开发规范、系统架构、GOV-005 和部署目录。
|
||||||
|
- 本次新增配置、文档和静态测试,不修改既有生产函数、类或方法,无生产符号上游影响目标。
|
||||||
|
- GitNexus 未识别业务执行流程;预计影响限于配置契约、部署边界和治理测试。
|
||||||
|
- 风险控制:不提交真实秘密,不运行应用部署,不连接任何生产服务,明确示例骨架的未验证状态。
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
# 开发、生产环境与双部署方式实施计划
|
||||||
|
|
||||||
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||||
|
|
||||||
|
**Goal:** 建立可机器验证的开发/生产环境变量契约、本地 Redis Compose,以及 Docker Compose 与 Ubuntu 源码生产部署规范和配置骨架。
|
||||||
|
|
||||||
|
**Architecture:** 八份 env 模板按进程和环境分离,但同一进程在 development/production 使用相同变量名。静态契约测试负责检查模板完整性、敏感值为空、Web 仅暴露 `VITE_*`、生产安全默认值和部署文件边界;当前应用尚未实现,不伪造可运行的应用镜像或启动命令。
|
||||||
|
|
||||||
|
**Tech Stack:** dotenv 模板、Docker Compose、Redis、systemd、Nginx、Node.js 内置测试运行器、Markdown、GitNexus。
|
||||||
|
|
||||||
|
## Global Constraints
|
||||||
|
|
||||||
|
- 环境仅定义 `development` 与 `production`,生产禁止模拟数据、热更新和开发默认值回退。
|
||||||
|
- 仓库提交八份 `*.env.example`,不提交任何真实 `.env` 或凭据。
|
||||||
|
- 本地 Compose 只启动 Redis;Web/API/Scheduler/Worker 从源码运行。
|
||||||
|
- 生产支持 Docker Compose 和 Ubuntu 22.04/24.04 x86_64 源码部署。
|
||||||
|
- Node.js 22 LTS、pnpm 10、Nginx 和基础设施由管理员提供,项目只验证不安装。
|
||||||
|
- 源码部署使用 `a-share` 用户和 `/etc/a-share-analysis/*.env`。
|
||||||
|
- MySQL 与 RabbitMQ 第一阶段默认关闭;MySQL 条件配置遵守 GOV-005。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Task 1: 建立失败的环境配置契约测试
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `tools/governance/environment-baseline.test.mjs`
|
||||||
|
- Modify: `package.json`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: `deploy/env/`、`deploy/compose/`、`deploy/systemd/`、`deploy/nginx/` 和 `docs/deployment/`。
|
||||||
|
- Produces: `npm run test:environment-baseline`。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 编写模板和部署边界测试**
|
||||||
|
|
||||||
|
测试八份模板存在、同一进程两环境键集合相同、敏感键为空、Web 仅含 `VITE_*`、生产安全开关正确、本地 Compose 仅定义 Redis,并检查 systemd/Nginx 与两份生产部署文档。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 验证测试因文件缺失而失败**
|
||||||
|
|
||||||
|
运行:`npm run test:environment-baseline`
|
||||||
|
|
||||||
|
预期:失败明确指出第一份缺少的环境模板或部署文件。
|
||||||
|
|
||||||
|
### Task 2: 实现统一环境模板
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `deploy/env/development/api.env.example`
|
||||||
|
- Create: `deploy/env/development/scheduler.env.example`
|
||||||
|
- Create: `deploy/env/development/worker.env.example`
|
||||||
|
- Create: `deploy/env/development/web.env.example`
|
||||||
|
- Create: `deploy/env/production/api.env.example`
|
||||||
|
- Create: `deploy/env/production/scheduler.env.example`
|
||||||
|
- Create: `deploy/env/production/worker.env.example`
|
||||||
|
- Create: `deploy/env/production/web.env.example`
|
||||||
|
- Modify: `.gitignore`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: GOV-006 设计中的变量作用域。
|
||||||
|
- Produces: 后续 NestJS Schema 和部署方式共同使用的变量名契约。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 编写四类进程模板**
|
||||||
|
|
||||||
|
每项变量附中文说明;敏感变量保持空值;MySQL/RabbitMQ/AI 由功能开关控制条件必填;生产值拒绝模拟数据和调试模式。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 加固忽略规则**
|
||||||
|
|
||||||
|
只允许提交 `*.env.example`,忽略 `*.env.local`、真实 env 和本地运行目录。
|
||||||
|
|
||||||
|
### Task 3: 实现本地 Redis 与生产部署骨架
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `deploy/compose/development.yml`
|
||||||
|
- Create: `deploy/compose/production.yml.example`
|
||||||
|
- Create: `deploy/systemd/a-share-api.service.example`
|
||||||
|
- Create: `deploy/systemd/a-share-scheduler.service.example`
|
||||||
|
- Create: `deploy/systemd/a-share-worker.service.example`
|
||||||
|
- Create: `deploy/nginx/a-share-analysis.conf.example`
|
||||||
|
- Create: `docs/deployment/local-development.md`
|
||||||
|
- Create: `docs/deployment/docker-compose-production.md`
|
||||||
|
- Create: `docs/deployment/ubuntu-source-production.md`
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: Task 2 的模板键集合。
|
||||||
|
- Produces: 本地 Redis 启动入口、生产 Compose 配置边界、systemd EnvironmentFile 和 Nginx 代理示例。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 配置本地 Redis Compose**
|
||||||
|
|
||||||
|
固定 Redis 镜像补丁版本,只暴露本机端口,使用项目专用容器名、网络、健康检查和仓库外本地数据目录;不得定义其他服务。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 配置生产部署骨架**
|
||||||
|
|
||||||
|
生产 Compose 只表达应用服务的配置契约和不可变镜像要求;systemd 使用独立 EnvironmentFile,Nginx 托管静态文件并代理 `/api/`。
|
||||||
|
|
||||||
|
- [ ] **Step 3: 编写开发与双生产部署文档**
|
||||||
|
|
||||||
|
明确当前应用尚未脚手架化,文档只验证配置与部署边界;列出管理员前置条件、版本检查、健康检查、升级和回退规则。
|
||||||
|
|
||||||
|
- [ ] **Step 4: 验证测试转绿**
|
||||||
|
|
||||||
|
运行:`npm run test:environment-baseline && npm run test:mysql-baseline && npm run test:governance`
|
||||||
|
|
||||||
|
预期:全部通过。Docker 可用时额外运行 `docker compose -f deploy/compose/development.yml config`。
|
||||||
|
|
||||||
|
### Task 4: 完成现行规范、追溯与发布
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `docs/architecture/system-architecture.md`
|
||||||
|
- Modify: `docs/governance/code-development-standards.md`
|
||||||
|
- Modify: `docs/governance/development-workflow.md`
|
||||||
|
- Modify: `README.md`
|
||||||
|
- Modify: `docs/index.md`
|
||||||
|
- Modify: `CHANGELOG.md`
|
||||||
|
- Modify: `VERSION`
|
||||||
|
- Create: GOV-006 除现有 `design.md`、`implementation-plan.md`、`gitnexus/before.md` 外的全部必备档案。
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: 通过契约测试的配置与部署文件。
|
||||||
|
- Produces: 可审查、可发布、可回退的 GOV-006 完整档案和 `v0.0.5`。
|
||||||
|
|
||||||
|
- [ ] **Step 1: 更新架构和开发规范**
|
||||||
|
|
||||||
|
记录环境模型、配置校验、两种部署方式、平台范围、管理员职责和生产防误用要求。
|
||||||
|
|
||||||
|
- [ ] **Step 2: 执行 GitNexus、测试和双 Review**
|
||||||
|
|
||||||
|
检测完整暂存区并运行 `npm run governance:finish -- GOV-006 environment-deployment-baseline`。
|
||||||
|
|
||||||
|
- [ ] **Step 3: 中文提交、推送与发布**
|
||||||
|
|
||||||
|
提交并推送 `main`;封存后创建带注释 `v0.0.5`,精确推送并核对分支与标签。
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
id: GOV-006
|
||||||
|
name: 开发、生产环境与双部署方式
|
||||||
|
slug: environment-deployment-baseline
|
||||||
|
status: released
|
||||||
|
owner: project
|
||||||
|
created_at: 2026-08-13
|
||||||
|
prd: prd.md
|
||||||
|
requirements: requirements.md
|
||||||
|
design: design.md
|
||||||
|
implementation_plan: implementation-plan.md
|
||||||
|
gitnexus_before: gitnexus/before.md
|
||||||
|
gitnexus_after: gitnexus/after.md
|
||||||
|
gitnexus_comparison: gitnexus/comparison.md
|
||||||
|
code_review: review/code-review.md
|
||||||
|
standards_review: review/standards-review.md
|
||||||
|
implementation_commit: 9203fdd
|
||||||
|
release: v0.0.5
|
||||||
|
superseded_by: GOV-009/source-only-deployment-design.md
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# 开发、生产环境与双部署方式 PRD
|
||||||
|
|
||||||
|
- 功能编号:GOV-006
|
||||||
|
- PRD 版本:0.1
|
||||||
|
- 状态:approved
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 问题
|
||||||
|
|
||||||
|
项目缺少开发/生产配置契约和部署边界,存在真实配置入库、生产误用模拟数据及两种部署方式行为漂移的风险。
|
||||||
|
|
||||||
|
## 目标
|
||||||
|
|
||||||
|
- 提供开发和生产的四类进程无秘密模板。
|
||||||
|
- 本地只用 Compose 启动 Redis,应用从源码运行。
|
||||||
|
- 同时规范 Docker Compose 与 Ubuntu 源码生产部署。
|
||||||
|
- 生产配置严格校验且不随发布版本覆盖。
|
||||||
|
|
||||||
|
## 非目标
|
||||||
|
|
||||||
|
- 不安装服务器运行时或基础设施。
|
||||||
|
- 不声称尚未实现的应用镜像、进程和健康端点已经可运行。
|
||||||
|
- 不启用 MySQL、RabbitMQ、正式数据源或 AI。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 八份模板完整、跨环境键一致且无敏感值。
|
||||||
|
- Web 模板只含公开 `VITE_*` 变量。
|
||||||
|
- 开发 Compose 仅定义 Redis并可通过配置解析。
|
||||||
|
- systemd、Nginx 和三份部署文档满足已确认平台与路径边界。
|
||||||
|
- 环境契约测试完成红绿验证,双 Review 和治理门禁通过。
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# 测试结果
|
||||||
|
|
||||||
|
## 测试先行证据
|
||||||
|
|
||||||
|
新增环境基线测试后首次运行 6 个测试全部失败,分别指出八份模板、开发 Compose、systemd/Nginx 示例和部署文档不存在。
|
||||||
|
|
||||||
|
补齐最小实现后:
|
||||||
|
|
||||||
|
- 环境基线测试:6 个通过,0 个失败。
|
||||||
|
- MySQL 基线测试:2 个通过,0 个失败。
|
||||||
|
- 治理测试:5 个通过,0 个失败。
|
||||||
|
- `docker compose -f deploy/compose/development.yml config`:通过,仅包含 Redis。
|
||||||
|
- `git diff --check`:通过。
|
||||||
|
- GitNexus 最终暂存区:43 个文件、77 个符号、0 条流程,风险为低。
|
||||||
|
|
||||||
|
生产 Compose 和源码部署当前属于配置契约骨架,应用尚未脚手架化,因此没有伪造生产启动或健康检查成功证据。
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# 视觉验证
|
||||||
|
|
||||||
|
本功能没有页面或交互变化,视觉验证不适用。
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# 发布说明
|
||||||
|
|
||||||
|
## v0.0.5
|
||||||
|
|
||||||
|
- 实现提交:`9203fdd`。
|
||||||
|
- 新增八份开发/生产无秘密环境模板。
|
||||||
|
- 新增只启动 Redis 的本地开发 Compose。
|
||||||
|
- 新增生产 Compose 契约骨架、systemd/Nginx 示例和 Ubuntu 源码部署规范。
|
||||||
|
- 新增环境配置自动化契约测试。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# 工程需求
|
||||||
|
|
||||||
|
- 环境只定义 `development` 与 `production`。
|
||||||
|
- API、Scheduler、Worker、Web 分别提供开发/生产模板,同进程键集合一致。
|
||||||
|
- 敏感变量保持空值,真实配置被 Git 忽略。
|
||||||
|
- 生产 Worker 固定 `MARKET_DATA_MODE=live`,第一阶段关闭 MySQL 与 RabbitMQ。
|
||||||
|
- 本地 Compose 固定 Redis 补丁版本、仅绑定本机并提供健康检查。
|
||||||
|
- Ubuntu 源码部署支持 22.04/24.04 LTS x86_64、Node.js 22 LTS、pnpm 10。
|
||||||
|
- systemd 使用 `a-share` 用户及独立 `EnvironmentFile`;Nginx 托管静态文件并代理 API。
|
||||||
|
- 生产 Compose 使用不可变镜像和外部 env,不承诺当前骨架可直接上线。
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# 配置与文档 Review
|
||||||
|
|
||||||
|
- reviewer_type:self
|
||||||
|
- reviewer:Codex
|
||||||
|
- 基线提交:`0328f9e`
|
||||||
|
- 设计提交:`fa1df71`
|
||||||
|
- 实现提交:`9203fdd`
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 审查结论
|
||||||
|
|
||||||
|
八份模板保持跨环境键一致,敏感值为空,Web 只含公开变量;开发 Compose 只启动 Redis;生产部署示例明确为未验证骨架。现行架构和规范覆盖启动校验、防误用与管理员职责。
|
||||||
|
|
||||||
|
## 发现与处置
|
||||||
|
|
||||||
|
| 严重程度 | 发现 | 处置 |
|
||||||
|
|---|---|---|
|
||||||
|
| Important | 两种部署方式可能形成不同变量协议 | 强制复用同一模板键并用自动测试比较 |
|
||||||
|
| Important | 示例容易被误认为可直接上线 | Compose 和文档显式标记需在应用脚手架后验证 |
|
||||||
|
| Important | 前端变量可能泄露服务端秘密 | 测试要求 Web 模板每个键都以 `VITE_` 开头且只含公开值 |
|
||||||
|
| Minor | 本地 Redis 数据可能进入仓库 | 使用 `.local/redis` 并加固忽略规则 |
|
||||||
|
|
||||||
|
- 环境契约测试 6/6、MySQL 基线 2/2、治理测试 5/5 通过。
|
||||||
|
- Docker Compose 配置解析成功且只包含 Redis。
|
||||||
|
- GitNexus 最终暂存区检测为 43 个文件、77 个符号、0 条流程、低风险。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 开发规范符合性 Review
|
||||||
|
|
||||||
|
- reviewer_type:self
|
||||||
|
- reviewer:Codex
|
||||||
|
- 实现提交:`9203fdd`
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 检查结果
|
||||||
|
|
||||||
|
- [x] 设计经用户确认后实施。
|
||||||
|
- [x] 环境契约先有 6 个失败测试,再补实现使其通过。
|
||||||
|
- [x] 模板无真实秘密,真实 env 与本地数据被忽略。
|
||||||
|
- [x] 不连接或探测生产服务,不安装服务器软件。
|
||||||
|
- [x] MySQL 变量符合 GOV-005,第一阶段默认关闭。
|
||||||
|
- [x] Docker Compose 与源码部署共享变量契约。
|
||||||
|
- [x] 未把尚未实现的应用描述为已可部署。
|
||||||
|
- [x] 无界面变化,视觉验证合理标记不适用。
|
||||||
|
|
||||||
|
没有未解决的 Critical 或 Important 不符合项。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# 回退说明
|
||||||
|
|
||||||
|
本功能没有部署应用或连接生产服务。若配置规范需要修正,使用新的中文修复提交更新模板、文档和测试,不移动共享标签。
|
||||||
|
|
||||||
|
开发 Redis 数据位于被忽略的 `.local/redis/`,版本回退不得自动删除该目录。生产真实 env 位于仓库外,不随应用版本切换覆盖。
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# 测试计划
|
||||||
|
|
||||||
|
- 先运行环境基线测试,证明六类行为因模板和部署文件缺失而失败。
|
||||||
|
- 实现后要求环境测试 6/6、MySQL 基线 2/2、治理测试 5/5 通过。
|
||||||
|
- 运行 Docker Compose 配置解析,确认只有 Redis。
|
||||||
|
- 运行 `git diff --check`、敏感信息扫描和 GitNexus 最终暂存区检测。
|
||||||
|
- 运行 `npm run governance:finish -- GOV-006 environment-deployment-baseline`。
|
||||||
|
- 本功能无页面变化,视觉验证不适用。
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
# 开发数据库 Schema 基线与版本门禁设计规格
|
||||||
|
|
||||||
|
- 功能编号:GOV-007
|
||||||
|
- 规格版本:0.1
|
||||||
|
- 状态:approved_for_review
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 背景与目标
|
||||||
|
|
||||||
|
数据库正式启用后,每个新应用版本开始开发前都需要一份可审计的结构起点。只保存迁移脚本不能证明开发数据库在版本开始时的真实结构,也无法发现手工改表造成的漂移。
|
||||||
|
|
||||||
|
本功能建立强制门禁:开始开发下一个语义化版本前,从开发环境数据库导出当前已发布版本的完整 Schema,规范化、校验并纳入 Git。开发流程和脚本禁止连接、读取或探测生产数据库。
|
||||||
|
|
||||||
|
## 版本与命名
|
||||||
|
|
||||||
|
基线按“被备份的当前已发布版本”命名,而不是即将开发的版本。例如开始开发 `v0.0.6` 前,封存 `v0.0.5` 状态:
|
||||||
|
|
||||||
|
```text
|
||||||
|
database/schema-baselines/v0.0.5/
|
||||||
|
├── schema.sql
|
||||||
|
├── manifest.yaml
|
||||||
|
└── checksum.sha256
|
||||||
|
```
|
||||||
|
|
||||||
|
每个应用版本开始前都生成一次。即使 Schema 未变化,也生成新版本目录,以相同内容校验值证明没有结构漂移。
|
||||||
|
|
||||||
|
## 唯一允许的数据来源
|
||||||
|
|
||||||
|
- 只允许读取开发环境数据库。
|
||||||
|
- 加载开发专用本地配置,要求 `APP_ENV=development`。
|
||||||
|
- 数据库名固定为 `a_share_analysis_dev`;名称不匹配立即终止。
|
||||||
|
- 启用真实导出时主机必须为 `127.0.0.1`、`localhost` 或 `::1`;远程开发库必须先通过运维建立本地 SSH 隧道,脚本不接受任意远程目标。
|
||||||
|
- 禁止通过命令参数覆盖环境类型、数据库名或传入任意 env 文件路径。
|
||||||
|
- 禁止连接、读取、探测或导出生产数据库;生产备份属于独立运维流程,不进入开发门禁。
|
||||||
|
- 推荐使用只拥有开发库结构读取和例程查看权限的专用账号,不授予生产访问能力。
|
||||||
|
|
||||||
|
即使主机名看似本地,脚本也必须验证环境和数据库名;不能只依赖地址白名单判断安全。
|
||||||
|
|
||||||
|
## 导出范围
|
||||||
|
|
||||||
|
使用 MySQL 5.7 客户端 `mysqldump`,仅导出结构,不包含任何表数据。基线必须完整包含:
|
||||||
|
|
||||||
|
- 数据库表、列、主键、索引、外键与表选项。
|
||||||
|
- 视图。
|
||||||
|
- 触发器。
|
||||||
|
- 存储过程和函数。
|
||||||
|
- Event Scheduler 事件。
|
||||||
|
|
||||||
|
导出命令必须使用 `--no-data --routines --triggers --events`,并使用符合 MySQL 5.7 的选项。执行元数据查询的 `mysql` 客户端和执行导出的 `mysqldump` 客户端必须分别验证为 5.7.x。账号凭据通过开发 env 或受控客户端配置提供,禁止出现在命令参数、日志或清单中。
|
||||||
|
|
||||||
|
## 规范化
|
||||||
|
|
||||||
|
原始 `mysqldump` 输出经过确定性规范化后才能进入 Git:
|
||||||
|
|
||||||
|
- 删除导出时间、完成时间、客户端路径等不稳定注释。
|
||||||
|
- 删除或规范化环境绑定的 `DEFINER`,避免恢复时绑定个人账号。
|
||||||
|
- 删除由数据增长产生的 `AUTO_INCREMENT=<当前值>`,保留列的自增属性。
|
||||||
|
- 统一换行符与文件末尾换行。
|
||||||
|
- 禁止把主机、端口、账号、密码或客户端配置路径写入 SQL。
|
||||||
|
- 不改变表、视图、触发器、例程和事件的业务定义。
|
||||||
|
|
||||||
|
规范化工具必须通过固定输入/输出测试证明不会误删业务 SQL。
|
||||||
|
|
||||||
|
## 校验与清单
|
||||||
|
|
||||||
|
`manifest.yaml` 至少记录:
|
||||||
|
|
||||||
|
- `application_version`:被备份的已发布版本。
|
||||||
|
- `git_commit`:该版本标签最终指向的提交。
|
||||||
|
- `source_environment: development`。
|
||||||
|
- `database_name: a_share_analysis_dev`。
|
||||||
|
- MySQL 客户端和服务端精确版本。
|
||||||
|
- `charset: utf8mb4`。
|
||||||
|
- `collation: utf8mb4_general_ci`。
|
||||||
|
- 生成时间与生成工具版本。
|
||||||
|
- 是否包含表、视图、触发器、例程和事件。
|
||||||
|
- 规范化 SQL 的 SHA-256。
|
||||||
|
|
||||||
|
`checksum.sha256` 使用标准格式记录 `schema.sql` 校验值。流程必须重新计算并验证清单、校验文件和实际 SQL 三者一致。
|
||||||
|
|
||||||
|
## 强制阻断条件
|
||||||
|
|
||||||
|
出现以下任一情况,不允许进入下一版本开发:
|
||||||
|
|
||||||
|
- 当前已发布版本没有 Schema 基线,且数据库已启用。
|
||||||
|
- `APP_ENV` 不是 `development`。
|
||||||
|
- 数据库名不是 `a_share_analysis_dev`。
|
||||||
|
- 检测到生产配置文件、生产环境标识或禁止的连接目标。
|
||||||
|
- MySQL 客户端或服务端不是 5.7.x。
|
||||||
|
- 字符集或排序规则不是 `utf8mb4` / `utf8mb4_general_ci`。
|
||||||
|
- 导出缺少视图、触发器、存储过程/函数或事件的范围声明。
|
||||||
|
- SQL 包含 `DEFINER`、不稳定导出注释、当前 AUTO_INCREMENT 值或疑似凭据。
|
||||||
|
- 校验值不一致、目标版本目录已存在且内容不同,或 Git 工作区存在无法解释的 Schema 改动。
|
||||||
|
|
||||||
|
禁止覆盖既有版本基线。需要修正时新增带原因的治理记录和修复提交,不静默重写已发布事实。`schema:verify` 是本地内容校验;`governance:start` 还要求基线文件已被 Git 跟踪、工作区无改动、当前分支已推送以及远程发布标签仍指向清单提交。
|
||||||
|
|
||||||
|
## 首次启用与未启用状态
|
||||||
|
|
||||||
|
当前 MySQL 尚未启用,因此在开发新版本前允许记录结构备份“不适用”,但必须能证明功能开关为关闭,且不得创建伪造的空 `schema.sql` 冒充数据库基线。
|
||||||
|
|
||||||
|
首次启用 MySQL 的版本必须:
|
||||||
|
|
||||||
|
1. 通过迁移创建开发库初始结构。
|
||||||
|
2. 在 MySQL 5.7 开发环境验证字符集与排序规则。
|
||||||
|
3. 发布时建立首份真实 Schema 基线。
|
||||||
|
4. 后续每个版本开始前严格执行本门禁。
|
||||||
|
|
||||||
|
## 开发流程位置
|
||||||
|
|
||||||
|
下一版本开发前顺序为:
|
||||||
|
|
||||||
|
1. 确认当前已发布版本和标签提交。
|
||||||
|
2. 判断 MySQL 功能开关;未启用则保存可验证的不适用记录。
|
||||||
|
3. 已启用时从开发数据库导出、规范化并校验完整 Schema。
|
||||||
|
4. 将当前发布版本基线作为独立中文提交推送 Gitea。
|
||||||
|
5. 确认工作区干净和远程同步成功。
|
||||||
|
6. 再创建下一版本 PRD、设计与功能档案,执行 GitNexus 开发前分析。
|
||||||
|
|
||||||
|
数据库迁移必须从上一基线在 MySQL 5.7 开发环境正向执行验证。禁止直接修改共享开发表代替迁移脚本。
|
||||||
|
|
||||||
|
## 安全边界
|
||||||
|
|
||||||
|
- Schema 基线只含结构,不含业务数据、账号数据或生产数据。
|
||||||
|
- 导出脚本不得回显秘密,也不得接受密码命令行参数。
|
||||||
|
- 开发工具和代理无权使用生产 env 或生产数据库验证功能。
|
||||||
|
- 基线提交前扫描疑似凭据、生产主机、`DEFINER` 和数据 INSERT。
|
||||||
|
- Schema 基线进入 Git 后视为公开给仓库使用者,任何敏感对象名称或注释都应在数据库设计阶段避免。
|
||||||
|
|
||||||
|
## 实施范围
|
||||||
|
|
||||||
|
GOV-007 将实现数据库目录规范、开发 env 模板扩展、确定性 SQL 规范化工具、导出/校验脚本、自动化测试、开发流程门禁和完整追溯档案。由于当前 MySQL 未启用,本功能只验证阻断逻辑、规范化固定样本和“不适用”路径,不连接任何数据库。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 开发流程明确每个应用版本开始前建立上一已发布版本的开发库 Schema 基线。
|
||||||
|
- 脚本只接受 `development` 和固定开发库名,无法通过普通参数切换到生产配置。
|
||||||
|
- 导出范围包含表、视图、触发器、存储过程/函数和事件且不含数据。
|
||||||
|
- 规范化稳定移除时间注释、`DEFINER` 和当前 AUTO_INCREMENT 值,但保留业务 SQL。
|
||||||
|
- 清单和 SHA-256 格式可自动校验。
|
||||||
|
- MySQL 5.7、`utf8mb4`、`utf8mb4_general_ci` 不符合时阻断。
|
||||||
|
- 当前未启用 MySQL 时使用可验证“不适用”记录,不伪造空 Schema。
|
||||||
|
- 自动化测试、治理门禁、GitNexus 和双 Review 通过。
|
||||||
|
- 中文提交和对应版本标签精确推送 Gitea。
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# GitNexus 开发后基线
|
||||||
|
|
||||||
|
## GitNexus 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/13/2026, 1:13:21 PM
|
||||||
|
Indexed commit: d827bfa
|
||||||
|
Current commit: d827bfa
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 最终实现
|
||||||
|
|
||||||
|
```text
|
||||||
|
d827bfadb1fc0a7d768eefbf87b46ba26ac612d6
|
||||||
|
fix(GOV-007): 收紧 Schema 基线安全门禁
|
||||||
|
```
|
||||||
|
|
||||||
|
该提交已推送到 `origin/main`,实时远程查询结果与本地提交一致。
|
||||||
|
|
||||||
|
## 实现范围摘要
|
||||||
|
|
||||||
|
```text
|
||||||
|
30 files changed, 1835 insertions(+), 18 deletions(-)
|
||||||
|
```
|
||||||
|
|
||||||
|
最终索引为 879 节点、1062 关系、23 条流程。新增流程集中在 Schema
|
||||||
|
生成、校验、N/A 运行时一致性和发布门禁,不包含市场业务、HTTP、RabbitMQ
|
||||||
|
或生产数据库流程。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GitNexus 开发前基线
|
||||||
|
|
||||||
|
- 功能编号:GOV-007
|
||||||
|
- 记录时间:2026年8月13日 GMT+8 10:58:35
|
||||||
|
- 分支:main
|
||||||
|
- 基线提交:0a69aa1d43f4
|
||||||
|
|
||||||
|
## 工作区
|
||||||
|
|
||||||
|
```text
|
||||||
|
(干净)
|
||||||
|
```
|
||||||
|
|
||||||
|
## GitNexus 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/13/2026, 10:58:34 AM
|
||||||
|
Indexed commit: 0a69aa1
|
||||||
|
Current commit: 0a69aa1
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 后续人工分析
|
||||||
|
|
||||||
|
在修改代码前,将 GitNexus query、context、impact 的结论写入 `gitnexus/impact-plan.md`。高风险结果必须先获得用户确认。
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# GitNexus 前后对比
|
||||||
|
|
||||||
|
## 开发前
|
||||||
|
|
||||||
|
- 基线提交:`e552b979b61342b9e3a47d463f0b9a821b0ad95d`
|
||||||
|
- 索引:641 节点、671 关系、0 流程。
|
||||||
|
- 影响:现有治理档案函数总体 LOW,无数据库 Schema 执行流。
|
||||||
|
|
||||||
|
## 开发后
|
||||||
|
|
||||||
|
- N/A 基线提交:`2c502ebbec25e45ac2980c08ed288ace194b7a04`,已独立推送。
|
||||||
|
- 最终实现提交:`d827bfadb1fc0a7d768eefbf87b46ba26ac612d6`,已推送 `origin/main`。
|
||||||
|
- 索引:879 节点、1062 关系、23 条流程,状态 up-to-date。
|
||||||
|
- 最终修复变更检测为 HIGH,涉及 13 条 Schema 生成、验证与治理门禁流程。
|
||||||
|
|
||||||
|
## 结论
|
||||||
|
|
||||||
|
新增关系和流程全部来自 GOV-007 Schema 安全门禁及其测试,没有引入市场业务、HTTP、RabbitMQ 或页面流程。风险提升是因为 `schema:verify` 和 `governance:start` 属于关键开发路径;对应流程已用红绿测试、23 项 Schema 回归、远程实测和独立终审覆盖。
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# GitNexus 暂存区变更检测
|
||||||
|
|
||||||
|
- 检测日期:2026-08-13
|
||||||
|
- 检测范围:最终实现提交前的 unstaged 修复
|
||||||
|
- 变更文件:3
|
||||||
|
- 变更符号:17
|
||||||
|
- 受影响流程:13
|
||||||
|
- GitNexus 风险:high(已按关键门禁完成专项验证)
|
||||||
|
|
||||||
|
## 受影响流程
|
||||||
|
|
||||||
|
变更集中在数据库 Schema 治理模块:
|
||||||
|
|
||||||
|
- Schema 生成、规范化与敏感/数据写入扫描。
|
||||||
|
- 清单、SHA-256 与目录文件集合验证。
|
||||||
|
- MySQL 5.7 双客户端、服务端和字符规则验证。
|
||||||
|
- 当前发布版本本地校验。
|
||||||
|
- N/A 基线与当前固定开发环境开关的一致性校验。
|
||||||
|
- 顶层数据修改/装载、疑似凭据、连接串和生产主机扫描。
|
||||||
|
- 已提交、已推送、远程分支和远程标签严格校验。
|
||||||
|
- CLI 生成/验证和 `governance:start` 入口。
|
||||||
|
|
||||||
|
## 风险解释
|
||||||
|
|
||||||
|
GitNexus 的 HIGH 结论来自安全扫描和 N/A 校验位于 13 条生成、验证及治理门禁流程,而非发现市场业务、生产数据库或跨服务回归。该风险已用 23 项 Schema 行为测试、既有 13 项治理回归测试、真实 Gitea `ls-remote` 校验和独立最终 Review 覆盖。最终 Review 无未关闭问题。
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# GitNexus 开发前影响分析
|
||||||
|
|
||||||
|
- 分析日期:2026-08-13
|
||||||
|
- 基线提交:`e552b979b61342b9e3a47d463f0b9a821b0ad95d`
|
||||||
|
- 索引状态:up-to-date
|
||||||
|
|
||||||
|
## 查询范围
|
||||||
|
|
||||||
|
围绕 `governance start development gate feature record database schema baseline` 查询现有治理入口。GitNexus 未识别出业务执行流,相关定义集中在:
|
||||||
|
|
||||||
|
- `tools/governance/start.mjs`
|
||||||
|
- `tools/governance/finish.mjs`
|
||||||
|
- `tools/governance/feature-record.mjs`
|
||||||
|
- `tools/governance/feature-record.test.mjs`
|
||||||
|
- `package.json`
|
||||||
|
- 治理规范和 GOV-007 设计档案
|
||||||
|
|
||||||
|
## 符号影响
|
||||||
|
|
||||||
|
- `getFeatureDirectory`:LOW;3 个直接依赖,分别是 start、finish 和治理测试;0 个执行流、0 个跨模块影响。
|
||||||
|
- `validateFeatureId`:LOW;GitNexus 没有发现上游执行流,实际文本导入由 start、finish 和测试覆盖。
|
||||||
|
- `getRequiredFeatureFiles`:LOW;没有识别到执行流,完成门禁由现有自动化测试保护。
|
||||||
|
|
||||||
|
## 实施边界
|
||||||
|
|
||||||
|
本功能不修改上述已有公共函数语义。Schema 逻辑新增为独立模块,只让 `start.mjs` 调用一个只读的“当前已发布版本基线有效”入口。生成、规范化和写入由独立命令负责,因此不会让一般功能档案解析承担数据库职责。
|
||||||
|
|
||||||
|
## 风险结论
|
||||||
|
|
||||||
|
总体风险:LOW。
|
||||||
|
|
||||||
|
没有 HIGH 或 CRITICAL 结果,不需要额外中止确认。主要回归面是治理开始命令可能因缺少上一版本基线被有意阻断;通过 N/A 与真实 Schema 两类测试、既有治理回归测试和命令级验证覆盖。
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
# GOV-007 开发数据库 Schema 基线与版本门禁实施计划
|
||||||
|
|
||||||
|
> **执行要求:** 按测试驱动方式逐项实施;每个行为先观察失败,再写最小实现。实施期间不得连接、探测或读取任何数据库,真实导出入口仅通过固定样本和依赖注入验证。
|
||||||
|
|
||||||
|
**目标:** 建立只允许读取固定开发库、可确定性规范化和校验完整 MySQL 5.7 Schema,并在下一版本开发前强制验证上一已发布版本基线的治理门禁。
|
||||||
|
|
||||||
|
**架构:** `tools/database/schema-baseline.mjs` 集中维护安全配置、命令构造、SQL 规范化、产物生成及校验,避免将一条连续的安全流程过度拆分。`governance:start` 只调用“当前已发布版本基线是否存在且有效”的纯门禁,不负责静默生成或覆盖产物;生成基线必须先由独立命令完成、提交并推送。
|
||||||
|
|
||||||
|
**技术栈:** Node.js 22 LTS、Node 内置测试运行器、MySQL 5.7 `mysql`/`mysqldump` 客户端、SHA-256、GitNexus、Git/Gitea。
|
||||||
|
|
||||||
|
## 全局约束
|
||||||
|
|
||||||
|
- 数据来源只能是 `APP_ENV=development`、数据库 `a_share_analysis_dev`。
|
||||||
|
- MySQL 客户端与服务端只能是 5.7.x,字符集固定 `utf8mb4`,排序规则固定 `utf8mb4_general_ci`。
|
||||||
|
- 导出必须包含 `--no-data --routines --triggers --events`,密码不得出现在参数、日志、SQL 或清单中。
|
||||||
|
- 不接受环境类型、数据库名或 env 路径的命令行覆盖。
|
||||||
|
- 当前 MySQL 未启用,不运行真实数据库命令,只生成可验证的 `not_applicable` 清单,且不创建空 `schema.sql`。
|
||||||
|
- 已存在版本目录不得静默覆盖;真实 Schema 只含结构,不含任何数据。
|
||||||
|
- 修改关键符号前执行 GitNexus impact,提交前执行 GitNexus detect-changes。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 任务 1:锁定安全边界和可观察契约
|
||||||
|
|
||||||
|
**文件:**
|
||||||
|
|
||||||
|
- 新建:`tools/database/schema-baseline.test.mjs`
|
||||||
|
- 新建:`tools/database/fixtures/mysql57-schema-input.sql`
|
||||||
|
- 新建:`tools/database/fixtures/mysql57-schema-expected.sql`
|
||||||
|
- 新建:`docs/features/GOV-007-development-schema-baseline/test-plan.md`
|
||||||
|
|
||||||
|
**接口:**
|
||||||
|
|
||||||
|
- 消费:设计规格中固定的环境、版本、Schema 范围和禁止覆盖规则。
|
||||||
|
- 产出:后续实现必须满足的公开函数行为和固定 SQL 输入/输出。
|
||||||
|
|
||||||
|
- [x] 编写配置测试,分别证明非 `development`、非 `a_share_analysis_dev`、非 MySQL 5.7、错误字符集和错误排序规则被拒绝。
|
||||||
|
- [x] 运行 `node --test tools/database/schema-baseline.test.mjs`,确认因实现模块不存在而失败。
|
||||||
|
- [x] 编写命令构造测试,手工断言参数包含 `--no-data`、`--routines`、`--triggers`、`--events`,且密码字符串不出现在参数中。
|
||||||
|
- [x] 编写固定 SQL 样本测试,手工断言时间注释、`DEFINER` 和表级当前自增值被删除,列级 `AUTO_INCREMENT` 以及表、视图、触发器、例程和事件定义完整保留。
|
||||||
|
- [x] 编写产物测试,证明清单和校验文件的 SHA-256 与 SQL 一致、不同内容的既有目录被拒绝、未启用 MySQL 时只有 `manifest.yaml` 而没有 `schema.sql`。
|
||||||
|
|
||||||
|
### 任务 2:实现纯函数和文件产物
|
||||||
|
|
||||||
|
**文件:**
|
||||||
|
|
||||||
|
- 新建:`tools/database/schema-baseline.mjs`
|
||||||
|
- 修改:`package.json`
|
||||||
|
|
||||||
|
**接口:**
|
||||||
|
|
||||||
|
- 产出:`assertSafeDevelopmentConfiguration(config)`、`assertMysql57Metadata(metadata)`、`buildMysqldumpArguments(config)`、`normalizeSchemaSql(sql)`、`buildCapturedArtifacts(metadata, sql)`、`buildNotApplicableArtifacts(metadata)`、`persistBaselineArtifacts(target, artifacts)`、`verifyBaselineDirectory(target, expectedRelease)`。
|
||||||
|
|
||||||
|
- [x] 实现最小配置与元数据校验,使安全边界测试通过。
|
||||||
|
- [x] 实现参数数组构造;连接密码只允许由子进程环境传递,不进入参数。
|
||||||
|
- [x] 实现确定性 SQL 规范化和敏感内容扫描,使固定样本逐字节匹配期望文件。
|
||||||
|
- [x] 实现 SHA-256、平面可审计清单、标准 checksum 文件和目录校验。
|
||||||
|
- [x] 采用同目录临时目录加原子改名写入;目标已存在时仅允许逐字节相同内容复用,其他情况报错。
|
||||||
|
- [x] 运行 Schema 测试,确认所有测试转绿;再运行既有治理、MySQL 与环境基线测试,确认没有回归。
|
||||||
|
|
||||||
|
### 任务 3:实现真实入口但不连接数据库
|
||||||
|
|
||||||
|
**文件:**
|
||||||
|
|
||||||
|
- 修改:`tools/database/schema-baseline.mjs`
|
||||||
|
- 修改:`package.json`
|
||||||
|
- 修改:`deploy/env/development/api.env.example`(仅在契约字段缺失时修改)
|
||||||
|
|
||||||
|
**接口:**
|
||||||
|
|
||||||
|
- 消费:固定路径 `deploy/env/development/api.env`;文件不存在且仓库模板明确 `MYSQL_ENABLED=false` 时允许生成不适用记录。
|
||||||
|
- 产出:`npm run schema:baseline` 与 `npm run schema:verify`,版本自动从最近语义化版本标签解析。
|
||||||
|
|
||||||
|
- [x] 测试命令行拒绝额外参数,证明不能传入 production env、数据库名或任意 env 路径。
|
||||||
|
- [x] 测试未启用 MySQL 的入口不会调用数据库执行器,并为最近发布标签创建可验证不适用记录。
|
||||||
|
- [x] 测试启用分支只构造固定 `mysql`/`mysqldump` 参数,并在客户端/服务端版本或数据库字符规则不符时阻断。
|
||||||
|
- [x] 实现固定配置加载、最近标签与标签提交解析、回环主机检查、mysql/mysqldump 双客户端和服务端元数据检查、真实导出执行路径;本次验证不调用该路径。
|
||||||
|
- [x] 运行 `npm run schema:baseline` 为 `v0.0.5` 生成 `not_applicable` 清单,并运行 `npm run schema:verify` 验证;确认不存在 `schema.sql`。
|
||||||
|
|
||||||
|
### 任务 4:接入版本开发前门禁与治理规范
|
||||||
|
|
||||||
|
**文件:**
|
||||||
|
|
||||||
|
- 修改:`tools/governance/start.mjs`
|
||||||
|
- 修改:`tools/governance/feature-record.test.mjs` 或新增对应集成测试。
|
||||||
|
- 修改:`AGENTS.md`
|
||||||
|
- 修改:`docs/governance/development-workflow.md`
|
||||||
|
- 修改:`docs/governance/code-development-standards.md`
|
||||||
|
- 修改:`README.md`
|
||||||
|
- 修改:`docs/index.md`
|
||||||
|
|
||||||
|
**接口:**
|
||||||
|
|
||||||
|
- 消费:`assertCurrentReleasedBaselinePublished(repositoryRoot)`。
|
||||||
|
- 产出:治理开始命令只有在上一已发布版本 Schema 基线有效时才继续 GitNexus 开发前流程。
|
||||||
|
|
||||||
|
- [x] 先写失败测试:基线缺失或失效时 `governance:start` 的前置检查拒绝继续,有效 N/A 或真实基线时允许继续。
|
||||||
|
- [x] 在 `start.mjs` 刷新 GitNexus 之前调用严格发布验证,检查 Git 跟踪、工作区、origin 分支和远程标签;不自动生成、不覆盖基线。
|
||||||
|
- [x] 文档明确顺序为“生成并验证基线 → 中文提交 → 推送 Gitea → 治理开始”,以及首次启用 MySQL 时必须从真实开发库导出。
|
||||||
|
- [x] 代码规范增加 Schema 仅结构、MySQL 5.7 完整对象范围、确定性规范化、禁止生产数据库和禁止直接改共享表的规则。
|
||||||
|
|
||||||
|
### 任务 5:验证、Review 与发布
|
||||||
|
|
||||||
|
**文件:**
|
||||||
|
|
||||||
|
- 新建或更新:GOV-007 完整功能档案。
|
||||||
|
- 修改:`VERSION`、`CHANGELOG.md`、`docs/index.md`。
|
||||||
|
|
||||||
|
**接口:**
|
||||||
|
|
||||||
|
- 产出:可追溯的 `v0.0.6` 治理版本。
|
||||||
|
|
||||||
|
- [x] 执行 Schema、治理、MySQL、环境测试,执行 `git diff --check`、敏感信息扫描和适用构建检查。
|
||||||
|
- [x] 执行 `npx gitnexus analyze` 与变更检测,保存开发前后差异和风险结论。
|
||||||
|
- [x] 完成代码 Review 与开发规范符合性 Review;两份报告必须包含独立一行 `最终结论:passed`。
|
||||||
|
- [x] 执行 `npm run governance:finish -- GOV-007 development-schema-baseline` 并保存证据。
|
||||||
|
- [x] 使用中文 Conventional Commit 提交并立即推送 `origin/main`,回填实现提交和远程 SHA。
|
||||||
|
- [x] 封存最终验证结果,提交并推送;创建带注释标签 `v0.0.6` 并只精确推送该标签。
|
||||||
|
|
||||||
|
## 计划自审
|
||||||
|
|
||||||
|
- 设计中的安全配置、完整对象范围、规范化、清单校验、禁止覆盖、未启用路径、治理门禁、双 Review 和发布要求均有对应任务。
|
||||||
|
- 所有实现接口在任务 2 明确定义,任务 3、4 只消费这些接口,没有命名漂移。
|
||||||
|
- 计划不包含待定项;真实数据库路径可实现但本次只以依赖注入和固定样本验证,符合禁止连接数据库的范围。
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
id: GOV-007
|
||||||
|
name: 开发数据库 Schema 基线与版本门禁
|
||||||
|
slug: development-schema-baseline
|
||||||
|
status: released
|
||||||
|
owner: project
|
||||||
|
created_at: 2026-08-13
|
||||||
|
prd: prd.md
|
||||||
|
requirements: requirements.md
|
||||||
|
design: design.md
|
||||||
|
implementation_plan: implementation-plan.md
|
||||||
|
test_plan: test-plan.md
|
||||||
|
gitnexus_before: gitnexus/before.md
|
||||||
|
gitnexus_after: gitnexus/after.md
|
||||||
|
gitnexus_comparison: gitnexus/comparison.md
|
||||||
|
code_review: review/code-review.md
|
||||||
|
standards_review: review/standards-review.md
|
||||||
|
implementation_commit: d827bfadb1fc0a7d768eefbf87b46ba26ac612d6
|
||||||
|
release: v0.0.6
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
# 开发数据库 Schema 基线与版本门禁 PRD
|
||||||
|
|
||||||
|
- 功能编号:GOV-007
|
||||||
|
- PRD 版本:0.1
|
||||||
|
- 状态:approved
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 问题
|
||||||
|
|
||||||
|
数据库迁移文件只能表达预期变化,不能证明每个版本开始前开发数据库的实际结构,也无法发现手工改表、对象遗漏或环境误连。当前 MySQL 尚未启用,还需要一种不伪造空 Schema 的可审计状态。
|
||||||
|
|
||||||
|
## 目标
|
||||||
|
|
||||||
|
- 每个新应用版本开发前,封存上一已发布版本的开发库完整 Schema。
|
||||||
|
- 将环境、数据库名、MySQL 版本、字符集、排序规则和对象范围设置为强制门禁。
|
||||||
|
- 生成确定性、可校验、可版本控制且不含数据或凭据的产物。
|
||||||
|
- MySQL 未启用时生成可验证的不适用记录。
|
||||||
|
- 在 `governance:start` 前阻断缺失或失效的上一版本基线。
|
||||||
|
|
||||||
|
## 用户流程
|
||||||
|
|
||||||
|
1. 开发者确认上一已发布语义化版本。
|
||||||
|
2. 执行 `npm run schema:baseline` 生成或幂等验证对应目录。
|
||||||
|
3. 执行 `npm run schema:verify` 复核清单、版本、提交和校验值。
|
||||||
|
4. 将基线用中文提交推送项目 Gitea。
|
||||||
|
5. 执行 `governance:start` 开始下一版本功能。
|
||||||
|
|
||||||
|
## 非目标
|
||||||
|
|
||||||
|
- 不备份任何业务数据、用户数据或生产数据。
|
||||||
|
- 不连接、探测、读取或验证生产数据库。
|
||||||
|
- 不替代生产运维备份、数据库恢复演练或迁移框架。
|
||||||
|
- 本版本不启动 MySQL,也不对真实数据库执行命令。
|
||||||
|
|
||||||
|
## 风险
|
||||||
|
|
||||||
|
- `DEFINER`、导出时间和当前自增值会造成不可移植或无意义差异。
|
||||||
|
- 参数可覆盖 env 或数据库名会扩大到生产资源的误操作范围。
|
||||||
|
- 空 SQL 或可篡改的 N/A 清单会让门禁形式化而不可信。
|
||||||
|
- 既有版本目录被覆盖会破坏发布历史。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 开发库、MySQL 5.7 和字符规则不符合时全部阻断。
|
||||||
|
- 导出参数明确只含结构并覆盖表、视图、触发器、例程和事件。
|
||||||
|
- 规范化固定样本精确保留业务对象和列自增属性。
|
||||||
|
- 真实基线三方 SHA-256 一致;N/A 基线只有清单。
|
||||||
|
- 版本、标签提交、对象范围、状态和文件集合都能自动校验。
|
||||||
|
- 既有不同内容禁止覆盖,命令行不能切换 production env 或数据库。
|
||||||
|
- 治理流程、双 Review、GitNexus、中文提交和 Gitea 推送完成。
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# 测试结果
|
||||||
|
|
||||||
|
- 日期:2026-08-13
|
||||||
|
- 环境:本地开发仓库;未启动 MySQL,未连接任何数据库。
|
||||||
|
|
||||||
|
## 最新结果
|
||||||
|
|
||||||
|
- Schema 基线测试:23/23 passed。
|
||||||
|
- 治理测试:5/5 passed。
|
||||||
|
- MySQL 兼容基线:2/2 passed。
|
||||||
|
- 环境与部署基线:6/6 passed。
|
||||||
|
- `npm run schema:verify`:`v0.0.5 (not_applicable)` passed。
|
||||||
|
- 严格 `governance:start` smoke:基线未提交时按预期阻断;独立提交并推送后通过。
|
||||||
|
- `git ls-remote origin refs/heads/main` 与 `refs/tags/v0.0.5^{}`:远程 SHA 均按实时查询核对通过。
|
||||||
|
- `git diff --check`:passed。
|
||||||
|
- Node 语法检查:passed。
|
||||||
|
- `npm run governance:finish -- GOV-007 development-schema-baseline`:passed。
|
||||||
|
- 最终实现提交:`d827bfadb1fc0a7d768eefbf87b46ba26ac612d6`。
|
||||||
|
- `git ls-remote origin refs/heads/main`:与最终实现提交一致。
|
||||||
|
|
||||||
|
## 测试先行留痕
|
||||||
|
|
||||||
|
首次测试因模块不存在以 `ERR_MODULE_NOT_FOUND` 失败。实现期间失败测试先后捕获:MySQL 密码条件必填、标签提交核对、清单篡改、标准 5.7 视图 DEFINER、例程字符串误改、顶层/例程 DML 区分、双客户端版本、未跟踪基线、陈旧 tracking ref、普通与可执行注释 DML 绕过、N/A 与当前开关不一致、顶层数据修改/装载及敏感内容漏检。每项均在实现修复后转绿。
|
||||||
|
|
||||||
|
## 未执行项
|
||||||
|
|
||||||
|
当前 MySQL 功能开关为关闭,本功能范围明确禁止连接数据库,因此未执行真实 MySQL 5.7 导出。首次启用 MySQL 的版本必须在固定开发库补做真实集成验证。
|
||||||
|
|
||||||
|
## 人工完成项
|
||||||
|
|
||||||
|
- GitNexus HIGH 风险已核对,13 条受影响流程均属于 Schema 生成、验证和治理门禁。
|
||||||
|
- 视觉 QA 不适用,原因已单独留痕。
|
||||||
|
- 回退说明已核对;本版本未执行生产发布或数据库变更。
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# 视觉 QA
|
||||||
|
|
||||||
|
本功能没有页面、组件、样式、图表或浏览器交互变化,视觉 QA 不适用。
|
||||||
|
|
||||||
|
结论:not_applicable
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# 发布说明
|
||||||
|
|
||||||
|
## v0.0.6
|
||||||
|
|
||||||
|
- 实现开发数据库 Schema 基线生成与只读验证命令。
|
||||||
|
- 固定 MySQL 5.7、`a_share_analysis_dev`、`utf8mb4` 和 `utf8mb4_general_ci` 安全边界。
|
||||||
|
- 增加完整对象导出参数、确定性 SQL 规范化、SHA-256 三方校验和禁止覆盖机制。
|
||||||
|
- 为 MySQL 未启用状态建立不伪造空 SQL 的 `not_applicable` 基线。
|
||||||
|
- 将上一发布版本 Schema 基线验证接入开发前和开发后治理门禁。
|
||||||
|
- `governance:start` 仅接受已提交、已推送且远程标签一致的基线;真实导出限制在本机回环地址并分别校验 `mysql` 与 `mysqldump` 客户端版本。
|
||||||
|
- N/A 基线会实时核对当前开发环境 MySQL 开关;启用后必须改用真实 captured 基线。
|
||||||
|
- 扩展顶层数据操作、疑似凭据、数据库 URI、生产主机和导出噪声阻断。
|
||||||
|
- 最终实现提交:`d827bfadb1fc0a7d768eefbf87b46ba26ac612d6`。
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# 工程需求
|
||||||
|
|
||||||
|
## 安全配置
|
||||||
|
|
||||||
|
- `APP_ENV` 必须为 `development`,`MYSQL_DATABASE` 必须为 `a_share_analysis_dev`。
|
||||||
|
- 字符集固定 `utf8mb4`,排序规则固定 `utf8mb4_general_ci`。
|
||||||
|
- 启用 MySQL 后 host、port、username、password 均为必填;密码只通过子进程环境传递。
|
||||||
|
- 启用 MySQL 时主机只能是本机回环地址;远程开发库必须先由运维建立本地 SSH 隧道,脚本不接受任意远程目标。
|
||||||
|
- 命令行不接受 env 文件、环境类型、数据库名或其他覆盖参数。
|
||||||
|
|
||||||
|
## 数据库与导出
|
||||||
|
|
||||||
|
- 客户端和服务端版本必须匹配 MySQL 5.7.x。
|
||||||
|
- 执行元数据查询的 `mysql` 客户端和执行导出的 `mysqldump` 客户端都必须分别验证为 5.7.x。
|
||||||
|
- `mysqldump` 使用 `--no-data --routines --triggers --events`,不得输出 INSERT 或 REPLACE。
|
||||||
|
- 完整对象范围为表、索引、外键、视图、触发器、存储过程、函数和事件。
|
||||||
|
- 规范化删除不稳定注释、环境 `DEFINER` 和表选项当前自增值,保留列自增属性。
|
||||||
|
|
||||||
|
## 产物与校验
|
||||||
|
|
||||||
|
- 目录固定为 `database/schema-baselines/<已发布版本>/`。
|
||||||
|
- 真实基线包含 `schema.sql`、`manifest.yaml`、`checksum.sha256`。
|
||||||
|
- `manifest.yaml` 使用 JSON 兼容 YAML 的结构化格式,可由标准 JSON 解析器读取。
|
||||||
|
- 清单记录版本、标签提交、来源环境、库名、版本、字符规则、对象范围、生成器和 SHA-256。
|
||||||
|
- 目录采用同父目录临时写入后原子改名;既有目录只允许逐字节相同的幂等重跑。
|
||||||
|
- MySQL 未启用时只生成 `manifest.yaml`,状态为 `not_applicable`,原因是 `mysql_disabled`,所有对象均为未捕获。
|
||||||
|
|
||||||
|
## 流程
|
||||||
|
|
||||||
|
- `governance:start` 在写入功能档案或刷新 GitNexus 前只读验证上一发布版本基线。
|
||||||
|
- `governance:start` 还要求基线文件已被 Git 跟踪、无未提交改动、当前分支已推送且远程发布标签提交一致;`schema:verify` 只负责本地内容校验。
|
||||||
|
- `governance:finish` 运行全部既有治理测试、Schema 测试和基线验证。
|
||||||
|
- 本版本实际产物为 `v0.0.5` 的 N/A 清单,不连接任何数据库。
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# 代码 Review
|
||||||
|
|
||||||
|
## 第一轮
|
||||||
|
|
||||||
|
结论:changes_required。发现 5 个 Important 和 2 个 Minor:未提交基线可绕过门禁、远程生产主机可被误连、标准 MySQL 5.7 视图 DEFINER 不兼容、顶层 DML 扫描绕过/例程误拒、未校验 mysql 客户端、N/A 清单字段不严和缺少严格门禁测试。
|
||||||
|
|
||||||
|
处置:全部补失败测试并修复。增加回环主机、双客户端、结构化清单、Git 跟踪与远程同步验证。
|
||||||
|
|
||||||
|
## 第二轮
|
||||||
|
|
||||||
|
结论:changes_required。发现普通/版本注释可绕过顶层 DML 扫描,远程分支校验依赖可能陈旧的 tracking ref。
|
||||||
|
|
||||||
|
处置:按真实分隔符解析顶层语句,剥离前置普通注释但扫描 MySQL 可执行注释;远程分支改为实时 `git ls-remote origin refs/heads/<branch>`,并增加回归测试。
|
||||||
|
|
||||||
|
## 最终复审
|
||||||
|
|
||||||
|
- 普通注释、版本 SET 注释、MySQL 可执行注释中的顶层 INSERT/REPLACE 均被拒绝。
|
||||||
|
- 顶层 UPDATE、DELETE、TRUNCATE、LOAD DATA/XML 均被拒绝,例程内部合法 DML 保留。
|
||||||
|
- MySQL dump 残留头、疑似密码/Token/Secret、数据库 URI 和生产主机注释均被拒绝。
|
||||||
|
- N/A 基线每次重读固定开发环境配置,MySQL 启用后旧 N/A 清单立即失效。
|
||||||
|
- 例程内合法 DML 保留,标准 MySQL 5.7 视图 DEFINER 输出可规范化。
|
||||||
|
- 远程分支使用实时 `git ls-remote`,远程标签提交与清单提交核对。
|
||||||
|
- 23 项 Schema 测试、治理/数据库/环境回归测试均通过。
|
||||||
|
|
||||||
|
问题处置:多轮 Review 的所有 Critical/Important/Minor 问题均已关闭并有回归测试;独立终审无新增问题,未保留延期问题。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# 开发规范符合性 Review
|
||||||
|
|
||||||
|
## 检查范围
|
||||||
|
|
||||||
|
- PRD、需求、确认设计、实施计划、测试计划、GitNexus 前后报告齐全。
|
||||||
|
- 关键安全边界、规范化取舍、原子写入和远程门禁有中文原因注释。
|
||||||
|
- 主要业务流程集中在一个可连续阅读的模块,没有过度拆分。
|
||||||
|
- 测试遵循先失败后实现,固定样本和期望值独立维护。
|
||||||
|
- MySQL 5.7、`utf8mb4`、`utf8mb4_general_ci` 和开发库限制符合规范。
|
||||||
|
- 未写入密码、Token、真实 env、生产地址或生产数据。
|
||||||
|
- `v0.0.5` N/A 基线已作为独立中文提交推送 Gitea。
|
||||||
|
- 视觉变化不适用,已记录原因。
|
||||||
|
|
||||||
|
## 复审结果
|
||||||
|
|
||||||
|
- 最终代码复审已通过,Critical/Important/Minor 均为零;历史问题全部关闭并有测试证据。
|
||||||
|
- `governance:finish` 将在发布前重新执行全部治理、Schema 和 GitNexus 门禁。
|
||||||
|
- 最终实现提交 `d827bfadb1fc0a7d768eefbf87b46ba26ac612d6` 已推送 Gitea;封存提交和 `v0.0.6` 标签按发布步骤执行。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# 回退说明
|
||||||
|
|
||||||
|
本功能没有连接数据库、执行迁移或修改任何开发/生产数据。回退应用代码时可以恢复上一提交中的治理脚本和文档,但不得删除或改写已经随版本发布的 `database/schema-baselines/` 历史事实。
|
||||||
|
|
||||||
|
若工具实现存在缺陷,使用新的中文修复提交:
|
||||||
|
|
||||||
|
1. 保留原版本基线目录和 Git 历史。
|
||||||
|
2. 在新的治理档案中记录错误原因、影响范围和修复策略。
|
||||||
|
3. 对尚未发布的错误产物可在审查后修正;已发布产物通过追加更正记录处理,不移动共享标签。
|
||||||
|
4. 首次启用 MySQL 后,任何修复都只允许读取开发库,生产数据库仍属于禁止范围。
|
||||||
|
|
||||||
|
N/A 清单没有 Schema 或数据可恢复。`v0.0.5` 目录证明当时 MySQL 功能开关关闭,不能在未来启用 MySQL 后追溯改写为真实 Schema。
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# 测试计划
|
||||||
|
|
||||||
|
## 测试先行证据
|
||||||
|
|
||||||
|
- 首次执行 `node --test tools/database/schema-baseline.test.mjs` 因生产模块不存在而失败,错误为 `ERR_MODULE_NOT_FOUND`。
|
||||||
|
- 首轮实现后固定样本和清单嵌套字段测试暴露规范化与解析缺口,修正后转绿。
|
||||||
|
- 安全自审再以失败测试发现密码未设为条件必填、标签提交未核对、真实清单版本可篡改和 N/A 对象范围可伪造,均已实现对应阻断。
|
||||||
|
|
||||||
|
## 自动化范围
|
||||||
|
|
||||||
|
- 配置:环境、库名、字符集、排序规则、启用后的必填凭据。
|
||||||
|
- 版本:MySQL 客户端、服务端和发布标签提交。
|
||||||
|
- 命令:完整结构参数、密码不进参数、额外参数拒绝。
|
||||||
|
- SQL:时间注释、`DEFINER`、表级自增值、列自增属性和五类对象。
|
||||||
|
- 产物:SHA-256、精确文件集合、禁止覆盖、篡改检测、空 SQL 拒绝。
|
||||||
|
- N/A:零数据库调用、只有清单、明确关闭版本和对象范围。
|
||||||
|
- 回归:治理测试、MySQL 基线测试、环境基线测试、Schema 验证。
|
||||||
|
- 严格发布门禁:未跟踪基线、未提交改动、未推送分支或远程标签不一致均阻断;本地 `schema:verify` 与发布前 `governance:start` 的职责分别验证。
|
||||||
|
|
||||||
|
## 最终命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run test:governance
|
||||||
|
npm run test:mysql-baseline
|
||||||
|
npm run test:environment-baseline
|
||||||
|
npm run test:schema-baseline
|
||||||
|
npm run schema:verify
|
||||||
|
npm run governance:finish -- GOV-007 development-schema-baseline
|
||||||
|
git diff --check
|
||||||
|
```
|
||||||
|
|
||||||
|
本功能无 Web 页面、CSS 或图表变化,视觉 QA 记录为不适用。
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# RocketMQ 消息队列架构调整设计
|
||||||
|
|
||||||
|
- 功能编号:GOV-008
|
||||||
|
- 设计版本:0.1
|
||||||
|
- 状态:approved
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 架构
|
||||||
|
|
||||||
|
```text
|
||||||
|
Scheduler
|
||||||
|
-> MessageBusAdapter.publish()
|
||||||
|
-> RocketMQ 5.x Proxy 或受支持客户端
|
||||||
|
-> NameServer / Broker
|
||||||
|
-> MessageBusAdapter.consume()
|
||||||
|
-> Worker
|
||||||
|
-> Redis 当前状态 + MySQL 事实记录
|
||||||
|
```
|
||||||
|
|
||||||
|
`MessageBusAdapter` 是稳定边界。业务消息、Topic 和 Group 不引用 RocketMQ SDK 类型,未来客户端实现变化不要求重写调度与分析逻辑。项目只维护 RocketMQ 一套实现,不同时维护 RabbitMQ 兼容层。
|
||||||
|
|
||||||
|
## 接入模式
|
||||||
|
|
||||||
|
推荐 Node.js 通过 RocketMQ 5.x Proxy 接入,以降低对旧 Remoting 客户端实现的依赖。若后续选定的 Node 客户端直接连接 NameServer/Broker,必须先验证客户端维护状态、RocketMQ 5.3.2 兼容性、重试语义和优雅关闭,再通过 Adapter 接入。
|
||||||
|
|
||||||
|
`ROCKETMQ_NAMESRV_ADDR` 用于基础设施发现和诊断,`ROCKETMQ_ENDPOINT` 是应用客户端实际接入地址。两者不得混为同一项:只有 NameServer 端口可达时,不能完成生产或消费。
|
||||||
|
|
||||||
|
## Topic 与 Group
|
||||||
|
|
||||||
|
- Topic 前缀固定为 `a-share-analysis`,实际 Topic 按业务域追加,例如行情采集或指标计算。
|
||||||
|
- Tag 使用稳定事件类型,不用临时任务 ID。
|
||||||
|
- RocketMQ 5.x Proxy Producer 不配置 Producer Group;Worker 按独立消费语义使用 Consumer Group。
|
||||||
|
- 环境隔离通过受控前缀或独立集群完成,禁止开发消费者读取生产 Topic。
|
||||||
|
|
||||||
|
## 可靠性
|
||||||
|
|
||||||
|
RocketMQ 提供至少一次投递语义,Worker 必须幂等。消息处理完成并形成可验证结果后才能确认;可重试错误返回重试,永久错误记录原因后进入死信。顺序消息只在明确消息组键内保证,不假设跨证券或跨交易日全局顺序。
|
||||||
|
|
||||||
|
最大投递次数是 Consumer Group 的服务端重试策略,由 RocketMQ 运维配置和发布检查负责。应用客户端只声明 Consumer Group、并发与处理结果,不能用一个不会被官方 Node SDK读取的 env 字段假装控制死信边界。
|
||||||
|
|
||||||
|
## 本地状态
|
||||||
|
|
||||||
|
2026-08-13 首次检查到 `apache/rocketmq:5.3.2` 的 `rmqnamesrv` 容器曾运行并映射 `9876:9876`,日志为 NameServer boot success;随后串行复核发现该容器已以 137 退出且未配置自动重启,`OOMKilled=false`。
|
||||||
|
|
||||||
|
宿主机 `9876` 实际由 `/usr/local/rocketmq` 的原生 NameServer 监听,同时存在 `mqbroker --enable-proxy`。只读 `mqadmin` 验证结果:`broker-a` 已注册,版本 `V5_3_2`、`brokerActive=true`,Broker 地址 `192.168.2.37:10911`;本机 `10911`、Proxy `8081` 和 NameServer `9876` 均可达,Topic 列表可读取。当前可确认 RocketMQ 基础设施和管理链路连通,但尚未通过项目 Node 客户端执行消息收发。
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# GitNexus 开发后基线
|
||||||
|
|
||||||
|
## 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/13/2026, 2:23:20 PM
|
||||||
|
Indexed commit: f5994ad
|
||||||
|
Current commit: f5994ad
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 图谱规模
|
||||||
|
|
||||||
|
- 958 个节点。
|
||||||
|
- 1141 条关系。
|
||||||
|
- 13 个聚类。
|
||||||
|
- 23 条流程。
|
||||||
|
|
||||||
|
本次新增内容以文档、环境模板和契约测试为主,没有新增 MQ 运行时代码或执行流。
|
||||||
|
|
||||||
|
最终实现提交 `f5994ad77ec980175f671475e82c72d9d7e6f979` 已推送 `origin/main`,实时远程 SHA 核对一致。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GitNexus 开发前基线
|
||||||
|
|
||||||
|
- 功能编号:GOV-008
|
||||||
|
- 记录时间:2026年8月13日 GMT+8 13:59:16
|
||||||
|
- 分支:main
|
||||||
|
- 基线提交:3cc00de8f65e
|
||||||
|
|
||||||
|
## 工作区
|
||||||
|
|
||||||
|
```text
|
||||||
|
(干净)
|
||||||
|
```
|
||||||
|
|
||||||
|
## GitNexus 状态
|
||||||
|
|
||||||
|
```text
|
||||||
|
Repository: /Users/citrons/Documents/Codex/2026-08-12/wo-x/a-share-analysis
|
||||||
|
Indexed: 8/13/2026, 1:59:15 PM
|
||||||
|
Indexed commit: 3cc00de
|
||||||
|
Current commit: 3cc00de
|
||||||
|
Status: ✅ up-to-date
|
||||||
|
```
|
||||||
|
|
||||||
|
## 后续人工分析
|
||||||
|
|
||||||
|
在修改代码前,将 GitNexus query、context、impact 的结论写入 `gitnexus/impact-plan.md`。高风险结果必须先获得用户确认。
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# GitNexus 前后对比
|
||||||
|
|
||||||
|
## 开发前
|
||||||
|
|
||||||
|
- 基线提交:`3cc00de`
|
||||||
|
- RabbitMQ 仅存在于文档、模板和契约测试,没有运行时代码或执行流。
|
||||||
|
|
||||||
|
## 开发后
|
||||||
|
|
||||||
|
- 当前活动架构统一为 RocketMQ 5.x。
|
||||||
|
- 新增 MessageBusAdapter、Topic/Tag/Group、重试、死信、幂等和顺序键约束。
|
||||||
|
- GitNexus 变更检测为 LOW,0 条执行流受影响。
|
||||||
|
|
||||||
|
结论:调整发生在实现客户端之前,避免了双栈迁移;后续真实风险集中在 Node 客户端与 RocketMQ 5.3.2 的契约验证。
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GitNexus 变更检测
|
||||||
|
|
||||||
|
- 检测日期:2026-08-13
|
||||||
|
- 范围:unstaged
|
||||||
|
- 变更文件:16 个已跟踪文件,另含 GOV-008 功能档案与 ADR 新文件。
|
||||||
|
- 变更符号:35
|
||||||
|
- 受影响流程:0
|
||||||
|
- 风险:LOW
|
||||||
|
|
||||||
|
变更集中在当前架构、环境模板、部署说明、代码规范和环境契约测试。GitNexus 未发现市场业务、数据库、HTTP 或消息运行流程受影响,因为 Server 和 MQ 客户端尚未实现。
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# GitNexus 开发前影响分析
|
||||||
|
|
||||||
|
- 分析日期:2026-08-13
|
||||||
|
- 基线提交:`3cc00de`
|
||||||
|
- 索引状态:up-to-date
|
||||||
|
|
||||||
|
查询 RabbitMQ、消息队列、Scheduler、Worker 和部署配置。当前仓库没有 Server 生产代码或 MQ 执行流,影响集中在系统架构、代码开发规范、环境模板、部署文档和环境契约测试。
|
||||||
|
|
||||||
|
- `environment-baseline.test.mjs`:LOW,无上游调用方或业务流程。
|
||||||
|
- `system-architecture.md`:LOW,直接引用方为 README 与文档索引。
|
||||||
|
- `code-development-standards.md`:LOW,直接引用方为 README 与文档索引。
|
||||||
|
|
||||||
|
结论:不影响市场业务、数据库或 HTTP 运行流程。主要风险是环境键漂移和把 NameServer 可达误判为消息链路可用,分别由契约测试和分层连接证据控制。
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# GOV-008 实施计划
|
||||||
|
|
||||||
|
- [x] 封存并推送 `v0.0.6` 开发库 N/A Schema 基线。
|
||||||
|
- [x] 执行 `governance:start` 与 GitNexus 开发前探索和影响分析。
|
||||||
|
- [x] 先修改环境契约测试,确认旧 RabbitMQ 配置使测试失败。
|
||||||
|
- [x] 将 Scheduler/Worker 开发和生产模板改为 `ROCKETMQ_*`。
|
||||||
|
- [x] 更新系统架构、代码开发规范、部署文档和未发布市场概览 PRD。
|
||||||
|
- [x] 补齐 GOV-008 功能档案和本机连接验证证据。
|
||||||
|
- [x] 运行治理、MySQL、环境、Schema 测试和配置/文档检查。
|
||||||
|
- [x] 执行 GitNexus 变更检测、代码 Review 与规范 Review。
|
||||||
|
- [x] 执行 `governance:finish`,中文提交并推送 Gitea。
|
||||||
|
|
||||||
|
本版本不实现客户端、不创建 Broker/Proxy、不发送测试消息。后续 Server 脚手架功能负责选型 Node 客户端并完成真实 Topic 收发契约测试。
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
id: GOV-008
|
||||||
|
name: RocketMQ 消息队列架构调整
|
||||||
|
slug: rocketmq-adoption
|
||||||
|
status: released
|
||||||
|
owner: project
|
||||||
|
created_at: 2026-08-13
|
||||||
|
prd: prd.md
|
||||||
|
requirements: requirements.md
|
||||||
|
design: design.md
|
||||||
|
implementation_plan: implementation-plan.md
|
||||||
|
test_plan: test-plan.md
|
||||||
|
gitnexus_before: gitnexus/before.md
|
||||||
|
gitnexus_after: gitnexus/after.md
|
||||||
|
gitnexus_comparison: gitnexus/comparison.md
|
||||||
|
code_review: review/code-review.md
|
||||||
|
standards_review: review/standards-review.md
|
||||||
|
implementation_commit: f5994ad77ec980175f671475e82c72d9d7e6f979
|
||||||
|
release: v0.0.7
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# RocketMQ 消息队列架构调整 PRD
|
||||||
|
|
||||||
|
- 功能编号:GOV-008
|
||||||
|
- PRD 版本:0.1
|
||||||
|
- 状态:approved
|
||||||
|
- 日期:2026-08-13
|
||||||
|
|
||||||
|
## 问题
|
||||||
|
|
||||||
|
项目早期约定 RabbitMQ,但尚未实现消息客户端或业务消息链路。现决定统一采用 RocketMQ,并需要在服务脚手架落地前同步架构、环境契约和部署边界,避免后续同时维护两套消息模型。
|
||||||
|
|
||||||
|
## 目标
|
||||||
|
|
||||||
|
- 项目唯一消息队列调整为 RocketMQ 5.x。
|
||||||
|
- Scheduler 和 Worker 通过 `MessageBusAdapter` 使用版本化消息契约。
|
||||||
|
- 配置明确区分 NameServer、Broker/Proxy Endpoint、Topic 和 Group。
|
||||||
|
- 保留本地默认关闭策略,同时允许连接独立运行的本机 RocketMQ。
|
||||||
|
- 检查当前本机 Docker RocketMQ 的实际连通状态,不夸大验证范围。
|
||||||
|
|
||||||
|
## 非目标
|
||||||
|
|
||||||
|
- 本版本不实现 Server、Scheduler、Worker 或 RocketMQ Node 客户端。
|
||||||
|
- 不替用户创建、删除或重启 Docker 或本机 RocketMQ 进程。
|
||||||
|
- 不连接生产 RocketMQ,不创建生产 Topic 或 Group。
|
||||||
|
- NameServer 可达时不宣称消息生产和消费已经可用。
|
||||||
|
|
||||||
|
## 验收标准
|
||||||
|
|
||||||
|
- 当前架构、开发规范、部署说明和环境模板只采用 RocketMQ。
|
||||||
|
- Scheduler 与 Worker 开发/生产模板键集合分别一致,且无 RabbitMQ 变量。
|
||||||
|
- 文档定义重复投递、幂等、重试、死信和顺序消息边界。
|
||||||
|
- 本机 NameServer 的版本、端口和启动状态有可复核证据。
|
||||||
|
- 诊断必须区分 Docker 容器与本机原生进程,并报告 NameServer、Broker、Proxy 的真实状态。
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# 测试结果
|
||||||
|
|
||||||
|
- 日期:2026-08-13
|
||||||
|
- 状态:passed
|
||||||
|
|
||||||
|
测试先行阶段,环境契约测试按预期因缺少 `ROCKETMQ_*` 和活动文档仍包含 RabbitMQ 而失败。实现后结果:
|
||||||
|
|
||||||
|
- 治理测试:5/5 passed。
|
||||||
|
- MySQL 5.7 基线测试:2/2 passed。
|
||||||
|
- 环境与部署契约测试:7/7 passed。
|
||||||
|
- Schema 基线测试:23/23 passed。
|
||||||
|
- `npm run schema:verify`:`v0.0.6 (not_applicable)` passed。
|
||||||
|
- `git diff --check` 与 Node 语法检查:passed。
|
||||||
|
- 活动架构、部署、治理规范与环境模板 RabbitMQ 残留扫描:passed。
|
||||||
|
- `npm run governance:finish -- GOV-008 rocketmq-adoption`:passed。
|
||||||
|
- 独立代码 Review 与开发规范 Review:passed。
|
||||||
|
- 最终实现提交:`f5994ad77ec980175f671475e82c72d9d7e6f979`,已推送 `origin/main`。
|
||||||
|
|
||||||
|
本机诊断确认:Docker `rmqnamesrv` 容器曾启动成功但现已以 137 退出,且非 OOM;宿主机原生 RocketMQ 5.3.2 正在运行 NameServer、`broker-a` 和 Proxy。`9876`、`10911`、`8081` 可达,`mqadmin` 可读取集群、Topic 和 Broker 状态。项目 Node 客户端尚未实现,因此未创建 Topic 或写入测试消息。
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# 视觉 QA
|
||||||
|
|
||||||
|
本功能没有页面、组件、样式或浏览器交互变化,视觉 QA 不适用。
|
||||||
|
|
||||||
|
结论:not_applicable
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# 发布说明
|
||||||
|
|
||||||
|
- 项目消息队列技术基线由 RabbitMQ 调整为 RocketMQ 5.x。
|
||||||
|
- Scheduler 和 Worker 配置切换为 `ROCKETMQ_*`,并明确 Topic、Group、重试和接入地址。
|
||||||
|
- 增加 `MessageBusAdapter` 边界,避免业务绑定具体客户端。
|
||||||
|
- 本机原生 RocketMQ 5.3.2 NameServer、Broker 和 Proxy 已验证可达,Broker 已注册且状态正常;Docker `rmqnamesrv` 容器已退出,项目消息收发待 Node 客户端落地后验证。
|
||||||
|
- 最终实现提交:`f5994ad77ec980175f671475e82c72d9d7e6f979`。
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# 工程需求
|
||||||
|
|
||||||
|
## 技术基线
|
||||||
|
|
||||||
|
- MQ 固定为 RocketMQ 5.x,当前本机镜像版本为 `apache/rocketmq:5.3.2`。
|
||||||
|
- 业务模块只依赖 `MessageBusAdapter` 与版本化事件,不直接引用客户端 SDK 类型。
|
||||||
|
- Scheduler 只发布任务,Worker 只消费执行;重复投递由幂等键和业务唯一约束处理。
|
||||||
|
|
||||||
|
## 配置契约
|
||||||
|
|
||||||
|
- Scheduler 使用 `ROCKETMQ_ENABLED`、`ROCKETMQ_NAMESRV_ADDR`、`ROCKETMQ_ENDPOINT`、`ROCKETMQ_TOPIC_PREFIX` 和发送超时。RocketMQ 5.x Proxy 官方 Node Producer 不要求 Producer Group,禁止把旧 Remoting 参数混入配置。
|
||||||
|
- Worker 使用相同的基础连接字段,并增加 `ROCKETMQ_CONSUMER_GROUP` 和客户端消费并发。
|
||||||
|
- 开发和生产模板的同一进程必须保持相同键集合;生产连接地址留空且不得提交真实值。
|
||||||
|
- `ROCKETMQ_ENABLED=false` 时不建立连接;启用后 Endpoint、Topic 和对应 Group 必须通过启动配置 Schema 校验。
|
||||||
|
|
||||||
|
## 消息语义
|
||||||
|
|
||||||
|
- 事件必须包含 `eventId`、`eventType`、`schemaVersion`、`occurredAt`、`tradeDate`、`traceId` 和 `idempotencyKey`。
|
||||||
|
- Topic 表达稳定业务域,Tag 表达事件类型,Consumer Group 表达独立消费进度。
|
||||||
|
- 需要顺序处理时必须声明消息组键;普通消息不保证全局顺序。
|
||||||
|
- 超过最大消费次数后进入死信,必须支持查询、告警和受控重放。
|
||||||
|
- 最大投递次数属于 RocketMQ 服务端 Consumer Group 重试策略,由运维配置并纳入部署验收,不作为官方 Node PushConsumer 的客户端环境变量。
|
||||||
|
|
||||||
|
## 本机验证
|
||||||
|
|
||||||
|
- 检查容器、镜像、端口映射和 NameServer 启动日志。
|
||||||
|
- 使用 TCP 探针验证 `127.0.0.1:9876`。
|
||||||
|
- 检查 Docker 容器和本机原生进程,避免把相同端口的其他监听者误判为目标容器。
|
||||||
|
- 通过 `mqadmin clusterList`、`topicList`、`brokerStatus` 确认 Broker 注册、版本和管理链路;不擅自创建 Topic 或写入测试消息。
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# 代码 Review
|
||||||
|
|
||||||
|
## 第一轮
|
||||||
|
|
||||||
|
结论:changes_required。发现 2 个 Important:配置混入旧 Remoting Producer Group 和无效的客户端最大重试字段;RabbitMQ 残留断言只覆盖生产 Worker。
|
||||||
|
|
||||||
|
## 处置
|
||||||
|
|
||||||
|
- 删除 `ROCKETMQ_PRODUCER_GROUP` 和 `ROCKETMQ_MAX_RECONSUME_TIMES`。
|
||||||
|
- 明确最大投递次数属于服务端 Consumer Group 运维策略。
|
||||||
|
- 扩展测试覆盖 Scheduler/Worker 的开发与生产四份模板,同时核对开发和生产连接地址边界。
|
||||||
|
|
||||||
|
## 最终复审
|
||||||
|
|
||||||
|
- 四份 Scheduler/Worker 模板均移除旧 RabbitMQ 字段、旧 Remoting Producer Group 和无效的客户端最大重试字段。
|
||||||
|
- 开发模板统一使用 `127.0.0.1:9876` 和 `127.0.0.1:8081` 且保持关闭;生产连接地址保持空值。
|
||||||
|
- 最大投递次数归属服务端 Consumer Group 运维策略,文档和配置语义一致。
|
||||||
|
- 环境 7/7、治理 5/5、MySQL 2/2、Schema 23/23 及 Schema 验证通过。
|
||||||
|
|
||||||
|
Critical、Important、Minor 均无未关闭项。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# 开发规范符合性 Review
|
||||||
|
|
||||||
|
## 检查结果
|
||||||
|
|
||||||
|
- PRD、需求、设计、实施计划、测试计划、回退和 GitNexus 档案齐全。
|
||||||
|
- 技术基线统一为 RocketMQ 5.x,历史档案保留原版本事实。
|
||||||
|
- 配置模板无秘密,开发与生产同进程键集合一致,生产连接地址为空。
|
||||||
|
- Node.js 接入边界明确采用 MessageBusAdapter,未提前绑定未经验证的 SDK 参数。
|
||||||
|
- 本机诊断只读执行,未创建 Topic、未发送消息、未修改或重启用户进程。
|
||||||
|
- 测试先行、GitNexus 影响分析和独立复审证据齐全。
|
||||||
|
|
||||||
|
最终结论:passed
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# 回退说明
|
||||||
|
|
||||||
|
本功能只修改架构约定、无秘密环境模板、文档和契约测试,没有启动、停止或修改用户的 Docker 容器,也没有连接生产服务。
|
||||||
|
|
||||||
|
若后续 RocketMQ 客户端验证失败,使用新的治理功能和中文提交调整 Adapter 实现或接入方式;不得在业务代码中临时绕过 Adapter。回退文档配置时可以恢复上一已发布提交,但必须同步恢复开发/生产模板和契约测试,禁止形成一半 RabbitMQ、一半 RocketMQ 的混合状态。
|
||||||
|
|
||||||
|
本机 `rmqnamesrv` 容器及其 Docker 网络属于用户环境,不由仓库回退操作管理。
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# 测试计划
|
||||||
|
|
||||||
|
## 自动化
|
||||||
|
|
||||||
|
- 开发和生产同进程环境键一致。
|
||||||
|
- 生产模板禁止模拟数据并保持 MySQL 5.7 与 RocketMQ 开关契约。
|
||||||
|
- 活动架构和部署文档包含 RocketMQ 且不再包含 RabbitMQ。
|
||||||
|
- 本地 Compose 仍只启动 Redis,不隐式增加 RocketMQ 生命周期。
|
||||||
|
- 治理、MySQL 5.7、Schema 基线回归测试全部通过。
|
||||||
|
|
||||||
|
## 本机诊断
|
||||||
|
|
||||||
|
- `docker ps` 与本机进程检查 NameServer、Broker、Proxy,定位端口真实监听者。
|
||||||
|
- `docker inspect rmqnamesrv` 核对镜像与端口映射。
|
||||||
|
- `docker logs rmqnamesrv` 核对启动成功日志。
|
||||||
|
- `nc` 检查 `9876`、`10911` 和 `8081` TCP 可达。
|
||||||
|
- `mqadmin clusterList`、`topicList`、`brokerStatus` 检查 Broker 注册、Topic 路由与运行状态。
|
||||||
|
|
||||||
|
基础设施管理链路已验证。由于项目 Server 与 Node 客户端尚未实现,本版本不创建测试 Topic,也不执行项目消息生产和消费,并将此限制记录为未执行项。
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
# 前后端项目架构复核与论证
|
||||||
|
|
||||||
|
- 复核基线:`95b8611bd9bbc282193591e472e2e19c617e5035`
|
||||||
|
- 状态:实现已验证,等待用户确认
|
||||||
|
|
||||||
|
## 实际落地结构
|
||||||
|
|
||||||
|
```text
|
||||||
|
repository
|
||||||
|
├── web/ Vue 3 独立工程
|
||||||
|
│ └── src/
|
||||||
|
│ ├── app/ 应用装配、路由和根视图
|
||||||
|
│ ├── api/generated/ OpenAPI 自动生成类型
|
||||||
|
│ ├── api/adapters/ 面向页面的稳定数据适配
|
||||||
|
│ └── styles/ Sass 全局样式与后续 token 入口
|
||||||
|
├── server/ NestJS 独立工程
|
||||||
|
│ ├── apps/api/ HTTP 与 OpenAPI 入口
|
||||||
|
│ ├── apps/scheduler/ 只负责任务触发的无 HTTP 进程
|
||||||
|
│ ├── apps/worker/ 任务执行的无 HTTP 进程
|
||||||
|
│ └── libs/
|
||||||
|
│ ├── config/ 三进程最小权限配置契约
|
||||||
|
│ ├── http-contracts/ Server DTO
|
||||||
|
│ ├── message-contracts/ Server 内部 RocketMQ 信封
|
||||||
|
│ └── infrastructure/ Redis、MySQL、消息与生命周期适配
|
||||||
|
├── deploy/ systemd、Nginx、env 源码部署模板
|
||||||
|
└── tools/ 治理、Schema、契约、边界和部署验证
|
||||||
|
```
|
||||||
|
|
||||||
|
## 为什么当前拆分合适
|
||||||
|
|
||||||
|
1. **前后端工程分开,但仓库不割裂。** Web 和 Server 有各自 package、构建与类型检查,责任清楚;根 workspace 只做质量编排。个人开发阶段仍能一次安装和验证,避免维护多个仓库与跨仓库版本同步。
|
||||||
|
2. **不建立根共享 contracts 包。** HTTP 只有一个事实源:Server DTO 生成 OpenAPI,Web 再生成自己的类型。Web 无法直接引用 Server 源码,`.vue` 和 TypeScript 都有自动边界检查。这样比手工同步两份类型或共享内部类更明确。
|
||||||
|
3. **一个 Server 工程、三个进程入口。** API、Scheduler、Worker 使用相同基础设施与消息契约,但启动、配置和部署彼此独立。当前规模下没有必要拆成三个仓库或三个重复 Nest 工程;未来可独立扩容进程而不复制公共代码。
|
||||||
|
4. **配置是进程级最小权限。** API 不读取任务消费配置,Scheduler 不读取 MySQL/AI 密钥,Worker 不读取 API 端口。配置先校验和冻结,再通过动态模块注入,测试与生产使用同一装配路径。
|
||||||
|
5. **基础设施通过 Adapter 隔离。** 业务代码将依赖 MessageBus、Repository 和数据源端口;RocketMQ 客户端尚未验证时明确禁用,避免以临时内存队列形成错误语义。
|
||||||
|
6. **生产只有一条源码路径。** Ubuntu 源码部署直接使用 Web dist 与三个 Server dist 入口,由 systemd 和 Nginx 管理;源码发布门禁验证这些路径一致,避免维护第二套构建和运行语义。
|
||||||
|
|
||||||
|
## 适合下一阶段的扩展方式
|
||||||
|
|
||||||
|
- Web 市场概览应建立一个可连续阅读的 `features/market-overview/` 业务目录,内部按页面、数据适配和状态拆分;短线与中长线作为市场概览下的模式,不拆成两个独立应用。
|
||||||
|
- Server 在 API/Scheduler/Worker 各入口内注册同一市场概览业务能力的不同适配面;共享领域模型和规则计算放入稳定业务库,HTTP DTO、消息 DTO 与数据库实体继续分离。
|
||||||
|
- 用户体系、订阅和权限暂不加入当前业务模型;未来通过独立功能档案增加,不让其反向污染市场概览核心。
|
||||||
|
- 当某个业务域出现独立发布节奏、团队所有权或明显扩容边界时,再论证拆包或拆服务;当前提前微服务化只会增加契约、部署和运维成本。
|
||||||
|
|
||||||
|
## 已知限制
|
||||||
|
|
||||||
|
- 当前 Web 只是工程外壳,没有市场概览 UI、行情图表和分析工作台。
|
||||||
|
- RocketMQ 只有契约和禁用 Adapter,尚未选择并验证 Node 客户端。
|
||||||
|
- TypeORM 已固定安全选项,但尚无业务实体和迁移。
|
||||||
|
- 用户体系和订阅能力按用户决定后置,不在 GOV-009 范围。
|
||||||
|
- 仅源码部署调整已实现;历史 Docker 验证只作为决策追溯,不再代表当前可用能力。
|
||||||
|
|
||||||
|
## 复核结论
|
||||||
|
|
||||||
|
现有架构适合“先做市场概览、个人使用为主、未来可扩展订阅”的阶段:边界清晰、运行方式简单、契约可自动校验,也保留 API/Scheduler/Worker 独立扩容路径。它不是不可变终局;完成市场概览真实业务后,仍应根据模块依赖和运行数据再次复核,而不是凭脚手架预判过度拆分。
|
||||||
|
|
||||||
|
用户确认本论证前,GOV-009 保持 `reviewing/unreleased`,不得创建 `v0.0.8` 标签。
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user