docs: add contributing guides + link docs from README

This commit is contained in:
youzini
2026-05-31 17:11:19 +00:00
parent efbf5e3505
commit e80ca7ed9a
4 changed files with 166 additions and 0 deletions

View File

@@ -0,0 +1,48 @@
# 测试
ST-BME 的测试是 Node 回归测试(`tests/*.mjs``npm run test:stable` 自动扫描运行。本文档说明测试分类和两道关键防线。
## 测试分类
| 类别 | 例子 | 测什么 |
| --- | --- | --- |
| 控制平面 | `identity-resolver` / `persistence-reducer` | 身份解析、持久化状态机不变量 |
| 数据格式 | `graph-snapshot-schema` / `graph-snapshot-upgrade` / `snapshot-forward-compat` | 快照契约、宽容解析、向前兼容往返 |
| 持久化 | `graph-persistence` / `indexeddb-*` | 图谱持久化、IndexedDB 快照/增量/hydrate |
| 检索/召回 | `p0-regressions` 内相关、`trivial-user-input` | 召回、reroll 复用、注入 |
| 向量 | `vector-gate` / `vector-connection-probe` / `vector-sync-coalescer` | 向量门禁、连接探测、后台同步合并 |
| Native | `native-layout-parity` / `native-rollout-matrix` | native/JS 一致性、灰度门控 |
| 防线 | `index-slicing-ratchet` / `runtime-deps-completeness` | 见下 |
## 防线一:禁止切片 index.jsratchet
历史上部分回归测试用 `readFile(index.js)` + 标记字符串切片 + `vm.runInContext` 来测内部函数。这让 `index.js` 与字节偏移强耦合,反复出现 `X is not defined` 沙箱崩溃,并阻碍任何 `index.js` 重构。
这些逻辑已全部抽成可直接 `import` 的控制器/工厂模块。
> `tests/index-slicing-ratchet.mjs` 守住这条线:任何测试文件若读取 `index.js` 文本CI 失败。允许名单ALLOWLIST现在为空且只能缩不能增。
**所以:新测试必须直接 import 真实模块并注入依赖,绝不切片 `index.js`。**
## 防线二:依赖注入完整性守卫
抽出的控制器模块通过 `runtime` 对象拿依赖,由 `index.js``create*Runtime()` builder 提供。如果模块用了 `runtime.someDep` 但 builder 忘了提供,运行时(尤其 fallback 路径)才炸——测试可能还是绿的。这正是历史上出过的真实 bug。
> `tests/runtime-deps-completeness.mjs` 扫描三个 sync 控制平面模块的直接 `runtime.X` 引用,和对应 builder 提供的键对比;漏注入则失败,并报出模块/builder/缺失键。
校验的模块/builder 对:
| 模块 | builder |
| --- | --- |
| `sync/graph-persistence-io.js` | `createGraphPersistenceIoRuntime` |
| `sync/graph-load-persist.js` | `createGraphLoadPersistRuntime` |
| `sync/graph-mutation-gate.js` | `createGraphMutationGateRuntime` |
> 禁止 `runtime[dynamicKey]` 这种计算属性访问——它绕过静态完整性检查,守卫会直接报错。新增 `runtime.X` 依赖时,必须同步更新对应 builder。
详见 [`conventions.md`](conventions.md)。
## 已知环境限制
- `tests/indexeddb-migration.mjs` 等需要 IndexedDB 测试依赖;某些 Node 环境缺失会失败,非代码问题。
- `typescript-language-server` 未安装,用 `npm run check` 替代 LSP 诊断。