zijunchiang
3738bd91b9
契约变更（T-WEB-016，与 Android T-AND-011「两端一起改」配套）
- websocket-keypoints 0.1.0 -> 0.2.0，均为向后兼容（子协议名与二进制帧
version 均不变，只新增可选控制字段与一种新控制类型）：
1.1 保活：接收端必须声明 silentTimeoutMs 与 heartbeatIntervalMs，且心跳必须
小于静默超时的一半。根因是客户端只能用 OkHttp 的协议层 ping，而它由
底层库自动应答、**不暴露给应用层**，接收端根本看不到，无法续命；
3.1 hello.deviceId（该安装实例的稳定标识，不使用任何硬件序列号）；
3.2/3.3 welcome/config 携带保活字段；
3.6 应用层 ping/pong（回显 sentAtMs，pong 另带 serverAtMs 供算 RTT）；
5 设备去重：同一 deviceId 只保留最新连接，旧连接以 1000 关闭
（刻意用 1000：对端据 §7 不会重连，否则形成"挤掉-重连-再挤掉"循环）；
7 关闭码与重连策略：1000/1001/1002 与主动停止不重连，其余重连；
7.1 退避参数冻结：min(500ms*2^(n-1), 15000ms) + ±20% 抖动；
8 连接状态机（两端同名，日志可直接对照）。
- contracts/VERSION 与 src/config/contract-versions.ts 同步到 0.2.0。
补齐 rest-api.yaml 漏写的场景结构（只补规格，不改线格式，版本号不变）
- CatalogBundle 增加 scenes[]（标注 0.5.0 起下发）；
- 新增 Scene / SceneConfig / Vec3 schemas。catalog/export 自 v0.7.0 起就返回
scenes[]，data-models 7 也已冻结，但规格漏写会让两端对字段边界
（如 0~1、±200）的理解不一致。
deploy/proxy/README.md 新增第九节：Gitea 站点的附件上传上限
- 与一~五节的 Web 服务反代是**两个不同站点**；实测 30.5 MB / 40 MB 上传返回
HTTP 413，根因是 IIS 默认 maxAllowedContentLength = 30,000,000 字节；
- 给出放宽到 256 MB 的 IIS / ARR / Gitea app.ini / nginx 四处配置与复验命令；
- 这解释了 Windows 端 v0.1.0 为何被拆成 zip.part0/1/2（交付缺陷）。
文档与脚本
- 补齐 tasks/011~016 与 project.yaml 条目（T-WEB-011~015 此前已在代码中落地
却缺任务说明书）；project.yaml 的 contracts_version 由单个 0.4.0 改为六项字典；
- scripts/package-release.sh 的版本号改为从 web-server/package.json 读取
（与 GET /health 的 version、管理端左下角展示同源），并与 project.yaml 交叉校验；
同时补上 SHA256SUMS 与自校验（此前是手工生成的）。
验证：npm run verify 通过（contracts:check 六项一致 + 35 条路由一致、
typecheck、246 项测试、nest build）；产物 opendance-web-v0.7.1.tar.gz
sha256 27f92cfb125bbcf29077d4ad90c44720cbca46d23ddef12cd7826d73bd8865e2。
50 lines
1.8 KiB
TypeScript
50 lines
1.8 KiB
TypeScript
import { existsSync, readFileSync } from 'node:fs';
|
||
import { join } from 'node:path';
|
||
|
||
/**
|
||
* 编译进代码的契约版本常量。
|
||
* 与 `contracts/VERSION` 必须一致；`npm run contracts:check` 在构建前校验。
|
||
* 之所以编译进代码：这是运行时读不到 contracts/VERSION 时的兜底值
|
||
* （原生部署会通过 CONTRACTS_DIR 指向安装目录下的 contracts/，
|
||
* 未设置该变量时回落到这里的常量）。
|
||
*/
|
||
export const CONTRACT_VERSIONS: Readonly<Record<string, string>> = Object.freeze({
|
||
'rest-api': '0.5.0',
|
||
'websocket-keypoints': '0.2.0',
|
||
'data-models': '0.7.0',
|
||
'skeleton-topology': '0.2.0',
|
||
'model-formats': '0.5.0',
|
||
database: '0.4.0',
|
||
});
|
||
|
||
/** 解析 `contracts/VERSION`（`key: value` 每行一条，`#` 起注释） */
|
||
export function parseVersionFile(content: string): Record<string, string> {
|
||
const out: Record<string, string> = {};
|
||
for (const rawLine of content.split(/\r?\n/)) {
|
||
const line = rawLine.trim();
|
||
if (!line || line.startsWith('#')) continue;
|
||
const idx = line.indexOf(':');
|
||
if (idx <= 0) continue;
|
||
const key = line.slice(0, idx).trim();
|
||
const value = line.slice(idx + 1).trim();
|
||
if (key && value) out[key] = value;
|
||
}
|
||
return out;
|
||
}
|
||
|
||
/**
|
||
* 运行期契约版本。设置 `CONTRACTS_DIR` 时读取实时文件（部署可挂载 contracts/），
|
||
* 否则回落到编译常量。
|
||
*/
|
||
export function resolveContractVersions(contractsDir?: string): Record<string, string> {
|
||
if (!contractsDir) return { ...CONTRACT_VERSIONS };
|
||
const file = join(contractsDir, 'VERSION');
|
||
if (!existsSync(file)) return { ...CONTRACT_VERSIONS };
|
||
try {
|
||
const parsed = parseVersionFile(readFileSync(file, 'utf8'));
|
||
return Object.keys(parsed).length > 0 ? parsed : { ...CONTRACT_VERSIONS };
|
||
} catch {
|
||
return { ...CONTRACT_VERSIONS };
|
||
}
|
||
}
|