Files
opendance-web/web-server/admin
zijunchiang 2433cd22a5 fix(boot): CatalogModule 漏 import ScenesModule 导致产物起不来 + /health 版本号错
两个都是**只有真正启动服务才会暴露**的缺陷,v0.7.0 / v0.7.1 的产物受影响。

1. 【致命】CatalogModule 漏 import ScenesModule
   CatalogService 因为 catalog/export 要下发 scenes[] 而注入 ScenesService,但
   CatalogModule 的 imports 只列了 SongsModule / MotionsModule / ModelsModule。
   Nest 的 DI 按模块解析,于是 node dist/main.js 在 bootstrap 阶段直接抛
   UnknownDependenciesException: Nest can't resolve dependencies of the
   CatalogService (... ? ...) —— 服务完全起不来(装得上、起不来)。
   为什么三层检查全绿:nest build/tsc 看不出运行时 DI;258 项单元测试直接 new
   服务或测纯函数,从不编译 AppModule;打包脚本只校验文件清单与压缩包完整性。
   修复:CatalogModule.imports 补上 ScenesModule。

2. /health 的 version 在原生部署下永远是 0.1.0
   原实现 process.env.npm_package_version ?? '0.1.0',而该变量只在 npm 脚本下
   存在;正式部署是原生服务(ExecStart=node dist/main.js),npm 不参与 ->
   恒为 undefined -> 回退到硬编码 0.1.0,与管理端左下角展示的 vX.Y.Z 冲突,
   违反文档 11.2 第 4 条「可核对:Web 端至少与 GET /health 的 version 一致」。
   修复:新增 src/config/app-version.ts 作为运行时唯一解析点
   (APP_VERSION -> 运行入口旁/工作目录的 package.json(带包名校验)
   -> npm_package_version -> 显式 0.0.0),/health 改用 resolveAppVersion(),
   main.ts 启动首行也打印版本号。新增 12 项测试,其中一项显式模拟无 npm
   环境变量的原生部署。

防线(都挂进了 verify 与打包脚本)
- scripts/check-bootstrap.mjs:以正式部署方式(node dist/main.js、无 npm 环境
  变量、不需要数据库)拉起真实产物,断言①无依赖解析类错误②启动日志的应用版本
  等于 package.json ③已推进到数据库连接阶段。已做反向验证:删掉 ScenesModule
  后该检查立刻失败。
- scripts/check-version.mjs(并入 contracts:check):校验
  web-server/package.json = admin/package.json = project.yaml,正则禁止
  health.controller.ts 再出现硬编码版本回退,管理端已构建时断言产物 JS 含 vX.Y.Z。
- npm run verify 现在包含 bootstrap:check;package-release.sh 在构建后、打包前
  各跑一次(构建管理端后再跑 version:check,因为此时才需要校验产物内版本)。

文档:README.md / README.txt 增加 v0.7.2 修订说明;
tasks/011-version-display.md 与 tasks/015-scene-management.md 补「缺陷修复记录」
(含为什么当时没被发现的三层检查对照表)。

验证:npm run verify 通过(契约六项一致、35 条路由、258 项测试、nest build、
启动冒烟);产物 opendance-web-v0.7.2.tar.gz
sha256 f04ecc85d17517ec00754238616eb1237cdb2fe17440af6dce731827c0922b26。
2026-09-17 01:49:52 +08:00
..

OpenDance Studio 管理端(opendance-admin)

基于 React 18 + TypeScript + Vite 的管理后台,对接 web-server 的 NestJS API。 接口契约以 ../contracts/rest-api.yaml(rest-api 0.1.0)为准, 字段语义见 ../contracts/data-models.md。

界面语言为简体中文;无任何 UI 组件框架,全部样式集中在 src/styles.css。

快速开始

npm install      # 或 pnpm install
npm run dev      # 开发服务器 http://localhost:5173
npm run build    # 生产构建(tsc -b && vite build)-> dist/
npm run preview  # 本地预览 dist/
npm run typecheck # 只做类型检查(tsc --noEmit)

