test(accept): 产物级端到端验收自动化 + 实体注册核对落到 dist（v0.7.4 实测全通过）
背景：`npm run verify` 跑的是源码与刚构建的 dist，而交付给部署方的是
`dist-release/*.tar.gz`；两者之间隔着「解包 → npm install --omit=dev → 迁移 →
起进程」四步。本项目三次生产事故（v0.7.0/v0.7.1 起不来、v0.7.3 场景上传 400、
v0.7.4 `No metadata for "Scene"`）全都只在产物真正跑起来时才暴露。
一、`scripts/check-bootstrap.mjs` 新增「产物级实体注册核对」
直接读包内 `dist/entities/`：逐个 import 每个 *.entity.js（@Entity() 装饰器
在模块加载时写 metadata），要求
* 每个实体文件里被 @Entity() 装饰的类都在 ENTITIES 里；
* ENTITIES 里不允许有未装饰的成员；不允许重复；
* Scene 必须注册（点名）。
为什么必须单独有这一条：漏注册实体**不影响启动**（TypeORM 只按 ENTITIES 注册，
DI 图照样解析、/health 正常、migrationsPending 0），只在第一次查该实体时抛
`No metadata`，导致 /api/scenes、/api/catalog/export、/api/catalog/version、
/api/reviews?status=pending 全部 500 —— 客户端一个目录都拉不到。
原来的启动冒烟与 entities-registry.spec.ts（查 src/）都抓不到它。
反向验证（在真实 v0.7.4 发布包里复现生产缺陷）：把包内
dist/entities/index.js 的 ENTITIES 去掉 Scene 后，核对立即失败并给出
「scene.entity.js 里的 Scene 没有注册进 ENTITIES」与「ENTITIES 里没有 Scene」；
还原后通过。
二、`scripts/accept-release.sh`（新增）：一个 tar.gz 的产物级端到端验收
解包 → 装生产依赖 → 跑迁移 → 起服务 → 校验 /health 关键字段
（版本 / 数据库 / migrationsPending / scenes.available）→ 产物级实体注册核对
（用仓库当前的 checker 覆盖包内旧版本，验收标准以最新为准）→ 跑发布包自带的
test/smoke.mjs → 停服务。只需要一个现成的 MySQL/MariaDB，不装数据库
（与项目「不部署 MySQL」的边界一致）。
实测（opendance-web-v0.7.4.tar.gz + 真实 MySQL 9.7.2，全新库从零迁移）：
✓ /health version=0.7.4 与 package.json 一致
✓ 数据库已连接（opendance_accept，pending=0）
✓ scenes.available=true（生产 v0.7.3 是 false + No metadata）
✓ 产物级实体注册核对通过：6 个实体文件全部注册进 ENTITIES（含 Scene）
== 结果：80 通过 / 0 失败 ==
冒烟 [7] 段即 ④ 验收：POST /api/scenes 201、一律 pending、GLB 直传不重编码、
glbUrl 生成、重力/风/摩擦/坡度/出生点/相机模式按配置原样入库、越界夹紧与非法
枚举回退、审核通过后 catalog/export 的 scenes[] 带完整物理参数与 GLB/缩略图字段、
目录指纹纳入场景变更、详情、状态过滤、DELETE 204。
`npm run verify` 全绿：契约 6 项 / 35 路由 / 版本一致 / 295 项测试 / build /
产物级注册核对 / 启动冒烟。
This commit is contained in:
@@ -26,7 +26,8 @@
|
||||
* 用法：node scripts/check-bootstrap.mjs
|
||||
*/
|
||||
import { spawn } from 'node:child_process';
|
||||
import { mkdtempSync, readFileSync } from 'node:fs';
|
||||
import { mkdtempSync, readFileSync, readdirSync } from 'node:fs';
|
||||
import { createRequire } from 'node:module';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
@@ -60,12 +61,126 @@ const DB_STAGE_PATTERNS = [
|
||||
|
||||
const TIMEOUT_MS = Number(process.env.BOOTSTRAP_TIMEOUT_MS ?? 40_000);
|
||||
|
||||
/* ---------------------------------------------- 产物级实体注册核对 */
|
||||
|
||||
/**
|
||||
* 就地核对**编译产物**里的实体注册，而不是源码。
|
||||
*
|
||||
* 为什么必须有这一层：生产事故「`/health` 报 `No metadata for "Scene" was found.`」
|
||||
* 的根因是 `src/entities/index.ts` 的 `ENTITIES` 漏了 `Scene`。这类缺陷有三个特点：
|
||||
* 1. **启动完全正常** —— TypeORM 只按 `ENTITIES` 注册 metadata，漏注册不影响 DI 图；
|
||||
* 2. **`tsc` 与单元测试全绿** —— 类型没问题，`entities-registry.spec.ts` 只查源码；
|
||||
* 3. 只有**第一次查该实体**时才抛（`/api/scenes`、`/api/catalog/export`、
|
||||
* `/api/reviews?status=pending` 全部 500，客户端一个目录都拉不到）。
|
||||
* 也就是说：源码层的校验挡不住「产物里的 ENTITIES 与 dist 里的实体文件不一致」
|
||||
* （例如 `nest build` 没重新编译、打包时带了旧的 dist）。
|
||||
*
|
||||
* 因此按「校验必须落在产物上」的规则，这里直接读 `dist/entities/`：
|
||||
* * 每个 `*.entity.js` 里被 `@Entity()` 装饰的类都必须在 `ENTITIES` 里；
|
||||
* * `ENTITIES` 里不允许出现没有 `@Entity()` 装饰的成员（防复制粘贴写错）；
|
||||
* * `ENTITIES` 不允许重复；
|
||||
* * `Scene` 必须注册（点名，一眼看出是不是又漏了场景）。
|
||||
*/
|
||||
function checkEntityRegistry() {
|
||||
const requireFromServer = createRequire(join(serverDir, 'package.json'));
|
||||
const errors = [];
|
||||
|
||||
let storage;
|
||||
try {
|
||||
requireFromServer('reflect-metadata');
|
||||
storage = requireFromServer('typeorm').getMetadataArgsStorage();
|
||||
} catch (error) {
|
||||
return {
|
||||
errors: [
|
||||
`无法加载 typeorm（${error instanceof Error ? error.message : String(error)}）——` +
|
||||
'请先在 web-server 目录执行 npm install',
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
const entitiesDir = join(serverDir, 'dist', 'entities');
|
||||
let files;
|
||||
try {
|
||||
files = readdirSync(entitiesDir).filter((name) => name.endsWith('.entity.js'));
|
||||
} catch (error) {
|
||||
return { errors: [`无法读取 ${entitiesDir}：${error.message}（是否忘了 npm run build？）`] };
|
||||
}
|
||||
if (files.length === 0) {
|
||||
return { errors: [`${entitiesDir} 下没有任何 *.entity.js`] };
|
||||
}
|
||||
|
||||
// 逐个 import：@Entity() 装饰器在模块加载时写入 metadata storage
|
||||
const fileOfClass = new Map();
|
||||
for (const file of files) {
|
||||
const module_ = requireFromServer(join(entitiesDir, file));
|
||||
let decorated = null;
|
||||
for (const value of Object.values(module_)) {
|
||||
if (typeof value === 'function' && storage.tables.some((t) => t.target === value)) {
|
||||
decorated = value;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!decorated) {
|
||||
errors.push(`${file} 里没有找到被 @Entity() 装饰的类`);
|
||||
continue;
|
||||
}
|
||||
fileOfClass.set(decorated, file);
|
||||
}
|
||||
|
||||
let entities;
|
||||
try {
|
||||
entities = requireFromServer(join(entitiesDir, 'index.js')).ENTITIES;
|
||||
} catch (error) {
|
||||
return { errors: [`无法加载 dist/entities/index.js：${error.message}`] };
|
||||
}
|
||||
if (!Array.isArray(entities)) {
|
||||
return { errors: ['dist/entities/index.js 没有导出数组形式的 ENTITIES'] };
|
||||
}
|
||||
|
||||
const registered = new Set(entities);
|
||||
for (const [cls, file] of fileOfClass) {
|
||||
if (!registered.has(cls)) {
|
||||
errors.push(
|
||||
`${file} 里的 ${cls.name} 没有注册进 ENTITIES —— ` +
|
||||
'查询该实体会抛 `No metadata for "..." was found.`（接口直接 500）',
|
||||
);
|
||||
}
|
||||
}
|
||||
for (const cls of entities) {
|
||||
if (!fileOfClass.has(cls)) {
|
||||
errors.push(`ENTITIES 里的 ${cls?.name ?? String(cls)} 不是 dist/entities/ 下任何 @Entity() 类`);
|
||||
}
|
||||
}
|
||||
if (registered.size !== entities.length) {
|
||||
errors.push(`ENTITIES 有重复项（${entities.length} 项，去重后 ${registered.size} 项）`);
|
||||
}
|
||||
if (!entities.some((cls) => cls?.name === 'Scene')) {
|
||||
errors.push('ENTITIES 里没有 Scene —— 场景管理相关接口会全部 500（生产事故根因）');
|
||||
}
|
||||
|
||||
return { errors, count: entities.length, fileCount: files.length };
|
||||
}
|
||||
|
||||
function freePort(base) {
|
||||
// 用一个不常见的端口即可；连库失败是预期的，端口只要不撞上真实服务
|
||||
return base + Math.floor(Math.random() * 200);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
// ---------- 第一步：产物级实体注册核对（不需要进程与数据库）----------
|
||||
const registry = checkEntityRegistry();
|
||||
if (registry.errors.length > 0) {
|
||||
console.error('✗ 产物级实体注册核对失败（dist/entities 与 ENTITIES 不一致）：');
|
||||
for (const message of registry.errors) console.error(` - ${message}`);
|
||||
console.error(' 说明：TypeORM 只按 ENTITIES 注册 metadata，漏注册不影响启动，');
|
||||
console.error(' 但第一次查该实体会抛 No metadata，相关接口全部 500。');
|
||||
process.exit(1);
|
||||
}
|
||||
console.log(
|
||||
`✓ 产物级实体注册核对通过：dist/entities/ 下 ${registry.fileCount} 个实体文件` +
|
||||
`全部注册进 ENTITIES（共 ${registry.count} 项，含 Scene）`,
|
||||
);
|
||||
|
||||
const scratch = mkdtempSync(join(tmpdir(), 'opendance-boot-'));
|
||||
|
||||
// 模拟 systemd：删掉 npm_* 环境变量（ExecStart=node dist/main.js 时它们不存在）
|
||||
|
||||
Reference in New Issue
Block a user