Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
afed67e175 | ||
|
|
da03777995 | ||
|
|
e9de740d66 | ||
|
|
ea58520fc2 | ||
|
|
d6376ec5a5 |
@@ -101,7 +101,7 @@ opendance-web/
|
|||||||
│ ├── admin/ # React 管理端
|
│ ├── admin/ # React 管理端
|
||||||
│ │ ├── src/components/ModelReviewPanel.tsx # 模型审核面板 + 骨骼详细界面
|
│ │ ├── src/components/ModelReviewPanel.tsx # 模型审核面板 + 骨骼详细界面
|
||||||
│ │ └── src/lib/bone-tree.ts # 骨骼树过滤(搜索保留祖先链)
|
│ │ └── src/lib/bone-tree.ts # 骨骼树过滤(搜索保留祖先链)
|
||||||
│ ├── test/ # 单元测试 + 端到端冒烟(10 文件 / 168 项)
|
│ ├── test/ # 单元测试 + 端到端冒烟(12 文件 / 193 项)
|
||||||
│ │ # mmd-vmd 31 / model-archive 24 / model-inspector 25
|
│ │ # mmd-vmd 31 / model-archive 24 / model-inspector 25
|
||||||
│ │ # / model-thumbnail 8 / admin-bone-filter 8
|
│ │ # / model-thumbnail 8 / admin-bone-filter 8
|
||||||
│ │ # / preprocess 25 / init-env 16 / admin-port 16
|
│ │ # / preprocess 25 / init-env 16 / admin-port 16
|
||||||
@@ -111,6 +111,7 @@ opendance-web/
|
|||||||
│ # / import-default-model.mjs(默认模型导入 / 补写源码)
|
│ # / import-default-model.mjs(默认模型导入 / 补写源码)
|
||||||
├── deploy/ # ★ 业务服务部署(不含 MySQL、不含反代)
|
├── deploy/ # ★ 业务服务部署(不含 MySQL、不含反代)
|
||||||
│ ├── init-env.sh # ★ 首次启动的.env 交互引导(install.sh 缺.env 时调用)
|
│ ├── init-env.sh # ★ 首次启动的.env 交互引导(install.sh 缺.env 时调用)
|
||||||
|
│ ├── env-lib.sh # ★ deploy/.env 语法预检(被 install.sh / ctl.sh 引用)
|
||||||
│ ├── install.sh # 一键部署(systemd / OpenRC / SysVinit / 后台进程)
|
│ ├── install.sh # 一键部署(systemd / OpenRC / SysVinit / 后台进程)
|
||||||
│ ├── uninstall.sh
|
│ ├── uninstall.sh
|
||||||
│ ├── ctl.sh # 无 init 系统时的进程控制
|
│ ├── ctl.sh # 无 init 系统时的进程控制
|
||||||
@@ -333,12 +334,18 @@ POST /api/models ─┬─.glb /.vrm /.gltf ─▶ importModelFile() 直接导
|
|||||||
T-pose 角色图;真实 10MB VRM(83 关节、5307 顶点)单张耗时 60-121ms(中位 79ms)。
|
T-pose 角色图;真实 10MB VRM(83 关节、5307 顶点)单张耗时 60-121ms(中位 79ms)。
|
||||||
- 管理端 3D 预览放开到 `vrm/glb/gltf`(`fbx` 仍提示"仅归档,请先转换为 GLB/VRM");
|
- 管理端 3D 预览放开到 `vrm/glb/gltf`(`fbx` 仍提示"仅归档,请先转换为 GLB/VRM");
|
||||||
列表页显示 40px 缩略图。
|
列表页显示 40px 缩略图。
|
||||||
- 测试:`npx vitest run` -> **10 个文件 / 168 项通过**
|
- 测试:`npx vitest run` -> **12 个文件 / 193 项通过**
|
||||||
(`model-inspector` 25、`model-thumbnail` 8、`admin-bone-filter` 8、
|
(`model-inspector` 25、`model-thumbnail` 8、`admin-bone-filter` 8、
|
||||||
`model-archive` 24、`mmd-vmd` 31、`preprocess` 25、`init-env` 16、
|
`model-archive` 24、`mmd-vmd` 31、`preprocess` 25、`init-env` 16、
|
||||||
`admin-port` 16、`access-log` 9、`vrm-inspector` 6)。
|
`admin-port` 16、`access-log` 9、`vrm-inspector` 6)。
|
||||||
|
|
||||||
## 12. 首次启动的.env 引导(deploy/init-env.sh)与监听地址
|
## 12. 首次启动的.env 引导(deploy/init-env.sh)、.env 预检与监听地址
|
||||||
|
|
||||||
|
- `deploy/env-lib.sh`: `.env` 语法预检。`install.sh` / `ctl.sh` 用
|
||||||
|
`set -a; . deploy/.env` 载入配置时 shell 会真的执行该文件,值含空格却未加引号
|
||||||
|
会被切成「赋值 + 命令」(实测报 `line 53: Miku.pmx: command not found`,退出码 127)。
|
||||||
|
两个脚本在 source 之前调用预检,输出「哪一行、原文、改法」;
|
||||||
|
模板中带空格的值统一写成 `MODEL_CONVERT_PMX="Hatsune Miku.pmx"`。
|
||||||
|
|
||||||
- `deploy/init-env.sh`:交互式逐项询问 `DB_HOST / DB_PORT / DB_USER / DB_PASS /
|
- `deploy/init-env.sh`:交互式逐项询问 `DB_HOST / DB_PORT / DB_USER / DB_PASS /
|
||||||
DB_NAME / PORT / ADMIN_PORT / HOST`,回车保留默认;口令 `read -rs` 不回显、
|
DB_NAME / PORT / ADMIN_PORT / HOST`,回车保留默认;口令 `read -rs` 不回显、
|
||||||
|
|||||||
@@ -10,7 +10,22 @@ OpenDance Studio **阶段一**: Web 管理服务端(NestJS + TypeORM + 现有 My
|
|||||||
|
|
||||||
## 状态
|
## 状态
|
||||||
|
|
||||||
**阶段一已完成**: T-WEB-001 -> T-WEB-010 全部落地,当前版本 **v0.2.0**(契约 `rest-api / data-models / model-formats 0.4.0`、`database 0.3.0`)。
|
**阶段一已完成**: T-WEB-001 -> T-WEB-010 全部落地,当前版本 **v0.2.2**(契约 `rest-api / data-models / model-formats 0.4.0`、`database 0.3.0`)。
|
||||||
|
|
||||||
|
v0.2.2 修订:
|
||||||
|
|
||||||
|
1. **修复 Assimp 缺失时的报错与部署体验**:服务器没装 Assimp 时,上传 .pmx/.fbx(或含它们的压缩包)只得到两条 `导出失败(ENOENT): spawn assimp ENOENT`,看不出缺什么、怎么装;
|
||||||
|
2. 转换前先**定位 Assimp 可执行文件**(`src/common/assimp.ts`):按 `ASSIMP_BIN` -> PATH -> `/usr/bin`、`/usr/local/bin` 等常见目录查找,找不到就一次性给出各发行版安装命令、查过的路径与**替代办法**(只传 .glb/.vrm 不需要它),不再打两条 ENOENT;
|
||||||
|
3. `install.sh` 新增 **Assimp 检查与自动安装**(`deploy/assimp-lib.sh`):按发行版调用 apt-get / dnf / yum / zypper / apk / pacman;装在非常规目录时自动把绝对路径写进 `deploy/.env` 的 `ASSIMP_BIN`;装不上只告警不中止(可用 `SKIP_ASSIMP_INSTALL=1` 跳过);
|
||||||
|
4. `deploy/check-access.sh` 自检增加 Assimp 一行;管理端「概览 -> 服务健康」显示 Assimp 状态,不可用时给出提示;
|
||||||
|
5. 新增 13 项测试(`test/assimp-locate.spec.ts`),覆盖定位、错误文案、快速失败与部署脚本的安装逻辑。
|
||||||
|
|
||||||
|
v0.2.1 修订:
|
||||||
|
|
||||||
|
1. **修复部署失败**:`deploy/.env.example` 里 `MODEL_CONVERT_PMX=Hatsune Miku.pmx` 的值含空格却没加引号,`install.sh` 用 `set -a; . deploy/.env` 载入时把 `Miku.pmx` 当命令执行,报 `command not found`(退出码 127);模板改为带引号写法;
|
||||||
|
2. **新增 `.env` 语法预检**(`deploy/env-lib.sh`):`install.sh` 与 `ctl.sh` 在 source 之前先检查,直接给出哪一行、原文、改法,不再出现看不懂的 127 报错;
|
||||||
|
3. 安装失败提示带上出错文件名(`.env` 被 source 时行号属于 `.env`,只报行号无法定位);
|
||||||
|
4. 新增 12 项回归测试(`test/env-file.spec.ts`),锁住「模板可被 shell 原样载入」这条线。
|
||||||
|
|
||||||
v0.2.0 主要变更:
|
v0.2.0 主要变更:
|
||||||
|
|
||||||
@@ -35,18 +50,18 @@ v0.2.0 主要变更:
|
|||||||
2. 准备一个现有的 MySQL / MariaDB 实例,并建好库与账号(见下方[前置要求](#前置要求))
|
2. 准备一个现有的 MySQL / MariaDB 实例,并建好库与账号(见下方[前置要求](#前置要求))
|
||||||
本项目**不会创建数据库本身**
|
本项目**不会创建数据库本身**
|
||||||
|
|
||||||
3. 取得发布包并校验(地址用你们自己的制品库替换)
|
3. 取得发布包并校验(地址用你们自己的制品库替换; 下面是本仓库的发布地址)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -LO https://<制品库地址>/opendance-web-v0.2.0.tar.gz
|
curl -LO https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/v0.2.2/opendance-web-v0.2.2.tar.gz
|
||||||
curl -LO https://<制品库地址>/SHA256SUMS
|
curl -LO https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/v0.2.2/SHA256SUMS
|
||||||
sha256sum -c SHA256SUMS # 期望输出 "OK"
|
sha256sum -c SHA256SUMS # 期望输出 "OK"
|
||||||
```
|
```
|
||||||
|
|
||||||
4. 解压并生成配置(交互式引导,逐项问答,口令不回显)
|
4. 解压并生成配置(交互式引导,逐项问答,口令不回显)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tar -xzf opendance-web-v0.2.0.tar.gz && cd opendance-web-v0.2.0
|
tar -xzf opendance-web-v0.2.2.tar.gz && cd opendance-web-v0.2.2
|
||||||
bash deploy/init-env.sh
|
bash deploy/init-env.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -96,6 +111,9 @@ Node 业务服务由系统服务托管,**同时监听两个端口**,职责分开
|
|||||||
- Linux 服务器,有 **root** 权限(不需要 sudo,直接以 root 执行即可)
|
- Linux 服务器,有 **root** 权限(不需要 sudo,直接以 root 执行即可)
|
||||||
- **Node.js 22** 或更高版本
|
- **Node.js 22** 或更高版本
|
||||||
- 进程管理:`systemd` / `OpenRC` / `SysVinit` 均可;三者都没有也能装(自动降级为 `nohup` 后台进程 + PID 文件 + crontab `@reboot` 开机自启)
|
- 进程管理:`systemd` / `OpenRC` / `SysVinit` 均可;三者都没有也能装(自动降级为 `nohup` 后台进程 + PID 文件 + crontab `@reboot` 开机自启)
|
||||||
|
- Assimp 命令行工具(**可选但推荐**):`.pmx/.fbx` 模型转换与 FBX/glTF 动作预处理需要它;
|
||||||
|
`install.sh` 会自动尝试安装(apt-get / dnf / yum / zypper / apk / pacman),装不上只告警不中止。
|
||||||
|
只上传 `.glb/.vrm` 模型与 `.bvh/.vmd` 动作则完全不需要
|
||||||
- 反向代理:由另外的服务提供,本项目不要求、也不安装
|
- 反向代理:由另外的服务提供,本项目不要求、也不安装
|
||||||
- 一个可连通的现有 MySQL / MariaDB 实例,并已创建数据库与账号:
|
- 一个可连通的现有 MySQL / MariaDB 实例,并已创建数据库与账号:
|
||||||
|
|
||||||
@@ -113,8 +131,8 @@ FLUSH PRIVILEGES;
|
|||||||
### 5. 部署步骤
|
### 5. 部署步骤
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tar -xzf opendance-web-v0.2.0.tar.gz
|
tar -xzf opendance-web-v0.2.2.tar.gz
|
||||||
cd opendance-web-v0.2.0
|
cd opendance-web-v0.2.2
|
||||||
bash deploy/init-env.sh # 首次启动引导: 逐项问答生成 deploy/.env(见下)
|
bash deploy/init-env.sh # 首次启动引导: 逐项问答生成 deploy/.env(见下)
|
||||||
bash deploy/install.sh # 已以 root 登录, 不需要 sudo
|
bash deploy/install.sh # 已以 root 登录, 不需要 sudo
|
||||||
```
|
```
|
||||||
@@ -254,7 +272,8 @@ bash /opt/opendance/deploy/ctl.sh status | restart | logs
|
|||||||
| 健康检查返回 503 | 服务起来了但连不上数据库:核对 `deploy/.env` 的 `DB_HOST/DB_PORT/DB_USER/DB_PASS/DB_NAME`,以及数据库账号是否允许从本机 IP 连接(`GRANT ... TO 'user'@'%'` 或具体主机) |
|
| 健康检查返回 503 | 服务起来了但连不上数据库:核对 `deploy/.env` 的 `DB_HOST/DB_PORT/DB_USER/DB_PASS/DB_NAME`,以及数据库账号是否允许从本机 IP 连接(`GRANT ... TO 'user'@'%'` 或具体主机) |
|
||||||
| 服务本机 curl 通、外部访问不了 | `bash deploy/check-access.sh` 一次定位:打印 `HOST`/`PORT`、实际监听地址、对外 IP 自测、80/443 有无反代、防火墙放行情况,并给出修复命令 |
|
| 服务本机 curl 通、外部访问不了 | `bash deploy/check-access.sh` 一次定位:打印 `HOST`/`PORT`、实际监听地址、对外 IP 自测、80/443 有无反代、防火墙放行情况,并给出修复命令 |
|
||||||
| 管理页面打开是 404 | 说明访问的是软件 API 端口(默认 3000);管理页面在管理端端口(默认 3001) |
|
| 管理页面打开是 404 | 说明访问的是软件 API 端口(默认 3000);管理页面在管理端端口(默认 3001) |
|
||||||
| 上传 `.zip` 模型包报 422 且提示 Assimp 不可用 | PMX/FBX 转换依赖 Assimp:`apt-get install -y assimp-utils libassimp6`;只上传 `.glb` / `.vrm` 则不需要它 |
|
| 上传 `.zip` / `.pmx` / `.fbx` 报转换失败(ENOENT / Assimp 不可用) | PMX/FBX 转换依赖外部 Assimp:`apt-get install -y assimp-utils`(RHEL 系 `dnf install -y assimp`,`install.sh` 现在会尝试自动安装)。装好后**不需要重启服务**;若不在服务 PATH 中,在 `deploy/.env` 设 `ASSIMP_BIN` 为绝对路径。只上传 `.glb` / `.vrm` 则不需要它 |
|
||||||
|
| 安装时报 `command not found` / 退出码 127,且提示指向 `deploy/.env` 某一行 | 该行的值含空格或 shell 元字符却没加引号,被 shell 当成命令执行了。按预检提示给这个值加引号(如 `MODEL_CONVERT_PMX="Hatsune Miku.pmx"`)后重跑;`deploy/env-lib.sh` 会提前拦住并给出行号 |
|
||||||
| 模型审核界面显示"未分析 / 无预览图" | 该模型是升级前入库的:调 `POST /api/models/<id>/reanalyze`,或批量跑 `node scripts/reanalyze-models.mjs --url http://127.0.0.1:3000` |
|
| 模型审核界面显示"未分析 / 无预览图" | 该模型是升级前入库的:调 `POST /api/models/<id>/reanalyze`,或批量跑 `node scripts/reanalyze-models.mjs --url http://127.0.0.1:3000` |
|
||||||
|
|
||||||
## 本地开发
|
## 本地开发
|
||||||
@@ -283,10 +302,11 @@ npm run dev # http://localhost:5173(/api 与 /health 代理到 3000)
|
|||||||
cd web-server
|
cd web-server
|
||||||
npm run contracts:check # 契约版本一致性
|
npm run contracts:check # 契约版本一致性
|
||||||
npm run typecheck # TypeScript 严格检查
|
npm run typecheck # TypeScript 严格检查
|
||||||
npm run test # 168 项单元测试 / 10 个文件(VMD 31、模型压缩包 24、
|
npm run test # 193 项单元测试 / 12 个文件(VMD 31、模型压缩包 24、
|
||||||
# 模型检查器 25、缩略图 8、骨骼过滤 8、
|
# 模型检查器 25、缩略图 8、骨骼过滤 8、
|
||||||
# 预处理 25、init-env 16、admin-port 16、
|
# 预处理 25、init-env 16、admin-port 16、
|
||||||
# access-log 9、VRM 检查器 6)
|
# access-log 9、VRM 检查器 6、.env 预检 12、
|
||||||
|
# Assimp 定位与安装 13)
|
||||||
npm run build # 生产构建
|
npm run build # 生产构建
|
||||||
npm run start:prod & # 启动
|
npm run start:prod & # 启动
|
||||||
npm run test:smoke # 57 项端到端冒烟(需要数据库可连通)
|
npm run test:smoke # 57 项端到端冒烟(需要数据库可连通)
|
||||||
@@ -308,15 +328,23 @@ cd ../admin && npm run build # 管理端构建
|
|||||||
| `ADMIN_DIR` | `../admin`(即 `/opt/opendance/admin`) | 管理端静态站点目录 |
|
| `ADMIN_DIR` | `../admin`(即 `/opt/opendance/admin`) | 管理端静态站点目录 |
|
||||||
| `STORAGE_DIR` | `/var/lib/opendance/storage` | 上传文件存储目录(原生部署默认值) |
|
| `STORAGE_DIR` | `/var/lib/opendance/storage` | 上传文件存储目录(原生部署默认值) |
|
||||||
| `UPLOAD_MAX_BYTES` | `536870912`(512 MiB) | 单文件上限。反向代理层的同名限制必须不小于此值,否则大模型上传会在代理层被拒(nginx `client_max_body_size` / IIS `requestLimits`),详见 `deploy/proxy/README.md` |
|
| `UPLOAD_MAX_BYTES` | `536870912`(512 MiB) | 单文件上限。反向代理层的同名限制必须不小于此值,否则大模型上传会在代理层被拒(nginx `client_max_body_size` / IIS `requestLimits`),详见 `deploy/proxy/README.md` |
|
||||||
| `ASSIMP_BIN` | - | 可选:Assimp 可执行文件。FBX/glTF 动作预处理需要;上传 `.zip` 模型包、或 `.pmx/.fbx` 单文件模型时必须能调用到,否则转换失败(422) |
|
| `ASSIMP_BIN` | `assimp` | Assimp 可执行文件(`install.sh` 会自动安装并解析出绝对路径写入此项)。`.pmx/.fbx` 模型转换与 FBX/glTF 动作预处理需要;缺失时上传会失败并给出安装命令,只上传 `.glb/.vrm` 不受影响 |
|
||||||
| `MODEL_CONVERT_FORMAT` | `glb` | 需要转换的模型(PMX/FBX)的交付格式:`glb`(两个客户端都原生加载)或 `vrm`。`vrm` = 在 GLB 之上补 `VRMC_vrm` 扩展(humanoid 骨骼 / 表情语义),humanoid 骨骼映射不全时自动回退交付 GLB 并写进 `conversion_note`。产物一律用 `assimp info` 回读校验 |
|
| `MODEL_CONVERT_FORMAT` | `glb` | 需要转换的模型(PMX/FBX)的交付格式:`glb`(两个客户端都原生加载)或 `vrm`。`vrm` = 在 GLB 之上补 `VRMC_vrm` 扩展(humanoid 骨骼 / 表情语义),humanoid 骨骼映射不全时自动回退交付 GLB 并写进 `conversion_note`。产物一律用 `assimp info` 回读校验 |
|
||||||
| `MODEL_CONVERT_PMX` | `Hatsune Miku.pmx` | 压缩包内优先选用的 PMX 文件名(大小写不敏感);找不到时按「格式优先级 -> 目录最浅 -> 文件最大」挑选 |
|
| `MODEL_CONVERT_PMX` | `"Hatsune Miku.pmx"` | 压缩包内优先选用的 PMX 文件名(大小写不敏感);找不到时按「格式优先级 -> 目录最浅 -> 文件最大」挑选 |
|
||||||
| `MODEL_CONVERT_TIMEOUT_MS` | `180000` | 单次转换超时(毫秒) |
|
| `MODEL_CONVERT_TIMEOUT_MS` | `180000` | 单次转换超时(毫秒) |
|
||||||
| `DEFAULT_MODEL_ID` | - | 可选:显式指定默认模型 id;不设置时按源码种子 `src/config/default-model.ts` 匹配,再回落到 VRM 优先规则 |
|
| `DEFAULT_MODEL_ID` | - | 可选:显式指定默认模型 id;不设置时按源码种子 `src/config/default-model.ts` 匹配,再回落到 VRM 优先规则 |
|
||||||
| `CONTRACTS_DIR` | - | 可选:契约目录,设置后 `/health` 反映实时契约版本(原生部署默认指向 `/opt/opendance/contracts`) |
|
| `CONTRACTS_DIR` | - | 可选:契约目录,设置后 `/health` 反映实时契约版本(原生部署默认指向 `/opt/opendance/contracts`) |
|
||||||
|
|
||||||
端口配置非法(非 1..65535 整数)时,生产环境启动会直接中止;`ADMIN_PORT` 设为与 `PORT` 相同只打印提示,不中止。
|
端口配置非法(非 1..65535 整数)时,生产环境启动会直接中止;`ADMIN_PORT` 设为与 `PORT` 相同只打印提示,不中止。
|
||||||
|
|
||||||
|
**`.env` 写法约定**:`install.sh` / `ctl.sh` 用 `set -a; . deploy/.env` 载入配置,shell 会**真的执行**这个文件,因此
|
||||||
|
|
||||||
|
- 普通值不加引号:`PORT=3000`、`DB_HOST=127.0.0.1`;
|
||||||
|
- 值里含**空格或 shell 元字符**(`& | ; $ \` < > ( )` 等)时**必须加引号**,例如 `MODEL_CONVERT_PMX="Hatsune Miku.pmx"`;
|
||||||
|
- 双引号内不要用 `$(...)` 或反引号(会被真的执行),需要字面量时用单引号:`KEY='a b'`。
|
||||||
|
|
||||||
|
两个脚本在 source 之前都会先跑 `deploy/env-lib.sh` 的语法预检,不安全写法会直接指出行号、原文与改法。
|
||||||
|
|
||||||
## 主要 API
|
## 主要 API
|
||||||
|
|
||||||
| 方法 | 路径 | 说明 |
|
| 方法 | 路径 | 说明 |
|
||||||
|
|||||||
+56
-14
@@ -1,5 +1,5 @@
|
|||||||
================================================================
|
================================================================
|
||||||
OpenDance Studio -- Web 管理服务端 v0.2.0 使用说明
|
OpenDance Studio -- Web 管理服务端 v0.2.2 使用说明
|
||||||
================================================================
|
================================================================
|
||||||
|
|
||||||
本服务端是 OpenDance Studio 三端中的第一端, 负责管理歌曲、VRM 模型与
|
本服务端是 OpenDance Studio 三端中的第一端, 负责管理歌曲、VRM 模型与
|
||||||
@@ -8,6 +8,31 @@ OpenDance Studio -- Web 管理服务端 v0.2.0 使用说明
|
|||||||
重要: 本服务端 不部署、不管理 MySQL。数据库为部署方提供的现有实例,
|
重要: 本服务端 不部署、不管理 MySQL。数据库为部署方提供的现有实例,
|
||||||
连接信息通过 .env 注入。
|
连接信息通过 .env 注入。
|
||||||
|
|
||||||
|
v0.2.2 修订
|
||||||
|
1. 修复 Assimp 缺失时的报错与部署体验: 服务器没装 Assimp 时, 上传 .pmx/.fbx
|
||||||
|
(或含它们的压缩包)只得到两条 导出失败(ENOENT): spawn assimp ENOENT,
|
||||||
|
看不出缺什么、怎么装。
|
||||||
|
2. 转换前先定位 Assimp(src/common/assimp.ts): 按 ASSIMP_BIN -> PATH ->
|
||||||
|
/usr/bin、/usr/local/bin 等常见目录查找, 找不到就一次性给出各发行版安装
|
||||||
|
命令、查过的路径与替代办法(只传 .glb/.vrm 不需要它), 不再打两条 ENOENT。
|
||||||
|
3. install.sh 新增 Assimp 检查与自动安装(deploy/assimp-lib.sh): 按发行版调用
|
||||||
|
apt-get / dnf / yum / zypper / apk / pacman; 装在非常规目录时自动把绝对
|
||||||
|
路径写进 deploy/.env 的 ASSIMP_BIN; 装不上只告警不中止(可用
|
||||||
|
SKIP_ASSIMP_INSTALL=1 跳过)。
|
||||||
|
4. deploy/check-access.sh 自检增加 Assimp 一行; 管理端「概览 -> 服务健康」
|
||||||
|
显示 Assimp 状态, 不可用时给出提示。
|
||||||
|
5. 新增 13 项测试(test/assimp-locate.spec.ts)。
|
||||||
|
|
||||||
|
v0.2.1 修订
|
||||||
|
1. 修复部署失败: 模板里的 MODEL_CONVERT_PMX=Hatsune Miku.pmx 值含空格却
|
||||||
|
没加引号, install.sh 用 `set -a; . deploy/.env` 载入时把 Miku.pmx 当命令
|
||||||
|
执行, 报 command not found(退出码 127); 模板已改为带引号写法。
|
||||||
|
2. 新增 .env 语法预检(deploy/env-lib.sh): install.sh 与 ctl.sh 在 source 之前
|
||||||
|
先检查, 直接给出哪一行、原文与改法, 不再出现看不懂的 127。
|
||||||
|
3. 失败提示带上出错文件名(.env 被 source 时行号属于 .env)。
|
||||||
|
4. 新增 12 项回归测试(web-server/test/env-file.spec.ts)。
|
||||||
|
约定: 值里含空格或 shell 元字符时必须加引号(双引号内不要用 $( ) 或反引号)。
|
||||||
|
|
||||||
--
|
--
|
||||||
一、部署到 Linux 服务器(业务服务, 不含反向代理)
|
一、部署到 Linux 服务器(业务服务, 不含反向代理)
|
||||||
--
|
--
|
||||||
@@ -20,11 +45,11 @@ OpenDance Studio -- Web 管理服务端 v0.2.0 使用说明
|
|||||||
2. 准备一个现有的 MySQL / MariaDB 实例, 并建好库与账号(见下方"前置要求")
|
2. 准备一个现有的 MySQL / MariaDB 实例, 并建好库与账号(见下方"前置要求")
|
||||||
本项目不会创建数据库本身
|
本项目不会创建数据库本身
|
||||||
3. 取得发布包并校验(地址用你们自己的制品库替换)
|
3. 取得发布包并校验(地址用你们自己的制品库替换)
|
||||||
curl -LO https://<制品库地址>/opendance-web-v0.2.0.tar.gz
|
curl -LO https://<制品库地址>/opendance-web-v0.2.2.tar.gz
|
||||||
curl -LO https://<制品库地址>/SHA256SUMS
|
curl -LO https://<制品库地址>/SHA256SUMS
|
||||||
sha256sum -c SHA256SUMS # 期望输出 "OK"
|
sha256sum -c SHA256SUMS # 期望输出 "OK"
|
||||||
4. 解压并生成配置(交互式引导, 逐项问答, 口令不回显)
|
4. 解压并生成配置(交互式引导, 逐项问答, 口令不回显)
|
||||||
tar -xzf opendance-web-v0.2.0.tar.gz && cd opendance-web-v0.2.0
|
tar -xzf opendance-web-v0.2.2.tar.gz && cd opendance-web-v0.2.2
|
||||||
bash deploy/init-env.sh
|
bash deploy/init-env.sh
|
||||||
5. 安装(建用户与目录 -> 装依赖 -> 迁移 -> 注册系统服务 -> 等健康检查)
|
5. 安装(建用户与目录 -> 装依赖 -> 迁移 -> 注册系统服务 -> 等健康检查)
|
||||||
bash deploy/install.sh
|
bash deploy/install.sh
|
||||||
@@ -66,6 +91,9 @@ OpenDance Studio -- Web 管理服务端 v0.2.0 使用说明
|
|||||||
- Node.js 22 或更高版本
|
- Node.js 22 或更高版本
|
||||||
- 进程管理: systemd / OpenRC / SysVinit 均可; 三者都没有也能装
|
- 进程管理: systemd / OpenRC / SysVinit 均可; 三者都没有也能装
|
||||||
(自动降级为 nohup 后台进程 + PID 文件 + crontab @reboot 开机自启)
|
(自动降级为 nohup 后台进程 + PID 文件 + crontab @reboot 开机自启)
|
||||||
|
- Assimp 命令行工具(可选但推荐): .pmx/.fbx 模型转换与 FBX/glTF 动作预处理
|
||||||
|
需要它; install.sh 会自动尝试安装(apt-get / dnf / yum / zypper / apk /
|
||||||
|
pacman), 装不上只告警不中止。只上传 .glb/.vrm 模型与 .bvh/.vmd 动作则不需要
|
||||||
- 反向代理: 由另外的服务提供, 本项目不要求、也不安装
|
- 反向代理: 由另外的服务提供, 本项目不要求、也不安装
|
||||||
- 一个可连通的现有 MySQL / MariaDB 实例, 并已创建数据库与账号:
|
- 一个可连通的现有 MySQL / MariaDB 实例, 并已创建数据库与账号:
|
||||||
|
|
||||||
@@ -79,8 +107,8 @@ OpenDance Studio -- Web 管理服务端 v0.2.0 使用说明
|
|||||||
(本项目不会创建数据库本身, 也不需要 GRANT OPTION / FILE / SUPER 等管理权限)
|
(本项目不会创建数据库本身, 也不需要 GRANT OPTION / FILE / SUPER 等管理权限)
|
||||||
|
|
||||||
部署步骤
|
部署步骤
|
||||||
tar -xzf opendance-web-v0.2.0.tar.gz
|
tar -xzf opendance-web-v0.2.2.tar.gz
|
||||||
cd opendance-web-v0.2.0
|
cd opendance-web-v0.2.2
|
||||||
bash deploy/init-env.sh # 首次启动引导: 逐项问答生成 deploy/.env(见下)
|
bash deploy/init-env.sh # 首次启动引导: 逐项问答生成 deploy/.env(见下)
|
||||||
bash deploy/install.sh # 已以 root 登录, 不需要 sudo
|
bash deploy/install.sh # 已以 root 登录, 不需要 sudo
|
||||||
|
|
||||||
@@ -206,9 +234,14 @@ deploy/.env 初始化引导(deploy/init-env.sh)
|
|||||||
对外 IP 自测、80/443 有无反代、防火墙放行情况, 并给出修复命令。
|
对外 IP 自测、80/443 有无反代、防火墙放行情况, 并给出修复命令。
|
||||||
- 管理页面打开是 404
|
- 管理页面打开是 404
|
||||||
说明访问的是软件 API 端口(默认 3000); 管理页面在管理端端口(默认 3001)。
|
说明访问的是软件 API 端口(默认 3000); 管理页面在管理端端口(默认 3001)。
|
||||||
- 上传 .zip 模型包报 422 且提示 Assimp 不可用
|
- 上传 .zip / .pmx / .fbx 报转换失败(ENOENT / Assimp 不可用)
|
||||||
PMX/FBX 转换依赖 Assimp: apt-get install -y assimp-utils libassimp6;
|
PMX/FBX 转换依赖外部 Assimp: apt-get install -y assimp-utils
|
||||||
只上传 .glb / .vrm 则不需要它。
|
(RHEL 系 dnf install -y assimp; install.sh 现在会尝试自动安装)。
|
||||||
|
装好后不需要重启服务; 若不在服务 PATH 中, 在 deploy/.env 里把 ASSIMP_BIN
|
||||||
|
设为绝对路径。只上传 .glb / .vrm 则不需要它。
|
||||||
|
- 安装时报 command not found / 退出码 127, 且提示指向 deploy/.env 某一行
|
||||||
|
该行的值含空格或 shell 元字符却没加引号, 被 shell 当成命令执行了。按预检
|
||||||
|
提示给这个值加引号(如 MODEL_CONVERT_PMX="Hatsune Miku.pmx")后重跑。
|
||||||
- 模型审核界面显示"未分析 / 无预览图"
|
- 模型审核界面显示"未分析 / 无预览图"
|
||||||
该模型是升级前入库的: 调 POST /api/models/<id>/reanalyze, 或批量跑
|
该模型是升级前入库的: 调 POST /api/models/<id>/reanalyze, 或批量跑
|
||||||
node scripts/reanalyze-models.mjs --url http://127.0.0.1:3000。
|
node scripts/reanalyze-models.mjs --url http://127.0.0.1:3000。
|
||||||
@@ -236,10 +269,11 @@ deploy/.env 初始化引导(deploy/init-env.sh)
|
|||||||
cd web-server
|
cd web-server
|
||||||
npm run contracts:check # 契约版本一致性
|
npm run contracts:check # 契约版本一致性
|
||||||
npm run typecheck # TypeScript 严格检查
|
npm run typecheck # TypeScript 严格检查
|
||||||
npm run test # 168 项单元测试 / 10 个文件(VMD 31、模型压缩包 24、
|
npm run test # 193 项单元测试 / 12 个文件(VMD 31、模型压缩包 24、
|
||||||
# 模型检查器 25、缩略图 8、骨骼过滤 8、
|
# 模型检查器 25、缩略图 8、骨骼过滤 8、
|
||||||
# 预处理 25、init-env 16、admin-port 16、
|
# 预处理 25、init-env 16、admin-port 16、
|
||||||
# access-log 9、VRM 检查器 6)
|
# access-log 9、VRM 检查器 6、.env 预检 12、
|
||||||
|
# Assimp 定位与安装 13)
|
||||||
npm run build # 生产构建
|
npm run build # 生产构建
|
||||||
npm run start:prod & # 启动
|
npm run start:prod & # 启动
|
||||||
npm run test:smoke # 57 项端到端冒烟(需要数据库可连通)
|
npm run test:smoke # 57 项端到端冒烟(需要数据库可连通)
|
||||||
@@ -270,6 +304,13 @@ deploy/.env 初始化引导(deploy/init-env.sh)
|
|||||||
ADMIN_HOST 管理端监听地址(可选, 默认跟随 HOST;HOST 未设置时同样
|
ADMIN_HOST 管理端监听地址(可选, 默认跟随 HOST;HOST 未设置时同样
|
||||||
回落 0.0.0.0)。需要接口对外、管理端只对本机时设为
|
回落 0.0.0.0)。需要接口对外、管理端只对本机时设为
|
||||||
127.0.0.1
|
127.0.0.1
|
||||||
|
.env 写法约定: install.sh / ctl.sh 用 `set -a; . deploy/.env` 载入配置, shell 会
|
||||||
|
真的执行这个文件, 因此普通值不加引号(PORT=3000), 值里含空格或 shell 元字符
|
||||||
|
(& | ; $ ` < > ( ) 等)时必须加引号, 例如 MODEL_CONVERT_PMX="Hatsune Miku.pmx";
|
||||||
|
双引号内不要用 $( ) 或反引号(会被真的执行), 需要字面量时用单引号 KEY='a b'。
|
||||||
|
两个脚本在 source 之前都会先跑 deploy/env-lib.sh 的语法预检, 不安全写法会直接
|
||||||
|
指出行号、原文与改法。
|
||||||
|
|
||||||
端口配置非法(非 1..65535 整数)时, 生产环境启动会直接中止;
|
端口配置非法(非 1..65535 整数)时, 生产环境启动会直接中止;
|
||||||
ADMIN_PORT 设为与 PORT 相同只打印提示, 不中止。
|
ADMIN_PORT 设为与 PORT 相同只打印提示, 不中止。
|
||||||
ADMIN_DIR 管理端静态站点目录(默认 ../admin, 即 /opt/opendance/admin)
|
ADMIN_DIR 管理端静态站点目录(默认 ../admin, 即 /opt/opendance/admin)
|
||||||
@@ -278,15 +319,16 @@ deploy/.env 初始化引导(deploy/init-env.sh)
|
|||||||
* 反向代理层的同名限制必须不小于此值, 否则大模型上传
|
* 反向代理层的同名限制必须不小于此值, 否则大模型上传
|
||||||
会在代理层被拒(nginx client_max_body_size /
|
会在代理层被拒(nginx client_max_body_size /
|
||||||
IIS requestLimits), 详见 deploy/proxy/README.md
|
IIS requestLimits), 详见 deploy/proxy/README.md
|
||||||
ASSIMP_BIN 可选: Assimp 可执行文件, FBX/glTF 动作预处理需要;
|
ASSIMP_BIN Assimp 可执行文件(install.sh 会自动安装并把解析出的绝对
|
||||||
上传 .zip 模型包、或 .pmx/.fbx 单文件模型时必须能调用到,
|
路径写入此项)。.pmx/.fbx 模型转换与 FBX/glTF 动作预处理
|
||||||
否则转换失败(422)
|
需要; 缺失时上传会失败并给出安装命令, 只上传 .glb/.vrm 与
|
||||||
|
.bvh/.vmd 动作不受影响
|
||||||
MODEL_CONVERT_FORMAT 需要转换的模型(PMX/FBX)的交付格式:
|
MODEL_CONVERT_FORMAT 需要转换的模型(PMX/FBX)的交付格式:
|
||||||
glb(默认, 两个客户端都原生加载)| vrm
|
glb(默认, 两个客户端都原生加载)| vrm
|
||||||
vrm = 在 GLB 之上补 VRMC_vrm 扩展(humanoid 骨骼 / 表情语义),
|
vrm = 在 GLB 之上补 VRMC_vrm 扩展(humanoid 骨骼 / 表情语义),
|
||||||
humanoid 骨骼映射不全时自动回退交付 GLB 并写进 conversion_note。
|
humanoid 骨骼映射不全时自动回退交付 GLB 并写进 conversion_note。
|
||||||
产物一律用 `assimp info` 回读校验
|
产物一律用 `assimp info` 回读校验
|
||||||
MODEL_CONVERT_PMX 压缩包内优先选用的 PMX 文件名(默认 Hatsune Miku.pmx,
|
MODEL_CONVERT_PMX 压缩包内优先选用的 PMX 文件名(默认 "Hatsune Miku.pmx",
|
||||||
大小写不敏感); 找不到时按「格式优先级 -> 目录最浅 ->
|
大小写不敏感); 找不到时按「格式优先级 -> 目录最浅 ->
|
||||||
文件最大」挑选
|
文件最大」挑选
|
||||||
MODEL_CONVERT_TIMEOUT_MS
|
MODEL_CONVERT_TIMEOUT_MS
|
||||||
|
|||||||
+5
-3
@@ -24,10 +24,10 @@ HOST=0.0.0.0
|
|||||||
ADMIN_DIR=/opt/opendance/admin
|
ADMIN_DIR=/opt/opendance/admin
|
||||||
|
|
||||||
# ---- 现有 MySQL / MariaDB 实例(本项目不安装、不管理数据库)----
|
# ---- 现有 MySQL / MariaDB 实例(本项目不安装、不管理数据库)----
|
||||||
DB_HOST=<existing-mysql-host>
|
DB_HOST='<existing-mysql-host>'
|
||||||
DB_PORT=3306
|
DB_PORT=3306
|
||||||
DB_USER=opendance_app
|
DB_USER=opendance_app
|
||||||
DB_PASS=<数据库口令>
|
DB_PASS='<数据库口令>'
|
||||||
DB_NAME=opendance
|
DB_NAME=opendance
|
||||||
# 生产环境必须为 false,表结构一律走 TypeORM migration
|
# 生产环境必须为 false,表结构一律走 TypeORM migration
|
||||||
DB_SYNCHRONIZE=false
|
DB_SYNCHRONIZE=false
|
||||||
@@ -50,7 +50,9 @@ ASSIMP_BIN=assimp
|
|||||||
# humanoid 骨骼名映射不全时会自动回退交付 GLB 并写进 conversion_note
|
# humanoid 骨骼名映射不全时会自动回退交付 GLB 并写进 conversion_note
|
||||||
MODEL_CONVERT_FORMAT=glb
|
MODEL_CONVERT_FORMAT=glb
|
||||||
# 压缩包里优先选用的 PMX 文件名(大小写不敏感);找不到时按"格式优先级 -> 目录最浅 -> 文件最大"挑
|
# 压缩包里优先选用的 PMX 文件名(大小写不敏感);找不到时按"格式优先级 -> 目录最浅 -> 文件最大"挑
|
||||||
MODEL_CONVERT_PMX=Hatsune Miku.pmx
|
# 值里含空格或 shell 元字符时必须用引号包起来(install.sh 会用
|
||||||
|
# `set -a; . deploy/.env` 真的执行本文件;不加引号会把 "Miku.pmx" 当命令)
|
||||||
|
MODEL_CONVERT_PMX="Hatsune Miku.pmx"
|
||||||
# 单次转换超时(毫秒)
|
# 单次转换超时(毫秒)
|
||||||
MODEL_CONVERT_TIMEOUT_MS=180000
|
MODEL_CONVERT_TIMEOUT_MS=180000
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# ============================================================
|
||||||
|
# OpenDance Studio Web API —— 外部依赖 Assimp 的定位与安装
|
||||||
|
#
|
||||||
|
# 本文件被 install.sh 引用(不要单独执行)。
|
||||||
|
#
|
||||||
|
# Assimp 是**外部**命令行工具(BSD-3-Clause),不在 Node 依赖里。
|
||||||
|
# 它只影响两件事:
|
||||||
|
# * 上传 .pmx / .fbx(或含它们的压缩包)时的服务端转换;
|
||||||
|
# * FBX / glTF 动作的预处理。
|
||||||
|
# 直接上传 .glb / .vrm 模型,或 .bvh / .vmd / 关键点 JSON 动作,都不需要它。
|
||||||
|
# 因此这里「装不上」不叫失败,但必须给出结论与可复制的安装命令。
|
||||||
|
# ============================================================
|
||||||
|
|
||||||
|
# 当前发行版对应的安装命令(用于提示)
|
||||||
|
# 注意:只装 assimp-utils(它会按发行版自动带上对应版本的 libassimp5/6),
|
||||||
|
# 不写死库名 —— Debian 11 / Ubuntu 22.04 是 libassimp5,Debian 12+ 才是 libassimp6。
|
||||||
|
opendance_assimp_install_cmd() {
|
||||||
|
if command -v apt-get >/dev/null 2>&1; then
|
||||||
|
printf 'apt-get update && apt-get install -y assimp-utils'
|
||||||
|
elif command -v dnf >/dev/null 2>&1; then
|
||||||
|
printf 'dnf install -y assimp'
|
||||||
|
elif command -v yum >/dev/null 2>&1; then
|
||||||
|
printf 'yum install -y assimp'
|
||||||
|
elif command -v zypper >/dev/null 2>&1; then
|
||||||
|
printf 'zypper --non-interactive install assimp'
|
||||||
|
elif command -v apk >/dev/null 2>&1; then
|
||||||
|
printf 'apk add --no-cache assimp'
|
||||||
|
elif command -v pacman >/dev/null 2>&1; then
|
||||||
|
printf 'pacman -S --noconfirm assimp'
|
||||||
|
else
|
||||||
|
printf '用发行版包管理器安装 assimp 命令行工具'
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# 真正执行安装(静默细节,成功返回 0)
|
||||||
|
opendance_assimp_install() {
|
||||||
|
if command -v apt-get >/dev/null 2>&1; then
|
||||||
|
DEBIAN_FRONTEND=noninteractive apt-get update -qq &&
|
||||||
|
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq assimp-utils
|
||||||
|
elif command -v dnf >/dev/null 2>&1; then dnf install -y -q assimp
|
||||||
|
elif command -v yum >/dev/null 2>&1; then yum install -y -q assimp
|
||||||
|
elif command -v zypper >/dev/null 2>&1; then zypper --non-interactive install assimp
|
||||||
|
elif command -v apk >/dev/null 2>&1; then apk add --no-cache assimp
|
||||||
|
elif command -v pacman >/dev/null 2>&1; then pacman -S --noconfirm assimp
|
||||||
|
else return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# 解析 Assimp 的实际路径:ASSIMP_BIN -> PATH -> 常见系统目录
|
||||||
|
# 找到时把绝对路径打印到 stdout 并返回 0;否则返回 1(stdout 为空)
|
||||||
|
opendance_assimp_resolve() {
|
||||||
|
local bin="${ASSIMP_BIN:-assimp}" dir candidate
|
||||||
|
# 必须同时是**文件**且可执行:只判 -x 会把目录(例如 ASSIMP_BIN=/usr/bin/)当成可执行文件
|
||||||
|
if [ -f "$bin" ] && [ -x "$bin" ]; then printf '%s' "$bin"; return 0; fi
|
||||||
|
if command -v "$bin" >/dev/null 2>&1; then command -v "$bin"; return 0; fi
|
||||||
|
for dir in /usr/bin /usr/local/bin /usr/sbin /usr/local/sbin /snap/bin; do
|
||||||
|
candidate="$dir/${bin##*/}" # 用参数展开代替 basename: PATH 极窄时 basename 可能不可用
|
||||||
|
if [ -f "$candidate" ] && [ -x "$candidate" ]; then printf '%s' "$candidate"; return 0; fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# 该目录是否已在服务的默认 PATH 中(否 -> 需要把绝对路径写进 .env)
|
||||||
|
opendance_assimp_needs_env_path() {
|
||||||
|
case "$(dirname "${1:-}")" in
|
||||||
|
/bin|/usr/bin|/usr/local/bin|/sbin|/usr/sbin) return 1 ;;
|
||||||
|
*) return 0 ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
@@ -16,6 +16,7 @@ APP_DIR="${1:-/opt/opendance}"
|
|||||||
PORT=""
|
PORT=""
|
||||||
HOST_CFG=""
|
HOST_CFG=""
|
||||||
PROBLEMS=0
|
PROBLEMS=0
|
||||||
|
ASSIMP_MISSING=0
|
||||||
|
|
||||||
c_red() { printf '\033[31m%s\033[0m\n' "$*"; }
|
c_red() { printf '\033[31m%s\033[0m\n' "$*"; }
|
||||||
c_grn() { printf '\033[32m%s\033[0m\n' "$*"; }
|
c_grn() { printf '\033[32m%s\033[0m\n' "$*"; }
|
||||||
@@ -216,9 +217,33 @@ if [ "$FW_FOUND" -eq 0 ]; then
|
|||||||
info "注意:云服务器还需检查控制台的「安全组 / 网络 ACL」是否放行 $PORT"
|
info "注意:云服务器还需检查控制台的「安全组 / 网络 ACL」是否放行 $PORT"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# ---------- 6.5 可选依赖 Assimp ----------
|
||||||
|
title "可选依赖 Assimp(.pmx/.fbx 模型转换、FBX/glTF 动作预处理)"
|
||||||
|
if [ -f "$(dirname "$0")/assimp-lib.sh" ]; then
|
||||||
|
# shellcheck source=deploy/assimp-lib.sh
|
||||||
|
. "$(dirname "$0")/assimp-lib.sh"
|
||||||
|
ASSIMP_PATH="$(opendance_assimp_resolve || true)"
|
||||||
|
if [ -n "$ASSIMP_PATH" ]; then
|
||||||
|
ok "Assimp 可用:$ASSIMP_PATH($("$ASSIMP_PATH" version 2>/dev/null | head -1))"
|
||||||
|
else
|
||||||
|
warn "未安装 Assimp:上传 .pmx / .fbx(或含它们的压缩包)会报转换失败"
|
||||||
|
info "安装:$(opendance_assimp_install_cmd)"
|
||||||
|
info "只上传 .glb / .vrm 模型与 .bvh / .vmd 动作则不受影响"
|
||||||
|
ASSIMP_MISSING=1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "未找到 deploy/assimp-lib.sh,跳过 Assimp 检查"
|
||||||
|
fi
|
||||||
|
|
||||||
# ---------- 7. 结论 ----------
|
# ---------- 7. 结论 ----------
|
||||||
title "结论"
|
title "结论"
|
||||||
|
|
||||||
|
if [ "${ASSIMP_MISSING:-0}" = "1" ]; then
|
||||||
|
c_yel " 提示:未安装 Assimp,.pmx / .fbx 模型转换与 FBX / glTF 动作预处理不可用(与访问无关)。"
|
||||||
|
echo " 安装:$(opendance_assimp_install_cmd 2>/dev/null || echo '用发行版包管理器安装 assimp')"
|
||||||
|
echo
|
||||||
|
fi
|
||||||
|
|
||||||
if [ "$PROBLEMS" -eq 0 ]; then
|
if [ "$PROBLEMS" -eq 0 ]; then
|
||||||
c_grn " 未发现本机侧问题。"
|
c_grn " 未发现本机侧问题。"
|
||||||
echo " 若仍访问不了,按顺序排查:"
|
echo " 若仍访问不了,按顺序排查:"
|
||||||
|
|||||||
+8
-1
@@ -13,6 +13,7 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
set -uo pipefail
|
set -uo pipefail
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" 2>/dev/null && pwd)"
|
||||||
APP_DIR="${APP_DIR:-/opt/opendance}"
|
APP_DIR="${APP_DIR:-/opt/opendance}"
|
||||||
SERVICE_USER="${SERVICE_USER:-opendance}"
|
SERVICE_USER="${SERVICE_USER:-opendance}"
|
||||||
LOG_FILE="${LOG_FILE:-/var/log/opendance-api.log}"
|
LOG_FILE="${LOG_FILE:-/var/log/opendance-api.log}"
|
||||||
@@ -95,8 +96,14 @@ start() {
|
|||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# 载入部署环境变量
|
# 载入部署环境变量(先做语法预检:.env 会被 shell 真的执行)
|
||||||
if [ -f "$APP_DIR/deploy/.env" ]; then
|
if [ -f "$APP_DIR/deploy/.env" ]; then
|
||||||
|
if [ -f "$SCRIPT_DIR/env-lib.sh" ]; then
|
||||||
|
# shellcheck source=deploy/env-lib.sh
|
||||||
|
. "$SCRIPT_DIR/env-lib.sh"
|
||||||
|
opendance_validate_env_file "$APP_DIR/deploy/.env" \
|
||||||
|
|| die "$APP_DIR/deploy/.env 语法预检未通过(见上):给对应行的值加上引号后重试。"
|
||||||
|
fi
|
||||||
set -a; . "$APP_DIR/deploy/.env"; set +a
|
set -a; . "$APP_DIR/deploy/.env"; set +a
|
||||||
else
|
else
|
||||||
die "缺少 $APP_DIR/deploy/.env"
|
die "缺少 $APP_DIR/deploy/.env"
|
||||||
|
|||||||
@@ -0,0 +1,126 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# ============================================================
|
||||||
|
# OpenDance Studio Web API —— deploy/.env 语法预检
|
||||||
|
#
|
||||||
|
# 本文件被 install.sh 与 ctl.sh 引用(不要单独执行)。
|
||||||
|
#
|
||||||
|
# 为什么需要:
|
||||||
|
# 两个脚本都用 `set -a; . deploy/.env` 载入配置,shell 会**真的执行**
|
||||||
|
# 这个文件。若某个值含空格或 shell 元字符却没加引号,这一行会被切成
|
||||||
|
# 「赋值 + 命令」,报错形如:
|
||||||
|
# ./deploy/.env: line 53: Miku.pmx: command not found
|
||||||
|
# 退出码 127,而且提示里看不出是哪个文件、哪一行、该怎么改。
|
||||||
|
# 载入前先做一次静态检查,给出带行号与修复建议的中文提示。
|
||||||
|
#
|
||||||
|
# 约定(与 init-env.sh 一致):
|
||||||
|
# 普通值不加引号(如 PORT=3000);值里含空格或 shell 元字符时用引号包起来,
|
||||||
|
# 例如 MODEL_CONVERT_PMX="Hatsune Miku.pmx"。双引号内不要用 $(...) 或反引号
|
||||||
|
# —— 它们在载入时会被真正执行。单引号是字面量,最安全。
|
||||||
|
# ============================================================
|
||||||
|
|
||||||
|
# 裸值(未加引号)是否可以被 `set -a; . file` 安全载入
|
||||||
|
# 赋值语句里的裸值不会做通配展开,所以 * ? [ ] { } ! % + , - . : / @ = 都安全;
|
||||||
|
# 真正会破坏解析的是:空白、& | ; $ ` < > ( ) \ 以及引号本身、行首的 ~
|
||||||
|
opendance_env_value_is_safe_unquoted() {
|
||||||
|
local v="${1:-}"
|
||||||
|
[ -z "$v" ] && return 0
|
||||||
|
case "$v" in
|
||||||
|
*[[:space:]]*|*'&'*|*'|'*|*';'*|*'$'*|*'`'*|*'<'*|*'>'*|*'('*|*')'*|*'\'*|*'"'*|*"'"*) return 1 ;;
|
||||||
|
'~'*) return 1 ;;
|
||||||
|
esac
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# 值本身是否是安全的写法(空值 / 加引号 / 裸值但字符安全)
|
||||||
|
# 允许「引号 + 行尾注释」的写法,例如 DB_HOST="127.0.0.1" # 本机
|
||||||
|
opendance_env_value_is_safe() {
|
||||||
|
local v="${1:-}" inner="" rest=""
|
||||||
|
case "$v" in
|
||||||
|
'') return 0 ;;
|
||||||
|
\"*)
|
||||||
|
case "$v" in *\"*) ;; *) return 1 ;; esac # 结束引号必须在
|
||||||
|
inner="${v#\"}"; inner="${inner%%\"*}" # 引号内的内容
|
||||||
|
case "$inner" in *'$('*|*'`'*) return 1 ;; esac # 双引号内会真的执行
|
||||||
|
rest="${v#\"}"; rest="${rest#*\"}" # 结束引号之后的内容
|
||||||
|
case "$rest" in
|
||||||
|
''|[[:space:]]|[[:space:]]*|[[:space:]]*'#'*) return 0 ;;
|
||||||
|
*) return 1 ;;
|
||||||
|
esac ;;
|
||||||
|
\'*)
|
||||||
|
case "$v" in *\'*) ;; *) return 1 ;; esac
|
||||||
|
rest="${v#\'}"; rest="${rest#*\'}"
|
||||||
|
case "$rest" in
|
||||||
|
''|[[:space:]]|[[:space:]]*|[[:space:]]*'#'*) return 0 ;;
|
||||||
|
*) return 1 ;;
|
||||||
|
esac ;;
|
||||||
|
*) opendance_env_value_is_safe_unquoted "$v" ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# 校验一个 .env 文件:opendance_validate_env_file <文件路径>
|
||||||
|
# 通过返回 0;发现不安全写法返回 1(问题行与其改法已打印到 stderr)
|
||||||
|
opendance_validate_env_file() {
|
||||||
|
local file="${1:-}" lineno=0 bad=0 line key value reason inner
|
||||||
|
if [ ! -f "$file" ]; then
|
||||||
|
printf '[env] 找不到配置文件:%s\n' "$file" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
while IFS= read -r line || [ -n "$line" ]; do
|
||||||
|
lineno=$((lineno + 1))
|
||||||
|
line="${line%$'\r'}" # 兼容 CRLF
|
||||||
|
case "$line" in ''|'#'*) continue ;; esac
|
||||||
|
reason=""
|
||||||
|
case "$line" in
|
||||||
|
[A-Za-z_]*=*) ;;
|
||||||
|
*) reason="不是「键=值」形式(载入时会被当成命令执行)" ;;
|
||||||
|
esac
|
||||||
|
if [ -z "$reason" ]; then
|
||||||
|
key="${line%%=*}"
|
||||||
|
value="${line#*=}"
|
||||||
|
case "$key" in
|
||||||
|
*[!A-Za-z0-9_]*) reason="键名含非法字符" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
if [ -z "$reason" ] && ! opendance_env_value_is_safe "$value"; then
|
||||||
|
case "$value" in
|
||||||
|
\"*)
|
||||||
|
inner="${value#\"}"
|
||||||
|
case "$inner" in
|
||||||
|
*\"*) reason="引号写法不安全:引号后有其它内容,或引号内用了 \$( ) / 反引号(载入时会真的执行)" ;;
|
||||||
|
*) reason="双引号未闭合" ;;
|
||||||
|
esac ;;
|
||||||
|
\'*)
|
||||||
|
inner="${value#\'}"
|
||||||
|
case "$inner" in
|
||||||
|
*\'*) reason="单引号后还有其它内容,请把整个值放进引号" ;;
|
||||||
|
*) reason="单引号未闭合" ;;
|
||||||
|
esac ;;
|
||||||
|
*) reason="值含空格或 shell 元字符,却未加引号" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
if [ -n "$reason" ]; then
|
||||||
|
bad=$((bad + 1))
|
||||||
|
printf '\033[1;31m[env]\033[0m %s 第 %d 行写法不安全:%s\n' "$file" "$lineno" "$reason" >&2
|
||||||
|
printf ' %d | %s\n' "$lineno" "$line" >&2
|
||||||
|
case "$line" in
|
||||||
|
*'='*)
|
||||||
|
key="${line%%=*}"; value="${line#*=}"
|
||||||
|
case "$value" in
|
||||||
|
\"*|\'*)
|
||||||
|
printf ' 提示: 引号请成对、且把整个值包住; 单引号是字面量, 最安全。\n' >&2 ;;
|
||||||
|
*"'"*)
|
||||||
|
printf ' 提示: 值里同时有单引号与特殊字符, 请手工调整 - 单引号内不能再出现单引号。\n' >&2 ;;
|
||||||
|
*'$'*|*'`'*)
|
||||||
|
printf " 改法: %s='%s' 注意: 双引号里的 \$( ) 与反引号会被真的执行, 单引号才是字面量。\n" "$key" "$value" >&2 ;;
|
||||||
|
*)
|
||||||
|
printf ' 改法: %s="%s"\n' "$key" "$value" >&2 ;;
|
||||||
|
esac ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
done < "$file"
|
||||||
|
if [ "$bad" -gt 0 ]; then
|
||||||
|
printf '\033[1;31m[env]\033[0m %s 语法预检未通过:%d 行需要加引号(见上)。\n' "$file" "$bad" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
return 0
|
||||||
|
}
|
||||||
+45
-1
@@ -21,11 +21,20 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
# 失败时打印出错行号,避免只看到半截输出
|
# 失败时打印出错行号,避免只看到半截输出
|
||||||
trap 'printf "\033[1;31m[install]\033[0m 第 %d 行执行失败(退出码 %d)\n" "$LINENO" "$?" >&2' ERR
|
trap 'printf "\033[1;31m[install]\033[0m %s 第 %d 行执行失败(退出码 %d)\n" "${BASH_SOURCE[0]}" "$LINENO" "$?" >&2' ERR
|
||||||
|
|
||||||
SRC_DIR="$(cd "$(dirname "$0")/.." && pwd)"
|
SRC_DIR="$(cd "$(dirname "$0")/.." && pwd)"
|
||||||
cd "$SRC_DIR"
|
cd "$SRC_DIR"
|
||||||
|
|
||||||
|
# .env 语法预检(deploy/env-lib.sh):.env 是被 shell 真正 source 的文件,
|
||||||
|
# 未加引号且含空格的值会被当成命令执行,报错形如
|
||||||
|
# ./deploy/.env: line 53: Miku.pmx: command not found
|
||||||
|
# 载入前先查一遍,给出带行号与改法的中文提示。
|
||||||
|
# shellcheck source=deploy/env-lib.sh
|
||||||
|
. "$SRC_DIR/deploy/env-lib.sh"
|
||||||
|
# shellcheck source=deploy/assimp-lib.sh
|
||||||
|
. "$SRC_DIR/deploy/assimp-lib.sh"
|
||||||
|
|
||||||
APP_DIR="${APP_DIR:-/opt/opendance}"
|
APP_DIR="${APP_DIR:-/opt/opendance}"
|
||||||
SERVICE_USER="${SERVICE_USER:-opendance}"
|
SERVICE_USER="${SERVICE_USER:-opendance}"
|
||||||
STORAGE_DIR="${STORAGE_DIR:-/var/lib/opendance/storage}"
|
STORAGE_DIR="${STORAGE_DIR:-/var/lib/opendance/storage}"
|
||||||
@@ -125,6 +134,8 @@ if [ ! -f deploy/.env ]; then
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
opendance_validate_env_file "./deploy/.env" || die "deploy/.env 语法预检未通过(见上):按提示给对应行的值加上引号后重新执行。"
|
||||||
|
|
||||||
set -a
|
set -a
|
||||||
# shellcheck disable=SC1091
|
# shellcheck disable=SC1091
|
||||||
. ./deploy/.env
|
. ./deploy/.env
|
||||||
@@ -165,6 +176,38 @@ log "运行用户:$SERVICE_USER"
|
|||||||
log "上传目录:$STORAGE_DIR"
|
log "上传目录:$STORAGE_DIR"
|
||||||
log "目标数据库:${DB_HOST}:${DB_PORT:-3306}/${DB_NAME}(现有实例,本脚本不会创建或管理数据库)"
|
log "目标数据库:${DB_HOST}:${DB_PORT:-3306}/${DB_NAME}(现有实例,本脚本不会创建或管理数据库)"
|
||||||
|
|
||||||
|
# ---------- 0.5 可选外部依赖:Assimp ----------
|
||||||
|
# 逻辑与文案在 deploy/assimp-lib.sh(可单独测试):Assimp 是外部命令行工具
|
||||||
|
# (BSD-3-Clause),不在 Node 依赖里,只影响 .pmx/.fbx 模型转换与 FBX/glTF
|
||||||
|
# 动作预处理;装不上不中止安装,但必须当场给出结论与可复制的安装命令。
|
||||||
|
log "检查 Assimp(可选依赖:.pmx/.fbx 模型转换、FBX/glTF 动作预处理需要)"
|
||||||
|
ASSIMP_PATH="$(opendance_assimp_resolve || true)"
|
||||||
|
if [ -z "$ASSIMP_PATH" ] && [ "${SKIP_ASSIMP_INSTALL:-0}" != "1" ]; then
|
||||||
|
log "未找到 Assimp,尝试用系统包管理器安装:$(opendance_assimp_install_cmd)"
|
||||||
|
if opendance_assimp_install >/dev/null 2>&1; then
|
||||||
|
ASSIMP_PATH="$(opendance_assimp_resolve || true)"
|
||||||
|
else
|
||||||
|
warn "自动安装 Assimp 失败(离线环境或该发行版没有对应软件包)"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if [ -n "$ASSIMP_PATH" ]; then
|
||||||
|
log "Assimp:$ASSIMP_PATH($("$ASSIMP_PATH" version 2>/dev/null | head -1))"
|
||||||
|
if opendance_assimp_needs_env_path "$ASSIMP_PATH"; then
|
||||||
|
log "该目录不在服务默认 PATH 中,把 ASSIMP_BIN=\"$ASSIMP_PATH\" 写入 deploy/.env"
|
||||||
|
if grep -qE '^[[:space:]]*#?[[:space:]]*ASSIMP_BIN=' deploy/.env; then
|
||||||
|
sed -i "0,/^[[:space:]]*#\?[[:space:]]*ASSIMP_BIN=.*/s||ASSIMP_BIN=\"$ASSIMP_PATH\"|" deploy/.env
|
||||||
|
else
|
||||||
|
printf '\nASSIMP_BIN="%s"\n' "$ASSIMP_PATH" >> deploy/.env
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "未找到 Assimp:上传 .pmx / .fbx(或含它们的压缩包)会转换失败,FBX / glTF 动作也无法预处理。"
|
||||||
|
warn " 手动安装:$(opendance_assimp_install_cmd)"
|
||||||
|
warn " 只上传 .glb / .vrm 模型与 .bvh / .vmd / 关键点 JSON 动作则不受影响。"
|
||||||
|
warn " 已装好但不在 PATH?在 deploy/.env 里设置 ASSIMP_BIN 为绝对路径后重跑本脚本。"
|
||||||
|
warn " 也可用 SKIP_ASSIMP_INSTALL=1 跳过自动安装。"
|
||||||
|
fi
|
||||||
|
|
||||||
# ---------- 1. 系统用户与目录 ----------
|
# ---------- 1. 系统用户与目录 ----------
|
||||||
if ! id -u "$SERVICE_USER" >/dev/null 2>&1; then
|
if ! id -u "$SERVICE_USER" >/dev/null 2>&1; then
|
||||||
log "创建系统用户 $SERVICE_USER"
|
log "创建系统用户 $SERVICE_USER"
|
||||||
@@ -320,6 +363,7 @@ fi
|
|||||||
|
|
||||||
# ---------- 3. 数据库迁移 ----------
|
# ---------- 3. 数据库迁移 ----------
|
||||||
log "执行 TypeORM 迁移(不使用 DB_SYNCHRONIZE)"
|
log "执行 TypeORM 迁移(不使用 DB_SYNCHRONIZE)"
|
||||||
|
opendance_validate_env_file "$APP_DIR/deploy/.env" || die "$APP_DIR/deploy/.env 语法预检未通过(见上)"
|
||||||
set -a; . "$APP_DIR/deploy/.env"; set +a
|
set -a; . "$APP_DIR/deploy/.env"; set +a
|
||||||
cd "$APP_DIR/web-server"
|
cd "$APP_DIR/web-server"
|
||||||
as_service_user env \
|
as_service_user env \
|
||||||
|
|||||||
+2
-2
@@ -1,5 +1,5 @@
|
|||||||
project: opendance-web-server
|
project: opendance-web-server
|
||||||
version: 0.2.0
|
version: 0.2.2
|
||||||
repository: opendance-web
|
repository: opendance-web
|
||||||
default_branch: main
|
default_branch: main
|
||||||
contracts_version: 0.4.0
|
contracts_version: 0.4.0
|
||||||
@@ -60,7 +60,7 @@ tasks:
|
|||||||
status: done
|
status: done
|
||||||
|
|
||||||
deliverable:
|
deliverable:
|
||||||
artifact: opendance-web-v0.2.0.tar.gz
|
artifact: opendance-web-v0.2.2.tar.gz
|
||||||
packaging: Linux 业务服务(系统服务托管,双端口:软件 API + 管理端,不含 MySQL、不含反向代理、不使用 Docker)
|
packaging: Linux 业务服务(系统服务托管,双端口:软件 API + 管理端,不含 MySQL、不含反向代理、不使用 Docker)
|
||||||
includes:
|
includes:
|
||||||
- web-server/ # NestJS 源码 + 构建产物(含 BVH / VMD 内置解析、ZIP 读取与模型压缩包转换)
|
- web-server/ # NestJS 源码 + 构建产物(含 BVH / VMD 内置解析、ZIP 读取与模型压缩包转换)
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# ============================================================
|
# ============================================================
|
||||||
# 打包发布产物:opendance-web-v0.1.0.tar.gz
|
# 打包发布产物:opendance-web-v0.2.2.tar.gz
|
||||||
#
|
#
|
||||||
# 产物结构(Linux 业务服务部署,不使用 Docker、不部署反向代理):
|
# 产物结构(Linux 业务服务部署,不使用 Docker、不部署反向代理):
|
||||||
# web-server/ NestJS 源码 + 构建产物
|
# web-server/ NestJS 源码 + 构建产物
|
||||||
# admin/ React 管理端构建产物
|
# admin/ React 管理端构建产物
|
||||||
# deploy/ install.sh / ctl.sh / uninstall.sh / .env.example
|
# deploy/ install.sh / ctl.sh / uninstall.sh / .env.example
|
||||||
|
# env-lib.sh (.env 语法预检) / assimp-lib.sh (Assimp 定位安装)
|
||||||
|
# init-env.sh (.env 引导)
|
||||||
# systemd|openrc|initd / proxy(反代说明文档,仅文档不部署)
|
# systemd|openrc|initd / proxy(反代说明文档,仅文档不部署)
|
||||||
# contracts/ 当前版本契约快照
|
# contracts/ 当前版本契约快照
|
||||||
# THIRD_PARTY.md 开源项目声明
|
# THIRD_PARTY.md 开源项目声明
|
||||||
@@ -19,7 +21,7 @@ set -euo pipefail
|
|||||||
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||||||
cd "$REPO_ROOT"
|
cd "$REPO_ROOT"
|
||||||
|
|
||||||
VERSION="${1:-0.2.0}"
|
VERSION="${1:-0.2.2}"
|
||||||
NAME="opendance-web-v${VERSION}"
|
NAME="opendance-web-v${VERSION}"
|
||||||
OUT_DIR="$REPO_ROOT/dist-release"
|
OUT_DIR="$REPO_ROOT/dist-release"
|
||||||
STAGE="$OUT_DIR/$NAME"
|
STAGE="$OUT_DIR/$NAME"
|
||||||
@@ -130,6 +132,8 @@ for required in \
|
|||||||
"opendance-web-v${VERSION}/web-server/dist/models/vrm-writer.js" \
|
"opendance-web-v${VERSION}/web-server/dist/models/vrm-writer.js" \
|
||||||
"opendance-web-v${VERSION}/web-server/dist/models/gltf-packer.js" \
|
"opendance-web-v${VERSION}/web-server/dist/models/gltf-packer.js" \
|
||||||
"opendance-web-v${VERSION}/deploy/init-env.sh" \
|
"opendance-web-v${VERSION}/deploy/init-env.sh" \
|
||||||
|
"opendance-web-v${VERSION}/deploy/env-lib.sh" \
|
||||||
|
"opendance-web-v${VERSION}/deploy/assimp-lib.sh" \
|
||||||
"opendance-web-v${VERSION}/deploy/proxy/README.md" \
|
"opendance-web-v${VERSION}/deploy/proxy/README.md" \
|
||||||
"opendance-web-v${VERSION}/deploy/proxy/nginx.conf.example" \
|
"opendance-web-v${VERSION}/deploy/proxy/nginx.conf.example" \
|
||||||
"opendance-web-v${VERSION}/deploy/proxy/web.config.example" \
|
"opendance-web-v${VERSION}/deploy/proxy/web.config.example" \
|
||||||
|
|||||||
@@ -160,7 +160,7 @@ node scripts/import-default-model.mjs --write-source-only --model-id 22 --dry-ru
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd web-server
|
cd web-server
|
||||||
npx vitest run # 10 个文件 / 168 项通过
|
npx vitest run # 12 个文件 / 193 项通过
|
||||||
npm run test:smoke # 冒烟 [4] 段落
|
npm run test:smoke # 冒烟 [4] 段落
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ draft ──submit──▶ pending ──approve──▶ published
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd web-server
|
cd web-server
|
||||||
npx vitest run # 10 个文件 / 168 项通过(含 admin-bone-filter 8 项)
|
npx vitest run # 12 个文件 / 193 项通过(含 admin-bone-filter 8 项、.env 预检 12 项、Assimp 13 项)
|
||||||
npm run test:smoke
|
npm run test:smoke
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "opendance-admin",
|
"name": "opendance-admin",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.2.0",
|
"version": "0.2.2",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "OpenDance Studio 管理端(React + TypeScript + Vite)",
|
"description": "OpenDance Studio 管理端(React + TypeScript + Vite)",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
@@ -273,12 +273,21 @@ export interface HealthDatabase {
|
|||||||
migrationsPending?: number;
|
migrationsPending?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface HealthAssimp {
|
||||||
|
available: boolean;
|
||||||
|
/** 解析到的 Assimp 可执行文件路径 */
|
||||||
|
path?: string;
|
||||||
|
version?: string;
|
||||||
|
error?: string;
|
||||||
|
}
|
||||||
|
|
||||||
export interface Health {
|
export interface Health {
|
||||||
status: 'ok' | 'degraded';
|
status: 'ok' | 'degraded';
|
||||||
uptimeSec: number;
|
uptimeSec: number;
|
||||||
version: string;
|
version: string;
|
||||||
contractVersion: Record<string, string>;
|
contractVersion: Record<string, string>;
|
||||||
database: HealthDatabase;
|
database: HealthDatabase;
|
||||||
|
assimp?: HealthAssimp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ------------------------------------------------------------ 错误响应 */
|
/* ------------------------------------------------------------ 错误响应 */
|
||||||
|
|||||||
@@ -196,10 +196,28 @@ export function DashboardPage() {
|
|||||||
<span className="muted">迁移待执行</span>
|
<span className="muted">迁移待执行</span>
|
||||||
<code>{healthValue.database?.migrationsPending ?? 0}</code>
|
<code>{healthValue.database?.migrationsPending ?? 0}</code>
|
||||||
</div>
|
</div>
|
||||||
|
<div className="kv">
|
||||||
|
<span className="muted">assimp</span>
|
||||||
|
<code>
|
||||||
|
{healthValue.assimp?.available
|
||||||
|
? (healthValue.assimp.version ?? 'available')
|
||||||
|
: '未安装'}
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
) : (
|
) : (
|
||||||
<ErrorBox message={health.error ?? '无法获取健康状态'} onRetry={state.reload} />
|
<ErrorBox message={health.error ?? '无法获取健康状态'} onRetry={state.reload} />
|
||||||
)}
|
)}
|
||||||
|
{health.ok && healthValue && !healthValue.assimp?.available ? (
|
||||||
|
<div className="banner banner-warn" role="status">
|
||||||
|
<strong>Assimp 不可用</strong>
|
||||||
|
<span>
|
||||||
|
上传 .pmx / .fbx 模型(或含 PMX/FBX 的压缩包)会转换失败;FBX / glTF 动作预处理同样
|
||||||
|
需要它。在服务器上安装后无需重启服务:<code>apt-get install -y assimp-utils</code>
|
||||||
|
(RHEL 系为 <code>dnf install -y assimp</code>)。只上传 .glb / .vrm 则不受影响。
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "opendance-web-server",
|
"name": "opendance-web-server",
|
||||||
"version": "0.2.0",
|
"version": "0.2.2",
|
||||||
"description": "OpenDance Studio Web 管理服务端(NestJS + TypeORM + 现有 MySQL 实例)",
|
"description": "OpenDance Studio Web 管理服务端(NestJS + TypeORM + 现有 MySQL 实例)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
|||||||
@@ -0,0 +1,133 @@
|
|||||||
|
/**
|
||||||
|
* Assimp 可执行文件的定位、安装提示与可用性探测。
|
||||||
|
*
|
||||||
|
* 背景:PMX / FBX 模型转换与 FBX / glTF 动作预处理都依赖**外部** Assimp
|
||||||
|
* 命令行工具(BSD-3-Clause,不在 Node 依赖里)。装漏了只有在用户上传完
|
||||||
|
* 一整个压缩包之后才会暴露,而且原始报错只有 `spawn assimp ENOENT`。
|
||||||
|
* 这里把「找二进制」与「怎么装」集中到一处,供转换管线、动作预处理、
|
||||||
|
* /health 与部署自检共用。
|
||||||
|
*/
|
||||||
|
import { execFile } from 'node:child_process';
|
||||||
|
import { existsSync, statSync } from 'node:fs';
|
||||||
|
import { delimiter, join } from 'node:path';
|
||||||
|
import { promisify } from 'node:util';
|
||||||
|
|
||||||
|
const execFileAsync = promisify(execFile);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 除 PATH 之外再查找的常见目录。
|
||||||
|
* 生产上服务由系统服务托管,PATH 可能很窄(甚至只有 /usr/bin),
|
||||||
|
* 而用户把 Assimp 装在 /usr/local/bin 也很常见。
|
||||||
|
*/
|
||||||
|
export const ASSIMP_FALLBACK_DIRS = [
|
||||||
|
'/usr/bin',
|
||||||
|
'/usr/local/bin',
|
||||||
|
'/usr/sbin',
|
||||||
|
'/usr/local/sbin',
|
||||||
|
'/snap/bin',
|
||||||
|
];
|
||||||
|
|
||||||
|
export interface AssimpLocation {
|
||||||
|
/** 解析到的可执行文件路径(未找到时原样返回传入的 bin) */
|
||||||
|
path: string;
|
||||||
|
found: boolean;
|
||||||
|
/** 依次查找过的候选路径(用于错误信息) */
|
||||||
|
searched: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 定位 Assimp 可执行文件:显式路径 -> PATH -> 常见系统目录。
|
||||||
|
* 只做文件系统检查,不执行它(探测可用性见 detectAssimpBin)。
|
||||||
|
*/
|
||||||
|
export function resolveAssimpBinary(bin: string): AssimpLocation {
|
||||||
|
const candidates: string[] = [];
|
||||||
|
if (bin.includes('/') || bin.includes('\\')) {
|
||||||
|
candidates.push(bin);
|
||||||
|
} else {
|
||||||
|
for (const dir of (process.env.PATH ?? '').split(delimiter)) {
|
||||||
|
if (dir) candidates.push(join(dir, bin));
|
||||||
|
}
|
||||||
|
for (const dir of ASSIMP_FALLBACK_DIRS) candidates.push(join(dir, bin));
|
||||||
|
}
|
||||||
|
const searched = [...new Set(candidates)];
|
||||||
|
for (const candidate of searched) {
|
||||||
|
try {
|
||||||
|
// 必须是文件:只判 existsSync 会把同名目录(例如 ASSIMP_BIN=/usr/bin)当成二进制
|
||||||
|
if (existsSync(candidate) && statSync(candidate).isFile()) {
|
||||||
|
return { path: candidate, found: true, searched };
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
/* 权限等问题一律视为该候选不可用,继续找下一个 */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { path: bin, found: false, searched };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 各发行版的安装命令(部署脚本与错误信息共用同一份文案) */
|
||||||
|
export const ASSIMP_INSTALL_COMMANDS: ReadonlyArray<{ distro: string; command: string }> = [
|
||||||
|
{ distro: 'Debian / Ubuntu', command: 'apt-get update && apt-get install -y assimp-utils' },
|
||||||
|
{ distro: 'RHEL / CentOS / Rocky / Fedora', command: 'dnf install -y assimp' },
|
||||||
|
{ distro: 'Alpine', command: 'apk add --no-cache assimp' },
|
||||||
|
{ distro: 'Arch', command: 'pacman -S --noconfirm assimp' },
|
||||||
|
];
|
||||||
|
|
||||||
|
export function assimpInstallHint(indent = ' '): string {
|
||||||
|
return ASSIMP_INSTALL_COMMANDS.map((item) => `${indent}${item.distro}: ${item.command}`).join('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 找不到 Assimp 时的完整可读错误(含查过的路径、安装命令与替代办法) */
|
||||||
|
export function assimpMissingMessage(bin: string, searched: string[] = []): string {
|
||||||
|
const tried =
|
||||||
|
searched.length > 0
|
||||||
|
? `\n已查找 ${searched.length} 处: ${searched.slice(0, 5).join(', ')}${searched.length > 5 ? ' ...' : ''}`
|
||||||
|
: '';
|
||||||
|
return (
|
||||||
|
`未找到 Assimp 可执行文件 "${bin}"。PMX / FBX 模型转换与 FBX / glTF 动作预处理都需要它` +
|
||||||
|
'(外部命令行工具, 不在 Node 依赖内)。' +
|
||||||
|
tried +
|
||||||
|
'\n安装方式:\n' +
|
||||||
|
assimpInstallHint() +
|
||||||
|
'\n装好后可用 `assimp version` 验证; 若它不在服务进程的 PATH 里, ' +
|
||||||
|
'请在 deploy/.env 中把 ASSIMP_BIN 设为绝对路径并重启服务。' +
|
||||||
|
'\n只上传 .glb / .vrm 模型(或 .bvh / .vmd / 关键点 JSON 动作)则不需要 Assimp。'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AssimpProbe {
|
||||||
|
available: boolean;
|
||||||
|
/** 解析到的路径(未找到时为原值) */
|
||||||
|
path: string;
|
||||||
|
version?: string;
|
||||||
|
error?: string;
|
||||||
|
searched: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 探测 Assimp 是否真的可用(执行 `assimp version`)。
|
||||||
|
* 用于 /health、部署自检,以及转换前的预检。
|
||||||
|
*/
|
||||||
|
export async function detectAssimpBin(bin: string): Promise<AssimpProbe> {
|
||||||
|
const location = resolveAssimpBinary(bin);
|
||||||
|
if (!location.found) {
|
||||||
|
return {
|
||||||
|
available: false,
|
||||||
|
path: location.path,
|
||||||
|
error: `未安装 (${bin})`,
|
||||||
|
searched: location.searched,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const { stdout } = await execFileAsync(location.path, ['version'], { timeout: 10_000 });
|
||||||
|
const version =
|
||||||
|
stdout.split(/\r?\n/).find((line) => line.toLowerCase().includes('assimp')) ?? stdout.trim();
|
||||||
|
return { available: true, path: location.path, version: version.trim(), searched: location.searched };
|
||||||
|
} catch (error) {
|
||||||
|
const err = error as NodeJS.ErrnoException;
|
||||||
|
return {
|
||||||
|
available: false,
|
||||||
|
path: location.path,
|
||||||
|
error: err.code === 'ENOENT' ? `未安装 (${bin})` : (err.message ?? '未知错误'),
|
||||||
|
searched: location.searched,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -24,6 +24,8 @@ export interface HealthReport {
|
|||||||
};
|
};
|
||||||
assimp: {
|
assimp: {
|
||||||
available: boolean;
|
available: boolean;
|
||||||
|
/** 解析到的 Assimp 可执行文件路径(未找到时为配置值) */
|
||||||
|
path?: string;
|
||||||
version?: string;
|
version?: string;
|
||||||
error?: string;
|
error?: string;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import { promisify } from 'node:util';
|
|||||||
import { ModelFormat } from '../common/enums';
|
import { ModelFormat } from '../common/enums';
|
||||||
import { ZipEntry, readZipEntries } from '../common/zip-reader';
|
import { ZipEntry, readZipEntries } from '../common/zip-reader';
|
||||||
import { embedGlbImages } from './glb-textures';
|
import { embedGlbImages } from './glb-textures';
|
||||||
|
import { assimpMissingMessage, resolveAssimpBinary } from '../common/assimp';
|
||||||
import { packGltfToGlb } from './gltf-packer';
|
import { packGltfToGlb } from './gltf-packer';
|
||||||
import { VrmWrapMeta, detectGlbKind, wrapGlbAsVrm } from './vrm-writer';
|
import { VrmWrapMeta, detectGlbKind, wrapGlbAsVrm } from './vrm-writer';
|
||||||
|
|
||||||
@@ -250,6 +251,13 @@ async function runAssimpPipeline(
|
|||||||
): Promise<{ buffer: Buffer; format: ModelFormat; note: string; attempts: string[] }> {
|
): Promise<{ buffer: Buffer; format: ModelFormat; note: string; attempts: string[] }> {
|
||||||
const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
|
const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
|
||||||
const prefer = options.preferFormat ?? 'glb';
|
const prefer = options.preferFormat ?? 'glb';
|
||||||
|
|
||||||
|
// 预检:Assimp 缺失时直接给出「怎么装 + 查过哪些路径」,而不是两条 spawn ENOENT。
|
||||||
|
// 只做文件系统检查(不执行),避免给假二进制(测试桩)增加额外要求。
|
||||||
|
const location = resolveAssimpBinary(options.assimpBin);
|
||||||
|
if (!location.found) {
|
||||||
|
throw new Error(`模型转换失败:${assimpMissingMessage(options.assimpBin, location.searched)}`);
|
||||||
|
}
|
||||||
{
|
{
|
||||||
const workDir = dirname(modelPath);
|
const workDir = dirname(modelPath);
|
||||||
const attempts: string[] = [];
|
const attempts: string[] = [];
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ import { existsSync } from 'node:fs';
|
|||||||
import { basename, extname, join } from 'node:path';
|
import { basename, extname, join } from 'node:path';
|
||||||
import { promisify } from 'node:util';
|
import { promisify } from 'node:util';
|
||||||
|
|
||||||
|
import { assimpMissingMessage, resolveAssimpBinary } from '../common/assimp';
|
||||||
|
|
||||||
const execFileAsync = promisify(execFile);
|
const execFileAsync = promisify(execFile);
|
||||||
|
|
||||||
export const ASSIMP_CONVERT_TIMEOUT_MS = 120_000;
|
export const ASSIMP_CONVERT_TIMEOUT_MS = 120_000;
|
||||||
@@ -31,10 +33,8 @@ export async function convertToBvhWithAssimp(
|
|||||||
} catch (error) {
|
} catch (error) {
|
||||||
const err = error as NodeJS.ErrnoException & { stderr?: string };
|
const err = error as NodeJS.ErrnoException & { stderr?: string };
|
||||||
if (err.code === 'ENOENT') {
|
if (err.code === 'ENOENT') {
|
||||||
throw new BadRequestException(
|
const location = resolveAssimpBinary(assimpBin);
|
||||||
`未找到 Assimp 可执行文件「${assimpBin}」。FBX / glTF 动作预处理需要 Assimp(BSD-3-Clause),` +
|
throw new BadRequestException(assimpMissingMessage(assimpBin, location.searched));
|
||||||
'请安装后设置 ASSIMP_BIN 环境变量;BVH 动作无需 Assimp。',
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
const detail = (err.stderr ?? err.message ?? '').toString().trim().slice(0, 500);
|
const detail = (err.stderr ?? err.message ?? '').toString().trim().slice(0, 500);
|
||||||
throw new BadRequestException(`Assimp 转换失败:${detail || '未知错误'}`);
|
throw new BadRequestException(`Assimp 转换失败:${detail || '未知错误'}`);
|
||||||
@@ -47,16 +47,4 @@ export async function convertToBvhWithAssimp(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** 探测 Assimp 是否可用(用于 /health 与部署自检) */
|
/** 探测 Assimp 是否可用(用于 /health 与部署自检) */
|
||||||
export async function detectAssimp(assimpBin: string): Promise<{ available: boolean; version?: string; error?: string }> {
|
export { detectAssimpBin as detectAssimp } from '../common/assimp';
|
||||||
try {
|
|
||||||
const { stdout } = await execFileAsync(assimpBin, ['version'], { timeout: 10_000 });
|
|
||||||
const version = stdout.split(/\r?\n/).find((line) => line.toLowerCase().includes('assimp')) ?? stdout.trim();
|
|
||||||
return { available: true, version: version.trim() };
|
|
||||||
} catch (error) {
|
|
||||||
const err = error as NodeJS.ErrnoException;
|
|
||||||
return {
|
|
||||||
available: false,
|
|
||||||
error: err.code === 'ENOENT' ? `未安装(${assimpBin})` : (err.message ?? '未知错误'),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,200 @@
|
|||||||
|
import { spawnSync } from 'node:child_process';
|
||||||
|
import { chmodSync, existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
|
||||||
|
import { tmpdir } from 'node:os';
|
||||||
|
import { join, resolve } from 'node:path';
|
||||||
|
import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
import {
|
||||||
|
ASSIMP_FALLBACK_DIRS,
|
||||||
|
assimpInstallHint,
|
||||||
|
assimpMissingMessage,
|
||||||
|
detectAssimpBin,
|
||||||
|
resolveAssimpBinary,
|
||||||
|
} from '../src/common/assimp';
|
||||||
|
import { convertModelFile } from '../src/models/model-convert';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Assimp 缺失时的可诊断性。
|
||||||
|
*
|
||||||
|
* 背景(真实故障):服务器没装 Assimp,上传 PMX 压缩包只得到
|
||||||
|
* GLB 直出:导出失败(ENOENT):spawn assimp ENOENT
|
||||||
|
* glTF 直出:导出失败(ENOENT):spawn assimp ENOENT
|
||||||
|
* 用户看不出「缺什么、怎么装」。现在:
|
||||||
|
* * 转换前先定位二进制,找不到就一次性给出安装命令与查过的路径;
|
||||||
|
* * 定位逻辑覆盖 PATH 之外的常见目录(服务由 systemd 托管时 PATH 可能很窄)。
|
||||||
|
*/
|
||||||
|
|
||||||
|
let workRoot = '';
|
||||||
|
let fakeBin = '';
|
||||||
|
|
||||||
|
function findDeployLib(): string {
|
||||||
|
const candidates = [
|
||||||
|
resolve(process.cwd(), '..', 'deploy', 'assimp-lib.sh'),
|
||||||
|
resolve(process.cwd(), 'deploy', 'assimp-lib.sh'),
|
||||||
|
resolve(process.cwd(), '..', '..', 'deploy', 'assimp-lib.sh'),
|
||||||
|
];
|
||||||
|
for (const candidate of candidates) {
|
||||||
|
if (existsSync(candidate)) return candidate;
|
||||||
|
}
|
||||||
|
throw new Error(`找不到 deploy/assimp-lib.sh,候选路径:\n${candidates.join('\n')}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const ASSIMP_LIB = findDeployLib();
|
||||||
|
|
||||||
|
/** 写一个最小的假 assimp:只实现 `version` */
|
||||||
|
function writeFakeAssimp(path: string, versionLine = 'Assimp version 6.0.4'): string {
|
||||||
|
mkdirSync(join(path, '..'), { recursive: true });
|
||||||
|
writeFileSync(path, `#!/bin/bash\n[ "\${1:-}" = "version" ] && echo "${versionLine}"\nexit 0\n`);
|
||||||
|
chmodSync(path, 0o755);
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeAll(() => {
|
||||||
|
workRoot = mkdtempSync(join(tmpdir(), 'opendance-assimp-test-'));
|
||||||
|
fakeBin = writeFakeAssimp(join(workRoot, 'bin', 'assimp'));
|
||||||
|
});
|
||||||
|
|
||||||
|
afterAll(() => {
|
||||||
|
rmSync(workRoot, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
const savedPath = process.env.PATH;
|
||||||
|
afterEach(() => {
|
||||||
|
process.env.PATH = savedPath;
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('Assimp 定位(resolveAssimpBinary)', () => {
|
||||||
|
it('能在 PATH 中找到可执行文件', () => {
|
||||||
|
process.env.PATH = `${join(workRoot, 'bin')}:/usr/bin:/bin`;
|
||||||
|
const result = resolveAssimpBinary('assimp');
|
||||||
|
expect(result.found).toBe(true);
|
||||||
|
expect(result.path).toBe(fakeBin);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('显式绝对路径优先,不存在时 found=false 并给出查找记录', () => {
|
||||||
|
const missing = join(workRoot, 'no-such-assimp');
|
||||||
|
const result = resolveAssimpBinary(missing);
|
||||||
|
expect(result.found).toBe(false);
|
||||||
|
expect(result.searched).toContain(missing);
|
||||||
|
|
||||||
|
const present = resolveAssimpBinary(fakeBin);
|
||||||
|
expect(present.found).toBe(true);
|
||||||
|
expect(present.path).toBe(fakeBin);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('PATH 里没有时仍会查常见系统目录(systemd 服务 PATH 可能很窄)', () => {
|
||||||
|
process.env.PATH = '/nonexistent-dir-only';
|
||||||
|
const result = resolveAssimpBinary('assimp');
|
||||||
|
// 结果取决于本机是否装了真实 assimp:两种都必须把常见目录查过
|
||||||
|
for (const dir of ASSIMP_FALLBACK_DIRS) {
|
||||||
|
expect(result.searched).toContain(join(dir, 'assimp'));
|
||||||
|
}
|
||||||
|
if (!result.found) expect(result.path).toBe('assimp');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('Assimp 缺失时的错误信息', () => {
|
||||||
|
it('包含二进制名、各发行版安装命令、替代办法与查过的路径', () => {
|
||||||
|
const message = assimpMissingMessage('assimp', ['/usr/bin/assimp', '/usr/local/bin/assimp']);
|
||||||
|
expect(message).toContain('assimp');
|
||||||
|
expect(message).toContain('apt-get install -y assimp-utils');
|
||||||
|
expect(message).toContain('dnf install -y assimp');
|
||||||
|
expect(message).toContain('/usr/bin/assimp');
|
||||||
|
expect(message).toContain('ASSIMP_BIN');
|
||||||
|
expect(message).toContain('.glb / .vrm');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('安装提示各发行版一条命令', () => {
|
||||||
|
const hint = assimpInstallHint();
|
||||||
|
for (const distro of ['Debian / Ubuntu', 'Alpine', 'Arch']) {
|
||||||
|
expect(hint).toContain(distro);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('Assimp 可用性探测(detectAssimpBin)', () => {
|
||||||
|
it('能执行时返回版本与路径', async () => {
|
||||||
|
const probe = await detectAssimpBin(fakeBin);
|
||||||
|
expect(probe.available).toBe(true);
|
||||||
|
expect(probe.path).toBe(fakeBin);
|
||||||
|
expect(probe.version).toContain('6.0.4');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('找不到时 available=false 且 error 说明未安装', async () => {
|
||||||
|
const probe = await detectAssimpBin(join(workRoot, 'no-such-assimp'));
|
||||||
|
expect(probe.available).toBe(false);
|
||||||
|
expect(probe.error).toContain('未安装');
|
||||||
|
expect(probe.searched.length).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('转换管线:Assimp 缺失时快速失败并给出可操作信息', () => {
|
||||||
|
it('convertModelFile 抛出的错误包含安装命令,且不再出现两次 spawn ENOENT', async () => {
|
||||||
|
let message = '';
|
||||||
|
try {
|
||||||
|
await convertModelFile(Buffer.from('PMX dummy'), 'Hatsune Miku.pmx', {
|
||||||
|
assimpBin: join(workRoot, 'no-such-assimp'),
|
||||||
|
timeoutMs: 5_000,
|
||||||
|
});
|
||||||
|
throw new Error('应当抛出异常');
|
||||||
|
} catch (error) {
|
||||||
|
message = error instanceof Error ? error.message : String(error);
|
||||||
|
}
|
||||||
|
expect(message).toContain('模型转换失败');
|
||||||
|
expect(message).toContain('apt-get install -y assimp-utils');
|
||||||
|
expect(message).toContain('ASSIMP_BIN');
|
||||||
|
expect(message).not.toContain('ENOENT');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('deploy/assimp-lib.sh:部署脚本共用的安装逻辑', () => {
|
||||||
|
function runLib(script: string, path?: string) {
|
||||||
|
// 覆盖 PATH 的用例里必须用绝对路径调 bash,否则连 bash 都找不到
|
||||||
|
return spawnSync('/bin/bash', ['-c', `. "$1"; ${script}`, '_', ASSIMP_LIB], {
|
||||||
|
encoding: 'utf8',
|
||||||
|
timeout: 15000,
|
||||||
|
env: { ...process.env, ...(path ? { PATH: path } : {}) },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
it('opendance_assimp_resolve 能在 PATH 中找到二进制', () => {
|
||||||
|
const result = runLib('opendance_assimp_resolve', `${join(workRoot, 'bin')}:/usr/bin:/bin`);
|
||||||
|
expect(result.stdout.trim()).toBe(fakeBin);
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('opendance_assimp_resolve 在找不到时返回非 0 且无输出', () => {
|
||||||
|
const result = runLib('opendance_assimp_resolve || echo MISSING', '/nonexistent-dir-only');
|
||||||
|
// 本机若真的装了 assimp(/usr/bin),则跳过这条断言的严格性
|
||||||
|
if (!existsSync('/usr/bin/assimp') && !existsSync('/usr/local/bin/assimp')) {
|
||||||
|
expect(result.stdout.trim()).toBe('MISSING');
|
||||||
|
}
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('opendance_assimp_install_cmd 按包管理器给出对应命令', () => {
|
||||||
|
const aptDir = join(workRoot, 'apt');
|
||||||
|
mkdirSync(aptDir, { recursive: true });
|
||||||
|
writeFileSync(join(aptDir, 'apt-get'), '#!/bin/bash\nexit 0\n');
|
||||||
|
chmodSync(join(aptDir, 'apt-get'), 0o755);
|
||||||
|
const result = runLib('opendance_assimp_install_cmd', `${aptDir}:/usr/bin:/bin`);
|
||||||
|
expect(result.stdout).toContain('apt-get install -y assimp-utils');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('opendance_assimp_install 调用包管理器安装 assimp-utils(离线失败也不抛)', () => {
|
||||||
|
const aptDir = join(workRoot, 'apt');
|
||||||
|
const log = join(aptDir, 'calls.log');
|
||||||
|
rmSync(log, { force: true });
|
||||||
|
writeFileSync(join(aptDir, 'apt-get'), `#!/bin/bash\necho "apt-get $*" >> "${log}"\nexit 0\n`);
|
||||||
|
chmodSync(join(aptDir, 'apt-get'), 0o755);
|
||||||
|
const result = runLib('opendance_assimp_install', `${aptDir}:/usr/bin:/bin`);
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
const calls = existsSync(log) ? readFileSync(log, 'utf8') : '';
|
||||||
|
expect(calls).toContain('apt-get install -y -qq assimp-utils');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('非常规目录需要写 ASSIMP_BIN,标准目录不需要', () => {
|
||||||
|
expect(runLib(`opendance_assimp_needs_env_path ${join(workRoot, 'bin', 'assimp')} && echo YES`).stdout).toContain('YES');
|
||||||
|
expect(runLib('opendance_assimp_needs_env_path /usr/bin/assimp || echo NO').stdout).toContain('NO');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,189 @@
|
|||||||
|
import { spawnSync } from 'node:child_process';
|
||||||
|
import { existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
|
||||||
|
import { tmpdir } from 'node:os';
|
||||||
|
import { join, resolve } from 'node:path';
|
||||||
|
import { afterEach, describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* deploy/.env 的「可被 shell 安全载入」保证。
|
||||||
|
*
|
||||||
|
* 背景(真实故障):install.sh 用 `set -a; . deploy/.env` 载入配置,而模板里
|
||||||
|
* MODEL_CONVERT_PMX=Hatsune Miku.pmx
|
||||||
|
* 的值含空格却没加引号,这一行被切成「赋值 + 命令」,安装直接失败:
|
||||||
|
* ./deploy/.env: line 53: Miku.pmx: command not found
|
||||||
|
* [install] 第 53 行执行失败(退出码 127)
|
||||||
|
*
|
||||||
|
* 因此这里锁两条线:
|
||||||
|
* 1. deploy/.env.example 必须能被 `set -a; .` 原样载入(回归用例);
|
||||||
|
* 2. deploy/env-lib.sh 的预检能在载入前拦住不安全写法,并给出行号与改法。
|
||||||
|
*/
|
||||||
|
|
||||||
|
function findDeployFile(name: string): string {
|
||||||
|
const candidates = [
|
||||||
|
resolve(process.cwd(), '..', 'deploy', name), // 从 web-server/ 运行(vitest 默认)
|
||||||
|
resolve(process.cwd(), 'deploy', name), // 从仓库根运行
|
||||||
|
resolve(process.cwd(), '..', '..', 'deploy', name),
|
||||||
|
];
|
||||||
|
for (const candidate of candidates) {
|
||||||
|
if (existsSync(candidate)) return candidate;
|
||||||
|
}
|
||||||
|
throw new Error(`找不到 deploy/${name},候选路径:\n${candidates.join('\n')}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const EXAMPLE = findDeployFile('.env.example');
|
||||||
|
const ENV_LIB = findDeployFile('env-lib.sh');
|
||||||
|
const INSTALL_SH = findDeployFile('install.sh');
|
||||||
|
const CTL_SH = findDeployFile('ctl.sh');
|
||||||
|
|
||||||
|
const dirs: string[] = [];
|
||||||
|
function makeDir(): string {
|
||||||
|
const dir = mkdtempSync(join(tmpdir(), 'opendance-env-'));
|
||||||
|
dirs.push(dir);
|
||||||
|
return dir;
|
||||||
|
}
|
||||||
|
afterEach(() => {
|
||||||
|
while (dirs.length) rmSync(dirs.pop()!, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
/** 用真实 shell 载入一个 .env(与 install.sh 的做法一致) */
|
||||||
|
function sourceEnv(file: string) {
|
||||||
|
return spawnSync(
|
||||||
|
'bash',
|
||||||
|
[
|
||||||
|
'-c',
|
||||||
|
'set -a; . "$1"; set +a; printf "%s\\n" "${MODEL_CONVERT_PMX:-}" "${DB_HOST:-}" "${DB_PASS:-}" "${UPLOAD_MAX_BYTES:-}"',
|
||||||
|
'_',
|
||||||
|
file,
|
||||||
|
],
|
||||||
|
{ encoding: 'utf8', timeout: 15000 },
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 调用 deploy/env-lib.sh 的预检函数 */
|
||||||
|
function validate(file: string) {
|
||||||
|
return spawnSync('bash', ['-c', '. "$1"; opendance_validate_env_file "$2"', '_', ENV_LIB, file], {
|
||||||
|
encoding: 'utf8',
|
||||||
|
timeout: 15000,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function writeEnv(content: string): string {
|
||||||
|
const file = join(makeDir(), '.env');
|
||||||
|
writeFileSync(file, content);
|
||||||
|
return file;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('deploy/.env.example:必须能被 shell 原样载入', () => {
|
||||||
|
it('`set -a; . .env.example` 成功, 且带空格的值读回完整 (回归: 修复前此处退出码 127)', () => {
|
||||||
|
const result = sourceEnv(EXAMPLE);
|
||||||
|
|
||||||
|
expect(result.stderr).not.toContain('command not found');
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
const [pmx, host, pass, uploadMax] = result.stdout.trimEnd().split('\n');
|
||||||
|
expect(pmx).toBe('Hatsune Miku.pmx');
|
||||||
|
expect(host).toBe('<existing-mysql-host>');
|
||||||
|
expect(pass).toBe('<数据库口令>');
|
||||||
|
expect(uploadMax).toBe('536870912');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('模板整体通过语法预检', () => {
|
||||||
|
const result = validate(EXAMPLE);
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
expect(result.stderr).toBe('');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('模板里每个赋值行都通过预检(逐行定位,便于以后加字段时发现问题)', () => {
|
||||||
|
const lines = readFileSync(EXAMPLE, 'utf8').split('\n');
|
||||||
|
const assigns = lines.filter((l) => /^[A-Za-z_][A-Za-z0-9_]*=/.test(l));
|
||||||
|
expect(assigns.length).toBeGreaterThan(10); // 模板字段数量下限,防止误删
|
||||||
|
for (const line of assigns) {
|
||||||
|
expect(validate(writeEnv(`${line}\n`)).status, `模板行应通过预检:${line}`).toBe(0);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('deploy/env-lib.sh:载入前的语法预检', () => {
|
||||||
|
it('拦住「值含空格却未加引号」,并给出行号、原文与改法(本次故障的原始写法)', () => {
|
||||||
|
const result = validate(writeEnv('NODE_ENV=production\nMODEL_CONVERT_PMX=Hatsune Miku.pmx\n'));
|
||||||
|
expect(result.status).toBe(1);
|
||||||
|
expect(result.stderr).toContain('第 2 行');
|
||||||
|
expect(result.stderr).toContain('MODEL_CONVERT_PMX=Hatsune Miku.pmx');
|
||||||
|
expect(result.stderr).toContain('MODEL_CONVERT_PMX="Hatsune Miku.pmx"');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('拦住 shell 元字符,且对 $( ) 建议单引号(双引号仍会执行)', () => {
|
||||||
|
const result = validate(writeEnv('A=x&y\nB=$(id)\n'));
|
||||||
|
expect(result.status).toBe(1);
|
||||||
|
expect(result.stderr).toContain('第 1 行');
|
||||||
|
expect(result.stderr).toContain('第 2 行');
|
||||||
|
expect(result.stderr).toContain("B='$(id)'");
|
||||||
|
});
|
||||||
|
|
||||||
|
it('拦住未闭合引号', () => {
|
||||||
|
const result = validate(writeEnv('A="unclosed\n'));
|
||||||
|
expect(result.status).toBe(1);
|
||||||
|
expect(result.stderr).toContain('双引号未闭合');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('不误伤合法写法:* % 口令、IPv4、路径、空值、单引号、引号 + 行尾注释', () => {
|
||||||
|
const result = validate(
|
||||||
|
writeEnv(
|
||||||
|
[
|
||||||
|
'DB_PASS=S3cr3t*Pwd%1',
|
||||||
|
'DB_HOST=127.0.0.1',
|
||||||
|
'DB_PORT=3306',
|
||||||
|
'STORAGE_DIR=/var/lib/opendance/storage',
|
||||||
|
'EMPTY=',
|
||||||
|
"WITH_SPACE='a b c'",
|
||||||
|
'QUOTED_COMMENT="x y" # 行尾注释',
|
||||||
|
'MODEL_CONVERT_PMX="Hatsune Miku.pmx"',
|
||||||
|
'# 注释与空行也必须放过',
|
||||||
|
'',
|
||||||
|
].join('\n'),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.stderr).toBe('');
|
||||||
|
expect(result.status).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('拦住非「键=值」的行号并指出原因', () => {
|
||||||
|
const result = validate(writeEnv('A=1\n这一行不是赋值\n'));
|
||||||
|
expect(result.status).toBe(1);
|
||||||
|
expect(result.stderr).toContain('第 2 行');
|
||||||
|
expect(result.stderr).toContain('不是「键=值」形式');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('文件不存在时返回 1(而不是静默通过)', () => {
|
||||||
|
const result = validate(join(makeDir(), 'missing.env'));
|
||||||
|
expect(result.status).toBe(1);
|
||||||
|
expect(result.stderr).toContain('找不到配置文件');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('载入顺序:install.sh / ctl.sh 必须先预检再 source', () => {
|
||||||
|
it('install.sh 在 `. ./deploy/.env` 之前调用预检', () => {
|
||||||
|
const text = readFileSync(INSTALL_SH, 'utf8');
|
||||||
|
const check = text.indexOf('opendance_validate_env_file "./deploy/.env"');
|
||||||
|
const source = text.indexOf('. ./deploy/.env');
|
||||||
|
expect(check).toBeGreaterThan(-1);
|
||||||
|
expect(source).toBeGreaterThan(-1);
|
||||||
|
expect(check).toBeLessThan(source);
|
||||||
|
// .env 被 source 时 LINENO 指向 .env 的行号,报错必须带上文件名才定位得到
|
||||||
|
expect(text).toContain('${BASH_SOURCE[0]}');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('install.sh 在迁移前再次预检安装目录里的 .env', () => {
|
||||||
|
const text = readFileSync(INSTALL_SH, 'utf8');
|
||||||
|
expect(text).toContain('opendance_validate_env_file "$APP_DIR/deploy/.env"');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ctl.sh 载入 .env 前调用预检,且引用同目录的 env-lib.sh', () => {
|
||||||
|
const text = readFileSync(CTL_SH, 'utf8');
|
||||||
|
expect(text).toContain('"$SCRIPT_DIR/env-lib.sh"');
|
||||||
|
const check = text.indexOf('opendance_validate_env_file "$APP_DIR/deploy/.env"');
|
||||||
|
const source = text.indexOf('. "$APP_DIR/deploy/.env"');
|
||||||
|
expect(check).toBeGreaterThan(-1);
|
||||||
|
expect(source).toBeGreaterThan(-1);
|
||||||
|
expect(check).toBeLessThan(source);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -423,13 +423,18 @@ describe('压缩包导入与转换(用假 Assimp 做对照)', () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('assimp 不存在时给出可读错误', async () => {
|
it('assimp 不存在时给出可读错误(含安装命令与替代办法,而不是 spawn ENOENT)', async () => {
|
||||||
|
const promise = convertModelArchive(pmxArchive(), {
|
||||||
|
assimpBin: join(workRoot, 'no-such-assimp'),
|
||||||
|
timeoutMs: 5_000,
|
||||||
|
});
|
||||||
|
await expect(promise).rejects.toThrow(/模型转换失败/);
|
||||||
await expect(
|
await expect(
|
||||||
convertModelArchive(pmxArchive(), {
|
convertModelArchive(pmxArchive(), {
|
||||||
assimpBin: join(workRoot, 'no-such-assimp'),
|
assimpBin: join(workRoot, 'no-such-assimp'),
|
||||||
timeoutMs: 5_000,
|
timeoutMs: 5_000,
|
||||||
}),
|
}),
|
||||||
).rejects.toThrow(/模型转换失败/);
|
).rejects.toThrow(/apt-get install -y assimp-utils[\s\S]*\.glb \/ \.vrm/);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user