管理端请求的是同源的 /api/** 与 /health,不含任何硬编码域名。

开发代理(dev proxy)

vite.config.ts 已把 /api 与 /health 代理到 http://localhost:3000:

server: {
  port: 5173,
  proxy: {
    '/api':    { target: 'http://localhost:3000', changeOrigin: true },
    '/health': { target: 'http://localhost:3000', changeOrigin: true },
  },
}

因此本地只需先启动服务端,再 npm run dev 即可,无需配置 CORS。

VITE_API_BASE

src/api/client.ts 的基址取自:

const BASE_URL = import.meta.env.VITE_API_BASE?? '';
  • 不设置(默认,空串):同源请求 -- 开发期走上面的 vite 代理,生产期走 nginx 反代。推荐。

  • 设置:例如服务端在另一台机器上:

    #.env.local(不要提交)
    VITE_API_BASE=http://192.0.2.10:3000
    

    此时浏览器会直接跨域请求该地址,需要服务端开启 CORS。 构建期注入:VITE_API_BASE=https://api.example.com npm run build。

生产构建与部署

npm run build     # 产物在 dist/

vite.config.ts 使用 base: './',产物使用相对路径引用,可挂在任意子路径下。

生产部署(业务服务自带管理端,不需要反代托管静态文件)

构建产物 dist/ 会被安装到 $APP_DIR/admin,并由 NestJS 服务自身托管 (含 SPA 深链接回退)。因此反向代理只需要把请求整体转发到后端端口即可, 不需要在代理层再配置静态站点或 try_files。

# 仓库根目录,一键部署后端(含管理端)
bash deploy/install.sh
  • 后端通过 ADMIN_DIR 定位管理端产物,默认 ../admin
  • 反代配置样例:deploy/proxy/nginx.conf.example(nginx)、 deploy/proxy/web.config.example(IIS)
  • 完整说明:deploy/proxy/README.md

目录结构

src/
  main.tsx                 入口(BrowserRouter)
  App.tsx                  路由表
  styles.css               全部样式
  api/
    client.ts              fetch 封装(ApiError / 分页 / multipart)
    types.ts               契约类型(与 rest-api.yaml 一一对应)
    endpoints.ts           契约端点封装
  components/
    Layout.tsx             左侧导航骨架
    ui.tsx                 通用组件(表格/弹窗/分页/来源五元组展示与表单...)
    VrmPreview.tsx         three + @pixiv/three-vrm 的 3D 预览(懒加载分包)
  lib/
    labels.ts              枚举中文文案
    format.ts              时间/字节/时长格式化
    validation.ts          客户端校验(来源五元组等)
    useAsync.ts            加载/错误/重试 hook
  pages/
    Dashboard.tsx          概览
    Songs.tsx              歌曲管理 T-WEB-008
    Models.tsx             模型管理 T-WEB-009
    Motions.tsx            动作管理 T-WEB-004/006
    Reviews.tsx            审核 T-WEB-007

页面与任务对照

路由 说明 任务
/ 概览:三类资产按状态计数、契约版本与目录指纹、健康检查、API 不可达告警 -
/songs 歌曲管理:分页/搜索/筛选、来源五元组必填、音频上传、软删除 T-WEB-008
/models 模型管理:VRM 优先、来源五元组完整展示、设为默认、3D 预览 T-WEB-009
/motions 动作管理:上传、预处理、关键点 NDJSON 下载 T-WEB-004/006
/reviews 审核:待审列表 + 审核流水,通过/驳回(驳回必填意见) T-WEB-007

所有页面都显式处理加载中 / 空数据 / 请求失败三种状态,请求失败不会白屏。

3D 预览说明

src/components/VrmPreview.tsx: GLTFLoader + VRMLoaderPlugin(来自 @pixiv/three-vrm),

  • 依据 vrm.meta.metaVersion 区分 VRM 0.x / 1.0, 0.x 自动执行 VRMUtils.rotateVRM0;
  • 自实现鼠标拖拽旋转与滚轮缩放(未引入 OrbitControls);
  • requestAnimationFrame 循环内调用 vrm.update(delta),并按包围盒自动取景;
  • 卸载时取消 RAF、断开 ResizeObserver、释放 renderer / geometry / material / texture;
  • 无 WebGL 上下文时降级为错误提示,不会让页面崩溃。

three + @pixiv/three-vrm(约 750 kB)通过 React.lazy 单独分包,仅进入模型页时加载。