Compare commits

7 Commits
66 changed files with 1514 additions and 13 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
+1 -1
View File
@@ -23,7 +23,7 @@
<!-- 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** (620 symbols, 651 relationships, 0 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.
+13
View File
@@ -2,6 +2,19 @@
本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。 本项目采用语义化版本。功能级变化请从 `docs/features/` 按功能编号追溯。
## 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
- 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。 - 将当前分支推送设为每次提交后的强制步骤,新标签采用精确推送。
+8
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)
+1 -1
View File
@@ -1 +1 @@
0.0.3 0.0.5
+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`。
- 本功能无页面变化,视觉验证不适用。
+31 -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,28 @@ 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 处理并阻断发布。
## 12. 测试要求
- 功能和缺陷修复遵循测试先行:先看到测试因缺少行为而失败,再实现最小代码。 - 功能和缺陷修复遵循测试先行:先看到测试因缺少行为而失败,再实现最小代码。
- 纯规则和指标计算使用单元测试,期望值必须手工推导。 - 纯规则和指标计算使用单元测试,期望值必须手工推导。
@@ -107,14 +132,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 出发,检查:
+5 -3
View File
@@ -23,14 +23,15 @@ released → superseded
5. 比较可选方案,记录设计与关键决策。 5. 比较可选方案,记录设计与关键决策。
6. 更新 API、事件和数据结构契约。 6. 更新 API、事件和数据结构契约。
7. 编写测试计划和实施计划。 7. 编写测试计划和实施计划。
8. 确保 Git 工作区基线可识别,执行: 8. 明确功能需要的环境变量、功能开关和部署影响;同步更新开发/生产模板,禁止只修改本机真实 env。
9. 确保 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`。 10. 运行 GitNexus 查询、上下文和影响分析,将结果写入 `gitnexus/impact-plan.md`。
10. 高风险或关键路径变化必须先向用户说明影响,再进入开发。 11. 高风险或关键路径变化必须先向用户说明影响,再进入开发。
开发前必须至少回答:修改什么、为什么修改、影响谁、如何验证、失败后如何回退。 开发前必须至少回答:修改什么、为什么修改、影响谁、如何验证、失败后如何回退。
@@ -79,6 +80,7 @@ npm run governance:finish -- FEAT-MO-001 market-overview
- 发布说明和回退方法可执行。 - 发布说明和回退方法可执行。
- 中文提交已关联功能编号。 - 中文提交已关联功能编号。
- 当前分支和本次新建标签已推送到 `origin`,功能档案保存远程核对结果。 - 当前分支和本次新建标签已推送到 `origin`,功能档案保存远程核对结果。
- 配置契约变化已同步开发/生产模板和适用的 Compose、systemd、Nginx及部署文档。
## 7. 提交流程 ## 7. 提交流程
+8
View File
@@ -15,6 +15,12 @@
- [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)
## GitNexus ## GitNexus
- [仓库基线](gitnexus/repository-baseline.md) - [仓库基线](gitnexus/repository-baseline.md)
@@ -28,5 +34,7 @@
- [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)
功能档案是需求、设计、代码、测试、版本和回退之间的唯一正式关联入口。 功能档案是需求、设计、代码、测试、版本和回退之间的唯一正式关联入口。
+2
View File
@@ -5,6 +5,8 @@
"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",
"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,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, /不负责安装/);
});
+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}`);
}
});