Compare commits

12 Commits
90 changed files with 3528 additions and 23 deletions
+4
View File
@@ -8,7 +8,11 @@ coverage/
.env .env
.env.* .env.*
!.env.example !.env.example
*.env
*.env.*
!*.env.example
*.local *.local
.local/
# 编辑器与操作系统 # 编辑器与操作系统
.DS_Store .DS_Store
+3 -2
View File
@@ -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,12 @@
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`,启用时主机必须是开发机回环地址;禁止连接、探测或读取生产数据库。MySQL 未启用时只允许生成可验证的 `not_applicable` 清单,禁止用空 SQL 冒充基线。`governance:start` 还必须确认基线已提交、已推送且远程标签一致。
<!-- 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** (879 symbols, 1062 relationships, 23 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.
+19
View File
@@ -2,6 +2,25 @@
本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。 本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。
## 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
- 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。 - 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。
+12
View File
@@ -15,6 +15,14 @@ A read-only A-share market overview and analysis tool.
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):Compose 只启动 Redis,应用从源码运行。
- [Docker Compose 生产部署](docs/deployment/docker-compose-production.md):当前为应用脚手架落地前的配置契约骨架。
- [Ubuntu 源码生产部署](docs/deployment/ubuntu-source-production.md):支持 Ubuntu 22.04/24.04 LTS x86_64。
无秘密环境模板位于 `deploy/env/`。生产配置不进入 Git 或发布目录;Node.js 22 LTS、pnpm 10、Nginx 和基础设施由服务器管理员提供。
## 开发入口 ## 开发入口
- [文档索引](docs/index.md) - [文档索引](docs/index.md)
@@ -25,9 +33,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>
+1 -1
View File
@@ -1 +1 @@
0.0.3 0.0.6
@@ -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
}
}
+23
View File
@@ -0,0 +1,23 @@
name: a-share-analysis-development
services:
redis:
image: redis:7.2.5-alpine
container_name: a-share-analysis-dev-redis
command: ["redis-server", "--appendonly", "yes"]
ports:
- "127.0.0.1:6379:6379"
volumes:
- ../../.local/redis:/data
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 5s
timeout: 3s
retries: 10
restart: unless-stopped
networks:
- a-share-analysis-dev
networks:
a-share-analysis-dev:
name: a-share-analysis-dev
+30
View File
@@ -0,0 +1,30 @@
# 应用镜像和启动入口将在 Web/Server 脚手架落地后验证。本文件先固定生产配置边界。
name: a-share-analysis-production
services:
web:
image: ${A_SHARE_WEB_IMAGE:?必须提供不可变 Web 镜像引用}
env_file: ${A_SHARE_WEB_ENV_FILE:-/etc/a-share-analysis/web.env}
ports:
- "127.0.0.1:8080:80"
restart: unless-stopped
api:
image: ${A_SHARE_SERVER_IMAGE:?必须提供不可变 Server 镜像引用}
command: ["node", "dist/apps/api/main.js"]
env_file: ${A_SHARE_API_ENV_FILE:-/etc/a-share-analysis/api.env}
ports:
- "127.0.0.1:3000:3000"
restart: unless-stopped
scheduler:
image: ${A_SHARE_SERVER_IMAGE:?必须提供不可变 Server 镜像引用}
command: ["node", "dist/apps/scheduler/main.js"]
env_file: ${A_SHARE_SCHEDULER_ENV_FILE:-/etc/a-share-analysis/scheduler.env}
restart: unless-stopped
worker:
image: ${A_SHARE_SERVER_IMAGE:?必须提供不可变 Server 镜像引用}
command: ["node", "dist/apps/worker/main.js"]
env_file: ${A_SHARE_WORKER_ENV_FILE:-/etc/a-share-analysis/worker.env}
restart: unless-stopped
+31
View File
@@ -0,0 +1,31 @@
# 运行环境;本地源码运行固定为 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
# 第一阶段关闭付费 AI;启用后 BASE_URL、API_KEY 和 MODEL 变为必填。
AI_ENABLED=false
AI_BASE_URL=
AI_API_KEY=
AI_MODEL=
AI_TIMEOUT_MS=30000
+18
View File
@@ -0,0 +1,18 @@
# 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
# 第一阶段关闭 RabbitMQ,任务通过服务内 Adapter 调用。
RABBITMQ_ENABLED=false
RABBITMQ_URL=
RABBITMQ_EXCHANGE=a-share-analysis
RABBITMQ_PREFETCH=10
+5
View File
@@ -0,0 +1,5 @@
# VITE 变量会进入浏览器,只允许公开配置。
VITE_APP_ENV=development
VITE_APP_TITLE=A-Share Analysis
VITE_API_BASE_URL=http://127.0.0.1:3000/api
VITE_ENABLE_DEVTOOLS=true
+34
View File
@@ -0,0 +1,34 @@
# 开发环境使用确定性模拟行情,不访问生产数据源。
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
RABBITMQ_ENABLED=false
RABBITMQ_URL=
RABBITMQ_EXCHANGE=a-share-analysis
RABBITMQ_PREFETCH=10
AI_ENABLED=false
AI_BASE_URL=
AI_API_KEY=
AI_MODEL=
AI_TIMEOUT_MS=30000
+28
View File
@@ -0,0 +1,28 @@
# 生产进程必须显式使用 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
AI_ENABLED=false
AI_BASE_URL=
AI_API_KEY=
AI_MODEL=
AI_TIMEOUT_MS=30000
+16
View File
@@ -0,0 +1,16 @@
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
RABBITMQ_ENABLED=false
RABBITMQ_URL=
RABBITMQ_EXCHANGE=a-share-analysis
RABBITMQ_PREFETCH=10
+5
View File
@@ -0,0 +1,5 @@
# VITE 变量会进入浏览器,只允许公开配置。
VITE_APP_ENV=production
VITE_APP_TITLE=A-Share Analysis
VITE_API_BASE_URL=/api
VITE_ENABLE_DEVTOOLS=false
+34
View File
@@ -0,0 +1,34 @@
# 生产环境必须使用 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
RABBITMQ_ENABLED=false
RABBITMQ_URL=
RABBITMQ_EXCHANGE=a-share-analysis
RABBITMQ_PREFETCH=10
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,19 @@
[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 server/dist/apps/api/main.js
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
PrivateTmp=true
[Install]
WantedBy=multi-user.target
@@ -0,0 +1,19 @@
[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 server/dist/apps/scheduler/main.js
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
PrivateTmp=true
[Install]
WantedBy=multi-user.target
@@ -0,0 +1,19 @@
[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 server/dist/apps/worker/main.js
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
PrivateTmp=true
[Install]
WantedBy=multi-user.target
+18 -1
View File
@@ -36,6 +36,23 @@ tools/ 可重复执行的治理和开发工具
- Redis保存最新快照、缓存、锁和限流状态。 - Redis保存最新快照、缓存、锁和限流状态。
- Vue前端只读后端 API,不直接接触外部数据源和密钥。 - Vue前端只读后端 API,不直接接触外部数据源和密钥。
## 3. 当前实施顺序 ## 3. 数据库技术基线
- 数据库服务端固定使用 MySQL 5.7.x,开发、测试和生产环境禁止使用 MySQL 8.x 代替兼容性验证。
- 数据库与表默认字符集固定为 `utf8mb4`,排序规则固定为 `utf8mb4_general_ci`。
- 数据库初始化、表结构、连接会话、ORM 配置和迁移脚本必须显式声明或验证该字符集与排序规则,不能依赖服务器默认值。
- 正式启用持久化前,必须在真实 MySQL 5.7 环境验证服务端版本、Schema/表排序规则、迁移和关键查询。
- 第一阶段市场概览只定义 MySQL Repository 接口并使用内存实现,不启动数据库、不建立生产连接;后续启用时不得改变前端 API 和核心分析契约。
## 4. 当前实施顺序
第一阶段先实现可交互的市场综合概览和稳定数据契约,再接入正式行情采集链路。用户、邀请、权限、会员和支付后置,不进入当前核心架构。 第一阶段先实现可交互的市场综合概览和稳定数据契约,再接入正式行情采集链路。用户、邀请、权限、会员和支付后置,不进入当前核心架构。
## 5. 环境与部署基线
- 应用运行环境只定义 `development` 与 `production`;生产环境禁止模拟数据、热更新、调试端口和开发默认值回退。
- API、Scheduler、Worker、Web 分别拥有开发和生产模板;同一进程跨环境使用相同变量名,通过启动 Schema 校验条件必填项。
- 本地开发使用 Docker Compose 只启动 Redis,应用进程从源码运行;第一阶段 MySQL 与 RabbitMQ 保持关闭。
- 生产同时支持 Docker Compose 和 Ubuntu 22.04/24.04 LTS x86_64 源码部署,两者共用配置契约和进程边界。
- 源码部署由管理员预装 Node.js 22 LTS、pnpm 10、Nginx 和基础设施;项目只验证,不安装或修改系统软件源。
- 源码部署使用不可变发布目录、`a-share` 用户和 systemd 独立进程配置;生产 env 存放在 `/etc/a-share-analysis/`,不随代码版本切换覆盖。
@@ -0,0 +1,18 @@
# Docker Compose 生产部署
生产 Docker Compose 使用不可变应用镜像和外部 env 文件。当前 `production.yml.example` 是部署契约骨架,应用镜像、健康检查和实际启动命令必须在 Web/Server 脚手架完成后验证,未验证前不得用于线上部署。
## 配置边界
- 从 `deploy/env/production/` 准备四份真实配置,存放在服务器 `/etc/a-share-analysis/` 或其他受控目录。
- Compose 通过外部路径加载,不在 YAML、镜像和 Git 中保存秘密。
- 镜像引用必须包含版本或内容摘要,禁止浮动 `latest`。
- 第一阶段只依赖 Redis;MySQL 和 RabbitMQ 功能开关保持关闭。
## 发布与回退
部署前验证镜像对应已推送提交或标签、环境 Schema、健康检查和数据目录。升级只修改不可变镜像引用;失败时恢复上一完整镜像集合和未改变的外部配置。禁止删除 Redis、MySQL 或 RabbitMQ 数据目录作为应用回退手段。
## 验证
应用脚手架落地后必须补充 `docker compose config`、服务健康检查、日志读取、优雅停止和回退演练证据。本版本不声称生产 Compose 已可运行。
+21
View File
@@ -0,0 +1,21 @@
# 本地开发环境
本地开发使用 Docker Compose 只启动 Redis,Web、API、Scheduler 和 Worker 从源码运行并使用开发环境模板。第一阶段不启动 MySQL 和 RabbitMQ。
## 配置
从 `deploy/env/development/` 中对应的 `*.env.example` 创建本机 `*.env.local`。真实文件被 Git 忽略,不得写入生产地址或真实密钥。
## Redis
```bash
docker compose -f deploy/compose/development.yml up -d
docker compose -f deploy/compose/development.yml ps
docker compose -f deploy/compose/development.yml down
```
Redis 只绑定 `127.0.0.1:6379`,数据写入仓库忽略的 `.local/redis/`。不得把该 Compose 文件用于生产。
## 应用状态
Web 和 Server 尚未完成脚手架,因此本版本只交付配置契约和 Redis 开发环境。后续脚手架必须使用 Node.js 22 LTS、pnpm 10 和这些模板,不能在本文档中假装应用已经可启动。
@@ -0,0 +1,35 @@
# Ubuntu 源码生产部署
正式支持 Ubuntu 22.04 LTS 与 Ubuntu 24.04 LTS 的 x86_64。服务器管理员预先提供 Node.js 22 LTS、pnpm 10、Nginx,以及 MySQL 5.7、Redis、RabbitMQ 或相应外部服务;项目不负责安装或升级这些软件,也不修改系统软件源。
## 前置验证
```bash
uname -m
node --version
pnpm --version
nginx -v
```
架构必须为 `x86_64`,Node.js 必须为 22 LTS,pnpm 必须为 10.x。不满足要求时终止部署。
## 目录与配置
- 发布目录:`/opt/a-share-analysis/releases/<版本或提交>/`。
- 当前版本:`/opt/a-share-analysis/current` 符号链接。
- 生产配置:`/etc/a-share-analysis/api.env`、`scheduler.env`、`worker.env`、`web.env`。
- 运行用户:非登录系统用户 `a-share`。
真实配置从仓库生产模板生成,但不得放入发布目录。API、Scheduler、Worker 的 systemd 单元分别通过 `EnvironmentFile=` 读取自己的配置;包含秘密的文件建议为 `root:a-share 0640`。
## 构建与启动边界
使用 `pnpm install --frozen-lockfile` 安装锁定依赖,在新发布目录构建 Web 和 Server。Web 静态文件由 Nginx 托管,API、Scheduler、Worker 运行编译后的 JavaScript。禁止 Vite 开发服务器、watch、调试端口和生产运行 TypeScript。
当前应用尚未脚手架化,仓库中的 systemd 与 Nginx 文件是路径和权限契约示例,不能冒充已经验证的线上启动文件。后续应用功能必须补充实际构建、启动和健康检查验证。
## 升级、检查与回退
在新的不可变发布目录完成安装、构建和配置校验后,原子切换 `current`,依次重启 API、Scheduler、Worker 并检查 `systemctl status`、`journalctl` 和 HTTP 健康端点。失败时切回上一完整目录并重启服务;生产配置不随版本切换覆盖。
项目部署流程禁止连接或读取生产数据库做开发验证。数据库备份属于独立运维职责,应用回退不得删除或覆盖数据。
@@ -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,17 @@
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
@@ -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 记录为不适用。
+40 -6
View File
@@ -8,7 +8,7 @@
- 前端:Vue 3、Vite、TypeScript、Dart Sass、Naive UI。 - 前端:Vue 3、Vite、TypeScript、Dart Sass、Naive UI。
- 后端:NestJS、TypeScript。 - 后端:NestJS、TypeScript。
- 数据库:MySQL;缓存:Redis;消息队列:RabbitMQ。 - 数据库:MySQL 5.7.x,字符集 `utf8mb4`,排序规则 `utf8mb4_general_ci`;缓存:Redis;消息队列:RabbitMQ。
- 图表:Lightweight Charts负责K线和分时,ECharts负责热力图、分布和资金趋势。 - 图表:Lightweight Charts负责K线和分时,ECharts负责热力图、分布和资金趋势。
- AI:由服务端调用兼容 OpenAI 格式的付费 API,密钥不得下发浏览器。 - AI:由服务端调用兼容 OpenAI 格式的付费 API,密钥不得下发浏览器。
@@ -82,7 +82,18 @@ count += 1;
- 免费数据源失败时保留最后有效快照,并明确标记陈旧,禁止伪装实时数据。 - 免费数据源失败时保留最后有效快照,并明确标记陈旧,禁止伪装实时数据。
- AI 失败不得影响规则分析和基础行情展示。 - AI 失败不得影响规则分析和基础行情展示。
## 8. 前端规范 ## 8. 环境配置规范
- 应用只接受 `development` 与 `production`,环境必须显式设置。生产启动不得回退到开发默认值、模拟数据、热更新或调试模式。
- API、Scheduler、Worker 必须使用各自的配置 Schema,在进程启动时验证类型、格式、范围和条件必填项;配置错误立即退出。
- 同一进程的开发与生产模板必须保持相同变量名。环境差异通过配置值、依赖注入和 Adapter 收敛,禁止在业务代码中散落 `APP_ENV` 分支。
- 只有 `*.env.example` 可以提交;真实 `.env`、`*.env.local`、密码、Token 和 API Key 必须被 Git 忽略并由运行环境注入。
- Web 只能使用公开的 `VITE_*` 变量。数据库、Redis、RabbitMQ、数据源和 AI 凭据禁止进入前端变量或构建产物。
- MySQL、RabbitMQ、正式数据源与 AI 使用显式功能开关;关闭时连接变量可为空,开启后缺少任何必填值都必须拒绝启动。
- Docker Compose 与源码部署必须复用同一变量契约,禁止为某种部署方式建立语义不同的别名。
- 生产配置必须位于发布目录之外,切换应用版本不得覆盖配置;日志和诊断输出必须对配置值脱敏。
## 9. 前端规范
- 页面不得直接访问第三方行情源、Redis、RabbitMQ 或 AI 服务。 - 页面不得直接访问第三方行情源、Redis、RabbitMQ 或 AI 服务。
- 全局服务器状态使用 TanStack Vue Query,本地界面偏好使用 Pinia或轻量组合式函数。 - 全局服务器状态使用 TanStack Vue Query,本地界面偏好使用 Pinia或轻量组合式函数。
@@ -91,14 +102,37 @@ count += 1;
- 图表必须标注单位、时间范围、数据日期和更新时间。 - 图表必须标注单位、时间范围、数据日期和更新时间。
- 所有核心交互覆盖加载、空、部分数据、错误和过期状态。 - 所有核心交互覆盖加载、空、部分数据、错误和过期状态。
## 9. 后端与任务规范 ## 10. 后端与任务规范
- API、Scheduler和Worker作为独立进程维护,不在请求期间临时抓取全市场数据。 - API、Scheduler和Worker作为独立进程维护,不在请求期间临时抓取全市场数据。
- Scheduler只决定何时投递;RabbitMQ负责任务传输;Worker负责执行;MySQL负责事实记录;Redis负责当前快照和短期状态。 - Scheduler只决定何时投递;RabbitMQ负责任务传输;Worker负责执行;MySQL负责事实记录;Redis负责当前快照和短期状态。
- 消费者必须幂等,消息确认只能发生在持久化或可验证处理完成后。 - 消费者必须幂等,消息确认只能发生在持久化或可验证处理完成后。
- 免费数据源通过 Adapter 统一为内部模型,上层不得依赖供应商原始字段。 - 免费数据源通过 Adapter 统一为内部模型,上层不得依赖供应商原始字段。
## 10. 测试要求 ## 11. MySQL 5.7 兼容规范
- 开发、测试、Docker 和生产环境必须使用明确的 MySQL 5.7 补丁版本,禁止使用 `latest`、MySQL 8.x 或其他数据库代替兼容性验证。
- 创建数据库必须显式声明 `DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci`;建表与迁移脚本必须显式保持 `DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci`。
- ORM 和数据库驱动必须声明 `utf8mb4`,连接建立后验证会话、数据库和表的排序规则为 `utf8mb4_general_ci`,不得依赖服务器默认值。
- 文本列默认继承表级规则。列级改变字符集或排序规则必须由具体功能设计解释,并通过 ADR 审批。
- 禁止使用 MySQL 8.x 专属或在 5.7 行为不同的公用表表达式、递归 CTE、窗口函数、函数索引、不可见索引、`utf8mb4_0900_*` 排序规则和 JSON 增强能力。
- 不得依赖 `CHECK` 约束在 MySQL 8.x 的强制执行语义;MySQL 5.7 下的业务约束必须由边界校验、普通索引或可测试的写入逻辑保证。
- `utf8mb4_general_ci` 不区分大小写。证券代码、外部事件 ID、幂等键等身份字段必须规范化输入,或显式采用经设计批准的二进制比较与唯一键,不能误把默认比较当成大小写敏感。
- 索引长度按 MySQL 5.7 和 `utf8mb4` 最多四字节字符预算;超长标识使用受控长度、前缀索引或稳定摘要时,必须说明唯一性和碰撞处理。
- JSON 字段只能使用 MySQL 5.7 已支持并经过真实环境验证的能力,查询和索引不得建立在 8.x 特性上。
- 每份迁移脚本必须能够从上一版本基线在 MySQL 5.7 正向执行;禁止用直接修改共享数据库表代替迁移脚本。
- 代码 Review 必须检查服务端版本、字符集、排序规则、SQL/迁移兼容性、索引长度和字符串比较语义;任一不符合项按 Important 处理并阻断发布。
### Schema 基线规范
- 每个新应用版本开发前必须封存上一已发布版本的开发库 Schema;只能读取 `APP_ENV=development`、`a_share_analysis_dev`,禁止连接、探测或读取生产数据库。
- 导出使用 MySQL 5.7 `mysqldump` 的 `--no-data --routines --triggers --events`,完整保留表、索引、外键、视图、触发器、存储过程、函数和事件,不得包含任何表数据。
- 规范化必须确定性删除导出时间、环境 `DEFINER` 和表选项中的当前 `AUTO_INCREMENT=<值>`,同时保留列定义的 `AUTO_INCREMENT` 属性和业务 SQL。
- 账号密码只能通过受控子进程环境传递,不得进入参数、日志、SQL、清单或 checksum 文件。
- `manifest.yaml`、`checksum.sha256` 和 `schema.sql` 的 SHA-256 必须一致;既有版本目录只允许内容完全一致的幂等验证,不允许覆盖。
- MySQL 未启用时只创建状态为 `not_applicable` 的清单,不得创建空 `schema.sql`;启用后的缺失基线必须阻断下一版本开发。
## 12. 测试要求
- 功能和缺陷修复遵循测试先行:先看到测试因缺少行为而失败,再实现最小代码。 - 功能和缺陷修复遵循测试先行:先看到测试因缺少行为而失败,再实现最小代码。
- 纯规则和指标计算使用单元测试,期望值必须手工推导。 - 纯规则和指标计算使用单元测试,期望值必须手工推导。
@@ -107,14 +141,14 @@ count += 1;
- 关键页面使用 Playwright流程测试和视觉截图对比。 - 关键页面使用 Playwright流程测试和视觉截图对比。
- 合并前必须通过类型检查、测试、构建和适用的视觉验证。 - 合并前必须通过类型检查、测试、构建和适用的视觉验证。
## 11. 安全要求 ## 13. 安全要求
- 禁止提交 `.env`、API Key、密码、真实账号和生产数据。 - 禁止提交 `.env`、API Key、密码、真实账号和生产数据。
- AI 密钥、数据源凭证和支付凭证仅存在服务端密钥管理中。 - AI 密钥、数据源凭证和支付凭证仅存在服务端密钥管理中。
- SQL必须参数化;外部输入必须在边界处校验。 - SQL必须参数化;外部输入必须在边界处校验。
- 日志和异常报告必须脱敏。 - 日志和异常报告必须脱敏。
## 12. 代码 Review 要求 ## 14. 代码 Review 要求
开发者完成自测不等于 Review 完成。审查者必须从功能 PRD、设计和 Git diff 出发,检查: 开发者完成自测不等于 Review 完成。审查者必须从功能 PRD、设计和 Git diff 出发,检查:
+28 -12
View File
@@ -16,21 +16,26 @@ released → superseded
## 3. 开发前流程 ## 3. 开发前流程
1. 分配功能编号和英文短名称。 1. 确认上一已发布语义化版本及标签提交,执行 `npm run schema:baseline` 和 `npm run schema:verify`。
2. 建立 `docs/features/<编号>-<短名称>/`。 2. MySQL 已启用时只能从 `APP_ENV=development`、`a_share_analysis_dev` 和本机回环地址导出完整 Schema;MySQL 未启用时只保存 `not_applicable` 清单,不创建空 SQL。
3. 编写 `prd.md`,明确用户问题、目标、范围、非目标、用户流程、指标、风险和验收标准。 3. 将 `database/schema-baselines/<上一发布版本>/` 作为独立中文提交推送 Gitea,核对本地和远程 SHA;既有版本目录禁止覆盖。只有 Git 已跟踪、工作区无改动、当前分支已推送且远程发布标签提交一致时,`governance:start` 才会继续。
4. PRD 审核通过后,将产品需求转换为可测试的工程需求。 4. 分配功能编号和英文短名称。
5. 比较可选方案,记录设计与关键决策。 5. 建立 `docs/features/<编号>-<短名称>/`。
6. 更新 API、事件和数据结构契约。 6. 编写 `prd.md`,明确用户问题、目标、范围、非目标、用户流程、指标、风险和验收标准。
7. 编写测试计划和实施计划。 7. PRD 审核通过后,将产品需求转换为可测试的工程需求。
8. 确保 Git 工作区基线可识别,执行: 8. 比较可选方案,记录设计与关键决策。
9. 更新 API、事件和数据结构契约。
10. 编写测试计划和实施计划。
11. 明确功能需要的环境变量、功能开关和部署影响;同步更新开发/生产模板,禁止只修改本机真实 env。
12. 确保 Git 工作区基线可识别,执行:
```bash ```bash
npm run governance:start -- FEAT-MO-001 market-overview npm run governance:start -- FEAT-MO-001 market-overview
``` ```
9. 运行 GitNexus 查询、上下文和影响分析,将结果写入 `gitnexus/impact-plan.md`。 13. `governance:start` 会只读复核上一发布版本 Schema 基线;缺失、失效或版本不一致时立即阻断,不会代为生成。
10. 高风险或关键路径变化必须先向用户说明影响,再进入开发。 14. 运行 GitNexus 查询、上下文和影响分析,将结果写入 `gitnexus/impact-plan.md`。
15. 高风险或关键路径变化必须先向用户说明影响,再进入开发。
开发前必须至少回答:修改什么、为什么修改、影响谁、如何验证、失败后如何回退。 开发前必须至少回答:修改什么、为什么修改、影响谁、如何验证、失败后如何回退。
@@ -79,8 +84,19 @@ npm run governance:finish -- FEAT-MO-001 market-overview
- 发布说明和回退方法可执行。 - 发布说明和回退方法可执行。
- 中文提交已关联功能编号。 - 中文提交已关联功能编号。
- 当前分支和本次新建标签已推送到 `origin`,功能档案保存远程核对结果。 - 当前分支和本次新建标签已推送到 `origin`,功能档案保存远程核对结果。
- 配置契约变化已同步开发/生产模板和适用的 Compose、systemd、Nginx及部署文档。
- 下一版本开发前所需的上一发布版本 Schema 基线已验证、独立提交并推送 Gitea。
## 7. 提交流程 ## 7. 数据库 Schema 基线
- 基线目录固定为 `database/schema-baselines/vX.Y.Z/`,版本是被备份的已发布版本。
- 真实基线由 `schema.sql`、`manifest.yaml`、`checksum.sha256` 组成;范围包括表、索引、外键、视图、触发器、存储过程、函数和 Event Scheduler 事件,不含数据。
- MySQL 未启用时目录只能包含 `manifest.yaml`,状态为 `not_applicable`、原因为 `mysql_disabled`。
- `schema:baseline` 不接受 env 路径、环境类型或数据库名参数;配置路径固定在开发环境,生产配置和生产数据库不属于该命令的权限范围。
- 修正已发布基线必须新增治理记录说明原因,禁止静默覆盖或重写历史目录。
- 首次启用 MySQL 的版本必须通过迁移建立开发库,并在 MySQL 5.7 开发环境生成第一份真实 Schema 基线。
## 8. 提交流程
提交格式: 提交格式:
@@ -112,7 +128,7 @@ git push origin <本次标签名>
禁止使用 `--force`、`--force-with-lease` 或 `--tags` 代替精确推送。推送失败时不得宣称任务完成;应记录不含凭据的错误摘要,排查后重试同一精确命令。 禁止使用 `--force`、`--force-with-lease` 或 `--tags` 代替精确推送。推送失败时不得宣称任务完成;应记录不含凭据的错误摘要,排查后重试同一精确命令。
## 8. 发布与回退 ## 9. 发布与回退
- 使用语义化版本和带注释 Git Tag。 - 使用语义化版本和带注释 Git Tag。
- 发布产物必须对应确定提交,不从浮动分支临时构建。 - 发布产物必须对应确定提交,不从浮动分支临时构建。
+14
View File
@@ -15,6 +15,17 @@
- [ADR-0001:单仓库双项目独立部署](adr/ADR-0001-monorepo-independent-deploy.md) - [ADR-0001:单仓库双项目独立部署](adr/ADR-0001-monorepo-independent-deploy.md)
- [ADR-0002:GitNexus 双门禁](adr/ADR-0002-gitnexus-double-gate.md) - [ADR-0002:GitNexus 双门禁](adr/ADR-0002-gitnexus-double-gate.md)
## 环境与部署
- [本地开发环境](deployment/local-development.md)
- [Docker Compose 生产部署](deployment/docker-compose-production.md)
- [Ubuntu 源码生产部署](deployment/ubuntu-source-production.md)
## 数据库版本基线
- [Schema 基线目录](../database/schema-baselines/)
- [GOV-007 设计规格](features/GOV-007-development-schema-baseline/design.md)
## GitNexus ## GitNexus
- [仓库基线](gitnexus/repository-baseline.md) - [仓库基线](gitnexus/repository-baseline.md)
@@ -28,5 +39,8 @@
- [GOV-002:PRD 与 Review 门禁](features/GOV-002-prd-review-gates/manifest.yaml) - [GOV-002:PRD 与 Review 门禁](features/GOV-002-prd-review-gates/manifest.yaml)
- [GOV-003:项目专用 Gitea 远程仓库](features/GOV-003-gitea-local-remote/manifest.yaml) - [GOV-003:项目专用 Gitea 远程仓库](features/GOV-003-gitea-local-remote/manifest.yaml)
- [GOV-004:提交后强制推送 Gitea](features/GOV-004-mandatory-gitea-push/manifest.yaml) - [GOV-004:提交后强制推送 Gitea](features/GOV-004-mandatory-gitea-push/manifest.yaml)
- [GOV-005:MySQL 5.7 字符集与兼容性基线](features/GOV-005-mysql57-charset-baseline/manifest.yaml)
- [GOV-006:开发、生产环境与双部署方式](features/GOV-006-environment-deployment-baseline/manifest.yaml)
- [GOV-007:开发数据库 Schema 基线与版本门禁](features/GOV-007-development-schema-baseline/manifest.yaml)
功能档案是需求、设计、代码、测试、版本和回退之间的唯一正式关联入口。 功能档案是需求、设计、代码、测试、版本和回退之间的唯一正式关联入口。
+5
View File
@@ -5,6 +5,11 @@
"type": "module", "type": "module",
"scripts": { "scripts": {
"test:governance": "node --test tools/governance/feature-record.test.mjs", "test:governance": "node --test tools/governance/feature-record.test.mjs",
"test:mysql-baseline": "node --test tools/governance/mysql-baseline.test.mjs",
"test:environment-baseline": "node --test tools/governance/environment-baseline.test.mjs",
"test:schema-baseline": "node --test tools/database/schema-baseline.test.mjs",
"schema:baseline": "node tools/database/schema-baseline.mjs generate",
"schema:verify": "node tools/database/schema-baseline.mjs verify",
"governance:start": "node tools/governance/start.mjs", "governance:start": "node tools/governance/start.mjs",
"governance:finish": "node tools/governance/finish.mjs" "governance:finish": "node tools/governance/finish.mjs"
} }
@@ -0,0 +1,18 @@
/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
CREATE TABLE `market_snapshot` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`trade_date` date NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
/*!50001 DROP VIEW IF EXISTS `active_market_snapshot`*/;
/*!50001 CREATE ALGORITHM=UNDEFINED */
/*!50013 SQL SECURITY DEFINER */
/*!50001 VIEW `active_market_snapshot` AS select `market_snapshot`.`id` AS `id` from `market_snapshot` */;
DELIMITER ;;
/*!50003 CREATE*/ /*!50003 TRIGGER `market_snapshot_before_insert` BEFORE INSERT ON `market_snapshot` FOR EACH ROW SET NEW.trade_date = COALESCE(NEW.trade_date, CURRENT_DATE) */;;
/*!50003 CREATE*/ /*!50003 PROCEDURE `refresh_market_snapshot`() BEGIN SELECT COUNT(*) FROM market_snapshot; END */;;
/*!50106 CREATE*/ /*!50106 EVENT `purge_market_snapshot` ON SCHEDULE EVERY 1 DAY DO DELETE FROM market_snapshot WHERE trade_date < CURRENT_DATE - INTERVAL 365 DAY */;;
DELIMITER ;
@@ -0,0 +1,26 @@
-- MySQL dump 10.13 Distrib 5.7.44, for Linux (x86_64)
--
-- Host: 127.0.0.1 Database: a_share_analysis_dev
-- ------------------------------------------------------
-- Server version 5.7.44-log
/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
CREATE TABLE `market_snapshot` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`trade_date` date NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=128 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
/*!50001 DROP VIEW IF EXISTS `active_market_snapshot`*/;
/*!50001 CREATE ALGORITHM=UNDEFINED */
/*!50013 DEFINER=`dev_reader`@`127.0.0.1` SQL SECURITY DEFINER */
/*!50001 VIEW `active_market_snapshot` AS select `market_snapshot`.`id` AS `id` from `market_snapshot` */;
DELIMITER ;;
/*!50003 CREATE*/ /*!50017 DEFINER=`dev_reader`@`127.0.0.1`*/ /*!50003 TRIGGER `market_snapshot_before_insert` BEFORE INSERT ON `market_snapshot` FOR EACH ROW SET NEW.trade_date = COALESCE(NEW.trade_date, CURRENT_DATE) */;;
/*!50003 CREATE*/ /*!50020 DEFINER=`dev_reader`@`127.0.0.1`*/ /*!50003 PROCEDURE `refresh_market_snapshot`() BEGIN SELECT COUNT(*) FROM market_snapshot; END */;;
/*!50106 CREATE*/ /*!50117 DEFINER=`dev_reader`@`127.0.0.1`*/ /*!50106 EVENT `purge_market_snapshot` ON SCHEDULE EVERY 1 DAY DO DELETE FROM market_snapshot WHERE trade_date < CURRENT_DATE - INTERVAL 365 DAY */;;
DELIMITER ;
-- Dump completed on 2026-08-13 11:00:00
+766
View File
@@ -0,0 +1,766 @@
import { execFileSync } from 'node:child_process';
import {
existsSync,
mkdirSync,
readFileSync,
readdirSync,
renameSync,
rmSync,
writeFileSync,
} from 'node:fs';
import { createHash } from 'node:crypto';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
const DEVELOPMENT_DATABASE = 'a_share_analysis_dev';
const REQUIRED_CHARSET = 'utf8mb4';
const REQUIRED_COLLATION = 'utf8mb4_general_ci';
const BASELINE_FORMAT_VERSION = 1;
const TOOL_VERSION = '1.0.0';
const VERSION_PATTERN = /^v\d+\.\d+\.\d+$/;
const DEVELOPMENT_HOSTS = new Set(['127.0.0.1', 'localhost', '::1']);
const OBJECT_KEYS = Object.freeze(['tables', 'views', 'triggers', 'routines', 'events']);
const CAPTURED_FILES = Object.freeze(['checksum.sha256', 'manifest.yaml', 'schema.sql']);
const NOT_APPLICABLE_FILES = Object.freeze(['manifest.yaml']);
function requireExactValue(actual, expected, message) {
if (actual !== expected) {
throw new Error(`${message},要求 ${expected},实际 ${actual || '(空)'}`);
}
}
function isEnabled(value) {
return value === true || value === 'true';
}
/**
* Schema 工具拥有比普通应用启动更窄的权限边界:即使连接地址看起来是本机,
* 环境名和数据库名也必须同时命中固定开发值,避免通过参数误切到生产库。
*/
export function assertSafeDevelopmentConfiguration(config) {
requireExactValue(config.APP_ENV, 'development', 'Schema 基线只允许 development 环境');
requireExactValue(
config.MYSQL_DATABASE,
DEVELOPMENT_DATABASE,
'Schema 基线只允许固定开发库 a_share_analysis_dev',
);
requireExactValue(config.MYSQL_CHARSET, REQUIRED_CHARSET, '数据库字符集不符合要求');
requireExactValue(
config.MYSQL_COLLATION,
REQUIRED_COLLATION,
'数据库排序规则不符合要求',
);
if (isEnabled(config.MYSQL_ENABLED)) {
if (!DEVELOPMENT_HOSTS.has(config.MYSQL_HOST)) {
throw new Error(
`Schema 基线只允许通过开发机回环地址连接,实际 ${config.MYSQL_HOST || '(空)'};远程开发库必须先建立本地 SSH 隧道`,
);
}
for (const key of ['MYSQL_HOST', 'MYSQL_PORT', 'MYSQL_USERNAME', 'MYSQL_PASSWORD']) {
if (!String(config[key] ?? '').trim()) {
throw new Error(`MySQL 已启用,${key} 不能为空`);
}
}
} else if (config.MYSQL_ENABLED !== false && config.MYSQL_ENABLED !== 'false') {
throw new Error('MYSQL_ENABLED 必须显式为 true 或 false');
}
return Object.freeze({ ...config, MYSQL_ENABLED: isEnabled(config.MYSQL_ENABLED) });
}
/**
* 客户端与服务端分别校验,防止用 MySQL 8 客户端生成带有 5.7 无法稳定恢复的语法,
* 同时核对数据库自身字符规则,而不是信任 env 中的声明值。
*/
export function assertMysql57Metadata(metadata) {
if (!/^5\.7\.\d+(?:[-+].*)?$/.test(metadata.mysqlClientVersion ?? '')) {
throw new Error(`mysql 客户端必须为 5.7.x,实际 ${metadata.mysqlClientVersion || '(空)'}`);
}
if (!/^5\.7\.\d+(?:[-+].*)?$/.test(metadata.mysqldumpClientVersion ?? '')) {
throw new Error(
`mysqldump 客户端必须为 5.7.x,实际 ${metadata.mysqldumpClientVersion || '(空)'}`,
);
}
if (!/^5\.7\.\d+(?:[-+].*)?$/.test(metadata.serverVersion ?? '')) {
throw new Error(`MySQL 服务端必须为 5.7.x,实际 ${metadata.serverVersion || '(空)'}`);
}
requireExactValue(metadata.databaseCharset, REQUIRED_CHARSET, '开发数据库字符集不符合要求');
requireExactValue(
metadata.databaseCollation,
REQUIRED_COLLATION,
'开发数据库排序规则不符合要求',
);
return metadata;
}
export function buildMysqldumpArguments(config) {
assertSafeDevelopmentConfiguration(config);
return [
`--host=${config.MYSQL_HOST}`,
`--port=${config.MYSQL_PORT}`,
`--user=${config.MYSQL_USERNAME}`,
`--default-character-set=${REQUIRED_CHARSET}`,
'--no-data',
'--routines',
'--triggers',
'--events',
'--single-transaction',
'--skip-lock-tables',
'--skip-comments',
DEVELOPMENT_DATABASE,
];
}
function buildMysqlMetadataArguments(config) {
return [
`--host=${config.MYSQL_HOST}`,
`--port=${config.MYSQL_PORT}`,
`--user=${config.MYSQL_USERNAME}`,
`--default-character-set=${REQUIRED_CHARSET}`,
'--batch',
'--skip-column-names',
DEVELOPMENT_DATABASE,
'--execute=SELECT VERSION(), DEFAULT_CHARACTER_SET_NAME, DEFAULT_COLLATION_NAME FROM information_schema.SCHEMATA WHERE SCHEMA_NAME = DATABASE()',
];
}
function assertSchemaHasNoSensitiveOrDataStatements(sql) {
// 安全扫描只忽略 SQL 字符串字面量,标识符反引号仍参与检查。否则存储过程
// 合法返回“DEFINER=”等说明文字时会被误判,而真正的对象 DEFINER 仍可检出。
const sqlWithoutStringLiterals = sql.replace(/'(?:''|\\.|[^'\\])*'/gs, "''");
const prohibitedPatterns = [
[sqlWithoutStringLiterals, /\bDEFINER\s*=/i, 'DEFINER'],
[sql, /^--\s*MySQL dump\b/im, 'MySQL dump 头'],
[sql, /--\s*Dump completed on/i, '导出完成时间'],
[sql, /--\s*Host:/i, '连接主机注释'],
[sql, /\b(?:password|passwd|pwd|api[_-]?key|api[_-]?token|access[_-]?token|client[_-]?secret|secret)\s*[:=]/i, '疑似凭据'],
[sql, /\b(?:mysql|mariadb):\/\/[^\s'"`]+/i, '数据库连接串'],
[sql, /\b(?:production|prod)[-_\s]*(?:host|db|database)?\s*[:=]\s*[^\s'"`]+/i, '疑似生产主机'],
];
for (const [content, pattern, label] of prohibitedPatterns) {
if (pattern.test(content)) {
throw new Error(`Schema SQL 包含禁止内容:${label}`);
}
}
for (const statement of splitSqlStatements(sql)) {
let executableSql = statement
.replace(
/^(?:\s*--[^\n]*(?:\n|$)|\s*#[^\n]*(?:\n|$)|\s*\/\*(?!\!)[\s\S]*?\*\/\s*)+/g,
'',
)
.trim();
const candidates = [executableSql];
const executableComment = executableSql.match(/^\/\*!\d{5}\s+([\s\S]*?)\*\/\s*/);
if (executableComment) {
candidates.push(
executableComment[1].trim(),
executableSql.slice(executableComment[0].length).trim(),
);
}
const dataStatement = candidates.find((candidate) =>
/^(?:INSERT\s+INTO|REPLACE\s+INTO|UPDATE\b|DELETE\s+FROM\b|TRUNCATE(?:\s+TABLE)?\b|LOAD\s+(?:DATA|XML)\b)/i.test(
candidate,
),
);
if (dataStatement) {
const operation = dataStatement.match(
/^(?:INSERT\s+INTO|REPLACE\s+INTO|UPDATE|DELETE\s+FROM|TRUNCATE(?:\s+TABLE)?|LOAD\s+(?:DATA|XML))/i,
)[0];
throw new Error(
`Schema SQL 包含禁止的数据操作:${operation}`,
);
}
}
}
function findDelimiterOutsideStrings(content, delimiter) {
let quote = null;
let escaped = false;
for (let index = 0; index <= content.length - delimiter.length; index += 1) {
const character = content[index];
if (quote) {
if (escaped) {
escaped = false;
} else if (character === '\\') {
escaped = true;
} else if (character === quote) {
if (content[index + 1] === quote && quote !== '`') {
index += 1;
} else {
quote = null;
}
}
continue;
}
if (character === "'" || character === '"' || character === '`') {
quote = character;
continue;
}
if (content.startsWith(delimiter, index)) return index;
}
return -1;
}
/**
* mysqldump 用 DELIMITER 包住例程、触发器和事件。按真实分隔符切分后,
* 只有顶层以 INSERT/REPLACE 开头的语句代表数据;对象体内部 DML 必须保留。
*/
function splitSqlStatements(sql) {
const statements = [];
let delimiter = ';';
let buffer = '';
for (const line of String(sql).split(/(?<=\n)/)) {
const directive = line.trim().match(/^DELIMITER\s+(\S+)$/i);
if (directive) {
if (buffer.trim()) statements.push(buffer.trim());
buffer = '';
delimiter = directive[1];
continue;
}
buffer += line;
let delimiterIndex;
while ((delimiterIndex = findDelimiterOutsideStrings(buffer, delimiter)) >= 0) {
const statement = buffer.slice(0, delimiterIndex).trim();
if (statement) statements.push(statement);
buffer = buffer.slice(delimiterIndex + delimiter.length);
}
}
if (buffer.trim()) statements.push(buffer.trim());
return statements;
}
/**
* 规范化只删除 mysqldump 的环境噪声,不重排或重新格式化业务定义。
* 表选项中的当前 AUTO_INCREMENT 值会随数据增长变化;列定义的自增属性不匹配
* “等号加数字”的模式,因此会原样保留。
*/
export function normalizeSchemaSql(rawSql) {
const normalized = String(rawSql)
.replace(/\r\n?/g, '\n')
.replace(/^-- MySQL dump .*\n/gm, '')
.replace(/^-- Host:.*\n/gm, '')
.replace(/^-- -+\n/gm, '')
.replace(/^--\s*\n/gm, '')
.replace(/^-- Server version.*\n/gm, '')
.replace(/^-- Dump completed on .*\n?/gm, '')
.replace(/\/\*!\d{5}\s+DEFINER=`[^`]+`@`[^`]+`\*\//g, '')
.replace(
/^(\/\*!\d{5}\s+)DEFINER=`[^`]+`@`[^`]+`\s+(SQL SECURITY\s+(?:DEFINER|INVOKER)\s+\*\/)$/gm,
'$1$2',
)
// 普通视图的 DEFINER 只允许出现在版本注释外、语句行首的 CREATE 前缀中;
// 限定在行首可避免误删例程字符串或注释里的业务文本。
.replace(/^(\/\*!\d{5}\s+CREATE\s+[^\n]*?)\bDEFINER=`[^`]+`@`[^`]+`\s*/gm, '$1')
.replace(/^(\) ENGINE=[^\n;]*?) AUTO_INCREMENT=\d+(?= )/gm, '$1')
.replace(/^\s+/, '')
.replace(/\s+$/, '');
const result = normalized.length > 0 ? `${normalized}\n` : '';
assertSchemaHasNoSensitiveOrDataStatements(result);
return result;
}
function sha256(content) {
return createHash('sha256').update(content, 'utf8').digest('hex');
}
function buildManifest(fields) {
// JSON 是 YAML 1.2 的严格子集;使用标准解析器生成和读取,避免手写 YAML
// 对缩进、引号和同名嵌套字段产生歧义,同时仍保留约定的 manifest.yaml 文件名。
return `${JSON.stringify(
{
format_version: BASELINE_FORMAT_VERSION,
status: fields.status,
application_version: fields.applicationVersion,
git_commit: fields.gitCommit,
source_environment: 'development',
database_name: DEVELOPMENT_DATABASE,
mysql_client_version: fields.mysqlClientVersion,
mysqldump_client_version: fields.mysqldumpClientVersion,
mysql_server_version: fields.serverVersion,
charset: REQUIRED_CHARSET,
collation: REQUIRED_COLLATION,
generated_at: fields.generatedAt,
generator: `schema-baseline/${TOOL_VERSION}`,
reason: fields.reason ?? 'none',
schema_sha256: fields.schemaSha256 ?? 'not_applicable',
objects: {
tables: fields.captured,
views: fields.captured,
triggers: fields.captured,
routines: fields.captured,
events: fields.captured,
},
},
null,
2,
)}\n`;
}
export function buildCapturedArtifacts(metadata, sql) {
assertMysql57Metadata(metadata);
if (!VERSION_PATTERN.test(metadata.applicationVersion ?? '')) {
throw new Error(`应用版本格式无效:${metadata.applicationVersion || '(空)'}`);
}
const normalizedSql = normalizeSchemaSql(sql);
if (!normalizedSql.trim()) {
throw new Error('真实 Schema SQL 不能为空');
}
const schemaSha256 = sha256(normalizedSql);
const manifest = buildManifest({
...metadata,
status: 'captured',
captured: true,
schemaSha256,
});
return Object.freeze({
status: 'captured',
schemaSha256,
files: Object.freeze({
'manifest.yaml': manifest,
'schema.sql': normalizedSql,
'checksum.sha256': `${schemaSha256} schema.sql\n`,
}),
});
}
export function buildNotApplicableArtifacts(metadata) {
if (!VERSION_PATTERN.test(metadata.applicationVersion ?? '')) {
throw new Error(`应用版本格式无效:${metadata.applicationVersion || '(空)'}`);
}
const manifest = buildManifest({
...metadata,
mysqlClientVersion: 'not_enabled',
mysqldumpClientVersion: 'not_enabled',
serverVersion: 'not_enabled',
status: 'not_applicable',
reason: 'mysql_disabled',
captured: false,
});
return Object.freeze({
status: 'not_applicable',
files: Object.freeze({ 'manifest.yaml': manifest }),
});
}
function compareExistingArtifacts(targetDirectory, artifacts) {
const actualFiles = readdirSync(targetDirectory).sort();
const expectedFiles = Object.keys(artifacts.files).sort();
if (
actualFiles.length !== expectedFiles.length ||
actualFiles.some((file, index) => file !== expectedFiles[index])
) {
return false;
}
return expectedFiles.every(
(file) => readFileSync(path.join(targetDirectory, file), 'utf8') === artifacts.files[file],
);
}
/**
* 先在目标父目录写入临时目录,再原子改名。这样异常不会留下半份基线;
* 已发布版本目录只允许逐字节相同的幂等重跑,任何差异都必须人工留痕修正。
*/
export function persistBaselineArtifacts(targetDirectory, artifacts) {
if (existsSync(targetDirectory)) {
if (compareExistingArtifacts(targetDirectory, artifacts)) {
return { reused: true };
}
throw new Error(`目标版本基线已存在且内容不同,禁止覆盖:${targetDirectory}`);
}
const parentDirectory = path.dirname(targetDirectory);
mkdirSync(parentDirectory, { recursive: true });
const temporaryDirectory = path.join(
parentDirectory,
`.${path.basename(targetDirectory)}.tmp-${process.pid}-${Date.now()}`,
);
mkdirSync(temporaryDirectory);
try {
for (const [file, content] of Object.entries(artifacts.files)) {
writeFileSync(path.join(temporaryDirectory, file), content, 'utf8');
}
renameSync(temporaryDirectory, targetDirectory);
} catch (error) {
rmSync(temporaryDirectory, { recursive: true, force: true });
throw error;
}
return { reused: false };
}
function parseManifest(content) {
try {
return JSON.parse(content);
} catch {
throw new Error('manifest.yaml 不是有效的结构化 YAML/JSON 清单');
}
}
function assertExactFileSet(targetDirectory, expectedFiles) {
const actualFiles = readdirSync(targetDirectory).sort();
const sortedExpected = [...expectedFiles].sort();
if (
actualFiles.length !== sortedExpected.length ||
actualFiles.some((file, index) => file !== sortedExpected[index])
) {
throw new Error(
`Schema 基线文件集合无效,要求 ${sortedExpected.join(', ')},实际 ${actualFiles.join(', ')}`,
);
}
}
export function verifyBaselineDirectory(targetDirectory, expectedRelease, expectedCommit) {
if (!VERSION_PATTERN.test(expectedRelease ?? '')) {
throw new Error(`待验证版本格式无效:${expectedRelease || '(空)'}`);
}
if (!existsSync(targetDirectory)) {
throw new Error(`当前已发布版本缺少 Schema 基线:${targetDirectory}`);
}
const manifest = parseManifest(
readFileSync(path.join(targetDirectory, 'manifest.yaml'), 'utf8'),
);
const status = manifest.status;
const applicationVersion = manifest.application_version;
const generatedAt = Date.parse(manifest.generated_at ?? '');
if (
manifest.format_version !== BASELINE_FORMAT_VERSION ||
manifest.generator !== `schema-baseline/${TOOL_VERSION}` ||
!Number.isFinite(generatedAt) ||
!/^[0-9a-f]{40}$/.test(manifest.git_commit ?? '')
) {
throw new Error('Schema 清单格式、生成器、时间或 Git 提交无效');
}
requireExactValue(applicationVersion, expectedRelease, 'Schema 基线版本与发布版本不一致');
if (expectedCommit !== undefined) {
requireExactValue(
manifest.git_commit,
expectedCommit,
'Schema 基线提交与发布标签不一致',
);
}
requireExactValue(
manifest.source_environment,
'development',
'Schema 基线来源环境无效',
);
requireExactValue(
manifest.database_name,
DEVELOPMENT_DATABASE,
'Schema 基线数据库名无效',
);
requireExactValue(manifest.charset, REQUIRED_CHARSET, 'Schema 字符集无效');
requireExactValue(
manifest.collation,
REQUIRED_COLLATION,
'Schema 排序规则无效',
);
if (status === 'not_applicable') {
assertExactFileSet(targetDirectory, NOT_APPLICABLE_FILES);
const reason = manifest.reason;
requireExactValue(reason, 'mysql_disabled', 'Schema 不适用原因无效');
if (
manifest.mysql_client_version !== 'not_enabled' ||
manifest.mysqldump_client_version !== 'not_enabled' ||
manifest.mysql_server_version !== 'not_enabled' ||
manifest.schema_sha256 !== 'not_applicable' ||
Object.keys(manifest.objects ?? {}).sort().join(',') !== [...OBJECT_KEYS].sort().join(',') ||
OBJECT_KEYS.some((key) => manifest.objects[key] !== false)
) {
throw new Error('Schema 不适用清单必须证明 MySQL 未启用且所有对象均未捕获');
}
return { status, applicationVersion, reason };
}
if (status !== 'captured') {
throw new Error(`Schema 基线状态无效:${status}`);
}
assertExactFileSet(targetDirectory, CAPTURED_FILES);
assertMysql57Metadata({
mysqlClientVersion: manifest.mysql_client_version,
mysqldumpClientVersion: manifest.mysqldump_client_version,
serverVersion: manifest.mysql_server_version,
databaseCharset: manifest.charset,
databaseCollation: manifest.collation,
});
if (Object.keys(manifest.objects ?? {}).sort().join(',') !== [...OBJECT_KEYS].sort().join(',')) {
throw new Error('Schema 对象范围字段无效');
}
for (const objectName of OBJECT_KEYS) {
requireExactValue(manifest.objects?.[objectName], true, `Schema 对象范围缺少 ${objectName}`);
}
const sql = readFileSync(path.join(targetDirectory, 'schema.sql'), 'utf8');
if (!sql.trim()) {
throw new Error('真实 Schema SQL 不能为空');
}
assertSchemaHasNoSensitiveOrDataStatements(sql);
if (/^(\) ENGINE=[^\n;]*?) AUTO_INCREMENT=\d+(?= )/m.test(sql)) {
throw new Error('Schema SQL 仍包含当前 AUTO_INCREMENT 值');
}
const schemaSha256 = sha256(sql);
const manifestChecksum = manifest.schema_sha256;
const checksumFile = readFileSync(path.join(targetDirectory, 'checksum.sha256'), 'utf8');
if (manifestChecksum !== schemaSha256 || checksumFile !== `${schemaSha256} schema.sql\n`) {
throw new Error('Schema SQL、manifest 和 checksum 校验值不一致');
}
return { status, applicationVersion, schemaSha256 };
}
export function parseEnvironmentFile(content) {
const config = {};
for (const rawLine of String(content).replace(/\r\n?/g, '\n').split('\n')) {
const line = rawLine.trim();
if (!line || line.startsWith('#')) continue;
const separator = line.indexOf('=');
if (separator <= 0) {
throw new Error('开发环境配置包含无效行');
}
const key = line.slice(0, separator).trim();
const value = line.slice(separator + 1).trim();
if (!/^[A-Z][A-Z0-9_]*$/.test(key)) {
throw new Error(`开发环境配置键无效:${key}`);
}
config[key] = value;
}
return config;
}
function extractClientVersion(output) {
const match = String(output).match(/\b(?:Distrib\s+)?(5\.7\.\d+(?:[-+][^\s,]+)?)/);
return match?.[1] ?? String(output).trim();
}
/**
* 真实执行器可注入是为了让测试证明“关闭时零数据库调用”和命令边界;默认执行器
* 仍使用 execFileSync 参数数组。密码仅放入子进程环境 MYSQL_PWD,不会进入 argv。
*/
export function runBaselineGeneration(options) {
if ((options.commandArguments ?? []).length > 0) {
throw new Error('Schema 基线命令不接受命令参数,不能覆盖环境、数据库或 env 路径');
}
const config = assertSafeDevelopmentConfiguration(
parseEnvironmentFile(readFileSync(options.envFile, 'utf8')),
);
const targetDirectory = path.join(
options.repositoryRoot,
'database',
'schema-baselines',
options.applicationVersion,
);
if (existsSync(targetDirectory)) {
return verifyBaselineDirectory(
targetDirectory,
options.applicationVersion,
options.gitCommit,
);
}
const commonMetadata = {
applicationVersion: options.applicationVersion,
gitCommit: options.gitCommit,
generatedAt: options.generatedAt ?? new Date().toISOString(),
};
if (!config.MYSQL_ENABLED) {
const artifacts = buildNotApplicableArtifacts(commonMetadata);
persistBaselineArtifacts(targetDirectory, artifacts);
return verifyBaselineDirectory(targetDirectory, options.applicationVersion);
}
const executeFile = options.executeFile ?? execFileSync;
const childEnvironment = { ...process.env, MYSQL_PWD: config.MYSQL_PASSWORD ?? '' };
const executionOptions = {
cwd: options.repositoryRoot,
encoding: 'utf8',
stdio: ['ignore', 'pipe', 'pipe'],
env: childEnvironment,
};
const mysqlClientVersion = extractClientVersion(
executeFile('mysql', ['--version'], executionOptions),
);
const mysqldumpClientVersion = extractClientVersion(
executeFile('mysqldump', ['--version'], executionOptions),
);
assertMysql57Metadata({
mysqlClientVersion,
mysqldumpClientVersion,
serverVersion: '5.7.0-pending-server-check',
databaseCharset: REQUIRED_CHARSET,
databaseCollation: REQUIRED_COLLATION,
});
const serverMetadata = String(
executeFile('mysql', buildMysqlMetadataArguments(config), executionOptions),
)
.trim()
.split('\t');
if (serverMetadata.length !== 3) {
throw new Error('无法从固定开发库读取 MySQL 版本、字符集和排序规则');
}
const metadata = {
...commonMetadata,
mysqlClientVersion,
mysqldumpClientVersion,
serverVersion: serverMetadata[0],
databaseCharset: serverMetadata[1],
databaseCollation: serverMetadata[2],
};
assertMysql57Metadata(metadata);
const rawSql = executeFile('mysqldump', buildMysqldumpArguments(config), executionOptions);
const artifacts = buildCapturedArtifacts(metadata, rawSql);
persistBaselineArtifacts(targetDirectory, artifacts);
return verifyBaselineDirectory(targetDirectory, options.applicationVersion);
}
function runGit(repositoryRoot, args) {
return execFileSync('git', args, {
cwd: repositoryRoot,
encoding: 'utf8',
stdio: ['ignore', 'pipe', 'pipe'],
}).trim();
}
export function getCurrentReleasedVersion(repositoryRoot) {
const applicationVersion = runGit(repositoryRoot, [
'describe',
'--tags',
'--abbrev=0',
'--match',
'v[0-9]*',
]);
if (!VERSION_PATTERN.test(applicationVersion)) {
throw new Error(`最近发布标签格式无效:${applicationVersion}`);
}
return {
applicationVersion,
gitCommit: runGit(repositoryRoot, ['rev-list', '-n', '1', applicationVersion]),
};
}
/**
* not_applicable 清单只记录生成当时 MySQL 未启用,不能永久替代真实结构基线。
* 每次校验都重新读取固定开发环境配置;一旦开发库启用,旧清单立即失效,强制
* 下一版本开发开始前先从开发库生成 captured 基线。
*/
export function assertNotApplicableMatchesDevelopmentConfiguration(repositoryRoot, result) {
if (result.status !== 'not_applicable') return result;
const config = assertSafeDevelopmentConfiguration(
parseEnvironmentFile(readFileSync(resolveFixedDevelopmentEnv(repositoryRoot), 'utf8')),
);
if (config.MYSQL_ENABLED) {
throw new Error('当前开发环境已启用 MySQL,不能继续使用 not_applicable Schema 基线');
}
return result;
}
export function assertCurrentReleasedBaseline(repositoryRoot) {
const { applicationVersion, gitCommit } = getCurrentReleasedVersion(repositoryRoot);
const result = verifyBaselineDirectory(
path.join(repositoryRoot, 'database', 'schema-baselines', applicationVersion),
applicationVersion,
gitCommit,
);
return assertNotApplicableMatchesDevelopmentConfiguration(repositoryRoot, result);
}
function runGitLines(repositoryRoot, args) {
const output = runGit(repositoryRoot, args);
return output ? output.split('\n').filter(Boolean) : [];
}
/**
* 开始下一版本前使用严格门禁:本地校验只证明内容正确,不能证明它已经进入
* 可协作历史。这里进一步要求基线已跟踪、工作区无相关改动、当前 HEAD 已推送,
* 且 origin 上的发布标签仍指向清单记录的提交。
*/
export function assertCurrentReleasedBaselinePublished(repositoryRoot) {
const release = getCurrentReleasedVersion(repositoryRoot);
const relativeDirectory = path.posix.join(
'database',
'schema-baselines',
release.applicationVersion,
);
const result = verifyBaselineDirectory(
path.join(repositoryRoot, relativeDirectory),
release.applicationVersion,
release.gitCommit,
);
assertNotApplicableMatchesDevelopmentConfiguration(repositoryRoot, result);
const trackedFiles = new Set(
runGitLines(repositoryRoot, ['ls-files', '--', relativeDirectory]),
);
const expectedFiles =
result.status === 'captured' ? CAPTURED_FILES : NOT_APPLICABLE_FILES;
for (const file of expectedFiles) {
const relativeFile = path.posix.join(relativeDirectory, file);
if (!trackedFiles.has(relativeFile)) {
throw new Error(`Schema 基线尚未提交到 Git:${relativeFile}`);
}
}
const localChanges = runGitLines(repositoryRoot, [
'status',
'--porcelain',
'--',
relativeDirectory,
]);
if (localChanges.length > 0) {
throw new Error(`Schema 基线存在未提交改动:${localChanges.join(', ')}`);
}
const branch = runGit(repositoryRoot, ['branch', '--show-current']);
if (!branch) {
throw new Error('Schema 发布门禁要求当前位于可推送分支');
}
const localHead = runGit(repositoryRoot, ['rev-parse', 'HEAD']);
assertRemoteBranchMatches(repositoryRoot, branch, runGit, localHead);
const remoteTag = runGit(repositoryRoot, [
'ls-remote',
'--tags',
'origin',
`refs/tags/${release.applicationVersion}^{}`,
]);
const remoteTagCommit = remoteTag.split(/\s+/)[0];
requireExactValue(remoteTagCommit, release.gitCommit, '远程发布标签与基线提交不一致');
return result;
}
export function assertRemoteBranchMatches(repositoryRoot, branch, gitRunner = runGit, localHead) {
const expectedHead = localHead ?? gitRunner(repositoryRoot, ['rev-parse', 'HEAD']);
const remoteOutput = gitRunner(repositoryRoot, ['ls-remote', 'origin', `refs/heads/${branch}`]);
const remoteHead = remoteOutput.split(/\s+/)[0];
requireExactValue(remoteHead, expectedHead, '当前分支尚未完整推送到 origin');
return true;
}
function resolveFixedDevelopmentEnv(repositoryRoot) {
const realDevelopmentEnv = path.join(repositoryRoot, 'deploy', 'env', 'development', 'api.env');
if (existsSync(realDevelopmentEnv)) return realDevelopmentEnv;
return path.join(repositoryRoot, 'deploy', 'env', 'development', 'api.env.example');
}
function runCommandLine() {
const [command, ...commandArguments] = process.argv.slice(2);
if (!['generate', 'verify'].includes(command) || commandArguments.length > 0) {
throw new Error('用法:node tools/database/schema-baseline.mjs <generate|verify>(不接受额外参数)');
}
const repositoryRoot = process.cwd();
const release = getCurrentReleasedVersion(repositoryRoot);
const result =
command === 'generate'
? runBaselineGeneration({
repositoryRoot,
envFile: resolveFixedDevelopmentEnv(repositoryRoot),
...release,
commandArguments,
})
: assertCurrentReleasedBaseline(repositoryRoot);
process.stdout.write(
`Schema 基线验证通过:${release.applicationVersion} (${result.status})\n`,
);
}
if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
runCommandLine();
}
+477
View File
@@ -0,0 +1,477 @@
import assert from 'node:assert/strict';
import { createHash } from 'node:crypto';
import { mkdirSync, mkdtempSync, readFileSync, writeFileSync } from 'node:fs';
import { tmpdir } from 'node:os';
import path from 'node:path';
import test from 'node:test';
import {
assertMysql57Metadata,
assertNotApplicableMatchesDevelopmentConfiguration,
assertCurrentReleasedBaselinePublished,
assertSafeDevelopmentConfiguration,
buildCapturedArtifacts,
buildMysqldumpArguments,
buildNotApplicableArtifacts,
normalizeSchemaSql,
persistBaselineArtifacts,
runBaselineGeneration,
assertRemoteBranchMatches,
verifyBaselineDirectory,
} from './schema-baseline.mjs';
const validConfig = Object.freeze({
APP_ENV: 'development',
MYSQL_ENABLED: 'true',
MYSQL_HOST: '127.0.0.1',
MYSQL_PORT: '3306',
MYSQL_DATABASE: 'a_share_analysis_dev',
MYSQL_USERNAME: 'schema_reader',
MYSQL_PASSWORD: 'never-place-this-in-arguments',
MYSQL_CHARSET: 'utf8mb4',
MYSQL_COLLATION: 'utf8mb4_general_ci',
});
const validMetadata = Object.freeze({
applicationVersion: 'v0.0.5',
gitCommit: '0a69aa1f6f5cc75d72f21c43d96f5ff648e2ec93',
mysqlClientVersion: '5.7.44',
mysqldumpClientVersion: '5.7.44',
serverVersion: '5.7.44-log',
databaseCharset: 'utf8mb4',
databaseCollation: 'utf8mb4_general_ci',
generatedAt: '2026-08-13T03:00:00.000Z',
});
function makeTemporaryDirectory() {
return mkdtempSync(path.join(tmpdir(), 'a-share-schema-baseline-'));
}
function replaceCapturedSql(target, sql) {
const checksum = createHash('sha256').update(sql).digest('hex');
const manifestPath = path.join(target, 'manifest.yaml');
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
manifest.schema_sha256 = checksum;
writeFileSync(path.join(target, 'schema.sql'), sql);
writeFileSync(path.join(target, 'checksum.sha256'), `${checksum} schema.sql\n`);
writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
}
test('拒绝任何非开发环境和非固定开发库配置', () => {
assert.throws(
() => assertSafeDevelopmentConfiguration({ ...validConfig, APP_ENV: 'production' }),
/只允许 development/,
);
assert.throws(
() =>
assertSafeDevelopmentConfiguration({
...validConfig,
MYSQL_DATABASE: 'a_share_analysis',
}),
/a_share_analysis_dev/,
);
assert.throws(
() =>
assertSafeDevelopmentConfiguration({
...validConfig,
MYSQL_HOST: 'forbidden-remote.example.invalid',
}),
/开发机回环地址/,
);
});
test('拒绝错误字符集、排序规则和不完整的启用配置', () => {
assert.throws(
() => assertSafeDevelopmentConfiguration({ ...validConfig, MYSQL_CHARSET: 'utf8' }),
/utf8mb4/,
);
assert.throws(
() =>
assertSafeDevelopmentConfiguration({
...validConfig,
MYSQL_COLLATION: 'utf8mb4_0900_ai_ci',
}),
/utf8mb4_general_ci/,
);
assert.throws(
() => assertSafeDevelopmentConfiguration({ ...validConfig, MYSQL_USERNAME: '' }),
/MYSQL_USERNAME/,
);
assert.throws(
() => assertSafeDevelopmentConfiguration({ ...validConfig, MYSQL_PASSWORD: '' }),
/MYSQL_PASSWORD/,
);
});
test('只接受 MySQL 5.7 客户端、服务端和固定数据库字符规则', () => {
assert.doesNotThrow(() => assertMysql57Metadata(validMetadata));
assert.throws(
() => assertMysql57Metadata({ ...validMetadata, serverVersion: '8.0.39' }),
/服务端必须为 5\.7/,
);
assert.throws(
() => assertMysql57Metadata({ ...validMetadata, mysqlClientVersion: '8.0.39' }),
/mysql 客户端必须为 5\.7/,
);
assert.throws(
() => assertMysql57Metadata({ ...validMetadata, databaseCollation: 'utf8mb4_bin' }),
/utf8mb4_general_ci/,
);
});
test('mysqldump 只导出完整结构且密码不进入命令参数', () => {
const args = buildMysqldumpArguments(validConfig);
for (const required of ['--no-data', '--routines', '--triggers', '--events']) {
assert.ok(args.includes(required), `缺少强制导出参数:${required}`);
}
assert.equal(args.at(-1), 'a_share_analysis_dev');
assert.equal(args.join(' ').includes(validConfig.MYSQL_PASSWORD), false);
assert.equal(args.some((argument) => argument.startsWith('--password')), false);
});
test('规范化移除环境噪声和账号绑定但保留全部业务对象', () => {
const fixtureDirectory = path.join(import.meta.dirname, 'fixtures');
const input = readFileSync(path.join(fixtureDirectory, 'mysql57-schema-input.sql'), 'utf8');
const expected = readFileSync(
path.join(fixtureDirectory, 'mysql57-schema-expected.sql'),
'utf8',
);
const actual = normalizeSchemaSql(input);
assert.equal(actual, expected);
assert.match(actual, /NOT NULL AUTO_INCREMENT/);
assert.doesNotMatch(actual, /AUTO_INCREMENT=128/);
assert.doesNotMatch(actual, /DEFINER=`/);
for (const objectName of [
'CREATE TABLE',
'VIEW `active_market_snapshot`',
'TRIGGER `market_snapshot_before_insert`',
'PROCEDURE `refresh_market_snapshot`',
'EVENT `purge_market_snapshot`',
]) {
assert.ok(actual.includes(objectName), `规范化误删对象:${objectName}`);
}
});
test('规范化不改写例程字符串中的业务文本', () => {
const sql = [
'CREATE PROCEDURE `describe_schema`()',
"BEGIN SELECT 'DEFINER=`business`@`text` AUTO_INCREMENT=128' AS description; END;",
'',
].join('\n');
assert.equal(normalizeSchemaSql(sql), sql);
});
test('数据扫描拒绝同行顶层写入但保留例程中的合法 DML', () => {
assert.throws(
() => normalizeSchemaSql('CREATE TABLE `sample` (`id` int); INSERT INTO `sample` VALUES (1);\n'),
/INSERT INTO/,
);
const routineSql = [
'DELIMITER ;;',
'CREATE PROCEDURE `seed_fixture`()',
'BEGIN',
'INSERT INTO `sample` VALUES (1);',
'END ;;',
'DELIMITER ;',
'',
].join('\n');
assert.equal(normalizeSchemaSql(routineSql), routineSql);
for (const prefixedSql of [
'/* comment */\nINSERT INTO `sample` VALUES (1);\n',
'/*!40101 SET @x=1 */ INSERT INTO `sample` VALUES (1);\n',
'/*!40101 INSERT INTO `sample` VALUES (1) */;\n',
'/*!40101 REPLACE INTO `sample` VALUES (1) */;\n',
'CREATE TABLE `sample` (`id` int); -- comment\nREPLACE INTO `sample` VALUES (1);\n',
]) {
assert.throws(() => normalizeSchemaSql(prefixedSql), /INSERT INTO|REPLACE INTO/);
}
});
test('数据扫描拒绝所有顶层数据修改和装载语句', () => {
for (const statement of [
'UPDATE `sample` SET `id` = 2',
'DELETE FROM `sample`',
'TRUNCATE TABLE `sample`',
"LOAD DATA LOCAL INFILE '/tmp/sample.csv' INTO TABLE `sample`",
"LOAD XML LOCAL INFILE '/tmp/sample.xml' INTO TABLE `sample`",
]) {
assert.throws(() => normalizeSchemaSql(`${statement};\n`), /禁止的数据操作/);
}
});
test('安全扫描拒绝导出噪声、疑似凭据、连接串和生产主机', () => {
for (const unsafeSql of [
'-- API_TOKEN=supersecret\nCREATE TABLE `sample` (`id` int);\n',
'-- CLIENT_SECRET: supersecret\nCREATE TABLE `sample` (`id` int);\n',
'-- mysql://schema_reader:secret@127.0.0.1/a_share_analysis_dev\nCREATE TABLE `sample` (`id` int);\n',
'-- production host: prod-db.internal\nCREATE TABLE `sample` (`id` int);\n',
]) {
assert.throws(() => normalizeSchemaSql(unsafeSql), /Schema SQL 包含禁止内容/);
}
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(
target,
buildCapturedArtifacts(validMetadata, 'CREATE TABLE `sample` (`id` int);\n'),
);
replaceCapturedSql(
target,
'-- MySQL dump 10.13 Distrib 5.7.44\nCREATE TABLE `sample` (`id` int);\n',
);
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /MySQL dump/);
});
test('真实基线的清单、校验文件和 SQL 必须三方一致', () => {
const sql = 'CREATE TABLE `sample` (`id` bigint NOT NULL AUTO_INCREMENT);\n';
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
const artifacts = buildCapturedArtifacts(validMetadata, sql);
persistBaselineArtifacts(target, artifacts);
const result = verifyBaselineDirectory(target, 'v0.0.5');
assert.equal(result.status, 'captured');
assert.equal(result.applicationVersion, 'v0.0.5');
assert.equal(result.schemaSha256, artifacts.schemaSha256);
assert.equal(readFileSync(path.join(target, 'checksum.sha256'), 'utf8'), `${artifacts.schemaSha256} schema.sql\n`);
});
test('拒绝静默覆盖已存在且内容不同的版本基线', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
const artifacts = buildCapturedArtifacts(validMetadata, 'CREATE TABLE `sample` (`id` int);\n');
persistBaselineArtifacts(target, artifacts);
assert.doesNotThrow(() => persistBaselineArtifacts(target, artifacts));
assert.throws(
() =>
persistBaselineArtifacts(
target,
buildCapturedArtifacts(validMetadata, 'CREATE TABLE `changed` (`id` int);\n'),
),
/禁止覆盖/,
);
});
test('MySQL 未启用时只生成可验证不适用清单', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
const artifacts = buildNotApplicableArtifacts(validMetadata);
persistBaselineArtifacts(target, artifacts);
const result = verifyBaselineDirectory(target, 'v0.0.5');
assert.equal(result.status, 'not_applicable');
assert.equal(result.reason, 'mysql_disabled');
assert.throws(() => readFileSync(path.join(target, 'schema.sql')), /ENOENT/);
assert.throws(() => readFileSync(path.join(target, 'checksum.sha256')), /ENOENT/);
});
test('未启用入口不调用数据库且拒绝额外命令参数', () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
envFile,
'APP_ENV=development\nMYSQL_ENABLED=false\nMYSQL_DATABASE=a_share_analysis_dev\nMYSQL_CHARSET=utf8mb4\nMYSQL_COLLATION=utf8mb4_general_ci\n',
);
let executionCount = 0;
const result = runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
gitCommit: validMetadata.gitCommit,
generatedAt: validMetadata.generatedAt,
executeFile() {
executionCount += 1;
throw new Error('未启用路径不应执行数据库命令');
},
});
assert.equal(result.status, 'not_applicable');
assert.equal(executionCount, 0);
assert.throws(
() => runBaselineGeneration({ ...result, commandArguments: ['--env', 'production.env'] }),
/不接受命令参数/,
);
});
test('启用入口分别校验 mysql 与 mysqldump 客户端版本', () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
envFile,
Object.entries(validConfig)
.map(([key, value]) => `${key}=${value}`)
.join('\n'),
);
assert.throws(
() =>
runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
gitCommit: validMetadata.gitCommit,
generatedAt: validMetadata.generatedAt,
executeFile(command, args) {
if (args[0] === '--version') {
return command === 'mysql'
? 'mysql Ver 8.0.39 for macos'
: 'mysqldump Ver 10.13 Distrib 5.7.44, for macos';
}
if (command === 'mysql') {
return '5.7.44-log\tutf8mb4\tutf8mb4_general_ci\n';
}
return 'CREATE TABLE `sample` (`id` int);\n';
},
}),
/mysql 客户端必须为 5\.7/,
);
});
test('幂等重跑仍核对清单提交与发布标签提交', () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
envFile,
'APP_ENV=development\nMYSQL_ENABLED=false\nMYSQL_DATABASE=a_share_analysis_dev\nMYSQL_CHARSET=utf8mb4\nMYSQL_COLLATION=utf8mb4_general_ci\n',
);
const target = path.join(root, 'database', 'schema-baselines', 'v0.0.5');
persistBaselineArtifacts(target, buildNotApplicableArtifacts(validMetadata));
assert.throws(
() =>
runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
gitCommit: 'ffffffffffffffffffffffffffffffffffffffff',
}),
/提交与发布标签不一致/,
);
});
test('校验能发现 SQL 被修改且生成阶段拒绝空基线', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(
target,
buildCapturedArtifacts(validMetadata, 'CREATE TABLE `sample` (`id` int);\n'),
);
writeFileSync(path.join(target, 'schema.sql'), 'CREATE TABLE `tampered` (`id` int);\n');
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /校验值不一致/);
assert.throws(
() => buildCapturedArtifacts({ ...validMetadata, applicationVersion: 'v0.0.4' }, ''),
/不能为空/,
);
});
test('基线清单中的提交必须等于发布标签指向的提交', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(target, buildNotApplicableArtifacts(validMetadata));
assert.throws(
() => verifyBaselineDirectory(target, 'v0.0.5', 'ffffffffffffffffffffffffffffffffffffffff'),
/提交与发布标签不一致/,
);
});
test('校验拒绝篡改成错误 MySQL 版本或伪造对象范围的真实清单', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(
target,
buildCapturedArtifacts(validMetadata, 'CREATE TABLE `sample` (`id` int);\n'),
);
const manifestPath = path.join(target, 'manifest.yaml');
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
manifest.mysql_server_version = '8.0.39';
writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /服务端必须为 5\.7/);
manifest.mysql_server_version = '5.7.44-log';
manifest.objects.events = false;
writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /events/);
});
test('不适用清单必须明确记录 MySQL 未启用且所有对象未捕获', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(target, buildNotApplicableArtifacts(validMetadata));
const manifestPath = path.join(target, 'manifest.yaml');
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
manifest.mysql_server_version = '5.7.44';
manifest.objects.tables = true;
writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /不适用清单/);
});
test('不适用清单拒绝未知对象键和伪造的格式元数据', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
persistBaselineArtifacts(target, buildNotApplicableArtifacts(validMetadata));
const manifestPath = path.join(target, 'manifest.yaml');
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
manifest.format_version = 999;
manifest.generator = 'unknown';
manifest.schema_sha256 = 'forged';
manifest.objects = { a: false, b: false, c: false, d: false, e: false };
writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
assert.throws(() => verifyBaselineDirectory(target, 'v0.0.5'), /清单格式/);
});
test('不适用基线只在当前开发环境仍关闭 MySQL 时有效', () => {
const root = makeTemporaryDirectory();
const envDirectory = path.join(root, 'deploy', 'env', 'development');
const envFile = path.join(envDirectory, 'api.env.example');
const result = { status: 'not_applicable' };
mkdirSync(envDirectory, { recursive: true });
writeFileSync(
envFile,
'APP_ENV=development\nMYSQL_ENABLED=false\nMYSQL_DATABASE=a_share_analysis_dev\nMYSQL_CHARSET=utf8mb4\nMYSQL_COLLATION=utf8mb4_general_ci\n',
);
assert.doesNotThrow(() =>
assertNotApplicableMatchesDevelopmentConfiguration(root, result),
);
writeFileSync(
envFile,
Object.entries(validConfig)
.map(([key, value]) => `${key}=${value}`)
.join('\n'),
);
assert.throws(
() => assertNotApplicableMatchesDevelopmentConfiguration(root, result),
/已启用 MySQL.*not_applicable/,
);
});
test('严格发布门禁通过已提交且远程同步的当前基线', () => {
assert.doesNotThrow(() => assertCurrentReleasedBaselinePublished(process.cwd()));
});
test('远程分支校验实时读取 origin 而不是陈旧 tracking ref', () => {
assert.doesNotThrow(() =>
assertRemoteBranchMatches('/repo', 'main', (_root, args) => {
assert.deepEqual(args, ['ls-remote', 'origin', 'refs/heads/main']);
return 'abc123\trefs/heads/main';
}, 'abc123'),
);
assert.throws(
() =>
assertRemoteBranchMatches('/repo', 'main', () => 'def456\trefs/heads/main', 'abc123'),
/尚未完整推送到 origin/,
);
});
@@ -0,0 +1,102 @@
import assert from 'node:assert/strict';
import { readFile } from 'node:fs/promises';
import test from 'node:test';
const repoRoot = new URL('../../', import.meta.url);
const processNames = ['api', 'scheduler', 'worker', 'web'];
const sensitiveKeyPattern = /(PASSWORD|API_KEY|TOKEN|SECRET|RABBITMQ_URL)$/;
async function readRepoFile(relativePath) {
return readFile(new URL(relativePath, repoRoot), 'utf8');
}
function parseEnvTemplate(content) {
const entries = new Map();
for (const line of content.split(/\r?\n/)) {
const normalizedLine = line.trim();
if (!normalizedLine || normalizedLine.startsWith('#')) continue;
const separator = normalizedLine.indexOf('=');
assert.ok(separator > 0, `无效环境变量行:${line}`);
entries.set(normalizedLine.slice(0, separator), normalizedLine.slice(separator + 1));
}
return entries;
}
test('开发和生产环境都提供四类进程模板且键集合一致', async () => {
for (const processName of processNames) {
const development = parseEnvTemplate(
await readRepoFile(`deploy/env/development/${processName}.env.example`),
);
const production = parseEnvTemplate(
await readRepoFile(`deploy/env/production/${processName}.env.example`),
);
assert.deepEqual([...development.keys()].sort(), [...production.keys()].sort());
}
});
test('模板不包含敏感值且 Web 只暴露 VITE 变量', async () => {
for (const environment of ['development', 'production']) {
for (const processName of processNames) {
const entries = parseEnvTemplate(
await readRepoFile(`deploy/env/${environment}/${processName}.env.example`),
);
for (const [key, value] of entries) {
if (sensitiveKeyPattern.test(key)) assert.equal(value, '', `${key} 必须保持空值`);
if (processName === 'web') assert.ok(key.startsWith('VITE_'), `Web 禁止暴露 ${key}`);
}
}
}
});
test('生产模板禁止模拟数据并保持 MySQL 5.7 配置契约', async () => {
const worker = parseEnvTemplate(await readRepoFile('deploy/env/production/worker.env.example'));
assert.equal(worker.get('APP_ENV'), 'production');
assert.equal(worker.get('MARKET_DATA_MODE'), 'live');
assert.equal(worker.get('MYSQL_ENABLED'), 'false');
assert.equal(worker.get('MYSQL_CHARSET'), 'utf8mb4');
assert.equal(worker.get('MYSQL_COLLATION'), 'utf8mb4_general_ci');
assert.equal(worker.get('RABBITMQ_ENABLED'), 'false');
});
test('本地 Compose 仅启动 Redis 并提供健康检查', async () => {
const compose = await readRepoFile('deploy/compose/development.yml');
assert.match(compose, /services:\s*\n\s+redis:/);
assert.match(compose, /healthcheck:/);
assert.match(compose, /127\.0\.0\.1:/);
assert.doesNotMatch(compose, /^\s{2}(mysql|rabbitmq|api|worker|scheduler|web):/m);
});
test('生产源码部署使用独立 EnvironmentFile 并提供 Nginx 代理', async () => {
for (const processName of ['api', 'scheduler', 'worker']) {
const unit = await readRepoFile(`deploy/systemd/a-share-${processName}.service.example`);
assert.match(unit, new RegExp(`EnvironmentFile=/etc/a-share-analysis/${processName}\\.env`));
assert.match(unit, /User=a-share/);
assert.match(unit, /WorkingDirectory=\/opt\/a-share-analysis\/current/);
}
const nginx = await readRepoFile('deploy/nginx/a-share-analysis.conf.example');
assert.match(nginx, /location \/api\//);
assert.match(nginx, /proxy_pass http:\/\/127\.0\.0\.1:3000/);
assert.match(nginx, /\/opt\/a-share-analysis\/current\/web\/dist/);
});
test('部署文档覆盖本地、Compose 生产和 Ubuntu 源码生产', async () => {
const local = await readRepoFile('docs/deployment/local-development.md');
const compose = await readRepoFile('docs/deployment/docker-compose-production.md');
const source = await readRepoFile('docs/deployment/ubuntu-source-production.md');
assert.match(local, /Redis/);
assert.match(compose, /Docker Compose/);
assert.match(source, /Ubuntu 22\.04 LTS/);
assert.match(source, /Ubuntu 24\.04 LTS/);
assert.match(source, /Node\.js 22 LTS/);
assert.match(source, /pnpm 10/);
assert.match(source, /不负责安装/);
});
+4
View File
@@ -34,6 +34,10 @@ function run(command, args) {
* 根目录 verify 脚本会继续串联前端和后端测试,而不需要改变本门禁入口。 * 根目录 verify 脚本会继续串联前端和后端测试,而不需要改变本门禁入口。
*/ */
run('npm', ['run', 'test:governance']); run('npm', ['run', 'test:governance']);
run('npm', ['run', 'test:mysql-baseline']);
run('npm', ['run', 'test:environment-baseline']);
run('npm', ['run', 'test:schema-baseline']);
run('npm', ['run', 'schema:verify']);
run('npx', ['gitnexus', 'analyze']); run('npx', ['gitnexus', 'analyze']);
const status = run('npx', ['gitnexus', 'status']); const status = run('npx', ['gitnexus', 'status']);
+34
View File
@@ -0,0 +1,34 @@
import assert from 'node:assert/strict';
import { readFile } from 'node:fs/promises';
import test from 'node:test';
const architecturePath = new URL('../../docs/architecture/system-architecture.md', import.meta.url);
const standardsPath = new URL('../../docs/governance/code-development-standards.md', import.meta.url);
test('系统架构固定 MySQL 5.7 字符集与排序规则', async () => {
const architecture = await readFile(architecturePath, 'utf8');
assert.match(architecture, /MySQL 5\.7/);
assert.match(architecture, /utf8mb4/);
assert.match(architecture, /utf8mb4_general_ci/);
});
test('开发规范覆盖 MySQL 5.7 全链路兼容性要求', async () => {
const standards = await readFile(standardsPath, 'utf8');
for (const requiredText of [
'MySQL 5.7',
'utf8mb4',
'utf8mb4_general_ci',
'公用表表达式',
'窗口函数',
'函数索引',
'utf8mb4_0900_',
'不区分大小写',
'索引长度',
'迁移脚本',
'代码 Review',
]) {
assert.ok(standards.includes(requiredText), `开发规范缺少数据库基线:${requiredText}`);
}
});
+5
View File
@@ -2,6 +2,7 @@ import { execFileSync } from 'node:child_process';
import { existsSync, mkdirSync, writeFileSync } from 'node:fs'; import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
import path from 'node:path'; import path from 'node:path';
import { assertCurrentReleasedBaselinePublished } from '../database/schema-baseline.mjs';
import { getFeatureDirectory, validateFeatureId } from './feature-record.mjs'; import { getFeatureDirectory, validateFeatureId } from './feature-record.mjs';
const [featureId, slug] = process.argv.slice(2); const [featureId, slug] = process.argv.slice(2);
@@ -15,6 +16,10 @@ const featureDirectory = getFeatureDirectory(repositoryRoot, featureId, slug);
const gitnexusDirectory = path.join(featureDirectory, 'gitnexus'); const gitnexusDirectory = path.join(featureDirectory, 'gitnexus');
const beforeReport = path.join(gitnexusDirectory, 'before.md'); const beforeReport = path.join(gitnexusDirectory, 'before.md');
// Schema 基线必须在新版本的功能档案和 GitNexus 分析之前已经独立提交;
// 这里仅做只读验证,绝不在一般功能开发命令中连接数据库或静默生成历史产物。
assertCurrentReleasedBaselinePublished(repositoryRoot);
if (existsSync(beforeReport)) { if (existsSync(beforeReport)) {
throw new Error(`开发前报告已存在,为保护历史不会覆盖:${beforeReport}`); throw new Error(`开发前报告已存在,为保护历史不会覆盖:${beforeReport}`);
} }