mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-20 16:19:19 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c302c162a0 | ||
|
|
432be04a96 | ||
|
|
6c95d14fb3 | ||
|
|
3263580e89 | ||
|
|
f3da916905 | ||
|
|
fe8d404a44 | ||
|
|
0f9d213b1d | ||
|
|
f952318b34 | ||
|
|
43a2eced75 | ||
|
|
e894457275 | ||
|
|
4b1b64fe2b |
@@ -12,6 +12,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
||||
|
||||
### Changed
|
||||
|
||||
## [0.5.2] - 2026-10-13
|
||||
|
||||
### Added
|
||||
|
||||
* **3d asset**: Add support for 3D model files (.glb, .gltf, .obj, .fbx, .stl, .dae, .usd, .usda, .usdc, .usdz) with automated turntable video rendering, hover sprite scrubbing, and an interactive 3D turntable viewer featuring 360° ruler scrubbing and degree-based markup comments
|
||||
* **kanban**: Related assets on a task are now clickable, taking you directly to that file or folder in its project
|
||||
* **settings**: Add an Integrations section to Team Settings with dedicated configuration for Gotenberg Document Converter, supporting connection testing and environment variable override protection
|
||||
|
||||
### Fixed
|
||||
|
||||
* **transcode**: Fix an issue where portrait photos from cameras and phones appeared sideways in thumbnails, previews, watermarked share links and annotated snapshots, and were listed with their width and height swapped
|
||||
|
||||
### Changed
|
||||
|
||||
## [0.5.1] - 2026-10-06
|
||||
|
||||
### Added
|
||||
|
||||
@@ -33,6 +33,7 @@ Shumai is an open-source Frame.io alternative built for creative teams to collab
|
||||
* **Custom Asset Metadata**: Define dynamic metadata fields tailored to your production pipeline.
|
||||
* **Share Link Watermarking**: Protect shared media with customizable text and image watermarks, and save watermark as reusable templates.
|
||||
* **Wide File Format Support**: Preview common creative file formats, including images (with PSD support), videos, audio, and documents, while allowing any file type to be uploaded and stored.
|
||||
* **3D Asset Turntable Previews**: Generate interactive 3D model turntable previews and videos for formats like GLB, FBX, OBJ, STL, USD, and DAE using [turntable-renderer](https://docs.shumai.one/using-shumai/3d-asset-support).
|
||||
* **Office & Document PDF Proxying via Gotenberg**: Convert Word, PowerPoint, Excel, Markdown, HTML, and CSV documents to high-quality PDF proxies for in-browser previewing using [Gotenberg](https://docs.shumai.one/using-shumai/gotenberg).
|
||||
* **NLE Export & Premiere Pro Plugin (Experimental)**: Export timestamped review comments to your favorite non-linear editor (Premiere Pro XML, DaVinci Resolve EDL, Final Cut Pro, Avid Media Composer) or use the experimental Premiere Pro UXP plugin to import media assets and auto-sync comments directly to sequence timeline markers. See [documentation](https://docs.shumai.one/using-shumai/nle-and-premiere).
|
||||
|
||||
|
||||
@@ -33,6 +33,7 @@ Shumai 是一个开源的 Frame.io 替代方案,专为创意团队打造,让
|
||||
* **自定义素材元数据**:可以按你的制作流程,自由定义动态元数据字段。
|
||||
* **分享链接水印**:通过可自定义的文字和图片水印保护共享媒体,并将水印配置保存为模板以便重复使用。
|
||||
* **丰富的文件格式支持**:支持预览常见创意文件格式,包括图片(支持 PSD)、视频、音频和文档,同时可上传和存储任意类型的文件。
|
||||
* **基于转盘渲染服务的 3D 资产预览**:通过集成 [turntable-renderer](https://docs.shumai.one/using-shumai/3d-asset-support) 支持为 GLB、FBX、OBJ、STL、USD 和 DAE 等 3D 模型生成高质量的交互式转盘预览与视频。
|
||||
* **基于 Gotenberg 的文档 PDF 转码代理**:通过集成 [Gotenberg](https://docs.shumai.one/using-shumai/gotenberg) 支持将 Word、PowerPoint、Excel、Markdown、HTML 和 CSV 文档高质量转换为 PDF 代理文件进行在线预览。
|
||||
* **非编剪辑导出与 Premiere 插件(实验性)**:支持将时间戳审阅评论导出至常用非编软件(Premiere Pro XML、DaVinci Resolve EDL、Final Cut Pro、Avid Media Composer),或使用实验性的 Premiere Pro 原生 UXP 插件导入媒体素材并将评论自动同步为时间轴标记。详见[相关文档](https://docs.shumai.one/using-shumai/nle-and-premiere)。
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/agent-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/cli",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/premiere-uxp",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "commonjs",
|
||||
"scripts": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/transcode-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/web-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
},
|
||||
"apps/agent": {
|
||||
"name": "@shumai/agent-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"bin": {
|
||||
"shumai-agent": "./src/index.ts",
|
||||
},
|
||||
@@ -45,7 +45,7 @@
|
||||
},
|
||||
"apps/cli": {
|
||||
"name": "@shumai/cli",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"bin": {
|
||||
"shumai-cli": "./src/index.ts",
|
||||
},
|
||||
@@ -60,7 +60,7 @@
|
||||
},
|
||||
"apps/premiere-uxp": {
|
||||
"name": "@shumai/premiere-uxp",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@shumai/api": "workspace:*",
|
||||
"@shumai/dtos": "workspace:*",
|
||||
@@ -114,7 +114,7 @@
|
||||
},
|
||||
"apps/transcode": {
|
||||
"name": "@shumai/transcode-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"bin": {
|
||||
"shumai-transcode": "./src/index.ts",
|
||||
},
|
||||
@@ -126,7 +126,7 @@
|
||||
},
|
||||
"apps/web": {
|
||||
"name": "@shumai/web-app",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@shumai/agent": "workspace:*",
|
||||
"@shumai/api": "workspace:*",
|
||||
@@ -146,7 +146,7 @@
|
||||
},
|
||||
"packages/agent": {
|
||||
"name": "@shumai/agent",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@anthropic-ai/sandbox-runtime": "0.0.74",
|
||||
"@earendil-works/pi-agent-core": "0.82.1",
|
||||
@@ -171,7 +171,7 @@
|
||||
},
|
||||
"packages/api": {
|
||||
"name": "@shumai/api",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@hono/zod-validator": "0.7.6",
|
||||
"@shumai/core": "workspace:*",
|
||||
@@ -185,7 +185,7 @@
|
||||
},
|
||||
"packages/core": {
|
||||
"name": "@shumai/core",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@ai-sdk/alibaba": "2.0.38",
|
||||
"@ai-sdk/amazon-bedrock": "5.0.67",
|
||||
@@ -247,7 +247,7 @@
|
||||
},
|
||||
"packages/db": {
|
||||
"name": "@shumai/db",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@earendil-works/pi-agent-core": "0.82.1",
|
||||
"@prisma/adapter-pg": "7.10.0",
|
||||
@@ -263,7 +263,7 @@
|
||||
},
|
||||
"packages/dtos": {
|
||||
"name": "@shumai/dtos",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@earendil-works/pi-agent-core": "0.82.1",
|
||||
"zod": "4.5.4",
|
||||
@@ -271,7 +271,7 @@
|
||||
},
|
||||
"packages/e2e": {
|
||||
"name": "@shumai/e2e",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@earendil-works/pi-agent-core": "0.82.1",
|
||||
"@google/genai": "2.19.0",
|
||||
@@ -286,11 +286,11 @@
|
||||
},
|
||||
"packages/tableprinter": {
|
||||
"name": "@shumai/tableprinter",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
},
|
||||
"packages/transcode": {
|
||||
"name": "@shumai/transcode",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@shumai/core": "workspace:*",
|
||||
"@shumai/db": "workspace:*",
|
||||
@@ -304,7 +304,7 @@
|
||||
},
|
||||
"packages/webui": {
|
||||
"name": "@shumai/webui",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@base-ui/react": "1.7.0",
|
||||
"@dnd-kit/abstract": "0.5.0",
|
||||
@@ -406,7 +406,7 @@
|
||||
},
|
||||
"packages/workflow-core": {
|
||||
"name": "@shumai/workflow-core",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"dependencies": {
|
||||
"@shumai/core": "workspace:*",
|
||||
"@shumai/db": "workspace:*",
|
||||
|
||||
@@ -3,6 +3,22 @@ title: "Changelog"
|
||||
description: "Recent updates, new features, and improvements in Shumai"
|
||||
---
|
||||
|
||||
<Update label="v0.5.2" description="October 13, 2026">
|
||||
|
||||
### Added
|
||||
|
||||
* **3d asset**: Add support for 3D model files (.glb, .gltf, .obj, .fbx, .stl, .dae, .usd, .usda, .usdc, .usdz) with automated turntable video rendering, hover sprite scrubbing, and an interactive 3D turntable viewer featuring 360° ruler scrubbing and degree-based markup comments
|
||||
* **kanban**: Related assets on a task are now clickable, taking you directly to that file or folder in its project
|
||||
* **settings**: Add an Integrations section to Team Settings with dedicated configuration for Gotenberg Document Converter, supporting connection testing and environment variable override protection
|
||||
|
||||
### Fixed
|
||||
|
||||
* **transcode**: Fix an issue where portrait photos from cameras and phones appeared sideways in thumbnails, previews, watermarked share links and annotated snapshots, and were listed with their width and height swapped
|
||||
|
||||
### Changed
|
||||
|
||||
</Update>
|
||||
|
||||
<Update label="v0.5.1" description="October 6, 2026">
|
||||
|
||||
### Added
|
||||
|
||||
@@ -99,3 +99,29 @@ API keys to AI providers on startup.
|
||||
| `GEMINI_API_KEY` | API key for Google Gemini provider. | `AIzaSy...` |
|
||||
| `OPENAI_API_KEY` | API key for OpenAI provider. | `sk-proj-...` |
|
||||
| `ANTHROPIC_API_KEY` | API key for Anthropic provider. | `sk-ant-...` |
|
||||
|
||||
---
|
||||
|
||||
## External Integrations Config
|
||||
|
||||
Environment variables can configure external microservices globally. When set, these environment variables take precedence over any team-level settings configured in **Team Settings → Integrations**, and lock the corresponding settings fields in the WebUI to read-only.
|
||||
|
||||
### Gotenberg Document Converter
|
||||
|
||||
Used to convert Office documents, HTML, Markdown, and CSV files into high-fidelity PDF proxies for in-browser previewing. See the [Gotenberg Guide](/using-shumai/gotenberg) for setup instructions.
|
||||
|
||||
| Variable | Description | Example / Default |
|
||||
| :------------------------------ | :----------------------------------------------------------------------- | :---------------------- |
|
||||
| `GOTENBERG_URL` | Base URL of the external Gotenberg conversion API. | `http://gotenberg:3000` |
|
||||
| `GOTENBERG_BASIC_AUTH_USERNAME` | Username when Basic Authentication is enabled on the Gotenberg instance. | `admin` |
|
||||
| `GOTENBERG_BASIC_AUTH_PASSWORD` | Password when Basic Authentication is enabled on the Gotenberg instance. | `secret` |
|
||||
|
||||
### 3D Turntable Renderer
|
||||
|
||||
Used to convert 3D model files (GLB, OBJ, FBX, USD, STL, DAE) into interactive 360° turntable video proxies, posters, and hover sprites. See the [3D Asset Support Guide](/using-shumai/3d-asset-support) for setup instructions.
|
||||
|
||||
| Variable | Description | Example / Default |
|
||||
| :--------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :------------------------------- |
|
||||
| `TURNTABLE_RENDERER_URL` | Base URL of the external turntable-renderer service. | `http://turntable-renderer:3000` |
|
||||
| `TURNTABLE_RENDERER_BASIC_AUTH_USERNAME` | Username when Basic Authentication is enabled on the turntable renderer (alias: `TURNTABLE_RENDERER_USERNAME`). | `admin` |
|
||||
| `TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD` | Password when Basic Authentication is enabled on the turntable renderer (alias: `TURNTABLE_RENDERER_PASSWORD`). | `secret` |
|
||||
|
||||
@@ -44,6 +44,7 @@
|
||||
"using-shumai/collections",
|
||||
"using-shumai/share-links",
|
||||
"using-shumai/nle-and-premiere",
|
||||
"using-shumai/3d-asset-support",
|
||||
"using-shumai/gotenberg"
|
||||
]
|
||||
},
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
---
|
||||
title: 3D Asset Support with Turntable Renderer
|
||||
description: Render interactive 3D model turntable previews, sprite scrubbing, and video proxies using turntable-renderer.
|
||||
---
|
||||
|
||||
3D models and mesh assets cannot always be rendered consistently or inspected reliably across diverse client web browsers and mobile devices. Shumai integrates with [turntable-renderer](https://github.com/shumaiOne/turntable-renderer) — a standalone service that executes isolated, headless Blender 5.2 LTS subprocesses — to convert 3D model uploads into standardized, high-fidelity turntable previews.
|
||||
|
||||
Turntable Renderer automatically produces:
|
||||
|
||||
- **1080×1080 Turntable Video (`turntable.mp4`)**: A 4-second, 24-frame, 6 fps video rotating the model 360° (15° per frame) clockwise under dark studio lighting with a pure black background.
|
||||
- **Poster Image (`poster.webp`)**: A crisp still poster for grid cards and immediate file display.
|
||||
- **Hover Sprite Sheet (`sprite.webp`)**: A fast scrubbing sheet allowing users to rotate and inspect the model directly from the file browser on hover.
|
||||
- **Interactive 3D Viewer**: A specialized web viewer featuring 360° ruler scrubbing, rotation angle control (0° to 345°), playback controls, and angle-specific review comments and visual markups.
|
||||
|
||||
---
|
||||
|
||||
## Supported File Types
|
||||
|
||||
When turntable-renderer is configured, Shumai automatically generates 3D turntable proxies for the following formats:
|
||||
|
||||
| Format / Standard | Extensions |
|
||||
| --------------------------- | --------------------------------- |
|
||||
| Binary glTF | `.glb` |
|
||||
| Universal Scene Description | `.usd`, `.usda`, `.usdc`, `.usdz` |
|
||||
| Autodesk FBX | `.fbx` |
|
||||
| Wavefront OBJ | `.obj` |
|
||||
| Stereolithography (STL) | `.stl` |
|
||||
| COLLADA | `.dae` |
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
Shumai supports configuring the turntable renderer either through the **WebUI** or via **Environment Variables**.
|
||||
|
||||
### 1. WebUI (Team Settings → Integrations)
|
||||
|
||||
Team owners can configure the turntable renderer directly from the web interface:
|
||||
|
||||
1. Navigate to **Team Settings** from the sidebar.
|
||||
2. Select the **Integrations** tab.
|
||||
3. Under **3D Turntable Renderer**, enter the **Server URL** (e.g. `http://turntable-renderer:3000` or `http://localhost:3003`).
|
||||
4. Enter the **Username** and **Password** if Basic Authentication is enabled on the service.
|
||||
5. Click **Test Connection** to verify that Shumai can communicate with the renderer and check the detected Blender version.
|
||||
6. Click **Save Changes**.
|
||||
|
||||
### 2. Environment Variables
|
||||
|
||||
You can also configure turntable-renderer globally across the system using environment variables on the machine running Shumai or the transcode workers:
|
||||
|
||||
| Variable | Required | Description |
|
||||
| ---------------------------------------- | --------------- | ------------------------------------------------------------------------------------- |
|
||||
| `TURNTABLE_RENDERER_URL` | Yes (to enable) | Base URL of the turntable renderer service, e.g. `http://turntable-renderer:3000`. |
|
||||
| `TURNTABLE_RENDERER_BASIC_AUTH_USERNAME` | No | Username when Basic Authentication is enabled (alias: `TURNTABLE_RENDERER_USERNAME`). |
|
||||
| `TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD` | No | Password when Basic Authentication is enabled (alias: `TURNTABLE_RENDERER_PASSWORD`). |
|
||||
|
||||
### Configuration Priority & Read-Only Mode
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Environment variables take highest priority.** If `TURNTABLE_RENDERER_URL` is set in your environment, Shumai will always use the environment variable configuration.
|
||||
>
|
||||
> When configured via environment variables, the settings in **Team Settings → Integrations** will display a **Configured via environment variables (Read-only)** badge, and the input fields will be locked to prevent accidental changes or configuration drift.
|
||||
|
||||
---
|
||||
|
||||
## Deploying Turntable Renderer
|
||||
|
||||
### Docker Quickstart
|
||||
|
||||
The easiest way to run `turntable-renderer` is using the prebuilt Docker image:
|
||||
|
||||
```bash
|
||||
docker run -d --rm \
|
||||
--name turntable-renderer \
|
||||
-p 3003:3000 \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_USERNAME=admin \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_PASSWORD=your_password \
|
||||
shumaione/turntable-renderer:latest
|
||||
```
|
||||
|
||||
> **Note**: Host port `3003` maps to internal container port `3000`.
|
||||
|
||||
### Docker Compose Setup
|
||||
|
||||
Add a `turntable-renderer` service to your `docker-compose.yaml`:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
turntable-renderer:
|
||||
image: shumaione/turntable-renderer:latest
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- '3003:3000'
|
||||
environment:
|
||||
TURNTABLE_RENDERER_API_BASIC_AUTH_USERNAME: admin
|
||||
TURNTABLE_RENDERER_API_BASIC_AUTH_PASSWORD: your_password
|
||||
```
|
||||
|
||||
Then point Shumai at it:
|
||||
|
||||
```bash
|
||||
TURNTABLE_RENDERER_URL=http://localhost:3003
|
||||
TURNTABLE_RENDERER_BASIC_AUTH_USERNAME=admin
|
||||
TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD=your_password
|
||||
```
|
||||
|
||||
_(If both Shumai and turntable-renderer run within the same Docker Compose network, use `http://turntable-renderer:3000` as the URL)._
|
||||
|
||||
### GPU Acceleration
|
||||
|
||||
A dedicated GPU is optional — turntable-renderer's CPU rendering pipeline is fast enough for modest hardware. When a GPU is passed into the container, it is automatically detected and leveraged.
|
||||
|
||||
#### Intel / AMD (Open Source Drivers)
|
||||
|
||||
Pass the DRI render node:
|
||||
|
||||
```bash
|
||||
docker run -d --rm \
|
||||
--name turntable-renderer \
|
||||
--shm-size=1gb \
|
||||
-p 3003:3000 \
|
||||
--device /dev/dri \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_USERNAME=admin \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_PASSWORD=your_password \
|
||||
shumaione/turntable-renderer:latest
|
||||
```
|
||||
|
||||
#### NVIDIA (Proprietary Drivers)
|
||||
|
||||
Requires host driver 580+ and the NVIDIA Container Toolkit (`--runtime nvidia`):
|
||||
|
||||
```bash
|
||||
docker run -d --rm \
|
||||
--name turntable-renderer \
|
||||
--shm-size=1gb \
|
||||
-p 3003:3000 \
|
||||
--runtime nvidia \
|
||||
--gpus all \
|
||||
--device /dev/nvidia-modeset \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_USERNAME=admin \
|
||||
-e TURNTABLE_RENDERER_API_BASIC_AUTH_PASSWORD=your_password \
|
||||
shumaione/turntable-renderer:latest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Behavior Without Turntable Renderer
|
||||
|
||||
If turntable-renderer is not configured or unreachable:
|
||||
|
||||
- The 3D model upload completes successfully with status `processed`.
|
||||
- No turntable video proxy, sprite, or poster is generated.
|
||||
- The original raw 3D file is safely preserved and can be downloaded by team members.
|
||||
@@ -32,7 +32,22 @@ When Gotenberg is configured, Shumai automatically generates a PDF proxy for the
|
||||
|
||||
## Configuration
|
||||
|
||||
Gotenberg support is opt-in and controlled by the following environment variables on the machine running the transcode workers:
|
||||
Shumai supports configuring Gotenberg either through the **WebUI** or via **Environment Variables**.
|
||||
|
||||
### 1. WebUI (Team Settings → Integrations)
|
||||
|
||||
Team owners can configure Gotenberg directly from the web interface:
|
||||
|
||||
1. Navigate to **Team Settings** from the sidebar.
|
||||
2. Select the **Integrations** tab.
|
||||
3. Under **Gotenberg Document Converter**, enter the **Server URL** (e.g. `http://gotenberg:3000` or `http://localhost:3000`).
|
||||
4. Enter the **Username** and **Password** if Basic Authentication is enabled on the service.
|
||||
5. Click **Test Connection** to test communication with Gotenberg and verify its health.
|
||||
6. Click **Save Changes**.
|
||||
|
||||
### 2. Environment Variables
|
||||
|
||||
Gotenberg can also be configured globally across the system using environment variables on the machine running Shumai or the transcode workers:
|
||||
|
||||
| Variable | Required | Description |
|
||||
| ------------------------------- | --------------- | ---------------------------------------------------------------- |
|
||||
@@ -40,6 +55,15 @@ Gotenberg support is opt-in and controlled by the following environment variable
|
||||
| `GOTENBERG_BASIC_AUTH_USERNAME` | No | Username when Basic Authentication is enabled on Gotenberg. |
|
||||
| `GOTENBERG_BASIC_AUTH_PASSWORD` | No | Password when Basic Authentication is enabled on Gotenberg. |
|
||||
|
||||
### Configuration Priority & Read-Only Mode
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Environment variables take highest priority.** If `GOTENBERG_URL` is set in your environment, Shumai will always use the environment variable configuration.
|
||||
>
|
||||
> When configured via environment variables, the settings in **Team Settings → Integrations** will display a **Configured via environment variables (Read-only)** badge, and the input fields will be locked to prevent accidental changes or configuration drift.
|
||||
|
||||
### Deploying Gotenberg
|
||||
|
||||
### Docker Quickstart
|
||||
|
||||
You can start a Gotenberg container with a single command:
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "shumai",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"repository": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/agent",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -662,6 +662,23 @@ describe('Agent Activities', () => {
|
||||
const pdfPrompt = mockHarness.prompt.mock.calls[1]?.[0] ?? ''
|
||||
expect(pdfPrompt).toContain('Document pages: 50')
|
||||
expect(pdfPrompt).not.toContain('Video duration')
|
||||
|
||||
// For a 3D asset, should produce 3D Model recommendation
|
||||
await autofillAiActivity({
|
||||
teamId: 't1',
|
||||
assetId: 'model-3',
|
||||
assetName: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
images: [],
|
||||
fields: [{ id: 'f1', config: { name: 'F1', type: 'text' } }],
|
||||
context,
|
||||
})
|
||||
|
||||
const modelPrompt = mockHarness.prompt.mock.calls[2]?.[0] ?? ''
|
||||
expect(modelPrompt).toContain('3D Model: This asset has an orthogonal 4-view composite image')
|
||||
expect(modelPrompt).toContain(
|
||||
'Front view at top-left, Right side view at top-right, Back view at bottom-left, Left side view at bottom-right',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1170,6 +1187,43 @@ describe('Agent Database Activities Integration', () => {
|
||||
expect((rootEntry as any)?.details?.thread).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should set media position to degree for 3D asset comments', async () => {
|
||||
const asset3d = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: { proxyType: '3d' } as unknown as PrismaJson.MediaInfo,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
const comment3d = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: asset3d.id,
|
||||
message: 'Nice angle',
|
||||
creatorId: user.id,
|
||||
second: 0.5, // 45°
|
||||
},
|
||||
})
|
||||
|
||||
const sessionId = await initializeAgentSessionActivity({
|
||||
teamId: team.id,
|
||||
agentId: 'test-agent-id',
|
||||
userCommentId: comment3d.id,
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
const storage = new DatabaseSessionStorage(sessionId)
|
||||
const pathEntries = await storage.getPathToRoot(comment3d.id)
|
||||
const entry = pathEntries.find((e) => e.id === comment3d.id)
|
||||
|
||||
expect(entry).toBeDefined()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- test entry position parsing
|
||||
expect((entry as any)?.details?.position).toEqual({ type: 'degree', degree: 45 })
|
||||
})
|
||||
|
||||
it('should return user name and role for team member', async () => {
|
||||
const info = await getUserTeamInfoActivity({
|
||||
userId: user.id,
|
||||
@@ -2105,5 +2159,83 @@ describe('Agent Database Activities Integration', () => {
|
||||
expect(systemPromptArg).toContain('<thread id="..." reply_count="..." />')
|
||||
expect(systemPromptArg).toContain('read_thread')
|
||||
})
|
||||
|
||||
it('agentChatActivity injects # 3D Model Inspection into systemPrompt', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User_3d_Prompt', email: `prompt-3d-${Date.now()}@example.com` },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Team_3d_Prompt_' + Date.now() },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Project_3d_Prompt', teamId: team.id },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: { proxyType: '3d' } as unknown as PrismaJson.MediaInfo,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
const comment = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
creatorId: user.id,
|
||||
message: 'Check this 3d model',
|
||||
},
|
||||
})
|
||||
|
||||
const mockSession = {
|
||||
id: 'mock-session-id',
|
||||
subscribe: vi.fn(),
|
||||
getEntries: vi.fn().mockResolvedValue([]),
|
||||
getStorage: vi.fn().mockReturnValue({ sessionId: 'mock-session-id' }),
|
||||
}
|
||||
const mockHarness = {
|
||||
subscribe: vi.fn(),
|
||||
prompt: vi.fn().mockResolvedValue({
|
||||
content: [{ type: 'text', text: 'Response' }],
|
||||
usage: { input: 10, output: 20 },
|
||||
}),
|
||||
}
|
||||
|
||||
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
|
||||
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Mock AgentHarness instance for activity test
|
||||
harness: mockHarness as unknown as AgentHarness<any, any, any, any>,
|
||||
})
|
||||
|
||||
const context = {
|
||||
agent: { id: 'agent-1', provider: { name: 'google' }, modelRef: { modelId: 'gemini' } },
|
||||
dbProviders: [],
|
||||
teamSkills: [],
|
||||
allowedDomains: [],
|
||||
} as unknown as AgentExecutionContext
|
||||
|
||||
await agentChatActivity({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-1',
|
||||
message: 'Hello',
|
||||
imageUrls: [],
|
||||
projectId: project.id,
|
||||
folderId: asset.id,
|
||||
assetId: asset.id,
|
||||
sessionId: 'mock-session-id',
|
||||
userCommentId: comment.id,
|
||||
userId: user.id,
|
||||
context,
|
||||
})
|
||||
|
||||
const lastCall = vi.mocked(piAgent.createAgentSession).mock.calls.at(-1)
|
||||
const systemPromptArg = lastCall?.[0].systemPrompt as string
|
||||
expect(systemPromptArg).toContain('# 3D Model Inspection')
|
||||
expect(systemPromptArg).toContain('media_type="3d"')
|
||||
expect(systemPromptArg).toContain('config3d')
|
||||
expect(systemPromptArg).toContain('<position type="degree" degree="..." />')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -21,6 +21,7 @@ import {
|
||||
import { aiUsageService } from '@shumai/core/src/ai-usage/ai-usage'
|
||||
import { quotaService, QuotaExceededError } from '@shumai/core/src/quota/quota-service'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
import { secondToDegree } from '@shumai/core/src/utils/model3d'
|
||||
import {
|
||||
UpdateAssetMetadataRequest,
|
||||
type ShumaiMessageContext,
|
||||
@@ -179,6 +180,8 @@ User messages may contain a <context> block detailing the user, active asset loc
|
||||
systemPrompt += `\n\n# Comment Threads\nWhen operating in comment mode, previous top-level messages in the conversation history may contain a <thread id="..." reply_count="..." /> tag indicating an earlier discussion thread with replies. If a user's question refers to or depends on earlier comments or discussions, you can use the 'read_thread' tool with the thread ID to inspect all replies in that thread.`
|
||||
}
|
||||
|
||||
systemPrompt += `\n\n# 3D Model Inspection\nWhen interacting with 3D model assets (media_type="3d"), you can visually inspect the asset using 'read_asset'. Calling 'read_asset' with config3d: null (or config3d: {}) returns an orthogonal 4-view composite image (Front at top-left, Right side at top-right, Back at bottom-left, Left side at bottom-right). If a <position type="degree" degree="..." /> tag is present or a specific angle is discussed, pass 'config3d: { degree: ... }' (integer 0, 15, 30, ..., 345) to inspect that view angle. If an <annotation id="..." /> tag is present on a 3D asset, pass 'annotationId' to inspect the angle with the user's visual markup drawings overlaid.`
|
||||
|
||||
if (agent.type === 'autofill') {
|
||||
systemPrompt += `\n\n# Autofill Instructions\nWhen performing metadata autofill, inspect the asset content using the 'read_asset' tool. If 'read_asset' fails or returns an error, do not autofill any metadata and report to the user directly. Do not try anything fancy, for example downloading the file or using python/ffmpeg to extract content.`
|
||||
}
|
||||
@@ -564,6 +567,7 @@ export async function autofillAiActivity(params: AutofillAiParams) {
|
||||
const proxyType = getProxyType(params.mediaType, params.assetName)
|
||||
const isVideoOrAudio = proxyType === 'video' || proxyType === 'audio'
|
||||
const isPdf = proxyType === 'pdf'
|
||||
const is3d = proxyType === '3d'
|
||||
|
||||
if (params.duration !== undefined && params.duration > 0 && (!proxyType || isVideoOrAudio)) {
|
||||
promptLines.push(
|
||||
@@ -575,11 +579,16 @@ export async function autofillAiActivity(params: AutofillAiParams) {
|
||||
`- Document pages: ${params.pageCount}. Recommended inspection: call read_asset with docConfig: { mode: "pages", startPage: 1, endPage: ${Math.min(params.pageCount, 20)} } or mode: "text".`,
|
||||
)
|
||||
}
|
||||
if (is3d) {
|
||||
promptLines.push(
|
||||
'- 3D Model: This asset has an orthogonal 4-view composite image (2x2 grid showing Front view at top-left, Right side view at top-right, Back view at bottom-left, Left side view at bottom-right). Call read_asset to inspect the 4 views.',
|
||||
)
|
||||
}
|
||||
|
||||
promptLines.push(
|
||||
'',
|
||||
'Instructions:',
|
||||
`1. Call the "read_asset" tool with assetId: "${params.assetId || ''}" to inspect the asset content (use imageConfig, videoConfig, or docConfig according to the media type).`,
|
||||
`1. Call the "read_asset" tool with assetId: "${params.assetId || ''}" to inspect the asset content (use imageConfig, videoConfig, or docConfig according to the media type; for 3D assets, call read_asset directly to inspect the 4-view composite image).`,
|
||||
'2. After analyzing the retrieved content, call the "autofill_metadata" tool to provide the extracted metadata values.',
|
||||
'3. If "read_asset" fails or returns an error, do not autofill any metadata and report to the user directly. Do not try anything fancy, for example downloading the file or using python/ffmpeg to extract content.',
|
||||
)
|
||||
@@ -834,7 +843,9 @@ export async function initializeAgentSessionActivity(params: {
|
||||
|
||||
let position: ShumaiMediaPosition | undefined = undefined
|
||||
if (c.second !== null && c.second !== undefined) {
|
||||
if (proxyType === 'pdf') {
|
||||
if (proxyType === '3d') {
|
||||
position = { type: 'degree', degree: secondToDegree(c.second) }
|
||||
} else if (proxyType === 'pdf') {
|
||||
position = { type: 'page', page: Math.round(c.second) }
|
||||
} else {
|
||||
position = { type: 'time', seconds: c.second }
|
||||
@@ -852,7 +863,14 @@ export async function initializeAgentSessionActivity(params: {
|
||||
id: att.asset.id,
|
||||
name: att.asset.name,
|
||||
type: att.asset.type,
|
||||
mediaType: attProxyType as 'image' | 'video' | 'pdf' | 'audio' | 'other' | undefined,
|
||||
mediaType: attProxyType as
|
||||
| 'image'
|
||||
| 'video'
|
||||
| 'pdf'
|
||||
| 'audio'
|
||||
| '3d'
|
||||
| 'other'
|
||||
| undefined,
|
||||
mimeType: att.asset.mediaType || undefined,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -350,5 +350,24 @@ describe('serializeContextToXml', () => {
|
||||
'<context>\n <annotation id="test<id>&"123"" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('serializes position type="degree" with integer degree attribute without seconds', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'ast_3d',
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
mediaType: '3d',
|
||||
path: 'robot.glb',
|
||||
},
|
||||
position: {
|
||||
type: 'degree',
|
||||
degree: 45,
|
||||
},
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <current_asset id="ast_3d" name="robot.glb" type="file" media_type="3d" path="robot.glb" />\n <position type="degree" degree="45" />\n</context>',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -4,6 +4,7 @@ import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { resolveAnnotationsById } from './annotation-resolver'
|
||||
import { DatabaseSessionStorage } from '../database-session-storage'
|
||||
import type { SessionTreeEntry } from '@earendil-works/pi-agent-core'
|
||||
import { degreeToSecond } from '@shumai/core/src/utils/model3d'
|
||||
|
||||
describe('resolveAnnotationsById', () => {
|
||||
setupTestDbHooks()
|
||||
@@ -210,6 +211,89 @@ describe('resolveAnnotationsById', () => {
|
||||
])
|
||||
})
|
||||
|
||||
it('resolves annotations and degree position timestamp from 1-on-1 chat AgentSessionEntry for 3D assets', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User 3D', email: 'user3d@test.com', password: 'pw' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Team 3D' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Project 3D', teamId: team.id },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
projectId: project.id,
|
||||
status: 'uploaded',
|
||||
},
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: { name: 'Agent 3D', email: 'agent3d@example.com', type: 'agent' },
|
||||
})
|
||||
const agent = await prisma.agent.create({
|
||||
data: {
|
||||
id: agentUser.id,
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'test-provider', model: 'test-model' },
|
||||
},
|
||||
})
|
||||
|
||||
const storage = await DatabaseSessionStorage.create({
|
||||
agentId: agent.id,
|
||||
userId: user.id,
|
||||
assetId: asset.id,
|
||||
})
|
||||
|
||||
storage.currentMessageContext = {
|
||||
currentAsset: {
|
||||
id: asset.id,
|
||||
name: asset.name,
|
||||
type: 'file',
|
||||
path: asset.name,
|
||||
},
|
||||
position: { type: 'degree', degree: 45 },
|
||||
annotation: true,
|
||||
annotations: [
|
||||
{
|
||||
type: 'rectangle',
|
||||
x: 10,
|
||||
y: 20,
|
||||
width: 30,
|
||||
height: 40,
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
const userEntry: SessionTreeEntry = {
|
||||
type: 'message',
|
||||
id: '01JTEST3DENTRY123456789',
|
||||
parentId: null,
|
||||
timestamp: new Date().toISOString(),
|
||||
message: {
|
||||
role: 'user',
|
||||
content: 'Check markup at 45 degrees',
|
||||
timestamp: Date.now(),
|
||||
},
|
||||
}
|
||||
|
||||
await storage.appendEntry(userEntry)
|
||||
|
||||
const result = await resolveAnnotationsById(asset.id, '01JTEST3DENTRY123456789')
|
||||
expect(result.timestamp).toBeCloseTo(degreeToSecond(45))
|
||||
expect(result.annotations).toEqual([
|
||||
{
|
||||
type: 'rectangle',
|
||||
x: 10,
|
||||
y: 20,
|
||||
width: 30,
|
||||
height: 40,
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it('throws an error when AgentSessionEntry belongs to a different asset', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User', email: 'user3@test.com', password: 'pw' },
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import type { ShumaiMessageContext } from '@shumai/dtos'
|
||||
import { degreeToSecond } from '@shumai/core/src/utils/model3d'
|
||||
|
||||
export async function resolveAnnotationsById(
|
||||
assetId: string,
|
||||
@@ -44,7 +45,14 @@ export async function resolveAnnotationsById(
|
||||
const list = details?.annotations
|
||||
const annotations =
|
||||
Array.isArray(list) && list.length > 0 ? (list as unknown as PrismaJson.AnnotationList) : null
|
||||
const timestamp = details?.position?.type === 'time' ? details.position.seconds : null
|
||||
let timestamp: number | null = null
|
||||
if (details?.position?.type === 'time') {
|
||||
timestamp = details.position.seconds
|
||||
} else if (details?.position?.type === 'degree') {
|
||||
timestamp = degreeToSecond(details.position.degree)
|
||||
} else if (details?.position?.type === 'page') {
|
||||
timestamp = details.position.page
|
||||
}
|
||||
return { annotations, timestamp }
|
||||
}
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import * as annotationResolver from './annotation-resolver'
|
||||
import { degreeToSecond } from '@shumai/core/src/utils/model3d'
|
||||
|
||||
vi.mock('@shumai/db', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@shumai/db')>()
|
||||
@@ -211,6 +212,476 @@ describe('readAssetTool', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('3D Assets', () => {
|
||||
it('should read 3D asset 4-views image and return image with quadrant layout description', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
storageKey: { key: 'raw/robot.glb' },
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [{ key: 'proxy/views.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-views-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-3d', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'model-1',
|
||||
})
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/views.webp')
|
||||
|
||||
const textItem = result.content[0] as { type: 'text'; text: string }
|
||||
const imageItem = result.content[1] as { type: 'image'; data: string; mimeType: string }
|
||||
|
||||
expect(textItem.text).toContain('Orthogonal 4-view composite image')
|
||||
expect(textItem.text).toContain('Top-Left quadrant: Front view (0°)')
|
||||
expect(textItem.text).toContain('Top-Right quadrant: Right side view (90°)')
|
||||
expect(textItem.text).toContain('Bottom-Left quadrant: Back view (180°)')
|
||||
expect(textItem.text).toContain('Bottom-Right quadrant: Left side view (270°)')
|
||||
expect(imageItem.type).toBe('image')
|
||||
expect(imageItem.data).toBe(Buffer.from('fake-views-bytes').toString('base64'))
|
||||
expect(result.details.key).toBe('proxy/views.webp')
|
||||
})
|
||||
|
||||
it('should support s3KeyOnly mode for 3D assets', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [{ key: 'proxy/views.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-3d-s3', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
s3KeyOnly: true,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(result.content).toHaveLength(1)
|
||||
const textItem = result.content[0] as { type: 'text'; text: string }
|
||||
expect(textItem.text).toContain('proxy/views.webp')
|
||||
expect(textItem.text).toContain('Front view (0°)')
|
||||
expect(result.details.key).toBe('proxy/views.webp')
|
||||
})
|
||||
|
||||
it('should throw error if videoConfig is passed for 3D assets', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [{ key: 'proxy/views.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-3d-err', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: { start: 0, end: 4, count: 4 },
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
"To inspect specific angles pass 'config3d: { degree: ... }'; do not pass videoConfig",
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if 3D asset imageTranscodes is missing when overview is requested', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-3d-err2', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('4-views image (views.webp) is missing')
|
||||
})
|
||||
|
||||
it('should extract specific turntable frame when config3d.degree is provided', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
projectId: 'proj-1',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [{ key: 'proxy/turntable.mp4' }],
|
||||
imageTranscodes: [{ key: 'proxy/views.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-shot-3d',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-shot-3d',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: {
|
||||
screenshots: [{ key: 'proxy/shot-45.webp', timestamp: 0.5833 }],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-shot-45-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-3d-degree', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
config3d: { degree: 45 },
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: expect.objectContaining({
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
assetId: 'model-1',
|
||||
payload: {
|
||||
projectId: 'proj-1',
|
||||
screenshot: {
|
||||
start: expect.any(Number),
|
||||
end: expect.any(Number),
|
||||
count: 1,
|
||||
commentTimestamp: expect.any(Number),
|
||||
annotations: undefined,
|
||||
},
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
||||
const textItem = result.content[0] as { type: 'text'; text: string }
|
||||
const imageItem = result.content[1] as { type: 'image'; data: string; mimeType: string }
|
||||
|
||||
expect(textItem.text).toContain('view at 45°:')
|
||||
expect(imageItem.data).toBe(Buffer.from('fake-shot-45-bytes').toString('base64'))
|
||||
expect(result.details.key).toBe('proxy/shot-45.webp')
|
||||
})
|
||||
|
||||
it('should throw error when config3d.degree is not a multiple of 15 or out of range', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [{ key: 'proxy/turntable.mp4' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
|
||||
await expect(
|
||||
tool.execute('call-3d-invalid-deg', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
config3d: { degree: 40 },
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Invalid turntable degree: 40')
|
||||
|
||||
await expect(
|
||||
tool.execute('call-3d-out-of-range', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
config3d: { degree: 360 },
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Invalid turntable degree: 360')
|
||||
})
|
||||
|
||||
it('should extract frame with overlaid markups when annotationId is provided on 3D asset', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
projectId: 'proj-1',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [{ key: 'proxy/turntable.mp4' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.spyOn(annotationResolver, 'resolveAnnotationsById').mockResolvedValue({
|
||||
annotations: [
|
||||
{
|
||||
type: 'freehand',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
timestamp: 0.5, // 0.5s = 45°
|
||||
})
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-shot-ann',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-shot-ann',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: {
|
||||
screenshots: [{ key: 'proxy/shot-annotated.webp', timestamp: 0.5 }],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-shot-ann-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-3d-ann', {
|
||||
assetId: 'model-1',
|
||||
annotationId: 'comm-1',
|
||||
config3d: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: expect.objectContaining({
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
assetId: 'model-1',
|
||||
payload: {
|
||||
projectId: 'proj-1',
|
||||
screenshot: {
|
||||
start: 0.5,
|
||||
end: 0.5,
|
||||
count: 1,
|
||||
commentTimestamp: 0.5,
|
||||
annotations: [
|
||||
{
|
||||
type: 'freehand',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
||||
const textItem = result.content[0] as { type: 'text'; text: string }
|
||||
expect(textItem.text).toContain('view at 45° with visual markups overlaid:')
|
||||
expect(result.details.key).toBe('proxy/shot-annotated.webp')
|
||||
})
|
||||
|
||||
it('should extract turntable frame at resolved degree angle for 3D session annotations', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
projectId: 'proj-1',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [{ key: 'proxy/turntable.mp4' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const expectedTime = degreeToSecond(90)
|
||||
vi.spyOn(annotationResolver, 'resolveAnnotationsById').mockResolvedValue({
|
||||
annotations: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#00ff00',
|
||||
points: [
|
||||
[10, 20],
|
||||
[40, 60],
|
||||
],
|
||||
},
|
||||
],
|
||||
timestamp: expectedTime,
|
||||
})
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-shot-3d-session',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-shot-3d-session',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: {
|
||||
screenshots: [{ key: 'proxy/shot-annotated-90.webp', timestamp: expectedTime }],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-shot-90-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-3d-session-ann', {
|
||||
assetId: 'model-1',
|
||||
annotationId: 'session-entry-1',
|
||||
config3d: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: expect.objectContaining({
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
assetId: 'model-1',
|
||||
payload: {
|
||||
projectId: 'proj-1',
|
||||
screenshot: {
|
||||
start: expectedTime,
|
||||
end: expectedTime,
|
||||
count: 1,
|
||||
commentTimestamp: expectedTime,
|
||||
annotations: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#00ff00',
|
||||
points: [
|
||||
[10, 20],
|
||||
[40, 60],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}),
|
||||
})
|
||||
|
||||
const textItem = result.content[0] as { type: 'text'; text: string }
|
||||
expect(textItem.text).toContain('view at 90° with visual markups overlaid:')
|
||||
expect(result.details.key).toBe('proxy/shot-annotated-90.webp')
|
||||
})
|
||||
|
||||
it('should throw error if config3d.degree conflicts with annotation angle', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
projectId: 'proj-1',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [{ key: 'proxy/turntable.mp4' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.spyOn(annotationResolver, 'resolveAnnotationsById').mockResolvedValue({
|
||||
annotations: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
timestamp: 0.5, // 45°
|
||||
})
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-3d-conflict', {
|
||||
assetId: 'model-1',
|
||||
annotationId: 'comm-1',
|
||||
config3d: { degree: 90 }, // Conflicts with 45°
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
'Annotation "comm-1" was drawn at 45°, but degree 90° was specified. Do not pass a conflicting degree with annotationId.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if 3D asset turntable video is missing when angle inspection is requested', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'model-1',
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-3d-missing-turntable', {
|
||||
assetId: 'model-1',
|
||||
annotationId: null,
|
||||
config3d: { degree: 45 },
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('turntable video (turntable.mp4) is missing')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Video Assets', () => {
|
||||
it('should throw error if videoConfig is missing for video assets', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
@@ -7,6 +7,12 @@ import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { resolveAnnotationsById } from './annotation-resolver'
|
||||
import { getFileMimeType } from '@shumai/core/src/utils/file-mime'
|
||||
import { is3dModel } from '@shumai/core/src/utils/mime'
|
||||
import {
|
||||
isValidTurntableDegree,
|
||||
secondToDegree,
|
||||
degreeToSecond,
|
||||
} from '@shumai/core/src/utils/model3d'
|
||||
|
||||
export const readAssetSchema = Type.Object(
|
||||
{
|
||||
@@ -37,6 +43,31 @@ export const readAssetSchema = Type.Object(
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
config3d: Type.Optional(
|
||||
Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
degree: Type.Optional(
|
||||
Type.Union([
|
||||
Type.Integer({
|
||||
minimum: 0,
|
||||
maximum: 345,
|
||||
description:
|
||||
'Turntable rotation degree (integer: 0, 15, 30, ..., 345 in 15° increments) to inspect a specific angle of a 3D model. Leave null/omitted to view the 4-view composite overview.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
),
|
||||
},
|
||||
{
|
||||
additionalProperties: false,
|
||||
description:
|
||||
'Configuration for 3D model assets. Pass null if inspecting another asset type. Optionally pass degree to inspect a specific turntable angle, or leave null/omitted to view the 4-view composite overview.',
|
||||
},
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
),
|
||||
videoConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
@@ -167,12 +198,12 @@ export function createReadAssetTool(
|
||||
label: 'Read Asset',
|
||||
description:
|
||||
'Inspects and reads the content of an asset in the workspace. ' +
|
||||
'Supports visual analysis for images, video frame extraction, PDF page rendering, and direct text reading for text/markdown files. ' +
|
||||
'Pass assetId, and provide the specific config (imageConfig, videoConfig, or docConfig) while setting unused configs to null. ' +
|
||||
'Supports visual analysis for images, 3D models (overview or specific degree angle), video frame extraction, PDF page rendering, and direct text reading for text/markdown files. ' +
|
||||
'Pass assetId, and provide the specific config (imageConfig, config3d, videoConfig, or docConfig) while setting unused configs to null. ' +
|
||||
'Optionally provide annotationId to view visual markups drawn on the asset.',
|
||||
parameters: readAssetSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const { assetId, annotationId, s3KeyOnly, videoConfig, docConfig } = params
|
||||
const { assetId, annotationId, s3KeyOnly, config3d, videoConfig, docConfig } = params
|
||||
|
||||
if (agentType === 'autofill' && !userId) {
|
||||
if (!targetAssetId) {
|
||||
@@ -243,6 +274,209 @@ export function createReadAssetTool(
|
||||
const filename = asset.name?.toLowerCase() || ''
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Branch 0: 3D Assets (Orthogonal 4-View Composite Image or Degree Angle)
|
||||
// ----------------------------------------------------------------------
|
||||
const is3d = proxyType === '3d' || is3dModel(mediaType, filename)
|
||||
if (is3d) {
|
||||
if (videoConfig) {
|
||||
throw new Error(
|
||||
`Asset ${asset.id} is a 3D model. To inspect specific angles pass 'config3d: { degree: ... }'; do not pass videoConfig.`,
|
||||
)
|
||||
}
|
||||
|
||||
if (config3d?.degree !== undefined && config3d?.degree !== null) {
|
||||
if (!isValidTurntableDegree(config3d.degree)) {
|
||||
throw new Error(
|
||||
`Invalid turntable degree: ${config3d.degree}. Degree must be an integer multiple of 15 between 0 and 345 (e.g. 0, 15, 30, 45, ..., 345).`,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
let annotations: PrismaJson.AnnotationList | null = null
|
||||
let commentTimestamp: number | null = null
|
||||
if (annotationId) {
|
||||
const resolved = await resolveAnnotationsById(asset.id, annotationId)
|
||||
annotations = resolved.annotations
|
||||
commentTimestamp = resolved.timestamp
|
||||
if (commentTimestamp !== null && commentTimestamp !== undefined) {
|
||||
const commentDegree = secondToDegree(commentTimestamp)
|
||||
if (
|
||||
config3d?.degree !== undefined &&
|
||||
config3d?.degree !== null &&
|
||||
config3d.degree !== commentDegree
|
||||
) {
|
||||
throw new Error(
|
||||
`Annotation "${annotationId}" was drawn at ${commentDegree}°, but degree ${config3d.degree}° was specified. Do not pass a conflicting degree with annotationId.`,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ((config3d?.degree !== undefined && config3d?.degree !== null) || annotationId) {
|
||||
if (!mediaInfo?.videoTranscodes || mediaInfo.videoTranscodes.length === 0) {
|
||||
throw new Error(
|
||||
`Asset ${asset.id} is a 3D model, but its turntable video (turntable.mp4) is missing.`,
|
||||
)
|
||||
}
|
||||
|
||||
let targetDegree: number
|
||||
let targetSecond: number
|
||||
|
||||
if (config3d?.degree !== undefined && config3d?.degree !== null) {
|
||||
targetDegree = config3d.degree
|
||||
targetSecond = degreeToSecond(targetDegree)
|
||||
} else {
|
||||
targetSecond =
|
||||
commentTimestamp !== null && commentTimestamp !== undefined ? commentTimestamp : 0
|
||||
targetDegree = secondToDegree(targetSecond)
|
||||
}
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
screenshot: {
|
||||
start: targetSecond,
|
||||
end: targetSecond,
|
||||
count: 1,
|
||||
commentTimestamp: targetSecond,
|
||||
annotations: annotations ?? undefined,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- transcode screenshot output
|
||||
const output = completedTask.output as any
|
||||
const screenshots = output?.screenshots as
|
||||
| Array<{ key: string; timestamp: number }>
|
||||
| undefined
|
||||
|
||||
if (!screenshots || screenshots.length === 0) {
|
||||
throw new Error(
|
||||
`Failed to extract 3D turntable frame for asset ${asset.id} at ${targetDegree}°.`,
|
||||
)
|
||||
}
|
||||
|
||||
const shotKey = screenshots[0].key
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
shotKey,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
const content: Array<TextContent | ImageContent> = []
|
||||
const hasMarkup = Boolean(annotations && annotations.length > 0)
|
||||
const textDescription = hasMarkup
|
||||
? `3D asset "${asset.name}" (ID: ${asset.id}, S3 Key: "${shotKey}") view at ${targetDegree}° with visual markups overlaid:`
|
||||
: `3D asset "${asset.name}" (ID: ${asset.id}, S3 Key: "${shotKey}") view at ${targetDegree}°:`
|
||||
|
||||
if (s3KeyOnly) {
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: textDescription,
|
||||
})
|
||||
} else {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, shotKey)
|
||||
const actualMimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : 'image/webp'
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: textDescription,
|
||||
})
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType: actualMimeType,
|
||||
})
|
||||
}
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
key: shotKey,
|
||||
downloadUrl,
|
||||
sourceKeys: [shotKey],
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
if (!mediaInfo?.imageTranscodes || mediaInfo.imageTranscodes.length === 0) {
|
||||
throw new Error(
|
||||
`Asset ${asset.id} is a 3D model, but its 4-views image (views.webp) is missing.`,
|
||||
)
|
||||
}
|
||||
|
||||
const mediaKey = mediaInfo.imageTranscodes[0].key
|
||||
if (!mediaKey) {
|
||||
throw new Error(`Asset ${asset.id} is a 3D model, but its 4-views image key is missing.`)
|
||||
}
|
||||
|
||||
const keyToUse = mediaKey
|
||||
const mimeType = 'image/webp'
|
||||
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
keyToUse,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
const content: Array<TextContent | ImageContent> = []
|
||||
const textDescription = [
|
||||
`3D asset "${asset.name}" (ID: ${asset.id}, MIME: ${mimeType}, S3 Key: "${keyToUse}"):`,
|
||||
'Orthogonal 4-view composite image (2x2 grid across 360° rotation):',
|
||||
'- Top-Left quadrant: Front view (0°)',
|
||||
'- Top-Right quadrant: Right side view (90°)',
|
||||
'- Bottom-Left quadrant: Back view (180°)',
|
||||
'- Bottom-Right quadrant: Left side view (270°)',
|
||||
].join('\n')
|
||||
|
||||
if (s3KeyOnly) {
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: textDescription,
|
||||
})
|
||||
} else {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, keyToUse)
|
||||
const actualMimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : mimeType
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: textDescription,
|
||||
})
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType: actualMimeType,
|
||||
})
|
||||
}
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
key: keyToUse,
|
||||
downloadUrl,
|
||||
sourceKeys: [keyToUse],
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Branch 1: Image Assets
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
@@ -129,6 +129,42 @@ describe('createReadThreadTool', () => {
|
||||
expect(textContent).toContain('- [Ai Agent] (id: reply-1, has_markup: false): Agent answer')
|
||||
})
|
||||
|
||||
it('should format 3d asset comment timestamps as degree: X°', async () => {
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'root-3d',
|
||||
message: 'Notice this angle',
|
||||
creator: { name: 'Alice' },
|
||||
second: 0.5,
|
||||
annotation: [{ type: 'box' }],
|
||||
asset: {
|
||||
media: { proxyType: '3d' },
|
||||
mediaType: 'model/gltf-binary',
|
||||
name: 'robot.glb',
|
||||
},
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any)
|
||||
vi.mocked(prisma.assetComment.findMany).mockResolvedValue([
|
||||
{
|
||||
id: 'reply-3d-1',
|
||||
message: 'Looking at back side',
|
||||
creator: { name: 'Bob' },
|
||||
second: 2.0,
|
||||
},
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
] as any)
|
||||
|
||||
const tool = createReadThreadTool()
|
||||
const result = await tool.execute('call-3d', { threadId: 'root-3d' })
|
||||
const textContent = (result.content[0] as { text: string }).text
|
||||
|
||||
expect(textContent).toContain(
|
||||
'Thread Root [Alice] (id: root-3d, degree: 45°, has_markup: true): Notice this angle',
|
||||
)
|
||||
expect(textContent).toContain(
|
||||
'- [Bob] (id: reply-3d-1, degree: 180°, has_markup: false): Looking at back side',
|
||||
)
|
||||
})
|
||||
|
||||
it('should describe threadId parameter as referencing <thread id="..." /> in <context>', () => {
|
||||
const tool = createReadThreadTool()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { secondToDegree } from '@shumai/core/src/utils/model3d'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
|
||||
const readThreadSchema = Type.Object({
|
||||
threadId: Type.String({
|
||||
@@ -9,14 +11,21 @@ const readThreadSchema = Type.Object({
|
||||
}),
|
||||
})
|
||||
|
||||
function formatCommentMeta(c: {
|
||||
id: string
|
||||
second?: number | null
|
||||
annotation?: unknown
|
||||
}): string {
|
||||
function formatCommentMeta(
|
||||
c: {
|
||||
id: string
|
||||
second?: number | null
|
||||
annotation?: unknown
|
||||
},
|
||||
proxyType?: string,
|
||||
): string {
|
||||
const parts = [`id: ${c.id}`]
|
||||
if (c.second !== null && c.second !== undefined) {
|
||||
parts.push(`time: ${c.second}s`)
|
||||
if (proxyType === '3d') {
|
||||
parts.push(`degree: ${secondToDegree(c.second)}°`)
|
||||
} else {
|
||||
parts.push(`time: ${c.second}s`)
|
||||
}
|
||||
}
|
||||
const hasMarkup = Boolean(c.annotation && Array.isArray(c.annotation) && c.annotation.length > 0)
|
||||
parts.push(`has_markup: ${hasMarkup}`)
|
||||
@@ -34,7 +43,10 @@ export const createReadThreadTool = (): AgentTool<
|
||||
execute: async (_toolCallId, params) => {
|
||||
const rootComment = await prisma.assetComment.findUnique({
|
||||
where: { id: params.threadId },
|
||||
include: { creator: true },
|
||||
include: {
|
||||
creator: true,
|
||||
asset: { select: { media: true, mediaType: true, name: true } },
|
||||
},
|
||||
})
|
||||
|
||||
if (!rootComment) {
|
||||
@@ -61,9 +73,14 @@ export const createReadThreadTool = (): AgentTool<
|
||||
include: { creator: true },
|
||||
})
|
||||
|
||||
const proxyType =
|
||||
(rootComment.asset?.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(rootComment.asset?.mediaType, rootComment.asset?.name) ||
|
||||
undefined
|
||||
|
||||
const isRootAgent = rootComment.creator?.type === 'agent' || rootComment.sessionId !== null
|
||||
const rootAuthor = rootComment.creator?.name || (isRootAgent ? 'Ai Agent' : 'User')
|
||||
const rootMeta = formatCommentMeta(rootComment)
|
||||
const rootMeta = formatCommentMeta(rootComment, proxyType)
|
||||
let output = `Thread Root [${rootAuthor}] ${rootMeta}: ${rootComment.message || ''}\n\nReplies (${replies.length}):`
|
||||
|
||||
if (replies.length === 0) {
|
||||
@@ -72,7 +89,7 @@ export const createReadThreadTool = (): AgentTool<
|
||||
for (const reply of replies) {
|
||||
const isAgent = reply.creator?.type === 'agent' || reply.sessionId !== null
|
||||
const author = reply.creator?.name || (isAgent ? 'Ai Agent' : 'User')
|
||||
const replyMeta = formatCommentMeta(reply)
|
||||
const replyMeta = formatCommentMeta(reply, proxyType)
|
||||
output += `\n- [${author}] ${replyMeta}: ${reply.message || ''}`
|
||||
}
|
||||
}
|
||||
|
||||
@@ -806,4 +806,89 @@ describe('Agent Chat Workflow', () => {
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should format mediaPosition as degree for 3D assets in 1-on-1 chat', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'a-3d',
|
||||
project: { teamId: 't1' },
|
||||
type: 'file',
|
||||
name: 'model.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: { proxyType: '3d' },
|
||||
parentId: null,
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'a-3d',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: {
|
||||
agentId: 'b1',
|
||||
prompt: 'Look at this angle',
|
||||
sessionId: 'session-3d-1',
|
||||
second: 0.5, // 0.5s turntable time = 45°
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
position: { type: 'degree', degree: 45 },
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should format mediaPosition as degree for 3D assets in comment mode', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'a-3d',
|
||||
project: { teamId: 't1' },
|
||||
type: 'file',
|
||||
name: 'model.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
media: { proxyType: '3d' },
|
||||
parentId: null,
|
||||
})
|
||||
|
||||
mockActivities.getCommentActivity.mockResolvedValue({
|
||||
id: 'comment-3d-1',
|
||||
creatorId: 'user-c1',
|
||||
message: 'Look at the back',
|
||||
replyToId: null,
|
||||
second: 2.0, // 2.0s = 180°
|
||||
attachments: [],
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'a-3d',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: {
|
||||
agentId: 'b1',
|
||||
userCommentId: 'comment-3d-1',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
position: { type: 'degree', degree: 180 },
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -8,6 +8,7 @@ import type {
|
||||
ShumaiMediaPosition,
|
||||
} from '@shumai/dtos'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
import { secondToDegree } from '@shumai/core/src/utils/model3d'
|
||||
|
||||
export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
const {
|
||||
@@ -273,7 +274,9 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
// Build position
|
||||
let mediaPosition: ShumaiMediaPosition | undefined
|
||||
if (commentTimestamp !== undefined && commentTimestamp !== null) {
|
||||
if (proxyType === 'pdf') {
|
||||
if (proxyType === '3d') {
|
||||
mediaPosition = { type: 'degree', degree: secondToDegree(commentTimestamp) }
|
||||
} else if (proxyType === 'pdf') {
|
||||
mediaPosition = { type: 'page', page: Math.round(commentTimestamp) }
|
||||
} else {
|
||||
mediaPosition = { type: 'time', seconds: commentTimestamp }
|
||||
|
||||
@@ -211,6 +211,68 @@ describe('Agent Embedding Workflow', () => {
|
||||
})
|
||||
})
|
||||
|
||||
it('should run agent embedding workflow successfully for 3D asset using 4-views image', async () => {
|
||||
mockActivities.getEmbeddingContextActivity.mockResolvedValue({
|
||||
agent: { id: 'b1' },
|
||||
asset: {
|
||||
id: 'model-1',
|
||||
mediaType: 'model/gltf-binary',
|
||||
storageKey: { key: 'raw/model.glb' },
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [{ key: 'files/views.webp', format: 'webp' }],
|
||||
},
|
||||
},
|
||||
chunkDuration: 60.0,
|
||||
chunkOverlap: 5.0,
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_embedding',
|
||||
status: 'pending',
|
||||
assetId: 'model-1',
|
||||
teamId: 't1',
|
||||
},
|
||||
})
|
||||
|
||||
await agentEmbeddingMedia(task)
|
||||
|
||||
expect(mockActivities.generateImageEmbeddingActivity).toHaveBeenCalledWith({
|
||||
teamId: 't1',
|
||||
assetKey: 'files/views.webp',
|
||||
mediaType: 'image/webp',
|
||||
})
|
||||
})
|
||||
|
||||
it('should reject 3D asset for embeddings if imageTranscodes is missing', async () => {
|
||||
mockActivities.getEmbeddingContextActivity.mockResolvedValue({
|
||||
agent: { id: 'b1' },
|
||||
asset: {
|
||||
id: 'model-1',
|
||||
mediaType: 'model/gltf-binary',
|
||||
storageKey: { key: 'raw/model.glb' },
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [],
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_embedding',
|
||||
status: 'pending',
|
||||
assetId: 'model-1',
|
||||
teamId: 't1',
|
||||
},
|
||||
})
|
||||
|
||||
await expect(agentEmbeddingMedia(task)).rejects.toThrow(
|
||||
'unsupported media type for embeddings: model/gltf-binary',
|
||||
)
|
||||
})
|
||||
|
||||
it('should run agent embedding workflow successfully for video in chunks', async () => {
|
||||
mockActivities.getEmbeddingContextActivity.mockResolvedValue({
|
||||
agent: { id: 'b1' },
|
||||
|
||||
@@ -70,7 +70,10 @@ export async function agentEmbeddingMedia(task: WorkflowTask): Promise<void> {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const { asset, chunkDuration, chunkOverlap } = context as any
|
||||
|
||||
const isImage = asset.mediaType?.startsWith('image/')
|
||||
const mediaInfo = asset.media as PrismaJson.MediaInfo | null
|
||||
const is3dWithViews =
|
||||
mediaInfo?.proxyType === '3d' && (mediaInfo.imageTranscodes?.length ?? 0) > 0
|
||||
const isImage = asset.mediaType?.startsWith('image/') || is3dWithViews
|
||||
const isVideo = asset.mediaType?.startsWith('video/')
|
||||
|
||||
if (!isImage && !isVideo) {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/api",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -42,7 +42,8 @@ async function applyWatermarkToAssetMedia(
|
||||
password?: string,
|
||||
): Promise<AssetInfo> {
|
||||
if (!asset.media) return asset
|
||||
if (asset.proxyType !== 'video' && asset.proxyType !== 'image') return asset
|
||||
if (asset.proxyType !== 'video' && asset.proxyType !== 'image' && asset.proxyType !== '3d')
|
||||
return asset
|
||||
|
||||
const updatedMedia = { ...asset.media }
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
@@ -58,10 +59,27 @@ async function applyWatermarkToAssetMedia(
|
||||
height: vt.height ?? 0,
|
||||
size: 0,
|
||||
hdr: vt.hdr,
|
||||
resolution: vt.resolution,
|
||||
})),
|
||||
)
|
||||
: []
|
||||
|
||||
if (watermarkMedia?.videoTranscodes && watermarkMedia.videoTranscodes.length > 0) {
|
||||
if (updatedMedia.videoPreview) {
|
||||
const watermarkedKey =
|
||||
watermarkMedia.videoPreview?.key || watermarkMedia.videoTranscodes[0]?.key
|
||||
if (watermarkedKey) {
|
||||
updatedMedia.videoPreview = {
|
||||
...updatedMedia.videoPreview,
|
||||
key: watermarkedKey,
|
||||
url: await s3Service.presign(bucket, watermarkedKey, 'GET'),
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
delete updatedMedia.videoPreview
|
||||
}
|
||||
|
||||
updatedMedia.imageTranscodes =
|
||||
watermarkMedia?.imageTranscodes && watermarkMedia.imageTranscodes.length > 0
|
||||
? await Promise.all(
|
||||
@@ -254,11 +272,11 @@ const route = app
|
||||
|
||||
let asset = await assetService.getAsset({ assetId: fileId })
|
||||
|
||||
// Only video/image assets are subject to watermark protection; skip the
|
||||
// Only video/image/3d assets are subject to watermark protection; skip the
|
||||
// watermark lookup entirely for other media types (pdf, audio, ...).
|
||||
if (
|
||||
shareLink.watermarkConfigId &&
|
||||
(asset.proxyType === 'video' || asset.proxyType === 'image')
|
||||
(asset.proxyType === 'video' || asset.proxyType === 'image' || asset.proxyType === '3d')
|
||||
) {
|
||||
const targetAssetId = await assetService.resolveLatestVersionId(fileId)
|
||||
const wfMap = await watermarkService.getCompletedWatermarkMediaMap(
|
||||
|
||||
@@ -513,6 +513,121 @@ describe('Share API', () => {
|
||||
expect(body.media.hls).toBeUndefined()
|
||||
})
|
||||
|
||||
test('serves watermarked turntable video for a 3d asset when watermark enabled and completed', async () => {
|
||||
vi.spyOn(shareService, 'verifyPublicAccess').mockResolvedValue(shareLinkWithWatermark)
|
||||
const asset3d = {
|
||||
id: 'file1',
|
||||
name: 'model.glb',
|
||||
sizeByte: 1024,
|
||||
fileCount: 0,
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
proxyType: '3d',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoPreview: {
|
||||
url: 'http://s3/unwatermarked-turntable.mp4',
|
||||
key: 'files/turntable.mp4',
|
||||
},
|
||||
videoTranscodes: [
|
||||
{
|
||||
id: 'orig-turntable',
|
||||
url: 'http://s3/unwatermarked-turntable.mp4',
|
||||
key: 'files/turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
],
|
||||
original: { key: 'files/model.glb' },
|
||||
},
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any
|
||||
vi.spyOn(assetService, 'getAsset').mockResolvedValue(asset3d)
|
||||
vi.spyOn(watermarkService, 'getCompletedWatermarkMediaMap').mockResolvedValue(
|
||||
new Map([
|
||||
[
|
||||
'file1',
|
||||
watermarkMediaInfo({
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [
|
||||
{
|
||||
key: 'files/watermarked-turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
},
|
||||
],
|
||||
videoPreview: { key: 'files/watermarked-turntable.mp4', width: 1080, height: 1080 },
|
||||
}),
|
||||
],
|
||||
]),
|
||||
)
|
||||
|
||||
const res = await app.request('/shares/share1/files/file1', {
|
||||
method: 'GET',
|
||||
headers: { 'x-share-password': 'pass' },
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const body = await res.json()
|
||||
expect(body.media.videoTranscodes).toEqual([
|
||||
{
|
||||
id: 'files/watermarked-turntable.mp4',
|
||||
url: 'http://s3/presigned',
|
||||
key: 'files/watermarked-turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
size: 0,
|
||||
resolution: '1080p',
|
||||
},
|
||||
])
|
||||
expect(body.media.videoPreview?.url).toBe('http://s3/presigned')
|
||||
expect(body.media.videoPreview?.key).toBe('files/watermarked-turntable.mp4')
|
||||
})
|
||||
|
||||
test('strips videoPreview url and serves empty videoTranscodes for a 3d asset while watermark is in flight', async () => {
|
||||
vi.spyOn(shareService, 'verifyPublicAccess').mockResolvedValue(shareLinkWithWatermark)
|
||||
const asset3d = {
|
||||
id: 'file1',
|
||||
name: 'model.glb',
|
||||
sizeByte: 1024,
|
||||
fileCount: 0,
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
proxyType: '3d',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoPreview: {
|
||||
url: 'http://s3/unwatermarked-turntable.mp4',
|
||||
key: 'files/turntable.mp4',
|
||||
},
|
||||
videoTranscodes: [
|
||||
{
|
||||
id: 'orig-turntable',
|
||||
url: 'http://s3/unwatermarked-turntable.mp4',
|
||||
key: 'files/turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
],
|
||||
original: { key: 'files/model.glb' },
|
||||
},
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any
|
||||
vi.spyOn(assetService, 'getAsset').mockResolvedValue(asset3d)
|
||||
vi.spyOn(watermarkService, 'getCompletedWatermarkMediaMap').mockResolvedValue(new Map())
|
||||
|
||||
const res = await app.request('/shares/share1/files/file1', {
|
||||
method: 'GET',
|
||||
headers: { 'x-share-password': 'pass' },
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const body = await res.json()
|
||||
expect(body.media.videoTranscodes).toEqual([])
|
||||
expect(body.media.videoPreview?.url).toBeUndefined()
|
||||
})
|
||||
|
||||
test('leaves non-video/image media untouched when watermark enabled', async () => {
|
||||
vi.spyOn(shareService, 'verifyPublicAccess').mockResolvedValue(shareLinkWithWatermark)
|
||||
vi.spyOn(assetService, 'getAsset').mockResolvedValue({
|
||||
|
||||
@@ -52,6 +52,22 @@ vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/turntable/turntable', () => ({
|
||||
turntableService: {
|
||||
getSettings: vi.fn(),
|
||||
updateSettings: vi.fn(),
|
||||
testConnection: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/gotenberg/gotenberg', () => ({
|
||||
gotenbergService: {
|
||||
getSettings: vi.fn(),
|
||||
updateSettings: vi.fn(),
|
||||
testConnection: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('team api', () => {
|
||||
const app = new Hono().use('*', authMiddleware).route('/', teamRoute)
|
||||
let mockCreateTeam: any // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||
@@ -638,5 +654,208 @@ describe('team api', () => {
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/turntable-settings returns turntable settings', async () => {
|
||||
const { turntableService } = await import('@shumai/core/src/turntable/turntable')
|
||||
vi.mocked(turntableService.getSettings).mockResolvedValue({
|
||||
url: 'http://localhost:3001',
|
||||
username: 'user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/turntable-settings')
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data).toEqual({
|
||||
url: 'http://localhost:3001',
|
||||
username: 'user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('PUT /teams/:teamId/turntable-settings updates settings when not env configured', async () => {
|
||||
const { turntableService } = await import('@shumai/core/src/turntable/turntable')
|
||||
vi.mocked(turntableService.updateSettings).mockResolvedValue({
|
||||
url: 'http://custom:3001',
|
||||
username: 'newuser',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/turntable-settings', {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3001',
|
||||
username: 'newuser',
|
||||
password: 'secretpassword',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.url).toBe('http://custom:3001')
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('PUT /teams/:teamId/turntable-settings returns 400 when env configured', async () => {
|
||||
const { turntableService } = await import('@shumai/core/src/turntable/turntable')
|
||||
vi.mocked(turntableService.updateSettings).mockRejectedValue(
|
||||
new Error(
|
||||
'Turntable settings are configured via environment variables and cannot be edited',
|
||||
),
|
||||
)
|
||||
|
||||
const res = await app.request('/teams/t1/turntable-settings', {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3001',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(400)
|
||||
const data = await res.json()
|
||||
expect(data.message).toContain('configured via environment variables')
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/turntable-settings/test tests connection', async () => {
|
||||
const { turntableService } = await import('@shumai/core/src/turntable/turntable')
|
||||
vi.mocked(turntableService.testConnection).mockResolvedValue({
|
||||
ok: true,
|
||||
version: '1.0.0',
|
||||
blender: '5.2.0',
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/turntable-settings/test', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3001',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.ok).toBe(true)
|
||||
expect(data.blender).toBe('5.2.0')
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/gotenberg-settings returns gotenberg settings', async () => {
|
||||
const { gotenbergService } = await import('@shumai/core/src/gotenberg/gotenberg')
|
||||
vi.mocked(gotenbergService.getSettings).mockResolvedValue({
|
||||
url: 'http://localhost:3000',
|
||||
username: 'user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/gotenberg-settings')
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data).toEqual({
|
||||
url: 'http://localhost:3000',
|
||||
username: 'user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('PUT /teams/:teamId/gotenberg-settings updates settings when not env configured', async () => {
|
||||
const { gotenbergService } = await import('@shumai/core/src/gotenberg/gotenberg')
|
||||
vi.mocked(gotenbergService.updateSettings).mockResolvedValue({
|
||||
url: 'http://custom:3000',
|
||||
username: 'newuser',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/gotenberg-settings', {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3000',
|
||||
username: 'newuser',
|
||||
password: 'secretpassword',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.url).toBe('http://custom:3000')
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('PUT /teams/:teamId/gotenberg-settings returns 400 when env configured', async () => {
|
||||
const { gotenbergService } = await import('@shumai/core/src/gotenberg/gotenberg')
|
||||
vi.mocked(gotenbergService.updateSettings).mockRejectedValue(
|
||||
new Error(
|
||||
'Gotenberg settings are configured via environment variables and cannot be edited',
|
||||
),
|
||||
)
|
||||
|
||||
const res = await app.request('/teams/t1/gotenberg-settings', {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3000',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(400)
|
||||
const data = await res.json()
|
||||
expect(data.message).toContain('configured via environment variables')
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/gotenberg-settings/test tests connection', async () => {
|
||||
const { gotenbergService } = await import('@shumai/core/src/gotenberg/gotenberg')
|
||||
vi.mocked(gotenbergService.testConnection).mockResolvedValue({
|
||||
ok: true,
|
||||
version: '8.3.0',
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/gotenberg-settings/test', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
url: 'http://custom:3000',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.ok).toBe(true)
|
||||
expect(data.version).toBe('8.3.0')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -10,6 +10,8 @@ import {
|
||||
updateTeamSettingsRequestSchema,
|
||||
listMembersQuerySchema,
|
||||
updateSandboxSettingsRequestSchema,
|
||||
updateTurntableSettingsRequestSchema,
|
||||
updateGotenbergSettingsRequestSchema,
|
||||
updateMeRequestSchema,
|
||||
updateTeamMemberRoleRequestSchema,
|
||||
createApiTokenRequestSchema,
|
||||
@@ -23,6 +25,8 @@ import {
|
||||
import { apiTokenService } from '@shumai/core/src/user/api-token'
|
||||
import { aiUsageService } from '@shumai/core/src/ai-usage/ai-usage'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { gotenbergService } from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import { NotificationType } from '@shumai/db'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
|
||||
@@ -265,6 +269,120 @@ const route = new Hono<{ Variables: { user: User } }>()
|
||||
return c.json(sandbox)
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/turntable-settings', async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const settings = await turntableService.getSettings(teamId)
|
||||
return c.json(settings)
|
||||
})
|
||||
.put(
|
||||
'/teams/:teamId/turntable-settings',
|
||||
zValidator('json', updateTurntableSettingsRequestSchema),
|
||||
async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
const req = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
try {
|
||||
const settings = await turntableService.updateSettings(teamId, req)
|
||||
return c.json(settings)
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err)
|
||||
return c.json({ message }, 400)
|
||||
}
|
||||
},
|
||||
)
|
||||
.post(
|
||||
'/teams/:teamId/turntable-settings/test',
|
||||
zValidator('json', updateTurntableSettingsRequestSchema.partial()),
|
||||
async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
const req = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const res = await turntableService.testConnection(req, teamId)
|
||||
return c.json(res)
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/gotenberg-settings', async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const settings = await gotenbergService.getSettings(teamId)
|
||||
return c.json(settings)
|
||||
})
|
||||
.put(
|
||||
'/teams/:teamId/gotenberg-settings',
|
||||
zValidator('json', updateGotenbergSettingsRequestSchema),
|
||||
async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
const req = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
try {
|
||||
const settings = await gotenbergService.updateSettings(teamId, req)
|
||||
return c.json(settings)
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err)
|
||||
return c.json({ message }, 400)
|
||||
}
|
||||
},
|
||||
)
|
||||
.post(
|
||||
'/teams/:teamId/gotenberg-settings/test',
|
||||
zValidator('json', updateGotenbergSettingsRequestSchema.partial()),
|
||||
async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
const req = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const res = await gotenbergService.testConnection(req, teamId)
|
||||
return c.json(res)
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/user-metadata', async (c) => {
|
||||
const user = c.get('user')
|
||||
const teamId = c.req.param('teamId')
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/core",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -1931,6 +1931,36 @@ describe('AssetService', () => {
|
||||
expect(info.preview?.duration).toBeUndefined()
|
||||
})
|
||||
|
||||
it('toPreviewInfo handles 3d asset with proxyType 3d and omits duration', async () => {
|
||||
const { project, user } = await setupBasicAssets()
|
||||
|
||||
const model = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'model.glb',
|
||||
type: AssetType.file,
|
||||
projectId: project.id,
|
||||
creatorId: user.id,
|
||||
sizeByte: 8000,
|
||||
mediaType: 'model/gltf-binary',
|
||||
status: 'processed',
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
poster: { key: 'poster-key' },
|
||||
sprite: { key: 'sprite-key', frames: 100, tileX: 10, tileY: 10 },
|
||||
metadata: { originalWidth: 1080, originalHeight: 1080, duration: 4 },
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any,
|
||||
},
|
||||
})
|
||||
|
||||
const info = await assetService.getAsset({ assetId: model.id })
|
||||
|
||||
expect(info.preview).toBeDefined()
|
||||
expect(info.preview?.proxyType).toBe('3d')
|
||||
expect(info.preview?.duration).toBeUndefined()
|
||||
expect(info.preview?.spriteUrl).toBeDefined()
|
||||
})
|
||||
|
||||
it('converts webp thumbnail to jpeg on demand when hasJpegPreview is false', async () => {
|
||||
vi.mocked(ensureJpegInStorage).mockClear()
|
||||
const { project, user } = await setupBasicAssets()
|
||||
|
||||
@@ -2407,7 +2407,13 @@ export class AssetService {
|
||||
}
|
||||
}
|
||||
|
||||
const proxyType = (media?.proxyType || null) as 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
const proxyType = (media?.proxyType || null) as
|
||||
| 'image'
|
||||
| 'video'
|
||||
| 'audio'
|
||||
| 'pdf'
|
||||
| '3d'
|
||||
| null
|
||||
|
||||
result.push({
|
||||
id: a.id,
|
||||
@@ -2773,7 +2779,13 @@ export class AssetService {
|
||||
): Promise<PreviewInfo | null> {
|
||||
if (!asset.media) return null
|
||||
|
||||
const proxyType = (asset.media?.proxyType || null) as 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
const proxyType = (asset.media?.proxyType || null) as
|
||||
| 'image'
|
||||
| 'video'
|
||||
| 'audio'
|
||||
| 'pdf'
|
||||
| '3d'
|
||||
| null
|
||||
|
||||
let rawThumbKey: string | undefined
|
||||
if (proxyType === 'image' && asset.media.thumbnail?.key) {
|
||||
@@ -2826,7 +2838,7 @@ export class AssetService {
|
||||
originalHeight: asset.media.metadata?.originalHeight,
|
||||
originalWidth: asset.media.metadata?.originalWidth,
|
||||
spriteUrl,
|
||||
duration: asset.media.metadata?.duration,
|
||||
duration: proxyType === '3d' ? undefined : asset.media.metadata?.duration,
|
||||
pageCount: asset.media.metadata?.totalFrames,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,9 +2,12 @@ import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import * as os from 'os'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { GotenbergService } from './gotenberg'
|
||||
|
||||
describe('GotenbergService', () => {
|
||||
setupTestDbHooks()
|
||||
const originalEnv = process.env
|
||||
let tmpDir: string
|
||||
let testFilePath: string
|
||||
@@ -216,4 +219,148 @@ describe('GotenbergService', () => {
|
||||
expect(indexHtmlText).toContain('{{ toHTML "file.md" }}')
|
||||
})
|
||||
})
|
||||
|
||||
describe('team settings & fallback', () => {
|
||||
it('resolves config from team settings when env is not set', async () => {
|
||||
delete process.env.GOTENBERG_URL
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Gotenberg Team',
|
||||
settings: {
|
||||
gotenberg: {
|
||||
url: 'http://custom-gotenberg:4000',
|
||||
username: 'team-user',
|
||||
password: 'team-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const service = new GotenbergService()
|
||||
const config = await service.resolveConfig(team.id)
|
||||
|
||||
expect(config).toEqual({
|
||||
url: 'http://custom-gotenberg:4000',
|
||||
username: 'team-user',
|
||||
password: 'team-password',
|
||||
isEnv: false,
|
||||
})
|
||||
})
|
||||
|
||||
it('prioritizes environment variables over team settings', async () => {
|
||||
process.env.GOTENBERG_URL = 'http://env-gotenberg:3000'
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Gotenberg Team',
|
||||
settings: {
|
||||
gotenberg: {
|
||||
url: 'http://custom-gotenberg:4000',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const service = new GotenbergService()
|
||||
const config = await service.resolveConfig(team.id)
|
||||
|
||||
expect(config.url).toBe('http://env-gotenberg:3000')
|
||||
expect(config.isEnv).toBe(true)
|
||||
})
|
||||
|
||||
it('getSettings returns masked settings response', async () => {
|
||||
delete process.env.GOTENBERG_URL
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Gotenberg Team',
|
||||
settings: {
|
||||
gotenberg: {
|
||||
url: 'http://custom-gotenberg:4000',
|
||||
username: 'team-user',
|
||||
password: 'team-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const service = new GotenbergService()
|
||||
const settings = await service.getSettings(team.id)
|
||||
|
||||
expect(settings).toEqual({
|
||||
url: 'http://custom-gotenberg:4000',
|
||||
username: 'team-user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
})
|
||||
|
||||
it('updateSettings updates team settings and rejects edits when env is set', async () => {
|
||||
delete process.env.GOTENBERG_URL
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Gotenberg Team' },
|
||||
})
|
||||
|
||||
const service = new GotenbergService()
|
||||
const updated = await service.updateSettings(team.id, {
|
||||
url: 'http://new-gotenberg:3000',
|
||||
username: 'admin',
|
||||
password: 'secret-password',
|
||||
})
|
||||
|
||||
expect(updated.url).toBe('http://new-gotenberg:3000')
|
||||
expect(updated.username).toBe('admin')
|
||||
expect(updated.hasPassword).toBe(true)
|
||||
|
||||
// When env is set, reject update
|
||||
process.env.GOTENBERG_URL = 'http://env-gotenberg:3000'
|
||||
await expect(service.updateSettings(team.id, { url: 'http://another:3000' })).rejects.toThrow(
|
||||
'Gotenberg settings are configured via environment variables and cannot be edited',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('testConnection', () => {
|
||||
it('returns error when url is empty and no team settings exist', async () => {
|
||||
delete process.env.GOTENBERG_URL
|
||||
const service = new GotenbergService()
|
||||
const result = await service.testConnection({})
|
||||
expect(result.ok).toBe(false)
|
||||
expect(result.error).toBe('URL is required')
|
||||
})
|
||||
|
||||
it('successfully connects to /health and enriches with /version', async () => {
|
||||
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockImplementation(async (url) => {
|
||||
const urlStr = String(url)
|
||||
if (urlStr.endsWith('/health')) {
|
||||
return { ok: true, status: 200 } as Response
|
||||
}
|
||||
if (urlStr.endsWith('/version')) {
|
||||
return {
|
||||
ok: true,
|
||||
status: 200,
|
||||
json: async () => ({ version: '8.3.0' }),
|
||||
} as Response
|
||||
}
|
||||
return { ok: false, status: 404 } as Response
|
||||
})
|
||||
|
||||
const service = new GotenbergService()
|
||||
const result = await service.testConnection({
|
||||
url: 'http://gotenberg.local:3000',
|
||||
username: 'test-user',
|
||||
password: 'test-pass',
|
||||
})
|
||||
|
||||
expect(result.ok).toBe(true)
|
||||
expect(result.version).toBe('8.3.0')
|
||||
expect(fetchSpy).toHaveBeenCalledWith(
|
||||
'http://gotenberg.local:3000/health',
|
||||
expect.objectContaining({
|
||||
method: 'GET',
|
||||
headers: expect.objectContaining({
|
||||
Authorization: expect.stringMatching(/^Basic /),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,40 +1,135 @@
|
||||
import * as fs from 'fs'
|
||||
import type { GotenbergSettingsResponse, UpdateGotenbergSettingsRequest } from '@shumai/dtos'
|
||||
import {
|
||||
IntegrationDefinition,
|
||||
resolveIntegrationConfig,
|
||||
getIntegrationSettings,
|
||||
updateIntegrationSettings,
|
||||
resolveTestConnectionConfig,
|
||||
getIntegrationBasicAuthHeader,
|
||||
ResolvedIntegrationConfig,
|
||||
} from '@shumai/core/src/integrations/helper'
|
||||
|
||||
export const GOTENBERG_INTEGRATION_DEF: IntegrationDefinition<'gotenberg'> = {
|
||||
name: 'Gotenberg',
|
||||
settingsKey: 'gotenberg',
|
||||
envKeys: {
|
||||
url: ['GOTENBERG_URL'],
|
||||
username: ['GOTENBERG_BASIC_AUTH_USERNAME'],
|
||||
password: ['GOTENBERG_BASIC_AUTH_PASSWORD'],
|
||||
},
|
||||
}
|
||||
|
||||
export interface GotenbergConvertOptions {
|
||||
landscape?: boolean
|
||||
teamId?: string
|
||||
}
|
||||
|
||||
export class GotenbergService {
|
||||
private getUrl(): string | undefined {
|
||||
const url = process.env.GOTENBERG_URL?.trim()
|
||||
return url ? url.replace(/\/+$/, '') : undefined
|
||||
async resolveConfig(teamId?: string): Promise<ResolvedIntegrationConfig> {
|
||||
return resolveIntegrationConfig(GOTENBERG_INTEGRATION_DEF, teamId)
|
||||
}
|
||||
|
||||
private getAuthHeader(): string | undefined {
|
||||
const username = process.env.GOTENBERG_BASIC_AUTH_USERNAME
|
||||
const password = process.env.GOTENBERG_BASIC_AUTH_PASSWORD
|
||||
private getAuthHeader(config: { username?: string; password?: string }): string | undefined {
|
||||
return getIntegrationBasicAuthHeader(config)
|
||||
}
|
||||
|
||||
if (username && password) {
|
||||
const credentials = Buffer.from(`${username}:${password}`).toString('base64')
|
||||
return `Basic ${credentials}`
|
||||
async getSettings(teamId: string): Promise<GotenbergSettingsResponse> {
|
||||
return getIntegrationSettings(GOTENBERG_INTEGRATION_DEF, teamId)
|
||||
}
|
||||
|
||||
async updateSettings(
|
||||
teamId: string,
|
||||
req: UpdateGotenbergSettingsRequest,
|
||||
): Promise<GotenbergSettingsResponse> {
|
||||
return updateIntegrationSettings(GOTENBERG_INTEGRATION_DEF, teamId, req)
|
||||
}
|
||||
|
||||
async testConnection(
|
||||
config?: UpdateGotenbergSettingsRequest,
|
||||
teamId?: string,
|
||||
): Promise<{ ok: boolean; version?: string; error?: string }> {
|
||||
const target = await resolveTestConnectionConfig(GOTENBERG_INTEGRATION_DEF, config, teamId)
|
||||
|
||||
if (!target.resolvedUrl) {
|
||||
return { ok: false, error: 'URL is required' }
|
||||
}
|
||||
const cleanUrl = target.resolvedUrl.replace(/\/+$/, '')
|
||||
|
||||
try {
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader({
|
||||
username: target.resolvedUsername,
|
||||
password: target.resolvedPassword,
|
||||
})
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${cleanUrl}/health`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(5000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errText = await response.text().catch(() => '')
|
||||
return {
|
||||
ok: false,
|
||||
error: `Health check returned status ${response.status}: ${errText || response.statusText}`,
|
||||
}
|
||||
}
|
||||
|
||||
// Optionally try /version to obtain version string
|
||||
let version: string | undefined
|
||||
try {
|
||||
const versionRes = await fetch(`${cleanUrl}/version`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(2000),
|
||||
})
|
||||
if (versionRes.ok) {
|
||||
const vData = (await versionRes.json().catch(() => null)) as
|
||||
| { version?: string }
|
||||
| string
|
||||
| null
|
||||
if (vData && typeof vData === 'object' && 'version' in vData) {
|
||||
version = String(vData.version)
|
||||
} else if (typeof vData === 'string') {
|
||||
version = vData
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Version endpoint is optional in some Gotenberg versions
|
||||
}
|
||||
|
||||
return {
|
||||
ok: true,
|
||||
version,
|
||||
}
|
||||
} catch (err) {
|
||||
const msg = err instanceof Error ? err.message : String(err)
|
||||
return {
|
||||
ok: false,
|
||||
error: msg,
|
||||
}
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
|
||||
async isAvailable(): Promise<boolean> {
|
||||
const baseUrl = this.getUrl()
|
||||
if (!baseUrl) {
|
||||
async isAvailable(teamId?: string): Promise<boolean> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
return false
|
||||
}
|
||||
|
||||
try {
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader()
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${baseUrl}/health`, {
|
||||
const response = await fetch(`${config.url}/health`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(3000),
|
||||
@@ -50,9 +145,11 @@ export class GotenbergService {
|
||||
filePath: string,
|
||||
filename: string,
|
||||
options: GotenbergConvertOptions = {},
|
||||
teamId?: string,
|
||||
): Promise<Buffer> {
|
||||
const baseUrl = this.getUrl()
|
||||
if (!baseUrl) {
|
||||
const effectiveTeamId = teamId ?? options.teamId
|
||||
const config = await this.resolveConfig(effectiveTeamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Gotenberg URL is not configured.')
|
||||
}
|
||||
|
||||
@@ -65,12 +162,12 @@ export class GotenbergService {
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader()
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${baseUrl}/forms/libreoffice/convert`, {
|
||||
const response = await fetch(`${config.url}/forms/libreoffice/convert`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: formData,
|
||||
@@ -88,9 +185,9 @@ export class GotenbergService {
|
||||
return Buffer.from(arrayBuffer)
|
||||
}
|
||||
|
||||
async convertHtmlToPdf(filePath: string, filename: string): Promise<Buffer> {
|
||||
const baseUrl = this.getUrl()
|
||||
if (!baseUrl) {
|
||||
async convertHtmlToPdf(filePath: string, filename: string, teamId?: string): Promise<Buffer> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Gotenberg URL is not configured.')
|
||||
}
|
||||
|
||||
@@ -103,12 +200,12 @@ export class GotenbergService {
|
||||
formData.append('files', new Blob([fileBytes]), targetFilename)
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader()
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${baseUrl}/forms/chromium/convert/html`, {
|
||||
const response = await fetch(`${config.url}/forms/chromium/convert/html`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: formData,
|
||||
@@ -126,9 +223,9 @@ export class GotenbergService {
|
||||
return Buffer.from(arrayBuffer)
|
||||
}
|
||||
|
||||
async convertMarkdownToPdf(filePath: string, filename: string): Promise<Buffer> {
|
||||
const baseUrl = this.getUrl()
|
||||
if (!baseUrl) {
|
||||
async convertMarkdownToPdf(filePath: string, filename: string, teamId?: string): Promise<Buffer> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Gotenberg URL is not configured.')
|
||||
}
|
||||
|
||||
@@ -151,12 +248,12 @@ export class GotenbergService {
|
||||
formData.append('files', new Blob([fileBytes]), mdFilename)
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader()
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${baseUrl}/forms/chromium/convert/markdown`, {
|
||||
const response = await fetch(`${config.url}/forms/chromium/convert/markdown`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: formData,
|
||||
|
||||
@@ -31,3 +31,6 @@ export * from './kanban/kanban'
|
||||
export * from './media-generation/media-generation'
|
||||
export * from './sandbox'
|
||||
export * from './asset/comments-export'
|
||||
export * from './turntable/turntable'
|
||||
export * from './utils/model3d'
|
||||
export * from './integrations/helper'
|
||||
|
||||
@@ -0,0 +1,271 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import {
|
||||
IntegrationDefinition,
|
||||
resolveIntegrationConfig,
|
||||
getIntegrationSettings,
|
||||
updateIntegrationSettings,
|
||||
resolveTestConnectionConfig,
|
||||
getIntegrationBasicAuthHeader,
|
||||
} from './helper'
|
||||
|
||||
const TEST_INTEGRATION_DEF: IntegrationDefinition<'turntable'> = {
|
||||
name: 'TestIntegration',
|
||||
settingsKey: 'turntable',
|
||||
envKeys: {
|
||||
url: ['TEST_INTEGRATION_URL', 'FALLBACK_INTEGRATION_URL'],
|
||||
username: ['TEST_INTEGRATION_USERNAME'],
|
||||
password: ['TEST_INTEGRATION_PASSWORD'],
|
||||
},
|
||||
}
|
||||
|
||||
describe('Integration Config Helper', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
const originalEnv = process.env
|
||||
|
||||
beforeEach(() => {
|
||||
process.env = { ...originalEnv }
|
||||
delete process.env.TEST_INTEGRATION_URL
|
||||
delete process.env.FALLBACK_INTEGRATION_URL
|
||||
delete process.env.TEST_INTEGRATION_USERNAME
|
||||
delete process.env.TEST_INTEGRATION_PASSWORD
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
process.env = originalEnv
|
||||
})
|
||||
|
||||
describe('resolveIntegrationConfig', () => {
|
||||
it('prioritizes environment variables over database settings', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://db-server:1234',
|
||||
username: 'db-user',
|
||||
password: 'db-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
process.env.TEST_INTEGRATION_URL = 'http://env-server:5678/'
|
||||
process.env.TEST_INTEGRATION_USERNAME = 'env-user'
|
||||
process.env.TEST_INTEGRATION_PASSWORD = 'env-pass'
|
||||
|
||||
const config = await resolveIntegrationConfig(TEST_INTEGRATION_DEF, team.id)
|
||||
expect(config).toEqual({
|
||||
url: 'http://env-server:5678',
|
||||
username: 'env-user',
|
||||
password: 'env-pass',
|
||||
isEnv: true,
|
||||
})
|
||||
})
|
||||
|
||||
it('falls back to second env key if first is missing', async () => {
|
||||
process.env.FALLBACK_INTEGRATION_URL = 'http://fallback-server:8080'
|
||||
|
||||
const config = await resolveIntegrationConfig(TEST_INTEGRATION_DEF)
|
||||
expect(config.url).toBe('http://fallback-server:8080')
|
||||
expect(config.isEnv).toBe(true)
|
||||
})
|
||||
|
||||
it('reads from team settings when environment variables are not set', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://db-server:1234/',
|
||||
username: 'db-user',
|
||||
password: 'db-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const config = await resolveIntegrationConfig(TEST_INTEGRATION_DEF, team.id)
|
||||
expect(config).toEqual({
|
||||
url: 'http://db-server:1234',
|
||||
username: 'db-user',
|
||||
password: 'db-password',
|
||||
isEnv: false,
|
||||
})
|
||||
})
|
||||
|
||||
it('returns isEnv: false and undefined fields when neither env nor DB are set', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Empty Team' },
|
||||
})
|
||||
|
||||
const config = await resolveIntegrationConfig(TEST_INTEGRATION_DEF, team.id)
|
||||
expect(config).toEqual({
|
||||
isEnv: false,
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('getIntegrationSettings', () => {
|
||||
it('returns safe response masking password', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://db-server:1234',
|
||||
username: 'db-user',
|
||||
password: 'db-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const res = await getIntegrationSettings(TEST_INTEGRATION_DEF, team.id)
|
||||
expect(res).toEqual({
|
||||
url: 'http://db-server:1234',
|
||||
username: 'db-user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('updateIntegrationSettings', () => {
|
||||
it('throws error when environment variable is configured', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Team' },
|
||||
})
|
||||
|
||||
process.env.TEST_INTEGRATION_URL = 'http://env-server:5678'
|
||||
|
||||
await expect(
|
||||
updateIntegrationSettings(TEST_INTEGRATION_DEF, team.id, {
|
||||
url: 'http://new-url:1234',
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
'TestIntegration settings are configured via environment variables and cannot be edited',
|
||||
)
|
||||
})
|
||||
|
||||
it('updates settings and preserves existing password when not supplied', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://original:1234',
|
||||
username: 'original-user',
|
||||
password: 'secret-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const res = await updateIntegrationSettings(TEST_INTEGRATION_DEF, team.id, {
|
||||
url: 'http://updated:5678/',
|
||||
username: 'new-user',
|
||||
})
|
||||
|
||||
expect(res).toEqual({
|
||||
url: 'http://updated:5678',
|
||||
username: 'new-user',
|
||||
hasPassword: true,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const config = await resolveIntegrationConfig(TEST_INTEGRATION_DEF, team.id)
|
||||
expect(config.password).toBe('secret-password')
|
||||
})
|
||||
|
||||
it('clears settings in database when URL is empty or whitespace', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://to-be-cleared:1234',
|
||||
username: 'user',
|
||||
password: 'pwd',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const res = await updateIntegrationSettings(TEST_INTEGRATION_DEF, team.id, {
|
||||
url: ' ',
|
||||
})
|
||||
|
||||
expect(res).toEqual({
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
})
|
||||
|
||||
const updatedTeam = await prisma.team.findUnique({
|
||||
where: { id: team.id },
|
||||
})
|
||||
// Check that turntable is removed from team settings
|
||||
expect((updatedTeam?.settings as Record<string, unknown>)?.turntable).toBeUndefined()
|
||||
})
|
||||
})
|
||||
|
||||
describe('resolveTestConnectionConfig', () => {
|
||||
it('uses provided credentials directly when supplied', async () => {
|
||||
const target = await resolveTestConnectionConfig(TEST_INTEGRATION_DEF, {
|
||||
url: 'http://direct:1234',
|
||||
username: 'direct-user',
|
||||
password: 'direct-password',
|
||||
})
|
||||
|
||||
expect(target).toEqual({
|
||||
resolvedUrl: 'http://direct:1234',
|
||||
resolvedUsername: 'direct-user',
|
||||
resolvedPassword: 'direct-password',
|
||||
})
|
||||
})
|
||||
|
||||
it('falls back to saved database settings when testing with partial inputs', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://db:1234',
|
||||
username: 'db-user',
|
||||
password: 'db-password',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const target = await resolveTestConnectionConfig(
|
||||
TEST_INTEGRATION_DEF,
|
||||
{ url: 'http://new-url:9999' },
|
||||
team.id,
|
||||
)
|
||||
|
||||
expect(target).toEqual({
|
||||
resolvedUrl: 'http://new-url:9999',
|
||||
resolvedUsername: 'db-user',
|
||||
resolvedPassword: 'db-password',
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('getIntegrationBasicAuthHeader', () => {
|
||||
it('generates base64 basic auth header when username and password are provided', () => {
|
||||
const header = getIntegrationBasicAuthHeader({ username: 'admin', password: 'secret' })
|
||||
expect(header).toBe(`Basic ${Buffer.from('admin:secret').toString('base64')}`)
|
||||
})
|
||||
|
||||
it('returns undefined when username or password is missing', () => {
|
||||
expect(getIntegrationBasicAuthHeader({ username: 'admin' })).toBeUndefined()
|
||||
expect(getIntegrationBasicAuthHeader({ password: 'secret' })).toBeUndefined()
|
||||
expect(getIntegrationBasicAuthHeader({})).toBeUndefined()
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,188 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import '@shumai/db/src/prisma-json-types'
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
|
||||
export interface IntegrationEnvKeys {
|
||||
url: string[]
|
||||
username?: string[]
|
||||
password?: string[]
|
||||
}
|
||||
|
||||
export interface IntegrationDefinition<TKey extends keyof PrismaJson.Settings> {
|
||||
name: string
|
||||
settingsKey: TKey
|
||||
envKeys: IntegrationEnvKeys
|
||||
}
|
||||
|
||||
export interface ResolvedIntegrationConfig {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
isEnv: boolean
|
||||
}
|
||||
|
||||
export interface IntegrationSettingsResponse {
|
||||
url?: string
|
||||
username?: string
|
||||
hasPassword: boolean
|
||||
isEnvConfigured: boolean
|
||||
}
|
||||
|
||||
export interface UpdateIntegrationSettingsRequest {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
}
|
||||
|
||||
function getFirstEnvValue(keys?: string[]): string | undefined {
|
||||
if (!keys) return undefined
|
||||
for (const key of keys) {
|
||||
const val = process.env[key]?.trim()
|
||||
if (val) return val
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
|
||||
export async function resolveIntegrationConfig<TKey extends keyof PrismaJson.Settings>(
|
||||
def: IntegrationDefinition<TKey>,
|
||||
teamId?: string,
|
||||
): Promise<ResolvedIntegrationConfig> {
|
||||
const envUrl = getFirstEnvValue(def.envKeys.url)
|
||||
const envUsername = getFirstEnvValue(def.envKeys.username)
|
||||
const envPassword = getFirstEnvValue(def.envKeys.password)
|
||||
|
||||
if (envUrl) {
|
||||
return {
|
||||
url: envUrl.replace(/\/+$/, ''),
|
||||
username: envUsername || undefined,
|
||||
password: envPassword || undefined,
|
||||
isEnv: true,
|
||||
}
|
||||
}
|
||||
|
||||
if (teamId) {
|
||||
try {
|
||||
const team = await prisma.team.findUnique({
|
||||
where: { id: teamId },
|
||||
select: { settings: true },
|
||||
})
|
||||
const teamSettings = team?.settings as PrismaJson.Settings | null
|
||||
const serviceSettings = teamSettings?.[def.settingsKey] as
|
||||
| { url?: string; username?: string; password?: string }
|
||||
| undefined
|
||||
|
||||
if (serviceSettings?.url?.trim()) {
|
||||
return {
|
||||
url: serviceSettings.url.trim().replace(/\/+$/, ''),
|
||||
username: serviceSettings.username?.trim() || undefined,
|
||||
password: serviceSettings.password?.trim() || undefined,
|
||||
isEnv: false,
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
logger.error({ err, teamId }, `Failed to load team ${def.name} settings`)
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
isEnv: false,
|
||||
}
|
||||
}
|
||||
|
||||
export async function getIntegrationSettings<TKey extends keyof PrismaJson.Settings>(
|
||||
def: IntegrationDefinition<TKey>,
|
||||
teamId: string,
|
||||
): Promise<IntegrationSettingsResponse> {
|
||||
const config = await resolveIntegrationConfig(def, teamId)
|
||||
return {
|
||||
url: config.url,
|
||||
username: config.username,
|
||||
hasPassword: Boolean(config.password),
|
||||
isEnvConfigured: config.isEnv,
|
||||
}
|
||||
}
|
||||
|
||||
export async function updateIntegrationSettings<TKey extends keyof PrismaJson.Settings>(
|
||||
def: IntegrationDefinition<TKey>,
|
||||
teamId: string,
|
||||
req: UpdateIntegrationSettingsRequest,
|
||||
): Promise<IntegrationSettingsResponse> {
|
||||
const currentConfig = await resolveIntegrationConfig(def, teamId)
|
||||
if (currentConfig.isEnv) {
|
||||
throw new Error(
|
||||
`${def.name} settings are configured via environment variables and cannot be edited`,
|
||||
)
|
||||
}
|
||||
|
||||
const team = await prisma.team.findUnique({
|
||||
where: { id: teamId },
|
||||
select: { settings: true },
|
||||
})
|
||||
const settings = { ...((team?.settings || {}) as PrismaJson.Settings) }
|
||||
const prevSettings = (settings[def.settingsKey] || {}) as {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
}
|
||||
|
||||
const trimmedUrl = req.url?.trim()
|
||||
if (!trimmedUrl) {
|
||||
// If URL is empty/unset, clear the integration settings
|
||||
delete settings[def.settingsKey]
|
||||
} else {
|
||||
const updatedServiceSettings: { url: string; username?: string; password?: string } = {
|
||||
url: trimmedUrl.replace(/\/+$/, ''),
|
||||
username:
|
||||
req.username !== undefined ? req.username.trim() || undefined : prevSettings.username,
|
||||
password: req.password !== undefined ? req.password : prevSettings.password,
|
||||
}
|
||||
settings[def.settingsKey] = updatedServiceSettings as unknown as PrismaJson.Settings[TKey]
|
||||
}
|
||||
|
||||
await prisma.team.update({
|
||||
where: { id: teamId },
|
||||
data: { settings },
|
||||
})
|
||||
|
||||
return getIntegrationSettings(def, teamId)
|
||||
}
|
||||
|
||||
export async function resolveTestConnectionConfig<TKey extends keyof PrismaJson.Settings>(
|
||||
def: IntegrationDefinition<TKey>,
|
||||
config?: UpdateIntegrationSettingsRequest,
|
||||
teamId?: string,
|
||||
): Promise<{ resolvedUrl?: string; resolvedUsername?: string; resolvedPassword?: string }> {
|
||||
let resolvedUrl = config?.url?.trim()
|
||||
let resolvedUsername = config?.username?.trim()
|
||||
let resolvedPassword = config?.password
|
||||
|
||||
if (teamId && (!resolvedUrl || resolvedPassword === undefined)) {
|
||||
const savedConfig = await resolveIntegrationConfig(def, teamId)
|
||||
if (!resolvedUrl) {
|
||||
resolvedUrl = savedConfig.url
|
||||
}
|
||||
if (!resolvedUsername && savedConfig.username) {
|
||||
resolvedUsername = savedConfig.username
|
||||
}
|
||||
if (resolvedPassword === undefined) {
|
||||
resolvedPassword = savedConfig.password
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
resolvedUrl,
|
||||
resolvedUsername,
|
||||
resolvedPassword,
|
||||
}
|
||||
}
|
||||
|
||||
export function getIntegrationBasicAuthHeader(config: {
|
||||
username?: string
|
||||
password?: string
|
||||
}): string | undefined {
|
||||
if (config.username && config.password) {
|
||||
const credentials = Buffer.from(`${config.username}:${config.password}`).toString('base64')
|
||||
return `Basic ${credentials}`
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
@@ -375,6 +375,18 @@ describe('TeamService', () => {
|
||||
hlsEnabled: false,
|
||||
hlsResolutions: ['480p', '720p', '1080p'],
|
||||
},
|
||||
turntable: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
gotenberg: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
appearance: { hideAgent: false },
|
||||
})
|
||||
|
||||
@@ -392,6 +404,18 @@ describe('TeamService', () => {
|
||||
hlsEnabled: false,
|
||||
hlsResolutions: ['480p', '720p', '1080p'],
|
||||
},
|
||||
turntable: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
gotenberg: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
appearance: { hideAgent: false },
|
||||
})
|
||||
|
||||
@@ -418,6 +442,18 @@ describe('TeamService', () => {
|
||||
hlsEnabled: true,
|
||||
hlsResolutions: ['720p', '1080p', '2160p'],
|
||||
},
|
||||
turntable: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
gotenberg: {
|
||||
hasPassword: false,
|
||||
isEnvConfigured: false,
|
||||
url: undefined,
|
||||
username: undefined,
|
||||
},
|
||||
appearance: { hideAgent: true },
|
||||
semanticSearchEnabled: false,
|
||||
})
|
||||
|
||||
@@ -7,6 +7,8 @@ import { getAvatarUrl } from '@shumai/core/src/user/avatar'
|
||||
import { HTTPException } from 'hono/http-exception'
|
||||
import { getAllowedAgentRoles } from '@shumai/core/src/agent/permissions'
|
||||
import { sandboxService } from '@shumai/core/src/sandbox/sandbox-service'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { gotenbergService } from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import {
|
||||
ServiceCreateTeamRequest,
|
||||
ServiceGetUserTeamsRequest,
|
||||
@@ -343,6 +345,9 @@ export class TeamService {
|
||||
settings.appearance.hideAgent = false
|
||||
}
|
||||
|
||||
settings.turntable = await turntableService.getSettings(teamId)
|
||||
settings.gotenberg = await gotenbergService.getSettings(teamId)
|
||||
|
||||
return settings
|
||||
}
|
||||
|
||||
|
||||
@@ -25,6 +25,11 @@ export interface RawPreviewResult {
|
||||
width: number
|
||||
height: number
|
||||
orientation?: number
|
||||
/**
|
||||
* True when the file is already upright (dcraw_emu output), so downstream sharp must not
|
||||
* auto-orient it even though `orientation` is undefined.
|
||||
*/
|
||||
orientationApplied?: boolean
|
||||
rawWidth?: number
|
||||
rawHeight?: number
|
||||
}
|
||||
@@ -382,6 +387,7 @@ export async function extractAndValidateRawPreview(
|
||||
previewPath: decoded.previewPath,
|
||||
cleanup: decoded.cleanup,
|
||||
orientation: decoded.orientation,
|
||||
orientationApplied: true,
|
||||
rawWidth: decoded.rawWidth,
|
||||
rawHeight: decoded.rawHeight,
|
||||
...dims,
|
||||
|
||||
@@ -0,0 +1,252 @@
|
||||
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import sharp from 'sharp'
|
||||
import { transcodeService } from './transcode'
|
||||
|
||||
// Only the storage layer is mocked: these tests run the real sharp pipeline end to end.
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
downloadToFile: vi.fn(),
|
||||
putObject: vi.fn(),
|
||||
resolveInput: vi.fn(),
|
||||
presign: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
// Only the RAW preview extraction is replaced, so the RAW branch of transcodeImage can be driven
|
||||
// with a prepared file (the dcraw_emu fallback result) without ExifTool or dcraw_emu installed.
|
||||
const extractRawMock = vi.hoisted(() => vi.fn())
|
||||
vi.mock('./raw-extract', async (importOriginal) => ({
|
||||
...(await importOriginal<typeof import('./raw-extract')>()),
|
||||
extractAndValidateRawPreview: extractRawMock,
|
||||
}))
|
||||
|
||||
// Windows keeps cached files open, which would make the temp dir cleanup fail with EBUSY.
|
||||
sharp.cache(false)
|
||||
|
||||
type Corner = 'TL' | 'TR' | 'BL' | 'BR'
|
||||
|
||||
// Stored (sensor) pixels are landscape. Each quadrant has its own color so the direction of the
|
||||
// rotation or flip can be read back from the corners of the output.
|
||||
const STORED_WIDTH = 64
|
||||
const STORED_HEIGHT = 48
|
||||
const QUADRANT_COLORS: Record<Corner, [number, number, number]> = {
|
||||
TL: [220, 30, 30], // red
|
||||
TR: [30, 200, 30], // green
|
||||
BL: [30, 30, 220], // blue
|
||||
BR: [230, 230, 30], // yellow
|
||||
}
|
||||
|
||||
/**
|
||||
* For each EXIF orientation: the displayed size and which stored corner ends up at the displayed
|
||||
* top-left and bottom-right. Orientations 5 to 8 swap width and height.
|
||||
*/
|
||||
const ORIENTATIONS: Array<{
|
||||
orientation: number
|
||||
name: string
|
||||
swapped: boolean
|
||||
topLeftIs: Corner
|
||||
bottomRightIs: Corner
|
||||
}> = [
|
||||
{ orientation: 1, name: 'normal', swapped: false, topLeftIs: 'TL', bottomRightIs: 'BR' },
|
||||
{
|
||||
orientation: 2,
|
||||
name: 'mirror horizontal',
|
||||
swapped: false,
|
||||
topLeftIs: 'TR',
|
||||
bottomRightIs: 'BL',
|
||||
},
|
||||
{ orientation: 3, name: 'rotate 180', swapped: false, topLeftIs: 'BR', bottomRightIs: 'TL' },
|
||||
{ orientation: 4, name: 'mirror vertical', swapped: false, topLeftIs: 'BL', bottomRightIs: 'TR' },
|
||||
{ orientation: 5, name: 'transpose', swapped: true, topLeftIs: 'TL', bottomRightIs: 'BR' },
|
||||
{ orientation: 6, name: 'rotate 90 CW', swapped: true, topLeftIs: 'BL', bottomRightIs: 'TR' },
|
||||
{ orientation: 7, name: 'transverse', swapped: true, topLeftIs: 'BR', bottomRightIs: 'TL' },
|
||||
{ orientation: 8, name: 'rotate 270 CW', swapped: true, topLeftIs: 'TR', bottomRightIs: 'BL' },
|
||||
]
|
||||
|
||||
async function makeJpeg(orientation: number): Promise<Buffer> {
|
||||
const halfW = STORED_WIDTH / 2
|
||||
const halfH = STORED_HEIGHT / 2
|
||||
const block = (corner: Corner) => ({
|
||||
create: {
|
||||
width: halfW,
|
||||
height: halfH,
|
||||
channels: 3 as const,
|
||||
background: {
|
||||
r: QUADRANT_COLORS[corner][0],
|
||||
g: QUADRANT_COLORS[corner][1],
|
||||
b: QUADRANT_COLORS[corner][2],
|
||||
},
|
||||
},
|
||||
})
|
||||
const tile = async (corner: Corner) => sharp(block(corner)).png().toBuffer()
|
||||
return sharp({
|
||||
create: {
|
||||
width: STORED_WIDTH,
|
||||
height: STORED_HEIGHT,
|
||||
channels: 3,
|
||||
background: { r: 0, g: 0, b: 0 },
|
||||
},
|
||||
})
|
||||
.composite([
|
||||
{ input: await tile('TL'), left: 0, top: 0 },
|
||||
{ input: await tile('TR'), left: halfW, top: 0 },
|
||||
{ input: await tile('BL'), left: 0, top: halfH },
|
||||
{ input: await tile('BR'), left: halfW, top: halfH },
|
||||
])
|
||||
.jpeg({ quality: 100, chromaSubsampling: '4:4:4' })
|
||||
.withMetadata({ orientation })
|
||||
.toBuffer()
|
||||
}
|
||||
|
||||
/** Which quadrant color is nearest to the pixel a few pixels inside the given output corner. */
|
||||
async function cornerColor(file: string, where: 'TL' | 'BR'): Promise<Corner> {
|
||||
const { data, info } = await sharp(fs.readFileSync(file))
|
||||
.removeAlpha()
|
||||
.raw()
|
||||
.toBuffer({ resolveWithObject: true })
|
||||
const inset = 3
|
||||
const x = where === 'TL' ? inset : info.width - 1 - inset
|
||||
const y = where === 'TL' ? inset : info.height - 1 - inset
|
||||
const offset = (y * info.width + x) * info.channels
|
||||
const pixel = [data[offset], data[offset + 1], data[offset + 2]]
|
||||
let best: Corner = 'TL'
|
||||
let bestDistance = Infinity
|
||||
for (const corner of Object.keys(QUADRANT_COLORS) as Corner[]) {
|
||||
const distance = QUADRANT_COLORS[corner].reduce(
|
||||
(sum, channel, i) => sum + (channel - pixel[i]) ** 2,
|
||||
0,
|
||||
)
|
||||
if (distance < bestDistance) {
|
||||
best = corner
|
||||
bestDistance = distance
|
||||
}
|
||||
}
|
||||
return best
|
||||
}
|
||||
|
||||
describe('EXIF orientation (real sharp)', () => {
|
||||
let tempDir: string
|
||||
|
||||
beforeEach(() => {
|
||||
tempDir = transcodeService.createTempDir('orientation-test-')
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
transcodeService.removeDir(tempDir)
|
||||
})
|
||||
|
||||
const expectedSize = (swapped: boolean) =>
|
||||
swapped
|
||||
? { width: STORED_HEIGHT, height: STORED_WIDTH }
|
||||
: { width: STORED_WIDTH, height: STORED_HEIGHT }
|
||||
|
||||
it.each(ORIENTATIONS)(
|
||||
'getImageInfo reports the displayed size for orientation $orientation ($name)',
|
||||
async ({ orientation, swapped }) => {
|
||||
const inputPath = path.join(tempDir, `in-${orientation}.jpg`)
|
||||
fs.writeFileSync(inputPath, await makeJpeg(orientation))
|
||||
|
||||
const info = await transcodeService.getImageInfo(inputPath)
|
||||
const expected = expectedSize(swapped)
|
||||
|
||||
expect(info.originalWidth).toBe(expected.width)
|
||||
expect(info.originalHeight).toBe(expected.height)
|
||||
},
|
||||
)
|
||||
|
||||
it.each(ORIENTATIONS)(
|
||||
'transcodeImage outputs an upright image for orientation $orientation ($name)',
|
||||
async ({ orientation, swapped, topLeftIs, bottomRightIs }) => {
|
||||
const inputPath = path.join(tempDir, `in-${orientation}.jpg`)
|
||||
const outputPath = path.join(tempDir, `out-${orientation}.webp`)
|
||||
fs.writeFileSync(inputPath, await makeJpeg(orientation))
|
||||
|
||||
await transcodeService.transcodeImage(inputPath, outputPath, 1000, 100)
|
||||
|
||||
const meta = await sharp(fs.readFileSync(outputPath)).metadata()
|
||||
const expected = expectedSize(swapped)
|
||||
expect(meta.width).toBe(expected.width)
|
||||
expect(meta.height).toBe(expected.height)
|
||||
// Direction, not just size: the stored corner that lands top-left and bottom-right.
|
||||
expect(await cornerColor(outputPath, 'TL')).toBe(topLeftIs)
|
||||
expect(await cornerColor(outputPath, 'BR')).toBe(bottomRightIs)
|
||||
},
|
||||
)
|
||||
|
||||
it('transcodeImage sizes a rotated preview from the displayed dimensions', async () => {
|
||||
// Stored 64x48 with orientation 6 is displayed 48x64 (portrait): the short edge is the width.
|
||||
const inputPath = path.join(tempDir, 'preview-in.jpg')
|
||||
const outputPath = path.join(tempDir, 'preview-out.webp')
|
||||
fs.writeFileSync(inputPath, await makeJpeg(6))
|
||||
|
||||
await transcodeService.transcodeImage(inputPath, outputPath, 24, 80, { isPreview: true })
|
||||
|
||||
const meta = await sharp(fs.readFileSync(outputPath)).metadata()
|
||||
expect(meta.width).toBeLessThan(meta.height ?? 0)
|
||||
})
|
||||
|
||||
describe('RAW inputs', () => {
|
||||
const rawPreview = (previewPath: string, extra: Record<string, unknown>) => ({
|
||||
previewPath,
|
||||
cleanup: () => {},
|
||||
width: STORED_WIDTH,
|
||||
height: STORED_HEIGHT,
|
||||
...extra,
|
||||
})
|
||||
|
||||
it('never auto-orients dcraw_emu output that still carries an Orientation tag', async () => {
|
||||
// The dcraw fallback reports orientation undefined (already upright) but flags it as applied.
|
||||
const tiffLike = path.join(tempDir, 'dcraw.jpg')
|
||||
const outputPath = path.join(tempDir, 'dcraw-out.webp')
|
||||
fs.writeFileSync(tiffLike, await makeJpeg(6))
|
||||
extractRawMock.mockResolvedValueOnce(
|
||||
rawPreview(tiffLike, { orientation: undefined, orientationApplied: true }),
|
||||
)
|
||||
|
||||
await transcodeService.transcodeImage(path.join(tempDir, 'photo.cr2'), outputPath, 1000, 100)
|
||||
|
||||
const meta = await sharp(fs.readFileSync(outputPath)).metadata()
|
||||
// Stored landscape stays landscape and the stored corners stay put: no second rotation.
|
||||
expect(meta.width).toBe(STORED_WIDTH)
|
||||
expect(meta.height).toBe(STORED_HEIGHT)
|
||||
expect(await cornerColor(outputPath, 'TL')).toBe('TL')
|
||||
expect(await cornerColor(outputPath, 'BR')).toBe('BR')
|
||||
})
|
||||
|
||||
it('still auto-orients an embedded preview that has no container orientation', async () => {
|
||||
const embedded = path.join(tempDir, 'embedded.jpg')
|
||||
const outputPath = path.join(tempDir, 'embedded-out.webp')
|
||||
fs.writeFileSync(embedded, await makeJpeg(6))
|
||||
extractRawMock.mockResolvedValueOnce(rawPreview(embedded, { orientation: undefined }))
|
||||
|
||||
await transcodeService.transcodeImage(path.join(tempDir, 'photo.cr2'), outputPath, 1000, 100)
|
||||
|
||||
const meta = await sharp(fs.readFileSync(outputPath)).metadata()
|
||||
expect(meta.width).toBe(STORED_HEIGHT)
|
||||
expect(meta.height).toBe(STORED_WIDTH)
|
||||
})
|
||||
})
|
||||
|
||||
it('overlayAnnotationsOnBuffer keeps the displayed orientation', async () => {
|
||||
const annotations = [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ffffff',
|
||||
points: [
|
||||
[0.1, 0.1],
|
||||
[0.4, 0.4],
|
||||
],
|
||||
},
|
||||
] as unknown as PrismaJson.AnnotationList
|
||||
const annotated = await transcodeService.overlayAnnotationsOnBuffer(
|
||||
await makeJpeg(6),
|
||||
annotations,
|
||||
)
|
||||
|
||||
const meta = await sharp(annotated).metadata()
|
||||
expect(meta.width).toBe(STORED_HEIGHT)
|
||||
expect(meta.height).toBe(STORED_WIDTH)
|
||||
})
|
||||
})
|
||||
@@ -330,7 +330,7 @@ describe('TranscodeService', () => {
|
||||
const outputFile = path.join(tempDir, 'output.webp')
|
||||
await transcodeService.transcodeImage('input.png', outputFile, 300, 80, { isPreview: true })
|
||||
|
||||
expect(sharp).toHaveBeenCalledWith('input.png', { limitInputPixels: false })
|
||||
expect(sharp).toHaveBeenCalledWith('input.png', { limitInputPixels: false, autoOrient: true })
|
||||
const mockSharp = vi.mocked(sharp).mock.results[0].value
|
||||
expect(mockSharp.toColorspace).toHaveBeenCalledWith('srgb')
|
||||
expect(mockSharp.resize).toHaveBeenCalledWith(400, 300, expect.any(Object))
|
||||
@@ -544,7 +544,11 @@ describe('TranscodeService', () => {
|
||||
|
||||
await transcodeService.transcodeImage(rawPath, outputFile, 1920, 85)
|
||||
|
||||
expect(sharp).toHaveBeenCalledWith('/tmp/extracted-raw.jpg', { limitInputPixels: false })
|
||||
// The RAW container orientation (1 here) is authoritative, so no auto-orient on top of it.
|
||||
expect(sharp).toHaveBeenCalledWith('/tmp/extracted-raw.jpg', {
|
||||
limitInputPixels: false,
|
||||
autoOrient: false,
|
||||
})
|
||||
const mockSharp = vi.mocked(sharp).mock.results[vi.mocked(sharp).mock.results.length - 1].value
|
||||
expect(mockSharp.toColorspace).toHaveBeenCalledWith('srgb')
|
||||
expect(mockSharp.webp).toHaveBeenCalledWith({ quality: 85 })
|
||||
@@ -568,7 +572,10 @@ describe('TranscodeService', () => {
|
||||
|
||||
await transcodeService.transcodeImage(rawPath, outputFile, 1920, 85)
|
||||
|
||||
expect(sharp).toHaveBeenCalledWith('/tmp/decoded-dcraw.tiff', { limitInputPixels: false })
|
||||
expect(sharp).toHaveBeenCalledWith('/tmp/decoded-dcraw.tiff', {
|
||||
limitInputPixels: false,
|
||||
autoOrient: true,
|
||||
})
|
||||
const mockSharp = vi.mocked(sharp).mock.results[vi.mocked(sharp).mock.results.length - 1].value
|
||||
expect(mockSharp.rotate).not.toHaveBeenCalled()
|
||||
expect(mockSharp.toColorspace).toHaveBeenCalledWith('srgb')
|
||||
@@ -593,9 +600,67 @@ describe('TranscodeService', () => {
|
||||
|
||||
const mockSharp = vi.mocked(sharp).mock.results[vi.mocked(sharp).mock.results.length - 1].value
|
||||
expect(mockSharp.rotate).toHaveBeenCalledWith(90)
|
||||
// Rotated from the container EXIF only, never also auto-oriented (would double-rotate).
|
||||
expect(sharp).toHaveBeenCalledWith('/tmp/extracted-rotated.jpg', {
|
||||
limitInputPixels: false,
|
||||
autoOrient: false,
|
||||
})
|
||||
expect(cleanupSpy).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should apply EXIF orientation when transcoding a rotated photo', async () => {
|
||||
// A camera portrait: stored 7728x5152 (landscape) with EXIF orientation 8, shown 5152x7728.
|
||||
const mockRotated = {
|
||||
resize: vi.fn().mockReturnThis(),
|
||||
toColorspace: vi.fn().mockReturnThis(),
|
||||
webp: vi.fn().mockReturnThis(),
|
||||
toFile: vi.fn().mockResolvedValue({}),
|
||||
metadata: vi.fn().mockResolvedValue({
|
||||
width: 7728,
|
||||
height: 5152,
|
||||
orientation: 8,
|
||||
autoOrient: { width: 5152, height: 7728 },
|
||||
format: 'jpeg',
|
||||
}),
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(sharp).mockReturnValueOnce(mockRotated as any)
|
||||
|
||||
await transcodeService.transcodeImage(
|
||||
'DSCF5056.JPG',
|
||||
path.join(tempDir, 'rotated.webp'),
|
||||
300,
|
||||
80,
|
||||
{ isPreview: true },
|
||||
)
|
||||
|
||||
expect(sharp).toHaveBeenCalledWith(
|
||||
'DSCF5056.JPG',
|
||||
expect.objectContaining({ autoOrient: true }),
|
||||
)
|
||||
// Portrait preview: 300 wide on the short edge, not a 450x300 landscape one.
|
||||
expect(mockRotated.resize).toHaveBeenCalledWith(300, 450, expect.any(Object))
|
||||
})
|
||||
|
||||
it('should report the displayed size of a rotated photo', async () => {
|
||||
const mockRotated = {
|
||||
metadata: vi.fn().mockResolvedValue({
|
||||
width: 7728,
|
||||
height: 5152,
|
||||
orientation: 8,
|
||||
autoOrient: { width: 5152, height: 7728 },
|
||||
format: 'jpeg',
|
||||
}),
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(sharp).mockReturnValueOnce(mockRotated as any)
|
||||
|
||||
const info = await transcodeService.getImageInfo('DSCF5056.JPG')
|
||||
|
||||
expect(info.originalWidth).toBe(5152)
|
||||
expect(info.originalHeight).toBe(7728)
|
||||
})
|
||||
|
||||
it('should throw error when transcoding RAW without usable preview', async () => {
|
||||
const rawPath = path.join(tempDir, 'corrupt.raf')
|
||||
const outputFile = path.join(tempDir, 'output-fail.webp')
|
||||
@@ -618,7 +683,10 @@ describe('TranscodeService', () => {
|
||||
await transcodeService.transcodeImage('http://example.com/image.png', outputFile, 480, 80)
|
||||
|
||||
expect(global.fetch).toHaveBeenCalledWith('http://example.com/image.png')
|
||||
expect(sharp).toHaveBeenCalledWith(expect.any(Buffer), { limitInputPixels: false })
|
||||
expect(sharp).toHaveBeenCalledWith(expect.any(Buffer), {
|
||||
limitInputPixels: false,
|
||||
autoOrient: true,
|
||||
})
|
||||
})
|
||||
|
||||
it('should support Buffer as input for image transcoding', async () => {
|
||||
@@ -626,7 +694,7 @@ describe('TranscodeService', () => {
|
||||
const outputFile = path.join(tempDir, 'output-buffer.webp')
|
||||
await transcodeService.transcodeImage(inputBuffer, outputFile, 480, 80)
|
||||
|
||||
expect(sharp).toHaveBeenCalledWith(inputBuffer, { limitInputPixels: false })
|
||||
expect(sharp).toHaveBeenCalledWith(inputBuffer, { limitInputPixels: false, autoOrient: true })
|
||||
const mockSharp = vi.mocked(sharp).mock.results[vi.mocked(sharp).mock.results.length - 1].value
|
||||
expect(mockSharp.toColorspace).toHaveBeenCalledWith('srgb')
|
||||
expect(mockSharp.resize).toHaveBeenCalledWith(400, 300, expect.any(Object))
|
||||
@@ -4364,6 +4432,89 @@ describe('TranscodeService', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('generate3dViews', () => {
|
||||
it('executes ffmpeg with 2x2 grid filter, libwebp encoder, and q=85', async () => {
|
||||
let executedArgs: string[] = []
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
;(child_process.execFile as any).mockImplementation(
|
||||
(
|
||||
_cmd: string,
|
||||
args: string[],
|
||||
cb: (err: unknown, result: { stdout: string; stderr: string }) => void,
|
||||
) => {
|
||||
executedArgs = args
|
||||
cb(null, { stdout: '', stderr: '' })
|
||||
},
|
||||
)
|
||||
|
||||
const inputPath = path.join(tempDir, 'turntable.mp4')
|
||||
const outputPath = path.join(tempDir, 'views.webp')
|
||||
|
||||
await transcodeService.generate3dViews(inputPath, outputPath)
|
||||
|
||||
expect(child_process.execFile).toHaveBeenCalledWith(
|
||||
'ffmpeg',
|
||||
expect.any(Array),
|
||||
expect.any(Function),
|
||||
)
|
||||
expect(executedArgs).toEqual([
|
||||
'-y',
|
||||
'-loglevel',
|
||||
'warning',
|
||||
'-i',
|
||||
inputPath,
|
||||
'-filter_complex',
|
||||
"[0:v]select='eq(n\\,0)+eq(n\\,6)+eq(n\\,12)+eq(n\\,18)',scale=1440:1440,tile=2x2[views_out]",
|
||||
'-map',
|
||||
'[views_out]',
|
||||
'-frames:v',
|
||||
'1',
|
||||
'-c:v',
|
||||
'libwebp',
|
||||
'-q:v',
|
||||
'85',
|
||||
outputPath,
|
||||
])
|
||||
})
|
||||
|
||||
it('passes abort signal to execFile when provided', async () => {
|
||||
const controller = new AbortController()
|
||||
let optionsPassed: unknown = null
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
;(child_process.execFile as any).mockImplementation(
|
||||
(_cmd: string, _args: string[], optionsOrCb: unknown, maybeCb?: unknown) => {
|
||||
const cb = (typeof optionsOrCb === 'function' ? optionsOrCb : maybeCb) as (
|
||||
err: unknown,
|
||||
result: { stdout: string; stderr: string },
|
||||
) => void
|
||||
if (typeof optionsOrCb !== 'function') {
|
||||
optionsPassed = optionsOrCb
|
||||
}
|
||||
cb(null, { stdout: '', stderr: '' })
|
||||
},
|
||||
)
|
||||
|
||||
const inputPath = path.join(tempDir, 'turntable.mp4')
|
||||
const outputPath = path.join(tempDir, 'views.webp')
|
||||
|
||||
await transcodeService.generate3dViews(inputPath, outputPath, controller.signal)
|
||||
|
||||
expect(optionsPassed).toMatchObject({ signal: controller.signal })
|
||||
})
|
||||
|
||||
it('rejects with cancellation error if aborted before execution', async () => {
|
||||
const controller = new AbortController()
|
||||
controller.abort()
|
||||
|
||||
const inputPath = path.join(tempDir, 'aborted.mp4')
|
||||
const outputPath = path.join(tempDir, 'views.webp')
|
||||
|
||||
await expect(
|
||||
transcodeService.generate3dViews(inputPath, outputPath, controller.signal),
|
||||
).rejects.toThrow('3D views generation cancelled')
|
||||
})
|
||||
})
|
||||
|
||||
describe('HLS utilities', () => {
|
||||
it('builds master playlist correctly with bandwidth and codecs', () => {
|
||||
const playlist = buildHlsMasterPlaylist([
|
||||
|
||||
@@ -8,7 +8,7 @@ import * as fs from 'fs'
|
||||
import * as os from 'os'
|
||||
import * as path from 'path'
|
||||
import PDFDocument from 'pdfkit'
|
||||
import sharp from 'sharp'
|
||||
import sharp, { type Metadata as SharpMetadata } from 'sharp'
|
||||
import { ulid } from 'ulid'
|
||||
import { promisify } from 'util'
|
||||
import { mapConcurrent } from '../utils/async'
|
||||
@@ -419,6 +419,28 @@ function normalizeRotation(rotation: number): number {
|
||||
return ((Math.round(rotation) % 360) + 360) % 360
|
||||
}
|
||||
|
||||
interface OrientationOptions {
|
||||
/** True when a RAW container orientation is applied by hand, so sharp must not also auto-orient. */
|
||||
rawOrientationApplied?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Sharp input options. The webp output drops the EXIF orientation tag, so camera portraits would
|
||||
* come out sideways unless sharp applies it; skip that when the RAW orientation is already applied,
|
||||
* otherwise the image would rotate twice.
|
||||
*/
|
||||
function orientedSharpOptions({ rawOrientationApplied = false }: OrientationOptions = {}) {
|
||||
return { limitInputPixels: false, autoOrient: !rawOrientationApplied } as const
|
||||
}
|
||||
|
||||
/** Width and height as displayed: sharp reports the EXIF-oriented size under `autoOrient`. */
|
||||
function displayedDimensions(
|
||||
metadata: SharpMetadata,
|
||||
{ rawOrientationApplied = false }: OrientationOptions = {},
|
||||
): Pick<SharpMetadata, 'width' | 'height'> {
|
||||
return rawOrientationApplied ? metadata : (metadata.autoOrient ?? metadata)
|
||||
}
|
||||
|
||||
export function parseBitrateKbps(bitrate: string | number): number {
|
||||
if (typeof bitrate === 'number') {
|
||||
return Math.round(bitrate / 1000)
|
||||
@@ -955,9 +977,11 @@ export class TranscodeService {
|
||||
}
|
||||
|
||||
const metadata = await sharp(input, { limitInputPixels: false }).metadata()
|
||||
// Cameras store portraits sideways plus an EXIF orientation; report the size as displayed.
|
||||
const shown = displayedDimensions(metadata)
|
||||
return {
|
||||
originalWidth: metadata.width || 0,
|
||||
originalHeight: metadata.height || 0,
|
||||
originalWidth: shown.width || 0,
|
||||
originalHeight: shown.height || 0,
|
||||
duration: 0,
|
||||
bitRate: 0,
|
||||
frameRate: 0,
|
||||
@@ -1922,6 +1946,7 @@ export class TranscodeService {
|
||||
|
||||
// RAW branch — extract embedded preview or decode RAW to temporary file + orientation, then treat as normal image
|
||||
let rawOrientation: number | undefined
|
||||
let rawOutputUpright = false
|
||||
let rawCleanup: (() => void) | null = null
|
||||
if (typeof input === 'string' && isRawImage(input)) {
|
||||
const extracted = await extractAndValidateRawPreview(input)
|
||||
@@ -1932,6 +1957,7 @@ export class TranscodeService {
|
||||
}
|
||||
input = extracted.previewPath
|
||||
rawOrientation = extracted.orientation
|
||||
rawOutputUpright = extracted.orientationApplied === true
|
||||
rawCleanup = extracted.cleanup
|
||||
}
|
||||
|
||||
@@ -1940,11 +1966,17 @@ export class TranscodeService {
|
||||
let targetW = width > 0 ? Math.min(width, WEBP_MAX_DIMENSION) : WEBP_MAX_DIMENSION
|
||||
let targetH = height && height > 0 ? Math.min(height, WEBP_MAX_DIMENSION) : WEBP_MAX_DIMENSION
|
||||
|
||||
const sharpInstance = sharp(input, { limitInputPixels: false })
|
||||
// RAW previews are oriented from the container EXIF below, so only auto-orient other
|
||||
// inputs: the webp output drops the tag, which would leave camera portraits sideways.
|
||||
// dcraw_emu output is already upright, so it is never auto-oriented (no double rotation).
|
||||
const rawOrientationApplied = rawOrientation !== undefined || rawOutputUpright
|
||||
const sharpInstance = sharp(input, orientedSharpOptions({ rawOrientationApplied }))
|
||||
|
||||
if (isPreview) {
|
||||
try {
|
||||
const meta = await sharpInstance.metadata()
|
||||
const meta = displayedDimensions(await sharpInstance.metadata(), {
|
||||
rawOrientationApplied,
|
||||
})
|
||||
if (meta.width && meta.height) {
|
||||
const isSwapped =
|
||||
rawOrientation !== undefined && rawOrientation >= 5 && rawOrientation <= 8
|
||||
@@ -2003,7 +2035,7 @@ export class TranscodeService {
|
||||
|
||||
// Apply EXIF orientation from the RAW container to the extracted buffer.
|
||||
// The buffer itself often lacks orientation EXIF, so Sharp won't auto-rotate.
|
||||
// For non-RAW images, Sharp auto-rotates from the image's own EXIF.
|
||||
// For non-RAW images, autoOrient above applies the image's own EXIF.
|
||||
if (rawOrientation && EXIF_ORIENTATION_TO_ROTATION[rawOrientation]) {
|
||||
const { angle, flip, flop } = EXIF_ORIENTATION_TO_ROTATION[rawOrientation]
|
||||
if (angle) sharpInstance.rotate(angle)
|
||||
@@ -3019,12 +3051,15 @@ export class TranscodeService {
|
||||
return imageBuffer
|
||||
}
|
||||
|
||||
const meta = await sharp(imageBuffer, { limitInputPixels: false }).metadata()
|
||||
// Annotations are drawn in the displayed (EXIF-oriented) coordinate space.
|
||||
const meta = displayedDimensions(
|
||||
await sharp(imageBuffer, { limitInputPixels: false }).metadata(),
|
||||
)
|
||||
const width = meta.width || 1920
|
||||
const height = meta.height || 1080
|
||||
|
||||
const svgStr = renderAnnotationsToSvg(width, height, annotations)
|
||||
return await sharp(imageBuffer, { limitInputPixels: false })
|
||||
return await sharp(imageBuffer, orientedSharpOptions())
|
||||
.composite([{ input: Buffer.from(svgStr), top: 0, left: 0 }])
|
||||
.toColorspace('srgb')
|
||||
.resize(16383, 16383, { fit: 'inside', withoutEnlargement: true })
|
||||
@@ -3111,13 +3146,83 @@ export class TranscodeService {
|
||||
width: number,
|
||||
height: number,
|
||||
): Promise<void> {
|
||||
await sharp(inputPath, { limitInputPixels: false })
|
||||
await sharp(inputPath, orientedSharpOptions())
|
||||
.toColorspace('srgb')
|
||||
.resize(width, height, { fit: 'inside' })
|
||||
.composite([{ input: overlayPngBuffer }])
|
||||
.webp({ quality: 90 })
|
||||
.toFile(outputPath)
|
||||
}
|
||||
|
||||
async convertImageToWebp(imageBuffer: Buffer, quality = 85): Promise<Buffer> {
|
||||
return await sharp(imageBuffer, { limitInputPixels: false })
|
||||
.toColorspace('srgb')
|
||||
.webp({ quality })
|
||||
.toBuffer()
|
||||
}
|
||||
|
||||
async generate3dSprite(
|
||||
inputFile: string,
|
||||
outputSprite: string,
|
||||
signal?: AbortSignal,
|
||||
): Promise<void> {
|
||||
if (signal?.aborted) {
|
||||
throw new Error('Sprite generation cancelled')
|
||||
}
|
||||
const spriteFps = 100 / 4
|
||||
const filterComplex = `[0:v]fps=${spriteFps},scale=w=300:h=-2,tile=10x10[sprite_out]`
|
||||
const args = [
|
||||
'-i',
|
||||
inputFile,
|
||||
'-filter_complex',
|
||||
filterComplex,
|
||||
'-map',
|
||||
'[sprite_out]',
|
||||
'-frames:v',
|
||||
'1',
|
||||
'-c:v',
|
||||
'libwebp',
|
||||
'-q:v',
|
||||
'75',
|
||||
outputSprite,
|
||||
]
|
||||
if (signal) {
|
||||
await execFileAsync('ffmpeg', ['-y', '-loglevel', 'warning', ...args], { signal })
|
||||
} else {
|
||||
await execFileAsync('ffmpeg', ['-y', '-loglevel', 'warning', ...args])
|
||||
}
|
||||
}
|
||||
|
||||
async generate3dViews(
|
||||
inputFile: string,
|
||||
outputViews: string,
|
||||
signal?: AbortSignal,
|
||||
): Promise<void> {
|
||||
if (signal?.aborted) {
|
||||
throw new Error('3D views generation cancelled')
|
||||
}
|
||||
const filterComplex = `[0:v]select='eq(n\\,0)+eq(n\\,6)+eq(n\\,12)+eq(n\\,18)',scale=1440:1440,tile=2x2[views_out]`
|
||||
const args = [
|
||||
'-i',
|
||||
inputFile,
|
||||
'-filter_complex',
|
||||
filterComplex,
|
||||
'-map',
|
||||
'[views_out]',
|
||||
'-frames:v',
|
||||
'1',
|
||||
'-c:v',
|
||||
'libwebp',
|
||||
'-q:v',
|
||||
'85',
|
||||
outputViews,
|
||||
]
|
||||
if (signal) {
|
||||
await execFileAsync('ffmpeg', ['-y', '-loglevel', 'warning', ...args], { signal })
|
||||
} else {
|
||||
await execFileAsync('ffmpeg', ['-y', '-loglevel', 'warning', ...args])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function renderAnnotationsToSvg(
|
||||
|
||||
@@ -0,0 +1,237 @@
|
||||
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import * as os from 'os'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { TurntableService } from './turntable'
|
||||
|
||||
describe('TurntableService', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
const originalEnv = process.env
|
||||
let tmpDir: string
|
||||
let testFilePath: string
|
||||
|
||||
beforeEach(() => {
|
||||
process.env = { ...originalEnv }
|
||||
delete process.env.TURNTABLE_RENDERER_URL
|
||||
delete process.env.TURNTABLE_RENDERER_BASIC_AUTH_USERNAME
|
||||
delete process.env.TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD
|
||||
delete process.env.TURNTABLE_RENDERER_USERNAME
|
||||
delete process.env.TURNTABLE_RENDERER_PASSWORD
|
||||
|
||||
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'turntable-test-'))
|
||||
testFilePath = path.join(tmpDir, 'model.glb')
|
||||
fs.writeFileSync(testFilePath, 'fake glb content')
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
process.env = originalEnv
|
||||
fs.rmSync(tmpDir, { recursive: true, force: true })
|
||||
vi.restoreAllMocks()
|
||||
})
|
||||
|
||||
describe('resolveConfig', () => {
|
||||
it('returns isEnv: false when neither env nor team settings are present', async () => {
|
||||
const service = new TurntableService()
|
||||
const config = await service.resolveConfig()
|
||||
expect(config.url).toBeUndefined()
|
||||
expect(config.isEnv).toBe(false)
|
||||
})
|
||||
|
||||
it('resolves env configuration with highest priority', async () => {
|
||||
process.env.TURNTABLE_RENDERER_URL = 'http://localhost:3000/'
|
||||
process.env.TURNTABLE_RENDERER_BASIC_AUTH_USERNAME = 'admin'
|
||||
process.env.TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD = 'secret'
|
||||
|
||||
const service = new TurntableService()
|
||||
const config = await service.resolveConfig('any-team-id')
|
||||
|
||||
expect(config.url).toBe('http://localhost:3000')
|
||||
expect(config.username).toBe('admin')
|
||||
expect(config.password).toBe('secret')
|
||||
expect(config.isEnv).toBe(true)
|
||||
})
|
||||
|
||||
it('falls back to team DB settings when env is not set', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: {
|
||||
name: 'Test Team 3D',
|
||||
settings: {
|
||||
turntable: {
|
||||
url: 'http://custom-turntable:4000',
|
||||
username: 'teamUser',
|
||||
password: 'teamPassword',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const service = new TurntableService()
|
||||
const config = await service.resolveConfig(team.id)
|
||||
|
||||
expect(config.url).toBe('http://custom-turntable:4000')
|
||||
expect(config.username).toBe('teamUser')
|
||||
expect(config.password).toBe('teamPassword')
|
||||
expect(config.isEnv).toBe(false)
|
||||
})
|
||||
})
|
||||
|
||||
describe('isAvailable', () => {
|
||||
it('returns false if URL is not configured', async () => {
|
||||
const service = new TurntableService()
|
||||
expect(await service.isAvailable()).toBe(false)
|
||||
})
|
||||
|
||||
it('returns true when health check returns 200', async () => {
|
||||
process.env.TURNTABLE_RENDERER_URL = 'http://turntable:3000'
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
expect(await service.isAvailable()).toBe(true)
|
||||
})
|
||||
|
||||
it('returns false when health check fails or throws', async () => {
|
||||
process.env.TURNTABLE_RENDERER_URL = 'http://turntable:3000'
|
||||
vi.spyOn(globalThis, 'fetch').mockRejectedValue(new Error('Connection refused'))
|
||||
|
||||
const service = new TurntableService()
|
||||
expect(await service.isAvailable()).toBe(false)
|
||||
})
|
||||
})
|
||||
|
||||
describe('testConnection', () => {
|
||||
it('returns error when url is empty', async () => {
|
||||
const service = new TurntableService()
|
||||
const result = await service.testConnection({})
|
||||
expect(result.ok).toBe(false)
|
||||
expect(result.error).toBe('URL is required')
|
||||
})
|
||||
|
||||
it('returns version information upon successful connection', async () => {
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
json: async () => ({ version: '0.1.0', blender: '5.2.2' }),
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
const result = await service.testConnection({ url: 'http://localhost:3000' })
|
||||
|
||||
expect(result.ok).toBe(true)
|
||||
expect(result.version).toBe('0.1.0')
|
||||
expect(result.blender).toBe('5.2.2')
|
||||
})
|
||||
})
|
||||
|
||||
describe('uploadFile', () => {
|
||||
it('posts file buffer to /v1/files and returns file info', async () => {
|
||||
process.env.TURNTABLE_RENDERER_URL = 'http://turntable:3000'
|
||||
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 201,
|
||||
json: async () => ({ id: 'f_test123', name: 'model.glb', size: 100 }),
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
const res = await service.uploadFile(testFilePath, 'model.glb')
|
||||
|
||||
expect(res.id).toBe('f_test123')
|
||||
expect(fetchSpy).toHaveBeenCalledWith(
|
||||
'http://turntable:3000/v1/files',
|
||||
expect.objectContaining({
|
||||
method: 'POST',
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('startRender & getTaskStatus & downloadFile & deleteTask', () => {
|
||||
beforeEach(() => {
|
||||
process.env.TURNTABLE_RENDERER_URL = 'http://turntable:3000'
|
||||
})
|
||||
|
||||
it('startRender calls /v1/render and returns sync response', async () => {
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
json: async () => ({
|
||||
taskId: 't_test456',
|
||||
status: 'queued',
|
||||
poster: {
|
||||
fileId: 'f_poster',
|
||||
size: 200,
|
||||
contentType: 'image/png',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
}),
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
const res = await service.startRender('f_input')
|
||||
expect(res.taskId).toBe('t_test456')
|
||||
expect(res.poster.fileId).toBe('f_poster')
|
||||
})
|
||||
|
||||
it('getTaskStatus queries /v1/render/tasks/:id', async () => {
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
json: async () => ({
|
||||
taskId: 't_test456',
|
||||
status: 'completed',
|
||||
video: {
|
||||
fileId: 'f_video',
|
||||
size: 1000,
|
||||
contentType: 'video/mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
}),
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
const res = await service.getTaskStatus('t_test456')
|
||||
expect(res.status).toBe('completed')
|
||||
expect(res.video?.fileId).toBe('f_video')
|
||||
})
|
||||
|
||||
it('downloadFile fetches /v1/files/:id and writes to destination', async () => {
|
||||
const destPath = path.join(tmpDir, 'downloaded.mp4')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
arrayBuffer: async () => Buffer.from('video data').buffer,
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
await service.downloadFile('f_video', destPath)
|
||||
|
||||
expect(fs.existsSync(destPath)).toBe(true)
|
||||
expect(fs.readFileSync(destPath, 'utf8')).toBe('video data')
|
||||
})
|
||||
|
||||
it('deleteTask calls DELETE /v1/render/tasks/:id and returns boolean', async () => {
|
||||
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200,
|
||||
} as Response)
|
||||
|
||||
const service = new TurntableService()
|
||||
const deleted = await service.deleteTask('t_test456')
|
||||
|
||||
expect(deleted).toBe(true)
|
||||
expect(fetchSpy).toHaveBeenCalledWith(
|
||||
'http://turntable:3000/v1/render/tasks/t_test456',
|
||||
expect.objectContaining({
|
||||
method: 'DELETE',
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,364 @@
|
||||
import * as fs from 'fs'
|
||||
import type { TurntableSettingsResponse, UpdateTurntableSettingsRequest } from '@shumai/dtos'
|
||||
import {
|
||||
IntegrationDefinition,
|
||||
resolveIntegrationConfig,
|
||||
getIntegrationSettings,
|
||||
updateIntegrationSettings,
|
||||
resolveTestConnectionConfig,
|
||||
getIntegrationBasicAuthHeader,
|
||||
} from '@shumai/core/src/integrations/helper'
|
||||
|
||||
export const TURNTABLE_INTEGRATION_DEF: IntegrationDefinition<'turntable'> = {
|
||||
name: 'Turntable',
|
||||
settingsKey: 'turntable',
|
||||
envKeys: {
|
||||
url: ['TURNTABLE_RENDERER_URL'],
|
||||
username: ['TURNTABLE_RENDERER_BASIC_AUTH_USERNAME', 'TURNTABLE_RENDERER_USERNAME'],
|
||||
password: ['TURNTABLE_RENDERER_BASIC_AUTH_PASSWORD', 'TURNTABLE_RENDERER_PASSWORD'],
|
||||
},
|
||||
}
|
||||
|
||||
export interface TurntableConfig {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
isEnv: boolean
|
||||
}
|
||||
|
||||
export interface TurntablePosterOutput {
|
||||
fileId: string
|
||||
size: number
|
||||
contentType: string
|
||||
width: number
|
||||
height: number
|
||||
}
|
||||
|
||||
export interface TurntableRenderSyncResponse {
|
||||
taskId: string
|
||||
status: 'queued' | 'rendering'
|
||||
positionInQueue?: number
|
||||
metadata?: Record<string, unknown>
|
||||
poster: TurntablePosterOutput
|
||||
}
|
||||
|
||||
export interface TurntableVideoOutput {
|
||||
fileId: string
|
||||
size: number
|
||||
contentType: string
|
||||
width: number
|
||||
height: number
|
||||
}
|
||||
|
||||
export interface TurntableRenderStats {
|
||||
width: number
|
||||
height: number
|
||||
frames: number
|
||||
fps: number
|
||||
durationSeconds: number
|
||||
degreesPerFrame: number
|
||||
startAngle: number
|
||||
direction: string
|
||||
includeEndFrame: boolean
|
||||
engine: string
|
||||
elapsedMs: number
|
||||
}
|
||||
|
||||
export interface TurntableTaskResponse {
|
||||
taskId: string
|
||||
status: 'queued' | 'rendering' | 'completed' | 'failed'
|
||||
positionInQueue?: number
|
||||
createdAt: string
|
||||
startedAt?: string
|
||||
completedAt?: string
|
||||
failedAt?: string
|
||||
render?: TurntableRenderStats
|
||||
video?: TurntableVideoOutput
|
||||
error?: {
|
||||
code: string
|
||||
message: string
|
||||
details?: Record<string, unknown>
|
||||
}
|
||||
}
|
||||
|
||||
export class TurntableService {
|
||||
async resolveConfig(teamId?: string): Promise<TurntableConfig> {
|
||||
return resolveIntegrationConfig(TURNTABLE_INTEGRATION_DEF, teamId)
|
||||
}
|
||||
|
||||
private getAuthHeader(config: TurntableConfig): string | undefined {
|
||||
return getIntegrationBasicAuthHeader(config)
|
||||
}
|
||||
|
||||
async isAvailable(teamId?: string): Promise<boolean> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
return false
|
||||
}
|
||||
|
||||
try {
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${config.url}/health`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(3000),
|
||||
})
|
||||
|
||||
return response.ok
|
||||
} catch {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
async getSettings(teamId: string): Promise<TurntableSettingsResponse> {
|
||||
return getIntegrationSettings(TURNTABLE_INTEGRATION_DEF, teamId)
|
||||
}
|
||||
|
||||
async updateSettings(
|
||||
teamId: string,
|
||||
req: UpdateTurntableSettingsRequest,
|
||||
): Promise<TurntableSettingsResponse> {
|
||||
return updateIntegrationSettings(TURNTABLE_INTEGRATION_DEF, teamId, req)
|
||||
}
|
||||
|
||||
async testConnection(
|
||||
config?: {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
},
|
||||
teamId?: string,
|
||||
): Promise<{ ok: boolean; version?: string; blender?: string; error?: string }> {
|
||||
const target = await resolveTestConnectionConfig(TURNTABLE_INTEGRATION_DEF, config, teamId)
|
||||
|
||||
if (!target.resolvedUrl) {
|
||||
return { ok: false, error: 'URL is required' }
|
||||
}
|
||||
const cleanUrl = target.resolvedUrl.replace(/\/+$/, '')
|
||||
|
||||
try {
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = getIntegrationBasicAuthHeader({
|
||||
username: target.resolvedUsername,
|
||||
password: target.resolvedPassword,
|
||||
})
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${cleanUrl}/version`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(5000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errText = await response.text().catch(() => '')
|
||||
return {
|
||||
ok: false,
|
||||
error: `Server returned status ${response.status}: ${errText || response.statusText}`,
|
||||
}
|
||||
}
|
||||
|
||||
const body = (await response.json()) as { version?: string; blender?: string }
|
||||
return {
|
||||
ok: true,
|
||||
version: body.version,
|
||||
blender: body.blender,
|
||||
}
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err)
|
||||
return { ok: false, error: message }
|
||||
}
|
||||
}
|
||||
|
||||
async uploadFile(
|
||||
filePath: string,
|
||||
filename: string,
|
||||
teamId?: string,
|
||||
): Promise<{ id: string; name: string; size: number }> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Turntable renderer URL is not configured.')
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
'content-type': 'application/octet-stream',
|
||||
'x-filename': encodeURIComponent(filename),
|
||||
}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${config.url}/v1/files`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: Bun.file(filePath),
|
||||
signal: AbortSignal.timeout(900000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text().catch(() => '')
|
||||
throw new Error(
|
||||
`Turntable upload failed with status ${response.status}: ${errorText || response.statusText}`,
|
||||
)
|
||||
}
|
||||
|
||||
return (await response.json()) as { id: string; name: string; size: number }
|
||||
}
|
||||
|
||||
async startRender(
|
||||
fileId: string,
|
||||
options: Record<string, unknown> = {},
|
||||
teamId?: string,
|
||||
): Promise<TurntableRenderSyncResponse> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Turntable renderer URL is not configured.')
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
'content-type': 'application/json',
|
||||
}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${config.url}/v1/render`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: JSON.stringify({
|
||||
input: { fileId },
|
||||
options,
|
||||
}),
|
||||
signal: AbortSignal.timeout(60000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text().catch(() => '')
|
||||
throw new Error(
|
||||
`Turntable render request failed with status ${response.status}: ${errorText || response.statusText}`,
|
||||
)
|
||||
}
|
||||
|
||||
return (await response.json()) as TurntableRenderSyncResponse
|
||||
}
|
||||
|
||||
async getTaskStatus(taskId: string, teamId?: string): Promise<TurntableTaskResponse> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Turntable renderer URL is not configured.')
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${config.url}/v1/render/tasks/${taskId}`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(10000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text().catch(() => '')
|
||||
throw new Error(
|
||||
`Failed to fetch task status (${response.status}): ${errorText || response.statusText}`,
|
||||
)
|
||||
}
|
||||
|
||||
return (await response.json()) as TurntableTaskResponse
|
||||
}
|
||||
|
||||
async downloadFile(fileId: string, targetPath?: string, teamId?: string): Promise<Buffer> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
throw new Error('Turntable renderer URL is not configured.')
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
const response = await fetch(`${config.url}/v1/files/${fileId}`, {
|
||||
method: 'GET',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(120000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text().catch(() => '')
|
||||
throw new Error(
|
||||
`Failed to download file ${fileId} (${response.status}): ${errorText || response.statusText}`,
|
||||
)
|
||||
}
|
||||
|
||||
const arrayBuffer = await response.arrayBuffer()
|
||||
const buffer = Buffer.from(arrayBuffer)
|
||||
if (targetPath) {
|
||||
fs.writeFileSync(targetPath, buffer)
|
||||
}
|
||||
return buffer
|
||||
}
|
||||
|
||||
async deleteTask(taskId: string, teamId?: string): Promise<boolean> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
return false
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(`${config.url}/v1/render/tasks/${taskId}`, {
|
||||
method: 'DELETE',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(10000),
|
||||
})
|
||||
return response.ok
|
||||
} catch {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
async deleteFile(fileId: string, teamId?: string): Promise<boolean> {
|
||||
const config = await this.resolveConfig(teamId)
|
||||
if (!config.url) {
|
||||
return false
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {}
|
||||
const authHeader = this.getAuthHeader(config)
|
||||
if (authHeader) {
|
||||
headers['Authorization'] = authHeader
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(`${config.url}/v1/files/${fileId}`, {
|
||||
method: 'DELETE',
|
||||
headers,
|
||||
signal: AbortSignal.timeout(10000),
|
||||
})
|
||||
return response.ok
|
||||
} catch {
|
||||
return false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const turntableService = new TurntableService()
|
||||
@@ -3,6 +3,7 @@ import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { uploadService } from './upload'
|
||||
import { gotenbergService } from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { AssetStatus, AssetType, TaskStatus, WorkflowTaskType } from '@shumai/db'
|
||||
|
||||
@@ -450,6 +451,163 @@ describe('UploadService', () => {
|
||||
expect(workflowTask).toBeNull()
|
||||
})
|
||||
|
||||
it('should create transcode_pdf for office documents when Gotenberg is configured in team settings without global env', async () => {
|
||||
vi.restoreAllMocks()
|
||||
vi.spyOn(globalThis, 'fetch').mockImplementation(async (input) => {
|
||||
const url = String(input)
|
||||
if (url.includes('/health')) {
|
||||
return new Response(JSON.stringify({ status: 'up' }), { status: 200 })
|
||||
}
|
||||
return new Response('Not Found', { status: 404 })
|
||||
})
|
||||
const originalEnv = process.env.GOTENBERG_URL
|
||||
delete process.env.GOTENBERG_URL
|
||||
|
||||
try {
|
||||
await prisma.team.update({
|
||||
where: { id: teamId },
|
||||
data: {
|
||||
settings: {
|
||||
gotenberg: {
|
||||
url: 'http://gotenberg.local:3000',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const task = await prisma.task.create({
|
||||
data: { creatorId: userId, total: 1, uploaded: 0, type: 'upload' },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'report.docx',
|
||||
type: AssetType.file,
|
||||
project: { connect: { id: projectId } },
|
||||
parent: { connect: { id: parentId } },
|
||||
status: AssetStatus.uploading,
|
||||
storageKey: {
|
||||
connectOrCreate: {
|
||||
where: { key: 'test-key-doc-team-settings' },
|
||||
create: { key: 'test-key-doc-team-settings' },
|
||||
},
|
||||
},
|
||||
mediaType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
||||
},
|
||||
})
|
||||
|
||||
await uploadService.confirmFileUpload(userId, task.id, { fileId: asset.id })
|
||||
|
||||
const workflowTask = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: asset.id, type: WorkflowTaskType.transcode_pdf },
|
||||
})
|
||||
expect(workflowTask).not.toBeNull()
|
||||
expect(workflowTask?.status).toBe(TaskStatus.pending)
|
||||
|
||||
// Test HTML document as well
|
||||
const htmlTask = await prisma.task.create({
|
||||
data: { creatorId: userId, total: 1, uploaded: 0, type: 'upload' },
|
||||
})
|
||||
const htmlAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'index.html',
|
||||
type: AssetType.file,
|
||||
project: { connect: { id: projectId } },
|
||||
parent: { connect: { id: parentId } },
|
||||
status: AssetStatus.uploading,
|
||||
storageKey: {
|
||||
connectOrCreate: {
|
||||
where: { key: 'test-key-html-team-settings' },
|
||||
create: { key: 'test-key-html-team-settings' },
|
||||
},
|
||||
},
|
||||
mediaType: 'text/html',
|
||||
},
|
||||
})
|
||||
|
||||
await uploadService.confirmFileUpload(userId, htmlTask.id, { fileId: htmlAsset.id })
|
||||
|
||||
const htmlWorkflowTask = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: htmlAsset.id, type: WorkflowTaskType.transcode_pdf },
|
||||
})
|
||||
expect(htmlWorkflowTask).not.toBeNull()
|
||||
expect(htmlWorkflowTask?.status).toBe(TaskStatus.pending)
|
||||
} finally {
|
||||
if (originalEnv !== undefined) {
|
||||
process.env.GOTENBERG_URL = originalEnv
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
it('should confirm file upload and create transcode_3d for 3D model when turntable is available', async () => {
|
||||
vi.spyOn(turntableService, 'isAvailable').mockResolvedValue(true)
|
||||
const task = await prisma.task.create({
|
||||
data: { creatorId: userId, total: 1, uploaded: 0, type: 'upload' },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: AssetType.file,
|
||||
project: { connect: { id: projectId } },
|
||||
parent: { connect: { id: parentId } },
|
||||
status: AssetStatus.uploading,
|
||||
storageKey: {
|
||||
connectOrCreate: {
|
||||
where: { key: 'test-key-3d-1' },
|
||||
create: { key: 'test-key-3d-1' },
|
||||
},
|
||||
},
|
||||
mediaType: 'model/gltf-binary',
|
||||
},
|
||||
})
|
||||
|
||||
await uploadService.confirmFileUpload(userId, task.id, { fileId: asset.id })
|
||||
|
||||
const workflowTask = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: asset.id, type: WorkflowTaskType.transcode_3d },
|
||||
})
|
||||
expect(workflowTask).toBeDefined()
|
||||
expect(workflowTask?.payload).toEqual({
|
||||
projectId: projectId,
|
||||
transcode: {
|
||||
sprite: true,
|
||||
poster: true,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
it('should mark asset processed without creating transcode_3d for 3D model when turntable is unavailable', async () => {
|
||||
vi.spyOn(turntableService, 'isAvailable').mockResolvedValue(false)
|
||||
const task = await prisma.task.create({
|
||||
data: { creatorId: userId, total: 1, uploaded: 0, type: 'upload' },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: AssetType.file,
|
||||
project: { connect: { id: projectId } },
|
||||
parent: { connect: { id: parentId } },
|
||||
status: AssetStatus.uploading,
|
||||
storageKey: {
|
||||
connectOrCreate: {
|
||||
where: { key: 'test-key-3d-2' },
|
||||
create: { key: 'test-key-3d-2' },
|
||||
},
|
||||
},
|
||||
mediaType: 'model/gltf-binary',
|
||||
},
|
||||
})
|
||||
|
||||
await uploadService.confirmFileUpload(userId, task.id, { fileId: asset.id })
|
||||
|
||||
const updatedAsset = await prisma.asset.findUnique({ where: { id: asset.id } })
|
||||
expect(updatedAsset?.status).toBe(AssetStatus.processed)
|
||||
|
||||
const workflowTask = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: asset.id, type: WorkflowTaskType.transcode_3d },
|
||||
})
|
||||
expect(workflowTask).toBeNull()
|
||||
})
|
||||
|
||||
it('should confirm file upload and resolve empty mediaType using Bun resolver for audio', async () => {
|
||||
const task = await prisma.task.create({
|
||||
data: { creatorId: userId, total: 1, uploaded: 0, type: 'upload' },
|
||||
|
||||
@@ -14,10 +14,11 @@ import {
|
||||
S3SignResponse,
|
||||
TaskInfo,
|
||||
} from '@shumai/dtos'
|
||||
import { ImageTranscoder, PdfTranscoder, VideoTranscoder } from '@shumai/transcode'
|
||||
import { ImageTranscoder, ModelTranscoder, PdfTranscoder, VideoTranscoder } from '@shumai/transcode'
|
||||
import { generateKeyBetween } from 'jittered-fractional-indexing'
|
||||
import { ulid } from 'ulid'
|
||||
import { gotenbergService } from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { getProxyType, isHtmlDocument, isOfficeDocument } from '@shumai/core/src/utils/mime'
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
@@ -323,6 +324,7 @@ export class UploadService {
|
||||
const isImage = proxyType === 'image'
|
||||
const isAudio = proxyType === 'audio'
|
||||
const isPdf = proxyType === 'pdf'
|
||||
const is3D = proxyType === '3d'
|
||||
|
||||
if (!proxyType) {
|
||||
await tx.asset.update({
|
||||
@@ -361,7 +363,7 @@ export class UploadService {
|
||||
const isHtml = isHtmlDocument(asset.mediaType, asset.name)
|
||||
|
||||
if (isOffice || isHtml) {
|
||||
const gotenbergAvailable = await gotenbergService.isAvailable()
|
||||
const gotenbergAvailable = await gotenbergService.isAvailable(team.id)
|
||||
if (!gotenbergAvailable) {
|
||||
await tx.asset.update({
|
||||
where: { id: asset.id },
|
||||
@@ -376,6 +378,21 @@ export class UploadService {
|
||||
.withSprite()
|
||||
.withPoster()
|
||||
.submit()
|
||||
} else if (is3D) {
|
||||
const turntableAvailable = await turntableService.isAvailable(team.id)
|
||||
if (!turntableAvailable) {
|
||||
await tx.asset.update({
|
||||
where: { id: asset.id },
|
||||
data: { status: AssetStatus.processed },
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
await new ModelTranscoder(tx as any, asset.id, team.id, projectId)
|
||||
.withSprite()
|
||||
.withPoster()
|
||||
.submit()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -126,8 +126,26 @@ describe('getProxyType', () => {
|
||||
expect(getProxyType(null, 'slides.pptx')).toBe('pdf')
|
||||
})
|
||||
|
||||
it('should detect 3d proxyType for supported 3D models', () => {
|
||||
expect(getProxyType('model/gltf-binary', 'model.glb')).toBe('3d')
|
||||
expect(getProxyType(null, 'model.glb')).toBe('3d')
|
||||
expect(getProxyType(null, 'character.fbx')).toBe('3d')
|
||||
expect(getProxyType('model/obj', 'mesh.obj')).toBe('3d')
|
||||
expect(getProxyType(null, 'mesh.obj')).toBe('3d')
|
||||
expect(getProxyType('model/stl', 'part.stl')).toBe('3d')
|
||||
expect(getProxyType(null, 'part.stl')).toBe('3d')
|
||||
expect(getProxyType(null, 'scene.usd')).toBe('3d')
|
||||
expect(getProxyType(null, 'scene.usda')).toBe('3d')
|
||||
expect(getProxyType(null, 'scene.usdc')).toBe('3d')
|
||||
expect(getProxyType('model/vnd.usdz+zip', 'scene.usdz')).toBe('3d')
|
||||
expect(getProxyType('model/vnd.collada+xml', 'model.dae')).toBe('3d')
|
||||
expect(getProxyType(null, 'MODEL.GLB')).toBe('3d')
|
||||
})
|
||||
|
||||
it('should return null for unsupported files', () => {
|
||||
expect(getProxyType('application/zip', 'archive.zip')).toBeNull()
|
||||
expect(getProxyType(null, 'unknown.bin')).toBeNull()
|
||||
expect(getProxyType('model/gltf+json', 'model.gltf')).toBeNull()
|
||||
expect(getProxyType(null, 'model.gltf')).toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,6 +1,43 @@
|
||||
import { isRawImage } from './raw'
|
||||
|
||||
export type ProxyType = 'image' | 'video' | 'audio' | 'pdf'
|
||||
export type ProxyType = 'image' | 'video' | 'audio' | 'pdf' | '3d'
|
||||
|
||||
export function is3dModel(mediaType?: string | null, filename?: string | null): boolean {
|
||||
const lowerMediaType = mediaType?.toLowerCase() || ''
|
||||
const lowerFilename = filename?.toLowerCase() || ''
|
||||
|
||||
if (lowerMediaType === 'model/gltf+json' || lowerFilename.endsWith('.gltf')) {
|
||||
return false
|
||||
}
|
||||
|
||||
const modelExtensions = [
|
||||
'.glb',
|
||||
'.usd',
|
||||
'.usda',
|
||||
'.usdc',
|
||||
'.usdz',
|
||||
'.fbx',
|
||||
'.obj',
|
||||
'.stl',
|
||||
'.dae',
|
||||
]
|
||||
if (modelExtensions.some((ext) => lowerFilename.endsWith(ext))) {
|
||||
return true
|
||||
}
|
||||
|
||||
if (
|
||||
lowerMediaType.startsWith('model/') ||
|
||||
lowerMediaType === 'model/gltf-binary' ||
|
||||
lowerMediaType === 'model/obj' ||
|
||||
lowerMediaType === 'model/stl' ||
|
||||
lowerMediaType === 'model/vnd.usdz+zip' ||
|
||||
lowerMediaType === 'model/vnd.collada+xml'
|
||||
) {
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
export function isOfficeDocument(mediaType?: string | null, filename?: string | null): boolean {
|
||||
const lowerMediaType = mediaType?.toLowerCase() || ''
|
||||
@@ -97,6 +134,10 @@ export function getProxyType(
|
||||
return 'pdf'
|
||||
}
|
||||
|
||||
if (is3dModel(mediaType, filename)) {
|
||||
return '3d'
|
||||
}
|
||||
|
||||
return null
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
import { describe, expect, it } from 'vitest'
|
||||
import {
|
||||
calculateTurntableFrameCenterTime,
|
||||
degreeToSecond,
|
||||
degreeToTurntableFrame,
|
||||
isValidTurntableDegree,
|
||||
secondToDegree,
|
||||
secondToTurntableFrame,
|
||||
TOTAL_TURNTABLE_FRAMES,
|
||||
TURNTABLE_FPS,
|
||||
} from './model3d'
|
||||
|
||||
describe('model3d utils', () => {
|
||||
describe('secondToTurntableFrame', () => {
|
||||
it('converts playback seconds to frame indices (0..23)', () => {
|
||||
expect(secondToTurntableFrame(0)).toBe(0)
|
||||
expect(secondToTurntableFrame(0.167)).toBe(1)
|
||||
expect(secondToTurntableFrame(0.5)).toBe(3)
|
||||
expect(secondToTurntableFrame(2.0)).toBe(12)
|
||||
expect(secondToTurntableFrame(3.9)).toBe(23)
|
||||
})
|
||||
|
||||
it('clamps out-of-range seconds', () => {
|
||||
expect(secondToTurntableFrame(-1)).toBe(0)
|
||||
expect(secondToTurntableFrame(10)).toBe(TOTAL_TURNTABLE_FRAMES - 1)
|
||||
})
|
||||
})
|
||||
|
||||
describe('secondToDegree', () => {
|
||||
it('converts seconds to turntable degrees (0, 15, ..., 345)', () => {
|
||||
expect(secondToDegree(0)).toBe(0)
|
||||
expect(secondToDegree(1 / TURNTABLE_FPS)).toBe(15)
|
||||
expect(secondToDegree(0.5)).toBe(45)
|
||||
expect(secondToDegree(2.0)).toBe(180)
|
||||
expect(secondToDegree(3.9)).toBe(345)
|
||||
})
|
||||
})
|
||||
|
||||
describe('degreeToTurntableFrame', () => {
|
||||
it('converts discrete degrees to frame indices', () => {
|
||||
expect(degreeToTurntableFrame(0)).toBe(0)
|
||||
expect(degreeToTurntableFrame(15)).toBe(1)
|
||||
expect(degreeToTurntableFrame(45)).toBe(3)
|
||||
expect(degreeToTurntableFrame(90)).toBe(6)
|
||||
expect(degreeToTurntableFrame(180)).toBe(12)
|
||||
expect(degreeToTurntableFrame(345)).toBe(23)
|
||||
})
|
||||
|
||||
it('normalizes degrees outside [0, 360)', () => {
|
||||
expect(degreeToTurntableFrame(360)).toBe(0)
|
||||
expect(degreeToTurntableFrame(-15)).toBe(23)
|
||||
expect(degreeToTurntableFrame(720)).toBe(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe('calculateTurntableFrameCenterTime and degreeToSecond', () => {
|
||||
it('calculates frame center times within bounds', () => {
|
||||
const centerTime0 = calculateTurntableFrameCenterTime(0)
|
||||
expect(centerTime0).toBeCloseTo(0.5 / TURNTABLE_FPS)
|
||||
|
||||
const centerTime23 = calculateTurntableFrameCenterTime(23)
|
||||
expect(centerTime23).toBeLessThan(TOTAL_TURNTABLE_FRAMES / TURNTABLE_FPS)
|
||||
expect(centerTime23).toBeGreaterThan(23 / TURNTABLE_FPS)
|
||||
|
||||
expect(degreeToSecond(0)).toBeCloseTo(centerTime0)
|
||||
expect(degreeToSecond(45)).toBeCloseTo((3 + 0.5) / TURNTABLE_FPS)
|
||||
expect(degreeToSecond(345)).toBeCloseTo(centerTime23)
|
||||
})
|
||||
})
|
||||
|
||||
describe('isValidTurntableDegree', () => {
|
||||
it('returns true for integer multiples of 15 from 0 to 345', () => {
|
||||
for (let deg = 0; deg < 360; deg += 15) {
|
||||
expect(isValidTurntableDegree(deg)).toBe(true)
|
||||
}
|
||||
})
|
||||
|
||||
it('returns false for non-multiples of 15', () => {
|
||||
expect(isValidTurntableDegree(10)).toBe(false)
|
||||
expect(isValidTurntableDegree(44)).toBe(false)
|
||||
expect(isValidTurntableDegree(45.5)).toBe(false)
|
||||
})
|
||||
|
||||
it('returns false for out of range or negative degrees', () => {
|
||||
expect(isValidTurntableDegree(-15)).toBe(false)
|
||||
expect(isValidTurntableDegree(360)).toBe(false)
|
||||
expect(isValidTurntableDegree(720)).toBe(false)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,58 @@
|
||||
export const TOTAL_TURNTABLE_FRAMES = 24
|
||||
export const TURNTABLE_FPS = 6
|
||||
export const TURNTABLE_FRAME_DURATION = 1 / TURNTABLE_FPS
|
||||
|
||||
/**
|
||||
* Converts a playback second into a turntable frame index (0..23), clamped.
|
||||
*/
|
||||
export function secondToTurntableFrame(second: number): number {
|
||||
return Math.min(
|
||||
Math.max(0, Math.floor(second * TURNTABLE_FPS + 1e-4)),
|
||||
TOTAL_TURNTABLE_FRAMES - 1,
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a turntable playback second to turntable degree (0, 15, 30, ..., 345).
|
||||
*/
|
||||
export function secondToDegree(second: number): number {
|
||||
const frameIndex = secondToTurntableFrame(second)
|
||||
return (frameIndex * 15) % 360
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the presentation time within a turntable frame.
|
||||
* Seeking near frame center avoids PTS boundary inaccuracies in video decoders.
|
||||
*/
|
||||
export function calculateTurntableFrameCenterTime(frameIndex: number): number {
|
||||
const normalizedFrame =
|
||||
((frameIndex % TOTAL_TURNTABLE_FRAMES) + TOTAL_TURNTABLE_FRAMES) % TOTAL_TURNTABLE_FRAMES
|
||||
if (normalizedFrame === TOTAL_TURNTABLE_FRAMES - 1) {
|
||||
return normalizedFrame * TURNTABLE_FRAME_DURATION + TURNTABLE_FRAME_DURATION * 0.25
|
||||
}
|
||||
return (normalizedFrame + 0.5) * TURNTABLE_FRAME_DURATION
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a rotation degree (0..345) to a turntable frame index (0..23).
|
||||
*/
|
||||
export function degreeToTurntableFrame(degree: number): number {
|
||||
const normalizedDegree = ((Math.round(degree) % 360) + 360) % 360
|
||||
return Math.round(normalizedDegree / 15) % TOTAL_TURNTABLE_FRAMES
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a rotation degree into a turntable video playback second (center time of that frame).
|
||||
*/
|
||||
export function degreeToSecond(degree: number): number {
|
||||
const frameIndex = degreeToTurntableFrame(degree)
|
||||
return calculateTurntableFrameCenterTime(frameIndex)
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates whether a degree is a valid discrete turntable angle:
|
||||
* integer multiple of 15 between 0 and 345 inclusive (0, 15, 30, ..., 345).
|
||||
*/
|
||||
export function isValidTurntableDegree(degree: number): boolean {
|
||||
return Number.isInteger(degree) && degree >= 0 && degree <= 345 && degree % 15 === 0
|
||||
}
|
||||
@@ -258,6 +258,57 @@ describe('WatermarkService', () => {
|
||||
expect(mediaIds).toContain(mediaFile.id)
|
||||
})
|
||||
|
||||
it('should include 3D assets with turntable video in getMediaAssetIdsInShareLink', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: '3D User', email: '3d-wm@example.com' },
|
||||
})
|
||||
const team = await teamService.createTeam(user, { name: '3D Team' })
|
||||
|
||||
const projectFolder = await prisma.asset.create({
|
||||
data: { name: 'root', type: 'root', status: 'processed' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: '3D Project', teamId: team.id, rootFolderId: projectFolder.id },
|
||||
})
|
||||
|
||||
const shareLink = await shareService.createShareLink(project.id, { name: '3D Share' }, user.id)
|
||||
|
||||
const modelAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
mediaType: 'model/gltf-binary',
|
||||
status: 'processed',
|
||||
projectId: project.id,
|
||||
media: {
|
||||
duration: 4,
|
||||
filesize: 100,
|
||||
frames: 24,
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [
|
||||
{ key: 'files/asset-3d/turntable.mp4', width: 1080, height: 1080, resolution: '1080p' },
|
||||
],
|
||||
finishedAt: new Date().toISOString(),
|
||||
original: { key: 'files/asset-3d/robot.glb', filesizeInBytes: 100, codec: '' },
|
||||
} as PrismaJson.MediaInfo,
|
||||
},
|
||||
})
|
||||
|
||||
await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'symlink',
|
||||
status: 'processed',
|
||||
projectId: project.id,
|
||||
parentId: shareLink.rootFolderId,
|
||||
targetId: modelAsset.id,
|
||||
},
|
||||
})
|
||||
|
||||
const mediaIds = await watermarkService.getMediaAssetIdsInShareLink(shareLink.rootFolderId)
|
||||
expect(mediaIds).toContain(modelAsset.id)
|
||||
})
|
||||
|
||||
describe('purgeOrphanWatermarkConfigs', () => {
|
||||
const bucket = 'shumai-gc-test-bucket'
|
||||
|
||||
|
||||
@@ -23,6 +23,7 @@ import {
|
||||
} from '@shumai/core/src/share/errors'
|
||||
import { shareService } from '@shumai/core/src/share/share'
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
import { is3dModel } from '@shumai/core/src/utils/mime'
|
||||
|
||||
// Union of the global client and interactive-transaction client, which share the
|
||||
// same delegate shapes for the models used by this service.
|
||||
@@ -319,8 +320,9 @@ export class WatermarkService {
|
||||
const proxyType = mediaInfo?.proxyType
|
||||
const isVideo = proxyType === 'video' || asset.mediaType?.startsWith('video/')
|
||||
const isImage = proxyType === 'image' || asset.mediaType?.startsWith('image/')
|
||||
const is3d = proxyType === '3d' || is3dModel(asset.mediaType)
|
||||
|
||||
if (isVideo || isImage) {
|
||||
if (isVideo || isImage || is3d) {
|
||||
mediaAssetIds.push(asset.id)
|
||||
}
|
||||
} else if (asset.type === 'folder' || asset.type === 'version_stack') {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/db",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
-- AlterEnum
|
||||
ALTER TYPE "WorkflowTaskType" ADD VALUE 'transcode_3d';
|
||||
@@ -121,6 +121,7 @@ enum WorkflowTaskType {
|
||||
transcode_screenshot
|
||||
transcode_image_annotation
|
||||
transcode_watermark
|
||||
transcode_3d
|
||||
ai_metadata_autofill
|
||||
chat
|
||||
ai_embedding
|
||||
|
||||
+1
@@ -150,6 +150,7 @@ export const WorkflowTaskType = {
|
||||
transcode_screenshot: 'transcode_screenshot',
|
||||
transcode_image_annotation: 'transcode_image_annotation',
|
||||
transcode_watermark: 'transcode_watermark',
|
||||
transcode_3d: 'transcode_3d',
|
||||
ai_metadata_autofill: 'ai_metadata_autofill',
|
||||
chat: 'chat',
|
||||
ai_embedding: 'ai_embedding',
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -103,8 +103,22 @@ declare global {
|
||||
replyTo?: string
|
||||
}
|
||||
|
||||
export interface TurntableSettings {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
}
|
||||
|
||||
export interface GotenbergSettings {
|
||||
url?: string
|
||||
username?: string
|
||||
password?: string
|
||||
}
|
||||
|
||||
export interface Settings {
|
||||
transcode?: TranscodeSettings
|
||||
turntable?: TurntableSettings
|
||||
gotenberg?: GotenbergSettings
|
||||
mediaGeneration?: MediaGenerationSettings
|
||||
appearance?: AppearanceSettings
|
||||
emailNotification?: EmailNotificationSettings
|
||||
@@ -196,7 +210,7 @@ declare global {
|
||||
duration: number
|
||||
filesize: number
|
||||
frames: number
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf'
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | '3d'
|
||||
imageTranscodes: ImageTranscode[]
|
||||
videoTranscodes: VideoTranscode[]
|
||||
videoPreview?: VideoTranscode
|
||||
@@ -530,7 +544,7 @@ declare global {
|
||||
key: string
|
||||
sizeByte: number
|
||||
contentType?: string | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | '3d' | null
|
||||
}
|
||||
export type KanbanCommentAttachmentList = KanbanCommentAttachment[]
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/dtos",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -14,7 +14,7 @@ export const assetInfoPaginatedListSchema = z.object({
|
||||
export type AssetInfoPaginatedList = z.infer<typeof assetInfoPaginatedListSchema>
|
||||
|
||||
export const previewInfoSchema = z.object({
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
thumbnailUrl: z.string().optional(),
|
||||
originalHeight: z.number().optional(),
|
||||
originalWidth: z.number().optional(),
|
||||
@@ -76,7 +76,7 @@ export const assetInfoSchema = z.object({
|
||||
type: z.string(),
|
||||
targetType: z.string().optional().nullable(),
|
||||
status: z.string(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
latestChildren: z.array(childPreviewSchema).optional(),
|
||||
preview: previewInfoSchema.nullable().optional(),
|
||||
createdAt: z.string(),
|
||||
@@ -143,7 +143,7 @@ export const assetInfoSchema = z.object({
|
||||
.optional(),
|
||||
})
|
||||
.optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
metadata: mediaMetadataSchema.optional(),
|
||||
error: z.string().optional(),
|
||||
})
|
||||
@@ -233,7 +233,7 @@ export const attachmentInfoSchema = z.object({
|
||||
id: z.string(),
|
||||
assetId: z.string(),
|
||||
url: z.string(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
})
|
||||
export type AttachmentInfo = z.infer<typeof attachmentInfoSchema>
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ export const shumaiAssetContextSchema = z.object({
|
||||
id: z.string(),
|
||||
name: z.string(),
|
||||
type: z.string(),
|
||||
mediaType: z.enum(['image', 'video', 'pdf', 'audio', 'other']).optional(),
|
||||
mediaType: z.enum(['image', 'video', 'pdf', 'audio', '3d', 'other']).optional(),
|
||||
mimeType: z.string().optional(),
|
||||
parentId: z.string().optional(),
|
||||
path: z.string().optional(),
|
||||
@@ -64,7 +64,7 @@ export const shumaiAttachedFileContextSchema = z.object({
|
||||
id: z.string(),
|
||||
name: z.string(),
|
||||
type: z.string(),
|
||||
mediaType: z.enum(['image', 'video', 'pdf', 'audio', 'other']).optional(),
|
||||
mediaType: z.enum(['image', 'video', 'pdf', 'audio', '3d', 'other']).optional(),
|
||||
mimeType: z.string().optional(),
|
||||
path: z.string().optional(),
|
||||
url: z.string().optional(),
|
||||
@@ -75,6 +75,7 @@ export type ShumaiAttachedFileContext = z.infer<typeof shumaiAttachedFileContext
|
||||
export const shumaiMediaPositionSchema = z.discriminatedUnion('type', [
|
||||
z.object({ type: z.literal('time'), seconds: z.number() }),
|
||||
z.object({ type: z.literal('page'), page: z.number() }),
|
||||
z.object({ type: z.literal('degree'), degree: z.number().int() }),
|
||||
])
|
||||
|
||||
export type ShumaiMediaPosition = z.infer<typeof shumaiMediaPositionSchema>
|
||||
|
||||
@@ -104,6 +104,8 @@ export function serializeContextToXml(context?: ShumaiMessageContext | null): st
|
||||
lines.push(` <position type="time" seconds="${context.position.seconds.toFixed(4)}" />`)
|
||||
} else if (context.position.type === 'page') {
|
||||
lines.push(` <position type="page" page="${Math.round(context.position.page)}" />`)
|
||||
} else if (context.position.type === 'degree') {
|
||||
lines.push(` <position type="degree" degree="${Math.round(context.position.degree)}" />`)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ export const kanbanAttachmentPayloadSchema = z.object({
|
||||
key: z.string(),
|
||||
sizeByte: z.number(),
|
||||
contentType: z.string().nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
})
|
||||
export type KanbanAttachmentPayload = z.infer<typeof kanbanAttachmentPayloadSchema>
|
||||
|
||||
@@ -17,7 +17,7 @@ export const kanbanAttachmentInfoSchema = z.object({
|
||||
sizeByte: z.number(),
|
||||
contentType: z.string().nullable().optional(),
|
||||
url: z.string(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
})
|
||||
export type KanbanAttachmentInfo = z.infer<typeof kanbanAttachmentInfoSchema>
|
||||
|
||||
@@ -28,7 +28,7 @@ export const postKanbanAttachmentResponseSchema = z.object({
|
||||
sizeByte: z.number(),
|
||||
contentType: z.string().nullable().optional(),
|
||||
uploadUrl: z.string(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
})
|
||||
export type PostKanbanAttachmentResponse = z.infer<typeof postKanbanAttachmentResponseSchema>
|
||||
|
||||
|
||||
@@ -92,7 +92,7 @@ export const kanbanTaskAssetInfoSchema = z.object({
|
||||
id: z.string(),
|
||||
name: z.string(),
|
||||
type: z.string(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
thumbnailUrl: z.string().nullable().optional(),
|
||||
path: z.string(),
|
||||
creator: kanbanUserInfoSchema.nullable().optional(),
|
||||
|
||||
@@ -18,7 +18,7 @@ export type EntityInfo = z.infer<typeof entityInfoSchema>
|
||||
|
||||
export const assetPreviewSchema = z.object({
|
||||
id: z.string().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf']).nullable().optional(),
|
||||
proxyType: z.enum(['image', 'video', 'audio', 'pdf', '3d']).nullable().optional(),
|
||||
name: z.string().optional(),
|
||||
preview: z.string().optional(),
|
||||
thumbnailUrl: z.string().optional(),
|
||||
|
||||
@@ -142,6 +142,36 @@ export const updateTeamSettingsRequestSchema = z.union([
|
||||
])
|
||||
export type UpdateTeamSettingsRequest = z.infer<typeof updateTeamSettingsRequestSchema>
|
||||
|
||||
export const turntableSettingsResponseSchema = z.object({
|
||||
url: z.string().optional(),
|
||||
username: z.string().optional(),
|
||||
hasPassword: z.boolean(),
|
||||
isEnvConfigured: z.boolean(),
|
||||
})
|
||||
export type TurntableSettingsResponse = z.infer<typeof turntableSettingsResponseSchema>
|
||||
|
||||
export const updateTurntableSettingsRequestSchema = z.object({
|
||||
url: z.string().optional(),
|
||||
username: z.string().optional(),
|
||||
password: z.string().optional(),
|
||||
})
|
||||
export type UpdateTurntableSettingsRequest = z.infer<typeof updateTurntableSettingsRequestSchema>
|
||||
|
||||
export const gotenbergSettingsResponseSchema = z.object({
|
||||
url: z.string().optional(),
|
||||
username: z.string().optional(),
|
||||
hasPassword: z.boolean(),
|
||||
isEnvConfigured: z.boolean(),
|
||||
})
|
||||
export type GotenbergSettingsResponse = z.infer<typeof gotenbergSettingsResponseSchema>
|
||||
|
||||
export const updateGotenbergSettingsRequestSchema = z.object({
|
||||
url: z.string().optional(),
|
||||
username: z.string().optional(),
|
||||
password: z.string().optional(),
|
||||
})
|
||||
export type UpdateGotenbergSettingsRequest = z.infer<typeof updateGotenbergSettingsRequestSchema>
|
||||
|
||||
export interface TeamAppearanceSettings {
|
||||
hideAgent?: boolean
|
||||
}
|
||||
@@ -155,6 +185,8 @@ export interface TeamSettingsResponse {
|
||||
hlsEnabled?: boolean
|
||||
hlsResolutions?: HlsResolutionLadder[]
|
||||
}
|
||||
turntable?: TurntableSettingsResponse
|
||||
gotenberg?: GotenbergSettingsResponse
|
||||
appearance?: TeamAppearanceSettings
|
||||
semanticSearchEnabled?: boolean
|
||||
[key: string]: unknown
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/e2e",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest'
|
||||
import { prisma, AssetStatus } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { workflowService, TaskQueueTranscode } from '@shumai/workflow-core'
|
||||
import { initTranscodeWorkflows } from '@shumai/transcode'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { fileURLToPath } from 'url'
|
||||
import * as path from 'path'
|
||||
import * as fs from 'fs'
|
||||
|
||||
const currentDir = path.dirname(fileURLToPath(import.meta.url))
|
||||
const transcodeWorkflowsPath = path.resolve(currentDir, '../../../apps/transcode/src/workflows.ts')
|
||||
const fixturesDir = path.resolve(currentDir, '../fixtures')
|
||||
|
||||
describe.each(['local', 'temporal'] as const)(
|
||||
'Workflow E2E - 3D Asset Transcode (executor: %s)',
|
||||
(mode) => {
|
||||
setupTestDbHooks()
|
||||
|
||||
let transcodeWorkerPromise: Promise<void> | null = null
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
let mockTurntableServer: any = null
|
||||
|
||||
beforeAll(async () => {
|
||||
process.env.S3_BUCKET = 'shumai-e2e-test-bucket-3d'
|
||||
|
||||
const smallPngBuffer = fs.readFileSync(path.join(fixturesDir, 'small.png'))
|
||||
const smallMp4Buffer = fs.readFileSync(path.join(fixturesDir, 'small.mp4'))
|
||||
|
||||
mockTurntableServer = Bun.serve({
|
||||
port: 0,
|
||||
fetch(req) {
|
||||
const url = new URL(req.url)
|
||||
if (url.pathname === '/version') {
|
||||
return Response.json({ version: '1.0.0', runtime: 'bun', blender: '5.2.0' })
|
||||
}
|
||||
if (url.pathname === '/v1/files' && req.method === 'POST') {
|
||||
return Response.json({ id: 'f_input3d', name: 'model.glb', size: 100 }, { status: 201 })
|
||||
}
|
||||
if (url.pathname === '/v1/render' && req.method === 'POST') {
|
||||
return Response.json(
|
||||
{
|
||||
taskId: 't_render3d',
|
||||
status: 'completed',
|
||||
poster: {
|
||||
fileId: 'f_poster3d',
|
||||
size: smallPngBuffer.length,
|
||||
contentType: 'image/png',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
metadata: { format: 'glb' },
|
||||
},
|
||||
{ status: 201 },
|
||||
)
|
||||
}
|
||||
if (url.pathname === '/v1/render/tasks/t_render3d') {
|
||||
if (req.method === 'DELETE') {
|
||||
return Response.json({ ok: true })
|
||||
}
|
||||
return Response.json({
|
||||
taskId: 't_render3d',
|
||||
status: 'completed',
|
||||
posterFileId: 'f_poster3d',
|
||||
video: {
|
||||
fileId: 'f_video3d',
|
||||
size: smallMp4Buffer.length,
|
||||
contentType: 'video/mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
},
|
||||
})
|
||||
}
|
||||
if (url.pathname === '/v1/files/f_poster3d') {
|
||||
return new Response(smallPngBuffer, {
|
||||
headers: { 'Content-Type': 'image/png' },
|
||||
})
|
||||
}
|
||||
if (url.pathname === '/v1/files/f_video3d') {
|
||||
return new Response(smallMp4Buffer, {
|
||||
headers: { 'Content-Type': 'video/mp4' },
|
||||
})
|
||||
}
|
||||
return new Response('Not Found', { status: 404 })
|
||||
},
|
||||
})
|
||||
|
||||
process.env.TURNTABLE_RENDERER_URL = `http://localhost:${mockTurntableServer.port}`
|
||||
|
||||
workflowService.setExecutorType(mode)
|
||||
initTranscodeWorkflows()
|
||||
|
||||
if (mode === 'temporal') {
|
||||
console.log('Starting background worker for transcode Temporal E2E tests...')
|
||||
transcodeWorkerPromise = workflowService.startWorkers(TaskQueueTranscode, {
|
||||
workflowsPath: transcodeWorkflowsPath,
|
||||
})
|
||||
await new Promise((resolve) => setTimeout(resolve, 2000))
|
||||
} else {
|
||||
console.log('Starting local workflow service polling...')
|
||||
workflowService.start()
|
||||
}
|
||||
}, 120000)
|
||||
|
||||
afterAll(async () => {
|
||||
if (mode === 'temporal') {
|
||||
console.log('Shutting down Temporal workers...')
|
||||
await workflowService.shutdownWorkers()
|
||||
await Promise.all([transcodeWorkerPromise].filter(Boolean))
|
||||
}
|
||||
workflowService.close()
|
||||
vi.restoreAllMocks()
|
||||
|
||||
if (mockTurntableServer) {
|
||||
mockTurntableServer.stop()
|
||||
}
|
||||
|
||||
delete process.env.TURNTABLE_RENDERER_URL
|
||||
|
||||
try {
|
||||
console.log('Cleaning up E2E storage files...')
|
||||
await s3Service.deletePrefix('shumai-e2e-test-bucket-3d', '')
|
||||
} catch (err) {
|
||||
console.error('Failed to clean up E2E storage folder:', err)
|
||||
}
|
||||
}, 120000)
|
||||
|
||||
it('should process 3D model transcode workflow task', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'E2E 3D Transcode Team' },
|
||||
})
|
||||
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'E2E 3D Transcode Project', teamId: team.id },
|
||||
})
|
||||
|
||||
const storageKey = await prisma.storageKey.create({
|
||||
data: {
|
||||
key: 'projects/e2e/model.glb',
|
||||
status: 'active',
|
||||
},
|
||||
})
|
||||
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'model.glb',
|
||||
type: 'file',
|
||||
status: 'uploaded',
|
||||
mediaType: 'model/gltf-binary',
|
||||
projectId: project.id,
|
||||
storageKeyId: storageKey.id,
|
||||
},
|
||||
})
|
||||
|
||||
const dummyGlbBuffer = Buffer.from('dummy glb content')
|
||||
await s3Service.putObject(
|
||||
'shumai-e2e-test-bucket-3d',
|
||||
'projects/e2e/model.glb',
|
||||
dummyGlbBuffer,
|
||||
dummyGlbBuffer.length,
|
||||
'model/gltf-binary',
|
||||
)
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'transcode_3d',
|
||||
status: 'pending',
|
||||
assetId: asset.id,
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
payload: {
|
||||
projectId: project.id,
|
||||
transcode: {
|
||||
poster: true,
|
||||
sprite: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
console.log(
|
||||
`Submitted E2E 3D Transcode Workflow Task. ID: ${task.id}. Awaiting completion...`,
|
||||
)
|
||||
const completedTask = await workflowService.executeWait(task, 60000)
|
||||
|
||||
expect(completedTask.status).toBe('completed')
|
||||
|
||||
const updatedAsset = await prisma.asset.findUnique({
|
||||
where: { id: asset.id },
|
||||
})
|
||||
expect(updatedAsset?.status).toBe(AssetStatus.processed)
|
||||
|
||||
const mediaInfo = updatedAsset?.media as unknown as {
|
||||
proxyType?: string
|
||||
videoPreview?: { key: string }
|
||||
poster?: { key: string }
|
||||
sprite?: { key: string }
|
||||
}
|
||||
expect(mediaInfo).toBeDefined()
|
||||
expect(mediaInfo.proxyType).toBe('3d')
|
||||
expect(mediaInfo.videoPreview?.key).toBe('projects/e2e/turntable.mp4')
|
||||
expect(mediaInfo.poster?.key).toBe('projects/e2e/poster.webp')
|
||||
expect(mediaInfo.sprite?.key).toBe('projects/e2e/sprite.webp')
|
||||
}, 90000)
|
||||
},
|
||||
)
|
||||
@@ -295,5 +295,85 @@ describe.each(['local', 'temporal'] as const)(
|
||||
expect(mediaInfo.imageTranscodes.length).toBeGreaterThan(0)
|
||||
expect(mediaInfo.thumbnail).toBeDefined()
|
||||
}, 50000)
|
||||
|
||||
it('should transcode a rotated camera photo upright', async () => {
|
||||
// 1. Seed Database
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'E2E Rotated Transcode Team' },
|
||||
})
|
||||
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'E2E Rotated Transcode Project', teamId: team.id },
|
||||
})
|
||||
|
||||
const storageKey = await prisma.storageKey.create({
|
||||
data: {
|
||||
key: 'projects/e2e/portrait-rotated.jpg',
|
||||
},
|
||||
})
|
||||
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'portrait-rotated.jpg',
|
||||
type: 'file',
|
||||
status: 'uploaded',
|
||||
mediaType: 'image/jpeg',
|
||||
projectId: project.id,
|
||||
storageKeyId: storageKey.id,
|
||||
},
|
||||
})
|
||||
|
||||
// 2. Seed S3 Storage from fixture portrait-rotated.jpg: stored 600x400 with EXIF
|
||||
// orientation 6, the way cameras save portrait shots, so it is displayed 400x600.
|
||||
const jpgPath = path.join(fixturesDir, 'portrait-rotated.jpg')
|
||||
const jpgBuffer = fs.readFileSync(jpgPath)
|
||||
await s3Service.putObject(
|
||||
'shumai-e2e-test-bucket-transcode',
|
||||
'projects/e2e/portrait-rotated.jpg',
|
||||
jpgBuffer,
|
||||
jpgBuffer.length,
|
||||
'image/jpeg',
|
||||
)
|
||||
|
||||
// 3. Create Workflow Task
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'transcode_image',
|
||||
status: 'pending',
|
||||
assetId: asset.id,
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
payload: {
|
||||
projectId: project.id,
|
||||
transcode: {
|
||||
thumbnail: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
// 4. Wait for workflow to complete
|
||||
console.log(
|
||||
`Submitted E2E Rotated Image Transcode Workflow Task. ID: ${task.id}. Awaiting completion...`,
|
||||
)
|
||||
const completedTask = await workflowService.executeWait(task, 45000)
|
||||
|
||||
// 5. Verification: the asset and its transcode are portrait, not the stored landscape.
|
||||
expect(completedTask.status).toBe('completed')
|
||||
|
||||
const updatedAsset = await prisma.asset.findUnique({
|
||||
where: { id: asset.id },
|
||||
})
|
||||
expect(updatedAsset?.status).toBe(AssetStatus.processed)
|
||||
|
||||
const mediaInfo = updatedAsset?.media as unknown as {
|
||||
imageTranscodes: Array<{ width: number; height: number }>
|
||||
metadata: { originalWidth: number; originalHeight: number }
|
||||
}
|
||||
expect(mediaInfo.metadata.originalWidth).toBe(400)
|
||||
expect(mediaInfo.metadata.originalHeight).toBe(600)
|
||||
expect(mediaInfo.imageTranscodes[0].width).toBe(400)
|
||||
expect(mediaInfo.imageTranscodes[0].height).toBe(600)
|
||||
}, 50000)
|
||||
},
|
||||
)
|
||||
|
||||
@@ -312,6 +312,128 @@ describe.each(['local', 'temporal'] as const)(
|
||||
expect(mediaInfo?.videoTranscodes?.[0].resolution).toBe('360p')
|
||||
})
|
||||
|
||||
it('should generate watermark proxy for a 3d asset from turntable video and update sharelink status to ready', async () => {
|
||||
// 1. Seed Database
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'E2E Watermark 3D Team' },
|
||||
})
|
||||
const projectFolder = await prisma.asset.create({
|
||||
data: { name: 'root', type: 'root', status: 'processed' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: {
|
||||
name: 'E2E Watermark 3D Project',
|
||||
teamId: team.id,
|
||||
rootFolderId: projectFolder.id,
|
||||
},
|
||||
})
|
||||
|
||||
const storageKey = await prisma.storageKey.create({
|
||||
data: { key: 'files/e2e-watermark-3d/model.glb' },
|
||||
})
|
||||
|
||||
const turntableKey = 'files/e2e-watermark-3d/turntable.mp4'
|
||||
const videoPath = path.join(fixturesDir, 'small.mp4')
|
||||
const videoBuffer = fs.readFileSync(videoPath)
|
||||
await s3Service.putObject(
|
||||
'shumai-e2e-test-bucket-watermark',
|
||||
turntableKey,
|
||||
videoBuffer,
|
||||
videoBuffer.length,
|
||||
'video/mp4',
|
||||
)
|
||||
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'model.glb',
|
||||
type: 'file',
|
||||
mediaType: 'model/gltf-binary',
|
||||
status: 'processed',
|
||||
projectId: project.id,
|
||||
storageKeyId: storageKey.id,
|
||||
media: {
|
||||
duration: 1,
|
||||
filesize: videoBuffer.length,
|
||||
frames: 30,
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [],
|
||||
videoTranscodes: [{ key: turntableKey, width: 640, height: 360, resolution: '360p' }],
|
||||
videoPreview: { key: turntableKey, width: 640, height: 360, resolution: '360p' },
|
||||
poster: { key: 'files/e2e-watermark-3d/poster.webp' },
|
||||
finishedAt: new Date().toISOString(),
|
||||
metadata: {
|
||||
originalWidth: 640,
|
||||
originalHeight: 360,
|
||||
duration: 1,
|
||||
bitRate: 0,
|
||||
frameRate: 30,
|
||||
totalFrames: 30,
|
||||
startTimecode: '00:00:00:00',
|
||||
hasAudio: false,
|
||||
format: {},
|
||||
},
|
||||
original: {
|
||||
key: storageKey.key,
|
||||
filesizeInBytes: 100,
|
||||
codec: '',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const shareLink = await shareService.createShareLink(project.id, {
|
||||
name: 'Public Watermarked 3D Share',
|
||||
})
|
||||
await shareService.addAssetToShare(shareLink.id, { assetIds: [asset.id] })
|
||||
|
||||
const watermarkConfig: WatermarkConfigSpec = {
|
||||
blocks: [
|
||||
{
|
||||
id: 'b1',
|
||||
type: 'text',
|
||||
x: 0.5,
|
||||
y: 0.5,
|
||||
opacity: 0.5,
|
||||
rotation: 0,
|
||||
text: 'CONFIDENTIAL 3D',
|
||||
size: 0.2,
|
||||
color: '#FF0000',
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
const updatedShare = await watermarkService.updateShareLinkWatermark(
|
||||
shareLink.id,
|
||||
true,
|
||||
watermarkConfig,
|
||||
)
|
||||
expect(updatedShare.watermarkStatus).toBe('processing')
|
||||
|
||||
let share = await shareService.getShareLink(shareLink.id)
|
||||
const startTime = Date.now()
|
||||
while (share.watermarkStatus === 'processing' && Date.now() - startTime < 60000) {
|
||||
await new Promise((resolve) => setTimeout(resolve, 500))
|
||||
share = await shareService.getShareLink(shareLink.id)
|
||||
}
|
||||
expect(share.watermarkStatus).toBe('ready')
|
||||
|
||||
const wf = await prisma.watermarkFile.findUnique({
|
||||
where: {
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
assetId_watermarkConfigId: {
|
||||
assetId: asset.id,
|
||||
watermarkConfigId: updatedShare.watermarkConfigId!,
|
||||
},
|
||||
},
|
||||
})
|
||||
expect(wf).toBeDefined()
|
||||
expect(wf?.status).toBe(WatermarkFileStatus.completed)
|
||||
const media = wf?.media as PrismaJson.MediaInfo
|
||||
expect(media.proxyType).toBe('3d')
|
||||
expect(media.videoTranscodes?.length).toBeGreaterThan(0)
|
||||
expect(media.videoPreview?.key).toBe(media.videoTranscodes?.[0]?.key)
|
||||
})
|
||||
|
||||
it('should watermark a newly added asset after the sharelink is already ready', async () => {
|
||||
// 1. Seed Database
|
||||
const team = await prisma.team.create({
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/tableprinter",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/transcode",
|
||||
"version": "0.5.1",
|
||||
"version": "0.5.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
|
||||
@@ -0,0 +1,355 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import {
|
||||
render3dModelActivity,
|
||||
start3dRenderActivity,
|
||||
waitFor3dVideoRenderActivity,
|
||||
generate3dSpriteActivity,
|
||||
generate3dViewsActivity,
|
||||
} from './transcode'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { transcodeService } from '@shumai/core/src/transcode/transcode'
|
||||
import * as fs from 'fs'
|
||||
|
||||
vi.mock('@shumai/core/src/turntable/turntable', () => ({
|
||||
turntableService: {
|
||||
uploadFile: vi.fn(),
|
||||
startRender: vi.fn(),
|
||||
getTaskStatus: vi.fn(),
|
||||
downloadFile: vi.fn(),
|
||||
deleteTask: vi.fn(),
|
||||
deleteFile: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
putObject: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/transcode/transcode', () => ({
|
||||
transcodeService: {
|
||||
convertImageToWebp: vi.fn(),
|
||||
generate3dSprite: vi.fn(),
|
||||
generate3dViews: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
isAssetPurging: vi.fn().mockResolvedValue(false),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('fs', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('fs')>()
|
||||
return {
|
||||
...actual,
|
||||
readFileSync: vi.fn(),
|
||||
writeFileSync: vi.fn(),
|
||||
}
|
||||
})
|
||||
|
||||
describe('3D Transcode Activities', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(Buffer.from('mock-bytes'))
|
||||
vi.mocked(transcodeService.convertImageToWebp).mockResolvedValue(Buffer.from('webp-bytes'))
|
||||
vi.mocked(transcodeService.generate3dSprite).mockResolvedValue()
|
||||
vi.mocked(transcodeService.generate3dViews).mockResolvedValue()
|
||||
vi.mocked(s3Service.putObject).mockResolvedValue({} as never)
|
||||
vi.mocked(turntableService.deleteTask).mockResolvedValue(true)
|
||||
})
|
||||
|
||||
describe('start3dRenderActivity', () => {
|
||||
it('uploads file, starts render, immediately downloads and uploads poster to S3', async () => {
|
||||
vi.mocked(turntableService.uploadFile).mockResolvedValue({
|
||||
id: 'f_input',
|
||||
name: 'model.glb',
|
||||
size: 1024,
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.startRender).mockResolvedValue({
|
||||
taskId: 'task_render_1',
|
||||
status: 'queued',
|
||||
poster: {
|
||||
fileId: 'f_poster',
|
||||
contentType: 'image/png',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
size: 5000,
|
||||
},
|
||||
metadata: { format: 'glb', vertices: 120 },
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.downloadFile).mockResolvedValue(Buffer.from('poster-raw-data'))
|
||||
|
||||
const res = await start3dRenderActivity({
|
||||
taskId: 'wf-task-1',
|
||||
teamId: 'team-1',
|
||||
assetId: 'asset-1',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
filePath: '/tmp/model.glb',
|
||||
filename: 'model.glb',
|
||||
targetPosterKey: 'files/asset-1/poster.webp',
|
||||
})
|
||||
|
||||
expect(turntableService.uploadFile).toHaveBeenCalledWith(
|
||||
'/tmp/model.glb',
|
||||
'model.glb',
|
||||
'team-1',
|
||||
)
|
||||
expect(turntableService.startRender).toHaveBeenCalledWith('f_input', {}, 'team-1')
|
||||
expect(turntableService.downloadFile).toHaveBeenCalledWith('f_poster', undefined, 'team-1')
|
||||
expect(transcodeService.convertImageToWebp).toHaveBeenCalledWith(
|
||||
Buffer.from('poster-raw-data'),
|
||||
)
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/poster.webp',
|
||||
Buffer.from('webp-bytes'),
|
||||
Buffer.from('webp-bytes').length,
|
||||
'image/webp',
|
||||
)
|
||||
|
||||
expect(res.renderTaskId).toBe('task_render_1')
|
||||
expect(res.posterFilePath).toBe('/tmp/poster.webp')
|
||||
expect(res.posterWidth).toBe(1080)
|
||||
expect(res.posterHeight).toBe(1080)
|
||||
expect(res.modelMetadata).toEqual({ format: 'glb', vertices: 120 })
|
||||
})
|
||||
|
||||
it('throws ApplicationFailure when poster file ID is missing', async () => {
|
||||
vi.mocked(turntableService.uploadFile).mockResolvedValue({
|
||||
id: 'f_input',
|
||||
name: 'model.glb',
|
||||
size: 1024,
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.startRender).mockResolvedValue({
|
||||
taskId: 'task_render_1',
|
||||
status: 'queued',
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
poster: undefined as any,
|
||||
})
|
||||
|
||||
await expect(
|
||||
start3dRenderActivity({
|
||||
taskId: 'wf-task-1',
|
||||
teamId: 'team-1',
|
||||
assetId: 'asset-1',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
filePath: '/tmp/model.glb',
|
||||
filename: 'model.glb',
|
||||
targetPosterKey: 'files/asset-1/poster.webp',
|
||||
}),
|
||||
).rejects.toThrow('Poster file ID missing from turntable render result')
|
||||
|
||||
expect(turntableService.deleteTask).toHaveBeenCalledWith('task_render_1', 'team-1')
|
||||
})
|
||||
})
|
||||
|
||||
describe('waitFor3dVideoRenderActivity', () => {
|
||||
it('polls until complete, downloads video, uploads to S3, and cleans up task', async () => {
|
||||
vi.mocked(turntableService.getTaskStatus).mockResolvedValue({
|
||||
taskId: 'task_render_1',
|
||||
status: 'completed',
|
||||
createdAt: new Date().toISOString(),
|
||||
video: {
|
||||
fileId: 'f_video',
|
||||
contentType: 'video/mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
size: 1000,
|
||||
},
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.downloadFile).mockResolvedValue(Buffer.from('video-data'))
|
||||
|
||||
const res = await waitFor3dVideoRenderActivity({
|
||||
taskId: 'wf-task-1',
|
||||
teamId: 'team-1',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
renderTaskId: 'task_render_1',
|
||||
targetVideoKey: 'files/asset-1/turntable.mp4',
|
||||
tmpDir: '/tmp',
|
||||
})
|
||||
|
||||
expect(turntableService.getTaskStatus).toHaveBeenCalledWith('task_render_1', 'team-1')
|
||||
expect(turntableService.downloadFile).toHaveBeenCalledWith(
|
||||
'f_video',
|
||||
'/tmp/turntable.mp4',
|
||||
'team-1',
|
||||
)
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/turntable.mp4',
|
||||
Buffer.from('video-data'),
|
||||
Buffer.from('video-data').length,
|
||||
'video/mp4',
|
||||
)
|
||||
expect(turntableService.deleteTask).toHaveBeenCalledWith('task_render_1', 'team-1')
|
||||
expect(res.videoFilePath).toBe('/tmp/turntable.mp4')
|
||||
})
|
||||
|
||||
it('throws ApplicationFailure when render fails on turntable-renderer', async () => {
|
||||
vi.mocked(turntableService.getTaskStatus).mockResolvedValue({
|
||||
taskId: 'task_render_2',
|
||||
status: 'failed',
|
||||
createdAt: new Date().toISOString(),
|
||||
error: {
|
||||
code: 'render_failed',
|
||||
message: 'Blender failed to import model',
|
||||
},
|
||||
})
|
||||
|
||||
await expect(
|
||||
waitFor3dVideoRenderActivity({
|
||||
taskId: 'wf-task-2',
|
||||
teamId: 'team-1',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
renderTaskId: 'task_render_2',
|
||||
targetVideoKey: 'files/asset-1/turntable.mp4',
|
||||
tmpDir: '/tmp',
|
||||
}),
|
||||
).rejects.toThrow('Blender failed to import model')
|
||||
|
||||
expect(turntableService.deleteTask).toHaveBeenCalledWith('task_render_2', 'team-1')
|
||||
})
|
||||
})
|
||||
|
||||
describe('render3dModelActivity (legacy wrapper)', () => {
|
||||
it('uploads file, starts render, polls until complete, and uploads to S3', async () => {
|
||||
vi.mocked(turntableService.uploadFile).mockResolvedValue({
|
||||
id: 'f_input',
|
||||
name: 'model.glb',
|
||||
size: 1024,
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.startRender).mockResolvedValue({
|
||||
taskId: 'task_render_1',
|
||||
status: 'queued',
|
||||
poster: {
|
||||
fileId: 'f_poster',
|
||||
contentType: 'image/png',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
size: 5000,
|
||||
},
|
||||
metadata: { format: 'glb', vertices: 120 },
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.getTaskStatus).mockResolvedValue({
|
||||
taskId: 'task_render_1',
|
||||
status: 'completed',
|
||||
createdAt: new Date().toISOString(),
|
||||
video: {
|
||||
fileId: 'f_video',
|
||||
contentType: 'video/mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
size: 1000,
|
||||
},
|
||||
})
|
||||
|
||||
vi.mocked(turntableService.downloadFile).mockResolvedValue(Buffer.from('downloaded-data'))
|
||||
|
||||
const res = await render3dModelActivity({
|
||||
taskId: 'wf-task-1',
|
||||
teamId: 'team-1',
|
||||
assetId: 'asset-1',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
filePath: '/tmp/model.glb',
|
||||
filename: 'model.glb',
|
||||
targetVideoKey: 'files/asset-1/turntable.mp4',
|
||||
targetPosterKey: 'files/asset-1/poster.webp',
|
||||
})
|
||||
|
||||
expect(turntableService.uploadFile).toHaveBeenCalledWith(
|
||||
'/tmp/model.glb',
|
||||
'model.glb',
|
||||
'team-1',
|
||||
)
|
||||
expect(turntableService.startRender).toHaveBeenCalledWith('f_input', {}, 'team-1')
|
||||
expect(turntableService.getTaskStatus).toHaveBeenCalledWith('task_render_1', 'team-1')
|
||||
expect(turntableService.downloadFile).toHaveBeenCalledWith(
|
||||
'f_video',
|
||||
'/tmp/turntable.mp4',
|
||||
'team-1',
|
||||
)
|
||||
expect(turntableService.downloadFile).toHaveBeenCalledWith('f_poster', undefined, 'team-1')
|
||||
expect(transcodeService.convertImageToWebp).toHaveBeenCalledWith(expect.any(Buffer))
|
||||
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/turntable.mp4',
|
||||
expect.any(Buffer),
|
||||
expect.any(Number),
|
||||
'video/mp4',
|
||||
)
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/poster.webp',
|
||||
expect.any(Buffer),
|
||||
expect.any(Number),
|
||||
'image/webp',
|
||||
)
|
||||
|
||||
expect(turntableService.deleteTask).toHaveBeenCalledWith('task_render_1', 'team-1')
|
||||
expect(res.modelMetadata).toEqual({ format: 'glb', vertices: 120 })
|
||||
expect(res.videoFilePath).toBe('/tmp/turntable.mp4')
|
||||
expect(res.posterFilePath).toBe('/tmp/poster.webp')
|
||||
})
|
||||
})
|
||||
|
||||
describe('generate3dSpriteActivity', () => {
|
||||
it('generates 3d sprite sheet and uploads to S3', async () => {
|
||||
const res = await generate3dSpriteActivity({
|
||||
taskId: 'wf-task-3',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
videoFilePath: '/tmp/turntable.mp4',
|
||||
spriteKey: 'files/asset-1/sprite.webp',
|
||||
})
|
||||
|
||||
expect(transcodeService.generate3dSprite).toHaveBeenCalledWith(
|
||||
'/tmp/turntable.mp4',
|
||||
'/tmp/sprite.webp',
|
||||
undefined,
|
||||
)
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/sprite.webp',
|
||||
expect.any(Buffer),
|
||||
expect.any(Number),
|
||||
'image/webp',
|
||||
)
|
||||
expect(res.spriteKey).toBe('files/asset-1/sprite.webp')
|
||||
})
|
||||
})
|
||||
|
||||
describe('generate3dViewsActivity', () => {
|
||||
it('generates 3d 4-views composite image and uploads to S3', async () => {
|
||||
const res = await generate3dViewsActivity({
|
||||
taskId: 'wf-task-4',
|
||||
assetKey: 'files/asset-1/model.glb',
|
||||
videoFilePath: '/tmp/turntable.mp4',
|
||||
viewsKey: 'files/asset-1/views.webp',
|
||||
})
|
||||
|
||||
expect(transcodeService.generate3dViews).toHaveBeenCalledWith(
|
||||
'/tmp/turntable.mp4',
|
||||
'/tmp/views.webp',
|
||||
undefined,
|
||||
)
|
||||
expect(s3Service.putObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/asset-1/views.webp',
|
||||
expect.any(Buffer),
|
||||
expect.any(Number),
|
||||
'image/webp',
|
||||
)
|
||||
expect(res.viewsKey).toBe('files/asset-1/views.webp')
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -27,6 +27,7 @@ import {
|
||||
transcodeVideoChunkActivity,
|
||||
deleteS3ObjectActivity,
|
||||
createAutofillTaskIfEnabledActivity,
|
||||
createEmbeddingTaskIfEnabledActivity,
|
||||
} from './transcode'
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
@@ -1717,4 +1718,115 @@ describe('Transcode Activities', () => {
|
||||
expect((task?.payload as any)?.agent?.agentId).toBe(autofillAgent.id)
|
||||
})
|
||||
})
|
||||
|
||||
describe('createEmbeddingTaskIfEnabledActivity', () => {
|
||||
it('should create ai_embedding task for 3D asset with imageTranscodes', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Test User Embedding', email: 'test-embedding-agent@test.com' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Team Embedding' },
|
||||
})
|
||||
await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: user.id, role: 'owner' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Test Project Embedding', teamId: team.id },
|
||||
})
|
||||
const embeddingAgent = await prisma.agent.create({
|
||||
data: {
|
||||
id: user.id,
|
||||
type: 'embedding',
|
||||
enabled: true,
|
||||
teamId: team.id,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
config: { provider: 'test', model: 'test' } as any,
|
||||
},
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
projectId: project.id,
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [
|
||||
{
|
||||
key: 'files/asset-1/views.webp',
|
||||
width: 2880,
|
||||
height: 2880,
|
||||
quality: 85,
|
||||
format: 'webp',
|
||||
},
|
||||
],
|
||||
} as unknown as PrismaJson.MediaInfo,
|
||||
},
|
||||
})
|
||||
|
||||
await createEmbeddingTaskIfEnabledActivity({
|
||||
assetId: asset.id,
|
||||
teamId: team.id,
|
||||
projectId: project.id,
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: asset.id, type: 'ai_embedding' },
|
||||
})
|
||||
expect(task).toBeDefined()
|
||||
expect(task?.status).toBe('pending')
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
expect((task?.payload as any)?.agent?.agentId).toBe(embeddingAgent.id)
|
||||
})
|
||||
|
||||
it('should NOT create ai_embedding task for 3D asset without imageTranscodes', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Test User Embedding 2', email: 'test-embedding-agent-2@test.com' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Team Embedding 2' },
|
||||
})
|
||||
await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: user.id, role: 'owner' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Test Project Embedding 2', teamId: team.id },
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: user.id,
|
||||
type: 'embedding',
|
||||
enabled: true,
|
||||
teamId: team.id,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
config: { provider: 'test', model: 'test' } as any,
|
||||
},
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
mediaType: 'model/gltf-binary',
|
||||
type: 'file',
|
||||
status: 'processed',
|
||||
projectId: project.id,
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [],
|
||||
} as unknown as PrismaJson.MediaInfo,
|
||||
},
|
||||
})
|
||||
|
||||
await createEmbeddingTaskIfEnabledActivity({
|
||||
assetId: asset.id,
|
||||
teamId: team.id,
|
||||
projectId: project.id,
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.findFirst({
|
||||
where: { assetId: asset.id, type: 'ai_embedding' },
|
||||
})
|
||||
expect(task).toBeNull()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -8,7 +8,11 @@ import {
|
||||
} from '@shumai/core/src/transcode/transcode'
|
||||
import { metadataService } from '@shumai/core/src/metadata/metadata'
|
||||
import { getDerivedArtifactDirectory, stemFromKey } from '@shumai/core/src/utils/filename'
|
||||
import { gotenbergService } from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import {
|
||||
gotenbergService,
|
||||
type GotenbergConvertOptions,
|
||||
} from '@shumai/core/src/gotenberg/gotenberg'
|
||||
import { turntableService } from '@shumai/core/src/turntable/turntable'
|
||||
import { parseCsvContent } from '@shumai/core/src/transcode/transcode'
|
||||
import { resolutionToDimensions } from '../workflows/transcode-utils'
|
||||
import {
|
||||
@@ -915,6 +919,7 @@ export async function generateSpriteActivity(params: GenerateSpriteActivityParam
|
||||
}
|
||||
|
||||
export interface GeneratePdfProxyActivityParams {
|
||||
teamId?: string | null
|
||||
assetId: string
|
||||
assetKey: string
|
||||
filePath: string
|
||||
@@ -941,8 +946,12 @@ export async function generatePdfProxyActivity(
|
||||
const tmpDir = path.dirname(params.filePath)
|
||||
const pdfFilePath = path.join(tmpDir, 'proxy.pdf')
|
||||
|
||||
const targetTeamId = params.teamId || undefined
|
||||
|
||||
try {
|
||||
const gotenbergAvailable = await gotenbergService.isAvailable()
|
||||
const gotenbergAvailable = await (targetTeamId
|
||||
? gotenbergService.isAvailable(targetTeamId)
|
||||
: gotenbergService.isAvailable())
|
||||
|
||||
if (isOffice) {
|
||||
if (!gotenbergAvailable) {
|
||||
@@ -950,10 +959,14 @@ export async function generatePdfProxyActivity(
|
||||
'Gotenberg service is required for Office document conversion but is unavailable.',
|
||||
)
|
||||
}
|
||||
const pdfBuffer = await gotenbergService.convertDocumentToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
)
|
||||
const pdfBuffer = await (targetTeamId
|
||||
? gotenbergService.convertDocumentToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
{ teamId: targetTeamId },
|
||||
targetTeamId,
|
||||
)
|
||||
: gotenbergService.convertDocumentToPdf(params.filePath, params.filename))
|
||||
fs.writeFileSync(pdfFilePath, pdfBuffer)
|
||||
} else if (isHtml) {
|
||||
if (!gotenbergAvailable) {
|
||||
@@ -961,7 +974,9 @@ export async function generatePdfProxyActivity(
|
||||
'Gotenberg service is required for HTML document conversion but is unavailable.',
|
||||
)
|
||||
}
|
||||
const pdfBuffer = await gotenbergService.convertHtmlToPdf(params.filePath, params.filename)
|
||||
const pdfBuffer = await (targetTeamId
|
||||
? gotenbergService.convertHtmlToPdf(params.filePath, params.filename, targetTeamId)
|
||||
: gotenbergService.convertHtmlToPdf(params.filePath, params.filename))
|
||||
fs.writeFileSync(pdfFilePath, pdfBuffer)
|
||||
} else if (isCsv) {
|
||||
if (gotenbergAvailable) {
|
||||
@@ -974,10 +989,14 @@ export async function generatePdfProxyActivity(
|
||||
} catch {
|
||||
// Fallback landscape calculation
|
||||
}
|
||||
const options: GotenbergConvertOptions = {
|
||||
landscape: isLandscape,
|
||||
...(targetTeamId ? { teamId: targetTeamId } : {}),
|
||||
}
|
||||
const pdfBuffer = await gotenbergService.convertDocumentToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
{ landscape: isLandscape },
|
||||
options,
|
||||
)
|
||||
fs.writeFileSync(pdfFilePath, pdfBuffer)
|
||||
} else {
|
||||
@@ -985,20 +1004,23 @@ export async function generatePdfProxyActivity(
|
||||
}
|
||||
} else if (isMd) {
|
||||
if (gotenbergAvailable) {
|
||||
const pdfBuffer = await gotenbergService.convertMarkdownToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
)
|
||||
const pdfBuffer = await (targetTeamId
|
||||
? gotenbergService.convertMarkdownToPdf(params.filePath, params.filename, targetTeamId)
|
||||
: gotenbergService.convertMarkdownToPdf(params.filePath, params.filename))
|
||||
fs.writeFileSync(pdfFilePath, pdfBuffer)
|
||||
} else {
|
||||
await transcodeService.generatePdfFromText(params.filePath, pdfFilePath)
|
||||
}
|
||||
} else if (isTxt) {
|
||||
if (gotenbergAvailable) {
|
||||
const pdfBuffer = await gotenbergService.convertDocumentToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
)
|
||||
const pdfBuffer = await (targetTeamId
|
||||
? gotenbergService.convertDocumentToPdf(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
{ teamId: targetTeamId },
|
||||
targetTeamId,
|
||||
)
|
||||
: gotenbergService.convertDocumentToPdf(params.filePath, params.filename))
|
||||
fs.writeFileSync(pdfFilePath, pdfBuffer)
|
||||
} else {
|
||||
await transcodeService.generatePdfFromText(params.filePath, pdfFilePath)
|
||||
@@ -1338,8 +1360,11 @@ export async function createEmbeddingTaskIfEnabledActivity(
|
||||
return
|
||||
}
|
||||
|
||||
const mediaInfo = asset.media as PrismaJson.MediaInfo | null
|
||||
const isVideo = asset.mediaType?.startsWith('video/')
|
||||
const isImage = asset.mediaType?.startsWith('image/')
|
||||
const isImage =
|
||||
asset.mediaType?.startsWith('image/') ||
|
||||
(mediaInfo?.proxyType === '3d' && (mediaInfo.imageTranscodes?.length ?? 0) > 0)
|
||||
if (!isVideo && !isImage) {
|
||||
return
|
||||
}
|
||||
@@ -1551,3 +1576,364 @@ export async function deleteS3ObjectActivity(params: { key: string }): Promise<v
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
await s3Service.deleteObject(bucket, params.key)
|
||||
}
|
||||
|
||||
export interface Render3dModelActivityParams {
|
||||
taskId: string
|
||||
teamId: string
|
||||
assetId: string
|
||||
assetKey: string
|
||||
filePath: string
|
||||
filename: string
|
||||
targetVideoKey: string
|
||||
targetPosterKey: string
|
||||
}
|
||||
|
||||
export interface Render3dModelActivityResult {
|
||||
videoFilePath: string
|
||||
posterFilePath: string
|
||||
modelMetadata?: Record<string, unknown>
|
||||
}
|
||||
|
||||
export interface Start3dRenderActivityParams {
|
||||
taskId: string
|
||||
teamId: string
|
||||
assetId: string
|
||||
assetKey: string
|
||||
filePath: string
|
||||
filename: string
|
||||
targetPosterKey: string
|
||||
}
|
||||
|
||||
export interface Start3dRenderActivityResult {
|
||||
renderTaskId: string
|
||||
posterFilePath: string
|
||||
posterWidth?: number
|
||||
posterHeight?: number
|
||||
modelMetadata?: Record<string, unknown>
|
||||
}
|
||||
|
||||
export async function start3dRenderActivity(
|
||||
params: Start3dRenderActivityParams,
|
||||
): Promise<Start3dRenderActivityResult> {
|
||||
const signal = getActivityCancellationSignal(params.taskId)
|
||||
if (signal?.aborted) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Render cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const tmpDir = path.dirname(params.filePath)
|
||||
const posterFilePath = path.join(tmpDir, 'poster.webp')
|
||||
|
||||
let fileId: string | undefined
|
||||
let renderTaskId: string | undefined
|
||||
|
||||
try {
|
||||
const uploadResult = await turntableService.uploadFile(
|
||||
params.filePath,
|
||||
params.filename,
|
||||
params.teamId,
|
||||
)
|
||||
fileId = uploadResult.id
|
||||
|
||||
if (signal?.aborted) {
|
||||
await turntableService.deleteFile(fileId, params.teamId).catch(() => {})
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Render cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const startResult = await turntableService.startRender(fileId, {}, params.teamId)
|
||||
renderTaskId = startResult.taskId
|
||||
|
||||
const posterFileId = startResult.poster?.fileId
|
||||
if (!posterFileId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Poster file ID missing from turntable render result',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const posterBuffer = await turntableService.downloadFile(posterFileId, undefined, params.teamId)
|
||||
const posterWebpBuffer = await transcodeService.convertImageToWebp(posterBuffer)
|
||||
fs.writeFileSync(posterFilePath, posterWebpBuffer)
|
||||
|
||||
await ensureAssetNotPurging(params.assetKey)
|
||||
|
||||
await s3Service.putObject(
|
||||
bucket,
|
||||
params.targetPosterKey,
|
||||
posterWebpBuffer,
|
||||
posterWebpBuffer.length,
|
||||
'image/webp',
|
||||
)
|
||||
|
||||
return {
|
||||
renderTaskId,
|
||||
posterFilePath,
|
||||
posterWidth: startResult.poster?.width,
|
||||
posterHeight: startResult.poster?.height,
|
||||
modelMetadata: (startResult.metadata as Record<string, unknown>) || {},
|
||||
}
|
||||
} catch (err) {
|
||||
if (renderTaskId) {
|
||||
await turntableService.deleteTask(renderTaskId, params.teamId).catch(() => {})
|
||||
} else if (fileId) {
|
||||
await turntableService.deleteFile(fileId, params.teamId).catch(() => {})
|
||||
}
|
||||
if (err instanceof ApplicationFailure) {
|
||||
throw err
|
||||
}
|
||||
const errMsg = err instanceof Error ? err.message : String(err)
|
||||
throw ApplicationFailure.create({
|
||||
message: `Failed to start 3D render: ${errMsg}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
export interface WaitFor3dVideoRenderActivityParams {
|
||||
taskId: string
|
||||
teamId: string
|
||||
assetKey: string
|
||||
renderTaskId: string
|
||||
targetVideoKey: string
|
||||
tmpDir: string
|
||||
}
|
||||
|
||||
export interface WaitFor3dVideoRenderActivityResult {
|
||||
videoFilePath: string
|
||||
}
|
||||
|
||||
export async function waitFor3dVideoRenderActivity(
|
||||
params: WaitFor3dVideoRenderActivityParams,
|
||||
): Promise<WaitFor3dVideoRenderActivityResult> {
|
||||
const signal = getActivityCancellationSignal(params.taskId)
|
||||
if (signal?.aborted) {
|
||||
await turntableService.deleteTask(params.renderTaskId, params.teamId).catch(() => {})
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Render cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const videoFilePath = path.join(params.tmpDir, 'turntable.mp4')
|
||||
|
||||
try {
|
||||
let finishedStatus: 'completed' | 'failed' | null = null
|
||||
let taskRecord: Awaited<ReturnType<typeof turntableService.getTaskStatus>> | null = null
|
||||
|
||||
for (let i = 0; i < 360; i++) {
|
||||
if (signal?.aborted) {
|
||||
await turntableService.deleteTask(params.renderTaskId, params.teamId).catch(() => {})
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Render cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
if (i > 0) {
|
||||
await new Promise((resolve) => setTimeout(resolve, 5000))
|
||||
}
|
||||
|
||||
taskRecord = await turntableService.getTaskStatus(params.renderTaskId, params.teamId)
|
||||
if (taskRecord.status === 'completed') {
|
||||
finishedStatus = 'completed'
|
||||
break
|
||||
}
|
||||
if (taskRecord.status === 'failed') {
|
||||
finishedStatus = 'failed'
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if (finishedStatus !== 'completed' || !taskRecord) {
|
||||
const errMsg =
|
||||
finishedStatus === 'failed'
|
||||
? taskRecord?.error?.message || '3D render failed on turntable server'
|
||||
: '3D render timed out on turntable server'
|
||||
throw ApplicationFailure.create({
|
||||
message: errMsg,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const videoFileId = taskRecord.video?.fileId
|
||||
if (!videoFileId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Video file ID missing from turntable render result',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const videoBuffer = await turntableService.downloadFile(
|
||||
videoFileId,
|
||||
videoFilePath,
|
||||
params.teamId,
|
||||
)
|
||||
|
||||
await ensureAssetNotPurging(params.assetKey)
|
||||
|
||||
await s3Service.putObject(
|
||||
bucket,
|
||||
params.targetVideoKey,
|
||||
videoBuffer,
|
||||
videoBuffer.length,
|
||||
'video/mp4',
|
||||
)
|
||||
|
||||
await turntableService.deleteTask(params.renderTaskId, params.teamId).catch((err) => {
|
||||
logger.warn(
|
||||
{ err, taskId: params.renderTaskId },
|
||||
'Failed to delete turntable task after completion',
|
||||
)
|
||||
})
|
||||
|
||||
return {
|
||||
videoFilePath,
|
||||
}
|
||||
} catch (err) {
|
||||
await turntableService.deleteTask(params.renderTaskId, params.teamId).catch(() => {})
|
||||
if (err instanceof ApplicationFailure) {
|
||||
throw err
|
||||
}
|
||||
const errMsg = err instanceof Error ? err.message : String(err)
|
||||
throw ApplicationFailure.create({
|
||||
message: `Failed to render 3D model video: ${errMsg}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Legacy monolithic 3D render activity. Prefer using `start3dRenderActivity` and `waitFor3dVideoRenderActivity`.
|
||||
*/
|
||||
export async function render3dModelActivity(
|
||||
params: Render3dModelActivityParams,
|
||||
): Promise<Render3dModelActivityResult> {
|
||||
const tmpDir = path.dirname(params.filePath)
|
||||
const startResult = await start3dRenderActivity({
|
||||
taskId: params.taskId,
|
||||
teamId: params.teamId,
|
||||
assetId: params.assetId,
|
||||
assetKey: params.assetKey,
|
||||
filePath: params.filePath,
|
||||
filename: params.filename,
|
||||
targetPosterKey: params.targetPosterKey,
|
||||
})
|
||||
|
||||
const videoResult = await waitFor3dVideoRenderActivity({
|
||||
taskId: params.taskId,
|
||||
teamId: params.teamId,
|
||||
assetKey: params.assetKey,
|
||||
renderTaskId: startResult.renderTaskId,
|
||||
targetVideoKey: params.targetVideoKey,
|
||||
tmpDir,
|
||||
})
|
||||
|
||||
return {
|
||||
videoFilePath: videoResult.videoFilePath,
|
||||
posterFilePath: startResult.posterFilePath,
|
||||
modelMetadata: startResult.modelMetadata,
|
||||
}
|
||||
}
|
||||
|
||||
export interface Generate3dSpriteActivityParams {
|
||||
taskId: string
|
||||
assetKey: string
|
||||
videoFilePath: string
|
||||
spriteKey: string
|
||||
}
|
||||
|
||||
export async function generate3dSpriteActivity(
|
||||
params: Generate3dSpriteActivityParams,
|
||||
): Promise<{ spriteKey: string }> {
|
||||
const signal = getActivityCancellationSignal(params.taskId)
|
||||
if (signal?.aborted) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Sprite generation cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const tmpDir = path.dirname(params.videoFilePath)
|
||||
const spriteFilePath = path.join(tmpDir, 'sprite.webp')
|
||||
|
||||
try {
|
||||
await transcodeService.generate3dSprite(params.videoFilePath, spriteFilePath, signal)
|
||||
const spriteBuffer = fs.readFileSync(spriteFilePath)
|
||||
|
||||
await ensureAssetNotPurging(params.assetKey)
|
||||
await s3Service.putObject(
|
||||
bucket,
|
||||
params.spriteKey,
|
||||
spriteBuffer,
|
||||
spriteBuffer.length,
|
||||
'image/webp',
|
||||
)
|
||||
|
||||
return { spriteKey: params.spriteKey }
|
||||
} catch (err) {
|
||||
if (err instanceof ApplicationFailure) {
|
||||
throw err
|
||||
}
|
||||
const errMsg = err instanceof Error ? err.message : String(err)
|
||||
throw ApplicationFailure.create({
|
||||
message: `Failed to generate 3D sprite: ${errMsg}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
export interface Generate3dViewsActivityParams {
|
||||
taskId: string
|
||||
assetKey: string
|
||||
videoFilePath: string
|
||||
viewsKey: string
|
||||
}
|
||||
|
||||
export async function generate3dViewsActivity(
|
||||
params: Generate3dViewsActivityParams,
|
||||
): Promise<{ viewsKey: string }> {
|
||||
const signal = getActivityCancellationSignal(params.taskId)
|
||||
if (signal?.aborted) {
|
||||
throw ApplicationFailure.create({
|
||||
message: '3D views generation cancelled',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const tmpDir = path.dirname(params.videoFilePath)
|
||||
const viewsFilePath = path.join(tmpDir, 'views.webp')
|
||||
|
||||
try {
|
||||
await transcodeService.generate3dViews(params.videoFilePath, viewsFilePath, signal)
|
||||
const viewsBuffer = fs.readFileSync(viewsFilePath)
|
||||
|
||||
await ensureAssetNotPurging(params.assetKey)
|
||||
await s3Service.putObject(
|
||||
bucket,
|
||||
params.viewsKey,
|
||||
viewsBuffer,
|
||||
viewsBuffer.length,
|
||||
'image/webp',
|
||||
)
|
||||
|
||||
return { viewsKey: params.viewsKey }
|
||||
} catch (err) {
|
||||
if (err instanceof ApplicationFailure) {
|
||||
throw err
|
||||
}
|
||||
const errMsg = err instanceof Error ? err.message : String(err)
|
||||
throw ApplicationFailure.create({
|
||||
message: `Failed to generate 3D views: ${errMsg}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -618,6 +618,125 @@ describe('Watermark Activities', () => {
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('produces a watermarked mp4 proxy from the turntable video for a 3d asset', async () => {
|
||||
const storageKey = await prisma.storageKey.create({
|
||||
data: { key: 'files/asset-3d/robot.glb' },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
mediaType: 'model/gltf-binary',
|
||||
status: 'processed',
|
||||
storageKeyId: storageKey.id,
|
||||
media: {
|
||||
duration: 4,
|
||||
filesize: 100,
|
||||
frames: 24,
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [
|
||||
{
|
||||
key: 'files/asset-3d/turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
},
|
||||
],
|
||||
videoPreview: {
|
||||
key: 'files/asset-3d/turntable.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
},
|
||||
poster: { key: 'files/asset-3d/poster.webp' },
|
||||
sprite: { key: 'files/asset-3d/sprite.webp', frames: 100, tileX: 10, tileY: 10 },
|
||||
finishedAt: new Date().toISOString(),
|
||||
metadata: {
|
||||
originalWidth: 1080,
|
||||
originalHeight: 1080,
|
||||
duration: 4,
|
||||
bitRate: 0,
|
||||
frameRate: 6,
|
||||
totalFrames: 24,
|
||||
startTimecode: '00:00:00:00',
|
||||
hasAudio: false,
|
||||
format: {},
|
||||
},
|
||||
original: {
|
||||
key: 'files/asset-3d/robot.glb',
|
||||
filesizeInBytes: 100,
|
||||
codec: '',
|
||||
},
|
||||
} as PrismaJson.MediaInfo,
|
||||
},
|
||||
})
|
||||
const config = await seedConfig()
|
||||
|
||||
vi.mocked(transcodeService.getVideoInfo).mockResolvedValue({
|
||||
originalWidth: 1080,
|
||||
originalHeight: 1080,
|
||||
duration: 4,
|
||||
bitRate: 2000,
|
||||
frameRate: 6,
|
||||
totalFrames: 24,
|
||||
startTimecode: '00:00:00:00',
|
||||
hasAudio: false,
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
vi.mocked(s3Service.putObject).mockResolvedValue(undefined as never)
|
||||
|
||||
const stem = 'robot'
|
||||
const configId = config.id
|
||||
const outFilePath = path.join('/tmp', `${stem}-watermark-${configId}-1080p.mp4`)
|
||||
fs.writeFileSync(outFilePath, Buffer.from('fake 3d watermarked turntable mp4'))
|
||||
|
||||
const media = await transcodeWatermarkMediaActivity({
|
||||
assetId: asset.id,
|
||||
watermarkConfigId: config.id,
|
||||
})
|
||||
|
||||
expect(media.proxyType).toBe('3d')
|
||||
expect(media.videoTranscodes?.length).toBeGreaterThan(0)
|
||||
expect(media.videoTranscodes?.[0].key).toContain('watermark-')
|
||||
expect(media.videoPreview?.key).toBe(media.videoTranscodes?.[0].key)
|
||||
expect(media.poster?.key).toBe('files/asset-3d/poster.webp')
|
||||
expect(media.sprite?.key).toBe('files/asset-3d/sprite.webp')
|
||||
expect(s3Service.downloadToFile).toHaveBeenCalledWith(
|
||||
bucket,
|
||||
'files/asset-3d/turntable.mp4',
|
||||
expect.any(String),
|
||||
)
|
||||
|
||||
fs.rmSync(outFilePath, { force: true })
|
||||
})
|
||||
|
||||
it('throws non-retryable ApplicationFailure when 3d asset has no turntable video transcode', async () => {
|
||||
const storageKey = await prisma.storageKey.create({
|
||||
data: { key: 'files/asset-3d/robot.glb' },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'robot.glb',
|
||||
type: 'file',
|
||||
mediaType: 'model/gltf-binary',
|
||||
status: 'processing',
|
||||
storageKeyId: storageKey.id,
|
||||
media: {
|
||||
proxyType: '3d',
|
||||
videoTranscodes: [],
|
||||
} as unknown as PrismaJson.MediaInfo,
|
||||
},
|
||||
})
|
||||
const config = await seedConfig()
|
||||
|
||||
await expect(
|
||||
transcodeWatermarkMediaActivity({
|
||||
assetId: asset.id,
|
||||
watermarkConfigId: config.id,
|
||||
}),
|
||||
).rejects.toThrow('Turntable video transcode not found for 3D asset')
|
||||
})
|
||||
})
|
||||
|
||||
describe('completeWatermarkFileActivity', () => {
|
||||
|
||||
@@ -163,17 +163,39 @@ export async function transcodeWatermarkMediaActivity(
|
||||
const stem = stemFromKey(assetKey)
|
||||
|
||||
const tmpDir = transcodeService.createTempDir('watermark-')
|
||||
const rawFilePath = path.join(tmpDir, path.basename(assetKey))
|
||||
|
||||
try {
|
||||
await s3Service.downloadToFile(bucket, assetKey, rawFilePath)
|
||||
|
||||
const is3d = (asset.media as PrismaJson.MediaInfo | null)?.proxyType === '3d'
|
||||
const isVideo =
|
||||
asset.mediaType?.startsWith('video/') ||
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType === 'video'
|
||||
!is3d &&
|
||||
(asset.mediaType?.startsWith('video/') ||
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType === 'video')
|
||||
const isImage =
|
||||
asset.mediaType?.startsWith('image/') ||
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType === 'image'
|
||||
!is3d &&
|
||||
(asset.mediaType?.startsWith('image/') ||
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType === 'image')
|
||||
|
||||
if (!isVideo && !isImage && !is3d) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Asset ${params.assetId} is neither video nor image`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const inputKey = is3d
|
||||
? (asset.media as PrismaJson.MediaInfo | null)?.videoTranscodes?.[0]?.key ||
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.videoPreview?.key
|
||||
: assetKey
|
||||
|
||||
if (is3d && !inputKey) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Turntable video transcode not found for 3D asset ${params.assetId}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const rawFilePath = path.join(tmpDir, path.basename(inputKey!))
|
||||
await s3Service.downloadToFile(bucket, inputKey!, rawFilePath)
|
||||
|
||||
let originalWidth = 1920
|
||||
let originalHeight = 1080
|
||||
@@ -192,7 +214,7 @@ export async function transcodeWatermarkMediaActivity(
|
||||
let hdrType: PrismaJson.HdrType | undefined
|
||||
let dvProfile: number | undefined
|
||||
|
||||
if (isVideo) {
|
||||
if (isVideo || is3d) {
|
||||
const info = await transcodeService.getVideoInfo(rawFilePath)
|
||||
originalWidth = info.originalWidth
|
||||
originalHeight = info.originalHeight
|
||||
@@ -214,11 +236,6 @@ export async function transcodeWatermarkMediaActivity(
|
||||
const info = await transcodeService.getImageInfo(rawFilePath)
|
||||
originalWidth = info.originalWidth
|
||||
originalHeight = info.originalHeight
|
||||
} else {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Asset ${params.assetId} is neither video nor image`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Process image blocks if any
|
||||
@@ -260,9 +277,11 @@ export async function transcodeWatermarkMediaActivity(
|
||||
duration,
|
||||
filesize: 0,
|
||||
frames: totalFrames,
|
||||
proxyType: isVideo ? 'video' : 'image',
|
||||
proxyType: is3d ? '3d' : isVideo ? 'video' : 'image',
|
||||
imageTranscodes: [],
|
||||
videoTranscodes: [],
|
||||
poster: originalMedia?.poster,
|
||||
sprite: originalMedia?.sprite,
|
||||
finishedAt: new Date().toISOString(),
|
||||
metadata: {
|
||||
originalWidth,
|
||||
@@ -280,7 +299,7 @@ export async function transcodeWatermarkMediaActivity(
|
||||
isHdr: isHdr ?? originalMedia?.metadata?.isHdr,
|
||||
hdrType: hdrType ?? originalMedia?.metadata?.hdrType,
|
||||
dvProfile: dvProfile ?? originalMedia?.metadata?.dvProfile,
|
||||
format: {},
|
||||
format: originalMedia?.metadata?.format ?? {},
|
||||
},
|
||||
original: {
|
||||
key: assetKey,
|
||||
@@ -333,7 +352,7 @@ export async function transcodeWatermarkMediaActivity(
|
||||
})
|
||||
}
|
||||
mediaInfo.filesize = totalSize
|
||||
} else if (isVideo) {
|
||||
} else if (isVideo || is3d) {
|
||||
const originalTranscodes = originalMedia?.videoTranscodes || []
|
||||
let totalSize = 0
|
||||
|
||||
@@ -395,6 +414,15 @@ export async function transcodeWatermarkMediaActivity(
|
||||
})
|
||||
}
|
||||
|
||||
if (is3d && mediaInfo.videoTranscodes.length > 0) {
|
||||
mediaInfo.videoPreview = {
|
||||
key: mediaInfo.videoTranscodes[0].key,
|
||||
width: mediaInfo.videoTranscodes[0].width,
|
||||
height: mediaInfo.videoTranscodes[0].height,
|
||||
resolution: mediaInfo.videoTranscodes[0].resolution,
|
||||
}
|
||||
}
|
||||
|
||||
if (originalMedia?.isHls && originalMedia?.hls?.resolutions?.length) {
|
||||
const hlsWatermarkDirKey = path.posix.join(
|
||||
path.posix.dirname(assetKey),
|
||||
|
||||
@@ -9,6 +9,7 @@ import { renderPdfPagesWorkflow } from './workflows/render-pdf-pages'
|
||||
import { takeVideoScreenshotsWorkflow } from './workflows/take-video-screenshots'
|
||||
import { overlayImageAnnotationWorkflow } from './workflows/overlay-image-annotation'
|
||||
import { transcodeWatermarkWorkflow } from './workflows/transcode-watermark'
|
||||
import { transcode3dWorkflow } from './workflows/transcode-3d'
|
||||
import { transcodeMedia } from './workflows/transcode'
|
||||
|
||||
export function initTranscodeWorkflows() {
|
||||
@@ -16,6 +17,7 @@ export function initTranscodeWorkflows() {
|
||||
registerWorkflow(WorkflowTaskType.transcode_video, transcodeVideoWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_image, transcodeImageWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_pdf, transcodePdfWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_3d, transcode3dWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_pdf_pages, renderPdfPagesWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_screenshot, takeVideoScreenshotsWorkflow)
|
||||
registerWorkflow(WorkflowTaskType.transcode_image_annotation, overlayImageAnnotationWorkflow)
|
||||
@@ -26,6 +28,7 @@ export function initTranscodeWorkflows() {
|
||||
|
||||
export * from './transcoder'
|
||||
export * from './workflows/transcode'
|
||||
export * from './workflows/transcode-3d'
|
||||
export * from './workflows/transcode-watermark'
|
||||
export * from './activities/transcode'
|
||||
export * from './activities/watermark'
|
||||
|
||||
@@ -151,3 +151,41 @@ export class PdfTranscoder {
|
||||
return task.id
|
||||
}
|
||||
}
|
||||
|
||||
export class ModelTranscoder {
|
||||
private spec: PrismaJson.TaskSpec = {}
|
||||
|
||||
constructor(
|
||||
private readonly db: TransactionClient,
|
||||
private readonly assetId: string,
|
||||
private readonly teamId: string,
|
||||
private readonly projectId: string,
|
||||
) {}
|
||||
|
||||
withSprite(): this {
|
||||
this.spec.sprite = true
|
||||
return this
|
||||
}
|
||||
|
||||
withPoster(): this {
|
||||
this.spec.poster = true
|
||||
return this
|
||||
}
|
||||
|
||||
async submit(): Promise<string> {
|
||||
const task = await this.db.workflowTask.create({
|
||||
data: {
|
||||
assetId: this.assetId,
|
||||
teamId: this.teamId,
|
||||
projectId: this.projectId,
|
||||
type: WorkflowTaskType.transcode_3d,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: this.projectId,
|
||||
transcode: this.spec,
|
||||
},
|
||||
},
|
||||
})
|
||||
return task.id
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,270 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { transcode3dWorkflow } from './transcode-3d'
|
||||
import { WorkflowTask, WorkflowTaskStatus, WorkflowTaskType, AssetStatus } from '@shumai/db'
|
||||
import * as workflowUtils from '@shumai/workflow-core'
|
||||
|
||||
vi.mock('@shumai/workflow-core', async (importOriginal) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const actual = (await importOriginal()) as any
|
||||
return {
|
||||
...actual,
|
||||
getActivities: vi.fn(),
|
||||
executeActivity: vi.fn(),
|
||||
sleep: vi.fn(),
|
||||
}
|
||||
})
|
||||
|
||||
describe('transcode3dWorkflow', () => {
|
||||
const mockActivities = {
|
||||
updateTaskStatusActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'updateTaskStatusActivity',
|
||||
}),
|
||||
updateAssetStatusActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'updateAssetStatusActivity',
|
||||
}),
|
||||
getAssetActivity: Object.assign(vi.fn(), { _activityName: 'getAssetActivity' }),
|
||||
render3dModelActivity: Object.assign(vi.fn(), { _activityName: 'render3dModelActivity' }),
|
||||
start3dRenderActivity: Object.assign(vi.fn(), { _activityName: 'start3dRenderActivity' }),
|
||||
waitFor3dVideoRenderActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'waitFor3dVideoRenderActivity',
|
||||
}),
|
||||
generate3dSpriteActivity: Object.assign(vi.fn(), { _activityName: 'generate3dSpriteActivity' }),
|
||||
generate3dViewsActivity: Object.assign(vi.fn(), { _activityName: 'generate3dViewsActivity' }),
|
||||
updateAssetMediaActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'updateAssetMediaActivity',
|
||||
}),
|
||||
getTranscodeWorkerQueueActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getTranscodeWorkerQueueActivity',
|
||||
}),
|
||||
downloadMediaToTmpActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'downloadMediaToTmpActivity',
|
||||
}),
|
||||
cleanupTmpDirActivity: Object.assign(vi.fn(), { _activityName: 'cleanupTmpDirActivity' }),
|
||||
createEmbeddingTaskIfEnabledActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'createEmbeddingTaskIfEnabledActivity',
|
||||
}),
|
||||
createAutofillTaskIfEnabledActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'createAutofillTaskIfEnabledActivity',
|
||||
}),
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
;(workflowUtils.getActivities as any).mockReturnValue(mockActivities)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
;(workflowUtils.executeActivity as any).mockImplementation(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
(_queue: string, fn: any, ...args: any[]) => {
|
||||
if (typeof fn !== 'function') {
|
||||
throw new Error(`fn is not a function in executeActivity. Queue: ${_queue}`)
|
||||
}
|
||||
return fn(...args)
|
||||
},
|
||||
)
|
||||
|
||||
mockActivities.getTranscodeWorkerQueueActivity.mockResolvedValue('transcode_worker_queue')
|
||||
mockActivities.downloadMediaToTmpActivity.mockResolvedValue({
|
||||
filePath: '/tmp/model.glb',
|
||||
tmpDir: '/tmp',
|
||||
})
|
||||
})
|
||||
|
||||
it('should process 3D model transcode successfully', async () => {
|
||||
const task: WorkflowTask = {
|
||||
id: 'task-3d',
|
||||
assetId: 'asset-3d',
|
||||
type: WorkflowTaskType.transcode_3d,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
sessionId: null,
|
||||
output: null,
|
||||
payload: {
|
||||
projectId: 'proj-1',
|
||||
transcode: {
|
||||
sprite: true,
|
||||
poster: true,
|
||||
},
|
||||
},
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
heartbeat: null,
|
||||
teamId: 'team-1',
|
||||
projectId: 'proj-1',
|
||||
uid: 'task-uid-3d',
|
||||
model: null,
|
||||
inputTokens: 0,
|
||||
outputTokens: 0,
|
||||
}
|
||||
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'asset-3d',
|
||||
name: 'robot.glb',
|
||||
storageKey: { key: 'files/asset-3d/robot.glb' },
|
||||
mediaType: 'model/gltf-binary',
|
||||
sizeByte: BigInt(1024),
|
||||
})
|
||||
|
||||
mockActivities.start3dRenderActivity.mockResolvedValue({
|
||||
renderTaskId: 'task_render_1',
|
||||
posterFilePath: '/tmp/poster.webp',
|
||||
posterWidth: 1080,
|
||||
posterHeight: 1080,
|
||||
modelMetadata: { format: 'glb' },
|
||||
})
|
||||
|
||||
mockActivities.waitFor3dVideoRenderActivity.mockResolvedValue({
|
||||
videoFilePath: '/tmp/turntable.mp4',
|
||||
})
|
||||
|
||||
mockActivities.generate3dSpriteActivity.mockResolvedValue({
|
||||
spriteKey: 'files/asset-3d/sprite.webp',
|
||||
})
|
||||
|
||||
await transcode3dWorkflow(task)
|
||||
|
||||
expect(mockActivities.updateAssetStatusActivity).toHaveBeenCalledWith({
|
||||
assetId: 'asset-3d',
|
||||
status: AssetStatus.processing,
|
||||
})
|
||||
|
||||
expect(mockActivities.start3dRenderActivity).toHaveBeenCalledWith({
|
||||
taskId: 'task-3d',
|
||||
teamId: 'team-1',
|
||||
assetId: 'asset-3d',
|
||||
assetKey: 'files/asset-3d/robot.glb',
|
||||
filePath: '/tmp/model.glb',
|
||||
filename: 'robot.glb',
|
||||
targetPosterKey: 'files/asset-3d/poster.webp',
|
||||
})
|
||||
|
||||
// Verify initial updateAssetMediaActivity with poster was called before waitFor3dVideoRenderActivity
|
||||
expect(mockActivities.updateAssetMediaActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
assetId: 'asset-3d',
|
||||
mediaInfo: expect.objectContaining({
|
||||
proxyType: '3d',
|
||||
poster: { key: 'files/asset-3d/poster.webp' },
|
||||
metadata: expect.objectContaining({
|
||||
format: { format: 'glb' },
|
||||
originalHeight: 1080,
|
||||
originalWidth: 1080,
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
|
||||
const firstMediaUpdateOrder =
|
||||
mockActivities.updateAssetMediaActivity.mock.invocationCallOrder[0]
|
||||
const waitVideoOrder = mockActivities.waitFor3dVideoRenderActivity.mock.invocationCallOrder[0]
|
||||
expect(firstMediaUpdateOrder).toBeLessThan(waitVideoOrder)
|
||||
|
||||
expect(mockActivities.waitFor3dVideoRenderActivity).toHaveBeenCalledWith({
|
||||
taskId: 'task-3d',
|
||||
teamId: 'team-1',
|
||||
assetKey: 'files/asset-3d/robot.glb',
|
||||
renderTaskId: 'task_render_1',
|
||||
targetVideoKey: 'files/asset-3d/turntable.mp4',
|
||||
tmpDir: '/tmp',
|
||||
})
|
||||
|
||||
expect(mockActivities.generate3dSpriteActivity).toHaveBeenCalledWith({
|
||||
taskId: 'task-3d',
|
||||
assetKey: 'files/asset-3d/robot.glb',
|
||||
videoFilePath: '/tmp/turntable.mp4',
|
||||
spriteKey: 'files/asset-3d/sprite.webp',
|
||||
})
|
||||
|
||||
expect(mockActivities.generate3dViewsActivity).toHaveBeenCalledWith({
|
||||
taskId: 'task-3d',
|
||||
assetKey: 'files/asset-3d/robot.glb',
|
||||
videoFilePath: '/tmp/turntable.mp4',
|
||||
viewsKey: 'files/asset-3d/views.webp',
|
||||
})
|
||||
|
||||
expect(mockActivities.updateAssetMediaActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
assetId: 'asset-3d',
|
||||
mediaInfo: expect.objectContaining({
|
||||
proxyType: '3d',
|
||||
duration: 4,
|
||||
frames: 24,
|
||||
poster: { key: 'files/asset-3d/poster.webp' },
|
||||
sprite: expect.objectContaining({ key: 'files/asset-3d/sprite.webp' }),
|
||||
imageTranscodes: [
|
||||
{
|
||||
key: 'files/asset-3d/views.webp',
|
||||
width: 2880,
|
||||
height: 2880,
|
||||
quality: 85,
|
||||
format: 'webp',
|
||||
},
|
||||
],
|
||||
}),
|
||||
}),
|
||||
)
|
||||
|
||||
expect(mockActivities.updateAssetStatusActivity).toHaveBeenCalledWith({
|
||||
assetId: 'asset-3d',
|
||||
status: AssetStatus.processed,
|
||||
})
|
||||
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
taskId: 'task-3d',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
}),
|
||||
)
|
||||
|
||||
expect(mockActivities.cleanupTmpDirActivity).toHaveBeenCalledWith({
|
||||
tmpDir: '/tmp',
|
||||
})
|
||||
})
|
||||
|
||||
it('should fail task when render activity fails', async () => {
|
||||
const task: WorkflowTask = {
|
||||
id: 'task-3d-fail',
|
||||
assetId: 'asset-3d-fail',
|
||||
type: WorkflowTaskType.transcode_3d,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
sessionId: null,
|
||||
output: null,
|
||||
payload: {
|
||||
projectId: 'proj-1',
|
||||
},
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
heartbeat: null,
|
||||
teamId: 'team-1',
|
||||
projectId: 'proj-1',
|
||||
uid: 'task-uid-3d-fail',
|
||||
model: null,
|
||||
inputTokens: 0,
|
||||
outputTokens: 0,
|
||||
}
|
||||
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'asset-3d-fail',
|
||||
name: 'corrupt.glb',
|
||||
storageKey: { key: 'files/corrupt.glb' },
|
||||
mediaType: 'model/gltf-binary',
|
||||
sizeByte: BigInt(512),
|
||||
})
|
||||
|
||||
mockActivities.start3dRenderActivity.mockRejectedValue(new Error('Renderer crashed'))
|
||||
|
||||
await expect(transcode3dWorkflow(task)).rejects.toThrow('Renderer crashed')
|
||||
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
taskId: 'task-3d-fail',
|
||||
status: WorkflowTaskStatus.failed,
|
||||
}),
|
||||
)
|
||||
expect(mockActivities.updateAssetStatusActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
assetId: 'asset-3d-fail',
|
||||
status: AssetStatus.failed,
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,191 @@
|
||||
import type { WorkflowTask } from '@shumai/db'
|
||||
import '@shumai/db/src/prisma-json-types'
|
||||
import { executeActivity, getActivities } from '@shumai/workflow-core'
|
||||
import {
|
||||
getWorkerQueueAndStartTask,
|
||||
fetchAssetWithKey,
|
||||
completeTask,
|
||||
failTask,
|
||||
cleanupTmpDir,
|
||||
} from './common'
|
||||
|
||||
export async function transcode3dWorkflow(task: WorkflowTask): Promise<void> {
|
||||
let tmpDir: string | undefined
|
||||
let workerQueue = ''
|
||||
let mediaProcessed = false
|
||||
|
||||
try {
|
||||
workerQueue = await getWorkerQueueAndStartTask(task)
|
||||
|
||||
const {
|
||||
updateAssetStatusActivity,
|
||||
downloadMediaToTmpActivity,
|
||||
start3dRenderActivity,
|
||||
waitFor3dVideoRenderActivity,
|
||||
generate3dSpriteActivity,
|
||||
generate3dViewsActivity,
|
||||
updateAssetMediaActivity,
|
||||
createEmbeddingTaskIfEnabledActivity,
|
||||
createAutofillTaskIfEnabledActivity,
|
||||
} = getActivities()
|
||||
|
||||
await executeActivity(workerQueue, updateAssetStatusActivity, {
|
||||
assetId: task.assetId,
|
||||
status: 'processing',
|
||||
})
|
||||
|
||||
const { asset, key } = await fetchAssetWithKey(workerQueue, task.assetId)
|
||||
|
||||
const download = await executeActivity(workerQueue, downloadMediaToTmpActivity, {
|
||||
assetKey: key,
|
||||
})
|
||||
const currentFilePath = download.filePath
|
||||
tmpDir = download.tmpDir
|
||||
|
||||
const lastSlashIndex = key.lastIndexOf('/')
|
||||
const assetDir = lastSlashIndex === -1 ? '' : key.substring(0, lastSlashIndex)
|
||||
const videoKey = assetDir ? `${assetDir}/turntable.mp4` : 'turntable.mp4'
|
||||
const posterKey = assetDir ? `${assetDir}/poster.webp` : 'poster.webp'
|
||||
const spriteKey = assetDir ? `${assetDir}/sprite.webp` : 'sprite.webp'
|
||||
const viewsKey = assetDir ? `${assetDir}/views.webp` : 'views.webp'
|
||||
|
||||
const renderStart = await executeActivity(workerQueue, start3dRenderActivity, {
|
||||
taskId: task.id,
|
||||
teamId: task.teamId,
|
||||
assetId: asset.id,
|
||||
assetKey: key,
|
||||
filePath: currentFilePath,
|
||||
filename: asset.name || 'model.glb',
|
||||
targetPosterKey: posterKey,
|
||||
})
|
||||
|
||||
const posterWidth = renderStart.posterWidth || 1080
|
||||
const posterHeight = renderStart.posterHeight || 1080
|
||||
|
||||
const mediaInfo: PrismaJson.MediaInfo = {
|
||||
duration: 4,
|
||||
filesize: 0,
|
||||
frames: 24,
|
||||
proxyType: '3d',
|
||||
imageTranscodes: [],
|
||||
videoTranscodes: [],
|
||||
poster: {
|
||||
key: posterKey,
|
||||
},
|
||||
finishedAt: new Date().toISOString(),
|
||||
metadata: {
|
||||
originalHeight: posterHeight,
|
||||
originalWidth: posterWidth,
|
||||
hasAudio: false,
|
||||
duration: 4,
|
||||
bitRate: 0,
|
||||
frameRate: 6,
|
||||
totalFrames: 24,
|
||||
startTimecode: '00:00:00:00',
|
||||
format: renderStart.modelMetadata ?? {},
|
||||
},
|
||||
original: {
|
||||
key,
|
||||
filesizeInBytes: Number(asset.sizeByte || 0),
|
||||
codec: '',
|
||||
},
|
||||
}
|
||||
|
||||
await executeActivity(workerQueue, updateAssetMediaActivity, {
|
||||
assetId: asset.id,
|
||||
mediaInfo,
|
||||
})
|
||||
|
||||
const renderVideo = await executeActivity(workerQueue, waitFor3dVideoRenderActivity, {
|
||||
taskId: task.id,
|
||||
teamId: task.teamId,
|
||||
assetKey: key,
|
||||
renderTaskId: renderStart.renderTaskId,
|
||||
targetVideoKey: videoKey,
|
||||
tmpDir,
|
||||
})
|
||||
|
||||
await executeActivity(workerQueue, generate3dSpriteActivity, {
|
||||
taskId: task.id,
|
||||
assetKey: key,
|
||||
videoFilePath: renderVideo.videoFilePath,
|
||||
spriteKey,
|
||||
})
|
||||
|
||||
mediaInfo.sprite = {
|
||||
key: spriteKey,
|
||||
frames: 100,
|
||||
tileX: 10,
|
||||
tileY: 10,
|
||||
}
|
||||
|
||||
await executeActivity(workerQueue, generate3dViewsActivity, {
|
||||
taskId: task.id,
|
||||
assetKey: key,
|
||||
videoFilePath: renderVideo.videoFilePath,
|
||||
viewsKey,
|
||||
})
|
||||
|
||||
mediaInfo.imageTranscodes = [
|
||||
{
|
||||
key: viewsKey,
|
||||
width: 2880,
|
||||
height: 2880,
|
||||
quality: 85,
|
||||
format: 'webp',
|
||||
},
|
||||
]
|
||||
|
||||
await executeActivity(workerQueue, updateAssetMediaActivity, {
|
||||
assetId: asset.id,
|
||||
mediaInfo,
|
||||
})
|
||||
|
||||
mediaInfo.videoTranscodes = [
|
||||
{
|
||||
key: videoKey,
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
},
|
||||
]
|
||||
mediaInfo.videoPreview = {
|
||||
key: videoKey,
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
}
|
||||
mediaInfo.finishedAt = new Date().toISOString()
|
||||
|
||||
await executeActivity(workerQueue, updateAssetMediaActivity, {
|
||||
assetId: asset.id,
|
||||
mediaInfo,
|
||||
})
|
||||
|
||||
await executeActivity(workerQueue, updateAssetStatusActivity, {
|
||||
assetId: asset.id,
|
||||
status: 'processed',
|
||||
})
|
||||
mediaProcessed = true
|
||||
|
||||
await executeActivity(workerQueue, createEmbeddingTaskIfEnabledActivity, {
|
||||
assetId: asset.id,
|
||||
teamId: task.teamId,
|
||||
projectId: task.projectId,
|
||||
})
|
||||
|
||||
await executeActivity(workerQueue, createAutofillTaskIfEnabledActivity, {
|
||||
assetId: asset.id,
|
||||
teamId: task.teamId,
|
||||
projectId: task.projectId,
|
||||
})
|
||||
|
||||
await completeTask(workerQueue, task.id)
|
||||
} catch (err) {
|
||||
console.error(`transcode3dWorkflow failed for task ${task.id}:`, err)
|
||||
await failTask(workerQueue, task.id, err, mediaProcessed ? undefined : task.assetId)
|
||||
throw err
|
||||
} finally {
|
||||
await cleanupTmpDir(workerQueue, tmpDir)
|
||||
}
|
||||
}
|
||||
@@ -42,6 +42,7 @@ export async function transcodePdfWorkflow(task: WorkflowTask): Promise<void> {
|
||||
tmpDir = download.tmpDir
|
||||
|
||||
const pdfProxy = await executeActivity(workerQueue, generatePdfProxyActivity, {
|
||||
teamId: task.teamId,
|
||||
assetId: asset.id,
|
||||
assetKey: key,
|
||||
filePath: currentFilePath,
|
||||
|
||||
@@ -47,5 +47,6 @@ export * from './render-pdf-pages'
|
||||
export * from './take-video-screenshots'
|
||||
export * from './overlay-image-annotation'
|
||||
export * from './transcode-watermark'
|
||||
export * from './transcode-3d'
|
||||
export * from './common'
|
||||
export * from './transcode-utils'
|
||||
|
||||
@@ -263,4 +263,45 @@ describe('BreadcrumbNav component', () => {
|
||||
expect(items.some((i) => i.textContent?.includes('1080p'))).toBe(true)
|
||||
expect(items.some((i) => i.textContent?.includes('1920p'))).toBe(false)
|
||||
})
|
||||
|
||||
it('correctly labels 1080p square / 3D turntable transcode in download menu', () => {
|
||||
render(
|
||||
<QueryClientProvider client={queryClient}>
|
||||
<BreadcrumbNav
|
||||
{...baseProps}
|
||||
fileId="file-3d"
|
||||
currentAsset={{
|
||||
id: 'file-3d',
|
||||
name: 'model.glb',
|
||||
type: 'file',
|
||||
version: 1,
|
||||
proxyType: '3d',
|
||||
}}
|
||||
allowDownload={true}
|
||||
downloadInfo={{
|
||||
originalKey: 'model.glb',
|
||||
videoTranscodes: [
|
||||
{
|
||||
key: 'turntable-1080p.mp4',
|
||||
width: 1080,
|
||||
height: 1080,
|
||||
resolution: '1080p',
|
||||
hdr: false,
|
||||
},
|
||||
],
|
||||
}}
|
||||
/>
|
||||
</QueryClientProvider>,
|
||||
)
|
||||
|
||||
const triggerButton = screen.getByRole('button', { name: 'model.glb' })
|
||||
fireEvent.pointerDown(triggerButton, { button: 0, ctrlKey: false })
|
||||
|
||||
const downloadSubTrigger = screen.getByText('Download')
|
||||
fireEvent.click(downloadSubTrigger)
|
||||
|
||||
const items = screen.getAllByRole('menuitem')
|
||||
expect(items.some((i) => i.textContent?.includes('1080p'))).toBe(true)
|
||||
expect(items.some((i) => i.textContent?.includes('480p'))).toBe(false)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -60,7 +60,7 @@ interface BreadcrumbNavProps {
|
||||
name?: string
|
||||
type: 'file' | 'folder'
|
||||
version?: number
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | '3d' | null
|
||||
}
|
||||
isRootFolder: boolean
|
||||
customTerminalBreadcrumb?: string
|
||||
|
||||
@@ -4,10 +4,10 @@ import { formatTime } from '../viewers/video/utils'
|
||||
|
||||
type FilePreviewItem = {
|
||||
type?: string | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | '3d' | null
|
||||
preview?: {
|
||||
mediaType?: string | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | null
|
||||
proxyType?: 'image' | 'video' | 'audio' | 'pdf' | '3d' | null
|
||||
spriteUrl?: string
|
||||
thumbnailUrl?: string
|
||||
originalWidth?: number
|
||||
@@ -27,6 +27,7 @@ export const FilePreview = ({ item, showDuration = false }: FilePreviewProps) =>
|
||||
const isVideo = proxyType === 'video'
|
||||
const isAudio = proxyType === 'audio'
|
||||
const isPdf = proxyType === 'pdf'
|
||||
const is3D = proxyType === '3d'
|
||||
const hasDuration = isVideo || isAudio
|
||||
const duration = item.preview?.duration
|
||||
const pageCount = item.preview?.pageCount
|
||||
@@ -43,7 +44,7 @@ export const FilePreview = ({ item, showDuration = false }: FilePreviewProps) =>
|
||||
) : null
|
||||
|
||||
const isMediaWithSprite =
|
||||
(isVideo || isPdf) &&
|
||||
(isVideo || isPdf || is3D) &&
|
||||
item.preview?.spriteUrl &&
|
||||
item.preview.thumbnailUrl &&
|
||||
item.preview.originalWidth &&
|
||||
@@ -57,6 +58,7 @@ export const FilePreview = ({ item, showDuration = false }: FilePreviewProps) =>
|
||||
thumbnailUrl={item.preview.thumbnailUrl!}
|
||||
videoWidth={item.preview.originalWidth!}
|
||||
videoHeight={item.preview.originalHeight!}
|
||||
reverse={is3D}
|
||||
/>
|
||||
{overlay}
|
||||
</>
|
||||
|
||||
@@ -12,6 +12,7 @@ export function FileViewer({
|
||||
onPlay,
|
||||
onPause,
|
||||
onTimeUpdate,
|
||||
onSeek,
|
||||
annotations,
|
||||
startTime,
|
||||
shareId,
|
||||
@@ -30,6 +31,7 @@ export function FileViewer({
|
||||
onPlay={onPlay}
|
||||
onPause={onPause}
|
||||
onTimeUpdate={onTimeUpdate}
|
||||
onSeek={onSeek}
|
||||
annotations={annotations}
|
||||
startTime={startTime}
|
||||
shareId={shareId}
|
||||
|
||||
@@ -156,6 +156,11 @@ export function MobileFileDetail({
|
||||
setSelectedCommentId(null)
|
||||
}
|
||||
|
||||
const handleSeek = () => {
|
||||
setAnnotations([])
|
||||
setSelectedCommentId(null)
|
||||
}
|
||||
|
||||
const handleCommentSelect = (comment: CommentInfo) => {
|
||||
setSelectedCommentId(comment.id || null)
|
||||
const newAnnotations = comment.annotations as Annotation[]
|
||||
@@ -238,6 +243,7 @@ export function MobileFileDetail({
|
||||
mediaControllerRef={mediaControllerRef}
|
||||
onPlay={handlePlay}
|
||||
onTimeUpdate={setCurrentTime}
|
||||
onSeek={handleSeek}
|
||||
annotations={annotations}
|
||||
startTime={startTime}
|
||||
shareId={shareId}
|
||||
|
||||
@@ -445,6 +445,7 @@ export function TaskInfoForm({ teamId, task, canEdit = true }: TaskInfoFormProps
|
||||
onAddAssets={(newAssets) => linkAssets(newAssets)}
|
||||
onRemoveAsset={(assetId) => unlinkAsset(assetId)}
|
||||
disabled={!canEdit}
|
||||
linkable
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -59,6 +59,15 @@ vi.mock('@dnd-kit/react', () => ({
|
||||
KeyboardSensor: {},
|
||||
}))
|
||||
|
||||
// Mock TanStack Router Link as a plain anchor
|
||||
vi.mock('@tanstack/react-router', () => ({
|
||||
Link: ({ children, to, ...props }: { children: React.ReactNode; to: string }) => (
|
||||
<a href={to} {...props}>
|
||||
{children}
|
||||
</a>
|
||||
),
|
||||
}))
|
||||
|
||||
// Mock @dnd-kit/dom
|
||||
vi.mock('@dnd-kit/dom', () => ({
|
||||
PointerActivationConstraints: {
|
||||
@@ -690,6 +699,58 @@ describe('Kanban UI Unit & Component Tests', () => {
|
||||
fireEvent.click(removeButtons[0])
|
||||
expect(onRemove).toHaveBeenCalledWith('asset-1')
|
||||
})
|
||||
|
||||
it('does not link asset rows by default', () => {
|
||||
render(
|
||||
<TaskRelatedAssets
|
||||
teamId="team-1"
|
||||
assets={mockAssets}
|
||||
onAddAssets={vi.fn()}
|
||||
onRemoveAsset={vi.fn()}
|
||||
/>,
|
||||
)
|
||||
|
||||
expect(screen.queryAllByRole('link')).toHaveLength(0)
|
||||
})
|
||||
|
||||
it('links files and folders to their project when linkable', () => {
|
||||
const onRemove = vi.fn()
|
||||
render(
|
||||
<TaskRelatedAssets
|
||||
teamId="team-1"
|
||||
projectId="task-proj"
|
||||
assets={[...mockAssets, { ...mockAssets[0], id: 'asset-3', projectId: null }]}
|
||||
onAddAssets={vi.fn()}
|
||||
onRemoveAsset={onRemove}
|
||||
linkable
|
||||
/>,
|
||||
)
|
||||
|
||||
const links = screen.getAllByRole('link')
|
||||
expect(links.map((link) => link.getAttribute('href'))).toEqual([
|
||||
'/projects/proj-1/files/asset-1',
|
||||
'/projects/proj-1/folders/asset-2',
|
||||
// Falls back to the task's project when the asset has none
|
||||
'/projects/task-proj/files/asset-3',
|
||||
])
|
||||
// The remove button stays outside the link
|
||||
fireEvent.click(screen.getAllByTitle(/Unlink Asset|取消关联资产/i)[1])
|
||||
expect(onRemove).toHaveBeenCalledWith('asset-2')
|
||||
})
|
||||
|
||||
it('does not link assets when no project is known', () => {
|
||||
render(
|
||||
<TaskRelatedAssets
|
||||
teamId="team-1"
|
||||
assets={[{ ...mockAssets[0], projectId: null }]}
|
||||
onAddAssets={vi.fn()}
|
||||
onRemoveAsset={vi.fn()}
|
||||
linkable
|
||||
/>,
|
||||
)
|
||||
|
||||
expect(screen.queryAllByRole('link')).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe('KanbanGoalSidebar component', () => {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { useState } from 'react'
|
||||
import { Link } from '@tanstack/react-router'
|
||||
import { Button } from '@/ui/components/ui/button'
|
||||
import { Separator } from '@/ui/components/ui/separator'
|
||||
import { Avatar, AvatarFallback, AvatarImage } from '@/ui/components/ui/avatar'
|
||||
@@ -6,6 +7,7 @@ import { m } from '@/ui/paraglide/messages.js'
|
||||
import type { KanbanTaskAssetInfo } from '@shumai/dtos'
|
||||
import { AssetPickerDialog } from './asset-picker-dialog'
|
||||
import { Plus, X, Folder, File, Files } from 'lucide-react'
|
||||
import { cn } from '@/ui/lib/utils'
|
||||
|
||||
interface TaskRelatedAssetsProps {
|
||||
teamId: string
|
||||
@@ -14,6 +16,8 @@ interface TaskRelatedAssetsProps {
|
||||
onAddAssets: (newAssets: KanbanTaskAssetInfo[]) => void
|
||||
onRemoveAsset: (assetId: string) => void
|
||||
disabled?: boolean
|
||||
/** Make each row a link to the asset in its project. Off by default so unsaved drafts are not discarded. */
|
||||
linkable?: boolean
|
||||
}
|
||||
|
||||
export function TaskRelatedAssets({
|
||||
@@ -23,6 +27,7 @@ export function TaskRelatedAssets({
|
||||
onAddAssets,
|
||||
onRemoveAsset,
|
||||
disabled = false,
|
||||
linkable = false,
|
||||
}: TaskRelatedAssetsProps) {
|
||||
const [isPickerOpen, setIsPickerOpen] = useState(false)
|
||||
|
||||
@@ -69,39 +74,62 @@ export function TaskRelatedAssets({
|
||||
<div className="space-y-1.5 max-h-48 overflow-y-auto pr-1">
|
||||
{assets.map((asset) => {
|
||||
const isFolder = asset.type === 'folder'
|
||||
const assetProjectId = asset.projectId || projectId
|
||||
const assetHref =
|
||||
linkable && assetProjectId
|
||||
? `/projects/${assetProjectId}/${isFolder ? 'folders' : 'files'}/${asset.id}`
|
||||
: null
|
||||
const body = (
|
||||
<>
|
||||
{/* Thumbnail / Icon */}
|
||||
<div className="w-7 h-7 rounded bg-muted border shrink-0 flex items-center justify-center overflow-hidden">
|
||||
{asset.thumbnailUrl ? (
|
||||
<img
|
||||
src={asset.thumbnailUrl}
|
||||
alt={asset.name}
|
||||
className="w-full h-full object-cover"
|
||||
/>
|
||||
) : isFolder ? (
|
||||
<Folder className="w-4 h-4 text-primary fill-primary/20" />
|
||||
) : (
|
||||
<File className="w-4 h-4 text-muted-foreground" />
|
||||
)}
|
||||
</div>
|
||||
|
||||
{/* Name & Path */}
|
||||
<div className="flex-1 min-w-0">
|
||||
<p
|
||||
className={cn(
|
||||
'font-medium truncate text-foreground leading-snug',
|
||||
assetHref && 'group-hover:underline group-hover:text-primary',
|
||||
)}
|
||||
>
|
||||
{asset.name}
|
||||
</p>
|
||||
<p className="text-[10px] text-muted-foreground truncate leading-none mt-0.5">
|
||||
{asset.path || '/'}
|
||||
</p>
|
||||
</div>
|
||||
</>
|
||||
)
|
||||
|
||||
return (
|
||||
<div
|
||||
key={asset.id}
|
||||
className="flex items-center justify-between gap-2 p-1.5 px-2 rounded-md bg-muted/40 hover:bg-muted/70 transition-colors text-xs border border-border/40"
|
||||
>
|
||||
{/* Left: Thumbnail & Names */}
|
||||
<div className="flex items-center gap-2.5 min-w-0 flex-1">
|
||||
{/* Thumbnail / Icon */}
|
||||
<div className="w-7 h-7 rounded bg-muted border shrink-0 flex items-center justify-center overflow-hidden">
|
||||
{asset.thumbnailUrl ? (
|
||||
<img
|
||||
src={asset.thumbnailUrl}
|
||||
alt={asset.name}
|
||||
className="w-full h-full object-cover"
|
||||
/>
|
||||
) : isFolder ? (
|
||||
<Folder className="w-4 h-4 text-primary fill-primary/20" />
|
||||
) : (
|
||||
<File className="w-4 h-4 text-muted-foreground" />
|
||||
)}
|
||||
</div>
|
||||
|
||||
{/* Name & Path */}
|
||||
<div className="flex-1 min-w-0">
|
||||
<p className="font-medium truncate text-foreground leading-snug">
|
||||
{asset.name}
|
||||
</p>
|
||||
<p className="text-[10px] text-muted-foreground truncate leading-none mt-0.5">
|
||||
{asset.path || '/'}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
{/* Left: Thumbnail & Names (links to the asset when linkable) */}
|
||||
{assetHref ? (
|
||||
<Link
|
||||
to={assetHref}
|
||||
title={asset.name}
|
||||
className="group flex items-center gap-2.5 min-w-0 flex-1 rounded-sm cursor-pointer focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
|
||||
>
|
||||
{body}
|
||||
</Link>
|
||||
) : (
|
||||
<div className="flex items-center gap-2.5 min-w-0 flex-1">{body}</div>
|
||||
)}
|
||||
|
||||
{/* Right: Creator & Remove Button */}
|
||||
<div className="flex items-center gap-2 shrink-0">
|
||||
|
||||
@@ -136,14 +136,14 @@ export const NotificationCard = ({ notification }: NotificationCardProps) => {
|
||||
|
||||
const hasPreview = asset?.preview && (asset.proxyType === 'image' || asset.proxyType === 'video')
|
||||
|
||||
const handleClick = () => {
|
||||
const handleClick = () => {
|
||||
if (kanbanTask?.id && team?.id) {
|
||||
navigate({
|
||||
to: '/teams/$teamId/kanban',
|
||||
params: { teamId: team.id },
|
||||
search: { taskId: kanbanTask.id },
|
||||
})
|
||||
}else if(project?.id && asset?.id){
|
||||
} else if (project?.id && asset?.id) {
|
||||
//TODO: Perhaps it should be marked as read too when redirecting to it.
|
||||
navigate({
|
||||
to: '/projects/$projectId/files/$fileId',
|
||||
|
||||
@@ -385,6 +385,11 @@ export function PublicShareManager({
|
||||
setSelectedCommentId(null)
|
||||
}
|
||||
|
||||
const handleSeek = () => {
|
||||
setAnnotations([])
|
||||
setSelectedCommentId(null)
|
||||
}
|
||||
|
||||
const updateCompareSearch = (patch: Record<string, unknown>) => {
|
||||
if (!viewingFileId) return
|
||||
navigate({
|
||||
@@ -656,6 +661,7 @@ export function PublicShareManager({
|
||||
mediaControllerRef={mediaControllerRef}
|
||||
onPlay={handlePlay}
|
||||
onTimeUpdate={setCurrentTime}
|
||||
onSeek={handleSeek}
|
||||
annotations={annotations}
|
||||
startTime={startTime}
|
||||
shareId={shareId}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user