dsh-agent
b28ca49491
后端目录 - db/：mysql / hydrogen / heatmap 连接与氢能只读 SQL 守卫收拢到一处。 - middleware/：auth（JWT → 注入 user）与 read-only 归位。 - 相关测试随文件移动（middleware/read-only.test.ts、db/hydrogen-read-only.test.ts）。 import 改写由一次性 codemod 完成，未改变任何逻辑。 架构守护 - 新增 src/architecture.test.ts，断言 6 条分层铁律： server 不依赖 modules、前端不依赖 server、shared 为叶子层、 无 vendor 引用、model.ts 不依赖 react、@ts-nocheck 仅限已登记的原型快照。 豁免清单只减不增。 测试基建 - npm test 的 glob 同时匹配 .test.ts 与 .test.tsx（此前 .tsx 测试会被静默漏掉）。 文档 - 新增根 README.md：入口、快速开始、命令、目录、部署注意事项 （JWT_SECRET 必须注入且 >=32 字符，否则拒绝启动）。 - 新增 docs/ARCHITECTURE.md：依赖方向、6 条硬规则、业务域形状、 中间件顺序、新增模块步骤，以及"已知未尽事项"的诚实清单。 lint / test(134) / build 全绿。
6.0 KiB
6.0 KiB
架构与分层约定
本文是这个仓库的结构契约。6 条硬规则由 src/architecture.test.ts 断言，破坏即测试失败。
1. 分层与依赖方向
app/ 应用外壳（路由、导航注册）
↓
modules/ 前端业务域 —— 只依赖 shared/
↓
shared/ 叶子层：角色常量、跨端 DTO、纯工具（不得依赖 modules/ 或 server/）
server/ 后端 —— 只依赖 shared/，不得依赖 modules/
依赖只能向下。前端通过 HTTP 调用后端，不通过 import。
6 条硬规则
| # | 规则 | 违反后果 |
|---|---|---|
| 1 | server/** 不得 import modules/** |
服务端被前端类型/组件绑架，无法独立部署与测试 |
| 2 | modules/**、components/**、auth/**、app/** 不得 import server/** |
打包会拖入服务端代码与密钥 |
| 3 | shared/** 不得 import modules/** / server/** / components/** |
叶子层反向依赖会让依赖图成环 |
| 4 | 不得出现 vendor/ 引用 |
生产代码必须位于业务域目录，不能藏在"第三方/参考"目录里 |
| 5 | model.ts / model.tsx 不得 import react |
纯模型必须能在 Node 里直接单测，不依赖 DOM |
| 6 | @ts-nocheck 只允许出现在已登记的原型快照文件 |
类型门禁对最大文件失效 |
关于第 6 条的豁免清单
这三个文件是逐字节保留的 8113 验收原型（UI / CSS 冻结，改动需重新做桌面与移动端截图验收）：
modules/energy/hydrogen/board/EnergyBiBoardApp.tsx
modules/energy/hydrogen/station-daily/StationDailyApp.tsx
modules/energy/hydrogen/station-daily/StationDailyDetailView.tsx
豁免清单是只减不增的：新增 @ts-nocheck 会被测试拦下，请改为修正类型。
2. 前端业务域的形状
每个域尽量保持同一形状，便于"进一个目录就知道从哪读起"：
modules/<domain>/
index.tsx 域入口组件（导出给 app/modules.ts 注册）
api.ts 只做 HTTP，不做业务判断
types.ts DTO
model.ts 纯函数：筛选 / 排序 / 聚合 / 口径（可被 node:test 直接测）
components/ 无状态展示组件
*.css 域内样式
复杂域可以再分子域，例如氢能：
modules/energy/hydrogen/
index.tsx 导航入口
api.ts types.ts 数据访问与 DTO
model/ 纯逻辑（格式化、承担方标签、按日汇总格式）
board/ 经营看板 UI
station-daily/ 单站日报 UI
drill/ 下钻弹层 UI
common/ 域内共享工具与组件
fonts/ 看板专用字体
判定标准很简单：能在 Node 里直接测的放 model/；需要浏览器/DOM 的放 UI 子目录。
3. 后端结构
server/
config.ts 环境变量集中读取 + assertRuntimeConfig() 启动期校验
app.ts createApp()：装配中间件、挂载路由、静态托管（无副作用，可测试）
index.ts 进程启动：config 校验 → app → bootstrap → listen
local.ts 只读预览启动（不建表、不定时任务）
bootstrap.ts 启动副作用总入口
db/ mysql / hydrogen / heatmap 连接
middleware/ auth（JWT → 注入 user）、read-only
auth/ 登录换票、固定密码、权限过滤与脱敏
routes/ 按业务域的 HTTP 路由
中间件顺序（在 app.ts 中显式体现）
cors → read-only → /api/auth（公开） → authMiddleware → 各业务域路由
→ /api/health → /api/* 未匹配返回 JSON 404 → 静态托管 + SPA 回退
两个已经踩过的坑，改动时不要退回去：
- 未匹配的
/api/*必须返回 JSON 404。若落到 SPA 回退，会返回200 text/html， 前端res.ok为真后在res.json()抛解析错误，把"路由不存在"伪装成数据问题。 - 模块守卫必须 fail-closed，写法是
if (!canAccessX(user?.roles))， 不能写成if (user && !canAccessX(user.roles))——后者在user缺失时静默放行。
角色与数据权限
- 角色常量唯一真源：
src/shared/auth/roles.ts（前后端共用）。 - 数据范围过滤与客户名脱敏：
src/server/auth/permissions.ts。 permissionLevel只表示数据范围，不等于模块权限；能源/调度/反馈各自另有白名单。
4. 新增一个业务模块的步骤
src/modules/<domain>/：建api.ts（HTTP）、model.ts（纯逻辑）、index.tsx（入口）、components/。src/app/modules.ts：注册导航项，必要时用roles.ts的判断控制可见性。src/server/routes/<domain>.ts（或routes/<domain>/）：实现接口；需要模块级权限就加 fail-closed 守卫。- 数据权限：读取后调用
filterByPermission+maskCustomerNames，或写等价的 SQL 过滤。 - 测试：纯逻辑进
model.test.ts；接口口径用固定夹具锁 SQL 与参数（参考server/routes/energy/routes.test.ts）。 - 跑
npm run lint && npm test && npm run build。
5. 已知未尽事项
诚实记录，避免后来者以为已经做完：
- 后端路由尚未全部拆成 routes / service / repository。
routes/vehicles/已有repository.ts+model.ts的雏形，其余域仍是单文件路由；拆分时不要改变 SQL 与参数顺序。 - 运行时建表仍分散在业务代码里：
ele、feedback、mileage在首次调用时执行CREATE TABLE，而read-only中间件只按 HTTP 方法拦截，所以只读预览下 GET 仍可能触发建表。 应收敛到显式的迁移函数并只由bootstrap.ts调用。 - 重复实现尚未合并：Excel 导出有 3 套、高德初始化 2 份、数值格式化多处；
公共实现
modules/energy/hydrogen/model/display-format.ts目前只被自己的测试使用。 - 前端
dist体积：氢能看板单个 chunk 约 200 kB（gzip 50 kB），来自原型渲染方式（大量内联样式）。