mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-20 04:47:37 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
62e86b703e | ||
|
|
6c87db0581 | ||
|
|
bc85dc4541 | ||
|
|
659a0af2c5 | ||
|
|
54d2c407b5 | ||
|
|
8e31d05f8a | ||
|
|
8c1e59d131 | ||
|
|
b087bf73ae | ||
|
|
a49722d5c7 | ||
|
|
576d8ebe64 | ||
|
|
ffc1889cdc | ||
|
|
6285ff8618 | ||
|
|
1e60933cdb | ||
|
|
dd0ea05a88 | ||
|
|
52330869a2 | ||
|
|
0c561e9b39 | ||
|
|
a236cd3a97 | ||
|
|
c3ef769f51 | ||
|
|
e58dfaa71a | ||
|
|
35b57cc0ab | ||
|
|
5a754bcb94 | ||
|
|
64b68e7d63 | ||
|
|
c2f477a391 | ||
|
|
9263971653 | ||
|
|
79a479c87c | ||
|
|
134eb8b7fa | ||
|
|
e06478df88 | ||
|
|
6e9cf8dfb6 | ||
|
|
d2620f6911 | ||
|
|
4537baa6a2 | ||
|
|
810e0c4cf5 | ||
|
|
07cb648183 | ||
|
|
c6602c9f1c | ||
|
|
86032539ed | ||
|
|
b2ec012e10 | ||
|
|
7fd8623684 | ||
|
|
083753a96d | ||
|
|
4b62c31f29 | ||
|
|
2208d4e0e0 | ||
|
|
df7f4c3c2d | ||
|
|
12323e1416 | ||
|
|
2edc5e1071 | ||
|
|
2162ed9ebe | ||
|
|
6acebb73ec | ||
|
|
7a1d6c0ab5 | ||
|
|
d16e31c0e5 | ||
|
|
d9a8b6a191 | ||
|
|
5ec4cd7fcd | ||
|
|
a7925e3c79 | ||
|
|
472b420620 | ||
|
|
8f55ba1d37 | ||
|
|
7b1428bf51 | ||
|
|
d5b3b1868e | ||
|
|
49f3fc0be5 | ||
|
|
59e641ccb3 | ||
|
|
1d9268b224 | ||
|
|
470a4bd6f7 | ||
|
|
8801d59b2e | ||
|
|
6a20e06982 | ||
|
|
b17abce2c2 | ||
|
|
f67e334016 | ||
|
|
c1de66520e | ||
|
|
37e086d822 | ||
|
|
d21f8ca8de | ||
|
|
6af4e7c2ec | ||
|
|
1f2bdc8c9e |
+2
-1
@@ -14,4 +14,5 @@ helm-charts
|
||||
.env
|
||||
.editorconfig
|
||||
.idea
|
||||
coverage*
|
||||
coverage*
|
||||
packages/webui/paraglide
|
||||
@@ -22,9 +22,9 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v1
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
bun-version: 1.4.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
@@ -34,6 +34,9 @@ jobs:
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
|
||||
|
||||
- name: Compile i18n
|
||||
run: bun run i18n:compile
|
||||
|
||||
- name: Lint
|
||||
run: bun run lint
|
||||
|
||||
@@ -76,13 +79,16 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v1
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
bun-version: 1.4.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
|
||||
- name: Compile i18n
|
||||
run: bun run i18n:compile
|
||||
|
||||
- name: Install Playwright browser (${{ matrix.project }})
|
||||
run: bunx playwright install --with-deps ${{ matrix.project }}
|
||||
|
||||
@@ -118,9 +124,9 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v1
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
bun-version: 1.4.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
@@ -130,6 +136,9 @@ jobs:
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
|
||||
|
||||
- name: Compile i18n
|
||||
run: bun run i18n:compile
|
||||
|
||||
- name: Install Playwright browser (${{ matrix.project }})
|
||||
run: bunx playwright install --with-deps ${{ matrix.project }}
|
||||
|
||||
@@ -152,9 +161,9 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v1
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
bun-version: 1.4.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
|
||||
@@ -36,7 +36,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
bun-version: 1.4.2
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v6
|
||||
@@ -53,6 +53,9 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
|
||||
- name: Compile i18n
|
||||
run: bun run i18n:compile
|
||||
|
||||
- name: Lint
|
||||
run: bun run lint
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ data/
|
||||
*.db
|
||||
*.diff
|
||||
*.orig
|
||||
code_quality.md
|
||||
.agents
|
||||
|
||||
# Playwright
|
||||
@@ -18,3 +19,7 @@ data/
|
||||
/test-results/
|
||||
/blob-report/
|
||||
/playwright/.cache/
|
||||
|
||||
# Paraglide JS
|
||||
packages/webui/paraglide
|
||||
|
||||
|
||||
+10
-2
@@ -1,6 +1,6 @@
|
||||
#syntax=docker/dockerfile:1.7-labs
|
||||
# Stage 1: Builder
|
||||
FROM oven/bun:1 AS builder
|
||||
FROM oven/bun:1.4.2 AS builder
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
@@ -18,6 +18,9 @@ RUN ls -la packages/transcode/node_modules
|
||||
# Copy source code
|
||||
COPY . .
|
||||
|
||||
# Compile i18n
|
||||
RUN bun run i18n:compile
|
||||
|
||||
# Build API and Worker
|
||||
RUN bun run build.ts
|
||||
|
||||
@@ -25,7 +28,7 @@ RUN bun run build.ts
|
||||
RUN bun run scripts/extract-runtime-deps.ts
|
||||
|
||||
# Stage 2: Runner
|
||||
FROM oven/bun:1 AS runner
|
||||
FROM oven/bun:1.4.2 AS runner
|
||||
|
||||
# Install ffmpeg/ffprobe
|
||||
COPY --from=mwader/static-ffmpeg:8.1 /ffmpeg /usr/local/bin/
|
||||
@@ -80,6 +83,11 @@ USER root
|
||||
COPY scripts/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
|
||||
RUN chmod +x /usr/local/bin/docker-entrypoint.sh
|
||||
|
||||
# Expose "bun index.js" as "shumai" CLI command (and alias "shuami")
|
||||
RUN printf '#!/bin/sh\nexec bun /app/index.js "$@"\n' > /usr/local/bin/shumai \
|
||||
&& chmod +x /usr/local/bin/shumai \
|
||||
&& ln -s /usr/local/bin/shumai /usr/local/bin/shuami
|
||||
|
||||
ENTRYPOINT ["docker-entrypoint.sh"]
|
||||
|
||||
# Default command: run migrations and start API server
|
||||
|
||||
@@ -9,7 +9,14 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a target="_blank" href="https://shumai.one/">Website</a> | <a target="_blank" href="https://docs.shumai.one/introduction">Docs</a> | <a target="_blank" href="https://staging.shumai.one">Demo</a> | <a target="_blank" href="https://discord.gg/sUzhujK6DD">Discord</a> | <a target="_blank" href="README_CN.md">中文</a>
|
||||
<a href="https://hub.docker.com/r/shumaione/shumai"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/shumaione/shumai" /></a>
|
||||
<a href="https://github.com/shumaiOne/shumai/releases"><img alt="GitHub latest release" src="https://img.shields.io/github/v/release/shumaiOne/shumai" /></a>
|
||||
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
|
||||
<a target="_blank" href="https://deepwiki.com/shumaiOne/shumai"><img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg" /></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a target="_blank" href="https://shumai.one/">Website</a> | <a target="_blank" href="https://docs.shumai.one/getting-started/overview">Docs</a> | <a target="_blank" href="https://staging.shumai.one">Demo</a> | <a target="_blank" href="https://discord.gg/sUzhujK6DD">Discord</a> | <a target="_blank" href="README_CN.md">中文</a>
|
||||
</p>
|
||||
|
||||

|
||||
@@ -45,6 +52,12 @@ Here is a short demo video showing what the Shumai agent can do:
|
||||
|
||||
https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
|
||||
|
||||
Shumai also brings project management into the creative workflow. A built-in Kanban board helps teams organize tasks, track progress, and collaborate in one place.
|
||||
|
||||
The ultimate goal is an **agentic Kanban**, where agents and team members can work together on tasks. This is still a **work in progress**: you can already create tasks for AI agents, but agents cannot act on those tasks yet.
|
||||
|
||||
<img width="2880" height="2160" alt="localhost_3000_teams_01M0HQR3EEBS0B46K4FK39X2C8_kanban(1080p-2) (1)" src="https://github.com/user-attachments/assets/cd0648d0-c69a-4398-958b-8d15a33378b0" />
|
||||
|
||||
|
||||
|
||||
> [!NOTE]
|
||||
@@ -302,11 +315,17 @@ To set up Shumai locally for development:
|
||||
```
|
||||
2. Start the `pgvector` database container (as described in **Option 2, Step 1**).
|
||||
3. Create a `.env` file at the root of the workspace using the configuration from **Option 2, Step 5**.
|
||||
4. Apply the database schema migrations:
|
||||
4. Generate i18n translation files:
|
||||
```bash
|
||||
bun run i18n:compile
|
||||
```
|
||||
> [!TIP]
|
||||
> During frontend development, you can run `bun run i18n:watch` in a separate terminal to automatically recompile translation files whenever you edit strings in `packages/webui/messages/`.
|
||||
5. Apply the database schema migrations:
|
||||
```bash
|
||||
bun run db:migrate
|
||||
```
|
||||
5. Start the local development server:
|
||||
6. Start the local development server:
|
||||
```bash
|
||||
bun run dev
|
||||
```
|
||||
|
||||
+41
-7
@@ -9,8 +9,14 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a target="_blank" href="https://shumai.one/">官方网站</a> | <a target="_blank" href="https://docs.shumai.one/introduction">文档</a> | <a target="_blank" href="https://staging.shumai.one">在线演示</a> | <a target="_blank" href="README.md">English</a>
|
||||
<a href="https://hub.docker.com/r/shumaione/shumai"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/shumaione/shumai" /></a>
|
||||
<a href="https://github.com/shumaiOne/shumai/releases"><img alt="GitHub latest release" src="https://img.shields.io/github/v/release/shumaiOne/shumai" /></a>
|
||||
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
|
||||
<a target="_blank" href="https://deepwiki.com/shumaiOne/shumai"><img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg" /></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a target="_blank" href="https://shumai.one/">官方网站</a> | <a target="_blank" href="https://docs.shumai.one/getting-started/overview">文档</a> | <a target="_blank" href="https://staging.shumai.one">在线演示</a> | <a target="_blank" href="README.md">English</a>
|
||||
</p>
|
||||
|
||||

|
||||
@@ -44,6 +50,13 @@ Shumai 是一个开源的 Frame.io 替代方案,专为创意团队打造,让
|
||||
|
||||
https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
|
||||
|
||||
Shumai 也将项目管理融入了创意工作流程。 内置的看板可以帮助团队整理任务以及跟踪进度。
|
||||
|
||||
最终目标是打造一个 Agentic看板,让 Agent 和团队成员能够围绕同一个目标协同工作。目前这一功能仍在开发中: 你已经可以在看板中为 Agent 创建任务,但 Agent 目前还无法自动执行这些任务。
|
||||
|
||||
<img width="2880" height="2160" alt="localhost_3000_teams_01M0HQR3EEBS0B46K4FK39X2C8_kanban(1080p-2) (1)" src="https://github.com/user-attachments/assets/29ff1db1-2d65-4e3c-b467-754b777b406f" />
|
||||
|
||||
|
||||
> [!NOTE]
|
||||
> **媒体处理与存储机制:** 上传媒体文件后,Shumai 始终会保留并存储原始文件。请注意,系统中显示的文件大小为原始文件的大小,不包含转码后生成的代理文件大小。无论图片还是视频,都会额外生成一张 300p 的 WebP 封面图,作为文件列表中的预览图。此外:
|
||||
>
|
||||
@@ -57,6 +70,24 @@ https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
|
||||
以下是使用本地存储运行 Shumai 的快速上手指南。如需了解高级配置(包括 S3 兼容存储配置、Temporal 工作流编排等),请参阅我们的[官方文档](https://docs.shumai.one/getting-started/overview)。
|
||||
|
||||
### 方案一:使用 Docker Compose(推荐)
|
||||
<details>
|
||||
|
||||
<summary>复制这个提示词,让agent帮你安装</summary>
|
||||
|
||||
```
|
||||
请帮我在本机使用 Docker Compose 一键部署 Shumai。
|
||||
|
||||
请严格参考官方文档:
|
||||
https://gh-proxy.com/https://raw.githubusercontent.com/shumaiOne/shumai/main/README_CN.md
|
||||
|
||||
要求:
|
||||
|
||||
1. 只能使用 Docker Compose local方式部署,不要使用其他部署方式。
|
||||
2. 部署前请先检查本机是否已安装并可正常使用 Docker 和 Docker Compose。
|
||||
3. 如果本机未安装 Docker,请立即提醒用户先安装 Docker,并停止后续部署操作。不要自行安装 Docker,也不要采用其他方式部署。
|
||||
4. 获取 `docker-compose-aliyun.yaml` 文件内容时,必须通过 `https://gh-proxy.com` 加速访问,不要直接访问 GitHub Raw 地址。
|
||||
```
|
||||
</details>
|
||||
|
||||
使用 Docker Compose 是运行 Shumai 最快的方式。您无需克隆仓库,也不需要手动安装依赖包。请确保电脑上已安装 [Docker](https://docs.docker.com/get-docker/) 和 [Docker Compose](https://docs.docker.com/compose/install/),然后按照以下步骤操作:
|
||||
|
||||
@@ -327,17 +358,20 @@ bun install
|
||||
|
||||
2. 启动 `pgvector` 数据库容器(参考**方案二中的第一步**)。
|
||||
3. 参照**方案二中的第五步**,在项目根目录下创建一个 `.env` 文件。
|
||||
4. 执行数据库结构迁移:
|
||||
4. 生成多语言国际化(i18n)代码:
|
||||
```bash
|
||||
bun run i18n:compile
|
||||
```
|
||||
> [!TIP]
|
||||
> 在前端开发过程中,可以在单独的终端窗口中运行 `bun run i18n:watch`,在修改 `packages/webui/messages/` 下的翻译文案时自动重新编译。
|
||||
|
||||
5. 执行数据库结构迁移:
|
||||
```bash
|
||||
bun run db:migrate
|
||||
|
||||
```
|
||||
|
||||
|
||||
5. 启动本地开发服务器:
|
||||
6. 启动本地开发服务器:
|
||||
```bash
|
||||
bun run dev
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
# Security Policy
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please report security vulnerabilities **privately**. Do not open a public issue,
|
||||
pull request or Discord message for a suspected vulnerability, as that discloses it
|
||||
to everyone before a fix exists.
|
||||
|
||||
Use **[GitHub private vulnerability reporting](https://github.com/shumaiOne/shumai/security/advisories/new)**
|
||||
(the "Report a vulnerability" button on the Security tab). If that is unavailable,
|
||||
contact the maintainer directly rather than in a public channel.
|
||||
|
||||
Please include:
|
||||
|
||||
- What the issue is, and the impact you believe it has
|
||||
- The version or commit you tested (`git rev-parse HEAD`, or the image digest)
|
||||
- Steps to reproduce, ideally minimal
|
||||
- Your deployment shape: storage backend, whether the agent feature is enabled,
|
||||
and whether the instance is internet-reachable
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Shumai is pre-1.0 and moves quickly. Security fixes are made against the **latest
|
||||
release**. Users are encouraged to track releases rather than pin indefinitely.
|
||||
|
||||
## Scope
|
||||
|
||||
**In scope** — the application, its API, the shipped Docker images, and the
|
||||
deployment manifests under `docker-compose/`.
|
||||
|
||||
Deployment manifests are explicitly in scope. A default that is unsafe when
|
||||
followed as documented is a real finding, because the documented quickstart is what
|
||||
most operators actually run.
|
||||
|
||||
**Out of scope**
|
||||
|
||||
- Vulnerabilities in third-party dependencies, unless Shumai's use of them is what
|
||||
creates the exposure. Report those upstream.
|
||||
- Findings that require an already-compromised host or database.
|
||||
- Configurations that deviate from the documented deployment.
|
||||
|
||||
## Operator guidance
|
||||
|
||||
Shumai is self-hosted, so several controls belong to the operator rather than to the
|
||||
project:
|
||||
|
||||
- **Set `BETTER_AUTH_SECRET` per deployment.** It signs sessions and, in local
|
||||
storage mode, upload URLs. Never reuse a value from documentation or an example.
|
||||
- **Do not expose the instance to the public internet without a reverse proxy**
|
||||
terminating TLS and applying your own access policy.
|
||||
- **Do not publish the database port.** Set a real database password.
|
||||
- **Treat the agent feature as a code-execution surface.** If you enable it, run it
|
||||
where a compromise is survivable, and review the sandbox network policy.
|
||||
|
||||
## Disclosure
|
||||
|
||||
Please allow a reasonable period for a fix before public disclosure. The maintainer
|
||||
will acknowledge reports and keep reporters informed of progress.
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/agent-app",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
export * from '@shumai/agent/src/workflows/agent-autofill'
|
||||
export * from '@shumai/agent/src/workflows/agent-chat'
|
||||
export * from '@shumai/agent/src/workflows/agent-embedding'
|
||||
export * from '@shumai/agent/src/workflows/agent-tool-call'
|
||||
export * from '@shumai/agent/src/workflows/query-embedding-for-search'
|
||||
|
||||
@@ -20,6 +20,9 @@ export SHUMAI_API_SERVER="http://localhost:3000"
|
||||
|
||||
# Your personal API Token (Generate this in the WebUI via Settings -> Developer tab)
|
||||
export SHUMAI_API_KEY="your-developer-api-token"
|
||||
|
||||
# Optional: Enable asset deletion capability (disabled by default for safety)
|
||||
export SHUMAI_ALLOW_DELETE="true"
|
||||
```
|
||||
|
||||
---
|
||||
@@ -89,6 +92,37 @@ shumai-cli create-version <localFilePath> -p <parentAssetId>
|
||||
- **Options:**
|
||||
- `-p`, `--parent <id>`: The parent asset ID (file or version stack) to version (required).
|
||||
|
||||
#### 6. Rename an Asset
|
||||
|
||||
Rename an existing file or folder in Shumai.
|
||||
|
||||
```bash
|
||||
shumai-cli rename <assetId> <newName>
|
||||
```
|
||||
|
||||
#### 7. Move Assets
|
||||
|
||||
Move one or more assets (files or folders) to a destination parent folder. Note that all assets to be moved must belong to the same current parent folder.
|
||||
|
||||
```bash
|
||||
shumai-cli move <assetId...> -p <parentId>
|
||||
# or using the short alias:
|
||||
shumai-cli mv <assetId...> -p <parentId>
|
||||
```
|
||||
|
||||
- **Options:**
|
||||
- `-p`, `--parent <id>`: The destination parent folder ID (required).
|
||||
|
||||
#### 8. Delete an Asset
|
||||
|
||||
Delete a single file or folder by moving it to the Trash bin. For safety, this command only deletes one asset at a time and requires the `SHUMAI_ALLOW_DELETE="true"` environment variable to be set in your environment.
|
||||
|
||||
```bash
|
||||
shumai-cli delete <assetId>
|
||||
# or using the short alias:
|
||||
shumai-cli rm <assetId>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/cli",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
@@ -11,7 +11,7 @@
|
||||
"@shumai/core": "workspace:*",
|
||||
"@shumai/dtos": "workspace:*",
|
||||
"@shumai/tableprinter": "workspace:*",
|
||||
"hono": "4.12.23",
|
||||
"ulid": "^3.0.2"
|
||||
"hono": "4.13.5",
|
||||
"ulid": "3.0.2"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@ import { mkdir } from './mkdir'
|
||||
import { getClient } from '../client'
|
||||
import { upload } from './upload'
|
||||
import { createVersion } from './create-version'
|
||||
import { rename } from './rename'
|
||||
import { move } from './move'
|
||||
import { deleteAsset } from './delete'
|
||||
import fs from 'node:fs'
|
||||
import http from 'node:http'
|
||||
|
||||
@@ -34,17 +37,29 @@ describe('CLI Commands', () => {
|
||||
$get: vi.fn(),
|
||||
':projectId': {
|
||||
$get: vi.fn(),
|
||||
reparent: {
|
||||
$post: vi.fn(),
|
||||
},
|
||||
},
|
||||
},
|
||||
folders: {
|
||||
$post: vi.fn(),
|
||||
$delete: vi.fn(),
|
||||
':folderId': {
|
||||
$get: vi.fn(),
|
||||
$put: vi.fn(),
|
||||
children: {
|
||||
$get: vi.fn(),
|
||||
},
|
||||
},
|
||||
},
|
||||
files: {
|
||||
$delete: vi.fn(),
|
||||
':fileId': {
|
||||
$get: vi.fn(),
|
||||
$put: vi.fn(),
|
||||
},
|
||||
},
|
||||
teams: {
|
||||
':teamId': {
|
||||
upload: {
|
||||
@@ -60,6 +75,8 @@ describe('CLI Commands', () => {
|
||||
},
|
||||
}
|
||||
|
||||
const originalAllowDelete = process.env.SHUMAI_ALLOW_DELETE
|
||||
|
||||
beforeEach(() => {
|
||||
vi.resetAllMocks()
|
||||
logSpy = vi.spyOn(console, 'log').mockImplementation(() => {})
|
||||
@@ -79,6 +96,11 @@ describe('CLI Commands', () => {
|
||||
writeSpy.mockRestore()
|
||||
errorSpy.mockRestore()
|
||||
exitSpy.mockRestore()
|
||||
if (originalAllowDelete !== undefined) {
|
||||
process.env.SHUMAI_ALLOW_DELETE = originalAllowDelete
|
||||
} else {
|
||||
delete process.env.SHUMAI_ALLOW_DELETE
|
||||
}
|
||||
})
|
||||
|
||||
describe('project ls', () => {
|
||||
@@ -361,4 +383,192 @@ describe('CLI Commands', () => {
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe('rename', () => {
|
||||
it('exits with error when assetId or newName is missing', async () => {
|
||||
await expect(rename('', 'new-name')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('Asset ID is required'))
|
||||
|
||||
await expect(rename('asset-1', '')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('New name is required'))
|
||||
})
|
||||
|
||||
it('renames a folder when asset type is folder', async () => {
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'f-1', type: 'folder' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.folders[':folderId'].$put.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'f-1', name: 'Renamed Folder' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await rename('f-1', 'Renamed Folder')
|
||||
|
||||
expect(mockClient.api.folders[':folderId'].$put).toHaveBeenCalledWith({
|
||||
param: { folderId: 'f-1' },
|
||||
json: { name: 'Renamed Folder' },
|
||||
})
|
||||
expect(logSpy).toHaveBeenCalledWith('Renamed asset f-1 to "Renamed Folder"')
|
||||
})
|
||||
|
||||
it('renames a file when asset type is file', async () => {
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'file-1', type: 'file' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.files[':fileId'].$put.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'file-1', name: 'new.mp4' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await rename('file-1', 'new.mp4')
|
||||
|
||||
expect(mockClient.api.files[':fileId'].$put).toHaveBeenCalledWith({
|
||||
param: { fileId: 'file-1' },
|
||||
json: { name: 'new.mp4' },
|
||||
})
|
||||
expect(logSpy).toHaveBeenCalledWith('Renamed asset file-1 to "new.mp4"')
|
||||
})
|
||||
|
||||
it('exits with error when asset fetch fails', async () => {
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: false,
|
||||
json: async () => ({ error: 'Asset not found' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await expect(rename('unknown-id', 'name')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith('Error: Asset not found')
|
||||
})
|
||||
})
|
||||
|
||||
describe('move', () => {
|
||||
it('exits with error when assetIds or parentId is missing', async () => {
|
||||
await expect(move([], 'parent-1')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(
|
||||
expect.stringContaining('At least one asset ID is required'),
|
||||
)
|
||||
|
||||
await expect(move(['a-1'], '')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(
|
||||
expect.stringContaining('Option -p/--parent <parentId> is required'),
|
||||
)
|
||||
})
|
||||
|
||||
it('successfully moves assets', async () => {
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'parent-1', projectId: 'proj-1' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.projects[':projectId'].reparent.$post.mockResolvedValue({
|
||||
ok: true,
|
||||
} as unknown as Response)
|
||||
|
||||
await move(['a-1', 'a-2'], 'parent-1')
|
||||
|
||||
expect(mockClient.api.projects[':projectId'].reparent.$post).toHaveBeenCalledWith({
|
||||
param: { projectId: 'proj-1' },
|
||||
json: {
|
||||
assetIds: ['a-1', 'a-2'],
|
||||
newParentId: 'parent-1',
|
||||
},
|
||||
})
|
||||
expect(logSpy).toHaveBeenCalledWith('Moved 2 asset(s) to parent parent-1')
|
||||
})
|
||||
|
||||
it('exits with error when destination parent is not found', async () => {
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: false,
|
||||
json: async () => ({ error: 'Folder not found' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await expect(move(['a-1'], 'missing-parent')).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith('Error: Folder not found')
|
||||
})
|
||||
})
|
||||
|
||||
describe('deleteAsset', () => {
|
||||
it('exits with error when SHUMAI_ALLOW_DELETE is not set or not true', async () => {
|
||||
delete process.env.SHUMAI_ALLOW_DELETE
|
||||
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(
|
||||
'Error: Asset deletion is disabled in this environment.',
|
||||
)
|
||||
})
|
||||
|
||||
it('exits with error when assetIds is empty', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = 'true'
|
||||
await expect(deleteAsset([])).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('Asset ID is required'))
|
||||
})
|
||||
|
||||
it('exits with error when more than one asset ID is passed', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = 'true'
|
||||
await expect(deleteAsset(['a-1', 'a-2'])).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith('Error: Can only delete one asset at a time.')
|
||||
})
|
||||
|
||||
it('exits with error when asset is not found', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = 'true'
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: false,
|
||||
json: async () => ({ error: 'Asset not found' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith('Error: Asset not found')
|
||||
})
|
||||
|
||||
it('successfully deletes a file when SHUMAI_ALLOW_DELETE is true', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = 'true'
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'a-1', type: 'file' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.files.$delete.mockResolvedValue({
|
||||
ok: true,
|
||||
} as unknown as Response)
|
||||
|
||||
await deleteAsset(['a-1'])
|
||||
|
||||
expect(mockClient.api.files.$delete).toHaveBeenCalledWith({
|
||||
json: { ids: ['a-1'] },
|
||||
})
|
||||
expect(mockClient.api.folders.$delete).not.toHaveBeenCalled()
|
||||
expect(logSpy).toHaveBeenCalledWith('Deleted asset a-1')
|
||||
})
|
||||
|
||||
it('successfully deletes a folder when SHUMAI_ALLOW_DELETE is 1', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = '1'
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'folder-1', type: 'folder' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.folders.$delete.mockResolvedValue({
|
||||
ok: true,
|
||||
} as unknown as Response)
|
||||
|
||||
await deleteAsset(['folder-1'])
|
||||
|
||||
expect(mockClient.api.folders.$delete).toHaveBeenCalledWith({
|
||||
json: { ids: ['folder-1'] },
|
||||
})
|
||||
expect(logSpy).toHaveBeenCalledWith('Deleted asset folder-1')
|
||||
})
|
||||
|
||||
it('exits with error when delete API returns an error', async () => {
|
||||
process.env.SHUMAI_ALLOW_DELETE = 'true'
|
||||
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ id: 'a-1', type: 'file' }),
|
||||
} as unknown as Response)
|
||||
mockClient.api.files.$delete.mockResolvedValue({
|
||||
ok: false,
|
||||
json: async () => ({ error: 'Failed to delete' }),
|
||||
} as unknown as Response)
|
||||
|
||||
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
|
||||
expect(errorSpy).toHaveBeenCalledWith('Error: Failed to delete')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
import { getClient } from '../client'
|
||||
|
||||
export async function deleteAsset(assetIds: string[]) {
|
||||
const isAllowed =
|
||||
process.env.SHUMAI_ALLOW_DELETE === 'true' || process.env.SHUMAI_ALLOW_DELETE === '1'
|
||||
if (!isAllowed) {
|
||||
console.error('Error: Asset deletion is disabled in this environment.')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
if (!assetIds || assetIds.length === 0) {
|
||||
console.error('Error: Asset ID is required. Usage: shumai-cli delete <assetId>')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
if (assetIds.length > 1) {
|
||||
console.error('Error: Can only delete one asset at a time.')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const assetId = assetIds[0]
|
||||
const client = getClient()
|
||||
|
||||
try {
|
||||
// Inspect asset to determine whether it is a folder or file
|
||||
const getRes = await client.api.folders[':folderId'].$get({
|
||||
param: { folderId: assetId },
|
||||
})
|
||||
|
||||
if (!getRes.ok) {
|
||||
const err = (await getRes.json().catch(() => ({ error: 'Asset not found' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Asset not found'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const asset = await getRes.json()
|
||||
const isFolder = asset.type === 'folder'
|
||||
|
||||
const res = isFolder
|
||||
? await client.api.folders.$delete({
|
||||
json: { ids: [assetId] },
|
||||
})
|
||||
: await client.api.files.$delete({
|
||||
json: { ids: [assetId] },
|
||||
})
|
||||
|
||||
if (!res.ok) {
|
||||
const err = (await res.json().catch(() => ({ error: 'Failed to delete asset' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Failed to delete asset'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
console.log(`Deleted asset ${assetId}`)
|
||||
} catch (err) {
|
||||
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
|
||||
process.exit(1)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
import { getClient } from '../client'
|
||||
|
||||
export async function move(assetIds: string[], parentId: string) {
|
||||
if (!assetIds || assetIds.length === 0) {
|
||||
console.error(
|
||||
'Error: At least one asset ID is required. Usage: shumai-cli move <assetId...> -p <parentId>',
|
||||
)
|
||||
process.exit(1)
|
||||
}
|
||||
if (!parentId) {
|
||||
console.error('Error: Option -p/--parent <parentId> is required.')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const client = getClient()
|
||||
|
||||
try {
|
||||
// Fetch destination folder to get its projectId
|
||||
const parentRes = await client.api.folders[':folderId'].$get({
|
||||
param: { folderId: parentId },
|
||||
})
|
||||
|
||||
if (!parentRes.ok) {
|
||||
const err = (await parentRes.json().catch(() => ({ error: 'Parent folder not found' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Parent folder not found'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const parentInfo = await parentRes.json()
|
||||
const projectId = parentInfo.projectId
|
||||
if (!projectId) {
|
||||
console.error('Error: Destination parent folder is not associated with a project.')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const res = await client.api.projects[':projectId'].reparent.$post({
|
||||
param: { projectId },
|
||||
json: {
|
||||
assetIds,
|
||||
newParentId: parentId,
|
||||
},
|
||||
})
|
||||
|
||||
if (!res.ok) {
|
||||
const err = (await res.json().catch(() => ({ error: 'Failed to move assets' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Failed to move assets'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
console.log(`Moved ${assetIds.length} asset(s) to parent ${parentId}`)
|
||||
} catch (err) {
|
||||
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
|
||||
process.exit(1)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
import { getClient } from '../client'
|
||||
|
||||
export async function rename(assetId: string, newName: string) {
|
||||
if (!assetId) {
|
||||
console.error('Error: Asset ID is required. Usage: shumai-cli rename <assetId> <newName>')
|
||||
process.exit(1)
|
||||
}
|
||||
if (!newName) {
|
||||
console.error('Error: New name is required. Usage: shumai-cli rename <assetId> <newName>')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const client = getClient()
|
||||
|
||||
try {
|
||||
// Determine whether asset is a folder or a file
|
||||
const getRes = await client.api.folders[':folderId'].$get({
|
||||
param: { folderId: assetId },
|
||||
})
|
||||
|
||||
if (!getRes.ok) {
|
||||
const err = (await getRes.json().catch(() => ({ error: 'Asset not found' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Asset not found'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const asset = await getRes.json()
|
||||
const isFolder = asset.type === 'folder'
|
||||
|
||||
const updateRes = isFolder
|
||||
? await client.api.folders[':folderId'].$put({
|
||||
param: { folderId: assetId },
|
||||
json: { name: newName },
|
||||
})
|
||||
: await client.api.files[':fileId'].$put({
|
||||
param: { fileId: assetId },
|
||||
json: { name: newName },
|
||||
})
|
||||
|
||||
if (!updateRes.ok) {
|
||||
const err = (await updateRes.json().catch(() => ({ error: 'Failed to rename asset' }))) as {
|
||||
error?: string
|
||||
}
|
||||
console.error(`Error: ${err.error || 'Failed to rename asset'}`)
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
console.log(`Renamed asset ${assetId} to "${newName}"`)
|
||||
} catch (err) {
|
||||
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
|
||||
process.exit(1)
|
||||
}
|
||||
}
|
||||
+37
-1
@@ -3,6 +3,9 @@ import { ls } from './commands/ls'
|
||||
import { mkdir } from './commands/mkdir'
|
||||
import { upload } from './commands/upload'
|
||||
import { createVersion } from './commands/create-version'
|
||||
import { rename } from './commands/rename'
|
||||
import { move } from './commands/move'
|
||||
import { deleteAsset } from './commands/delete'
|
||||
|
||||
function printHelp() {
|
||||
console.log(`
|
||||
@@ -14,9 +17,12 @@ Commands:
|
||||
mkdir <name> -p <parentId> Create a new folder in a parent folder
|
||||
upload <path> -p <parentId> Upload a local file or folder to a parent folder
|
||||
create-version <path> -p <id> Create a new version of an existing file or version stack
|
||||
rename <assetId> <newName> Rename an existing file or folder
|
||||
move <assetIds...> -p <target> Move one or more assets to a destination parent folder (alias: mv)
|
||||
delete <assetId> Delete a single file or folder (alias: rm)
|
||||
|
||||
Options:
|
||||
-p, --parent <id> The parent folder/asset ID (required for ls, mkdir, upload, create-version)
|
||||
-p, --parent <id> The parent folder/asset ID (required for ls, mkdir, upload, create-version, move)
|
||||
-h, --help Show help details
|
||||
`)
|
||||
}
|
||||
@@ -92,6 +98,36 @@ async function main() {
|
||||
process.exit(1)
|
||||
}
|
||||
await createVersion(localPath, parentId)
|
||||
} else if (cmd === 'rename') {
|
||||
const assetId = cleanArgs[1]
|
||||
const newName = cleanArgs[2]
|
||||
if (!assetId || !newName) {
|
||||
console.error(
|
||||
'Error: Asset ID and new name are required. Usage: shumai-cli rename <assetId> <newName>',
|
||||
)
|
||||
process.exit(1)
|
||||
}
|
||||
await rename(assetId, newName)
|
||||
} else if (cmd === 'move' || cmd === 'mv') {
|
||||
const assetIds = cleanArgs.slice(1)
|
||||
if (assetIds.length === 0) {
|
||||
console.error(
|
||||
'Error: At least one asset ID is required. Usage: shumai-cli move <assetId...> -p <parentId>',
|
||||
)
|
||||
process.exit(1)
|
||||
}
|
||||
if (!parentId) {
|
||||
console.error('Error: Option -p/--parent <parentId> is required.')
|
||||
process.exit(1)
|
||||
}
|
||||
await move(assetIds, parentId)
|
||||
} else if (cmd === 'delete' || cmd === 'rm') {
|
||||
const assetIds = cleanArgs.slice(1)
|
||||
if (assetIds.length === 0) {
|
||||
console.error('Error: Asset ID is required. Usage: shumai-cli delete <assetId>')
|
||||
process.exit(1)
|
||||
}
|
||||
await deleteAsset(assetIds)
|
||||
} else {
|
||||
console.error(`Error: Unknown command "${cmd}". Run "shumai-cli --help" for usage.`)
|
||||
process.exit(1)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/transcode-app",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -56,6 +56,8 @@ apps/web/e2e/
|
||||
|---|---|
|
||||
| Sign up as the first user and become the team owner | `tests/auth/signup.spec.ts` |
|
||||
| Log in with existing credentials | `tests/auth/login.spec.ts` |
|
||||
| Show error when accessing reset-password page without token | `tests/auth/reset-password.spec.ts` |
|
||||
| Reset password with valid token and allow logging in with new password | `tests/auth/reset-password.spec.ts` |
|
||||
|
||||
### team
|
||||
| Test | File |
|
||||
@@ -91,6 +93,7 @@ apps/web/e2e/
|
||||
| Owner saves a search result as a collection | `tests/project/save-search-collection.spec.ts` |
|
||||
| Image share with watermark + download disabled: no download buttons on public list/detail pages, watermarked proxy served, download-url rejected | `tests/project/share-watermark-no-download.spec.ts` |
|
||||
| Video share with watermark + download disabled: no download buttons on public list/detail pages, watermarked proxy served, download-url rejected | `tests/project/share-watermark-no-download.spec.ts` |
|
||||
| Owner views a file and it appears in recents | `tests/project/recents.spec.ts` |
|
||||
|
||||
### file
|
||||
| Test | File |
|
||||
|
||||
@@ -24,14 +24,32 @@ export async function dragCard(page: Page, source: Locator, target: Locator): Pr
|
||||
await page.mouse.move(fromX, fromY)
|
||||
await page.mouse.down()
|
||||
|
||||
// Move in several chunks so the dnd-kit sensor activates mid-drag
|
||||
const dx = toX - fromX
|
||||
const dy = toY - fromY
|
||||
const dist = Math.hypot(dx, dy)
|
||||
|
||||
// Step past the 10px activation constraint to trigger drag activation
|
||||
// and give the browser a brief moment for status to become 'dragging'
|
||||
const activationRatio = dist > 0 ? Math.min(1, 15 / dist) : 1
|
||||
await page.mouse.move(fromX + dx * activationRatio, fromY + dy * activationRatio)
|
||||
await page.waitForTimeout(50)
|
||||
|
||||
// Move in several chunks so the intermediate dragmove handlers run
|
||||
const chunks = 8
|
||||
for (let i = 1; i <= chunks; i++) {
|
||||
const x = fromX + ((toX - fromX) * i) / chunks
|
||||
const y = fromY + ((toY - fromY) * i) / chunks
|
||||
const x = fromX + (dx * i) / chunks
|
||||
const y = fromY + (dy * i) / chunks
|
||||
await page.mouse.move(x, y)
|
||||
await page.waitForTimeout(15)
|
||||
await page.waitForTimeout(20)
|
||||
}
|
||||
|
||||
// Ensure pointer is directly over target center and allow requestAnimationFrame
|
||||
// and collision microtasks to settle before triggering drop
|
||||
await page.mouse.move(toX, toY)
|
||||
await page.evaluate(
|
||||
() => new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(resolve))),
|
||||
)
|
||||
await page.waitForTimeout(100)
|
||||
|
||||
await page.mouse.up()
|
||||
}
|
||||
|
||||
@@ -7,15 +7,16 @@ interface CreateShareResponse {
|
||||
}
|
||||
|
||||
/**
|
||||
* Locates a file/folder card by its name. File names are rendered as
|
||||
* `EditableText` inputs (not text nodes), so `getByText` does not match them.
|
||||
* The returned locator points at the card wrapper div (right-clickable to open
|
||||
* the card context menu).
|
||||
* Locates a file/folder card by its name. Matches both read-only text nodes
|
||||
* and active EditableText inputs. The returned locator points at the card
|
||||
* wrapper div (right-clickable to open the card context menu).
|
||||
*/
|
||||
export function fileCard(page: Page, name: string): Locator {
|
||||
return page
|
||||
.locator('div.group')
|
||||
.filter({ has: page.locator(`input[value="${name}"]`) })
|
||||
.locator('[data-testid="file-card"]')
|
||||
.filter({
|
||||
has: page.locator(`input[value="${name}"]`).or(page.getByText(name, { exact: true })),
|
||||
})
|
||||
.first()
|
||||
}
|
||||
|
||||
|
||||
@@ -32,4 +32,7 @@ async function start() {
|
||||
await import('../src/index.ts')
|
||||
}
|
||||
|
||||
start().catch(console.error)
|
||||
start().catch((err) => {
|
||||
console.error('Failed to start E2E server:', err)
|
||||
process.exit(1)
|
||||
})
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
import { expect, test } from '../../fixtures'
|
||||
import { apiSignup, E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
|
||||
import { loginViaUi } from '../../helpers/ui'
|
||||
|
||||
test('should show error when accessing reset-password page without token', async ({ page }) => {
|
||||
await page.goto('/reset-password')
|
||||
await expect(page.getByText('Invalid or missing reset token.')).toBeVisible()
|
||||
await expect(page.getByRole('button', { name: 'Go to Login' })).toBeVisible()
|
||||
})
|
||||
|
||||
test('should reset password with valid token and allow logging in with new password', async ({
|
||||
page,
|
||||
request,
|
||||
prisma,
|
||||
}) => {
|
||||
const email = uniqueEmail('reset-pw')
|
||||
const oldPassword = E2E_PASSWORD
|
||||
const newPassword = 'newSecretPassword123'
|
||||
|
||||
// 1. Seed user
|
||||
await apiSignup(request, email, oldPassword)
|
||||
|
||||
// 2. Request password reset via API
|
||||
const resetRes = await request.post('/api/auth/request-password-reset', {
|
||||
data: {
|
||||
email,
|
||||
redirectTo: '/reset-password',
|
||||
},
|
||||
})
|
||||
expect(resetRes.ok()).toBe(true)
|
||||
|
||||
// Retrieve the generated verification token from DB
|
||||
const verification = await prisma.verification.findFirst({
|
||||
where: {
|
||||
identifier: { startsWith: 'reset-password:' },
|
||||
},
|
||||
orderBy: { createdAt: 'desc' },
|
||||
})
|
||||
expect(verification).not.toBeNull()
|
||||
const token = verification!.identifier.replace('reset-password:', '')
|
||||
|
||||
// 3. Open reset password page with token
|
||||
await page.goto(`/reset-password?token=${token}`)
|
||||
|
||||
// 4. Fill in new password and confirmation
|
||||
await page.locator('input#password').fill(newPassword)
|
||||
await page.locator('input#confirmPassword').fill(newPassword)
|
||||
|
||||
// 5. Submit form
|
||||
await page.getByRole('button', { name: 'Reset Password' }).click()
|
||||
|
||||
// 6. Verify success state
|
||||
await expect(page.getByText('Password reset successfully!')).toBeVisible()
|
||||
|
||||
// 7. Click Go to Login
|
||||
await page.getByRole('button', { name: 'Go to Login' }).click()
|
||||
await expect(page).toHaveURL('/login')
|
||||
|
||||
// 8. Log in with the new password
|
||||
await loginViaUi(page, email, newPassword)
|
||||
await expect(page).toHaveURL(/\/teams\/[^/]+/)
|
||||
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
|
||||
})
|
||||
@@ -40,8 +40,8 @@ test('owner should create a project with a cover image', async ({ owner, prisma
|
||||
await expect(page).toHaveURL(/\/projects\/[^/]+/)
|
||||
await expect(page.locator(`text=${projectName}`).first()).toBeVisible()
|
||||
|
||||
// Back on the dashboard the new project card is visible with its cover
|
||||
await page.click('button[aria-label="Dashboard"]')
|
||||
// Back on the home page the new project card is visible with its cover
|
||||
await page.click('button[aria-label="Home"]')
|
||||
await expect(page).toHaveURL(/\/teams\/[^/]+/)
|
||||
await expect(page.locator(`img[alt="${projectName}"]`)).toBeVisible()
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
import { expect, test } from '../../fixtures'
|
||||
import { fileCard } from '../../helpers/files'
|
||||
|
||||
test('owner views a file and it appears in recents', async ({ file }) => {
|
||||
const { page, projectId, fileName, fileId } = file
|
||||
|
||||
// Open the file details page to record view
|
||||
await page.goto(`/projects/${projectId}/files/${fileId}`)
|
||||
await expect(page.getByText(fileName).first()).toBeVisible()
|
||||
|
||||
// Navigate to Recents page via sidebar or direct URL
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
await page.getByText('Recently Viewed').first().click()
|
||||
await expect(page).toHaveURL(new RegExp(`/projects/${projectId}/recents`))
|
||||
|
||||
// The viewed file should be visible in recents
|
||||
const card = fileCard(page, fileName)
|
||||
await expect(card).toBeVisible()
|
||||
|
||||
// Toolbar should show hint text instead of action buttons
|
||||
await expect(
|
||||
page.getByText('This page displays the 100 most recent files you viewed in this project.'),
|
||||
).toBeVisible()
|
||||
await expect(page.getByRole('button', { name: 'Field' })).not.toBeVisible()
|
||||
await expect(page.getByRole('button', { name: 'Search' })).not.toBeVisible()
|
||||
await expect(page.getByText('AGENTS.md')).not.toBeVisible()
|
||||
|
||||
// Right-clicking the file should NOT show the context menu
|
||||
await card.click({ button: 'right' })
|
||||
await expect(page.getByRole('menuitem', { name: 'Delete' })).not.toBeVisible()
|
||||
await expect(page.getByRole('menuitem', { name: 'Download' })).not.toBeVisible()
|
||||
|
||||
// The per-item overflow menu must also be unavailable on the read-only Recents page.
|
||||
await expect(card.getByRole('button')).toHaveCount(0)
|
||||
})
|
||||
@@ -12,6 +12,11 @@ test('owner manages resource quotas in settings and resets usage from the dashbo
|
||||
// 2. Click the Quotas sidebar tab
|
||||
await page.getByRole('button', { name: /Quotas|配额/i }).click()
|
||||
|
||||
// Verify URL contains #quotas and remains after reload
|
||||
expect(page.url()).toContain('#quotas')
|
||||
await page.reload()
|
||||
expect(page.url()).toContain('#quotas')
|
||||
|
||||
// 3. Verify Quotas settings card is displayed with empty state
|
||||
await expect(page.getByRole('heading', { name: /^(Resource Quotas|资源配额)$/i })).toBeVisible()
|
||||
await expect(page.getByText(/No resource quotas configured|暂未配置资源配额/i)).toBeVisible()
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/web-app",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
@@ -12,11 +12,11 @@
|
||||
"@shumai/agent": "workspace:*",
|
||||
"@shumai/transcode": "workspace:*",
|
||||
"@shumai/webui": "workspace:*",
|
||||
"hono": "4.12.23"
|
||||
"hono": "4.13.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@prisma/adapter-pg": "7.8.0",
|
||||
"pg": "8.21.0",
|
||||
"@types/pg": "8.20.0"
|
||||
"@prisma/adapter-pg": "7.10.0",
|
||||
"@types/pg": "8.23.1",
|
||||
"pg": "8.23.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,14 +11,40 @@ import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { metadataService } from '@shumai/core/src/metadata/metadata'
|
||||
import { initTranscodeWorkflows } from '@shumai/transcode'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { migrateLegacyAgentAvatars } from '@shumai/core/src/agent/migration'
|
||||
|
||||
import { handleDaemonCommands } from '@shumai/core/src/utils/daemon'
|
||||
import { authService } from '@shumai/core/src/auth/auth'
|
||||
|
||||
if (process.argv.includes('--check')) {
|
||||
console.log('✅ Web app evaluated successfully!')
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
const cliArgs = process.argv.slice(2)
|
||||
const resetCmdIndex = cliArgs.findIndex(
|
||||
(arg) => arg === 'reset-password' || arg === 'reset-passowrd',
|
||||
)
|
||||
|
||||
if (resetCmdIndex !== -1) {
|
||||
const email = cliArgs[resetCmdIndex + 1]
|
||||
if (!email || email.startsWith('-')) {
|
||||
console.error('Error: Please provide a valid email address.')
|
||||
console.error('Usage: shumai reset-password <email>')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
try {
|
||||
const link = await authService.generatePasswordResetLink(email)
|
||||
console.log(link)
|
||||
process.exit(0)
|
||||
} catch (err: unknown) {
|
||||
const message = err instanceof Error ? err.message : 'Unknown error'
|
||||
console.error(`Error: ${message}`)
|
||||
process.exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
async function run() {
|
||||
// Initialize workflows and activities for local executor mode
|
||||
initAgentWorkflows()
|
||||
@@ -26,6 +52,7 @@ async function run() {
|
||||
|
||||
// Start services
|
||||
await metadataService.syncSystemFields().catch(console.error)
|
||||
await migrateLegacyAgentAvatars().catch(console.error)
|
||||
assetService.startCleanupJob()
|
||||
workflowService.start()
|
||||
if (process.env.WORKFLOW_EXECUTOR === 'temporal') {
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
# Code Quality Review: Quota Usage Dashboard
|
||||
|
||||
## Context
|
||||
|
||||
The change moves quota usage monitoring from the settings rule-card dialog to an owner-only dashboard section, adds collapsible rule/record display, and adds an audited manual record reset operation.
|
||||
|
||||
## Review
|
||||
|
||||
### Correctness
|
||||
|
||||
- The reset service validates team ownership, scope mode, membership, role filters, and selected-member membership.
|
||||
- Reset and first-use record creation are serialized with a quota-rule row lock.
|
||||
- Reset starts a new window at the current time and clears consumption.
|
||||
- API and service tests cover shared records, member records, invalid targets, cross-team access, request validation, and audit logging.
|
||||
- The application E2E test covers the settings/dashboard flow and verifies the persisted reset.
|
||||
|
||||
### Readability and architecture
|
||||
|
||||
- Business logic remains in `QuotaService`; the API only validates, authorizes, invokes the service, and maps the audit action.
|
||||
- The dashboard owns usage presentation, while quota formatting metadata is shared between dashboard and settings.
|
||||
- The removed usage dialog and obsolete translation messages are not referenced after the refactor.
|
||||
|
||||
### Security
|
||||
|
||||
- The reset endpoint retains owner-level team authorization.
|
||||
- Request input is validated with Zod.
|
||||
- SQL uses Prisma tagged-template parameters and does not interpolate raw user input.
|
||||
|
||||
### Performance
|
||||
|
||||
- Usage records are queried only after a rule is expanded.
|
||||
- Expanded rules refresh every ten seconds, matching the previous usage dialog behavior.
|
||||
- Quota rules retain the existing bounded list endpoint and descending ID ordering.
|
||||
|
||||
## Verification
|
||||
|
||||
- `bun run lint` passed.
|
||||
- `bun run format` passed.
|
||||
- `bun run typecheck` passed.
|
||||
- `bun run test` passed: 124 files, 1190 tests.
|
||||
- Quota API/core tests passed: 2 files, 30 tests.
|
||||
- Quota application E2E passed.
|
||||
- WebUI harness E2E passed: 9 tests.
|
||||
- Workflow E2E passed: 14 files, 58 tests.
|
||||
- `git diff --check` passed.
|
||||
|
||||
## Verdict
|
||||
|
||||
Approve. No critical or required findings remain.
|
||||
+6
-1
@@ -42,6 +42,7 @@
|
||||
"group": "Shumai Agent Settings",
|
||||
"pages": [
|
||||
"using-shumai/agent-providers",
|
||||
"using-shumai/image-video-generation",
|
||||
"using-shumai/agents",
|
||||
"using-shumai/agents-md",
|
||||
"using-shumai/agent-skills",
|
||||
@@ -52,7 +53,11 @@
|
||||
},
|
||||
{
|
||||
"group": "Team Settings",
|
||||
"pages": ["using-shumai/transcode-settings", "using-shumai/quotas-settings"]
|
||||
"pages": [
|
||||
"using-shumai/transcode-settings",
|
||||
"using-shumai/quotas-settings",
|
||||
"using-shumai/password-reset"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Configuration",
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 309 KiB After Width: | Height: | Size: 131 KiB |
@@ -5,7 +5,7 @@ description: Configure the tools and capabilities permitted for each agent.
|
||||
|
||||
Shumai agents are equipped with built-in tools that allow them to interact with the file system, view files, extract video frames, and execute commands.
|
||||
|
||||
By default, **all tools are enabled** for new agents. Team Owners can deny specific tools to restrict agent capabilities.
|
||||
By default, most tools are enabled for new agents, while sensitive or destructive tools (such as **Delete Asset**) are disabled by default. Team Owners can toggle specific tools to customize agent capabilities.
|
||||
|
||||
<Warning>
|
||||
**Caution:** Disabling tools can cause agents or skills to fail. For example, disabling the
|
||||
@@ -30,36 +30,63 @@ The following tools can be individually toggled in the agent configuration dialo
|
||||
- **Description:** Allows the agent to load and read skill definitions to perform specialized actions.
|
||||
- **Why it matters:** Enables the agent to inspect the instructions/configurations of custom skills registered in your workspace before executing them.
|
||||
|
||||
### 3. Analyze Image (`analyze_image`)
|
||||
### 3. Read Asset (`read_asset`)
|
||||
|
||||
- **Description:** Allows the agent to view and analyze the visual contents of an image file.
|
||||
- **Why it matters:** Enables multimodal agents to "see" image assets uploaded to Shumai, allowing them to answer comments or write metadata about images.
|
||||
- **Description:** Allows the agent to inspect images, extract still frames from video files, render PDF document pages, and read text/markdown documents.
|
||||
- **Why it matters:** Enables multimodal agents to view visual media assets uploaded to Shumai, extract frame-by-frame video screenshots, inspect document layouts, and answer questions about uploaded creative assets.
|
||||
|
||||
### 4. Video Frame Extraction (`screenshot`)
|
||||
|
||||
- **Description:** Allows the agent to extract still image frames from video files for analysis.
|
||||
- **Why it matters:** Enables the agent to perform frame-by-frame analysis on videos (e.g. for comments, annotation, or search).
|
||||
|
||||
### 5. Browse Shumai (`list_assets`)
|
||||
### 4. Browse Shumai (`list_assets`)
|
||||
|
||||
- **Description:** Allows the agent to list folders and browse files in Shumai.
|
||||
- **Why it matters:** Gives the agent visual mapping of the project structure so it can search for other files or locate related assets.
|
||||
|
||||
### 6. Create Folder (`create_folder`)
|
||||
### 5. Create Folder (`create_folder`)
|
||||
|
||||
- **Description:** Allows the agent to create new folders in Shumai.
|
||||
- **Why it matters:** Needed if the agent organizes outputs or places files in custom subdirectory folders.
|
||||
|
||||
### 7. Create File (`create_file`)
|
||||
### 6. Create File (`create_file`)
|
||||
|
||||
- **Description:** Allows the agent to create and upload new files to Shumai.
|
||||
- **Why it matters:** Allows the agent to generate new assets (e.g. text logs, transcoded clips, reports) and save them directly back into your project.
|
||||
|
||||
### 8. Create Version (`create_version`)
|
||||
### 7. Create Version (`create_version`)
|
||||
|
||||
- **Description:** Allows the agent to upload and stack a new version of an existing file in Shumai.
|
||||
- **Why it matters:** Allows the agent to update files in a clean, non-destructive way by stacking revisions rather than creating duplicate files.
|
||||
|
||||
### 8. Generate Image (`generate_image`)
|
||||
|
||||
- **Description:** Allows the agent to generate still images from text prompts and reference images using configured AI image models.
|
||||
- **Why it matters:** Enables agents to create concept art, mockups, textures, and illustrations directly inside Shumai.
|
||||
- **Prerequisite:** This tool requires at least one image model to be configured and enabled in [Image / Video Generation](/using-shumai/image-video-generation). If no image models are enabled under a configured provider, this tool is omitted from the agent session even if enabled in the agent settings dialog.
|
||||
|
||||
### 9. Generate Video (`generate_video`)
|
||||
|
||||
- **Description:** Allows the agent to generate video clips from text prompts, image animation, or transition keyframes using configured AI video models.
|
||||
- **Why it matters:** Enables agents to produce short animated clips, camera motion shots, and video transitions.
|
||||
- **Prerequisite:** This tool requires at least one video model to be configured and enabled in [Image / Video Generation](/using-shumai/image-video-generation). If no video models are enabled under a configured provider, this tool is omitted from the agent session even if enabled in the agent settings dialog.
|
||||
|
||||
### 10. Download Asset (`download_asset`)
|
||||
|
||||
- **Description:** Allows the agent to download a workspace asset or specific storage S3 key to the local `.pi` directory for processing with local scripts or bash commands.
|
||||
- **Why it matters:** Enables agents executing custom skill scripts to fetch files or intermediate transcode artifacts to local disk.
|
||||
|
||||
### 11. Rename Asset (`rename_asset`)
|
||||
|
||||
- **Description:** Allows the agent to rename an existing file or folder in Shumai.
|
||||
- **Why it matters:** Enables agents to keep project files neatly named and organized according to workspace naming conventions. Enabled by default.
|
||||
|
||||
### 12. Move Assets (`move_assets`)
|
||||
|
||||
- **Description:** Allows the agent to move one or more assets to a destination parent folder.
|
||||
- **Why it matters:** Enables agents to reorganize workspace structures, relocate generated outputs, or tidy up project folders. Enabled by default.
|
||||
|
||||
### 13. Delete Asset (`delete_asset`)
|
||||
|
||||
- **Description:** Allows the agent to delete a single file or folder by moving it to the Trash bin.
|
||||
- **Why it matters:** Provides agents with the ability to clean up outdated or redundant assets. To prevent accidental data loss, this tool is **disabled by default** and strictly limited to deleting one asset at a time. Team Owners must explicitly enable this tool for an agent.
|
||||
|
||||
---
|
||||
|
||||
## Restricting Tools
|
||||
|
||||
@@ -0,0 +1,141 @@
|
||||
---
|
||||
title: Image / Video Generation
|
||||
description: Configure image and video generation providers and models for built-in AI agent tools.
|
||||
---
|
||||
|
||||
Shumai agents can generate creative visual assets directly within your workspace using built-in agent tools: **Generate Image** (`generate_image`) and **Generate Video** (`generate_video`).
|
||||
|
||||
Because generating visual media requires specialized foundation models, you must configure upstream media providers and enable specific models in your team settings before agents can use these capabilities.
|
||||
|
||||
> 🔒 **Access Control:** Only **Team Owners** can view and configure media generation settings. To access this page, click your avatar, navigate to **Settings**, and select **Image / Video Generation** from the left sidebar (or navigate to `teams/<teamId>/settings#image-video`).
|
||||
|
||||
---
|
||||
|
||||
## Why This Setting Is Needed
|
||||
|
||||
Conversational AI models (configured under **AI Providers**) handle text reasoning and chat interactions, but image and video generation require dedicated multimodal generative models (such as DALL-E, FLUX, Gemini Image, Veo, Kling AI, Luma Ray, Wan, and others).
|
||||
|
||||
The **Image / Video Generation** settings page allows team owners to:
|
||||
|
||||
1. Authenticate with one or more supported image and video generation providers.
|
||||
2. Select which curated models to enable for your team, or register custom model IDs.
|
||||
3. Establish default models for agents when generating visual assets.
|
||||
|
||||
---
|
||||
|
||||
## Tool Availability & Activation Rules
|
||||
|
||||
<Warning>
|
||||
**Important:** Enabling `generate_image` or `generate_video` in an agent's configuration dialog is
|
||||
**not enough** on its own. The tool will only be available to the agent if all three of the
|
||||
following conditions are met:
|
||||
</Warning>
|
||||
|
||||
1. **Provider Configured:** The provider must have a valid API key (either set via server environment variables or configured with a custom team key).
|
||||
2. **At Least One Model Enabled:** There must be **at least one enabled model** for that modality (`image` or `video`) under an active provider.
|
||||
3. **Tool Permitted for Agent:** The tool must not be disabled in the agent's tool permissions list under **Team Settings** > **Agents** > **Tools**.
|
||||
|
||||
### What Happens If No Models Are Configured?
|
||||
|
||||
If no image models are enabled under a configured provider, the `generate_image` tool is **completely omitted** from the agent's runtime environment. Similarly, if no video models are enabled, the `generate_video` tool is omitted.
|
||||
|
||||
In this state:
|
||||
|
||||
- The agent **cannot call** the generation tool.
|
||||
- The tool will not appear in the agent's tool catalog or prompt definition.
|
||||
- Even if a Team Owner has toggled **Generate Image** or **Generate Video** ON in the agent's settings dialog, the agent will not have access to the tool until a model is enabled.
|
||||
|
||||
---
|
||||
|
||||
## Supported Providers
|
||||
|
||||
Shumai provides built-in support for 18 media generation providers:
|
||||
|
||||
| Provider | Supported Modalities | Default Environment Variable |
|
||||
| :-------------------- | :------------------- | :--------------------------- |
|
||||
| **OpenAI** | Image | `OPENAI_API_KEY` |
|
||||
| **Google** | Image, Video | `GEMINI_API_KEY` |
|
||||
| **Google Vertex AI** | Image, Video | `GOOGLE_CLOUD_API_KEY` |
|
||||
| **xAI** | Image, Video | `XAI_API_KEY` |
|
||||
| **Fal** | Image, Video | `FAL_KEY` |
|
||||
| **Replicate** | Image, Video | `REPLICATE_API_TOKEN` |
|
||||
| **Black Forest Labs** | Image, Video | `BFL_API_KEY` |
|
||||
| **Kling AI** | Video | `KLINGAI_API_KEY` |
|
||||
| **Together AI** | Image | `TOGETHER_API_KEY` |
|
||||
| **Fireworks AI** | Image | `FIREWORKS_API_KEY` |
|
||||
| **DeepInfra** | Image | `DEEPINFRA_API_KEY` |
|
||||
| **Luma** | Image | `LUMA_API_KEY` |
|
||||
| **Amazon Bedrock** | Image | `AWS_ACCESS_KEY_ID` |
|
||||
| **Alibaba** | Video | `ALIBABA_API_KEY` |
|
||||
| **ByteDance** | Image, Video | `ARK_API_KEY` |
|
||||
| **MiniMax** | Video | `MINIMAX_API_KEY` |
|
||||
| **Prodia** | Image, Video | `PRODIA_TOKEN` |
|
||||
| **Azure OpenAI** | Image | `AZURE_API_KEY` |
|
||||
|
||||
---
|
||||
|
||||
## Configuring Providers & API Keys
|
||||
|
||||
Clicking on any provider in the **Media Providers** list opens its configuration dialog:
|
||||
|
||||
### Provider Statuses
|
||||
|
||||
- **Configured (Custom)**: A team-specific API key or custom environment variable name was entered in this dialog.
|
||||
- **Configured (Environment)**: The system detected a server-level default environment variable (e.g. `OPENAI_API_KEY`). No team key is required unless you want to override it.
|
||||
- **Not Configured**: No API key is available. You must provide an API key or an environment variable name to use this provider.
|
||||
|
||||
### Overriding API Keys
|
||||
|
||||
In the **API Key** tab of the provider dialog:
|
||||
|
||||
- Enter an API key literal (e.g. `sk-...`) or a custom environment variable name available on the host system.
|
||||
- Click **Clear Custom Key** to revert back to using the default environment variable if one exists.
|
||||
|
||||
---
|
||||
|
||||
## Managing Models
|
||||
|
||||
In the **Models** tab of the provider dialog:
|
||||
|
||||
### Curated Models
|
||||
|
||||
Shumai comes pre-configured with popular curated models (such as `dall-e-3`, `fal-ai/flux/dev`, `veo-3.1-generate`, `kling-v3.0-t2v`, etc.). Toggle the switch next to any model to enable or disable it for your team.
|
||||
|
||||
### Custom Models
|
||||
|
||||
If your provider supports a new or fine-tuned model not listed in the curated models:
|
||||
|
||||
1. Select the modality (**Image** or **Video**).
|
||||
2. Enter the exact **Model ID** recognized by the upstream provider.
|
||||
3. Click **Add**.
|
||||
|
||||
### Default Model Selection
|
||||
|
||||
The **first enabled model** of each type (`image` or `video`) automatically becomes the default model. When an agent calls `generate_image` or `generate_video` without explicitly specifying a `model` parameter, Shumai automatically directs the generation request to this default model.
|
||||
|
||||
---
|
||||
|
||||
## How Agents Use Generation Tools
|
||||
|
||||
Once enabled, agents can invoke the tools during conversations or automated workflows:
|
||||
|
||||
### 1. Generate Image (`generate_image`)
|
||||
|
||||
- **Prompt:** Detailed text description of the image.
|
||||
- **Model Selection:** Automatically defaults to your first enabled image model, or the agent can choose any enabled model in `provider:modelId` format (e.g. `openai:dall-e-3` or `fal:fal-ai/flux/dev`).
|
||||
- **Image References:** Agents can use existing workspace assets as style or composition references by passing S3 storage keys obtained from the `read_asset` tool (`s3KeyOnly: true`).
|
||||
- **Inpainting:** Supports mask-guided localized image editing using an S3 mask key.
|
||||
- **Parameters:** Custom aspect ratios (`1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `2:3`, `3:2`), dimensions, and seeds.
|
||||
|
||||
### 2. Generate Video (`generate_video`)
|
||||
|
||||
- **Generation Modes:**
|
||||
- `text_to_video`: Generate a clip from a descriptive motion prompt.
|
||||
- `image_to_video`: Animate an existing still image asset.
|
||||
- `first_last_frame`: Seamlessly interpolate and transition between two keyframe assets.
|
||||
- `reference_to_video`: Use reference images for consistent characters or environments.
|
||||
- **Parameters:** Aspect ratio (`16:9`, `9:16`, `1:1`, `adaptive`), resolution, duration, frame rate (FPS), and audio generation.
|
||||
|
||||
### Asset Creation Workflow
|
||||
|
||||
All generated media files are initially saved to the local sandboxed directory (`.pi/`). Agents can then use **Create File** (`create_file`) to upload the output as a new project asset or **Create Version** (`create_version`) to stack it onto an existing revision history.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Password Reset
|
||||
description: How administrators generate secure password reset links for team members.
|
||||
---
|
||||
|
||||
Because Shumai does not require an external email delivery service (SMTP) to be configured for standard self-hosted deployments, password resets are initiated securely by an administrator using the Shumai CLI.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
When a user forgets their password, an administrator can generate a one-time password reset link directly from the command line.
|
||||
|
||||
- **Link Expiration**: The generated password reset link is valid for **1 hour** (`3600 seconds`).
|
||||
- **One-Time Use**: Once used, the token is permanently invalidated.
|
||||
- **Session Revocation**: When a user resets their password, all existing active sessions for that account are automatically revoked across all devices.
|
||||
- **Latest Link Validity**: Generating a new reset link for a user immediately supersedes any previously generated pending links.
|
||||
|
||||
---
|
||||
|
||||
## Generating a Password Reset Link
|
||||
|
||||
### Running on Local Host / Server
|
||||
|
||||
Run the `reset-password` subcommand from your Shumai installation directory:
|
||||
|
||||
```bash
|
||||
shumai reset-password <user-email>
|
||||
```
|
||||
|
||||
_(Alternatively, `bun apps/web/src/index.ts reset-password <user-email>`)_
|
||||
|
||||
**Example Output:**
|
||||
|
||||
```text
|
||||
http://localhost:3000/reset-password?token=bb3xg4uO3cwN0FQv4cgUK6Hh
|
||||
```
|
||||
|
||||
### Running inside Docker
|
||||
|
||||
If Shumai is running inside a Docker container, execute the command using `docker exec`:
|
||||
|
||||
```bash
|
||||
docker exec -it <container-name-or-id> shumai reset-password <user-email>
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> Both `shumai` and the common alias `shuami` (e.g. `shuami reset-password <user-email>`) are supported.
|
||||
|
||||
> [!NOTE]
|
||||
> For remote servers or production deployments, ensure `BETTER_AUTH_URL` is set in your environment (e.g., `BETTER_AUTH_URL=https://shumai.example.com`) so the CLI generates the reset link with your public domain instead of `localhost`.
|
||||
|
||||
---
|
||||
|
||||
## Member Reset Experience
|
||||
|
||||
1. The administrator sends the generated URL to the team member via their preferred secure communication channel.
|
||||
2. The user opens the link in their browser.
|
||||
3. The user inputs their **New Password** and **Confirm Password** (minimum 3 characters).
|
||||
4. Upon clicking **Reset Password**, the password is securely updated, all previous active sessions are invalidated, and the user is redirected to `/login` to sign in.
|
||||
@@ -53,7 +53,7 @@ Shumai supports quota enforcement across multiple layers of the AI and agent arc
|
||||
| **AI Cost ($)** | Dollar expenditure accrued from AI model providers. | Team, Role, or Members |
|
||||
| **MCP Server Calls** | Number of tool invocations directed to a connected Model Context Protocol (MCP) server. | Target MCP Server ID |
|
||||
| **Sandboxed Bash Commands** | Shell commands executed by the agent inside the isolated sandbox. | Wildcard pattern (e.g. `npm *`, `*`) |
|
||||
| **Agent Tool Calls** | Calls to specific native tools (e.g. `analyze_image`, `screenshot`, `create_file`). | Tool name |
|
||||
| **Agent Tool Calls** | Calls to specific native tools (e.g. `read_asset`, `download_asset`, `create_file`). | Tool name |
|
||||
|
||||
### Bash Command Wildcard Matching
|
||||
|
||||
|
||||
@@ -74,6 +74,7 @@ export default tseslint.config(
|
||||
'**/packages/db/src/generated/**',
|
||||
'**/packages/core/src/generated/**',
|
||||
'**/data/**',
|
||||
'**/packages/core/src/provider/generator/**',
|
||||
'**/packages/webui/components/ui/**',
|
||||
'**/packages/webui/paraglide/**',
|
||||
'**/packages/webui/public/**',
|
||||
|
||||
+17
-17
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "shumai",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"repository": {
|
||||
@@ -13,8 +13,8 @@
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "bun run --hot apps/web/src/index.ts",
|
||||
"i18n:compile": "paraglide-js compile --project ./packages/webui/project.inlang --outdir ./packages/webui/paraglide --emit-ts-declarations --no-emit-git-ignore",
|
||||
"i18n:watch": "paraglide-js compile --project ./packages/webui/project.inlang --outdir ./packages/webui/paraglide --watch --emit-ts-declarations --no-emit-git-ignore",
|
||||
"i18n:compile": "paraglide-js compile --project ./packages/webui/project.inlang --outdir ./packages/webui/paraglide --emit-ts-declarations",
|
||||
"i18n:watch": "paraglide-js compile --project ./packages/webui/project.inlang --outdir ./packages/webui/paraglide --watch --emit-ts-declarations",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
|
||||
"test": "bun --bun vitest run",
|
||||
@@ -30,8 +30,8 @@
|
||||
"db:generate": "cd packages/db && bunx prisma generate",
|
||||
"worker:agent": "bun apps/agent/src/index.ts",
|
||||
"worker:transcode": "bun apps/transcode/src/index.ts",
|
||||
"build": "bun run build.ts",
|
||||
"build-npm": "bun scripts/build-npm.ts",
|
||||
"build": "bun run i18n:compile && bun run build.ts",
|
||||
"build-npm": "bun run i18n:compile && bun scripts/build-npm.ts",
|
||||
"prepublishOnly": "bun run build-npm && bun run lint && bun run typecheck",
|
||||
"publish": "bun run prepublishOnly && bun run scripts/publish.ts",
|
||||
"publish:dry": "bun run prepublishOnly && bun run scripts/publish.ts --dry-run",
|
||||
@@ -42,29 +42,29 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "10.0.1",
|
||||
"@inlang/paraglide-js": "2.20.0",
|
||||
"@inlang/paraglide-js": "2.25.0",
|
||||
"@playwright/test": "1.61.1",
|
||||
"@testcontainers/postgresql": "12.0.1",
|
||||
"@testcontainers/postgresql": "12.1.0",
|
||||
"@testing-library/dom": "10.4.1",
|
||||
"@testing-library/react": "16.3.2",
|
||||
"@types/bun": "1.3.14",
|
||||
"@testing-library/react": "16.3.3",
|
||||
"@types/bun": "1.4.0",
|
||||
"@types/node": "25.9.1",
|
||||
"bun-plugin-pino": "1.5.0",
|
||||
"bun-plugin-tailwind": "0.1.2",
|
||||
"bun-types": "1.3.14",
|
||||
"eslint": "10.4.1",
|
||||
"bun-types": "1.4.0",
|
||||
"eslint": "10.9.1",
|
||||
"eslint-config-prettier": "10.1.8",
|
||||
"eslint-plugin-prettier": "5.5.6",
|
||||
"eslint-plugin-react": "7.37.5",
|
||||
"globals": "17.6.0",
|
||||
"happy-dom": "20.10.6",
|
||||
"globals": "17.11.0",
|
||||
"happy-dom": "20.12.0",
|
||||
"pino-pretty": "13.1.3",
|
||||
"prisma": "7.8.0",
|
||||
"testcontainers": "12.0.1",
|
||||
"prisma": "7.10.0",
|
||||
"testcontainers": "12.1.0",
|
||||
"typescript": "6.0.3",
|
||||
"typescript-eslint": "8.60.1",
|
||||
"typescript-eslint": "8.68.0",
|
||||
"vite-tsconfig-paths": "6.1.1",
|
||||
"vitest": "4.1.8"
|
||||
"vitest": "4.1.11"
|
||||
},
|
||||
"patchedDependencies": {
|
||||
"@earendil-works/pi-ai@0.82.1": "patches/@earendil-works%2Fpi-ai@0.82.1.patch"
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
{
|
||||
"name": "@shumai/agent",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
"types": "./src/index.ts",
|
||||
"dependencies": {
|
||||
"@anthropic-ai/sandbox-runtime": "0.0.66",
|
||||
"@anthropic-ai/sandbox-runtime": "0.0.74",
|
||||
"@earendil-works/pi-agent-core": "0.82.1",
|
||||
"@earendil-works/pi-ai": "0.82.1",
|
||||
"@google/genai": "1.52.0",
|
||||
"@google/genai": "2.19.0",
|
||||
"@shumai/core": "workspace:*",
|
||||
"@shumai/db": "workspace:*",
|
||||
"@shumai/dtos": "workspace:*",
|
||||
"@shumai/workflow-core": "workspace:*",
|
||||
"@temporalio/activity": "1.17.2",
|
||||
"@temporalio/worker": "1.17.2",
|
||||
"@temporalio/workflow": "1.17.2",
|
||||
"adm-zip": "0.5.17",
|
||||
"@temporalio/activity": "1.23.0",
|
||||
"@temporalio/worker": "1.23.0",
|
||||
"@temporalio/workflow": "1.23.0",
|
||||
"adm-zip": "0.6.0",
|
||||
"jittered-fractional-indexing": "1.0.1",
|
||||
"typebox": "1.1.38",
|
||||
"typebox": "1.3.22",
|
||||
"ulid": "3.0.2",
|
||||
"zod": "4.4.3"
|
||||
"zod": "4.5.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/adm-zip": "0.5.8"
|
||||
|
||||
@@ -13,8 +13,8 @@ import {
|
||||
getCommentActivity,
|
||||
getProjectAutofillFieldsActivity,
|
||||
updateAssetMetadataActivity,
|
||||
getAssetPathHierarchyActivity,
|
||||
getAssetPathContextActivity,
|
||||
executeAgentToolActivity,
|
||||
generateSessionNameActivity,
|
||||
type GenerateSessionNameParams,
|
||||
getUserTeamInfoActivity,
|
||||
@@ -36,8 +36,6 @@ import {
|
||||
type Asset,
|
||||
} from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { uploadService } from '@shumai/core/src/upload/upload'
|
||||
|
||||
vi.mock('../index', async () => {
|
||||
const actual = await vi.importActual('../index')
|
||||
@@ -567,8 +565,18 @@ describe('Agent Database Activities Integration', () => {
|
||||
|
||||
describe('initializeAgentSessionActivity', () => {
|
||||
it('should initialize a session, create agent/user records if missing, and store existing comments context', async () => {
|
||||
const attAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'attached-doc.pdf',
|
||||
type: AssetType.file,
|
||||
mediaType: 'application/pdf',
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
// Create first comment so it acts as context
|
||||
await prisma.assetComment.create({
|
||||
const firstComment = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
message: 'Hello <@' + user.id + '> check this',
|
||||
@@ -576,6 +584,13 @@ describe('Agent Database Activities Integration', () => {
|
||||
},
|
||||
})
|
||||
|
||||
await prisma.assetCommentAttachment.create({
|
||||
data: {
|
||||
commentId: firstComment.id,
|
||||
assetId: attAsset.id,
|
||||
},
|
||||
})
|
||||
|
||||
await sleep(2)
|
||||
// Create second comment that user responds with, triggering session initialization
|
||||
const userComment = await prisma.assetComment.create({
|
||||
@@ -614,9 +629,20 @@ describe('Agent Database Activities Integration', () => {
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- entry data is stored as Json in DB and needs casting to check properties
|
||||
const parsedEntry = pathEntries[0] as any
|
||||
expect(parsedEntry.message.content[0].text).toContain(
|
||||
`[${user.name} (owner)]: Hello <@${user.name}> check this`,
|
||||
)
|
||||
expect(parsedEntry.type).toBe('custom_message')
|
||||
expect(parsedEntry.customType).toBe('shumai_message')
|
||||
expect(parsedEntry.content).toContain(`Hello <@${user.name}> check this`)
|
||||
expect(parsedEntry.details.user.name).toBe(user.name)
|
||||
expect(parsedEntry.details.user.role).toBe('owner')
|
||||
expect(parsedEntry.details.attachedFiles).toEqual([
|
||||
{
|
||||
id: attAsset.id,
|
||||
name: 'attached-doc.pdf',
|
||||
type: 'file',
|
||||
mediaType: undefined,
|
||||
mimeType: 'application/pdf',
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it('should distinguish Main Session (userCommentId: null) and Thread Session (userCommentId: rootId) during lazy sync', async () => {
|
||||
@@ -685,7 +711,7 @@ describe('Agent Database Activities Integration', () => {
|
||||
expect(threadSession1?.userCommentId).toBe(mainComment1.id) // Thread Session has userCommentId = rootComment.id
|
||||
})
|
||||
|
||||
it('should dynamically tag top-level comments with [Thread ID: id] even if thread was created after initial sync', async () => {
|
||||
it('should dynamically tag top-level comments with thread metadata in context even if thread was created after initial sync', async () => {
|
||||
const msg3 = await prisma.assetComment.create({
|
||||
data: { assetId: asset.id, message: 'Question in msg3', creatorId: user.id },
|
||||
})
|
||||
@@ -730,8 +756,13 @@ describe('Agent Database Activities Integration', () => {
|
||||
const msg3Entry = pathEntries.find((e) => e.id.includes(msg3.id))
|
||||
expect(msg3Entry).toBeDefined()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const text = (msg3Entry as any).message.content[0].text
|
||||
expect(text).toContain(`[Thread ID: ${msg3.id}] [Replies: 1]`)
|
||||
expect((msg3Entry as any).details?.thread).toEqual({
|
||||
id: msg3.id,
|
||||
replyCount: 1,
|
||||
})
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const text = (msg3Entry as any).content ?? (msg3Entry as any).message?.content[0]?.text
|
||||
expect(text).not.toContain(`[Thread ID: ${msg3.id}]`)
|
||||
})
|
||||
|
||||
it('should create separate thread sessions when agent is mentioned in top-level comments (msg3 & msg5) sharing DAG entries without duplication', async () => {
|
||||
@@ -953,7 +984,7 @@ describe('Agent Database Activities Integration', () => {
|
||||
).resolves.not.toThrow()
|
||||
})
|
||||
|
||||
it('should not tag Thread ID when only __CHAT__ placeholder comment exists under root comment', async () => {
|
||||
it('should not tag thread when only __CHAT__ placeholder comment exists under root comment', async () => {
|
||||
const rootComment = await prisma.assetComment.create({
|
||||
data: { assetId: asset.id, message: 'Root comment asking agent', creatorId: user.id },
|
||||
})
|
||||
@@ -980,8 +1011,7 @@ describe('Agent Database Activities Integration', () => {
|
||||
|
||||
expect(rootEntry).toBeDefined()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- entry data structure parsing
|
||||
const content = (rootEntry as any)?.message?.content?.[0]?.text || ''
|
||||
expect(content).not.toContain(`[Thread ID: ${rootComment.id}]`)
|
||||
expect((rootEntry as any)?.details?.thread).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should return user name and role for team member', async () => {
|
||||
@@ -1343,10 +1373,14 @@ describe('Agent Database Activities Integration', () => {
|
||||
})
|
||||
|
||||
const pathCtx = await getAssetPathContextActivity(targetAsset.id)
|
||||
expect(pathCtx).toContain('Path: RootFolder/SubFolder/TargetImage.webp')
|
||||
expect(pathCtx).toContain(`name: RootFolder, id: ${rootFolder.id}`)
|
||||
expect(pathCtx).toContain(`name: SubFolder, id: ${subfolder.id}`)
|
||||
expect(pathCtx).toContain(`name: TargetImage.webp, id: ${targetAsset.id}`)
|
||||
expect(pathCtx).toBe('RootFolder/SubFolder/TargetImage.webp')
|
||||
|
||||
const hierarchy = await getAssetPathHierarchyActivity(targetAsset.id)
|
||||
expect(hierarchy.path).toBe('RootFolder/SubFolder/TargetImage.webp')
|
||||
expect(hierarchy.ancestors).toEqual([
|
||||
{ id: rootFolder.id, name: 'RootFolder' },
|
||||
{ id: subfolder.id, name: 'SubFolder' },
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1378,556 +1412,6 @@ describe('Agent Database Activities Integration', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('executeAgentToolActivity', () => {
|
||||
beforeEach(() => {
|
||||
vi.spyOn(authzService, 'hasPermission').mockResolvedValue()
|
||||
vi.spyOn(uploadService, 'triggerPostUploadWorkflows').mockResolvedValue()
|
||||
})
|
||||
|
||||
describe('list_assets', () => {
|
||||
it('should list assets inside a folder with cursor pagination', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
await prisma.asset.create({
|
||||
data: {
|
||||
name: 'file1.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
},
|
||||
})
|
||||
|
||||
await prisma.asset.create({
|
||||
data: {
|
||||
name: 'subfolder1',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'list_assets',
|
||||
args: { parent: folder.id, page: 1, pageSize: 1 },
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
expect(res.assets.length).toBe(1)
|
||||
expect(res.pageInfo.cursor).toBeDefined()
|
||||
})
|
||||
|
||||
it('should resolve version_stack name and size from top child version when container name is empty', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
const versionStack = await prisma.asset.create({
|
||||
data: {
|
||||
name: '',
|
||||
type: AssetType.version_stack,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
},
|
||||
})
|
||||
|
||||
await prisma.asset.create({
|
||||
data: {
|
||||
name: 'banana_ghost.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: versionStack.id,
|
||||
sizeByte: 622960,
|
||||
sortIndex: '0|i00000:',
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'list_assets',
|
||||
args: { parent: folder.id, page: 1, pageSize: 10 },
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
const stackItem = res.assets.find(
|
||||
(a: { id: string; name: string; size: number; type: string }) => a.id === versionStack.id,
|
||||
)
|
||||
expect(stackItem).toBeDefined()
|
||||
expect(stackItem?.name).toBe('banana_ghost.txt')
|
||||
expect(stackItem?.size).toBe(622960)
|
||||
expect(stackItem?.type).toBe('version_stack')
|
||||
})
|
||||
})
|
||||
|
||||
describe('create_folder', () => {
|
||||
it('should create folder and increment parent fileCount', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 0,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_folder',
|
||||
args: { parent: folder.id, name: 'subfolder' },
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
expect(res.name).toBe('subfolder')
|
||||
expect(res.type).toBe('folder')
|
||||
|
||||
const parentFolder = await prisma.asset.findUnique({ where: { id: folder.id } })
|
||||
expect(parentFolder?.fileCount).toBe(1)
|
||||
})
|
||||
})
|
||||
|
||||
describe('create_file', () => {
|
||||
it('should create file, increment parent fileCount, and update parent sizes', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 0,
|
||||
sizeByte: 0,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: folder.id,
|
||||
s3Key: 'uploads/testfile.txt',
|
||||
name: 'testfile.txt',
|
||||
size: 500,
|
||||
contentType: 'text/plain',
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
expect(res.name).toBe('testfile.txt')
|
||||
expect(res.size).toBe(500)
|
||||
|
||||
const parentFolder = await prisma.asset.findUnique({ where: { id: folder.id } })
|
||||
expect(parentFolder?.fileCount).toBe(1)
|
||||
expect(Number(parentFolder?.sizeByte)).toBe(500)
|
||||
expect(uploadService.triggerPostUploadWorkflows).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should persist metadata on the created file when metadata map is provided', async () => {
|
||||
await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'prompt',
|
||||
scope: 'PROJECT',
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
config: { name: 'Prompt', type: 'text', autofillSource: 'CREATION_CONTEXT' },
|
||||
},
|
||||
})
|
||||
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 0,
|
||||
sizeByte: 0,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: folder.id,
|
||||
s3Key: 'uploads/ctx.txt',
|
||||
name: 'ctx.txt',
|
||||
size: 100,
|
||||
contentType: 'text/plain',
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
const val = await prisma.assetMetadataValue.findFirst({
|
||||
where: { assetId: res.id, fieldKey: 'prompt' },
|
||||
})
|
||||
expect(val?.stringValue).toBe('Generated using gemini')
|
||||
})
|
||||
|
||||
it('should persist select and selectMulti metadata with dynamic newOption', async () => {
|
||||
const selectField = await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'provider',
|
||||
scope: 'PROJECT',
|
||||
project: { connect: { id: project.id } },
|
||||
config: {
|
||||
name: 'Provider',
|
||||
type: 'select',
|
||||
autofillSource: 'CREATION_CONTEXT',
|
||||
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const multiField = await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'tags',
|
||||
scope: 'PROJECT',
|
||||
project: { connect: { id: project.id } },
|
||||
config: {
|
||||
name: 'Tags',
|
||||
type: 'selectMulti',
|
||||
autofillSource: 'CREATION_CONTEXT',
|
||||
selectMulti: { options: [{ id: 'tag1', displayName: 'Tag 1', color: '#3b82f6' }] },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 0,
|
||||
sizeByte: 0,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: folder.id,
|
||||
s3Key: 'uploads/new_opt.txt',
|
||||
name: 'new_opt.txt',
|
||||
size: 100,
|
||||
contentType: 'text/plain',
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
// Verify select field
|
||||
const providerVal = await prisma.assetMetadataValue.findFirst({
|
||||
where: { assetId: res.id, fieldKey: selectField.key },
|
||||
})
|
||||
expect(providerVal?.stringValue).toBe('kling')
|
||||
|
||||
// Verify select field config was updated with new option
|
||||
const updatedSelectField = await prisma.metadataField.findUnique({
|
||||
where: { key: selectField.key },
|
||||
})
|
||||
const selectOpts =
|
||||
(updatedSelectField?.config as PrismaJson.FieldConfig)?.select?.options || []
|
||||
expect(selectOpts.some((o) => o.displayName === 'Kling' && o.id === 'kling')).toBe(true)
|
||||
|
||||
// Verify selectMulti field
|
||||
const tagsVal = await prisma.assetMetadataValue.findFirst({
|
||||
where: { assetId: res.id, fieldKey: multiField.key },
|
||||
})
|
||||
expect(tagsVal?.jsonValue).toEqual(['tag1', 'tag-2'])
|
||||
|
||||
// Verify selectMulti field config was updated with new option
|
||||
const updatedMultiField = await prisma.metadataField.findUnique({
|
||||
where: { key: multiField.key },
|
||||
})
|
||||
const multiOpts =
|
||||
(updatedMultiField?.config as PrismaJson.FieldConfig)?.selectMulti?.options || []
|
||||
expect(multiOpts.some((o) => o.displayName === 'Tag 2' && o.id === 'tag-2')).toBe(true)
|
||||
})
|
||||
|
||||
it('should reject metadata with keys that are not valid in this project', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 0,
|
||||
sizeByte: 0,
|
||||
},
|
||||
})
|
||||
|
||||
await expect(
|
||||
executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: folder.id,
|
||||
s3Key: 'uploads/ctx.txt',
|
||||
name: 'ctx.txt',
|
||||
size: 100,
|
||||
contentType: 'text/plain',
|
||||
metadata: { prompt: 'ok', unknownKey: 'not allowed' },
|
||||
},
|
||||
userId: user.id,
|
||||
}),
|
||||
).rejects.toThrow(/not valid in this project/)
|
||||
|
||||
// No metadata value should have been written for the unknown key
|
||||
const val = await prisma.assetMetadataValue.findFirst({
|
||||
where: { fieldKey: 'unknownKey' },
|
||||
})
|
||||
expect(val).toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
describe('create_version', () => {
|
||||
it('should create a version stack when parent is a regular file', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 1,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const fileAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'v1.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: fileAsset.id,
|
||||
s3Key: 'uploads/v2.txt',
|
||||
name: 'v2.txt',
|
||||
size: 300,
|
||||
contentType: 'text/plain',
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
expect(res.name).toBe('v2.txt')
|
||||
expect(res.size).toBe(300)
|
||||
|
||||
// Check version stack was created
|
||||
const stack = await prisma.asset.findFirst({
|
||||
where: { type: AssetType.version_stack, projectId: project.id },
|
||||
include: { children: true },
|
||||
})
|
||||
|
||||
expect(stack).not.toBeNull()
|
||||
expect(stack?.children.length).toBe(2) // v1.txt and v2.txt should both be inside the stack
|
||||
})
|
||||
|
||||
it('should add to version stack when parent is already inside a version stack', async () => {
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
|
||||
const stack = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'VersionStack',
|
||||
type: AssetType.version_stack,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
fileCount: 1,
|
||||
sizeByte: 100,
|
||||
},
|
||||
})
|
||||
|
||||
const existingFileVersion = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'v1.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: stack.id,
|
||||
sizeByte: 100,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: existingFileVersion.id,
|
||||
s3Key: 'uploads/v2.txt',
|
||||
name: 'v2.txt',
|
||||
size: 250,
|
||||
contentType: 'text/plain',
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
expect(res.name).toBe('v2.txt')
|
||||
|
||||
const updatedStack = await prisma.asset.findUnique({
|
||||
where: { id: stack.id },
|
||||
include: { children: true },
|
||||
})
|
||||
|
||||
expect(updatedStack?.fileCount).toBe(2)
|
||||
expect(Number(updatedStack?.sizeByte)).toBe(350)
|
||||
})
|
||||
|
||||
it('should persist metadata on the created version when metadata map is provided', async () => {
|
||||
await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'prompt',
|
||||
scope: 'PROJECT',
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
config: { name: 'Prompt', type: 'text', autofillSource: 'CREATION_CONTEXT' },
|
||||
},
|
||||
})
|
||||
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 1,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const fileAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'v1.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: fileAsset.id,
|
||||
s3Key: 'uploads/v2.txt',
|
||||
name: 'v2.txt',
|
||||
size: 300,
|
||||
contentType: 'text/plain',
|
||||
metadata: { prompt: 'Generated using seedance' },
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
const val = await prisma.assetMetadataValue.findFirst({
|
||||
where: { assetId: res.id, fieldKey: 'prompt' },
|
||||
})
|
||||
expect(val?.stringValue).toBe('Generated using seedance')
|
||||
})
|
||||
|
||||
it('should persist select and selectMulti newOption metadata in create_version', async () => {
|
||||
const selectField = await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'versionProvider',
|
||||
scope: 'PROJECT',
|
||||
project: { connect: { id: project.id } },
|
||||
config: {
|
||||
name: 'Version Provider',
|
||||
type: 'select',
|
||||
autofillSource: 'CREATION_CONTEXT',
|
||||
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const folder = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'WorkspaceFolder',
|
||||
type: AssetType.folder,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
fileCount: 1,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const fileAsset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'v1.txt',
|
||||
type: AssetType.file,
|
||||
status: AssetStatus.uploaded,
|
||||
projectId: project.id,
|
||||
parentId: folder.id,
|
||||
sizeByte: 200,
|
||||
},
|
||||
})
|
||||
|
||||
const res = await executeAgentToolActivity({
|
||||
taskId: 'task-1',
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: fileAsset.id,
|
||||
s3Key: 'uploads/v2.txt',
|
||||
name: 'v2.txt',
|
||||
size: 300,
|
||||
contentType: 'text/plain',
|
||||
metadata: {
|
||||
versionProvider: { newOption: { value: 'Midjourney' } },
|
||||
},
|
||||
},
|
||||
userId: user.id,
|
||||
})
|
||||
|
||||
const val = await prisma.assetMetadataValue.findFirst({
|
||||
where: { assetId: res.id, fieldKey: selectField.key },
|
||||
})
|
||||
expect(val?.stringValue).toBe('midjourney')
|
||||
|
||||
const updatedField = await prisma.metadataField.findUnique({
|
||||
where: { key: selectField.key },
|
||||
})
|
||||
const opts = (updatedField?.config as PrismaJson.FieldConfig)?.select?.options || []
|
||||
expect(opts.some((o) => o.displayName === 'Midjourney' && o.id === 'midjourney')).toBe(true)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('generateSessionNameActivity', () => {
|
||||
it('should generate and save session name for chat sessions', async () => {
|
||||
await prisma.team.create({
|
||||
@@ -2216,5 +1700,77 @@ describe('Agent Database Activities Integration', () => {
|
||||
'<project_instructions path="/subfolder/AGENTS.md">\n# Subfolder Policy\n</project_instructions>',
|
||||
)
|
||||
})
|
||||
|
||||
it('agentChatActivity injects # Comment Threads into systemPrompt when userCommentId is present', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User_Comment_Prompt', email: `comment-prompt-${Date.now()}@example.com` },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Team_Comment_Prompt_' + Date.now() },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Project_Comment_Prompt', teamId: team.id },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'Asset_1',
|
||||
type: AssetType.file,
|
||||
projectId: project.id,
|
||||
status: AssetStatus.uploaded,
|
||||
},
|
||||
})
|
||||
const comment = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
message: 'Question',
|
||||
creatorId: user.id,
|
||||
},
|
||||
})
|
||||
|
||||
const mockHarness = {
|
||||
subscribe: vi.fn(),
|
||||
prompt: vi.fn().mockResolvedValue({
|
||||
content: [{ type: 'text', text: 'Chat reply' }],
|
||||
usage: { input: 10, output: 20 },
|
||||
}),
|
||||
}
|
||||
const mockSession = {
|
||||
getEntries: vi.fn().mockResolvedValue([]),
|
||||
getStorage: vi.fn().mockReturnValue({ sessionId: 'mock-session-id' }),
|
||||
}
|
||||
|
||||
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('# Comment Threads')
|
||||
expect(systemPromptArg).toContain('<thread id="..." reply_count="..." />')
|
||||
expect(systemPromptArg).toContain('read_thread')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,29 +1,15 @@
|
||||
import {
|
||||
type AgentMessage,
|
||||
type AgentTool,
|
||||
type SessionTreeEntry,
|
||||
} from '@earendil-works/pi-agent-core'
|
||||
import { type AgentMessage, type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { type ImageContent } from '@earendil-works/pi-ai'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import {
|
||||
authzService,
|
||||
Permission,
|
||||
ResourceType,
|
||||
resolveEffectiveRole,
|
||||
} from '@shumai/core/src/authz/authz'
|
||||
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
import { mcpService } from '@shumai/core/src/mcp/mcp-service'
|
||||
import { metadataService } from '@shumai/core/src/metadata/metadata'
|
||||
import { encodeCursor, paginateQuery } from '@shumai/core/src/pagination'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { uploadService } from '@shumai/core/src/upload/upload'
|
||||
import { VersionStackService } from '@shumai/core/src/versionStack/versionStack'
|
||||
import { getAgentRequiredLevel, getRoleLevel } from '@shumai/core/src/agent/permissions'
|
||||
import { AssetType, prisma, Prisma, type Skill } from '@shumai/db'
|
||||
import { registerLocalCancelHandler, unregisterLocalCancelHandler } from '@shumai/workflow-core'
|
||||
import { ApplicationFailure, Context } from '@temporalio/activity'
|
||||
import { generateKeyBetween } from 'jittered-fractional-indexing'
|
||||
import { ulid } from 'ulid'
|
||||
import { DatabaseSessionStorage } from '../database-session-storage'
|
||||
import {
|
||||
createAgentSession,
|
||||
@@ -34,7 +20,11 @@ import {
|
||||
|
||||
import { aiUsageService } from '@shumai/core/src/ai-usage/ai-usage'
|
||||
import { quotaService, QuotaExceededError } from '@shumai/core/src/quota/quota-service'
|
||||
import { UpdateAssetMetadataRequest } from '@shumai/dtos'
|
||||
import {
|
||||
UpdateAssetMetadataRequest,
|
||||
type ShumaiMessageContext,
|
||||
type ShumaiMediaPosition,
|
||||
} from '@shumai/dtos'
|
||||
|
||||
export interface Usage {
|
||||
inputTokens: number
|
||||
@@ -90,7 +80,7 @@ async function executeAgentPrompt(params: {
|
||||
agentId: string
|
||||
prompt: string
|
||||
images: string[]
|
||||
agentsInstruction: string
|
||||
messageContext?: ShumaiMessageContext
|
||||
sessionId?: string
|
||||
userId?: string
|
||||
projectId?: string
|
||||
@@ -121,19 +111,19 @@ async function executeAgentPrompt(params: {
|
||||
let systemPrompt = `You are the AI assistant for shumai.
|
||||
shumai is a professional creative collaboration platform similar to frame.io, where users can upload creative files, manage projects, assign tasks, get precise feedback, and share their work. As the agent, your role is to help users use and manage this platform.
|
||||
|
||||
shumai has its own cloud file system. If a user asks you to perform file system operations (for example: creating a folder, creating a file, stacking a version, or listing assets), you MUST use the corresponding agent system tools (e.g., 'create_folder', 'create_file', 'create_version', 'list_assets'). Before calling 'create_folder', first check if the folder exists using 'list_assets'. Do NOT use local bash commands or the local bash tool to perform these operations locally on the host environment; all operations must be executed through the platform's cloud file system tools so they are correctly registered and visible within the platform.
|
||||
shumai has its own cloud file system. If a user asks you to perform file system operations (for example: creating a folder, creating a file, stacking a version, listing assets, renaming an asset, moving assets, or deleting an asset), you MUST use the corresponding agent system tools (e.g., 'create_folder', 'create_file', 'create_version', 'list_assets', 'rename_asset', 'move_assets', 'delete_asset'). Before calling 'create_folder', first check if the folder exists using 'list_assets'. Do NOT use local bash commands or the local bash tool to perform these operations locally on the host environment; all operations must be executed through the platform's cloud file system tools so they are correctly registered and visible within the platform.
|
||||
|
||||
If you need to create files in the local filesystem (for example, a temporary file for uploading), only the '.pi' folder in the current directory has write permissions. Do NOT attempt to create files in any other directories.
|
||||
|
||||
When creating a file or version, you may attach metadata (for example, the AI model or prompt used to generate the asset). The allowed field keys and value types are declared directly in the 'metadata' parameter of the 'create_file' and 'create_version' tools.`
|
||||
When creating a file or version, you may attach metadata (for example, the AI model or prompt used to generate the asset). The allowed field keys and value types are declared directly in the 'metadata' parameter of the 'create_file' and 'create_version' tools.
|
||||
|
||||
# Message Context & Tools
|
||||
User messages may contain a <context> block detailing the user, active asset location, playback position, and attachments. Use the asset IDs from <context> when invoking tools (e.g. 'read_asset', 'download_asset', 'list_assets'). When an <annotation id="..." /> tag is present, it indicates the user has drawn visual markups on the asset at the specified position. When calling 'read_asset', pass the 'annotationId' parameter with that ID to view the image or rendered pages with the visual markups overlaid.`
|
||||
|
||||
if (agent.soul) {
|
||||
systemPrompt = `${systemPrompt}\n\nAgent Personality and Core Instructions:\n${agent.soul}`
|
||||
}
|
||||
|
||||
// Note: params.agentsInstruction is no longer appended to systemPrompt here.
|
||||
// Instead, it is persisted as a custom message session entry in the conversation history below.
|
||||
|
||||
let targetAssetId = params.assetId
|
||||
if (!targetAssetId) {
|
||||
if (params.userCommentId) {
|
||||
@@ -173,6 +163,21 @@ When creating a file or version, you may attach metadata (for example, the AI mo
|
||||
systemPrompt += `\n\nYour current model supports the following input types: ${modelConfig.input.join(', ')}.`
|
||||
}
|
||||
|
||||
const isCommentMode =
|
||||
!!params.userCommentId ||
|
||||
(params.sessionId
|
||||
? (
|
||||
await prisma.agentSession.findUnique({
|
||||
where: { id: params.sessionId },
|
||||
select: { type: true },
|
||||
})
|
||||
)?.type === 'comment'
|
||||
: false)
|
||||
|
||||
if (isCommentMode) {
|
||||
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.`
|
||||
}
|
||||
|
||||
const agentConfig = agent.config as PrismaJson.AgentConfig | null | undefined
|
||||
const thinkingLevel = agentConfig?.thinkingLevel || 'off'
|
||||
|
||||
@@ -264,32 +269,9 @@ When creating a file or version, you may attach metadata (for example, the AI mo
|
||||
}
|
||||
|
||||
try {
|
||||
if (params.agentsInstruction && params.agentsInstruction.trim()) {
|
||||
const storage = session.getStorage()
|
||||
const parentId = await storage.getLeafId()
|
||||
await storage.appendEntry({
|
||||
id: ulid(),
|
||||
type: 'custom_message',
|
||||
parentId,
|
||||
timestamp: new Date().toISOString(),
|
||||
customType: 'context',
|
||||
content: params.agentsInstruction.trim(),
|
||||
} as unknown as SessionTreeEntry)
|
||||
}
|
||||
|
||||
if (params.attachedAssets && params.attachedAssets.length > 0) {
|
||||
const storage = session.getStorage()
|
||||
const parentId = await storage.getLeafId()
|
||||
await storage.appendEntry({
|
||||
id: ulid(),
|
||||
type: 'custom',
|
||||
parentId,
|
||||
timestamp: new Date().toISOString(),
|
||||
customType: 'context_display_info',
|
||||
data: {
|
||||
assets: params.attachedAssets,
|
||||
},
|
||||
} as unknown as SessionTreeEntry)
|
||||
const storage = session.getStorage()
|
||||
if (storage instanceof DatabaseSessionStorage && params.messageContext) {
|
||||
storage.currentMessageContext = params.messageContext
|
||||
}
|
||||
|
||||
let totalInputTokens = 0
|
||||
@@ -423,7 +405,7 @@ When creating a file or version, you may attach metadata (for example, the AI mo
|
||||
|
||||
const sessionEntries = await session.getEntries()
|
||||
sessionEntries.forEach((entry) => {
|
||||
if (entry.type === 'message') {
|
||||
if (entry.type === 'message' && entry.message) {
|
||||
const msg = entry.message
|
||||
if (msg.role === 'toolResult') {
|
||||
const logMsg = { ...msg, content: undefined }
|
||||
@@ -460,7 +442,6 @@ When creating a file or version, you may attach metadata (for example, the AI mo
|
||||
cost: totalCost,
|
||||
}
|
||||
|
||||
const storage = session.getStorage()
|
||||
let sessionId = ''
|
||||
if (storage instanceof DatabaseSessionStorage) {
|
||||
sessionId = storage.sessionId
|
||||
@@ -488,11 +469,11 @@ export interface AgentChatParams {
|
||||
projectId: string
|
||||
folderId: string
|
||||
assetId?: string
|
||||
agentsInstruction?: string
|
||||
sessionId: string
|
||||
userId?: string
|
||||
userCommentId?: string | null
|
||||
context: AgentExecutionContext
|
||||
messageContext?: ShumaiMessageContext
|
||||
attachedAssets?: Array<{ id: string; name: string; type: string }>
|
||||
}
|
||||
|
||||
@@ -522,40 +503,19 @@ export async function agentChatActivity(params: AgentChatParams) {
|
||||
const cleanMessage = params.message.replace(/<@[A-Z0-9]+>/g, '').trim()
|
||||
const sessionId = params.sessionId
|
||||
|
||||
let prompt = cleanMessage
|
||||
if (params.userCommentId) {
|
||||
let targetUserId = params.userId
|
||||
if (!targetUserId) {
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: params.userCommentId },
|
||||
select: { creatorId: true },
|
||||
})
|
||||
targetUserId = comment?.creatorId || undefined
|
||||
}
|
||||
if (targetUserId) {
|
||||
const userInfo = await getUserTeamInfoActivity({
|
||||
userId: targetUserId,
|
||||
teamId: params.teamId,
|
||||
})
|
||||
if (userInfo) {
|
||||
prompt = `[${userInfo.name} (${userInfo.role})]: ${cleanMessage}`
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return executeAgentPrompt({
|
||||
taskId: params.taskId,
|
||||
teamId: params.teamId,
|
||||
agentId: params.agentId,
|
||||
prompt,
|
||||
prompt: cleanMessage,
|
||||
images: params.imageUrls,
|
||||
agentsInstruction: params.agentsInstruction || '',
|
||||
sessionId,
|
||||
userId: params.userId,
|
||||
projectId: params.projectId,
|
||||
assetId: params.assetId || params.folderId,
|
||||
userCommentId: params.userCommentId,
|
||||
context: params.context,
|
||||
messageContext: params.messageContext,
|
||||
attachedAssets: params.attachedAssets,
|
||||
})
|
||||
}
|
||||
@@ -597,7 +557,6 @@ export async function autofillAiActivity(params: AutofillAiParams) {
|
||||
agentId: agent.id,
|
||||
prompt: fullPrompt,
|
||||
images: params.images,
|
||||
agentsInstruction: '',
|
||||
sessionId: undefined,
|
||||
userId: undefined,
|
||||
projectId: params.projectId,
|
||||
@@ -720,7 +679,10 @@ export async function initializeAgentSessionActivity(params: {
|
||||
createdAt: { lte: rootComment.createdAt },
|
||||
},
|
||||
orderBy: { id: 'asc' },
|
||||
include: { creator: true },
|
||||
include: {
|
||||
creator: true,
|
||||
attachments: { include: { asset: true } },
|
||||
},
|
||||
})
|
||||
|
||||
// 2. Fetch thread replies up to userComment.createdAt excluding userComment itself
|
||||
@@ -732,7 +694,10 @@ export async function initializeAgentSessionActivity(params: {
|
||||
id: { not: userComment.id },
|
||||
},
|
||||
orderBy: { id: 'asc' },
|
||||
include: { creator: true },
|
||||
include: {
|
||||
creator: true,
|
||||
attachments: { include: { asset: true } },
|
||||
},
|
||||
})
|
||||
: []
|
||||
|
||||
@@ -782,7 +747,13 @@ export async function initializeAgentSessionActivity(params: {
|
||||
}
|
||||
}
|
||||
|
||||
function formatCommentMessage(c: (typeof allCommentsToSync)[0]): string {
|
||||
const assetRecord = await prisma.asset.findUnique({
|
||||
where: { id: userComment.assetId },
|
||||
select: { media: true },
|
||||
})
|
||||
const proxyType = (assetRecord?.media as PrismaJson.MediaInfo | null)?.proxyType
|
||||
|
||||
function buildCommentEntry(c: (typeof allCommentsToSync)[0]) {
|
||||
const isAgent = c.creator?.type === 'agent' || c.sessionId !== null
|
||||
let messageContent = c.message || ''
|
||||
|
||||
@@ -792,13 +763,88 @@ export async function initializeAgentSessionActivity(params: {
|
||||
})
|
||||
|
||||
if (isAgent) {
|
||||
const agentName = c.creator?.name || 'Ai Agent'
|
||||
return `[Agent Message][${agentName}]: ${messageContent}`
|
||||
} else if (c.creator?.name) {
|
||||
const message: AgentMessage = {
|
||||
role: 'assistant',
|
||||
content: [{ type: 'text', text: messageContent }],
|
||||
api: 'custom',
|
||||
provider: 'shumai',
|
||||
model: 'agent',
|
||||
usage: {
|
||||
input: 0,
|
||||
output: 0,
|
||||
cacheRead: 0,
|
||||
cacheWrite: 0,
|
||||
totalTokens: 0,
|
||||
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0, total: 0 },
|
||||
},
|
||||
stopReason: 'stop',
|
||||
timestamp: c.createdAt.getTime(),
|
||||
}
|
||||
return {
|
||||
type: 'message' as const,
|
||||
data: { message },
|
||||
}
|
||||
}
|
||||
|
||||
let userObj: ShumaiMessageContext['user'] = undefined
|
||||
if (c.creator) {
|
||||
const role = (c.creatorId ? userRoleMap.get(c.creatorId) : undefined) || 'user'
|
||||
return `[${c.creator.name} (${role})]: ${messageContent}`
|
||||
userObj = {
|
||||
id: c.creator.id,
|
||||
name: c.creator.name || 'Unknown',
|
||||
role,
|
||||
}
|
||||
}
|
||||
|
||||
let position: ShumaiMediaPosition | undefined = undefined
|
||||
if (c.second !== null && c.second !== undefined) {
|
||||
if (proxyType === 'pdf') {
|
||||
position = { type: 'page', page: Math.round(c.second) }
|
||||
} else {
|
||||
position = { type: 'time', seconds: c.second }
|
||||
}
|
||||
}
|
||||
|
||||
const annotation = !!(c.annotation && Array.isArray(c.annotation) && c.annotation.length > 0)
|
||||
|
||||
const attachedFiles: ShumaiMessageContext['attachedFiles'] = []
|
||||
if (c.attachments && c.attachments.length > 0) {
|
||||
for (const att of c.attachments) {
|
||||
if (att.asset) {
|
||||
const attProxyType = (att.asset.media as PrismaJson.MediaInfo | null)?.proxyType
|
||||
attachedFiles.push({
|
||||
id: att.asset.id,
|
||||
name: att.asset.name,
|
||||
type: att.asset.type,
|
||||
mediaType: attProxyType as 'image' | 'video' | 'pdf' | 'audio' | 'other' | undefined,
|
||||
mimeType: att.asset.mediaType || undefined,
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const commentDetails: ShumaiMessageContext = {
|
||||
id: c.id,
|
||||
...(userObj ? { user: userObj } : {}),
|
||||
...(position ? { position } : {}),
|
||||
...(annotation
|
||||
? {
|
||||
annotation: true,
|
||||
annotations: c.annotation as unknown as ShumaiMessageContext['annotations'],
|
||||
}
|
||||
: {}),
|
||||
...(attachedFiles.length > 0 ? { attachedFiles } : {}),
|
||||
}
|
||||
|
||||
return {
|
||||
type: 'custom_message' as const,
|
||||
data: {
|
||||
customType: 'shumai_message',
|
||||
content: messageContent,
|
||||
display: true,
|
||||
details: commentDetails,
|
||||
},
|
||||
}
|
||||
return messageContent
|
||||
}
|
||||
|
||||
// 3. Sync top-level comments into agent_session_entries (DAG spine)
|
||||
@@ -810,21 +856,16 @@ export async function initializeAgentSessionActivity(params: {
|
||||
})
|
||||
|
||||
if (!existingEntry) {
|
||||
const messageContent = formatCommentMessage(c)
|
||||
const message: AgentMessage = {
|
||||
role: 'user',
|
||||
content: [{ type: 'text', text: messageContent }],
|
||||
timestamp: c.createdAt.getTime(),
|
||||
}
|
||||
const entryData = buildCommentEntry(c)
|
||||
await prisma.agentSessionEntry.create({
|
||||
data: {
|
||||
id: c.id,
|
||||
sessionId: mainSession.id,
|
||||
assetId: userComment.assetId,
|
||||
type: 'message',
|
||||
type: entryData.type,
|
||||
parentId: mainPrevId,
|
||||
createdAt: c.createdAt,
|
||||
data: { message },
|
||||
data: entryData.data as PrismaJson.PiSessionEntryData,
|
||||
},
|
||||
})
|
||||
}
|
||||
@@ -850,21 +891,16 @@ export async function initializeAgentSessionActivity(params: {
|
||||
})
|
||||
|
||||
if (!existingReplyEntry) {
|
||||
const messageContent = formatCommentMessage(reply)
|
||||
const message: AgentMessage = {
|
||||
role: 'user',
|
||||
content: [{ type: 'text', text: messageContent }],
|
||||
timestamp: reply.createdAt.getTime(),
|
||||
}
|
||||
const entryData = buildCommentEntry(reply)
|
||||
await prisma.agentSessionEntry.create({
|
||||
data: {
|
||||
id: reply.id,
|
||||
sessionId: session.id,
|
||||
assetId: userComment.assetId,
|
||||
type: 'message',
|
||||
type: entryData.type,
|
||||
parentId: lastReplyParentId,
|
||||
createdAt: reply.createdAt,
|
||||
data: { message },
|
||||
data: entryData.data as PrismaJson.PiSessionEntryData,
|
||||
},
|
||||
})
|
||||
}
|
||||
@@ -1175,6 +1211,7 @@ export async function getAssetActivity(assetId: string) {
|
||||
},
|
||||
})
|
||||
|
||||
let resolvedAsset = asset
|
||||
if (asset && asset.type === AssetType.version_stack) {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
@@ -1190,21 +1227,71 @@ export async function getAssetActivity(assetId: string) {
|
||||
})
|
||||
|
||||
if (latestVersion) {
|
||||
return {
|
||||
resolvedAsset = {
|
||||
...latestVersion,
|
||||
project: latestVersion.project ?? asset.project,
|
||||
}
|
||||
} as typeof asset
|
||||
}
|
||||
}
|
||||
|
||||
return asset
|
||||
if (!resolvedAsset) return null
|
||||
|
||||
let url: string | undefined
|
||||
if (resolvedAsset.storageKey?.key) {
|
||||
try {
|
||||
url = await s3Service.presign(
|
||||
process.env.S3_BUCKET || 'shumai',
|
||||
resolvedAsset.storageKey.key,
|
||||
'GET',
|
||||
)
|
||||
} catch {
|
||||
// Ignore presign errors
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
...resolvedAsset,
|
||||
url,
|
||||
}
|
||||
}
|
||||
|
||||
export async function getCommentActivity(commentId: string) {
|
||||
return prisma.assetComment.findUnique({
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: commentId },
|
||||
include: { attachments: { include: { asset: { include: { storageKey: true } } } } },
|
||||
include: {
|
||||
attachments: {
|
||||
include: { asset: { include: { storageKey: true } } },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
if (!comment) return null
|
||||
|
||||
const attachmentsWithUrl = await Promise.all(
|
||||
comment.attachments.map(async (att) => {
|
||||
let url: string | undefined
|
||||
if (att.asset?.storageKey?.key) {
|
||||
try {
|
||||
url = await s3Service.presign(
|
||||
process.env.S3_BUCKET || 'shumai',
|
||||
att.asset.storageKey.key,
|
||||
'GET',
|
||||
)
|
||||
} catch {
|
||||
// Ignore
|
||||
}
|
||||
}
|
||||
return {
|
||||
...att,
|
||||
asset: att.asset ? { ...att.asset, url } : null,
|
||||
}
|
||||
}),
|
||||
)
|
||||
|
||||
return {
|
||||
...comment,
|
||||
attachments: attachmentsWithUrl,
|
||||
}
|
||||
}
|
||||
|
||||
export async function getProjectAutofillFieldsActivity(projectId: string) {
|
||||
@@ -1219,7 +1306,9 @@ export async function updateAssetMetadataActivity(params: {
|
||||
return metadataService.updateAssetMetadata(params.assetId, params.metadata)
|
||||
}
|
||||
|
||||
export async function getAssetPathContextActivity(assetId: string): Promise<string> {
|
||||
export async function getAssetPathHierarchyActivity(
|
||||
assetId: string,
|
||||
): Promise<{ path: string; ancestors: Array<{ id: string; name: string }> }> {
|
||||
const parts: { name: string; id: string }[] = []
|
||||
let currentId: string | null = assetId
|
||||
|
||||
@@ -1238,469 +1327,16 @@ export async function getAssetPathContextActivity(assetId: string): Promise<stri
|
||||
currentId = assetNode.parentId
|
||||
}
|
||||
|
||||
if (parts.length === 0) return ''
|
||||
if (parts.length === 0) return { path: '', ancestors: [] }
|
||||
|
||||
const pathStr = parts.map((p) => p.name).join('/')
|
||||
let contextStr = `Path: ${pathStr}\n\n`
|
||||
for (const part of parts) {
|
||||
contextStr += `name: ${part.name}, id: ${part.id}\n`
|
||||
}
|
||||
|
||||
return contextStr
|
||||
const path = parts.map((p) => p.name).join('/')
|
||||
const ancestors = parts.slice(0, -1)
|
||||
return { path, ancestors }
|
||||
}
|
||||
|
||||
export interface ExecuteAgentToolParams {
|
||||
taskId: string
|
||||
toolName: string
|
||||
// args are dynamic JSON arguments passed from the agent harness at runtime
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
args: any
|
||||
userId?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates that every metadata key provided by the agent is a defined
|
||||
* CREATION_CONTEXT field of the project. Unknown keys are rejected with a
|
||||
* non-retryable failure so Temporal does not retry expected validation errors.
|
||||
*/
|
||||
async function validateCreationContextMetadata(
|
||||
userId: string,
|
||||
projectId: string,
|
||||
metadata: Record<string, unknown> | undefined,
|
||||
): Promise<void> {
|
||||
if (!metadata || Object.keys(metadata).length === 0) return
|
||||
|
||||
const fields = await metadataService.listProjectFields(userId, projectId)
|
||||
const allowedKeys = new Set(
|
||||
fields
|
||||
.filter((f) => f.field.config?.autofillSource === 'CREATION_CONTEXT')
|
||||
.map((f) => f.field.key),
|
||||
)
|
||||
const invalidKeys = Object.keys(metadata).filter((key) => !allowedKeys.has(key))
|
||||
if (invalidKeys.length > 0) {
|
||||
throw ApplicationFailure.create({
|
||||
message:
|
||||
`metadata contains keys that are not valid in this project: ${invalidKeys.join(', ')}. ` +
|
||||
"The valid metadata fields are fixed to the current conversation's project. " +
|
||||
'If the target folder or file belongs to a different project, call the tool WITHOUT the metadata parameter.',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Activity return type is a union of tool result shapes
|
||||
export async function executeAgentToolActivity(params: ExecuteAgentToolParams): Promise<any> {
|
||||
const { toolName, args, userId } = params
|
||||
if (!userId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'User ID is required for tool authz',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// 1. Fetch User
|
||||
const user = await prisma.user.findUnique({ where: { id: userId } })
|
||||
if (!user) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `User not found: ${userId}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// 2. Perform Authz and Action based on toolName
|
||||
switch (toolName) {
|
||||
case 'list_assets': {
|
||||
const parent = args.parent
|
||||
if (!parent) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'parent parameter is required',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Authz check
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: parent,
|
||||
})
|
||||
|
||||
const page = args.page || 1
|
||||
const pageSize = args.pageSize || 20
|
||||
const type = args.type || 'all'
|
||||
|
||||
// We need to list files and folders of parent dir
|
||||
const where: Prisma.AssetWhereInput = {
|
||||
parentId: parent,
|
||||
isDeleted: false,
|
||||
}
|
||||
if (type === 'file') {
|
||||
where.type = { in: ['file', 'version_stack'] }
|
||||
} else if (type === 'folder') {
|
||||
where.type = 'folder'
|
||||
} else {
|
||||
where.type = { in: ['file', 'folder', 'version_stack'] }
|
||||
}
|
||||
|
||||
const limit = pageSize
|
||||
const offset = (page - 1) * limit
|
||||
const after = offset > 0 ? encodeCursor(offset) : undefined
|
||||
|
||||
const { data: assets, pageInfo } = await paginateQuery<
|
||||
Prisma.AssetGetPayload<Record<string, never>>
|
||||
>(
|
||||
async (skip, take) => {
|
||||
return prisma.asset.findMany({
|
||||
where,
|
||||
orderBy: { id: 'desc' }, // sort desc per ULID default in sorting guidelines!
|
||||
skip,
|
||||
take,
|
||||
})
|
||||
},
|
||||
async () => prisma.asset.count({ where }),
|
||||
{ first: limit, after },
|
||||
)
|
||||
|
||||
const stackIds = assets.filter((a) => a.type === AssetType.version_stack).map((a) => a.id)
|
||||
|
||||
const latestVersionsMap = new Map<string, Prisma.AssetGetPayload<Record<string, never>>>()
|
||||
|
||||
if (stackIds.length > 0) {
|
||||
const versions = await prisma.asset.findMany({
|
||||
where: { parentId: { in: stackIds }, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
})
|
||||
for (const v of versions) {
|
||||
if (!latestVersionsMap.has(v.parentId!)) {
|
||||
latestVersionsMap.set(v.parentId!, v)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// return asset id, asset name, asset type, asset size (sizeByte or size)
|
||||
const results = assets.map((a) => {
|
||||
const latestVersion = latestVersionsMap.get(a.id)
|
||||
return {
|
||||
id: a.id,
|
||||
name: a.type === AssetType.version_stack ? (latestVersion?.name ?? a.name) : a.name,
|
||||
type: a.type,
|
||||
size:
|
||||
a.type === AssetType.version_stack && latestVersion
|
||||
? Number(latestVersion.sizeByte)
|
||||
: Number(a.sizeByte),
|
||||
}
|
||||
})
|
||||
|
||||
return {
|
||||
assets: results,
|
||||
pageInfo,
|
||||
}
|
||||
}
|
||||
|
||||
case 'create_folder': {
|
||||
const parent = args.parent
|
||||
const name = args.name
|
||||
if (!parent || !name) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'parent and name parameters are required',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Authz check
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: parent,
|
||||
})
|
||||
|
||||
const newFolder = await assetService.createAsset({
|
||||
name,
|
||||
parentId: parent,
|
||||
type: 'folder',
|
||||
creatorId: userId,
|
||||
})
|
||||
|
||||
return {
|
||||
id: newFolder.id,
|
||||
name: newFolder.name,
|
||||
type: newFolder.type,
|
||||
size: Number(newFolder.sizeByte),
|
||||
}
|
||||
}
|
||||
|
||||
case 'create_file': {
|
||||
const parent = args.parent
|
||||
const s3Key = args.s3Key as string
|
||||
const name = args.name as string
|
||||
const fileSize = args.size as number
|
||||
const mimeType = args.contentType as string
|
||||
const metadata =
|
||||
typeof args.metadata === 'object' && args.metadata !== null
|
||||
? (args.metadata as Record<string, unknown>)
|
||||
: undefined
|
||||
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'parent, s3Key, name, size, and contentType parameters are required',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Authz check
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: parent,
|
||||
})
|
||||
|
||||
// Fetch parent folder to resolve projectId and teamId
|
||||
const parentAsset = await prisma.asset.findUnique({
|
||||
where: { id: parent },
|
||||
include: { project: true },
|
||||
})
|
||||
if (!parentAsset) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Parent folder not found with ID: ${parent}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
if (!parentAsset.projectId || !parentAsset.project?.teamId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Parent folder ${parent} has no project or team associated`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Validate that any provided metadata keys are defined CREATION_CONTEXT fields
|
||||
await validateCreationContextMetadata(userId, parentAsset.projectId, metadata)
|
||||
|
||||
// Create asset via assetService
|
||||
const newFile = await assetService.createAsset({
|
||||
name,
|
||||
type: 'file',
|
||||
parentId: parent,
|
||||
key: s3Key,
|
||||
sizeByte: fileSize,
|
||||
contentType: mimeType,
|
||||
creatorId: userId,
|
||||
})
|
||||
|
||||
// Increment update ancestor size
|
||||
await prisma.$transaction(async (tx) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
await assetService.updateAncestorsSize(tx as any, parent, fileSize)
|
||||
|
||||
// Persist creation context metadata provided by the agent
|
||||
if (metadata) {
|
||||
const metadataUpdates = Object.entries(metadata)
|
||||
.filter(([, value]) => value !== null)
|
||||
.map(([key, value]) => ({ key, value }))
|
||||
if (metadataUpdates.length > 0) {
|
||||
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
|
||||
}
|
||||
}
|
||||
|
||||
// Trigger post-upload transcode and AI workflows
|
||||
await uploadService.triggerPostUploadWorkflows(
|
||||
tx,
|
||||
newFile.id,
|
||||
parentAsset.project!.teamId,
|
||||
parentAsset.projectId!,
|
||||
)
|
||||
})
|
||||
|
||||
return {
|
||||
id: newFile.id,
|
||||
name: newFile.name,
|
||||
type: newFile.type,
|
||||
size: Number(newFile.sizeByte),
|
||||
}
|
||||
}
|
||||
|
||||
case 'create_version': {
|
||||
const parent = args.parent // parent file id
|
||||
const s3Key = args.s3Key as string
|
||||
const name = args.name as string
|
||||
const fileSize = args.size as number
|
||||
const mimeType = args.contentType as string
|
||||
const metadata =
|
||||
typeof args.metadata === 'object' && args.metadata !== null
|
||||
? (args.metadata as Record<string, unknown>)
|
||||
: undefined
|
||||
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'parent, s3Key, name, size, and contentType parameters are required',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Fetch parent file and cast to any due to Prisma type resolution limits
|
||||
/* prettier-ignore */
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const parentFile = (await prisma.asset.findUnique({ where: { id: parent }, include: { parent: true, project: true } })) as any
|
||||
if (!parentFile) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Parent file not found with ID: ${parent}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
if (!parentFile.projectId || !parentFile.project?.teamId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Parent file ${parent} has no project or team associated`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Validate that any provided metadata keys are defined CREATION_CONTEXT fields
|
||||
await validateCreationContextMetadata(userId, parentFile.projectId, metadata)
|
||||
|
||||
// Authz check: verify Edit permission on the parent file (resource ID is parent file id)
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: parent,
|
||||
})
|
||||
|
||||
// If already in a version stack
|
||||
if (parentFile.parentId && parentFile.parent?.type === AssetType.version_stack) {
|
||||
const stackId = parentFile.parentId
|
||||
|
||||
// Create the new file asset
|
||||
const newFile = await assetService.createAsset({
|
||||
name,
|
||||
type: 'file',
|
||||
parentId: stackId,
|
||||
key: s3Key,
|
||||
sizeByte: fileSize,
|
||||
contentType: mimeType,
|
||||
creatorId: userId,
|
||||
})
|
||||
|
||||
// Generate sort index for new version inside the stack (newest gets the lowest sortIndex)
|
||||
const firstChild = await prisma.asset.findFirst({
|
||||
where: {
|
||||
parentId: stackId,
|
||||
NOT: { id: newFile.id },
|
||||
},
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
})
|
||||
const newSortIndex = generateKeyBetween(null, firstChild?.sortIndex || null)
|
||||
|
||||
await prisma.$transaction(async (tx) => {
|
||||
// Assign sort index
|
||||
await tx.asset.update({
|
||||
where: { id: newFile.id },
|
||||
data: { sortIndex: newSortIndex },
|
||||
})
|
||||
// Persist creation context metadata provided by the agent
|
||||
if (metadata) {
|
||||
const metadataUpdates = Object.entries(metadata)
|
||||
.filter(([, value]) => value !== null)
|
||||
.map(([key, value]) => ({ key, value }))
|
||||
if (metadataUpdates.length > 0) {
|
||||
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
|
||||
}
|
||||
}
|
||||
// Increment stack's size (fileCount is incremented by createAsset already)
|
||||
const updatedStack = await tx.asset.update({
|
||||
where: { id: stackId },
|
||||
data: {
|
||||
sizeByte: { increment: fileSize },
|
||||
},
|
||||
})
|
||||
// Update ancestors' size of stack's parent
|
||||
if (updatedStack.parentId) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
await assetService.updateAncestorsSize(tx as any, updatedStack.parentId, fileSize)
|
||||
}
|
||||
|
||||
// Trigger post-upload transcode and AI workflows
|
||||
await uploadService.triggerPostUploadWorkflows(
|
||||
tx,
|
||||
newFile.id,
|
||||
parentFile.project.teamId,
|
||||
parentFile.projectId,
|
||||
)
|
||||
})
|
||||
|
||||
return {
|
||||
id: newFile.id,
|
||||
name: newFile.name,
|
||||
type: newFile.type,
|
||||
size: Number(newFile.sizeByte),
|
||||
}
|
||||
} else {
|
||||
// Parent is a regular file. We must create a new version stack.
|
||||
const folderParentId = parentFile.parentId
|
||||
if (!folderParentId) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `Parent file ${parent} has no parent folder`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
// Create the new file asset under parent folder first (so that createVersionStack can run on them,
|
||||
// which enforces both files must have same parent initially)
|
||||
const newFile = await assetService.createAsset({
|
||||
name,
|
||||
type: 'file',
|
||||
parentId: folderParentId,
|
||||
key: s3Key,
|
||||
sizeByte: fileSize,
|
||||
contentType: mimeType,
|
||||
creatorId: userId,
|
||||
})
|
||||
|
||||
await prisma.$transaction(async (tx) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const txVersionStackService = new VersionStackService(tx as any)
|
||||
await txVersionStackService.createVersionStack({
|
||||
fileIds: [newFile.id, parentFile.id],
|
||||
projectId: parentFile.projectId!,
|
||||
creatorId: userId,
|
||||
})
|
||||
// Persist creation context metadata provided by the agent
|
||||
if (metadata) {
|
||||
const metadataUpdates = Object.entries(metadata)
|
||||
.filter(([, value]) => value !== null)
|
||||
.map(([key, value]) => ({ key, value }))
|
||||
if (metadataUpdates.length > 0) {
|
||||
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
|
||||
}
|
||||
}
|
||||
// Update ancestors' size (add size of the new file version)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
await assetService.updateAncestorsSize(tx as any, folderParentId!, fileSize)
|
||||
|
||||
// Trigger post-upload transcode and AI workflows
|
||||
await uploadService.triggerPostUploadWorkflows(
|
||||
tx,
|
||||
newFile.id,
|
||||
parentFile.project.teamId,
|
||||
parentFile.projectId!,
|
||||
)
|
||||
})
|
||||
|
||||
return {
|
||||
id: newFile.id,
|
||||
name: newFile.name,
|
||||
type: newFile.type,
|
||||
size: Number(newFile.sizeByte),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
default:
|
||||
throw ApplicationFailure.create({
|
||||
message: `Unsupported tool name: ${toolName}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
export async function getAssetPathContextActivity(assetId: string): Promise<string> {
|
||||
const { path } = await getAssetPathHierarchyActivity(assetId)
|
||||
return path
|
||||
}
|
||||
|
||||
export interface GenerateSessionNameParams {
|
||||
|
||||
@@ -0,0 +1,354 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
import { escapeXmlAttr, serializeContextToXml } from './serialize-context'
|
||||
import type { ShumaiMessageContext } from '@shumai/dtos'
|
||||
|
||||
describe('serializeContextToXml', () => {
|
||||
describe('escapeXmlAttr', () => {
|
||||
it('escapes &, <, >, ", and \' characters correctly', () => {
|
||||
expect(escapeXmlAttr('Alice & Bob <Admin> "v1" \'test\'')).toBe(
|
||||
'Alice & Bob <Admin> "v1" 'test'',
|
||||
)
|
||||
})
|
||||
|
||||
it('handles clean strings without modification', () => {
|
||||
expect(escapeXmlAttr('normal-string_123.mp4')).toBe('normal-string_123.mp4')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Tag Serialization', () => {
|
||||
it('returns empty string for null, undefined, or empty context', () => {
|
||||
expect(serializeContextToXml(null)).toBe('')
|
||||
expect(serializeContextToXml(undefined)).toBe('')
|
||||
expect(serializeContextToXml({})).toBe('')
|
||||
})
|
||||
|
||||
it('serializes minimal context with only user', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
user: { id: 'usr_1', name: 'Alice', role: 'editor' },
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <user id="usr_1" name="Alice" role="editor" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('serializes context with user and thread tag with reply_count', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
user: { id: 'usr_1', name: 'Alice', role: 'editor' },
|
||||
thread: { id: 'th_01JXYZ', replyCount: 3 },
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <user id="usr_1" name="Alice" role="editor" />\n <thread id="th_01JXYZ" reply_count="3" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('serializes context with thread tag without reply_count', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
thread: { id: 'th_01JXYZ' },
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <thread id="th_01JXYZ" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('serializes minimal context with only currentAsset (without ancestors)', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'ast_1',
|
||||
name: 'clip.mp4',
|
||||
type: 'file',
|
||||
mediaType: 'video',
|
||||
path: 'clip.mp4',
|
||||
},
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <current_asset id="ast_1" name="clip.mp4" type="file" media_type="video" path="clip.mp4" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('serializes full video context with duration, timestamp, annotation, attached files, and referenced assets', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
user: { id: 'usr_01', name: 'Alice Chen', role: 'editor' },
|
||||
currentAsset: {
|
||||
id: 'ast_01JC04_CURRENT',
|
||||
name: 'product_launch_v2.mp4',
|
||||
type: 'file',
|
||||
mediaType: 'video',
|
||||
parentId: 'ast_01JC03_PARENT',
|
||||
path: 'Marketing/2026_Launch/Footage/product_launch_v2.mp4',
|
||||
durationSeconds: 85.4,
|
||||
ancestors: [
|
||||
{ id: 'ast_01JC01_ROOT', name: 'Marketing' },
|
||||
{ id: 'ast_01JC02_SUB', name: '2026_Launch' },
|
||||
{ id: 'ast_01JC03_PARENT', name: 'Footage' },
|
||||
],
|
||||
},
|
||||
position: { type: 'time', seconds: 14.25 },
|
||||
annotation: true,
|
||||
attachedFiles: [
|
||||
{
|
||||
id: 'ast_01JC05_ATT1',
|
||||
name: 'brand_guidelines_2026.pdf',
|
||||
type: 'file',
|
||||
mediaType: 'pdf',
|
||||
path: 'Brand/brand_guidelines_2026.pdf',
|
||||
},
|
||||
],
|
||||
referencedAssets: [
|
||||
{
|
||||
id: 'ast_01JC07_REF2',
|
||||
name: 'Color_LUTs',
|
||||
type: 'folder',
|
||||
path: 'Assets/Color_LUTs',
|
||||
},
|
||||
{
|
||||
id: 'ast_01JC06_REF1',
|
||||
name: 'logo_white.png',
|
||||
type: 'file',
|
||||
mediaType: 'image',
|
||||
path: 'Brand/Logos/logo_white.png',
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
const expected = `<context>
|
||||
<user id="usr_01" name="Alice Chen" role="editor" />
|
||||
<current_asset id="ast_01JC04_CURRENT" name="product_launch_v2.mp4" type="file" media_type="video" parent_id="ast_01JC03_PARENT" path="Marketing/2026_Launch/Footage/product_launch_v2.mp4" duration_seconds="85.40">
|
||||
<ancestors>
|
||||
<folder id="ast_01JC01_ROOT" name="Marketing" />
|
||||
<folder id="ast_01JC02_SUB" name="2026_Launch" />
|
||||
<folder id="ast_01JC03_PARENT" name="Footage" />
|
||||
</ancestors>
|
||||
</current_asset>
|
||||
<position type="time" seconds="14.2500" />
|
||||
<annotation />
|
||||
<attached_files>
|
||||
<file id="ast_01JC05_ATT1" name="brand_guidelines_2026.pdf" type="file" media_type="pdf" path="Brand/brand_guidelines_2026.pdf" />
|
||||
</attached_files>
|
||||
<referenced_assets>
|
||||
<asset id="ast_01JC06_REF1" name="logo_white.png" type="file" media_type="image" path="Brand/Logos/logo_white.png" />
|
||||
<folder id="ast_01JC07_REF2" name="Color_LUTs" path="Assets/Color_LUTs" />
|
||||
</referenced_assets>
|
||||
</context>`
|
||||
|
||||
expect(serializeContextToXml(context)).toBe(expected)
|
||||
})
|
||||
|
||||
it('serializes PDF document context with total_pages and position.type === "page"', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'pdf_1',
|
||||
name: 'report.pdf',
|
||||
type: 'file',
|
||||
mediaType: 'pdf',
|
||||
totalPages: 12,
|
||||
},
|
||||
position: { type: 'page', page: 3 },
|
||||
}
|
||||
|
||||
const expected = `<context>
|
||||
<current_asset id="pdf_1" name="report.pdf" type="file" media_type="pdf" total_pages="12" />
|
||||
<position type="page" page="3" />
|
||||
</context>`
|
||||
|
||||
expect(serializeContextToXml(context)).toBe(expected)
|
||||
})
|
||||
|
||||
it('serializes Video context with total_frames and duration_seconds', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'vid_1',
|
||||
name: 'clip.mp4',
|
||||
type: 'file',
|
||||
mediaType: 'video',
|
||||
mimeType: 'video/mp4',
|
||||
durationSeconds: 9,
|
||||
totalFrames: 268,
|
||||
},
|
||||
}
|
||||
|
||||
const expected = `<context>
|
||||
<current_asset id="vid_1" name="clip.mp4" type="file" media_type="video" mime_type="video/mp4" duration_seconds="9.00" total_frames="268" />
|
||||
</context>`
|
||||
|
||||
expect(serializeContextToXml(context)).toBe(expected)
|
||||
})
|
||||
|
||||
it('serializes navigation context with navigated="true" and ancestors hierarchy', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'f_sub',
|
||||
name: 'Subfolder',
|
||||
type: 'folder',
|
||||
navigated: true,
|
||||
ancestors: [{ id: 'f_root', name: 'Root' }],
|
||||
},
|
||||
}
|
||||
|
||||
const expected = `<context>
|
||||
<current_asset id="f_sub" name="Subfolder" type="folder" navigated="true">
|
||||
<ancestors>
|
||||
<folder id="f_root" name="Root" />
|
||||
</ancestors>
|
||||
</current_asset>
|
||||
</context>`
|
||||
|
||||
expect(serializeContextToXml(context)).toBe(expected)
|
||||
})
|
||||
|
||||
it('serializes mime_type alongside media_type for current asset and attached files', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
currentAsset: {
|
||||
id: 'img_1',
|
||||
name: 'photo.png',
|
||||
type: 'file',
|
||||
mediaType: 'image',
|
||||
mimeType: 'image/png',
|
||||
},
|
||||
attachedFiles: [
|
||||
{
|
||||
id: 'doc_1',
|
||||
name: 'spec.pdf',
|
||||
type: 'file',
|
||||
mediaType: 'pdf',
|
||||
mimeType: 'application/pdf',
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
const expected = `<context>
|
||||
<current_asset id="img_1" name="photo.png" type="file" media_type="image" mime_type="image/png" />
|
||||
<attached_files>
|
||||
<file id="doc_1" name="spec.pdf" type="file" media_type="pdf" mime_type="application/pdf" />
|
||||
</attached_files>
|
||||
</context>`
|
||||
|
||||
expect(serializeContextToXml(context)).toBe(expected)
|
||||
})
|
||||
})
|
||||
|
||||
describe('XML Escaping & Security', () => {
|
||||
it('escapes user names, asset names, and paths with special characters', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
user: {
|
||||
id: 'u_1',
|
||||
name: 'Alice & Bob <Admin>',
|
||||
role: 'reviewer "lead"',
|
||||
},
|
||||
currentAsset: {
|
||||
id: 'ast_1',
|
||||
name: 'Final <Cut> "v2" & Test.mp4',
|
||||
type: 'file',
|
||||
path: 'Folder A > Folder B & C/clip.mp4',
|
||||
ancestors: [{ id: 'anc_1', name: 'Folder B & C' }],
|
||||
},
|
||||
attachedFiles: [
|
||||
{
|
||||
id: 'att_1',
|
||||
name: "Don't <Touch> & Go.pdf",
|
||||
type: 'file',
|
||||
path: "Path 'A' & 'B'/doc.pdf",
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
const xml = serializeContextToXml(context)
|
||||
expect(xml).toContain('name="Alice & Bob <Admin>"')
|
||||
expect(xml).toContain('role="reviewer "lead""')
|
||||
expect(xml).toContain('name="Final <Cut> "v2" & Test.mp4"')
|
||||
expect(xml).toContain('path="Folder A > Folder B & C/clip.mp4"')
|
||||
expect(xml).toContain('name="Folder B & C"')
|
||||
expect(xml).toContain('name="Don't <Touch> & Go.pdf"')
|
||||
expect(xml).toContain('path="Path 'A' & 'B'/doc.pdf"')
|
||||
|
||||
// Verify no unescaped dangerous characters exist inside attribute quotes
|
||||
const attrMatch = xml.match(/\w+="([^"]*)"/g)
|
||||
expect(attrMatch).not.toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
describe('Order Stability & Prompt Caching Invariants', () => {
|
||||
it('produces identical XML regardless of object key order', () => {
|
||||
const contextA: ShumaiMessageContext = {
|
||||
user: { role: 'editor', name: 'Alice', id: 'u_1' },
|
||||
currentAsset: {
|
||||
name: 'video.mp4',
|
||||
type: 'file',
|
||||
id: 'ast_1',
|
||||
mediaType: 'video',
|
||||
},
|
||||
position: { seconds: 12.345, type: 'time' },
|
||||
}
|
||||
|
||||
const contextB: ShumaiMessageContext = {
|
||||
position: { type: 'time', seconds: 12.345 },
|
||||
currentAsset: {
|
||||
id: 'ast_1',
|
||||
mediaType: 'video',
|
||||
type: 'file',
|
||||
name: 'video.mp4',
|
||||
},
|
||||
user: { id: 'u_1', name: 'Alice', role: 'editor' },
|
||||
}
|
||||
|
||||
expect(serializeContextToXml(contextA)).toBe(serializeContextToXml(contextB))
|
||||
})
|
||||
|
||||
it('sorts attachedFiles and referencedAssets by id ascending', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
attachedFiles: [
|
||||
{ id: 'z_file', name: 'Z', type: 'file' },
|
||||
{ id: 'a_file', name: 'A', type: 'file' },
|
||||
{ id: 'm_file', name: 'M', type: 'file' },
|
||||
],
|
||||
referencedAssets: [
|
||||
{ id: 'z_asset', name: 'Z', type: 'file' },
|
||||
{ id: 'a_asset', name: 'A', type: 'folder' },
|
||||
{ id: 'm_asset', name: 'M', type: 'file' },
|
||||
],
|
||||
}
|
||||
|
||||
const xml = serializeContextToXml(context)
|
||||
const fileOrder = [...xml.matchAll(/<file id="([^"]+)"/g)].map((m) => m[1])
|
||||
const refOrder = [...xml.matchAll(/<(?:asset|folder) id="([^"]+)"/g)].map((m) => m[1])
|
||||
|
||||
expect(fileOrder).toEqual(['a_file', 'm_file', 'z_file'])
|
||||
expect(refOrder).toEqual(['a_asset', 'm_asset', 'z_asset'])
|
||||
})
|
||||
|
||||
it('normalizes float formatting with fixed precision (toFixed(4) for position, toFixed(2) for duration)', () => {
|
||||
const context1: ShumaiMessageContext = {
|
||||
currentAsset: { id: '1', name: 'a', type: 'file', durationSeconds: 14 },
|
||||
position: { type: 'time', seconds: 5.5 },
|
||||
}
|
||||
const context2: ShumaiMessageContext = {
|
||||
currentAsset: { id: '1', name: 'a', type: 'file', durationSeconds: 14.0001 },
|
||||
position: { type: 'time', seconds: 5.50002 },
|
||||
}
|
||||
|
||||
expect(serializeContextToXml(context1)).toContain('duration_seconds="14.00"')
|
||||
expect(serializeContextToXml(context1)).toContain('seconds="5.5000"')
|
||||
expect(serializeContextToXml(context2)).toContain('duration_seconds="14.00"')
|
||||
expect(serializeContextToXml(context2)).toContain('seconds="5.5000"')
|
||||
})
|
||||
|
||||
it('serializes annotation tag with id when context.id is provided', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
id: '01JABCDEF1234567890',
|
||||
annotation: true,
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <annotation id="01JABCDEF1234567890" />\n</context>',
|
||||
)
|
||||
})
|
||||
|
||||
it('escapes special XML characters in annotation id', () => {
|
||||
const context: ShumaiMessageContext = {
|
||||
id: 'test<id>&"123"',
|
||||
annotation: true,
|
||||
}
|
||||
expect(serializeContextToXml(context)).toBe(
|
||||
'<context>\n <annotation id="test<id>&"123"" />\n</context>',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1 @@
|
||||
export { escapeXmlAttr, serializeContextToXml } from '@shumai/dtos'
|
||||
@@ -7,8 +7,7 @@ import { DatabaseSessionStorage } from './database-session-storage'
|
||||
import { agentService } from '@shumai/core/src/agent/agent'
|
||||
import { createAgentSession, type DbProviderInfo } from './index'
|
||||
import * as sandboxedBashModule from './tools/sandboxed-bash'
|
||||
import * as analyzeImageModule from './tools/analyze-image'
|
||||
import * as screenshotModule from './tools/screenshot'
|
||||
import * as readAssetModule from './tools/read-asset'
|
||||
|
||||
describe('DatabaseSessionStorage', () => {
|
||||
setupTestDbHooks()
|
||||
@@ -451,9 +450,8 @@ describe('DatabaseSessionStorage', () => {
|
||||
})
|
||||
const sessionId = initialStorage.sessionId
|
||||
|
||||
// 2. Spy on media tools constructors
|
||||
const createAnalyzeImageToolSpy = vi.spyOn(analyzeImageModule, 'createAnalyzeImageTool')
|
||||
const createScreenshotToolSpy = vi.spyOn(screenshotModule, 'createScreenshotTool')
|
||||
// 2. Spy on media tool constructor
|
||||
const createReadAssetToolSpy = vi.spyOn(readAssetModule, 'createReadAssetTool')
|
||||
|
||||
// 3. Resume the session via createAgentSession with a NEW comment ID
|
||||
await createAgentSession({
|
||||
@@ -470,12 +468,11 @@ describe('DatabaseSessionStorage', () => {
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
// 4. Assert that the tools were instantiated using the new comment ID and user ID
|
||||
expect(createAnalyzeImageToolSpy).toHaveBeenCalledWith(user.id, 'new-comment-456')
|
||||
expect(createScreenshotToolSpy).toHaveBeenCalledWith(user.id, 'new-comment-456')
|
||||
// 4. Assert that the tool was instantiated using user ID
|
||||
expect(createReadAssetToolSpy).toHaveBeenCalledWith(user.id)
|
||||
})
|
||||
|
||||
it('should use the current comment ID for media tools in subsequent turns (video)', async () => {
|
||||
it('should instantiate media tools with user ID in subsequent turns (video)', async () => {
|
||||
const { agent, user, team } = await setupTestData()
|
||||
|
||||
// Create a project and asset to satisfy FK constraints
|
||||
@@ -505,9 +502,8 @@ describe('DatabaseSessionStorage', () => {
|
||||
})
|
||||
const sessionId = initialStorage.sessionId
|
||||
|
||||
// 2. Spy on media tools constructors
|
||||
const createAnalyzeImageToolSpy = vi.spyOn(analyzeImageModule, 'createAnalyzeImageTool')
|
||||
const createScreenshotToolSpy = vi.spyOn(screenshotModule, 'createScreenshotTool')
|
||||
// 2. Spy on media tool constructor
|
||||
const createReadAssetToolSpy = vi.spyOn(readAssetModule, 'createReadAssetTool')
|
||||
|
||||
// 3. Resume the session via createAgentSession with a NEW comment ID
|
||||
await createAgentSession({
|
||||
@@ -524,9 +520,8 @@ describe('DatabaseSessionStorage', () => {
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
// 4. Assert that the tools were instantiated using the new comment ID and user ID
|
||||
expect(createScreenshotToolSpy).toHaveBeenCalledWith(user.id, 'new-comment-456')
|
||||
expect(createAnalyzeImageToolSpy).toHaveBeenCalledWith(user.id, 'new-comment-456')
|
||||
// 4. Assert that the tool was instantiated using user ID
|
||||
expect(createReadAssetToolSpy).toHaveBeenCalledWith(user.id)
|
||||
})
|
||||
|
||||
describe('P1 Bug Reproductions', () => {
|
||||
@@ -662,5 +657,158 @@ describe('DatabaseSessionStorage', () => {
|
||||
expect(stats.totalTokens).toBe(170)
|
||||
expect(stats.costTotal).toBeCloseTo(0.032)
|
||||
})
|
||||
|
||||
it('should save user message turn as custom_message (shumai_message) in DB when currentMessageContext is set', async () => {
|
||||
const { agent, user } = await setupTestData()
|
||||
const storage = await DatabaseSessionStorage.create({ agentId: agent.id, userId: user.id })
|
||||
|
||||
storage.currentMessageContext = {
|
||||
user: { id: user.id, name: user.name, role: 'owner' },
|
||||
currentAsset: { id: 'asset-123', name: 'video.mp4', type: 'file' },
|
||||
}
|
||||
|
||||
const userEntry: SessionTreeEntry = {
|
||||
type: 'message',
|
||||
id: 'msg-user-1',
|
||||
parentId: null,
|
||||
timestamp: new Date().toISOString(),
|
||||
message: {
|
||||
role: 'user',
|
||||
content: 'Hello, help me analyze this video',
|
||||
timestamp: Date.now(),
|
||||
},
|
||||
}
|
||||
|
||||
await storage.appendEntry(userEntry)
|
||||
|
||||
// 1. Verify DB record type is 'custom_message', not 'message'
|
||||
const record = await prisma.agentSessionEntry.findUnique({
|
||||
where: { id: 'msg-user-1' },
|
||||
})
|
||||
expect(record).toBeDefined()
|
||||
expect(record?.type).toBe('custom_message')
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const data = record?.data as any
|
||||
expect(data.customType).toBe('shumai_message')
|
||||
expect(data.content).toBe('Hello, help me analyze this video')
|
||||
expect(data.details?.user?.id).toBe(user.id)
|
||||
expect(data.details?.currentAsset?.id).toBe('asset-123')
|
||||
|
||||
// 2. Verify getEntries() and getPathToRoot() do not throw and return proper custom_message
|
||||
const entries = await storage.getEntries()
|
||||
expect(entries).toHaveLength(1)
|
||||
expect(entries[0].type).toBe('custom_message')
|
||||
|
||||
const pathEntries = await storage.getPathToRoot('msg-user-1')
|
||||
expect(pathEntries).toHaveLength(1)
|
||||
expect(pathEntries[0].type).toBe('custom_message')
|
||||
|
||||
const stats = await storage.getSessionStats()
|
||||
expect(stats.messageCount).toBe(1)
|
||||
})
|
||||
|
||||
it('should safely handle legacy records where type was message but data was shumai_message', async () => {
|
||||
const { agent } = await setupTestData()
|
||||
const storage = await DatabaseSessionStorage.create({ agentId: agent.id })
|
||||
|
||||
await prisma.agentSessionEntry.create({
|
||||
data: {
|
||||
id: 'legacy-corrupted-entry',
|
||||
sessionId: storage.sessionId,
|
||||
type: 'message',
|
||||
data: {
|
||||
customType: 'shumai_message',
|
||||
content: 'Legacy prompt',
|
||||
display: true,
|
||||
details: { user: { id: 'u1', name: 'User 1' } },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
// Must not throw in getEntries(), getPathToRoot(), or getSessionStats()
|
||||
const entries = await storage.getEntries()
|
||||
expect(entries).toHaveLength(1)
|
||||
expect(entries[0].type).toBe('custom_message')
|
||||
|
||||
const path = await storage.getPathToRoot('legacy-corrupted-entry')
|
||||
expect(path).toHaveLength(1)
|
||||
expect(path[0].type).toBe('custom_message')
|
||||
|
||||
const stats = await storage.getSessionStats()
|
||||
expect(stats.messageCount).toBe(1)
|
||||
})
|
||||
|
||||
it('should dynamically inject thread metadata into details.thread in getPathToRoot when replies exist', async () => {
|
||||
const { agent, user } = await setupTestData()
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Test Project', teamId: agent.teamId },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'Test Asset',
|
||||
type: 'file',
|
||||
status: 'uploaded',
|
||||
projectId: project.id,
|
||||
},
|
||||
})
|
||||
const storage = await DatabaseSessionStorage.create({ agentId: agent.id, assetId: asset.id })
|
||||
|
||||
const rootComment = await prisma.assetComment.create({
|
||||
data: {
|
||||
id: 'comment-root-1',
|
||||
assetId: asset.id,
|
||||
message: 'Top-level question',
|
||||
creatorId: user.id,
|
||||
},
|
||||
})
|
||||
|
||||
// Add a reply
|
||||
await prisma.assetComment.create({
|
||||
data: {
|
||||
id: 'comment-reply-1',
|
||||
assetId: asset.id,
|
||||
message: 'Reply 1',
|
||||
creatorId: user.id,
|
||||
replyToId: rootComment.id,
|
||||
},
|
||||
})
|
||||
|
||||
// Create session entry for root comment
|
||||
await prisma.agentSessionEntry.create({
|
||||
data: {
|
||||
id: rootComment.id,
|
||||
sessionId: storage.sessionId,
|
||||
assetId: asset.id,
|
||||
type: 'custom_message',
|
||||
data: {
|
||||
customType: 'shumai_message',
|
||||
content: 'Top-level question',
|
||||
display: true,
|
||||
details: { user: { id: user.id, name: user.name } },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const path = await storage.getPathToRoot(rootComment.id)
|
||||
expect(path).toHaveLength(1)
|
||||
expect(path[0].type).toBe('custom_message')
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const details = (path[0] as any).details
|
||||
expect(details.thread).toEqual({
|
||||
id: rootComment.id,
|
||||
replyCount: 1,
|
||||
})
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
expect((path[0] as any).content).toBe('Top-level question')
|
||||
|
||||
const entries = await storage.getEntries()
|
||||
expect(entries).toHaveLength(1)
|
||||
expect(entries[0].type).toBe('custom_message')
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
expect((entries[0] as any).details?.thread).toEqual({
|
||||
id: rootComment.id,
|
||||
replyCount: 1,
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
type SessionTreeEntry,
|
||||
} from '@earendil-works/pi-agent-core'
|
||||
import { agentService } from '@shumai/core/src/agent/agent'
|
||||
import type { ShumaiMessageContext } from '@shumai/dtos'
|
||||
|
||||
export interface DatabaseSessionMetadata extends SessionMetadata {
|
||||
agentId: string
|
||||
@@ -72,6 +73,7 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
}
|
||||
|
||||
nextEntryId?: string | null
|
||||
currentMessageContext?: PrismaJson.ShumaiMessageContext
|
||||
|
||||
async createEntryId(): Promise<string> {
|
||||
if (this.nextEntryId) {
|
||||
@@ -90,9 +92,13 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
data: unknown
|
||||
}): SessionTreeEntry {
|
||||
const payload = (record.data as Record<string, unknown>) || {}
|
||||
let type = (record.type || 'message') as SessionTreeEntry['type']
|
||||
if (type === 'message' && payload.customType === 'shumai_message') {
|
||||
type = 'custom_message'
|
||||
}
|
||||
return {
|
||||
id: record.id,
|
||||
type: (record.type || 'message') as SessionTreeEntry['type'],
|
||||
type,
|
||||
parentId: record.parentId,
|
||||
timestamp: record.createdAt.toISOString(),
|
||||
...payload,
|
||||
@@ -100,10 +106,44 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
}
|
||||
|
||||
async appendEntry(entry: SessionTreeEntry): Promise<void> {
|
||||
const strippedEntry = structuredClone(entry)
|
||||
let entryToProcess = entry
|
||||
if (
|
||||
entryToProcess.type === 'message' &&
|
||||
entryToProcess.message &&
|
||||
entryToProcess.message.role === 'user' &&
|
||||
this.currentMessageContext
|
||||
) {
|
||||
let contentText = ''
|
||||
if (typeof entryToProcess.message.content === 'string') {
|
||||
contentText = entryToProcess.message.content
|
||||
} else if (Array.isArray(entryToProcess.message.content)) {
|
||||
contentText = entryToProcess.message.content
|
||||
.map((c) =>
|
||||
typeof c === 'object' && c && 'text' in c && typeof c.text === 'string' ? c.text : '',
|
||||
)
|
||||
.join('')
|
||||
}
|
||||
|
||||
entryToProcess = {
|
||||
type: 'custom_message',
|
||||
id: entryToProcess.id,
|
||||
parentId: entryToProcess.parentId,
|
||||
timestamp: entryToProcess.timestamp,
|
||||
customType: 'shumai_message',
|
||||
content: contentText,
|
||||
display: true,
|
||||
details: {
|
||||
...this.currentMessageContext,
|
||||
id: entryToProcess.id,
|
||||
},
|
||||
} as unknown as SessionTreeEntry
|
||||
this.currentMessageContext = undefined
|
||||
}
|
||||
|
||||
const strippedEntry = structuredClone(entryToProcess)
|
||||
|
||||
// Strip image data and skill content before saving to DB
|
||||
if (strippedEntry.type === 'message') {
|
||||
if (strippedEntry.type === 'message' && strippedEntry.message) {
|
||||
const msg = strippedEntry.message
|
||||
if (msg.role === 'toolResult') {
|
||||
const details = msg.details as { sourceKeys?: string[]; skillId?: string } | undefined
|
||||
@@ -139,7 +179,10 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
}
|
||||
}
|
||||
|
||||
const targetLeafId = entry.type === 'leaf' ? entry.targetId : entry.id
|
||||
const targetLeafId =
|
||||
strippedEntry.type === 'leaf'
|
||||
? (strippedEntry as unknown as { targetId?: string }).targetId || strippedEntry.id
|
||||
: strippedEntry.id
|
||||
|
||||
// Extract base fields and store type-specific properties in data payload
|
||||
const payload = { ...strippedEntry } as Record<string, unknown>
|
||||
@@ -155,17 +198,18 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
|
||||
await prisma.$transaction([
|
||||
prisma.agentSessionEntry.upsert({
|
||||
where: { id: entry.id },
|
||||
where: { id: strippedEntry.id },
|
||||
create: {
|
||||
id: entry.id,
|
||||
id: strippedEntry.id,
|
||||
sessionId: this.sessionId,
|
||||
assetId: session?.assetId || null,
|
||||
type: entry.type,
|
||||
parentId: entry.parentId || null,
|
||||
createdAt: entry.timestamp ? new Date(entry.timestamp) : new Date(),
|
||||
type: strippedEntry.type,
|
||||
parentId: strippedEntry.parentId || null,
|
||||
createdAt: strippedEntry.timestamp ? new Date(strippedEntry.timestamp) : new Date(),
|
||||
data: payload as PrismaJson.PiSessionEntryData,
|
||||
},
|
||||
update: {
|
||||
type: strippedEntry.type,
|
||||
data: payload as PrismaJson.PiSessionEntryData,
|
||||
},
|
||||
}),
|
||||
@@ -236,7 +280,9 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
let costTotal = 0
|
||||
|
||||
for (const entry of entries) {
|
||||
if (entry.type === 'message') {
|
||||
if (entry.type === 'custom_message' && entry.customType === 'shumai_message') {
|
||||
messageCount++
|
||||
} else if (entry.type === 'message' && entry.message) {
|
||||
const msg = entry.message
|
||||
if (msg.role === 'user' || msg.role === 'assistant') {
|
||||
messageCount++
|
||||
@@ -324,48 +370,7 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
await this.reinjectSkillContentAsync(entry)
|
||||
}
|
||||
|
||||
// Dynamically tag comments that currently have reply threads
|
||||
const entryIds = pathEntries.map((e) => e.id)
|
||||
if (entryIds.length > 0) {
|
||||
const threadCounts = await prisma.assetComment.groupBy({
|
||||
by: ['replyToId'],
|
||||
where: {
|
||||
replyToId: { in: entryIds },
|
||||
message: { not: '__CHAT__' },
|
||||
},
|
||||
_count: {
|
||||
id: true,
|
||||
},
|
||||
})
|
||||
const threadReplyCountMap = new Map<string, number>()
|
||||
for (const tc of threadCounts) {
|
||||
if (tc.replyToId) {
|
||||
threadReplyCountMap.set(tc.replyToId, tc._count.id)
|
||||
}
|
||||
}
|
||||
|
||||
if (threadReplyCountMap.size > 0) {
|
||||
for (let i = 0; i < pathEntries.length; i++) {
|
||||
const entry = pathEntries[i]
|
||||
const count = threadReplyCountMap.get(entry.id)
|
||||
if (count !== undefined && count > 0 && entry.type === 'message') {
|
||||
const cloned = structuredClone(entry)
|
||||
const msg = cloned.message as unknown as {
|
||||
content?: Array<{ type: string; text: string }>
|
||||
}
|
||||
if (Array.isArray(msg.content) && msg.content[0] && msg.content[0].type === 'text') {
|
||||
const threadTag = `[Thread ID: ${entry.id}] [Replies: ${count}]`
|
||||
if (!msg.content[0].text.includes(`[Thread ID: ${entry.id}]`)) {
|
||||
msg.content[0].text = `${threadTag} ${msg.content[0].text}`
|
||||
}
|
||||
}
|
||||
pathEntries[i] = cloned
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return pathEntries
|
||||
return this.injectThreadMetadataAsync(pathEntries)
|
||||
}
|
||||
|
||||
async getEntries(): Promise<SessionTreeEntry[]> {
|
||||
@@ -378,11 +383,61 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
await this.reinjectImageDataAsync(entry)
|
||||
await this.reinjectSkillContentAsync(entry)
|
||||
}
|
||||
return this.injectThreadMetadataAsync(entries)
|
||||
}
|
||||
|
||||
private async injectThreadMetadataAsync(
|
||||
entries: SessionTreeEntry[],
|
||||
): Promise<SessionTreeEntry[]> {
|
||||
const entryIds = entries.map((e) => e.id)
|
||||
if (entryIds.length === 0) {
|
||||
return entries
|
||||
}
|
||||
|
||||
const threadCounts = await prisma.assetComment.groupBy({
|
||||
by: ['replyToId'],
|
||||
where: {
|
||||
replyToId: { in: entryIds },
|
||||
message: { not: '__CHAT__' },
|
||||
},
|
||||
_count: {
|
||||
id: true,
|
||||
},
|
||||
})
|
||||
const threadReplyCountMap = new Map<string, number>()
|
||||
for (const tc of threadCounts) {
|
||||
if (tc.replyToId) {
|
||||
threadReplyCountMap.set(tc.replyToId, tc._count.id)
|
||||
}
|
||||
}
|
||||
|
||||
if (threadReplyCountMap.size > 0) {
|
||||
for (let i = 0; i < entries.length; i++) {
|
||||
const entry = entries[i]
|
||||
const count = threadReplyCountMap.get(entry.id)
|
||||
if (count !== undefined && count > 0) {
|
||||
if (entry.type === 'custom_message') {
|
||||
const cloned = structuredClone(entry)
|
||||
const existingDetails = ((cloned as unknown as { details?: ShumaiMessageContext })
|
||||
.details || {}) as ShumaiMessageContext
|
||||
;(cloned as unknown as { details: ShumaiMessageContext }).details = {
|
||||
...existingDetails,
|
||||
thread: {
|
||||
id: entry.id,
|
||||
replyCount: count,
|
||||
},
|
||||
}
|
||||
entries[i] = cloned
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return entries
|
||||
}
|
||||
|
||||
private async reinjectImageDataAsync(entry: SessionTreeEntry) {
|
||||
if (entry.type === 'message') {
|
||||
if (entry.type === 'message' && entry.message) {
|
||||
const msg = entry.message as AgentMessage
|
||||
if (msg.role === 'toolResult') {
|
||||
const details = msg.details as { sourceKeys?: string[] } | undefined
|
||||
@@ -407,7 +462,7 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
|
||||
}
|
||||
|
||||
private async reinjectSkillContentAsync(entry: SessionTreeEntry) {
|
||||
if (entry.type === 'message') {
|
||||
if (entry.type === 'message' && entry.message) {
|
||||
const msg = entry.message as AgentMessage
|
||||
if (msg.role === 'toolResult' && msg.toolName === 'read_skill') {
|
||||
const details = msg.details as { skillId?: string } | undefined
|
||||
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
import { createSandboxedBashTool } from './tools/sandboxed-bash'
|
||||
import { SandboxManager, type SandboxAskCallback } from '@anthropic-ai/sandbox-runtime'
|
||||
import { quotaService } from '@shumai/core/src/quota/quota-service'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { type TSchema } from 'typebox'
|
||||
@@ -1028,6 +1029,64 @@ describe('createAgentSession typed metadata schema', () => {
|
||||
expect('metadata' in fileProps).toBe(false)
|
||||
expect('metadata' in versionProps).toBe(false)
|
||||
})
|
||||
|
||||
it('should include rename_asset and move_assets by default, but exclude delete_asset', async () => {
|
||||
const { harness } = await setupSessionWithProject({ withCreationFields: false })
|
||||
const toolNames = harness.getTools().map((t) => t.name)
|
||||
|
||||
expect(toolNames).toContain('rename_asset')
|
||||
expect(toolNames).toContain('move_assets')
|
||||
expect(toolNames).not.toContain('delete_asset')
|
||||
})
|
||||
|
||||
it('should include delete_asset when deniedTools is explicitly empty', async () => {
|
||||
const team = await prisma.team.create({ data: { name: 'Delete Asset Team' } })
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Owner', email: 'owner-del@shumai.ai' },
|
||||
})
|
||||
await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: user.id, role: 'owner' },
|
||||
})
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'del-agent',
|
||||
name: 'Del Agent',
|
||||
email: 'del-agent@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'del-agent',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: {
|
||||
provider: 'google',
|
||||
model: 'gemini',
|
||||
deniedTools: [],
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'del-agent',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
userId: user.id,
|
||||
})
|
||||
const toolNames = harness.getTools().map((t) => t.name)
|
||||
expect(toolNames).toContain('delete_asset')
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe('createAgentSession enabled skill filtering', () => {
|
||||
@@ -1257,3 +1316,240 @@ describe('createAgentSession enabled skill filtering', () => {
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe('getModelFromDb', () => {
|
||||
it('should prioritize provider active api protocol over model config api', () => {
|
||||
const providers: DbProviderInfo[] = [
|
||||
{
|
||||
name: 'custom-provider',
|
||||
config: { api: 'anthropic-messages', apiKey: 'KEY' },
|
||||
models: [
|
||||
{
|
||||
modelId: 'my-model',
|
||||
name: 'My Model',
|
||||
config: {
|
||||
api: 'openai-responses', // stale model config
|
||||
reasoning: false,
|
||||
input: ['text'],
|
||||
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
||||
contextWindow: 128000,
|
||||
maxTokens: 4096,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
]
|
||||
|
||||
const model = getModelFromDb(providers, 'custom-provider', 'my-model')
|
||||
expect(model.api).toBe('anthropic-messages')
|
||||
})
|
||||
})
|
||||
|
||||
describe('createAgentSession media generation tools injection', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
it('omits generate_image and generate_video when no valid models are configured', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'No Media Team' },
|
||||
})
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User 1', email: 'user1@example.com', password: 'pw' },
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-user-no-media',
|
||||
name: 'Agent User 1',
|
||||
email: 'agent1@test.com',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
const agent = await prisma.agent.create({
|
||||
data: {
|
||||
id: agentUser.id,
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
vi.spyOn(mediaGenerationService, 'getValidModels').mockResolvedValue({
|
||||
imageModels: [],
|
||||
videoModels: [],
|
||||
providerKeys: {},
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
userId: user.id,
|
||||
agentId: agent.id,
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
enabledSkillIds: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
const tools = harness.getTools()
|
||||
expect(tools.find((t) => t.name === 'generate_image')).toBeUndefined()
|
||||
expect(tools.find((t) => t.name === 'generate_video')).toBeUndefined()
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
|
||||
it('injects generate_image and generate_video when valid models are present', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Media Team' },
|
||||
})
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User 2', email: 'user2@example.com', password: 'pw' },
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-user-with-media',
|
||||
name: 'Agent User 2',
|
||||
email: 'agent2@test.com',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
const agent = await prisma.agent.create({
|
||||
data: {
|
||||
id: agentUser.id,
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
vi.spyOn(mediaGenerationService, 'getValidModels').mockResolvedValue({
|
||||
imageModels: [
|
||||
{
|
||||
id: 'im-1',
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
],
|
||||
videoModels: [
|
||||
{
|
||||
id: 'vm-1',
|
||||
type: 'video',
|
||||
provider: 'klingai',
|
||||
modelId: 'kling-v1-standard',
|
||||
name: 'Kling v1 Standard',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
],
|
||||
providerKeys: {
|
||||
openai: { apiKey: 'key-1' },
|
||||
klingai: { apiKey: 'key-2' },
|
||||
},
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
userId: user.id,
|
||||
agentId: agent.id,
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
enabledSkillIds: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
const tools = harness.getTools()
|
||||
expect(tools.find((t) => t.name === 'generate_image')).toBeDefined()
|
||||
expect(tools.find((t) => t.name === 'generate_video')).toBeDefined()
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
|
||||
it('respects deniedTools when generate_image is denied in agent config', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Denied Media Team' },
|
||||
})
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'User 3', email: 'user3@example.com', password: 'pw' },
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-user-denied-media',
|
||||
name: 'Agent User 3',
|
||||
email: 'agent3@test.com',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
const agent = await prisma.agent.create({
|
||||
data: {
|
||||
id: agentUser.id,
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: {
|
||||
provider: 'google',
|
||||
model: 'gemini',
|
||||
deniedTools: ['generate_image'],
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
vi.spyOn(mediaGenerationService, 'getValidModels').mockResolvedValue({
|
||||
imageModels: [
|
||||
{
|
||||
id: 'im-1',
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
],
|
||||
videoModels: [
|
||||
{
|
||||
id: 'vm-1',
|
||||
type: 'video',
|
||||
provider: 'klingai',
|
||||
modelId: 'kling-v1-standard',
|
||||
name: 'Kling v1 Standard',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
],
|
||||
providerKeys: {
|
||||
openai: { apiKey: 'key-1' },
|
||||
klingai: { apiKey: 'key-2' },
|
||||
},
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
userId: user.id,
|
||||
agentId: agent.id,
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
enabledSkillIds: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
const tools = harness.getTools()
|
||||
expect(tools.find((t) => t.name === 'generate_image')).toBeUndefined()
|
||||
expect(tools.find((t) => t.name === 'generate_video')).toBeDefined()
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
+64
-20
@@ -19,17 +19,23 @@ import * as os from 'os'
|
||||
import * as path from 'path'
|
||||
import { DatabaseSessionStorage } from './database-session-storage'
|
||||
import { metadataService } from '@shumai/core/src/metadata/metadata'
|
||||
import { createAnalyzeImageTool } from './tools/analyze-image'
|
||||
import { createCreateFileTool } from './tools/create-file'
|
||||
import { createCreateFolderTool } from './tools/create-folder'
|
||||
import { createCreateVersionTool } from './tools/create-version'
|
||||
import { createDownloadAssetTool } from './tools/download-asset'
|
||||
import { createListAssetsTool } from './tools/list-assets'
|
||||
import { createReadPdfPagesTool } from './tools/read-pdf-pages'
|
||||
import { createReadAssetTool } from './tools/read-asset'
|
||||
import { createReadSkillTool } from './tools/read-skill'
|
||||
import { createReadThreadTool } from './tools/read-thread'
|
||||
import { createSandboxedBashTool } from './tools/sandboxed-bash'
|
||||
import { createScreenshotTool } from './tools/screenshot'
|
||||
import { createGenerateImageTool } from './tools/generate-image'
|
||||
import { createGenerateVideoTool } from './tools/generate-video'
|
||||
import { createRenameAssetTool } from './tools/rename-asset'
|
||||
import { createMoveAssetsTool } from './tools/move-assets'
|
||||
import { createDeleteAssetTool } from './tools/delete-asset'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { serializeContextToXml } from './context/serialize-context'
|
||||
import { DEFAULT_DENIED_TOOLS, type ShumaiMessageContext } from '@shumai/dtos'
|
||||
|
||||
export interface DbModelInfo {
|
||||
modelId: string
|
||||
@@ -70,10 +76,10 @@ export function getModelFromDb(providers: DbProviderInfo[], providerName: string
|
||||
if (dbProvider.config.baseUrl) {
|
||||
m.baseUrl = dbProvider.config.baseUrl
|
||||
}
|
||||
Object.assign(m, dbModel.config)
|
||||
if (dbProvider.config.api) {
|
||||
m.api = dbProvider.config.api
|
||||
}
|
||||
Object.assign(m, dbModel.config)
|
||||
if (dbModel.name) {
|
||||
m.name = dbModel.name
|
||||
}
|
||||
@@ -292,6 +298,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
for (const entry of entries) {
|
||||
if (
|
||||
entry.type === 'message' &&
|
||||
entry.message &&
|
||||
entry.message.role === 'toolResult' &&
|
||||
entry.message.toolName === 'read_skill' &&
|
||||
!entry.message.isError
|
||||
@@ -309,24 +316,31 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
}
|
||||
}
|
||||
|
||||
const metadata = await storage.getMetadata()
|
||||
const userCommentId =
|
||||
passedUserCommentId !== undefined ? passedUserCommentId : metadata.userCommentId
|
||||
|
||||
const mediaTools: AgentTool[] = []
|
||||
if (userId) {
|
||||
mediaTools.push(
|
||||
createAnalyzeImageTool(userId, userCommentId),
|
||||
createScreenshotTool(userId, userCommentId),
|
||||
createReadPdfPagesTool(userId, userCommentId),
|
||||
)
|
||||
mediaTools.push(createReadAssetTool(userId))
|
||||
}
|
||||
|
||||
const agent = await prisma.agent.findUnique({
|
||||
where: { id: agentId },
|
||||
})
|
||||
const agentConfig = agent?.config as PrismaJson.AgentConfig | null | undefined
|
||||
const deniedTools = agentConfig?.deniedTools || []
|
||||
const deniedTools = agentConfig?.deniedTools ?? [...DEFAULT_DENIED_TOOLS]
|
||||
|
||||
if (!deniedTools.includes('generate_image') || !deniedTools.includes('generate_video')) {
|
||||
try {
|
||||
const { imageModels, videoModels, providerKeys } =
|
||||
await mediaGenerationService.getValidModels(teamId)
|
||||
if (imageModels.length > 0 && !deniedTools.includes('generate_image')) {
|
||||
mediaTools.push(createGenerateImageTool(imageModels, providerKeys, userId))
|
||||
}
|
||||
if (videoModels.length > 0 && !deniedTools.includes('generate_video')) {
|
||||
mediaTools.push(createGenerateVideoTool(videoModels, providerKeys, userId))
|
||||
}
|
||||
} catch (err) {
|
||||
logger.error({ err, teamId }, 'Failed to initialize media generation tools')
|
||||
}
|
||||
}
|
||||
|
||||
const sandboxedBash = createSandboxedBashTool(process.cwd(), skillEnvs, {
|
||||
teamId,
|
||||
@@ -369,12 +383,16 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
const systemTools: AgentTool[] = []
|
||||
if (userId) {
|
||||
const metadataSchema = await buildProjectMetadataSchema(projectId)
|
||||
const agentContext = { teamId, agentId }
|
||||
systemTools.push(
|
||||
createListAssetsTool(userId),
|
||||
createCreateFolderTool(userId),
|
||||
createCreateFileTool(userId, metadataSchema),
|
||||
createCreateVersionTool(userId, metadataSchema),
|
||||
createCreateFolderTool(userId, agentContext),
|
||||
createCreateFileTool(userId, metadataSchema, agentContext),
|
||||
createCreateVersionTool(userId, metadataSchema, agentContext),
|
||||
createDownloadAssetTool(userId),
|
||||
createRenameAssetTool(userId, agentContext),
|
||||
createMoveAssetsTool(userId, agentContext),
|
||||
createDeleteAssetTool(userId, agentContext),
|
||||
)
|
||||
}
|
||||
|
||||
@@ -445,6 +463,29 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
tools: enabledTools,
|
||||
})
|
||||
|
||||
harness.on('context', async ({ messages }) => {
|
||||
return {
|
||||
messages: messages.map((msg) => {
|
||||
if (
|
||||
msg.role === 'custom' &&
|
||||
msg.customType === 'shumai_message' &&
|
||||
msg.details &&
|
||||
typeof msg.details === 'object'
|
||||
) {
|
||||
const context = msg.details as ShumaiMessageContext
|
||||
const xml = serializeContextToXml(context)
|
||||
const text = typeof msg.content === 'string' ? msg.content : ''
|
||||
const fullContent = xml ? `${text}\n\n${xml}`.trim() : text
|
||||
return {
|
||||
...msg,
|
||||
content: fullContent,
|
||||
}
|
||||
}
|
||||
return msg
|
||||
}),
|
||||
}
|
||||
})
|
||||
|
||||
return { session, harness }
|
||||
}
|
||||
|
||||
@@ -613,7 +654,6 @@ import * as aiActivities from './activities/ai'
|
||||
import { agentAutofillMedia } from './workflows/agent-autofill'
|
||||
import { agentChat } from './workflows/agent-chat'
|
||||
import { agentEmbeddingMedia } from './workflows/agent-embedding'
|
||||
import { agentToolCall } from './workflows/agent-tool-call'
|
||||
import { queryEmbeddingForSearch } from './workflows/query-embedding-for-search'
|
||||
|
||||
export function initAgentWorkflows() {
|
||||
@@ -621,7 +661,6 @@ export function initAgentWorkflows() {
|
||||
registerWorkflow(WorkflowTaskType.query_embedding_for_search, queryEmbeddingForSearch)
|
||||
registerWorkflow(WorkflowTaskType.ai_metadata_autofill, agentAutofillMedia)
|
||||
registerWorkflow(WorkflowTaskType.chat, agentChat)
|
||||
registerWorkflow(WorkflowTaskType.agent_tool_call, agentToolCall)
|
||||
|
||||
registerActivities(agentActivities)
|
||||
registerActivities(aiActivities)
|
||||
@@ -640,8 +679,13 @@ export {
|
||||
type GenerateTextEmbeddingParams,
|
||||
} from './activities/ai'
|
||||
export * from './database-session-storage'
|
||||
export * from './context/serialize-context'
|
||||
export * from './workflows/agent-autofill'
|
||||
export * from './workflows/agent-chat'
|
||||
export * from './workflows/agent-embedding'
|
||||
export * from './workflows/agent-tool-call'
|
||||
export * from './workflows/query-embedding-for-search'
|
||||
export * from './tools/generate-image'
|
||||
export * from './tools/generate-video'
|
||||
export * from './tools/rename-asset'
|
||||
export * from './tools/move-assets'
|
||||
export * from './tools/delete-asset'
|
||||
|
||||
@@ -3,7 +3,8 @@ import { validateToolArguments } from '@earendil-works/pi-ai'
|
||||
import { createCreateFileTool } from './tools/create-file'
|
||||
import { fieldsToTypeBoxSchema } from './index'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { executeAgentToolWorkflow } from './tools/utils'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
@@ -12,8 +13,20 @@ vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('./tools/utils', () => ({
|
||||
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'test', type: 'file' }),
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
createFile: vi
|
||||
.fn()
|
||||
.mockResolvedValue({ id: 'file-1', name: 'test', type: 'file', sizeByte: 100 }),
|
||||
},
|
||||
}))
|
||||
|
||||
/**
|
||||
@@ -63,9 +76,16 @@ describe('reproduce null coercion in harness tool validation', () => {
|
||||
|
||||
// execute must accept the valid call (data-only) without throwing
|
||||
const result = await tool.execute('call-1', validated as never)
|
||||
expect(result.details).toEqual({ id: 'file-1', name: 'test', type: 'file' })
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'file-1',
|
||||
name: 'test',
|
||||
type: 'file',
|
||||
size: 100,
|
||||
})
|
||||
expect(s3Service.putObject).toHaveBeenCalledTimes(1)
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledTimes(1)
|
||||
expect(authzService.hasPermission).toHaveBeenCalledTimes(1)
|
||||
expect(assetService.createFile).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
it('keeps null metadata values (the "unknown" sentinel) through validation', () => {
|
||||
|
||||
@@ -1,175 +0,0 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createAnalyzeImageTool } from './analyze-image'
|
||||
import {
|
||||
prisma,
|
||||
WorkflowTaskStatus,
|
||||
type Asset,
|
||||
type AssetComment,
|
||||
type User,
|
||||
type WorkflowTask,
|
||||
} from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/db', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@shumai/db')>()
|
||||
return {
|
||||
...actual,
|
||||
prisma: {
|
||||
user: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
asset: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
assetComment: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
workflowTask: {
|
||||
create: vi.fn(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
getObject: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/workflow-core', () => ({
|
||||
workflowService: {
|
||||
executeWait: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn(),
|
||||
},
|
||||
Permission: { Read: 'Read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
describe('analyzeImageTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('should check user permissions and fetch the image from S3 when comment has no annotations', async () => {
|
||||
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user-1' } as User)
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
storageKey: { key: 'raw-image.png' },
|
||||
media: null,
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'comment-1',
|
||||
assetId: 'asset-1',
|
||||
annotation: null,
|
||||
} as unknown as AssetComment)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-image-bytes'),
|
||||
contentType: 'image/png',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createAnalyzeImageTool('user-1', 'comment-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(result.content[0].type).toBe('image')
|
||||
expect((result.content[0] as unknown as { data: string }).data).toBe(
|
||||
Buffer.from('fake-image-bytes').toString('base64'),
|
||||
)
|
||||
expect(result.details.sourceKeys).toEqual(['raw-image.png'])
|
||||
|
||||
expect(prisma.workflowTask.create).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should trigger overlay transcode workflow when comment has annotations', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
storageKey: { key: 'raw-image.png' },
|
||||
media: {
|
||||
imageTranscodes: [{ key: 'transcoded-image.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'comment-1',
|
||||
assetId: 'asset-1',
|
||||
annotation: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
} as unknown as AssetComment)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: { key: 'annotated-image.webp' },
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-annotated-image-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createAnalyzeImageTool('user-1', 'comment-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1' })
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
assetId: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
type: 'transcode_image_annotation',
|
||||
status: 'pending',
|
||||
payload: {
|
||||
projectId: 'project-1',
|
||||
imageAnnotation: {
|
||||
annotations: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(result.content[0].type).toBe('image')
|
||||
expect((result.content[0] as unknown as { data: string }).data).toBe(
|
||||
Buffer.from('fake-annotated-image-bytes').toString('base64'),
|
||||
)
|
||||
expect(result.details.sourceKeys).toEqual(['annotated-image.webp'])
|
||||
})
|
||||
})
|
||||
@@ -1,139 +0,0 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { type ImageContent } from '@earendil-works/pi-ai'
|
||||
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
|
||||
const analyzeImageSchema = Type.Object({
|
||||
assetId: Type.String({
|
||||
description: 'The asset ID of the image to analyze. This parameter is required.',
|
||||
}),
|
||||
})
|
||||
|
||||
export function createAnalyzeImageTool(
|
||||
userId: string,
|
||||
userCommentId?: string | null,
|
||||
): AgentTool<typeof analyzeImageSchema> {
|
||||
return {
|
||||
name: 'analyze_image',
|
||||
label: 'Analyze Image',
|
||||
description:
|
||||
'Retrieves and views the image content. Call this tool if you need to analyze the image.',
|
||||
parameters: analyzeImageSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const assetId = params.assetId
|
||||
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
|
||||
let asset = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
if (asset.type === 'version_stack') {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
if (latestVersion) {
|
||||
asset = latestVersion
|
||||
}
|
||||
}
|
||||
|
||||
// Get default media key
|
||||
let mediaKey = asset.storageKey?.key
|
||||
if (asset.media) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const mediaInfo = asset.media as any
|
||||
if (mediaInfo.imageTranscodes && mediaInfo.imageTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.imageTranscodes[0].key || mediaKey
|
||||
}
|
||||
}
|
||||
|
||||
if (!mediaKey) {
|
||||
throw new Error('No media content found for this asset.')
|
||||
}
|
||||
|
||||
// Check if trigger comment has draw annotations for this asset
|
||||
let annotations: unknown = null
|
||||
if (userCommentId) {
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: userCommentId },
|
||||
})
|
||||
if (comment && comment.assetId === assetId && comment.annotation) {
|
||||
const list = comment.annotation
|
||||
if (Array.isArray(list) && list.length > 0) {
|
||||
annotations = list
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let keyToUse = mediaKey
|
||||
|
||||
if (annotations) {
|
||||
// Trigger transcode workflow to draw annotation
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_image_annotation,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
imageAnnotation: {
|
||||
annotations: annotations as PrismaJson.AnnotationList,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const output = completedTask.output as any
|
||||
if (output?.key) {
|
||||
keyToUse = output.key
|
||||
} else {
|
||||
throw new Error('Image annotation transcode workflow failed to output S3 key.')
|
||||
}
|
||||
}
|
||||
|
||||
// Retrieve the image content from S3
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, keyToUse)
|
||||
|
||||
const mimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : 'image/webp'
|
||||
|
||||
const content: ImageContent[] = [
|
||||
{
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType,
|
||||
},
|
||||
]
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
sourceKeys: [keyToUse],
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,270 @@
|
||||
import { describe, it, expect, beforeEach } from 'vitest'
|
||||
import { prisma } from '@shumai/db'
|
||||
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'
|
||||
|
||||
describe('resolveAnnotationsById', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
beforeEach(() => {
|
||||
// DB hooks automatically manage transactions
|
||||
})
|
||||
|
||||
it('returns null annotations and null timestamp when annotationId is undefined or empty', async () => {
|
||||
const result1 = await resolveAnnotationsById('asset-1', undefined)
|
||||
expect(result1).toEqual({ annotations: null, timestamp: null })
|
||||
|
||||
const result2 = await resolveAnnotationsById('asset-1', '')
|
||||
expect(result2).toEqual({ annotations: null, timestamp: null })
|
||||
})
|
||||
|
||||
it('resolves annotations and timestamp from AssetComment (Comments Mode)', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Comment Author', email: 'author@test.com', password: 'pw' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Team' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Test Project', teamId: team.id },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'video.mp4',
|
||||
type: 'file',
|
||||
projectId: project.id,
|
||||
status: 'uploaded',
|
||||
},
|
||||
})
|
||||
|
||||
const comment = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
creatorId: user.id,
|
||||
message: 'Look at the highlighted area',
|
||||
second: 18.5,
|
||||
annotation: [
|
||||
{
|
||||
type: 'line',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[10, 10],
|
||||
[50, 50],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
})
|
||||
|
||||
const result = await resolveAnnotationsById(asset.id, comment.id)
|
||||
expect(result.timestamp).toBe(18.5)
|
||||
expect(result.annotations).toEqual([
|
||||
{
|
||||
type: 'line',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[10, 10],
|
||||
[50, 50],
|
||||
],
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it('throws an error when AssetComment belongs to a different asset', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Author', email: 'author2@test.com', password: 'pw' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Team' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Project', teamId: team.id },
|
||||
})
|
||||
const assetA = await prisma.asset.create({
|
||||
data: { name: 'videoA.mp4', type: 'file', projectId: project.id, status: 'uploaded' },
|
||||
})
|
||||
const assetB = await prisma.asset.create({
|
||||
data: { name: 'videoB.mp4', type: 'file', projectId: project.id, status: 'uploaded' },
|
||||
})
|
||||
|
||||
const commentB = await prisma.assetComment.create({
|
||||
data: {
|
||||
assetId: assetB.id,
|
||||
creatorId: user.id,
|
||||
message: 'Comment on B',
|
||||
annotation: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
})
|
||||
|
||||
await expect(resolveAnnotationsById(assetA.id, commentB.id)).rejects.toThrow(
|
||||
`Annotation "${commentB.id}" belongs to asset "${assetB.id}", not target asset "${assetA.id}".`,
|
||||
)
|
||||
})
|
||||
|
||||
it('resolves annotations and timestamp from AgentSessionEntry (1-on-1 Chat Mode)', async () => {
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Chat User', email: 'chatuser@test.com', password: 'pw' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Chat Team' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Chat Project', teamId: team.id },
|
||||
})
|
||||
const asset = await prisma.asset.create({
|
||||
data: {
|
||||
name: 'chat-video.mp4',
|
||||
type: 'file',
|
||||
projectId: project.id,
|
||||
status: 'uploaded',
|
||||
},
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: { name: 'Chat Bot User', email: 'bot@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' },
|
||||
},
|
||||
})
|
||||
|
||||
// Create session storage
|
||||
const storage = await DatabaseSessionStorage.create({
|
||||
agentId: agent.id,
|
||||
userId: user.id,
|
||||
assetId: asset.id,
|
||||
})
|
||||
|
||||
// Set active message context with markup annotations and position
|
||||
storage.currentMessageContext = {
|
||||
currentAsset: {
|
||||
id: asset.id,
|
||||
name: asset.name,
|
||||
type: 'file',
|
||||
path: asset.name,
|
||||
},
|
||||
position: { type: 'time', seconds: 12.34 },
|
||||
annotation: true,
|
||||
annotations: [
|
||||
{
|
||||
type: 'rectangle',
|
||||
x: 100,
|
||||
y: 200,
|
||||
width: 50,
|
||||
height: 50,
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
// User sends a message -> DatabaseSessionStorage.appendEntry is called
|
||||
const userEntry: SessionTreeEntry = {
|
||||
type: 'message',
|
||||
id: '01JTESTENTRY1234567890',
|
||||
parentId: null,
|
||||
timestamp: new Date().toISOString(),
|
||||
message: {
|
||||
role: 'user',
|
||||
content: 'Check this rectangle markup on video',
|
||||
timestamp: Date.now(),
|
||||
},
|
||||
}
|
||||
|
||||
await storage.appendEntry(userEntry)
|
||||
|
||||
// Verify DatabaseSessionStorage persisted entry with details.id = entry.id
|
||||
const dbEntry = await prisma.agentSessionEntry.findUnique({
|
||||
where: { id: '01JTESTENTRY1234567890' },
|
||||
})
|
||||
expect(dbEntry).toBeDefined()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const details = (dbEntry?.data as any)?.details
|
||||
expect(details.id).toBe('01JTESTENTRY1234567890')
|
||||
expect(details.position).toEqual({ type: 'time', seconds: 12.34 })
|
||||
expect(details.annotations).toHaveLength(1)
|
||||
|
||||
// Now resolveAnnotationsById directly with the entry id and matching asset.id
|
||||
const result = await resolveAnnotationsById(asset.id, '01JTESTENTRY1234567890')
|
||||
expect(result.timestamp).toBe(12.34)
|
||||
expect(result.annotations).toEqual([
|
||||
{
|
||||
type: 'rectangle',
|
||||
x: 100,
|
||||
y: 200,
|
||||
width: 50,
|
||||
height: 50,
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
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' },
|
||||
})
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Team' },
|
||||
})
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Project', teamId: team.id },
|
||||
})
|
||||
const assetA = await prisma.asset.create({
|
||||
data: { name: 'chatA.mp4', type: 'file', projectId: project.id, status: 'uploaded' },
|
||||
})
|
||||
const assetB = await prisma.asset.create({
|
||||
data: { name: 'chatB.mp4', type: 'file', projectId: project.id, status: 'uploaded' },
|
||||
})
|
||||
const agentUser = await prisma.user.create({
|
||||
data: { name: 'Bot User', email: 'bot2@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: assetB.id,
|
||||
})
|
||||
storage.currentMessageContext = {
|
||||
currentAsset: { id: assetB.id, name: assetB.name, type: 'file', path: assetB.name },
|
||||
annotation: true,
|
||||
annotations: [{ type: 'box' }],
|
||||
}
|
||||
const userEntry: SessionTreeEntry = {
|
||||
type: 'message',
|
||||
id: '01JENTRYONASSETB123456',
|
||||
parentId: null,
|
||||
timestamp: new Date().toISOString(),
|
||||
message: { role: 'user', content: 'Markup on B', timestamp: Date.now() },
|
||||
}
|
||||
await storage.appendEntry(userEntry)
|
||||
|
||||
await expect(resolveAnnotationsById(assetA.id, '01JENTRYONASSETB123456')).rejects.toThrow(
|
||||
`Annotation "01JENTRYONASSETB123456" belongs to asset "${assetB.id}", not target asset "${assetA.id}".`,
|
||||
)
|
||||
})
|
||||
|
||||
it('throws an error if annotationId does not match any record', async () => {
|
||||
await expect(resolveAnnotationsById('asset-1', 'non_existent_id')).rejects.toThrow(
|
||||
'Annotation with ID "non_existent_id" not found.',
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,52 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import type { ShumaiMessageContext } from '@shumai/dtos'
|
||||
|
||||
export async function resolveAnnotationsById(
|
||||
assetId: string,
|
||||
annotationId?: string | null,
|
||||
): Promise<{ annotations: PrismaJson.AnnotationList | null; timestamp: number | null }> {
|
||||
if (!annotationId) {
|
||||
return { annotations: null, timestamp: null }
|
||||
}
|
||||
|
||||
// 1. Check AssetComment table (Comments Mode)
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: annotationId },
|
||||
select: { assetId: true, annotation: true, second: true },
|
||||
})
|
||||
if (comment) {
|
||||
if (comment.assetId !== assetId) {
|
||||
throw new Error(
|
||||
`Annotation "${annotationId}" belongs to asset "${comment.assetId}", not target asset "${assetId}".`,
|
||||
)
|
||||
}
|
||||
const list = comment.annotation
|
||||
const annotations =
|
||||
Array.isArray(list) && list.length > 0 ? (list as PrismaJson.AnnotationList) : null
|
||||
return { annotations, timestamp: comment.second }
|
||||
}
|
||||
|
||||
// 2. Check AgentSessionEntry table (1-on-1 Chat Mode)
|
||||
const entry = await prisma.agentSessionEntry.findUnique({
|
||||
where: { id: annotationId },
|
||||
select: { assetId: true, data: true },
|
||||
})
|
||||
if (entry) {
|
||||
const details = (entry.data as Record<string, unknown> | null)?.details as
|
||||
| ShumaiMessageContext
|
||||
| undefined
|
||||
const entryAssetId = entry.assetId || details?.currentAsset?.id
|
||||
if (entryAssetId && entryAssetId !== assetId) {
|
||||
throw new Error(
|
||||
`Annotation "${annotationId}" belongs to asset "${entryAssetId}", not target asset "${assetId}".`,
|
||||
)
|
||||
}
|
||||
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
|
||||
return { annotations, timestamp }
|
||||
}
|
||||
|
||||
throw new Error(`Annotation with ID "${annotationId}" not found.`)
|
||||
}
|
||||
@@ -2,7 +2,10 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||||
import { createCreateFileTool } from './create-file'
|
||||
import { fieldsToTypeBoxSchema } from '../index'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
import { Value } from 'typebox/value'
|
||||
import * as fs from 'fs'
|
||||
import * as os from 'os'
|
||||
@@ -15,8 +18,26 @@ vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('./utils', () => ({
|
||||
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'test', type: 'file' }),
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
createFile: vi
|
||||
.fn()
|
||||
.mockResolvedValue({ id: 'file-1', name: 'test', type: 'file', sizeByte: 100 }),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createCreateFileTool', () => {
|
||||
@@ -56,23 +77,33 @@ describe('createCreateFileTool', () => {
|
||||
expect(s3Key).toMatch(/^files\/.+\.md$/)
|
||||
expect(uploadArgs[2]).toBe('text/markdown')
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: 'folder-1',
|
||||
s3Key,
|
||||
name: 'create-file-test.md',
|
||||
size: Buffer.byteLength('# Hello from disk', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
},
|
||||
userId: 'user-1',
|
||||
assetId: 'folder-1',
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'folder-1',
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({ id: 'file-1', name: 'test', type: 'file' })
|
||||
expect(assetService.createFile).toHaveBeenCalledWith({
|
||||
parentId: 'folder-1',
|
||||
name: 'create-file-test.md',
|
||||
key: s3Key,
|
||||
sizeByte: Buffer.byteLength('# Hello from disk', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
creatorId: 'user-1',
|
||||
metadata: undefined,
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'file-1',
|
||||
name: 'test',
|
||||
type: 'file',
|
||||
size: 100,
|
||||
})
|
||||
})
|
||||
|
||||
it('should forward the metadata to the agent tool workflow when provided', async () => {
|
||||
it('should forward the metadata to assetService.createFile when provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-metadata.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
@@ -86,9 +117,9 @@ describe('createCreateFileTool', () => {
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({ metadata: { prompt: 'Generated using gemini' } }),
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -125,19 +156,17 @@ describe('createCreateFileTool', () => {
|
||||
},
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should not include metadata in args when metadata is null', async () => {
|
||||
it('should not include metadata when metadata is null', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-no-metadata.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
@@ -151,8 +180,8 @@ describe('createCreateFileTool', () => {
|
||||
metadata: null,
|
||||
})
|
||||
|
||||
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
|
||||
expect(callArgs).not.toHaveProperty('metadata')
|
||||
const callArgs = vi.mocked(assetService.createFile).mock.calls[0][0]
|
||||
expect(callArgs.metadata).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should throw when the local file does not exist', async () => {
|
||||
@@ -161,7 +190,7 @@ describe('createCreateFileTool', () => {
|
||||
tool.execute('call-1', { parent: 'folder-1', path: '/nonexistent/file.md', data: null }),
|
||||
).rejects.toThrow('Local file not found at path: /nonexistent/file.md')
|
||||
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
|
||||
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
|
||||
expect(assetService.createFile).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should create a file directly from name and content', async () => {
|
||||
@@ -184,20 +213,23 @@ describe('createCreateFileTool', () => {
|
||||
expect(size).toBe(Buffer.byteLength('# Notes\n\nHello', 'utf-8'))
|
||||
expect(contentType).toBe('text/markdown')
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: 'folder-1',
|
||||
s3Key,
|
||||
name: 'notes.md',
|
||||
size: Buffer.byteLength('# Notes\n\nHello', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
},
|
||||
userId: 'user-1',
|
||||
assetId: 'folder-1',
|
||||
expect(assetService.createFile).toHaveBeenCalledWith({
|
||||
parentId: 'folder-1',
|
||||
name: 'notes.md',
|
||||
key: s3Key,
|
||||
sizeByte: Buffer.byteLength('# Notes\n\nHello', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
creatorId: 'user-1',
|
||||
metadata: undefined,
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({ id: 'file-1', name: 'test', type: 'file' })
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'file-1',
|
||||
name: 'test',
|
||||
type: 'file',
|
||||
size: 100,
|
||||
})
|
||||
})
|
||||
|
||||
it('should default unknown extensions to text/plain when creating from content', async () => {
|
||||
@@ -235,10 +267,8 @@ describe('createCreateFileTool', () => {
|
||||
]
|
||||
expect(s3Key).toContain('my_notes.md')
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({ name: 'my_notes.md' }),
|
||||
}),
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ name: 'my_notes.md' }),
|
||||
)
|
||||
})
|
||||
|
||||
@@ -260,7 +290,7 @@ describe('createCreateFileTool', () => {
|
||||
).rejects.toThrow('Provide exactly one of "path" (a local file) or "data" (name and content).')
|
||||
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
|
||||
expect(s3Service.putObject).not.toHaveBeenCalled()
|
||||
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
|
||||
expect(assetService.createFile).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should expose a strict, all-required (nullable) metadata schema when fields are provided', () => {
|
||||
@@ -316,4 +346,27 @@ describe('createCreateFileTool', () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
expect((tool.parameters as any).properties.metadata).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should pass agentId and record audit log when agentContext is provided', async () => {
|
||||
const filePath = createTempFile('# Agent file', 'agent-file.md')
|
||||
|
||||
const tool = createCreateFileTool('user-1', undefined, { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { parent: 'folder-1', path: filePath, data: null })
|
||||
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
creatorId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
}),
|
||||
)
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.file_create,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: undefined,
|
||||
itemId: 'file-1',
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { getFileMimeType, readFileMimeType } from '@shumai/core/src/utils/file-mime'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
import { Type, type TSchema } from 'typebox'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { ulid } from 'ulid'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
|
||||
interface CreateFileToolParams {
|
||||
parent: string
|
||||
@@ -24,7 +28,11 @@ function assertExactlyOneSource(params: CreateFileToolParams) {
|
||||
return hasPath ? params.path! : params.data!
|
||||
}
|
||||
|
||||
export function createCreateFileTool(userId: string, metadataSchema?: TSchema): AgentTool {
|
||||
export function createCreateFileTool(
|
||||
userId: string,
|
||||
metadataSchema?: TSchema,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool {
|
||||
const createFileSchema = Type.Object(
|
||||
{
|
||||
parent: Type.String({
|
||||
@@ -105,22 +113,45 @@ export function createCreateFileTool(userId: string, metadataSchema?: TSchema):
|
||||
await s3Service.putObject(process.env.S3_BUCKET || 'shumai', s3Key, content, size, mimeType)
|
||||
}
|
||||
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: p.parent,
|
||||
s3Key,
|
||||
name,
|
||||
size,
|
||||
contentType: mimeType,
|
||||
...(p.metadata ? { metadata: p.metadata } : {}),
|
||||
},
|
||||
userId,
|
||||
assetId: p.parent,
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: p.parent,
|
||||
})
|
||||
|
||||
const asset = await assetService.createFile({
|
||||
parentId: p.parent,
|
||||
name,
|
||||
key: s3Key,
|
||||
sizeByte: size,
|
||||
contentType: mimeType,
|
||||
creatorId: userId,
|
||||
agentId: agentContext?.agentId,
|
||||
metadata: p.metadata ?? undefined,
|
||||
})
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.file_create,
|
||||
teamId: agentContext.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: asset.projectId ?? undefined,
|
||||
itemId: asset.id,
|
||||
})
|
||||
}
|
||||
|
||||
const result = {
|
||||
id: asset.id,
|
||||
name: asset.name,
|
||||
type: asset.type,
|
||||
size: Number(asset.sizeByte),
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: result,
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -0,0 +1,87 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createCreateFolderTool } from './create-folder'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
createAsset: vi.fn().mockResolvedValue({
|
||||
id: 'folder-1',
|
||||
name: 'New Folder',
|
||||
type: 'folder',
|
||||
sizeByte: 0,
|
||||
}),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createCreateFolderTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('checks edit permission and calls assetService.createAsset with folder type', async () => {
|
||||
const tool = createCreateFolderTool('user-1')
|
||||
const result = await tool.execute('call-1', { parent: 'root-folder', name: 'New Folder' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'root-folder',
|
||||
})
|
||||
|
||||
expect(assetService.createAsset).toHaveBeenCalledWith({
|
||||
name: 'New Folder',
|
||||
parentId: 'root-folder',
|
||||
type: 'folder',
|
||||
creatorId: 'user-1',
|
||||
agentId: undefined,
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'folder-1',
|
||||
name: 'New Folder',
|
||||
type: 'folder',
|
||||
size: 0,
|
||||
})
|
||||
})
|
||||
|
||||
it('passes agentId and logs audit action when agentContext is provided', async () => {
|
||||
const tool = createCreateFolderTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { parent: 'root-folder', name: 'New Folder' })
|
||||
|
||||
expect(assetService.createAsset).toHaveBeenCalledWith({
|
||||
name: 'New Folder',
|
||||
parentId: 'root-folder',
|
||||
type: 'folder',
|
||||
creatorId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
})
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.folder_create,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: undefined,
|
||||
itemId: 'folder-1',
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,6 +1,10 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
const createFolderSchema = Type.Object({
|
||||
parent: Type.String({
|
||||
@@ -12,22 +16,52 @@ const createFolderSchema = Type.Object({
|
||||
}),
|
||||
})
|
||||
|
||||
export function createCreateFolderTool(userId: string): AgentTool<typeof createFolderSchema> {
|
||||
export function createCreateFolderTool(
|
||||
userId: string,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool<typeof createFolderSchema> {
|
||||
return {
|
||||
name: 'create_folder',
|
||||
label: 'Create Folder',
|
||||
description: 'Create a new folder in a specified parent folder.',
|
||||
parameters: createFolderSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'create_folder',
|
||||
args: params,
|
||||
userId,
|
||||
assetId: params.parent,
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: params.parent,
|
||||
})
|
||||
|
||||
const newFolder = await assetService.createAsset({
|
||||
name: params.name,
|
||||
parentId: params.parent,
|
||||
type: 'folder',
|
||||
creatorId: userId,
|
||||
agentId: agentContext?.agentId,
|
||||
})
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.folder_create,
|
||||
teamId: agentContext.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: newFolder.projectId ?? undefined,
|
||||
itemId: newFolder.id,
|
||||
})
|
||||
}
|
||||
|
||||
const result = {
|
||||
id: newFolder.id,
|
||||
name: newFolder.name,
|
||||
type: newFolder.type,
|
||||
size: Number(newFolder.sizeByte),
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: result,
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -2,7 +2,10 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||||
import { createCreateVersionTool } from './create-version'
|
||||
import { fieldsToTypeBoxSchema } from '../index'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
import { Value } from 'typebox/value'
|
||||
import * as fs from 'fs'
|
||||
import * as os from 'os'
|
||||
@@ -14,8 +17,26 @@ vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('./utils', () => ({
|
||||
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'v2', type: 'file' }),
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
createVersion: vi
|
||||
.fn()
|
||||
.mockResolvedValue({ id: 'file-1', name: 'v2', type: 'file', sizeByte: 100 }),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createCreateVersionTool', () => {
|
||||
@@ -41,7 +62,7 @@ describe('createCreateVersionTool', () => {
|
||||
return filePath
|
||||
}
|
||||
|
||||
it('should upload a local file and create a version via the agent tool workflow', async () => {
|
||||
it('should upload a local file and create a version via assetService.createVersion', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-test.md')
|
||||
|
||||
const tool = createCreateVersionTool('user-1')
|
||||
@@ -53,23 +74,33 @@ describe('createCreateVersionTool', () => {
|
||||
expect(s3Key).toMatch(/^files\/.+\.md$/)
|
||||
expect(uploadArgs[2]).toBe('text/markdown')
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: 'file-1',
|
||||
s3Key,
|
||||
name: 'create-version-test.md',
|
||||
size: Buffer.byteLength('# Hello from disk', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
},
|
||||
userId: 'user-1',
|
||||
assetId: 'file-1',
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'file-1',
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({ id: 'file-1', name: 'v2', type: 'file' })
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith({
|
||||
parentId: 'file-1',
|
||||
name: 'create-version-test.md',
|
||||
key: s3Key,
|
||||
sizeByte: Buffer.byteLength('# Hello from disk', 'utf-8'),
|
||||
contentType: 'text/markdown',
|
||||
creatorId: 'user-1',
|
||||
metadata: undefined,
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'file-1',
|
||||
name: 'v2',
|
||||
type: 'file',
|
||||
size: 100,
|
||||
})
|
||||
})
|
||||
|
||||
it('should forward the metadata to the agent tool workflow when provided', async () => {
|
||||
it('should forward the metadata to assetService.createVersion when provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-metadata.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
@@ -82,9 +113,9 @@ describe('createCreateVersionTool', () => {
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({ metadata: { prompt: 'Generated using gemini' } }),
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -120,19 +151,17 @@ describe('createCreateVersionTool', () => {
|
||||
},
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should not include metadata in args when metadata is null', async () => {
|
||||
it('should not include metadata when metadata is null', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-no-metadata.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
@@ -141,8 +170,8 @@ describe('createCreateVersionTool', () => {
|
||||
const tool = createCreateVersionTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', { parent: 'file-1', path: filePath, metadata: null })
|
||||
|
||||
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
|
||||
expect(callArgs).not.toHaveProperty('metadata')
|
||||
const callArgs = vi.mocked(assetService.createVersion).mock.calls[0][0]
|
||||
expect(callArgs.metadata).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should throw when the local file does not exist', async () => {
|
||||
@@ -151,7 +180,7 @@ describe('createCreateVersionTool', () => {
|
||||
tool.execute('call-1', { parent: 'file-1', path: '/nonexistent/file.md' }),
|
||||
).rejects.toThrow('Local file not found at path: /nonexistent/file.md')
|
||||
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
|
||||
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
|
||||
expect(assetService.createVersion).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should expose a strict, all-required (nullable) metadata schema when fields are provided', () => {
|
||||
@@ -183,4 +212,30 @@ describe('createCreateVersionTool', () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
expect((tool.parameters as any).properties.metadata).toBeUndefined()
|
||||
})
|
||||
|
||||
it('should pass agentId and record audit log when agentContext is provided', async () => {
|
||||
const filePath = createTempFile('# Agent version file', 'agent-ver-file.md')
|
||||
|
||||
const tool = createCreateVersionTool('user-1', undefined, {
|
||||
teamId: 'team-1',
|
||||
agentId: 'agent-1',
|
||||
})
|
||||
await tool.execute('call-1', { parent: 'file-1', path: filePath })
|
||||
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
creatorId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
}),
|
||||
)
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.file_create,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: undefined,
|
||||
itemId: 'file-1',
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
import { Type, type TSchema } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { readFileMimeType } from '@shumai/core/src/utils/file-mime'
|
||||
import { ulid } from 'ulid'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
import { Type, type TSchema } from 'typebox'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { ulid } from 'ulid'
|
||||
|
||||
interface CreateVersionToolParams {
|
||||
parent: string
|
||||
@@ -14,7 +18,11 @@ interface CreateVersionToolParams {
|
||||
metadata?: Record<string, unknown> | null
|
||||
}
|
||||
|
||||
export function createCreateVersionTool(userId: string, metadataSchema?: TSchema): AgentTool {
|
||||
export function createCreateVersionTool(
|
||||
userId: string,
|
||||
metadataSchema?: TSchema,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool {
|
||||
const createVersionSchema = Type.Object(
|
||||
{
|
||||
parent: Type.String({
|
||||
@@ -48,27 +56,51 @@ export function createCreateVersionTool(userId: string, metadataSchema?: TSchema
|
||||
|
||||
const fileSize = fs.statSync(absolutePath).size
|
||||
const mimeType = readFileMimeType(absolutePath)
|
||||
const name = path.basename(absolutePath)
|
||||
|
||||
// Generate compliant S3 key matching normal file upload format
|
||||
const s3Key = `files/${ulid()}/${sanitizeFilename(path.basename(absolutePath))}`
|
||||
const s3Key = `files/${ulid()}/${sanitizeFilename(name)}`
|
||||
await s3Service.uploadFileToKey(absolutePath, s3Key, mimeType)
|
||||
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'create_version',
|
||||
args: {
|
||||
parent: p.parent,
|
||||
s3Key,
|
||||
name: path.basename(absolutePath),
|
||||
size: fileSize,
|
||||
contentType: mimeType,
|
||||
...(p.metadata ? { metadata: p.metadata } : {}),
|
||||
},
|
||||
userId,
|
||||
assetId: p.parent,
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: p.parent,
|
||||
})
|
||||
|
||||
const asset = await assetService.createVersion({
|
||||
parentId: p.parent,
|
||||
name,
|
||||
key: s3Key,
|
||||
sizeByte: fileSize,
|
||||
contentType: mimeType,
|
||||
creatorId: userId,
|
||||
agentId: agentContext?.agentId,
|
||||
metadata: p.metadata ?? undefined,
|
||||
})
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.file_create,
|
||||
teamId: agentContext.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: asset.projectId ?? undefined,
|
||||
itemId: asset.id,
|
||||
})
|
||||
}
|
||||
|
||||
const result = {
|
||||
id: asset.id,
|
||||
name: asset.name,
|
||||
type: asset.type,
|
||||
size: Number(asset.sizeByte),
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: result,
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -0,0 +1,128 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createDeleteAssetTool } from './delete-asset'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
deleteAssets: vi.fn().mockResolvedValue(undefined),
|
||||
getAssetContext: vi.fn().mockResolvedValue({
|
||||
teamId: 'team-1',
|
||||
projectId: 'proj-1',
|
||||
}),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/db', () => ({
|
||||
prisma: {
|
||||
asset: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createDeleteAssetTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('checks edit permission, deletes asset, and returns success for a file', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
type: 'file',
|
||||
projectId: 'proj-1',
|
||||
} as unknown as never)
|
||||
|
||||
const tool = createDeleteAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(assetService.deleteAssets).toHaveBeenCalledWith(['asset-1'])
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
success: true,
|
||||
deletedAssetId: 'asset-1',
|
||||
})
|
||||
})
|
||||
|
||||
it('logs file_delete audit action when deleting a file with agentContext', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
type: 'file',
|
||||
projectId: 'proj-1',
|
||||
} as unknown as never)
|
||||
|
||||
const tool = createDeleteAssetTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { assetId: 'asset-1' })
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.file_delete,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'asset-1',
|
||||
})
|
||||
})
|
||||
|
||||
it('logs folder_delete audit action when deleting a folder with agentContext', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'folder-1',
|
||||
type: 'folder',
|
||||
projectId: 'proj-1',
|
||||
} as unknown as never)
|
||||
|
||||
const tool = createDeleteAssetTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { assetId: 'folder-1' })
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.folder_delete,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'folder-1',
|
||||
})
|
||||
})
|
||||
|
||||
it('throws when asset is not found', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
|
||||
const tool = createDeleteAssetTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'missing-asset' })).rejects.toThrow(
|
||||
'Asset not found',
|
||||
)
|
||||
})
|
||||
|
||||
it('fails when permission check fails', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockRejectedValueOnce(new Error('Permission denied'))
|
||||
const tool = createDeleteAssetTool('user-1')
|
||||
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1' })).rejects.toThrow(
|
||||
'Permission denied',
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,74 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { prisma, type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
const deleteAssetSchema = Type.Object(
|
||||
{
|
||||
assetId: Type.String({
|
||||
description:
|
||||
'The ID of the single asset (file or folder) to delete. This parameter is required.',
|
||||
}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
export function createDeleteAssetTool(
|
||||
userId: string,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool<typeof deleteAssetSchema> {
|
||||
return {
|
||||
name: 'delete_asset',
|
||||
label: 'Delete Asset',
|
||||
description:
|
||||
'Delete a single asset (file or folder) by its ID. Can only delete one asset at a time.',
|
||||
parameters: deleteAssetSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: params.assetId,
|
||||
})
|
||||
|
||||
const asset = await prisma.asset.findUnique({
|
||||
where: { id: params.assetId },
|
||||
select: { id: true, type: true, projectId: true },
|
||||
})
|
||||
if (!asset) {
|
||||
throw new Error('Asset not found')
|
||||
}
|
||||
|
||||
const ctx = await assetService.getAssetContext(params.assetId).catch(() => ({
|
||||
teamId: agentContext?.teamId || '',
|
||||
projectId: asset.projectId ?? undefined,
|
||||
}))
|
||||
|
||||
await assetService.deleteAssets([params.assetId])
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
await auditLogService.logAction({
|
||||
action: asset.type === 'folder' ? AuditAction.folder_delete : AuditAction.file_delete,
|
||||
teamId: agentContext.teamId || ctx.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: ctx.projectId ?? asset.projectId ?? undefined,
|
||||
itemId: params.assetId,
|
||||
})
|
||||
}
|
||||
|
||||
const result = {
|
||||
success: true,
|
||||
deletedAssetId: params.assetId,
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,10 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||||
import { createDownloadAssetTool } from './download-asset'
|
||||
import { prisma, type Asset } from '@shumai/db'
|
||||
import {
|
||||
createDownloadAssetTool,
|
||||
resolveAssetIdFromKey,
|
||||
resolveS3MediaBuffer,
|
||||
} from './download-asset'
|
||||
import { prisma, type Asset, type StorageKey } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import * as fs from 'fs'
|
||||
@@ -15,6 +19,10 @@ vi.mock('@shumai/db', async (importOriginal) => {
|
||||
findUnique: vi.fn(),
|
||||
findFirst: vi.fn(),
|
||||
},
|
||||
storageKey: {
|
||||
findFirst: vi.fn(),
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
@@ -52,163 +60,328 @@ describe('downloadAssetTool', () => {
|
||||
|
||||
it('should throw authorization error if user ID is empty', async () => {
|
||||
const tool = createDownloadAssetTool('')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1' })).rejects.toThrow(
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', key: null })).rejects.toThrow(
|
||||
'User ID is required for authorization.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if asset not found', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
|
||||
it('should throw error if both assetId and key are null', async () => {
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1' })).rejects.toThrow(
|
||||
'Asset with ID asset-1 not found.',
|
||||
await expect(tool.execute('call-1', { assetId: null, key: null })).rejects.toThrow(
|
||||
'Provide exactly one of "assetId" (to download a workspace asset) or "key" (to download a specific S3 storage key). Set the unused parameter to null.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should download proxy image to .pi directory when imageTranscodes is present', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-img-1',
|
||||
name: 'sample_photo.jpg',
|
||||
storageKey: { key: 'raw/sample_photo.jpg' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/sample_photo.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-proxy-image-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
it('should throw error if both assetId and key are provided', async () => {
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-img-1' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-img-1',
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/sample_photo.webp')
|
||||
|
||||
const expectedPath = path.join(piDir, 'asset-img-1_sample_photo.jpg')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(fs.readFileSync(expectedPath, 'utf-8')).toBe('fake-proxy-image-bytes')
|
||||
|
||||
expect(result.details.filePath).toBe(path.join('.pi', 'asset-img-1_sample_photo.jpg'))
|
||||
expect(result.details.contentType).toBe('image/webp')
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toContain(
|
||||
'Remember to delete this temporary file when finished.',
|
||||
await expect(
|
||||
tool.execute('call-1', { assetId: 'asset-1', key: 'files/path/file.png' }),
|
||||
).rejects.toThrow(
|
||||
'Provide exactly one of "assetId" (to download a workspace asset) or "key" (to download a specific S3 storage key). Set the unused parameter to null.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should download proxy video to .pi directory when videoTranscodes is present', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-vid-1',
|
||||
name: 'video_test.mov',
|
||||
storageKey: { key: 'raw/video_test.mov' },
|
||||
media: {
|
||||
proxyType: 'video',
|
||||
videoTranscodes: [{ key: 'proxy/video_test.mp4' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
describe('Download by assetId', () => {
|
||||
it('should throw error if asset not found', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-video-bytes'),
|
||||
contentType: 'video/mp4',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-vid-1' })
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/video_test.mp4')
|
||||
|
||||
const expectedPath = path.join(piDir, 'asset-vid-1_video_test.mov')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.size).toBe(Buffer.from('fake-video-bytes').length)
|
||||
})
|
||||
|
||||
it('should download original file to .pi directory even when pdfTranscode is present', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-md-1',
|
||||
name: 'doc.md',
|
||||
storageKey: { key: 'raw/doc.md' },
|
||||
media: {
|
||||
proxyType: 'pdf',
|
||||
pdfTranscode: { key: 'proxy/doc.pdf' },
|
||||
original: { key: 'raw/doc.md' },
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('# fake markdown bytes'),
|
||||
contentType: 'text/markdown',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-md-1' })
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'raw/doc.md')
|
||||
|
||||
const expectedPath = path.join(piDir, 'asset-md-1_doc.md')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.contentType).toBe('text/markdown')
|
||||
})
|
||||
|
||||
it('should resolve version_stack asset to its latest version file', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'stack-1',
|
||||
name: '',
|
||||
type: 'version_stack',
|
||||
storageKey: null,
|
||||
media: null,
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.asset.findFirst).mockResolvedValue({
|
||||
id: 'file-ver-2',
|
||||
name: 'banana_pig.png',
|
||||
type: 'file',
|
||||
storageKey: { key: 'raw/banana_pig.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/banana_pig.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-version-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'stack-1' })
|
||||
|
||||
expect(prisma.asset.findFirst).toHaveBeenCalledWith({
|
||||
where: { parentId: 'stack-1', isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', key: null })).rejects.toThrow(
|
||||
'Asset with ID asset-1 not found.',
|
||||
)
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/banana_pig.webp')
|
||||
it('should download proxy image to .pi directory when downloading by assetId', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-img-1',
|
||||
name: 'sample_photo.jpg',
|
||||
storageKey: { key: 'raw/sample_photo.jpg' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/sample_photo.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const expectedPath = path.join(piDir, 'file-ver-2_banana_pig.png')
|
||||
createdFiles.push(expectedPath)
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-proxy-image-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.name).toBe('banana_pig.png')
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-img-1', key: null })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-img-1',
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/sample_photo.webp')
|
||||
|
||||
const expectedPath = path.join(piDir, 'asset-img-1_sample_photo.jpg')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(fs.readFileSync(expectedPath, 'utf-8')).toBe('fake-proxy-image-bytes')
|
||||
|
||||
expect(result.details.filePath).toBe(path.join('.pi', 'asset-img-1_sample_photo.jpg'))
|
||||
expect(result.details.contentType).toBe('image/webp')
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toContain(
|
||||
'Remember to delete this temporary file when finished.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should resolve version_stack asset to its latest version file', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'stack-1',
|
||||
name: '',
|
||||
type: 'version_stack',
|
||||
storageKey: null,
|
||||
media: null,
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.asset.findFirst).mockResolvedValue({
|
||||
id: 'file-ver-2',
|
||||
name: 'banana_pig.png',
|
||||
type: 'file',
|
||||
storageKey: { key: 'raw/banana_pig.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/banana_pig.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-version-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'stack-1', key: null })
|
||||
|
||||
expect(prisma.asset.findFirst).toHaveBeenCalledWith({
|
||||
where: { parentId: 'stack-1', isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/banana_pig.webp')
|
||||
|
||||
const expectedPath = path.join(piDir, 'file-ver-2_banana_pig.png')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.name).toBe('banana_pig.png')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Download by S3 key and Authorization', () => {
|
||||
it('should reject keys that do not start with files/', async () => {
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', { assetId: null, key: 'avatars/user-1.png' }),
|
||||
).rejects.toThrow('Invalid storage key format: key must start with "files/"')
|
||||
})
|
||||
|
||||
it('should reject keys with path traversal (..)', async () => {
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', { assetId: null, key: 'files/../../etc/passwd' }),
|
||||
).rejects.toThrow('cannot contain ".."')
|
||||
})
|
||||
|
||||
it('should reject keys with insufficient path segments', async () => {
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: null, key: 'files/invalid' })).rejects.toThrow(
|
||||
'Invalid storage key format',
|
||||
)
|
||||
})
|
||||
|
||||
it('should reject keys that do not belong to any valid asset in database', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findFirst).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findUnique).mockResolvedValue(null)
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', { assetId: null, key: 'files/nonexistent-id/shot.webp' }),
|
||||
).rejects.toThrow('does not belong to any valid asset or the asset has been deleted')
|
||||
})
|
||||
|
||||
it('should reject download when user lacks read permission on the owning asset (cross-project protection)', async () => {
|
||||
// Key belongs to asset-in-other-project
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-in-other-project',
|
||||
} as unknown as Asset)
|
||||
|
||||
// Authz rejects because user is in a different project/team
|
||||
vi.mocked(authzService.hasPermission).mockRejectedValue(
|
||||
new Error('User does not have Read permission on asset asset-in-other-project'),
|
||||
)
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: null,
|
||||
key: 'files/asset-in-other-project/screenshots/secret_frame.webp',
|
||||
}),
|
||||
).rejects.toThrow('User does not have Read permission on asset asset-in-other-project')
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-in-other-project',
|
||||
})
|
||||
expect(s3Service.getObject).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should authorize and download derived artifact key (files/<assetId>/...)', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'ast-123',
|
||||
} as unknown as Asset)
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-screenshot-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: null,
|
||||
key: 'files/ast-123/screenshots/shot_5.0s.webp',
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'ast-123',
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/ast-123/screenshots/shot_5.0s.webp',
|
||||
)
|
||||
|
||||
const expectedPath = path.join(piDir, 'shot_5.0s.webp')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(fs.readFileSync(expectedPath, 'utf-8')).toBe('fake-screenshot-bytes')
|
||||
|
||||
expect(result.details.filePath).toBe(path.join('.pi', 'shot_5.0s.webp'))
|
||||
expect(result.details.key).toBe('files/ast-123/screenshots/shot_5.0s.webp')
|
||||
expect(result.details.assetId).toBe('ast-123')
|
||||
expect(result.details.size).toBe(Buffer.from('fake-screenshot-bytes').length)
|
||||
})
|
||||
|
||||
it('should authorize and download original upload key (files/<uploadUlid>/...) via StorageKey', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findFirst).mockResolvedValue({
|
||||
id: 'sk-1',
|
||||
key: 'files/upload-ulid-456/photo.png',
|
||||
assets: [{ id: 'asset-photo-1' }],
|
||||
} as unknown as StorageKey & { assets: Asset[] })
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-original-photo-bytes'),
|
||||
contentType: 'image/png',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: null,
|
||||
key: 'files/upload-ulid-456/photo.png',
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-photo-1',
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'files/upload-ulid-456/photo.png')
|
||||
|
||||
const expectedPath = path.join(piDir, 'photo.png')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.assetId).toBe('asset-photo-1')
|
||||
})
|
||||
})
|
||||
|
||||
describe('resolveAssetIdFromKey helper unit tests', () => {
|
||||
it('resolves directly by asset ID', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({ id: 'ast-999' } as unknown as Asset)
|
||||
const assetId = await resolveAssetIdFromKey('files/ast-999/pdf_pages/page_1.webp')
|
||||
expect(assetId).toBe('ast-999')
|
||||
})
|
||||
|
||||
it('resolves via StorageKey prefix', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findFirst).mockResolvedValue({
|
||||
assets: [{ id: 'ast-888' }],
|
||||
} as unknown as StorageKey & { assets: Asset[] })
|
||||
const assetId = await resolveAssetIdFromKey('files/ulid-777/document.pdf')
|
||||
expect(assetId).toBe('ast-888')
|
||||
})
|
||||
|
||||
it('resolves via exact StorageKey match', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findFirst).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findUnique).mockResolvedValue({
|
||||
assets: [{ id: 'ast-777' }],
|
||||
} as unknown as StorageKey & { assets: Asset[] })
|
||||
const assetId = await resolveAssetIdFromKey('files/ulid-special/document.pdf')
|
||||
expect(assetId).toBe('ast-777')
|
||||
})
|
||||
})
|
||||
|
||||
describe('resolveS3MediaBuffer helper unit tests', () => {
|
||||
it('throws authorization error when userId is empty', async () => {
|
||||
await expect(resolveS3MediaBuffer('files/ast-1/img.png', '')).rejects.toThrow(
|
||||
'User ID is required for authorization.',
|
||||
)
|
||||
})
|
||||
|
||||
it('verifies authz permission on owning asset and returns buffer with mimeType', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({ id: 'ast-1' } as unknown as Asset)
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('png-bytes'),
|
||||
contentType: 'image/png',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const result = await resolveS3MediaBuffer('files/ast-1/image.png', 'user-123')
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-123' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'ast-1',
|
||||
})
|
||||
expect(result.buffer.toString()).toBe('png-bytes')
|
||||
expect(result.mimeType).toBe('image/png')
|
||||
})
|
||||
|
||||
it('throws error when S3 file is not an image', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({ id: 'ast-1' } as unknown as Asset)
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('some text'),
|
||||
contentType: 'text/plain',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
await expect(resolveS3MediaBuffer('files/ast-1/readme.txt', 'user-123')).rejects.toThrow(
|
||||
'has MIME type "text/plain", but an image is required.',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -4,85 +4,144 @@ import { prisma, type User } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { getFileMimeType } from '@shumai/core/src/utils/file-mime'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
|
||||
const downloadAssetSchema = Type.Object({
|
||||
assetId: Type.String({
|
||||
description:
|
||||
'The asset ID of the workspace asset to download to local disk. This parameter is required.',
|
||||
}),
|
||||
})
|
||||
export const downloadAssetSchema = Type.Object(
|
||||
{
|
||||
assetId: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'The asset ID of the workspace asset to download to local disk, or null if providing "key".',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
key: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'The storage S3 key of a specific media artifact (e.g. a screenshot or transcode key from read_asset) to download to local disk, or null if providing "assetId".',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
export async function resolveAssetIdFromKey(key: string): Promise<string> {
|
||||
if (!key.startsWith('files/') || key.includes('..')) {
|
||||
throw new Error(
|
||||
'Invalid storage key format: key must start with "files/" and cannot contain "..".',
|
||||
)
|
||||
}
|
||||
|
||||
const segments = key.split('/')
|
||||
if (segments.length < 3) {
|
||||
throw new Error(
|
||||
'Invalid storage key format: key must follow "files/<identifier>/<path>" structure.',
|
||||
)
|
||||
}
|
||||
|
||||
const identifier = segments[1]
|
||||
|
||||
// 1. Check if identifier is directly an Asset ID (Derived Artifacts: screenshots, pdf_pages, annotations, proxies)
|
||||
const assetById = await prisma.asset.findUnique({
|
||||
where: { id: identifier, isDeleted: false },
|
||||
select: { id: true },
|
||||
})
|
||||
if (assetById) {
|
||||
return assetById.id
|
||||
}
|
||||
|
||||
// 2. Check if identifier is a StorageKey directory prefix (Original uploads / agent-created files)
|
||||
const storageKeyByPrefix = await prisma.storageKey.findFirst({
|
||||
where: { key: { startsWith: `files/${identifier}/` } },
|
||||
include: {
|
||||
assets: {
|
||||
where: { isDeleted: false },
|
||||
select: { id: true },
|
||||
},
|
||||
},
|
||||
})
|
||||
if (storageKeyByPrefix?.assets && storageKeyByPrefix.assets.length > 0) {
|
||||
return storageKeyByPrefix.assets[0].id
|
||||
}
|
||||
|
||||
// 3. Exact StorageKey fallback
|
||||
const exactStorageKey = await prisma.storageKey.findUnique({
|
||||
where: { key },
|
||||
include: {
|
||||
assets: {
|
||||
where: { isDeleted: false },
|
||||
select: { id: true },
|
||||
},
|
||||
},
|
||||
})
|
||||
if (exactStorageKey?.assets && exactStorageKey.assets.length > 0) {
|
||||
return exactStorageKey.assets[0].id
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Storage key "${key}" does not belong to any valid asset or the asset has been deleted.`,
|
||||
)
|
||||
}
|
||||
|
||||
export async function resolveS3MediaBuffer(
|
||||
key: string,
|
||||
userId: string,
|
||||
): Promise<{ buffer: Buffer; mimeType: string }> {
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
const owningAssetId = await resolveAssetIdFromKey(key)
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: owningAssetId,
|
||||
})
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, key)
|
||||
const mimeType = getFileMimeType(
|
||||
buffer,
|
||||
key,
|
||||
contentType && contentType !== 'application/octet-stream'
|
||||
? contentType
|
||||
: 'application/octet-stream',
|
||||
)
|
||||
|
||||
if (!mimeType.startsWith('image/')) {
|
||||
throw new Error(`Storage key "${key}" has MIME type "${mimeType}", but an image is required.`)
|
||||
}
|
||||
|
||||
return { buffer, mimeType }
|
||||
}
|
||||
|
||||
export function createDownloadAssetTool(userId: string): AgentTool<typeof downloadAssetSchema> {
|
||||
return {
|
||||
name: 'download_asset',
|
||||
label: 'Download Asset',
|
||||
description:
|
||||
'Downloads a workspace asset (proxy version if available) to the local .pi directory for processing with local scripts or bash commands. Remember to delete the temporary downloaded file when finished.',
|
||||
'Downloads a workspace asset or specific storage S3 key to the local .pi directory for processing with local scripts or bash commands. ' +
|
||||
'Provide exactly one of "assetId" (for full assets) or "key" (for intermediate artifacts like screenshots from read_asset). ' +
|
||||
'Remember to delete the temporary downloaded file when finished.',
|
||||
parameters: downloadAssetSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const assetId = params.assetId
|
||||
const { assetId, key } = params
|
||||
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
const hasAssetId = assetId !== null
|
||||
const hasKey = key !== null
|
||||
|
||||
let asset = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
if (asset.type === 'version_stack') {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
if (latestVersion) {
|
||||
asset = latestVersion
|
||||
}
|
||||
}
|
||||
|
||||
let mediaKey = asset.storageKey?.key
|
||||
|
||||
if (asset.media) {
|
||||
const mediaInfo = asset.media as unknown as PrismaJson.MediaInfo
|
||||
if (
|
||||
mediaInfo.proxyType === 'image' ||
|
||||
(mediaInfo.imageTranscodes && mediaInfo.imageTranscodes.length > 0)
|
||||
) {
|
||||
if (mediaInfo.imageTranscodes && mediaInfo.imageTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.imageTranscodes[0].key || mediaKey
|
||||
}
|
||||
} else if (
|
||||
mediaInfo.proxyType === 'video' ||
|
||||
(mediaInfo.videoTranscodes && mediaInfo.videoTranscodes.length > 0) ||
|
||||
mediaInfo.videoPreview?.key
|
||||
) {
|
||||
if (mediaInfo.videoTranscodes && mediaInfo.videoTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.videoTranscodes[0].key || mediaKey
|
||||
} else if (mediaInfo.videoPreview?.key) {
|
||||
mediaKey = mediaInfo.videoPreview.key
|
||||
}
|
||||
} else if (mediaInfo.original?.key) {
|
||||
mediaKey = mediaInfo.original.key || mediaKey
|
||||
}
|
||||
}
|
||||
|
||||
if (!mediaKey) {
|
||||
throw new Error(`No media content found for asset ${assetId}.`)
|
||||
if (hasAssetId === hasKey) {
|
||||
throw new Error(
|
||||
'Provide exactly one of "assetId" (to download a workspace asset) or "key" (to download a specific S3 storage key). Set the unused parameter to null.',
|
||||
)
|
||||
}
|
||||
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
@@ -90,32 +149,132 @@ export function createDownloadAssetTool(userId: string): AgentTool<typeof downlo
|
||||
fs.mkdirSync(piDir, { recursive: true })
|
||||
}
|
||||
|
||||
const safeName = sanitizeFilename(asset.name || 'file')
|
||||
const filename = `${asset.id}_${safeName}`
|
||||
const targetFilePath = path.join(piDir, filename)
|
||||
const relativePath = path.join('.pi', filename)
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, mediaKey)
|
||||
|
||||
fs.writeFileSync(targetFilePath, buffer)
|
||||
// Branch A: Download by assetId
|
||||
if (assetId) {
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Downloaded asset "${asset.name}" (ID: ${assetId}) to "${relativePath}". Remember to delete this temporary file when finished.`,
|
||||
let asset = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
if (asset.type === 'version_stack') {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
if (latestVersion) {
|
||||
asset = latestVersion
|
||||
}
|
||||
}
|
||||
|
||||
let mediaKey = asset.storageKey?.key
|
||||
|
||||
if (asset.media) {
|
||||
const mediaInfo = asset.media as unknown as PrismaJson.MediaInfo
|
||||
if (
|
||||
mediaInfo.proxyType === 'image' ||
|
||||
(mediaInfo.imageTranscodes && mediaInfo.imageTranscodes.length > 0)
|
||||
) {
|
||||
if (mediaInfo.imageTranscodes && mediaInfo.imageTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.imageTranscodes[0].key || mediaKey
|
||||
}
|
||||
} else if (
|
||||
mediaInfo.proxyType === 'video' ||
|
||||
(mediaInfo.videoTranscodes && mediaInfo.videoTranscodes.length > 0) ||
|
||||
mediaInfo.videoPreview?.key
|
||||
) {
|
||||
if (mediaInfo.videoTranscodes && mediaInfo.videoTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.videoTranscodes[0].key || mediaKey
|
||||
} else if (mediaInfo.videoPreview?.key) {
|
||||
mediaKey = mediaInfo.videoPreview.key
|
||||
}
|
||||
} else if (mediaInfo.original?.key) {
|
||||
mediaKey = mediaInfo.original.key || mediaKey
|
||||
}
|
||||
}
|
||||
|
||||
if (!mediaKey) {
|
||||
throw new Error(`No media content found for asset ${assetId}.`)
|
||||
}
|
||||
|
||||
const safeName = sanitizeFilename(asset.name || 'file')
|
||||
const filename = `${asset.id}_${safeName}`
|
||||
const targetFilePath = path.join(piDir, filename)
|
||||
const relativePath = path.join('.pi', filename)
|
||||
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, mediaKey)
|
||||
fs.writeFileSync(targetFilePath, buffer)
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Downloaded asset "${asset.name}" (ID: ${assetId}) to "${relativePath}". Remember to delete this temporary file when finished.`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
assetId,
|
||||
name: asset.name,
|
||||
filePath: relativePath,
|
||||
absolutePath: targetFilePath,
|
||||
contentType: contentType || 'application/octet-stream',
|
||||
size: buffer.length,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
assetId,
|
||||
name: asset.name,
|
||||
filePath: relativePath,
|
||||
absolutePath: targetFilePath,
|
||||
contentType: contentType || 'application/octet-stream',
|
||||
size: buffer.length,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// Branch B: Download by S3 storage key
|
||||
if (key) {
|
||||
const owningAssetId = await resolveAssetIdFromKey(key)
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: owningAssetId,
|
||||
})
|
||||
|
||||
const rawBasename = path.basename(key)
|
||||
const safeBasename = sanitizeFilename(rawBasename) || 'downloaded_file'
|
||||
const filename = safeBasename
|
||||
const targetFilePath = path.join(piDir, filename)
|
||||
const relativePath = path.join('.pi', filename)
|
||||
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, key)
|
||||
fs.writeFileSync(targetFilePath, buffer)
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Downloaded storage key "${key}" to "${relativePath}". Remember to delete this temporary file when finished.`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
key,
|
||||
assetId: owningAssetId,
|
||||
filePath: relativePath,
|
||||
absolutePath: targetFilePath,
|
||||
contentType: contentType || 'application/octet-stream',
|
||||
size: buffer.length,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error('Invalid download_asset parameters.')
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,298 @@
|
||||
import { vi } from 'vitest'
|
||||
|
||||
vi.mock('fs')
|
||||
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
||||
import { createGenerateImageTool } from './generate-image'
|
||||
import * as downloadAsset from './download-asset'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { EnabledMediaModel } from '@shumai/dtos'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
|
||||
describe('generate_image tool', () => {
|
||||
const enabledModels: EnabledMediaModel[] = [
|
||||
{
|
||||
id: 'em-1',
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3 (OpenAI)',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
{
|
||||
id: 'em-2',
|
||||
type: 'image',
|
||||
provider: 'azure',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3 (Azure)',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
{
|
||||
id: 'em-3',
|
||||
type: 'image',
|
||||
provider: 'google',
|
||||
modelId: 'imagen-3.0-generate-002',
|
||||
name: 'Imagen 3',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
]
|
||||
|
||||
const providerKeys = {
|
||||
openai: { apiKey: 'mock-openai-key' },
|
||||
azure: { apiKey: 'mock-azure-key' },
|
||||
google: { apiKey: 'mock-google-key' },
|
||||
}
|
||||
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
|
||||
beforeEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
|
||||
vi.spyOn(fs, 'mkdirSync').mockImplementation(() => undefined)
|
||||
vi.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
})
|
||||
|
||||
it('creates tool with correct metadata and provider-prefixed model schema', () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
expect(tool.name).toBe('generate_image')
|
||||
expect(tool.label).toBe('Generate Image')
|
||||
expect(tool.description).toContain('Generate an image')
|
||||
const modelDesc = (tool.parameters as { properties: { model: { description: string } } })
|
||||
.properties.model.description
|
||||
expect(modelDesc).toContain('openai:dall-e-3')
|
||||
expect(modelDesc).toContain('azure:dall-e-3')
|
||||
})
|
||||
|
||||
it('generates an image successfully and writes to .pi directory', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const mockBuffer = Buffer.from('fake-image-png-content')
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateImage').mockResolvedValue({
|
||||
buffer: mockBuffer,
|
||||
mimeType: 'image/png',
|
||||
})
|
||||
const writeSpy = vi.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
|
||||
const result = await tool.execute(
|
||||
'call-1',
|
||||
{
|
||||
prompt: 'A futuristic city skyline at dusk',
|
||||
model: 'openai:dall-e-3',
|
||||
aspectRatio: '16:9',
|
||||
size: null,
|
||||
seed: 42,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: 'test_city.png',
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
apiKey: 'mock-openai-key',
|
||||
prompt: 'A futuristic city skyline at dusk',
|
||||
aspectRatio: '16:9',
|
||||
seed: 42,
|
||||
}),
|
||||
)
|
||||
|
||||
const expectedPath = path.join(piDir, 'test_city.png')
|
||||
expect(writeSpy).toHaveBeenCalledWith(expectedPath, mockBuffer)
|
||||
|
||||
const textContent = result.content[0]
|
||||
expect(textContent.type).toBe('text')
|
||||
if (textContent.type === 'text') {
|
||||
expect(textContent.text).toContain('Successfully generated image')
|
||||
expect(textContent.text).toContain('.pi/test_city.png')
|
||||
}
|
||||
expect(result.details).toMatchObject({
|
||||
fileName: 'test_city.png',
|
||||
provider: 'openai',
|
||||
model: 'dall-e-3',
|
||||
})
|
||||
})
|
||||
|
||||
it('disambiguates identical model IDs across different providers', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateImage').mockResolvedValue({
|
||||
buffer: Buffer.from('image-bytes'),
|
||||
mimeType: 'image/png',
|
||||
})
|
||||
|
||||
// Invoke azure:dall-e-3
|
||||
await tool.execute(
|
||||
'call-azure',
|
||||
{
|
||||
prompt: 'Azure generation',
|
||||
model: 'azure:dall-e-3',
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenLastCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'azure',
|
||||
modelId: 'dall-e-3',
|
||||
apiKey: 'mock-azure-key',
|
||||
}),
|
||||
)
|
||||
|
||||
// Invoke openai:dall-e-3
|
||||
await tool.execute(
|
||||
'call-openai',
|
||||
{
|
||||
prompt: 'OpenAI generation',
|
||||
model: 'openai:dall-e-3',
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenLastCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
apiKey: 'mock-openai-key',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('defaults to first enabled model when model is null', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const mockBuffer = Buffer.from('fake-image-bytes')
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateImage').mockResolvedValue({
|
||||
buffer: mockBuffer,
|
||||
mimeType: 'image/png',
|
||||
})
|
||||
|
||||
await tool.execute(
|
||||
'call-2',
|
||||
{
|
||||
prompt: 'A cute cat',
|
||||
model: null,
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('resolves reference images and mask via resolveS3MediaBuffer', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateImage').mockResolvedValue({
|
||||
buffer: Buffer.from('out'),
|
||||
mimeType: 'image/jpeg',
|
||||
})
|
||||
|
||||
const resolverSpy = vi
|
||||
.spyOn(downloadAsset, 'resolveS3MediaBuffer')
|
||||
.mockImplementation(async (key: string) => ({
|
||||
buffer: Buffer.from(`data-for-${key}`),
|
||||
mimeType: 'image/png',
|
||||
}))
|
||||
|
||||
await tool.execute(
|
||||
'call-3',
|
||||
{
|
||||
prompt: 'Transform into watercolor',
|
||||
model: 'openai:dall-e-3',
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: ['files/ast-1/ref1.png', 'files/ast-2/ref2.png'],
|
||||
mask: 'files/ast-mask/mask.png',
|
||||
outputFileName: 'test_watercolor.jpg',
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(resolverSpy).toHaveBeenCalledWith('files/ast-1/ref1.png', 'user-1')
|
||||
expect(resolverSpy).toHaveBeenCalledWith('files/ast-2/ref2.png', 'user-1')
|
||||
expect(resolverSpy).toHaveBeenCalledWith('files/ast-mask/mask.png', 'user-1')
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
images: [
|
||||
Buffer.from('data-for-files/ast-1/ref1.png'),
|
||||
Buffer.from('data-for-files/ast-2/ref2.png'),
|
||||
],
|
||||
mask: Buffer.from('data-for-files/ast-mask/mask.png'),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('fails gracefully when API key is missing', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, {}, 'user-1') // No keys configured
|
||||
|
||||
await expect(
|
||||
tool.execute(
|
||||
'call-4',
|
||||
{
|
||||
prompt: 'A sunset',
|
||||
model: 'openai:dall-e-3',
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
),
|
||||
).rejects.toThrow('API key for provider "openai" is not configured')
|
||||
})
|
||||
|
||||
it('fails gracefully when requested model is not enabled', async () => {
|
||||
const tool = createGenerateImageTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
await expect(
|
||||
tool.execute(
|
||||
'call-5',
|
||||
{
|
||||
prompt: 'A sunset',
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
model: 'non-existent-model' as any,
|
||||
aspectRatio: null,
|
||||
size: null,
|
||||
seed: null,
|
||||
images: null,
|
||||
mask: null,
|
||||
outputFileName: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
),
|
||||
).rejects.toThrow('Image model "non-existent-model" is not enabled')
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,182 @@
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { EnabledMediaModel } from '@shumai/dtos'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { Type, type Static, type TSchema } from 'typebox'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { ulid } from 'ulid'
|
||||
import { resolveS3MediaBuffer } from './download-asset'
|
||||
|
||||
export function createGenerateImageTool(
|
||||
enabledModels: EnabledMediaModel[],
|
||||
providerKeys: Record<string, { apiKey?: string }>,
|
||||
userId?: string,
|
||||
): AgentTool {
|
||||
const modelIdentifiers = enabledModels.map((m) => `${m.provider}:${m.modelId}`)
|
||||
const modelSchemas =
|
||||
modelIdentifiers.length === 1
|
||||
? Type.Literal(modelIdentifiers[0])
|
||||
: Type.Union(
|
||||
modelIdentifiers.map((id) => Type.Literal(id)) as unknown as [
|
||||
TSchema,
|
||||
TSchema,
|
||||
...TSchema[],
|
||||
],
|
||||
)
|
||||
|
||||
const generateImageSchema = Type.Object(
|
||||
{
|
||||
prompt: Type.String({
|
||||
description: 'The text prompt describing the image to generate in detail.',
|
||||
}),
|
||||
model: Type.Union([modelSchemas, Type.Null()], {
|
||||
description: `The image model to use, in "provider:modelId" format. Available enabled models: ${modelIdentifiers.join(', ')}. Pass null to use the first enabled model (${modelIdentifiers[0]}).`,
|
||||
}),
|
||||
outputFileName: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional desired filename for the generated image (e.g. "cover.png"). Set to null for auto-generated name.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
images: Type.Union([
|
||||
Type.Array(Type.String(), {
|
||||
description:
|
||||
'Optional list of storage S3 keys of images to use as image-to-image or style reference. Call read_asset with s3KeyOnly: true to obtain the S3 key of an asset or video frame without loading its content into context. Set to null if not using.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
mask: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional storage S3 key of an inpainting mask image (white=inpaint, black=keep). Call read_asset with s3KeyOnly: true to obtain the S3 key. Set to null if not inpainting.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
aspectRatio: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional aspect ratio, e.g. "1:1", "16:9", "9:16", "4:3", "3:4", "2:3", "3:2". Set to null for default.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
size: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional target image dimensions, e.g. "1024x1024", "1536x1024". Set to null for default.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
seed: Type.Union([
|
||||
Type.Integer({
|
||||
description:
|
||||
'Optional random seed for reproducible generations. Set to null for random generation.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
type GenerateImageParams = Static<typeof generateImageSchema>
|
||||
|
||||
return {
|
||||
name: 'generate_image',
|
||||
label: 'Generate Image',
|
||||
description:
|
||||
'Generate an image using a configured image model. Supports text-to-image, reference images (image-to-image using S3 keys from read_asset), and inpainting (using a mask image S3 key from read_asset). The generated file is saved in the local .pi/ directory.',
|
||||
parameters: generateImageSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const p = params as GenerateImageParams
|
||||
|
||||
const defaultModel = `${enabledModels[0].provider}:${enabledModels[0].modelId}`
|
||||
const selected = p.model || defaultModel
|
||||
const modelConfig =
|
||||
enabledModels.find((m) => `${m.provider}:${m.modelId}` === selected) ||
|
||||
enabledModels.find((m) => m.modelId === selected)
|
||||
|
||||
if (!modelConfig) {
|
||||
throw new Error(
|
||||
`Image model "${selected}" is not enabled. Available enabled models: ${modelIdentifiers.join(', ')}`,
|
||||
)
|
||||
}
|
||||
|
||||
const customKey = providerKeys[modelConfig.provider]?.apiKey
|
||||
const apiKey = mediaGenerationService.resolveApiKey(modelConfig.provider, customKey)
|
||||
if (!apiKey) {
|
||||
throw new Error(
|
||||
`API key for provider "${modelConfig.provider}" is not configured. Please configure it in settings.`,
|
||||
)
|
||||
}
|
||||
|
||||
let resolvedImages: Buffer[] | undefined
|
||||
if (p.images && Array.isArray(p.images) && p.images.length > 0) {
|
||||
resolvedImages = await Promise.all(
|
||||
p.images.map(async (key: string) => {
|
||||
const { buffer } = await resolveS3MediaBuffer(key, userId || '')
|
||||
return buffer
|
||||
}),
|
||||
)
|
||||
}
|
||||
|
||||
let resolvedMask: Buffer | undefined
|
||||
if (p.mask) {
|
||||
const { buffer } = await resolveS3MediaBuffer(p.mask, userId || '')
|
||||
resolvedMask = buffer
|
||||
}
|
||||
|
||||
const { buffer, mimeType } = await mediaGenerationService.generateImage({
|
||||
provider: modelConfig.provider,
|
||||
modelId: modelConfig.modelId,
|
||||
apiKey,
|
||||
prompt: p.prompt,
|
||||
images: resolvedImages,
|
||||
mask: resolvedMask,
|
||||
aspectRatio: (p.aspectRatio as `${number}:${number}`) || undefined,
|
||||
size: (p.size as `${number}x${number}`) || undefined,
|
||||
seed: p.seed !== null && p.seed !== undefined ? p.seed : undefined,
|
||||
})
|
||||
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
if (!fs.existsSync(piDir)) {
|
||||
fs.mkdirSync(piDir, { recursive: true })
|
||||
}
|
||||
|
||||
const safeMime = mimeType || 'image/png'
|
||||
let ext = '.png'
|
||||
if (safeMime.includes('jpeg') || safeMime.includes('jpg')) ext = '.jpg'
|
||||
else if (safeMime.includes('webp')) ext = '.webp'
|
||||
|
||||
let filename: string
|
||||
if (p.outputFileName) {
|
||||
const safe = sanitizeFilename(p.outputFileName)
|
||||
filename = safe.includes('.') ? safe : `${safe}${ext}`
|
||||
} else {
|
||||
filename = `generated_image_${ulid()}${ext}`
|
||||
}
|
||||
|
||||
const targetPath = path.join(piDir, filename)
|
||||
const relativePath = path.join('.pi', filename)
|
||||
fs.writeFileSync(targetPath, buffer)
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Successfully generated image using model "${modelConfig.modelId}" (${modelConfig.provider}). Saved to "${relativePath}". Size: ${(buffer.length / 1024).toFixed(1)} KB.`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
fileName: filename,
|
||||
filePath: relativePath,
|
||||
absolutePath: targetPath,
|
||||
size: buffer.length,
|
||||
mimeType,
|
||||
provider: modelConfig.provider,
|
||||
model: modelConfig.modelId,
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,367 @@
|
||||
import { vi } from 'vitest'
|
||||
|
||||
vi.mock('fs')
|
||||
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
||||
import { createGenerateVideoTool } from './generate-video'
|
||||
import * as downloadAsset from './download-asset'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { EnabledMediaModel } from '@shumai/dtos'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
|
||||
describe('generate_video tool', () => {
|
||||
const enabledModels: EnabledMediaModel[] = [
|
||||
{
|
||||
id: 'vm-1',
|
||||
type: 'video',
|
||||
provider: 'klingai',
|
||||
modelId: 'kling-v1-standard',
|
||||
name: 'Kling v1 Standard',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
{
|
||||
id: 'vm-2',
|
||||
type: 'video',
|
||||
provider: 'fal',
|
||||
modelId: 'kling-v1-standard',
|
||||
name: 'Kling v1 Standard (fal)',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
{
|
||||
id: 'vm-3',
|
||||
type: 'video',
|
||||
provider: 'google',
|
||||
modelId: 'veo-2.0-generate-001',
|
||||
name: 'Veo 2',
|
||||
createdAt: '2026-01-01T00:00:00.000Z',
|
||||
},
|
||||
]
|
||||
|
||||
const providerKeys = {
|
||||
klingai: { apiKey: 'mock-kling-key' },
|
||||
fal: { apiKey: 'mock-fal-key' },
|
||||
google: { apiKey: 'mock-google-key' },
|
||||
}
|
||||
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
|
||||
beforeEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
|
||||
vi.spyOn(fs, 'mkdirSync').mockImplementation(() => undefined)
|
||||
vi.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
})
|
||||
|
||||
it('creates tool with correct metadata and provider-prefixed model schema', () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
expect(tool.name).toBe('generate_video')
|
||||
expect(tool.label).toBe('Generate Video')
|
||||
expect(tool.description).toContain('Generate a video')
|
||||
const modelDesc = (tool.parameters as { properties: { model: { description: string } } })
|
||||
.properties.model.description
|
||||
expect(modelDesc).toContain('klingai:kling-v1-standard')
|
||||
expect(modelDesc).toContain('fal:kling-v1-standard')
|
||||
})
|
||||
|
||||
it('generates text_to_video successfully', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const mockBuffer = Buffer.from('fake-mp4-video-stream')
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateVideo').mockResolvedValue({
|
||||
buffer: mockBuffer,
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
const writeSpy = vi.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
|
||||
const result = await tool.execute(
|
||||
'call-vid-1',
|
||||
{
|
||||
mode: 'text_to_video',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: 'test_nature.mp4',
|
||||
textToVideoConfig: {
|
||||
prompt: 'A gentle waterfall in a lush forest with cinematic lighting',
|
||||
},
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: '16:9',
|
||||
resolution: null,
|
||||
duration: 5,
|
||||
fps: 24,
|
||||
generateAudio: null,
|
||||
seed: 123,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'klingai',
|
||||
modelId: 'kling-v1-standard',
|
||||
apiKey: 'mock-kling-key',
|
||||
mode: 'text_to_video',
|
||||
prompt: 'A gentle waterfall in a lush forest with cinematic lighting',
|
||||
aspectRatio: '16:9',
|
||||
duration: 5,
|
||||
fps: 24,
|
||||
seed: 123,
|
||||
}),
|
||||
)
|
||||
|
||||
const expectedPath = path.join(piDir, 'test_nature.mp4')
|
||||
expect(writeSpy).toHaveBeenCalledWith(expectedPath, mockBuffer)
|
||||
|
||||
const textContent = result.content[0]
|
||||
expect(textContent.type).toBe('text')
|
||||
if (textContent.type === 'text') {
|
||||
expect(textContent.text).toContain('Successfully generated video')
|
||||
expect(textContent.text).toContain('.pi/test_nature.mp4')
|
||||
}
|
||||
expect(result.details).toMatchObject({
|
||||
fileName: 'test_nature.mp4',
|
||||
provider: 'klingai',
|
||||
model: 'kling-v1-standard',
|
||||
mode: 'text_to_video',
|
||||
})
|
||||
})
|
||||
|
||||
it('disambiguates identical model IDs across different providers', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateVideo').mockResolvedValue({
|
||||
buffer: Buffer.from('video-bytes'),
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
|
||||
// Select fal:kling-v1-standard
|
||||
await tool.execute(
|
||||
'call-fal',
|
||||
{
|
||||
mode: 'text_to_video',
|
||||
model: 'fal:kling-v1-standard',
|
||||
outputFileName: null,
|
||||
textToVideoConfig: { prompt: 'A soaring eagle' },
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenLastCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'fal',
|
||||
modelId: 'kling-v1-standard',
|
||||
apiKey: 'mock-fal-key',
|
||||
}),
|
||||
)
|
||||
|
||||
// Select klingai:kling-v1-standard
|
||||
await tool.execute(
|
||||
'call-klingai',
|
||||
{
|
||||
mode: 'text_to_video',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: null,
|
||||
textToVideoConfig: { prompt: 'A roaring tiger' },
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenLastCalledWith(
|
||||
expect.objectContaining({
|
||||
provider: 'klingai',
|
||||
modelId: 'kling-v1-standard',
|
||||
apiKey: 'mock-kling-key',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('generates image_to_video using resolveS3MediaBuffer', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateVideo').mockResolvedValue({
|
||||
buffer: Buffer.from('video-bytes'),
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
|
||||
const resolverSpy = vi.spyOn(downloadAsset, 'resolveS3MediaBuffer').mockResolvedValue({
|
||||
buffer: Buffer.from('resolved-image-data'),
|
||||
mimeType: 'image/png',
|
||||
})
|
||||
|
||||
await tool.execute(
|
||||
'call-vid-2',
|
||||
{
|
||||
mode: 'image_to_video',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: 'animate_cat.mp4',
|
||||
textToVideoConfig: null,
|
||||
imageToVideoConfig: {
|
||||
image: 'files/ast-1/img.png',
|
||||
prompt: 'Cat starts blinking and looks to the side',
|
||||
},
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(resolverSpy).toHaveBeenCalledWith('files/ast-1/img.png', 'user-1')
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
mode: 'image_to_video',
|
||||
image: Buffer.from('resolved-image-data'),
|
||||
prompt: 'Cat starts blinking and looks to the side',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('generates first_last_frame using resolveS3MediaBuffer', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateVideo').mockResolvedValue({
|
||||
buffer: Buffer.from('transition-video'),
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
|
||||
vi.spyOn(downloadAsset, 'resolveS3MediaBuffer').mockImplementation(async (key: string) => ({
|
||||
buffer: Buffer.from(`frame-data-${key}`),
|
||||
mimeType: 'image/png',
|
||||
}))
|
||||
|
||||
await tool.execute(
|
||||
'call-vid-3',
|
||||
{
|
||||
mode: 'first_last_frame',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: 'transition.mp4',
|
||||
textToVideoConfig: null,
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: {
|
||||
firstFrame: 'files/ast-1/start.png',
|
||||
lastFrame: 'files/ast-2/end.png',
|
||||
prompt: 'Smooth morph from sunrise to night',
|
||||
},
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
mode: 'first_last_frame',
|
||||
firstFrame: Buffer.from('frame-data-files/ast-1/start.png'),
|
||||
lastFrame: Buffer.from('frame-data-files/ast-2/end.png'),
|
||||
prompt: 'Smooth morph from sunrise to night',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('generates reference_to_video using resolveS3MediaBuffer', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, providerKeys, 'user-1')
|
||||
|
||||
const generateSpy = vi.spyOn(mediaGenerationService, 'generateVideo').mockResolvedValue({
|
||||
buffer: Buffer.from('ref-video'),
|
||||
mimeType: 'video/mp4',
|
||||
})
|
||||
|
||||
vi.spyOn(downloadAsset, 'resolveS3MediaBuffer').mockImplementation(async (key: string) => ({
|
||||
buffer: Buffer.from(`ref-data-${key}`),
|
||||
mimeType: 'image/png',
|
||||
}))
|
||||
|
||||
await tool.execute(
|
||||
'call-vid-4',
|
||||
{
|
||||
mode: 'reference_to_video',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: 'reference_output.mp4',
|
||||
textToVideoConfig: null,
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: {
|
||||
references: ['files/ast-1/ref1.png', 'files/ast-2/ref2.png'],
|
||||
prompt: 'Generate an anime dance following these characters',
|
||||
},
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
)
|
||||
|
||||
expect(generateSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
mode: 'reference_to_video',
|
||||
inputReferences: [
|
||||
Buffer.from('ref-data-files/ast-1/ref1.png'),
|
||||
Buffer.from('ref-data-files/ast-2/ref2.png'),
|
||||
],
|
||||
prompt: 'Generate an anime dance following these characters',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('fails gracefully when API key is missing', async () => {
|
||||
const tool = createGenerateVideoTool(enabledModels, {}, 'user-1')
|
||||
|
||||
await expect(
|
||||
tool.execute(
|
||||
'call-vid-5',
|
||||
{
|
||||
mode: 'text_to_video',
|
||||
model: 'klingai:kling-v1-standard',
|
||||
outputFileName: null,
|
||||
textToVideoConfig: { prompt: 'A simple video' },
|
||||
imageToVideoConfig: null,
|
||||
firstLastFrameConfig: null,
|
||||
referenceToVideoConfig: null,
|
||||
aspectRatio: null,
|
||||
resolution: null,
|
||||
duration: null,
|
||||
fps: null,
|
||||
generateAudio: null,
|
||||
seed: null,
|
||||
},
|
||||
new AbortController().signal,
|
||||
),
|
||||
).rejects.toThrow('API key for provider "klingai" is not configured')
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,302 @@
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { EnabledMediaModel } from '@shumai/dtos'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
|
||||
import { Type, type Static, type TSchema } from 'typebox'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import { ulid } from 'ulid'
|
||||
import { resolveS3MediaBuffer } from './download-asset'
|
||||
|
||||
export function createGenerateVideoTool(
|
||||
enabledModels: EnabledMediaModel[],
|
||||
providerKeys: Record<string, { apiKey?: string }>,
|
||||
userId?: string,
|
||||
): AgentTool {
|
||||
const modelIdentifiers = enabledModels.map((m) => `${m.provider}:${m.modelId}`)
|
||||
const modelSchemas =
|
||||
modelIdentifiers.length === 1
|
||||
? Type.Literal(modelIdentifiers[0])
|
||||
: Type.Union(
|
||||
modelIdentifiers.map((id) => Type.Literal(id)) as unknown as [
|
||||
TSchema,
|
||||
TSchema,
|
||||
...TSchema[],
|
||||
],
|
||||
)
|
||||
|
||||
const generateVideoSchema = Type.Object(
|
||||
{
|
||||
mode: Type.Union(
|
||||
[
|
||||
Type.Literal('text_to_video'),
|
||||
Type.Literal('image_to_video'),
|
||||
Type.Literal('first_last_frame'),
|
||||
Type.Literal('reference_to_video'),
|
||||
],
|
||||
{
|
||||
description:
|
||||
'The video generation mode: "text_to_video", "image_to_video", "first_last_frame", or "reference_to_video".',
|
||||
},
|
||||
),
|
||||
model: Type.Union([modelSchemas, Type.Null()], {
|
||||
description: `The video model to use, in "provider:modelId" format. Available enabled models: ${modelIdentifiers.join(', ')}. Pass null to use the first enabled model (${modelIdentifiers[0]}).`,
|
||||
}),
|
||||
outputFileName: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional desired filename for the generated video (e.g. "intro.mp4"). Set to null for auto-generated name.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
textToVideoConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
prompt: Type.String({
|
||||
description: 'Text prompt describing the desired video scene, action, and motion.',
|
||||
}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
imageToVideoConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
image: Type.String({
|
||||
description:
|
||||
'Storage S3 key of the image to animate. Call read_asset with s3KeyOnly: true to obtain the S3 key of an image asset or video frame without loading its content into context.',
|
||||
}),
|
||||
prompt: Type.Union([
|
||||
Type.String({
|
||||
description: 'Optional motion prompt describing how the image should animate.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
firstLastFrameConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
firstFrame: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Storage S3 key of the starting frame image. Call read_asset with s3KeyOnly: true to obtain the S3 key.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
lastFrame: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Storage S3 key of the ending frame image. Call read_asset with s3KeyOnly: true to obtain the S3 key.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
prompt: Type.Union([
|
||||
Type.String({ description: 'Optional prompt describing the transition.' }),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
referenceToVideoConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
references: Type.Array(Type.String(), {
|
||||
description:
|
||||
'List of storage S3 keys for style/motion/character reference images. Call read_asset with s3KeyOnly: true to obtain the S3 keys.',
|
||||
}),
|
||||
prompt: Type.Union([
|
||||
Type.String({ description: 'Prompt describing the video to generate.' }),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
aspectRatio: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'Optional aspect ratio: "16:9", "9:16", "1:1", or "adaptive", or null for default.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
resolution: Type.Union([
|
||||
Type.String({
|
||||
description: 'Optional target video resolution, e.g. "1280x720", or null for default.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
duration: Type.Union([
|
||||
Type.Integer({ description: 'Optional duration in seconds, or null for default.' }),
|
||||
Type.Null(),
|
||||
]),
|
||||
fps: Type.Union([
|
||||
Type.Integer({ description: 'Optional frames per second, or null for default.' }),
|
||||
Type.Null(),
|
||||
]),
|
||||
generateAudio: Type.Union([
|
||||
Type.Boolean({
|
||||
description: 'Whether to generate audio alongside video, or null for default.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
seed: Type.Union([
|
||||
Type.Integer({
|
||||
description:
|
||||
'Optional random seed for reproducible video generation, or null for random.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
type GenerateVideoParams = Static<typeof generateVideoSchema>
|
||||
|
||||
return {
|
||||
name: 'generate_video',
|
||||
label: 'Generate Video',
|
||||
description:
|
||||
'Generate a video using a configured video model. Supports text-to-video, image-to-video (using an S3 image key from read_asset), first/last frame (using S3 image keys from read_asset), and reference-to-video (using S3 image keys from read_asset). The generated file is saved in the local .pi/ directory.',
|
||||
parameters: generateVideoSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const p = params as GenerateVideoParams
|
||||
|
||||
const defaultModel = `${enabledModels[0].provider}:${enabledModels[0].modelId}`
|
||||
const selected = p.model || defaultModel
|
||||
const modelConfig =
|
||||
enabledModels.find((m) => `${m.provider}:${m.modelId}` === selected) ||
|
||||
enabledModels.find((m) => m.modelId === selected)
|
||||
|
||||
if (!modelConfig) {
|
||||
throw new Error(
|
||||
`Video model "${selected}" is not enabled. Available enabled models: ${modelIdentifiers.join(', ')}`,
|
||||
)
|
||||
}
|
||||
|
||||
const customKey = providerKeys[modelConfig.provider]?.apiKey
|
||||
const apiKey = mediaGenerationService.resolveApiKey(modelConfig.provider, customKey)
|
||||
if (!apiKey) {
|
||||
throw new Error(
|
||||
`API key for provider "${modelConfig.provider}" is not configured. Please configure it in settings.`,
|
||||
)
|
||||
}
|
||||
|
||||
let promptText = ''
|
||||
let resolvedImage: Buffer | undefined
|
||||
let resolvedFirstFrame: Buffer | undefined
|
||||
let resolvedLastFrame: Buffer | undefined
|
||||
let resolvedReferences: Buffer[] | undefined
|
||||
|
||||
if (p.mode === 'text_to_video') {
|
||||
if (!p.textToVideoConfig?.prompt) {
|
||||
throw new Error('textToVideoConfig.prompt is required when mode is "text_to_video"')
|
||||
}
|
||||
promptText = p.textToVideoConfig.prompt
|
||||
} else if (p.mode === 'image_to_video') {
|
||||
if (!p.imageToVideoConfig?.image) {
|
||||
throw new Error('imageToVideoConfig.image is required when mode is "image_to_video"')
|
||||
}
|
||||
const { buffer } = await resolveS3MediaBuffer(p.imageToVideoConfig.image, userId || '')
|
||||
resolvedImage = buffer
|
||||
promptText = p.imageToVideoConfig.prompt || ''
|
||||
} else if (p.mode === 'first_last_frame') {
|
||||
if (!p.firstLastFrameConfig?.firstFrame && !p.firstLastFrameConfig?.lastFrame) {
|
||||
throw new Error(
|
||||
'At least one of firstFrame or lastFrame is required in firstLastFrameConfig',
|
||||
)
|
||||
}
|
||||
if (p.firstLastFrameConfig.firstFrame) {
|
||||
const { buffer } = await resolveS3MediaBuffer(
|
||||
p.firstLastFrameConfig.firstFrame,
|
||||
userId || '',
|
||||
)
|
||||
resolvedFirstFrame = buffer
|
||||
}
|
||||
if (p.firstLastFrameConfig.lastFrame) {
|
||||
const { buffer } = await resolveS3MediaBuffer(
|
||||
p.firstLastFrameConfig.lastFrame,
|
||||
userId || '',
|
||||
)
|
||||
resolvedLastFrame = buffer
|
||||
}
|
||||
promptText = p.firstLastFrameConfig.prompt || ''
|
||||
} else if (p.mode === 'reference_to_video') {
|
||||
if (
|
||||
!p.referenceToVideoConfig?.references ||
|
||||
p.referenceToVideoConfig.references.length === 0
|
||||
) {
|
||||
throw new Error('referenceToVideoConfig.references list is required')
|
||||
}
|
||||
resolvedReferences = await Promise.all(
|
||||
p.referenceToVideoConfig.references.map(async (ref: string) => {
|
||||
const { buffer } = await resolveS3MediaBuffer(ref, userId || '')
|
||||
return buffer
|
||||
}),
|
||||
)
|
||||
promptText = p.referenceToVideoConfig.prompt || ''
|
||||
}
|
||||
|
||||
const { buffer, mimeType } = await mediaGenerationService.generateVideo({
|
||||
provider: modelConfig.provider,
|
||||
modelId: modelConfig.modelId,
|
||||
apiKey,
|
||||
mode: p.mode,
|
||||
prompt: promptText,
|
||||
image: resolvedImage,
|
||||
firstFrame: resolvedFirstFrame,
|
||||
lastFrame: resolvedLastFrame,
|
||||
inputReferences: resolvedReferences,
|
||||
aspectRatio: (p.aspectRatio as `${number}:${number}` | 'adaptive') || undefined,
|
||||
resolution: (p.resolution as `${number}x${number}`) || undefined,
|
||||
duration: p.duration !== null && p.duration !== undefined ? p.duration : undefined,
|
||||
fps: p.fps !== null && p.fps !== undefined ? p.fps : undefined,
|
||||
generateAudio: p.generateAudio !== null ? p.generateAudio : undefined,
|
||||
seed: p.seed !== null && p.seed !== undefined ? p.seed : undefined,
|
||||
})
|
||||
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
if (!fs.existsSync(piDir)) {
|
||||
fs.mkdirSync(piDir, { recursive: true })
|
||||
}
|
||||
|
||||
let filename: string
|
||||
if (p.outputFileName) {
|
||||
const safe = sanitizeFilename(p.outputFileName)
|
||||
filename = safe.endsWith('.mp4') ? safe : `${safe}.mp4`
|
||||
} else {
|
||||
filename = `generated_video_${ulid()}.mp4`
|
||||
}
|
||||
|
||||
const targetPath = path.join(piDir, filename)
|
||||
const relativePath = path.join('.pi', filename)
|
||||
fs.writeFileSync(targetPath, buffer)
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Successfully generated video using model "${modelConfig.modelId}" (${modelConfig.provider}) in mode "${p.mode}". Saved to "${relativePath}". Size: ${(buffer.length / (1024 * 1024)).toFixed(2)} MB.`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
fileName: filename,
|
||||
filePath: relativePath,
|
||||
absolutePath: targetPath,
|
||||
size: buffer.length,
|
||||
mimeType,
|
||||
provider: modelConfig.provider,
|
||||
model: modelConfig.modelId,
|
||||
mode: p.mode,
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createListAssetsTool } from './list-assets'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
listChildren: vi.fn().mockResolvedValue({
|
||||
data: [
|
||||
{ id: '01M2FILE2', name: 'file2.txt', type: 'file', sizeByte: 200 },
|
||||
{ id: '01M1FILE1', name: 'file1.txt', type: 'file', sizeByte: 100 },
|
||||
],
|
||||
pageInfo: { hasNextPage: false, hasPreviousPage: false, cursor: 'abc' },
|
||||
}),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createListAssetsTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('checks read permissions and invokes assetService.listChildren with default all and id desc ordering', async () => {
|
||||
const tool = createListAssetsTool('user-1')
|
||||
const result = await tool.execute('call-1', { parent: 'folder-1' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'read',
|
||||
type: 'asset',
|
||||
id: 'folder-1',
|
||||
})
|
||||
|
||||
expect(assetService.listChildren).toHaveBeenCalledWith({
|
||||
assetId: 'folder-1',
|
||||
assetType: 'all',
|
||||
sort: 'createdAt',
|
||||
order: 'desc',
|
||||
first: 20,
|
||||
after: undefined,
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
assets: [
|
||||
{ id: '01M2FILE2', name: 'file2.txt', type: 'file', size: 200 },
|
||||
{ id: '01M1FILE1', name: 'file1.txt', type: 'file', size: 100 },
|
||||
],
|
||||
pageInfo: { hasNextPage: false, hasPreviousPage: false, cursor: 'abc' },
|
||||
})
|
||||
})
|
||||
|
||||
it('passes explicit pagination and type filter options to assetService.listChildren', async () => {
|
||||
const tool = createListAssetsTool('user-1')
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
page: 2,
|
||||
pageSize: 10,
|
||||
type: 'folder',
|
||||
})
|
||||
|
||||
expect(assetService.listChildren).toHaveBeenCalledWith({
|
||||
assetId: 'folder-1',
|
||||
assetType: 'folder',
|
||||
sort: 'createdAt',
|
||||
order: 'desc',
|
||||
first: 10,
|
||||
after: expect.any(String),
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,6 +1,9 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { encodeCursor } from '@shumai/core/src/pagination'
|
||||
import { type User } from '@shumai/db'
|
||||
|
||||
const listAssetsSchema = Type.Object({
|
||||
parent: Type.String({
|
||||
@@ -19,9 +22,8 @@ const listAssetsSchema = Type.Object({
|
||||
}),
|
||||
),
|
||||
type: Type.Optional(
|
||||
Type.String({
|
||||
Type.Union([Type.Literal('file'), Type.Literal('folder'), Type.Literal('all')], {
|
||||
description: "Filter assets by type: 'file', 'folder', or 'all'. Default is 'all'.",
|
||||
enum: ['file', 'folder', 'all'],
|
||||
default: 'all',
|
||||
}),
|
||||
),
|
||||
@@ -34,15 +36,41 @@ export function createListAssetsTool(userId: string): AgentTool<typeof listAsset
|
||||
description: 'List the assets (files and folders) inside a parent folder with pagination.',
|
||||
parameters: listAssetsSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'list_assets',
|
||||
args: params,
|
||||
userId,
|
||||
assetId: params.parent,
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: params.parent,
|
||||
})
|
||||
|
||||
const page = params.page || 1
|
||||
const pageSize = params.pageSize || 20
|
||||
const type = params.type || 'all'
|
||||
|
||||
const result = await assetService.listChildren({
|
||||
assetId: params.parent,
|
||||
assetType: type,
|
||||
sort: 'createdAt',
|
||||
order: 'desc',
|
||||
first: pageSize,
|
||||
after: page > 1 ? encodeCursor((page - 1) * pageSize) : undefined,
|
||||
})
|
||||
|
||||
const assets = result.data.map((a) => ({
|
||||
id: a.id,
|
||||
name: a.name,
|
||||
type: a.type,
|
||||
size: Number(a.sizeByte),
|
||||
}))
|
||||
|
||||
const output = {
|
||||
assets,
|
||||
pageInfo: result.pageInfo,
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: result,
|
||||
content: [{ type: 'text', text: JSON.stringify(output, null, 2) }],
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createMoveAssetsTool } from './move-assets'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
reparentAssets: vi.fn().mockResolvedValue(undefined),
|
||||
getAssetContext: vi.fn().mockResolvedValue({
|
||||
teamId: 'team-1',
|
||||
projectId: 'proj-1',
|
||||
}),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createMoveAssetsTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('checks permissions on destination and all assets, and calls reparentAssets', async () => {
|
||||
const tool = createMoveAssetsTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetIds: ['asset-1', 'asset-2'],
|
||||
newParentId: 'folder-dest',
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'folder-dest',
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'asset-2',
|
||||
})
|
||||
|
||||
expect(assetService.reparentAssets).toHaveBeenCalledWith({
|
||||
assetIds: ['asset-1', 'asset-2'],
|
||||
newParentId: 'folder-dest',
|
||||
creatorId: 'user-1',
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
success: true,
|
||||
movedAssetIds: ['asset-1', 'asset-2'],
|
||||
newParentId: 'folder-dest',
|
||||
})
|
||||
})
|
||||
|
||||
it('logs asset_reparent for each asset when agentContext is provided', async () => {
|
||||
const tool = createMoveAssetsTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', {
|
||||
assetIds: ['asset-1', 'asset-2'],
|
||||
newParentId: 'folder-dest',
|
||||
})
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledTimes(2)
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.asset_reparent,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'asset-1',
|
||||
})
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.asset_reparent,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'asset-2',
|
||||
})
|
||||
})
|
||||
|
||||
it('fails when permission check on target folder fails', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockRejectedValueOnce(
|
||||
new Error('Access denied to destination'),
|
||||
)
|
||||
const tool = createMoveAssetsTool('user-1')
|
||||
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetIds: ['asset-1'],
|
||||
newParentId: 'folder-dest',
|
||||
}),
|
||||
).rejects.toThrow('Access denied to destination')
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,84 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
const moveAssetsSchema = Type.Object({
|
||||
assetIds: Type.Array(Type.String(), {
|
||||
description:
|
||||
'The IDs of the assets to move. All assets must belong to the same parent folder. At least one asset ID is required.',
|
||||
minItems: 1,
|
||||
}),
|
||||
newParentId: Type.String({
|
||||
description:
|
||||
'The destination parent folder ID to move the assets into. This parameter is required.',
|
||||
}),
|
||||
})
|
||||
|
||||
export function createMoveAssetsTool(
|
||||
userId: string,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool<typeof moveAssetsSchema> {
|
||||
return {
|
||||
name: 'move_assets',
|
||||
label: 'Move Assets',
|
||||
description:
|
||||
'Move one or more assets (files or folders) to a specified parent folder. Note: All assets to be moved must belong to the same current parent folder.',
|
||||
parameters: moveAssetsSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
// Check Edit permission on destination folder
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: params.newParentId,
|
||||
})
|
||||
|
||||
// Check Edit permission on all source assets
|
||||
for (const assetId of params.assetIds) {
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
}
|
||||
|
||||
await assetService.reparentAssets({
|
||||
assetIds: params.assetIds,
|
||||
newParentId: params.newParentId,
|
||||
creatorId: userId,
|
||||
})
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
const ctx = await assetService
|
||||
.getAssetContext(params.newParentId)
|
||||
.catch(() => ({ teamId: agentContext.teamId!, projectId: undefined }))
|
||||
for (const assetId of params.assetIds) {
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.asset_reparent,
|
||||
teamId: agentContext.teamId || ctx.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: ctx.projectId,
|
||||
itemId: assetId,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const result = {
|
||||
success: true,
|
||||
movedAssetIds: params.assetIds,
|
||||
newParentId: params.newParentId,
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,644 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createReadAssetTool } from './read-asset'
|
||||
import {
|
||||
prisma,
|
||||
WorkflowTaskType,
|
||||
WorkflowTaskStatus,
|
||||
type Asset,
|
||||
type WorkflowTask,
|
||||
} from '@shumai/db'
|
||||
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'
|
||||
|
||||
vi.mock('@shumai/db', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@shumai/db')>()
|
||||
return {
|
||||
...actual,
|
||||
prisma: {
|
||||
asset: {
|
||||
findUnique: vi.fn(),
|
||||
findFirst: vi.fn(),
|
||||
},
|
||||
workflowTask: {
|
||||
create: vi.fn(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
getObject: vi.fn(),
|
||||
presign: vi.fn().mockResolvedValue('https://mock-presigned-url.com'),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/workflow-core', () => ({
|
||||
workflowService: {
|
||||
executeWait: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn(),
|
||||
},
|
||||
Permission: { Read: 'Read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
describe('readAssetTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
vi.spyOn(annotationResolver, 'resolveAnnotationsById').mockResolvedValue({
|
||||
annotations: null,
|
||||
timestamp: null,
|
||||
})
|
||||
})
|
||||
|
||||
it('should throw authorization error if user ID is empty', async () => {
|
||||
const tool = createReadAssetTool('')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'asset-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('User ID is required for authorization.')
|
||||
})
|
||||
|
||||
it('should throw error if asset not found', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'asset-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Asset with ID asset-1 not found.')
|
||||
})
|
||||
|
||||
describe('Image Assets', () => {
|
||||
it('should read image and return ImageContent and S3 key', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'img-1',
|
||||
name: 'photo.png',
|
||||
mediaType: 'image/png',
|
||||
storageKey: { key: 'raw/photo.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/photo.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('fake-image-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'img-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'img-1',
|
||||
})
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'proxy/photo.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('proxy/photo.webp')
|
||||
expect(imageItem.type).toBe('image')
|
||||
expect(imageItem.data).toBe(Buffer.from('fake-image-bytes').toString('base64'))
|
||||
expect(result.details.key).toBe('proxy/photo.webp')
|
||||
})
|
||||
|
||||
it('should trigger image annotation transcode workflow when annotationId is provided', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'img-1',
|
||||
name: 'photo.png',
|
||||
mediaType: 'image/png',
|
||||
projectId: 'project-1',
|
||||
storageKey: { key: 'raw/photo.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/photo.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.spyOn(annotationResolver, 'resolveAnnotationsById').mockResolvedValue({
|
||||
annotations: [
|
||||
{
|
||||
type: 'arrow',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
timestamp: null,
|
||||
})
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-anno',
|
||||
} as unknown as WorkflowTask)
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-anno',
|
||||
output: { key: 'annotated/photo.webp' },
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('annotated-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'img-1',
|
||||
annotationId: 'comment-1',
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
assetId: 'img-1',
|
||||
projectId: 'project-1',
|
||||
type: WorkflowTaskType.transcode_image_annotation,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: 'project-1',
|
||||
imageAnnotation: {
|
||||
annotations: [
|
||||
{
|
||||
type: 'arrow',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[10, 10],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'annotated/photo.webp')
|
||||
expect(result.details.key).toBe('annotated/photo.webp')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Video Assets', () => {
|
||||
it('should throw error if videoConfig is missing for video assets', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'vid-1',
|
||||
name: 'video.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
media: { proxyType: 'video' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'vid-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('videoConfig with start, end, and count is required')
|
||||
})
|
||||
|
||||
it('should throw error on invalid video time range', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'vid-1',
|
||||
name: 'video.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
media: { proxyType: 'video' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'vid-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: { start: 10, end: 5, count: 1 },
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
'Invalid video time range: start (10) must be less than or equal to end (5).',
|
||||
)
|
||||
})
|
||||
|
||||
it('should extract frames and return ImageContent array and keys', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'vid-1',
|
||||
name: 'video.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
projectId: 'project-1',
|
||||
media: { proxyType: 'video' },
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-shot',
|
||||
} as unknown as WorkflowTask)
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-shot',
|
||||
output: {
|
||||
screenshots: [
|
||||
{ key: 'screenshots/shot1.webp', timestamp: 2.0 },
|
||||
{ key: 'screenshots/shot2.webp', timestamp: 4.0 },
|
||||
],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockImplementation(async (_bucket, key) => ({
|
||||
buffer: Buffer.from(`bytes-for-${key}`),
|
||||
contentType: 'image/webp',
|
||||
}))
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'vid-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: { start: 2.0, end: 4.0, count: 2 },
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
assetId: 'vid-1',
|
||||
projectId: 'project-1',
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: 'project-1',
|
||||
screenshot: {
|
||||
start: 2.0,
|
||||
end: 4.0,
|
||||
count: 2,
|
||||
commentTimestamp: null,
|
||||
annotations: null,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(result.content.length).toBe(3) // 1 text + 2 images
|
||||
expect(result.details.keys).toEqual(['screenshots/shot1.webp', 'screenshots/shot2.webp'])
|
||||
})
|
||||
})
|
||||
|
||||
describe('Document Assets', () => {
|
||||
it('should throw error if docConfig is missing for document assets', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'doc.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('docConfig with mode ("pages" or "text") is required')
|
||||
})
|
||||
|
||||
it('should render PDF pages in mode: "pages"', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'doc.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
projectId: 'project-1',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-pdf',
|
||||
} as unknown as WorkflowTask)
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-pdf',
|
||||
output: {
|
||||
pages: [
|
||||
{ key: 'pdf_pages/page1.webp', page: 1 },
|
||||
{ key: 'pdf_pages/page2.webp', page: 2 },
|
||||
],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockImplementation(async (_bucket, key) => ({
|
||||
buffer: Buffer.from(`bytes-for-${key}`),
|
||||
contentType: 'image/webp',
|
||||
}))
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'pages', startPage: 1, endPage: 2 },
|
||||
})
|
||||
|
||||
expect(result.content.length).toBe(3) // 1 text + 2 images
|
||||
expect(result.details.keys).toEqual(['pdf_pages/page1.webp', 'pdf_pages/page2.webp'])
|
||||
})
|
||||
|
||||
it('should throw error in mode: "pages" when page range exceeds 20 pages', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'doc.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'pages', startPage: 1, endPage: 25 },
|
||||
}),
|
||||
).rejects.toThrow('exceeds the maximum limit of 20 pages')
|
||||
})
|
||||
|
||||
it('should throw error in mode: "text" when called on binary PDF', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'manual.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'text', startPage: null, endPage: null },
|
||||
}),
|
||||
).rejects.toThrow('is a binary PDF/document and cannot be read as raw text')
|
||||
})
|
||||
|
||||
it('should throw error in mode: "text" when annotationId is provided', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'notes.md',
|
||||
mediaType: 'text/markdown',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: 'comment-123',
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'text', startPage: null, endPage: null },
|
||||
}),
|
||||
).rejects.toThrow('annotationId cannot be used with docConfig mode "text"')
|
||||
})
|
||||
|
||||
it('should throw error in mode: "text" when startPage or endPage is non-null', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-1',
|
||||
name: 'notes.md',
|
||||
mediaType: 'text/markdown',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'doc-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'text', startPage: 1, endPage: 2 },
|
||||
}),
|
||||
).rejects.toThrow('startPage and endPage must be null when docConfig mode is "text"')
|
||||
})
|
||||
|
||||
it('should read raw text from S3 in mode: "text" for markdown files', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-md',
|
||||
name: 'README.md',
|
||||
mediaType: 'text/markdown',
|
||||
storageKey: { key: 'raw/README.md' },
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('# Hello Shumai\nThis is markdown text.'),
|
||||
contentType: 'text/markdown',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'doc-md',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'text', startPage: null, endPage: null },
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).toHaveBeenCalledWith('shumai', 'raw/README.md')
|
||||
expect(result.content[0].type).toBe('text')
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toContain(
|
||||
'# Hello Shumai\nThis is markdown text.',
|
||||
)
|
||||
expect(result.details.key).toBe('raw/README.md')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Version Stack Resolution', () => {
|
||||
it('should resolve version_stack to latest version asset', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'stack-1',
|
||||
name: '',
|
||||
type: 'version_stack',
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.asset.findFirst).mockResolvedValue({
|
||||
id: 'file-v2',
|
||||
name: 'diagram_v2.png',
|
||||
type: 'file',
|
||||
mediaType: 'image/png',
|
||||
storageKey: { key: 'raw/diagram_v2.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/diagram_v2.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockResolvedValue({
|
||||
buffer: Buffer.from('v2-image-bytes'),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string })
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'stack-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(prisma.asset.findFirst).toHaveBeenCalledWith({
|
||||
where: { parentId: 'stack-1', isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
expect(result.details.name).toBe('diagram_v2.png')
|
||||
expect(result.details.key).toBe('proxy/diagram_v2.webp')
|
||||
})
|
||||
})
|
||||
|
||||
describe('s3KeyOnly mode', () => {
|
||||
it('returns only S3 key and MIME in text for image assets without fetching S3 buffer or attaching base64 image', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'img-1',
|
||||
name: 'photo.png',
|
||||
mediaType: 'image/png',
|
||||
storageKey: { key: 'raw/photo.png' },
|
||||
media: {
|
||||
proxyType: 'image',
|
||||
imageTranscodes: [{ key: 'proxy/photo.webp' }],
|
||||
},
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'img-1',
|
||||
annotationId: null,
|
||||
s3KeyOnly: true,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).not.toHaveBeenCalled()
|
||||
expect(result.content.length).toBe(1)
|
||||
expect(result.content[0].type).toBe('text')
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toBe(
|
||||
'Image asset "photo.png" (ID: img-1, MIME: image/webp, S3 Key: "proxy/photo.webp")',
|
||||
)
|
||||
expect(result.details.key).toBe('proxy/photo.webp')
|
||||
})
|
||||
|
||||
it('returns only frame S3 keys and MIME in text for video assets without fetching S3 buffers or attaching base64 images', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'vid-1',
|
||||
name: 'clip.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
projectId: 'project-1',
|
||||
media: { proxyType: 'video' },
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-shot',
|
||||
} as unknown as WorkflowTask)
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-shot',
|
||||
output: {
|
||||
screenshots: [{ key: 'screenshots/shot1.webp', timestamp: 1.5 }],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'vid-1',
|
||||
annotationId: null,
|
||||
s3KeyOnly: true,
|
||||
imageConfig: null,
|
||||
videoConfig: { start: 1.5, end: 1.5, count: 1 },
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).not.toHaveBeenCalled()
|
||||
expect(result.content.length).toBe(1)
|
||||
expect(result.content[0].type).toBe('text')
|
||||
const text = (result.content[0] as { type: 'text'; text: string }).text
|
||||
expect(text).toContain('- Frame at 1.5s (S3 Key: "screenshots/shot1.webp", MIME: image/webp)')
|
||||
expect(result.details.keys).toEqual(['screenshots/shot1.webp'])
|
||||
})
|
||||
|
||||
it('returns only document S3 key and MIME in text for text mode without fetching S3 buffer', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'doc-md',
|
||||
name: 'notes.md',
|
||||
mediaType: 'text/markdown',
|
||||
storageKey: { key: 'raw/notes.md' },
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'doc-md',
|
||||
annotationId: null,
|
||||
s3KeyOnly: true,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: { mode: 'text', startPage: null, endPage: null },
|
||||
})
|
||||
|
||||
expect(s3Service.getObject).not.toHaveBeenCalled()
|
||||
expect(result.content.length).toBe(1)
|
||||
expect(result.content[0].type).toBe('text')
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toBe(
|
||||
'Document "notes.md" (ID: doc-md, MIME: text/markdown, S3 Key: "raw/notes.md")',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,638 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { type ImageContent, type TextContent } from '@earendil-works/pi-ai'
|
||||
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
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'
|
||||
|
||||
export const readAssetSchema = Type.Object(
|
||||
{
|
||||
assetId: Type.String({
|
||||
description: 'The asset ID of the workspace asset to inspect. Required.',
|
||||
}),
|
||||
annotationId: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'The ID of the comment or message entry from <annotation id="..." /> whose visual markup should be overlaid, or null.',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
s3KeyOnly: Type.Optional(
|
||||
Type.Boolean({
|
||||
description:
|
||||
'When true, returns only the storage S3 key(s) and MIME types of the asset/frames without attaching base64 image or text content to the agent context. Use this to obtain S3 keys for generate_image or generate_video references without consuming context tokens.',
|
||||
default: false,
|
||||
}),
|
||||
),
|
||||
imageConfig: Type.Union([
|
||||
Type.Object(
|
||||
{},
|
||||
{
|
||||
additionalProperties: false,
|
||||
description: 'Optional configuration for image assets, or null.',
|
||||
},
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
videoConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
start: Type.Number({ description: 'Start time in seconds.' }),
|
||||
end: Type.Number({ description: 'End time in seconds.' }),
|
||||
count: Type.Number({ description: 'Number of frames to extract (e.g. 1 to 10).' }),
|
||||
},
|
||||
{
|
||||
additionalProperties: false,
|
||||
description:
|
||||
'Configuration for video assets. Required when inspecting videos, or null for other asset types.',
|
||||
},
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
docConfig: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
mode: Type.Union([
|
||||
Type.Literal('pages', {
|
||||
description:
|
||||
'Render specific page range as images for visual layout, charts, or visual annotations (required for binary PDFs).',
|
||||
}),
|
||||
Type.Literal('text', {
|
||||
description:
|
||||
'Read raw text content directly (ideal for .md, .txt, .csv, code files).',
|
||||
}),
|
||||
]),
|
||||
startPage: Type.Union([
|
||||
Type.Number({
|
||||
description:
|
||||
'Start page number (1-based index, required when mode="pages"), or null when mode="text".',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
endPage: Type.Union([
|
||||
Type.Number({
|
||||
description:
|
||||
'End page number (1-based index, max 20 pages per call, required when mode="pages"), or null when mode="text".',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{
|
||||
additionalProperties: false,
|
||||
description:
|
||||
'Configuration for document/PDF/text assets, or null if inspecting another asset type.',
|
||||
},
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
export function isPlainTextAsset(mediaType: string, filename: string): boolean {
|
||||
if (
|
||||
mediaType.startsWith('text/') ||
|
||||
mediaType === 'application/json' ||
|
||||
mediaType === 'application/javascript' ||
|
||||
mediaType === 'application/typescript' ||
|
||||
mediaType === 'application/xml' ||
|
||||
mediaType === 'application/x-yaml'
|
||||
) {
|
||||
return true
|
||||
}
|
||||
const textExtensions = [
|
||||
'.txt',
|
||||
'.md',
|
||||
'.markdown',
|
||||
'.json',
|
||||
'.csv',
|
||||
'.tsv',
|
||||
'.js',
|
||||
'.ts',
|
||||
'.tsx',
|
||||
'.jsx',
|
||||
'.html',
|
||||
'.htm',
|
||||
'.css',
|
||||
'.scss',
|
||||
'.yaml',
|
||||
'.yml',
|
||||
'.xml',
|
||||
'.py',
|
||||
'.rb',
|
||||
'.go',
|
||||
'.rs',
|
||||
'.c',
|
||||
'.cpp',
|
||||
'.h',
|
||||
'.hpp',
|
||||
'.java',
|
||||
'.sh',
|
||||
'.bash',
|
||||
'.zsh',
|
||||
'.sql',
|
||||
]
|
||||
return textExtensions.some((ext) => filename.endsWith(ext))
|
||||
}
|
||||
|
||||
const MAX_TEXT_BYTES = 50 * 1024
|
||||
const MAX_TEXT_LINES = 1000
|
||||
|
||||
export function createReadAssetTool(userId: string): AgentTool<typeof readAssetSchema> {
|
||||
return {
|
||||
name: 'read_asset',
|
||||
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. ' +
|
||||
'Optionally provide annotationId to view visual markups drawn on the asset.',
|
||||
parameters: readAssetSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const { assetId, annotationId, s3KeyOnly, videoConfig, docConfig } = params
|
||||
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
|
||||
let asset = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
if (asset.type === 'version_stack') {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
include: { storageKey: true },
|
||||
})
|
||||
if (latestVersion) {
|
||||
asset = latestVersion
|
||||
}
|
||||
}
|
||||
|
||||
const mediaInfo = asset.media as unknown as PrismaJson.MediaInfo | null
|
||||
const proxyType = mediaInfo?.proxyType
|
||||
const mediaType = asset.mediaType?.toLowerCase() || ''
|
||||
const filename = asset.name?.toLowerCase() || ''
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Branch 1: Image Assets
|
||||
// ----------------------------------------------------------------------
|
||||
if (proxyType === 'image' || mediaType.startsWith('image/') || filename.endsWith('.psd')) {
|
||||
let mediaKey = asset.storageKey?.key
|
||||
if (mediaInfo?.imageTranscodes && mediaInfo.imageTranscodes.length > 0) {
|
||||
mediaKey = mediaInfo.imageTranscodes[0].key || mediaKey
|
||||
}
|
||||
|
||||
if (!mediaKey) {
|
||||
throw new Error('No media content found for this asset.')
|
||||
}
|
||||
|
||||
let keyToUse = mediaKey
|
||||
let mimeType = getFileMimeType(null, keyToUse, asset.mediaType || 'image/png')
|
||||
|
||||
if (annotationId) {
|
||||
const { annotations } = await resolveAnnotationsById(asset.id, annotationId)
|
||||
if (annotations && annotations.length > 0) {
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_image_annotation,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
imageAnnotation: {
|
||||
annotations,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- transcode image annotation task output
|
||||
const output = completedTask.output as any
|
||||
if (output?.key) {
|
||||
keyToUse = output.key
|
||||
mimeType = 'image/webp'
|
||||
} else {
|
||||
throw new Error('Image annotation transcode workflow failed to output S3 key.')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
keyToUse,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
const content: Array<TextContent | ImageContent> = []
|
||||
|
||||
if (s3KeyOnly) {
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: `Image asset "${asset.name}" (ID: ${asset.id}, MIME: ${mimeType}, S3 Key: "${keyToUse}")`,
|
||||
})
|
||||
} else {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, keyToUse)
|
||||
const actualMimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : mimeType
|
||||
content.push({
|
||||
type: 'text',
|
||||
text: `Image asset "${asset.name}" (ID: ${asset.id}, MIME: ${actualMimeType}, S3 Key: "${keyToUse}")`,
|
||||
})
|
||||
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 2: Video Assets
|
||||
// ----------------------------------------------------------------------
|
||||
if (proxyType === 'video' || mediaType.startsWith('video/')) {
|
||||
if (!videoConfig) {
|
||||
throw new Error(
|
||||
'videoConfig with start, end, and count is required when inspecting video assets.',
|
||||
)
|
||||
}
|
||||
|
||||
const { start, end, count } = videoConfig
|
||||
|
||||
if (start < 0 || end < 0) {
|
||||
throw new Error('Invalid video time range: start and end must be non-negative numbers.')
|
||||
}
|
||||
|
||||
if (start > end) {
|
||||
throw new Error(
|
||||
`Invalid video time range: start (${start}) must be less than or equal to end (${end}).`,
|
||||
)
|
||||
}
|
||||
|
||||
if (count < 1) {
|
||||
throw new Error(`Invalid frame count: count (${count}) must be at least 1.`)
|
||||
}
|
||||
|
||||
const { annotations, timestamp: commentTimestamp } = await resolveAnnotationsById(
|
||||
asset.id,
|
||||
annotationId,
|
||||
)
|
||||
|
||||
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,
|
||||
end,
|
||||
count,
|
||||
commentTimestamp,
|
||||
annotations,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
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('No screenshots were generated.')
|
||||
}
|
||||
|
||||
const content: Array<TextContent | ImageContent> = []
|
||||
const sourceKeys: string[] = []
|
||||
const results: Array<{ key: string; timestamp: number; downloadUrl: string }> = []
|
||||
const textLines: string[] = [
|
||||
`Extracted ${screenshots.length} frame(s) from "${asset.name}" (${start}s - ${end}s):`,
|
||||
]
|
||||
|
||||
for (const shot of screenshots) {
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
shot.key,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
sourceKeys.push(shot.key)
|
||||
results.push({
|
||||
key: shot.key,
|
||||
timestamp: shot.timestamp,
|
||||
downloadUrl,
|
||||
})
|
||||
|
||||
if (s3KeyOnly) {
|
||||
const mimeType = getFileMimeType(null, shot.key, 'image/webp')
|
||||
textLines.push(
|
||||
`- Frame at ${shot.timestamp}s (S3 Key: "${shot.key}", MIME: ${mimeType})`,
|
||||
)
|
||||
} else {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, shot.key)
|
||||
const mimeType =
|
||||
contentType && contentType !== 'application/octet-stream'
|
||||
? contentType
|
||||
: getFileMimeType(buffer, shot.key, 'image/webp')
|
||||
textLines.push(
|
||||
`- Frame at ${shot.timestamp}s (S3 Key: "${shot.key}", MIME: ${mimeType})`,
|
||||
)
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
content.unshift({
|
||||
type: 'text',
|
||||
text: textLines.join('\n'),
|
||||
})
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
keys: sourceKeys,
|
||||
results,
|
||||
sourceKeys,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Branch 3: Documents & PDF Assets
|
||||
// ----------------------------------------------------------------------
|
||||
if (
|
||||
proxyType === 'pdf' ||
|
||||
mediaType === 'application/pdf' ||
|
||||
isPlainTextAsset(mediaType, filename)
|
||||
) {
|
||||
if (!docConfig) {
|
||||
throw new Error(
|
||||
'docConfig with mode ("pages" or "text") is required when inspecting document/PDF assets.',
|
||||
)
|
||||
}
|
||||
|
||||
if (docConfig.mode === 'text') {
|
||||
if (annotationId !== null) {
|
||||
throw new Error(
|
||||
'annotationId cannot be used with docConfig mode "text" because visual markups can only be rendered on visual pages. Use docConfig: { mode: "pages", startPage: ..., endPage: ... } instead.',
|
||||
)
|
||||
}
|
||||
|
||||
if (docConfig.startPage !== null || docConfig.endPage !== null) {
|
||||
throw new Error(
|
||||
'startPage and endPage must be null when docConfig mode is "text". To inspect specific page numbers, use mode: "pages".',
|
||||
)
|
||||
}
|
||||
|
||||
if (!isPlainTextAsset(mediaType, filename)) {
|
||||
throw new Error(
|
||||
`Asset "${asset.name}" is a binary PDF/document and cannot be read as raw text. Please call read_asset with docConfig: { mode: "pages", startPage: 1, endPage: ... } to view its visual pages.`,
|
||||
)
|
||||
}
|
||||
|
||||
const mediaKey = asset.storageKey?.key
|
||||
if (!mediaKey) {
|
||||
throw new Error(`No media content found for asset ${asset.id}.`)
|
||||
}
|
||||
|
||||
const docMimeType =
|
||||
asset.mediaType || getFileMimeType(null, asset.name || mediaKey, 'text/plain')
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
mediaKey,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
if (s3KeyOnly) {
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Document "${asset.name}" (ID: ${asset.id}, MIME: ${docMimeType}, S3 Key: "${mediaKey}")`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
key: mediaKey,
|
||||
downloadUrl,
|
||||
sourceKeys: [mediaKey],
|
||||
size: 0,
|
||||
isTruncated: false,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
const { buffer } = await s3Service.getObject(bucket, mediaKey)
|
||||
const rawText = buffer.toString('utf-8')
|
||||
let text = rawText
|
||||
let isTruncated = false
|
||||
|
||||
const lines = text.split('\n')
|
||||
if (lines.length > MAX_TEXT_LINES) {
|
||||
text = lines.slice(0, MAX_TEXT_LINES).join('\n')
|
||||
isTruncated = true
|
||||
}
|
||||
|
||||
if (Buffer.byteLength(text, 'utf-8') > MAX_TEXT_BYTES) {
|
||||
text = Buffer.from(text, 'utf-8').subarray(0, MAX_TEXT_BYTES).toString('utf-8')
|
||||
isTruncated = true
|
||||
}
|
||||
|
||||
if (isTruncated) {
|
||||
text += `\n\n[Content truncated to ${MAX_TEXT_LINES} lines / ${MAX_TEXT_BYTES / 1024}KB limit. Use download_asset to process the full file.]`
|
||||
}
|
||||
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: `Document "${asset.name}" (ID: ${asset.id}, MIME: ${docMimeType}, S3 Key: "${mediaKey}"):\n\n${text}`,
|
||||
},
|
||||
],
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
key: mediaKey,
|
||||
downloadUrl,
|
||||
sourceKeys: [mediaKey],
|
||||
size: buffer.length,
|
||||
isTruncated,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// docConfig.mode === 'pages'
|
||||
if (docConfig.startPage === null || docConfig.endPage === null) {
|
||||
throw new Error('startPage and endPage are required when docConfig mode is "pages".')
|
||||
}
|
||||
|
||||
const start = docConfig.startPage
|
||||
const end = docConfig.endPage
|
||||
|
||||
if (start < 1) {
|
||||
throw new Error(`Invalid page range: start page (${start}) must be at least 1.`)
|
||||
}
|
||||
|
||||
if (start > end) {
|
||||
throw new Error(
|
||||
`Invalid page range: start page (${start}) must be less than or equal to end page (${end}).`,
|
||||
)
|
||||
}
|
||||
|
||||
const MAX_PAGE_RANGE = 20
|
||||
const requestedPages = end - start + 1
|
||||
if (requestedPages > MAX_PAGE_RANGE) {
|
||||
throw new Error(
|
||||
`Page range (${requestedPages} pages requested) exceeds the maximum limit of ${MAX_PAGE_RANGE} pages per request.`,
|
||||
)
|
||||
}
|
||||
|
||||
const { annotations, timestamp: commentTimestamp } = await resolveAnnotationsById(
|
||||
asset.id,
|
||||
annotationId,
|
||||
)
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId: asset.id,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_pdf_pages,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
pdfPages: {
|
||||
start,
|
||||
end,
|
||||
commentTimestamp,
|
||||
annotations,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- transcode pdf pages output
|
||||
const output = completedTask.output as any
|
||||
const pages = output?.pages as Array<{ key: string; page: number }> | undefined
|
||||
|
||||
if (!pages || pages.length === 0) {
|
||||
throw new Error('No PDF page images were generated.')
|
||||
}
|
||||
|
||||
const content: Array<TextContent | ImageContent> = []
|
||||
const sourceKeys: string[] = []
|
||||
const results: Array<{ key: string; page: number; downloadUrl: string }> = []
|
||||
const textLines: string[] = [
|
||||
`Rendered ${pages.length} page(s) of "${asset.name}" (Pages ${start} to ${end}):`,
|
||||
]
|
||||
|
||||
for (const pageItem of pages) {
|
||||
const downloadUrl = await s3Service.presign(
|
||||
bucket,
|
||||
pageItem.key,
|
||||
'GET',
|
||||
true,
|
||||
asset.name || undefined,
|
||||
)
|
||||
|
||||
sourceKeys.push(pageItem.key)
|
||||
results.push({
|
||||
key: pageItem.key,
|
||||
page: pageItem.page,
|
||||
downloadUrl,
|
||||
})
|
||||
|
||||
if (s3KeyOnly) {
|
||||
const mimeType = getFileMimeType(null, pageItem.key, 'image/webp')
|
||||
textLines.push(`- Page ${pageItem.page} (S3 Key: "${pageItem.key}", MIME: ${mimeType})`)
|
||||
} else {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, pageItem.key)
|
||||
const mimeType =
|
||||
contentType && contentType !== 'application/octet-stream'
|
||||
? contentType
|
||||
: getFileMimeType(buffer, pageItem.key, 'image/webp')
|
||||
textLines.push(`- Page ${pageItem.page} (S3 Key: "${pageItem.key}", MIME: ${mimeType})`)
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
content.unshift({
|
||||
type: 'text',
|
||||
text: textLines.join('\n'),
|
||||
})
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
assetId: asset.id,
|
||||
name: asset.name,
|
||||
mediaType: asset.mediaType,
|
||||
keys: sourceKeys,
|
||||
results,
|
||||
sourceKeys,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Unsupported asset type for read_asset. Asset ${asset.id} has media type "${mediaType || 'unknown'}". Use download_asset to download this file to disk.`,
|
||||
)
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -1,209 +0,0 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createReadPdfPagesTool } from './read-pdf-pages'
|
||||
import {
|
||||
prisma,
|
||||
WorkflowTaskStatus,
|
||||
type Asset,
|
||||
type AssetComment,
|
||||
type User,
|
||||
type WorkflowTask,
|
||||
} from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/db', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@shumai/db')>()
|
||||
return {
|
||||
...actual,
|
||||
prisma: {
|
||||
user: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
asset: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
assetComment: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
workflowTask: {
|
||||
create: vi.fn(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
getObject: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/workflow-core', () => ({
|
||||
workflowService: {
|
||||
executeWait: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn(),
|
||||
},
|
||||
Permission: { Read: 'Read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
describe('readPdfPagesTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
})
|
||||
|
||||
it('should trigger pdfPages transcode workflow and return image outputs', async () => {
|
||||
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user-1' } as User)
|
||||
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
media: { proxyType: 'pdf' },
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'comment-1',
|
||||
assetId: 'asset-1',
|
||||
second: 2,
|
||||
annotation: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
} as unknown as AssetComment)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: {
|
||||
pages: [
|
||||
{ key: 'pdf_pages/page_1.webp', page: 1 },
|
||||
{ key: 'pdf_pages/page_2.webp', page: 2 },
|
||||
],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockImplementation(async (_bucket: string, key: string) => {
|
||||
return {
|
||||
buffer: Buffer.from(`fake-bytes-for-${key}`),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string }
|
||||
})
|
||||
|
||||
const tool = createReadPdfPagesTool('user-1', 'comment-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1', start: 1, end: 2 })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
assetId: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
type: 'transcode_pdf_pages',
|
||||
status: 'pending',
|
||||
payload: {
|
||||
projectId: 'project-1',
|
||||
pdfPages: {
|
||||
start: 1,
|
||||
end: 2,
|
||||
commentTimestamp: 2,
|
||||
annotations: [
|
||||
{
|
||||
type: 'box',
|
||||
color: '#ff0000',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(result.content.length).toBe(2)
|
||||
expect(result.content[0].type).toBe('image')
|
||||
expect((result.content[0] as unknown as { data: string }).data).toBe(
|
||||
Buffer.from('fake-bytes-for-pdf_pages/page_1.webp').toString('base64'),
|
||||
)
|
||||
expect(result.details.sourceKeys).toEqual(['pdf_pages/page_1.webp', 'pdf_pages/page_2.webp'])
|
||||
})
|
||||
|
||||
it('should throw error if start page is less than 1', async () => {
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 0, end: 5 })).rejects.toThrow(
|
||||
'Invalid page range: start page (0) must be at least 1.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if start page is greater than end page', async () => {
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 5, end: 2 })).rejects.toThrow(
|
||||
'Invalid page range: start page (5) must be less than or equal to end page (2).',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if page range exceeds maximum limit of 20', async () => {
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 1, end: 25 })).rejects.toThrow(
|
||||
'Page range (25 pages requested) exceeds the maximum limit of 20 pages per request.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if asset not found', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 1, end: 3 })).rejects.toThrow(
|
||||
'Asset with ID asset-1 not found.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if proxyType is not pdf', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
media: { proxyType: 'image' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 1, end: 3 })).rejects.toThrow(
|
||||
'Asset asset-1 is not a PDF or document.',
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw error if proxyType is null/undefined (unprocessed)', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
media: null,
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadPdfPagesTool('user-1')
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', start: 1, end: 3 })).rejects.toThrow(
|
||||
'Asset asset-1 is not a PDF or document.',
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -1,152 +0,0 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { type ImageContent } from '@earendil-works/pi-ai'
|
||||
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
|
||||
const readPdfPagesSchema = Type.Object({
|
||||
assetId: Type.String({
|
||||
description: 'Asset ID of the PDF document. This parameter is required.',
|
||||
}),
|
||||
start: Type.Number({ description: 'Start page number (1-based index)' }),
|
||||
end: Type.Number({ description: 'End page number (1-based index)' }),
|
||||
})
|
||||
|
||||
export function createReadPdfPagesTool(
|
||||
userId: string,
|
||||
userCommentId?: string | null,
|
||||
): AgentTool<typeof readPdfPagesSchema> {
|
||||
return {
|
||||
name: 'read_pdf_pages',
|
||||
label: 'Read PDF Pages',
|
||||
description:
|
||||
'Converts specific page range of a PDF document into 1080p WebP images for visual analysis. Maximum 20 pages allowed per call.',
|
||||
parameters: readPdfPagesSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
if (params.start < 1) {
|
||||
throw new Error(`Invalid page range: start page (${params.start}) must be at least 1.`)
|
||||
}
|
||||
|
||||
if (params.start > params.end) {
|
||||
throw new Error(
|
||||
`Invalid page range: start page (${params.start}) must be less than or equal to end page (${params.end}).`,
|
||||
)
|
||||
}
|
||||
|
||||
const MAX_PAGE_RANGE = 20
|
||||
const requestedPages = params.end - params.start + 1
|
||||
if (requestedPages > MAX_PAGE_RANGE) {
|
||||
throw new Error(
|
||||
`Page range (${requestedPages} pages requested) exceeds the maximum limit of ${MAX_PAGE_RANGE} pages per request.`,
|
||||
)
|
||||
}
|
||||
|
||||
const targetAssetId = params.assetId
|
||||
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: targetAssetId,
|
||||
})
|
||||
|
||||
let asset = await prisma.asset.findUnique({
|
||||
where: { id: targetAssetId },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${targetAssetId} not found.`)
|
||||
}
|
||||
|
||||
if (asset.type === 'version_stack') {
|
||||
const latestVersion = await prisma.asset.findFirst({
|
||||
where: { parentId: asset.id, isDeleted: false },
|
||||
orderBy: { sortIndex: 'asc' },
|
||||
})
|
||||
if (latestVersion) {
|
||||
asset = latestVersion
|
||||
}
|
||||
}
|
||||
|
||||
const proxyType = (asset.media as PrismaJson.MediaInfo | null)?.proxyType
|
||||
if (proxyType !== 'pdf') {
|
||||
throw new Error(`Asset ${targetAssetId} is not a PDF or document.`)
|
||||
}
|
||||
|
||||
// Fetch trigger comment details for comment page and annotations
|
||||
let commentTimestamp: number | null = null
|
||||
let annotations: unknown = null
|
||||
if (userCommentId) {
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: userCommentId },
|
||||
})
|
||||
if (comment && comment.assetId === targetAssetId) {
|
||||
commentTimestamp = comment.second !== null ? comment.second : null
|
||||
if (comment.annotation) {
|
||||
const list = comment.annotation
|
||||
if (Array.isArray(list) && list.length > 0) {
|
||||
annotations = list
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Trigger transcode workflow to render PDF pages
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId: targetAssetId,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_pdf_pages,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
pdfPages: {
|
||||
start: params.start,
|
||||
end: params.end,
|
||||
commentTimestamp,
|
||||
annotations: annotations as PrismaJson.AnnotationList,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const output = completedTask.output as any
|
||||
const pages = output?.pages as Array<{ key: string; page: number }> | undefined
|
||||
|
||||
if (!pages || pages.length === 0) {
|
||||
throw new Error('No PDF page images were generated.')
|
||||
}
|
||||
|
||||
const content: ImageContent[] = []
|
||||
const sourceKeys: string[] = []
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
|
||||
for (const pageItem of pages) {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, pageItem.key)
|
||||
const mimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : 'image/webp'
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType,
|
||||
})
|
||||
sourceKeys.push(pageItem.key)
|
||||
}
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
sourceKeys,
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -51,6 +51,8 @@ describe('createReadThreadTool', () => {
|
||||
id: 'root-1',
|
||||
message: 'Initial top-level question',
|
||||
creator: { name: 'Alice' },
|
||||
second: 12.5,
|
||||
annotation: [{ type: 'box' }],
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any)
|
||||
vi.mocked(prisma.assetComment.findMany).mockResolvedValue([])
|
||||
@@ -59,7 +61,9 @@ describe('createReadThreadTool', () => {
|
||||
const result = await tool.execute('call-2', { threadId: 'root-1' })
|
||||
const textContent = (result.content[0] as { text: string }).text
|
||||
|
||||
expect(textContent).toContain('Thread Root [Alice] (root-1): Initial top-level question')
|
||||
expect(textContent).toContain(
|
||||
'Thread Root [Alice] (id: root-1, time: 12.5s, has_markup: true): Initial top-level question',
|
||||
)
|
||||
expect(textContent).toContain('(No replies in this thread yet)')
|
||||
})
|
||||
|
||||
@@ -75,6 +79,8 @@ describe('createReadThreadTool', () => {
|
||||
id: 'reply-1',
|
||||
message: 'First reply to thread',
|
||||
creator: { name: 'Bob' },
|
||||
second: 15.0,
|
||||
annotation: [{ type: 'line' }],
|
||||
},
|
||||
{
|
||||
id: 'reply-2',
|
||||
@@ -88,8 +94,45 @@ describe('createReadThreadTool', () => {
|
||||
const result = await tool.execute('call-3', { threadId: 'root-1' })
|
||||
const textContent = (result.content[0] as { text: string }).text
|
||||
|
||||
expect(textContent).toContain('Thread Root [Alice] (root-1): Initial top-level question')
|
||||
expect(textContent).toContain('- [Bob]: First reply to thread')
|
||||
expect(textContent).toContain('- [Charlie]: Second reply to thread')
|
||||
expect(textContent).toContain(
|
||||
'Thread Root [Alice] (id: root-1, has_markup: false): Initial top-level question',
|
||||
)
|
||||
expect(textContent).toContain(
|
||||
'- [Bob] (id: reply-1, time: 15s, has_markup: true): First reply to thread',
|
||||
)
|
||||
expect(textContent).toContain(
|
||||
'- [Charlie] (id: reply-2, has_markup: false): Second reply to thread',
|
||||
)
|
||||
})
|
||||
|
||||
it('should label agent replies as [Ai Agent] when creator is null but sessionId exists', async () => {
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'root-1',
|
||||
message: 'Question to agent',
|
||||
creator: { name: 'Alice' },
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
} as any)
|
||||
vi.mocked(prisma.assetComment.findMany).mockResolvedValue([
|
||||
{
|
||||
id: 'reply-1',
|
||||
message: 'Agent answer',
|
||||
creator: null,
|
||||
sessionId: 'session-123',
|
||||
},
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
] as any)
|
||||
|
||||
const tool = createReadThreadTool()
|
||||
const result = await tool.execute('call-agent', { threadId: 'root-1' })
|
||||
const textContent = (result.content[0] as { text: string }).text
|
||||
|
||||
expect(textContent).toContain('- [Ai Agent] (id: reply-1, has_markup: false): Agent answer')
|
||||
})
|
||||
|
||||
it('should describe threadId parameter as referencing <thread id="..." /> in <context>', () => {
|
||||
const tool = createReadThreadTool()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const description = (tool.parameters as any).properties.threadId.description
|
||||
expect(description).toContain('<thread id="..." />')
|
||||
})
|
||||
})
|
||||
|
||||
@@ -5,10 +5,24 @@ import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
const readThreadSchema = Type.Object({
|
||||
threadId: Type.String({
|
||||
description:
|
||||
'The root comment ID of a thread (e.g. from [Thread ID: ...]). Do NOT pass an asset ID or project ID.',
|
||||
'The root comment ID of a thread (from <thread id="..." /> in the <context> block). Do NOT pass an asset ID or project ID.',
|
||||
}),
|
||||
})
|
||||
|
||||
function formatCommentMeta(c: {
|
||||
id: string
|
||||
second?: number | null
|
||||
annotation?: unknown
|
||||
}): string {
|
||||
const parts = [`id: ${c.id}`]
|
||||
if (c.second !== null && c.second !== undefined) {
|
||||
parts.push(`time: ${c.second}s`)
|
||||
}
|
||||
const hasMarkup = Boolean(c.annotation && Array.isArray(c.annotation) && c.annotation.length > 0)
|
||||
parts.push(`has_markup: ${hasMarkup}`)
|
||||
return `(${parts.join(', ')})`
|
||||
}
|
||||
|
||||
export const createReadThreadTool = (): AgentTool<
|
||||
typeof readThreadSchema,
|
||||
{ threadId: string }
|
||||
@@ -47,15 +61,19 @@ export const createReadThreadTool = (): AgentTool<
|
||||
include: { creator: true },
|
||||
})
|
||||
|
||||
const rootAuthor = rootComment.creator?.name || 'User'
|
||||
let output = `Thread Root [${rootAuthor}] (${rootComment.id}): ${rootComment.message || ''}\n\nReplies (${replies.length}):`
|
||||
const isRootAgent = rootComment.creator?.type === 'agent' || rootComment.sessionId !== null
|
||||
const rootAuthor = rootComment.creator?.name || (isRootAgent ? 'Ai Agent' : 'User')
|
||||
const rootMeta = formatCommentMeta(rootComment)
|
||||
let output = `Thread Root [${rootAuthor}] ${rootMeta}: ${rootComment.message || ''}\n\nReplies (${replies.length}):`
|
||||
|
||||
if (replies.length === 0) {
|
||||
output += '\n(No replies in this thread yet)'
|
||||
} else {
|
||||
for (const reply of replies) {
|
||||
const author = reply.creator?.name || 'User'
|
||||
output += `\n- [${author}]: ${reply.message || ''}`
|
||||
const isAgent = reply.creator?.type === 'agent' || reply.sessionId !== null
|
||||
const author = reply.creator?.name || (isAgent ? 'Ai Agent' : 'User')
|
||||
const replyMeta = formatCommentMeta(reply)
|
||||
output += `\n- [${author}] ${replyMeta}: ${reply.message || ''}`
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createRenameAssetTool } from './rename-asset'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
import { AuditAction, type AssetInfo } from '@shumai/dtos'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
Permission: { Edit: 'edit', Read: 'read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/asset/asset', () => ({
|
||||
assetService: {
|
||||
updateAssetName: vi.fn().mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
name: 'Renamed Asset',
|
||||
type: 'file',
|
||||
sizeByte: 1024,
|
||||
projectId: 'proj-1',
|
||||
}),
|
||||
getAssetContext: vi.fn().mockResolvedValue({
|
||||
teamId: 'team-1',
|
||||
projectId: 'proj-1',
|
||||
}),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('createRenameAssetTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('checks edit permission and calls assetService.updateAssetName', async () => {
|
||||
const tool = createRenameAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1', name: 'Renamed Asset' })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'edit',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(assetService.updateAssetName).toHaveBeenCalledWith({
|
||||
id: 'asset-1',
|
||||
name: 'Renamed Asset',
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({})
|
||||
expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({
|
||||
id: 'asset-1',
|
||||
name: 'Renamed Asset',
|
||||
type: 'file',
|
||||
size: 1024,
|
||||
})
|
||||
})
|
||||
|
||||
it('logs file_update audit action when renaming a file with agentContext', async () => {
|
||||
const tool = createRenameAssetTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { assetId: 'asset-1', name: 'Renamed File' })
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.file_update,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'asset-1',
|
||||
})
|
||||
})
|
||||
|
||||
it('logs folder_update audit action when renaming a folder with agentContext', async () => {
|
||||
vi.mocked(assetService.updateAssetName).mockResolvedValueOnce({
|
||||
id: 'folder-1',
|
||||
name: 'Renamed Folder',
|
||||
type: 'folder',
|
||||
sizeByte: 0,
|
||||
projectId: 'proj-1',
|
||||
} as unknown as AssetInfo)
|
||||
|
||||
const tool = createRenameAssetTool('user-1', { teamId: 'team-1', agentId: 'agent-1' })
|
||||
await tool.execute('call-1', { assetId: 'folder-1', name: 'Renamed Folder' })
|
||||
|
||||
expect(auditLogService.logAction).toHaveBeenCalledWith({
|
||||
action: AuditAction.folder_update,
|
||||
teamId: 'team-1',
|
||||
userId: 'user-1',
|
||||
agentId: 'agent-1',
|
||||
projectId: 'proj-1',
|
||||
itemId: 'folder-1',
|
||||
})
|
||||
})
|
||||
|
||||
it('fails when permission check rejects', async () => {
|
||||
vi.mocked(authzService.hasPermission).mockRejectedValueOnce(new Error('Permission denied'))
|
||||
const tool = createRenameAssetTool('user-1')
|
||||
|
||||
await expect(tool.execute('call-1', { assetId: 'asset-1', name: 'New' })).rejects.toThrow(
|
||||
'Permission denied',
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,69 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { type User } from '@shumai/db'
|
||||
import { AuditAction } from '@shumai/dtos'
|
||||
|
||||
const renameAssetSchema = Type.Object({
|
||||
assetId: Type.String({
|
||||
description: 'The ID of the asset (file or folder) to rename. This parameter is required.',
|
||||
}),
|
||||
name: Type.String({
|
||||
description: 'The new name for the asset. This parameter is required.',
|
||||
}),
|
||||
})
|
||||
|
||||
export function createRenameAssetTool(
|
||||
userId: string,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool<typeof renameAssetSchema> {
|
||||
return {
|
||||
name: 'rename_asset',
|
||||
label: 'Rename Asset',
|
||||
description: 'Rename an existing asset (file or folder).',
|
||||
parameters: renameAssetSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.Asset,
|
||||
id: params.assetId,
|
||||
})
|
||||
|
||||
const updatedAsset = await assetService.updateAssetName({
|
||||
id: params.assetId,
|
||||
name: params.name,
|
||||
})
|
||||
|
||||
if (agentContext?.teamId) {
|
||||
const ctx = await assetService.getAssetContext(params.assetId).catch(() => ({
|
||||
teamId: agentContext.teamId!,
|
||||
projectId: updatedAsset.projectId ?? undefined,
|
||||
}))
|
||||
await auditLogService.logAction({
|
||||
action:
|
||||
updatedAsset.type === 'folder' ? AuditAction.folder_update : AuditAction.file_update,
|
||||
teamId: agentContext.teamId || ctx.teamId,
|
||||
userId,
|
||||
agentId: agentContext.agentId,
|
||||
projectId: ctx.projectId ?? updatedAsset.projectId ?? undefined,
|
||||
itemId: params.assetId,
|
||||
})
|
||||
}
|
||||
|
||||
const result = {
|
||||
id: updatedAsset.id,
|
||||
name: updatedAsset.name,
|
||||
type: updatedAsset.type,
|
||||
size: Number(updatedAsset.sizeByte),
|
||||
}
|
||||
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -1,156 +0,0 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createScreenshotTool } from './screenshot'
|
||||
import {
|
||||
prisma,
|
||||
WorkflowTaskStatus,
|
||||
type Asset,
|
||||
type AssetComment,
|
||||
type User,
|
||||
type WorkflowTask,
|
||||
} from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/db', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@shumai/db')>()
|
||||
return {
|
||||
...actual,
|
||||
prisma: {
|
||||
user: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
asset: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
assetComment: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
workflowTask: {
|
||||
create: vi.fn(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
getObject: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/workflow-core', () => ({
|
||||
workflowService: {
|
||||
executeWait: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn(),
|
||||
},
|
||||
Permission: { Read: 'Read' },
|
||||
ResourceType: { Asset: 'asset' },
|
||||
}))
|
||||
|
||||
describe('screenshotTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('should trigger screenshot transcode workflow and return image outputs', async () => {
|
||||
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user-1' } as User)
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
} as unknown as Asset)
|
||||
|
||||
vi.mocked(prisma.assetComment.findUnique).mockResolvedValue({
|
||||
id: 'comment-1',
|
||||
assetId: 'asset-1',
|
||||
second: 5.0,
|
||||
annotation: [
|
||||
{
|
||||
type: 'line',
|
||||
color: '#00ff00',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
} as unknown as AssetComment)
|
||||
|
||||
vi.mocked(prisma.workflowTask.create).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(workflowService.executeWait).mockResolvedValue({
|
||||
id: 'task-1',
|
||||
status: WorkflowTaskStatus.completed,
|
||||
output: {
|
||||
screenshots: [
|
||||
{ key: 'screenshots/shot1.webp', timestamp: 0.0 },
|
||||
{ key: 'screenshots/shot2.webp', timestamp: 5.0 },
|
||||
],
|
||||
},
|
||||
} as unknown as WorkflowTask)
|
||||
|
||||
vi.mocked(s3Service.getObject).mockImplementation(async (_bucket: string, key: string) => {
|
||||
return {
|
||||
buffer: Buffer.from(`fake-bytes-for-${key}`),
|
||||
contentType: 'image/webp',
|
||||
} as unknown as { buffer: Buffer; contentType: string }
|
||||
})
|
||||
|
||||
const tool = createScreenshotTool('user-1', 'comment-1')
|
||||
const result = await tool.execute('call-1', { assetId: 'asset-1', start: 0, end: 10, count: 2 })
|
||||
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: { id: 'user-1' },
|
||||
permission: 'Read',
|
||||
type: 'asset',
|
||||
id: 'asset-1',
|
||||
})
|
||||
|
||||
expect(prisma.workflowTask.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
assetId: 'asset-1',
|
||||
projectId: 'project-1',
|
||||
type: 'transcode_screenshot',
|
||||
status: 'pending',
|
||||
payload: {
|
||||
projectId: 'project-1',
|
||||
screenshot: {
|
||||
start: 0,
|
||||
end: 10,
|
||||
count: 2,
|
||||
commentTimestamp: 5.0,
|
||||
annotations: [
|
||||
{
|
||||
type: 'line',
|
||||
color: '#00ff00',
|
||||
points: [
|
||||
[0, 0],
|
||||
[1, 1],
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(result.content.length).toBe(2)
|
||||
expect(result.content[0].type).toBe('image')
|
||||
expect((result.content[0] as unknown as { data: string }).data).toBe(
|
||||
Buffer.from('fake-bytes-for-screenshots/shot1.webp').toString('base64'),
|
||||
)
|
||||
expect((result.content[1] as unknown as { data: string }).data).toBe(
|
||||
Buffer.from('fake-bytes-for-screenshots/shot2.webp').toString('base64'),
|
||||
)
|
||||
expect(result.details.sourceKeys).toEqual(['screenshots/shot1.webp', 'screenshots/shot2.webp'])
|
||||
})
|
||||
})
|
||||
@@ -1,123 +0,0 @@
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { type ImageContent } from '@earendil-works/pi-ai'
|
||||
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
|
||||
const screenshotSchema = Type.Object({
|
||||
assetId: Type.String({
|
||||
description: 'The asset ID of the video asset. This parameter is required.',
|
||||
}),
|
||||
start: Type.Number({ description: 'Start time in seconds' }),
|
||||
end: Type.Number({ description: 'End time in seconds' }),
|
||||
count: Type.Number({ description: 'Number of screenshots to take' }),
|
||||
})
|
||||
|
||||
export function createScreenshotTool(
|
||||
userId: string,
|
||||
userCommentId?: string | null,
|
||||
): AgentTool<typeof screenshotSchema> {
|
||||
return {
|
||||
name: 'screenshot',
|
||||
label: 'Take Video Screenshots',
|
||||
description:
|
||||
'Takes screenshots for a video at specified interval. It returns the images to the agent context.',
|
||||
parameters: screenshotSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const assetId = params.assetId
|
||||
|
||||
if (!userId) {
|
||||
throw new Error('User ID is required for authorization.')
|
||||
}
|
||||
|
||||
await authzService.hasPermission({
|
||||
user: { id: userId } as User,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Asset,
|
||||
id: assetId,
|
||||
})
|
||||
|
||||
const asset = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
})
|
||||
|
||||
if (!asset) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
// Fetch trigger comment details for timestamp and annotations
|
||||
let commentTimestamp: number | null = null
|
||||
let annotations: unknown = null
|
||||
if (userCommentId) {
|
||||
const comment = await prisma.assetComment.findUnique({
|
||||
where: { id: userCommentId },
|
||||
})
|
||||
if (comment && comment.assetId === assetId) {
|
||||
commentTimestamp = comment.second !== null ? comment.second : null
|
||||
if (comment.annotation) {
|
||||
const list = comment.annotation
|
||||
if (Array.isArray(list) && list.length > 0) {
|
||||
annotations = list
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Trigger transcode workflow to take screenshots
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
assetId,
|
||||
projectId: asset.projectId || 'none',
|
||||
type: WorkflowTaskType.transcode_screenshot,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
payload: {
|
||||
projectId: asset.projectId || 'none',
|
||||
screenshot: {
|
||||
start: params.start,
|
||||
end: params.end,
|
||||
count: params.count,
|
||||
commentTimestamp,
|
||||
annotations: annotations as PrismaJson.AnnotationList,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
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('No screenshots were generated.')
|
||||
}
|
||||
|
||||
const content: ImageContent[] = []
|
||||
const sourceKeys: string[] = []
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
|
||||
for (const shot of screenshots) {
|
||||
const { buffer, contentType } = await s3Service.getObject(bucket, shot.key)
|
||||
const mimeType =
|
||||
contentType && contentType !== 'application/octet-stream' ? contentType : 'image/webp'
|
||||
content.push({
|
||||
type: 'image',
|
||||
data: buffer.toString('base64'),
|
||||
mimeType,
|
||||
})
|
||||
sourceKeys.push(shot.key)
|
||||
}
|
||||
|
||||
return {
|
||||
content,
|
||||
details: {
|
||||
sourceKeys,
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { WorkflowTaskType, WorkflowTaskStatus } from '@shumai/db'
|
||||
|
||||
export async function executeAgentToolWorkflow(params: {
|
||||
toolName: string
|
||||
args: Record<string, unknown>
|
||||
userId: string
|
||||
assetId: string
|
||||
}): Promise<unknown> {
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: WorkflowTaskType.agent_tool_call,
|
||||
status: WorkflowTaskStatus.pending,
|
||||
assetId: params.assetId,
|
||||
payload: {
|
||||
projectId: 'none',
|
||||
agentToolCall: {
|
||||
toolName: params.toolName,
|
||||
args: params.args,
|
||||
userId: params.userId,
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const completedTask = await workflowService.executeWait(task)
|
||||
if (completedTask.status === WorkflowTaskStatus.failed) {
|
||||
const output = completedTask.output as Record<string, unknown> | null
|
||||
const errorMsg = (output?.error as string) || 'Workflow task failed'
|
||||
throw new Error(errorMsg)
|
||||
}
|
||||
|
||||
return completedTask.output
|
||||
}
|
||||
@@ -1,171 +0,0 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
import { AgentChatPromptBuilder } from './agent-chat-prompt-builder'
|
||||
|
||||
describe('AgentChatPromptBuilder', () => {
|
||||
it('should build prompt with baseline configurations', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('The user is discussing an asset with ID: a1.')
|
||||
})
|
||||
|
||||
it('should build prompt with path context', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withPathContext('folder/sub/file.png')
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('Asset Path Context:\nfolder/sub/file.png')
|
||||
})
|
||||
|
||||
it('should build prompt with image asset details', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withAssetDetails(
|
||||
'test.png',
|
||||
'image/png',
|
||||
undefined,
|
||||
undefined,
|
||||
'image',
|
||||
)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('File Name: test.png')
|
||||
expect(result).toContain('File Type: image')
|
||||
expect(result).toContain("call the 'analyze_image' tool")
|
||||
expect(result).not.toContain("call the 'screenshot' tool")
|
||||
})
|
||||
|
||||
it('should build prompt with video asset details and duration', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withAssetDetails(
|
||||
'movie.mp4',
|
||||
'video/mp4',
|
||||
12.34,
|
||||
undefined,
|
||||
'video',
|
||||
)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('File Name: movie.mp4')
|
||||
expect(result).toContain('File Type: video')
|
||||
expect(result).toContain('Video Length: 12.34 seconds')
|
||||
expect(result).toContain("call the 'screenshot' tool")
|
||||
expect(result).not.toContain("call the 'analyze_image' tool")
|
||||
})
|
||||
|
||||
it('should build prompt with PDF asset details and total pages', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withAssetDetails(
|
||||
'doc.pdf',
|
||||
'application/pdf',
|
||||
undefined,
|
||||
15,
|
||||
'pdf',
|
||||
)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('File Name: doc.pdf')
|
||||
expect(result).toContain('File Type: pdf')
|
||||
expect(result).toContain('Total Pages: 15')
|
||||
expect(result).toContain("call the 'read_pdf_pages' tool")
|
||||
expect(result).toContain('Maximum 20 pages allowed per call.')
|
||||
expect(result).not.toContain("call the 'screenshot' tool")
|
||||
expect(result).not.toContain("call the 'analyze_image' tool")
|
||||
})
|
||||
|
||||
it('should build prompt with comment page for PDF asset', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
.withAssetDetails('doc.pdf', 'application/pdf', undefined, 10, 'pdf')
|
||||
.withCommentTimestamp(3)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('Comment Page: 3')
|
||||
})
|
||||
|
||||
it('should build prompt for PDF continuation mode with comment page', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
.withContinuation(true)
|
||||
.withAssetDetails('doc.pdf', 'application/pdf', undefined, 10, 'pdf')
|
||||
.withCommentTimestamp(4)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('Comment Page: 4')
|
||||
expect(result).not.toContain('Comment Timestamp:')
|
||||
})
|
||||
|
||||
it('should build prompt with comment timestamp', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withCommentTimestamp(5.5)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('Comment Timestamp: 5.50 seconds')
|
||||
})
|
||||
|
||||
it('should build prompt with all fields combined', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
.withPathContext('src/main.ts')
|
||||
.withAssetDetails('movie.mp4', 'video/mp4', 12.34, undefined, 'video')
|
||||
.withCommentTimestamp(8.2)
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('The user is discussing an asset with ID: a1.')
|
||||
expect(result).toContain('File Name: movie.mp4')
|
||||
expect(result).toContain('File Type: video')
|
||||
expect(result).toContain('Video Length: 12.34 seconds')
|
||||
expect(result).toContain('Comment Timestamp: 8.20 seconds')
|
||||
expect(result).toContain('Asset Path Context:\nsrc/main.ts')
|
||||
expect(result).toContain("call the 'screenshot' tool")
|
||||
})
|
||||
|
||||
it('should build prompt with attached files and referenced assets', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
.withAttachedFiles(['- file1.txt', '- file2.png'])
|
||||
.withReferencedAssets(['- folder1', '- file3.mp4'])
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('[Context: Attached Files & Referenced Assets]')
|
||||
expect(result).toContain('Attached Files:\n- file1.txt\n- file2.png')
|
||||
expect(result).toContain('Referenced Workspace Assets:\n- folder1\n- file3.mp4')
|
||||
})
|
||||
|
||||
it('should build prompt for continuation mode returning only turn-specific modifications', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
.withContinuation(true)
|
||||
.withAssetDetails('movie.mp4', 'video/mp4', 12.34)
|
||||
.withPathContext('src/main.ts')
|
||||
.withCommentTimestamp(8.2)
|
||||
.withAttachedFiles(['- file1.txt'])
|
||||
.withReferencedAssets(['- folder1'])
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).not.toContain('The user is discussing an asset with ID:')
|
||||
expect(result).not.toContain('File Name: movie.mp4')
|
||||
expect(result).not.toContain('Asset Path Context:')
|
||||
expect(result).toContain('Comment Timestamp: 8.20 seconds')
|
||||
expect(result).toContain('[Context: New Attached Files & Referenced Assets]')
|
||||
expect(result).toContain('Attached Files:\n- file1.txt')
|
||||
expect(result).toContain('Referenced Workspace Assets:\n- folder1')
|
||||
})
|
||||
|
||||
it('should include location change context block in continuation mode when asset has changed', () => {
|
||||
const builder = new AgentChatPromptBuilder('a2')
|
||||
.withContinuation(true)
|
||||
.withAssetChanged(true)
|
||||
.withAssetDetails('new-folder', 'folder', undefined, undefined, 'folder')
|
||||
.withPathContext('projects/my-proj/new-folder')
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('[Context: User Navigated to a New Location]')
|
||||
expect(result).toContain('New Location Asset ID: a2')
|
||||
expect(result).toContain('File Name: new-folder')
|
||||
expect(result).toContain('Asset Path Context:\nprojects/my-proj/new-folder')
|
||||
})
|
||||
|
||||
it('should build prompt with user info when provided and not continuation', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1').withUserInfo('Alice', 'owner')
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain('User Info:\nName: Alice\nRole: owner')
|
||||
})
|
||||
|
||||
it('should build prompt with download_asset tool instruction', () => {
|
||||
const builder = new AgentChatPromptBuilder('a1')
|
||||
const result = builder.build()
|
||||
|
||||
expect(result).toContain("call the 'download_asset' tool with assetId.")
|
||||
})
|
||||
})
|
||||
@@ -1,185 +0,0 @@
|
||||
export function getSimpleMediaType(proxyType?: string | null): 'image' | 'video' | 'pdf' | 'other' {
|
||||
if (proxyType === 'image') return 'image'
|
||||
if (proxyType === 'video') return 'video'
|
||||
if (proxyType === 'pdf') return 'pdf'
|
||||
return 'other'
|
||||
}
|
||||
|
||||
export class AgentChatPromptBuilder {
|
||||
private assetId: string
|
||||
private assetName?: string
|
||||
private mediaType?: string
|
||||
private proxyType?: string
|
||||
private videoDuration?: number
|
||||
private totalPages?: number
|
||||
private commentTimestamp?: number
|
||||
private pathContext?: string
|
||||
private attachedFiles: string[] = []
|
||||
private referencedAssets: string[] = []
|
||||
private userInfo?: { name: string; role: string }
|
||||
|
||||
private isContinuation = false
|
||||
private hasAssetChanged = false
|
||||
|
||||
constructor(assetId: string) {
|
||||
this.assetId = assetId
|
||||
}
|
||||
|
||||
withUserInfo(name?: string, role?: string): this {
|
||||
if (name) {
|
||||
this.userInfo = { name, role: role || 'user' }
|
||||
}
|
||||
return this
|
||||
}
|
||||
|
||||
withContinuation(isContinuation: boolean): this {
|
||||
this.isContinuation = isContinuation
|
||||
return this
|
||||
}
|
||||
|
||||
withAssetChanged(hasAssetChanged?: boolean): this {
|
||||
this.hasAssetChanged = !!hasAssetChanged
|
||||
return this
|
||||
}
|
||||
|
||||
withAttachedFiles(files?: string[]): this {
|
||||
if (files) {
|
||||
this.attachedFiles = files
|
||||
}
|
||||
return this
|
||||
}
|
||||
|
||||
withReferencedAssets(assets?: string[]): this {
|
||||
if (assets) {
|
||||
this.referencedAssets = assets
|
||||
}
|
||||
return this
|
||||
}
|
||||
|
||||
withPathContext(pathContext?: string): this {
|
||||
this.pathContext = pathContext
|
||||
return this
|
||||
}
|
||||
|
||||
withAssetDetails(
|
||||
name: string,
|
||||
mediaType: string | null,
|
||||
duration?: number,
|
||||
totalPages?: number,
|
||||
proxyType?: string | null,
|
||||
): this {
|
||||
this.assetName = name
|
||||
this.mediaType = mediaType || undefined
|
||||
this.proxyType = proxyType || undefined
|
||||
this.videoDuration = duration
|
||||
this.totalPages = totalPages
|
||||
return this
|
||||
}
|
||||
|
||||
withCommentTimestamp(second?: number | null): this {
|
||||
if (second !== undefined && second !== null) {
|
||||
this.commentTimestamp = second
|
||||
}
|
||||
return this
|
||||
}
|
||||
|
||||
build(): string {
|
||||
const effectiveType = this.proxyType
|
||||
|
||||
if (this.isContinuation) {
|
||||
let instruction = ''
|
||||
if (this.hasAssetChanged) {
|
||||
instruction += `[Context: User Navigated to a New Location]\nNew Location Asset ID: ${this.assetId}`
|
||||
if (this.assetName) {
|
||||
instruction += `\nFile Name: ${this.assetName}`
|
||||
}
|
||||
if (effectiveType) {
|
||||
const type = getSimpleMediaType(effectiveType)
|
||||
instruction += `\nFile Type: ${type}`
|
||||
if (type === 'video' && this.videoDuration !== undefined) {
|
||||
instruction += `\nVideo Length: ${this.videoDuration.toFixed(2)} seconds`
|
||||
} else if (type === 'pdf' && this.totalPages !== undefined) {
|
||||
instruction += `\nTotal Pages: ${this.totalPages}`
|
||||
}
|
||||
}
|
||||
if (this.pathContext) {
|
||||
instruction += `\n\nAsset Path Context:\n${this.pathContext}`
|
||||
}
|
||||
}
|
||||
if (this.commentTimestamp !== undefined) {
|
||||
const type = getSimpleMediaType(effectiveType)
|
||||
if (instruction) instruction += '\n\n'
|
||||
if (type === 'pdf') {
|
||||
instruction += `Comment Page: ${Math.round(this.commentTimestamp)}`
|
||||
} else {
|
||||
instruction += `Comment Timestamp: ${this.commentTimestamp.toFixed(2)} seconds`
|
||||
}
|
||||
}
|
||||
if (this.attachedFiles.length > 0 || this.referencedAssets.length > 0) {
|
||||
if (instruction) instruction += '\n\n'
|
||||
instruction += `[Context: New Attached Files & Referenced Assets]`
|
||||
if (this.attachedFiles.length > 0) {
|
||||
instruction += `\nAttached Files:\n${this.attachedFiles.join('\n')}`
|
||||
}
|
||||
if (this.referencedAssets.length > 0) {
|
||||
instruction += `\nReferenced Workspace Assets:\n${this.referencedAssets.join('\n')}`
|
||||
}
|
||||
}
|
||||
return instruction.trim()
|
||||
}
|
||||
|
||||
let instruction = `The user is discussing an asset with ID: ${this.assetId}.`
|
||||
if (this.assetName) {
|
||||
instruction += `\nFile Name: ${this.assetName}`
|
||||
}
|
||||
if (effectiveType) {
|
||||
const type = getSimpleMediaType(effectiveType)
|
||||
instruction += `\nFile Type: ${type}`
|
||||
if (type === 'video' && this.videoDuration !== undefined) {
|
||||
instruction += `\nVideo Length: ${this.videoDuration.toFixed(2)} seconds`
|
||||
} else if (type === 'pdf' && this.totalPages !== undefined) {
|
||||
instruction += `\nTotal Pages: ${this.totalPages}`
|
||||
}
|
||||
}
|
||||
if (this.commentTimestamp !== undefined) {
|
||||
const type = getSimpleMediaType(effectiveType)
|
||||
if (type === 'pdf') {
|
||||
instruction += `\nComment Page: ${Math.round(this.commentTimestamp)}`
|
||||
} else {
|
||||
instruction += `\nComment Timestamp: ${this.commentTimestamp.toFixed(2)} seconds`
|
||||
}
|
||||
}
|
||||
if (this.pathContext) {
|
||||
instruction += `\n\nAsset Path Context:\n${this.pathContext}`
|
||||
}
|
||||
|
||||
if (this.attachedFiles.length > 0 || this.referencedAssets.length > 0) {
|
||||
instruction += `\n\n[Context: Attached Files & Referenced Assets]`
|
||||
if (this.attachedFiles.length > 0) {
|
||||
instruction += `\nAttached Files:\n${this.attachedFiles.join('\n')}`
|
||||
}
|
||||
if (this.referencedAssets.length > 0) {
|
||||
instruction += `\nReferenced Workspace Assets:\n${this.referencedAssets.join('\n')}`
|
||||
}
|
||||
}
|
||||
|
||||
if (effectiveType) {
|
||||
const type = getSimpleMediaType(effectiveType)
|
||||
if (type === 'image') {
|
||||
instruction += `\n\nIf you need to view the image data, call the 'analyze_image' tool with assetId "${this.assetId}".`
|
||||
} else if (type === 'video') {
|
||||
instruction += `\n\nIf you need to view visual frames or take screenshots of the video, call the 'screenshot' tool. You must specify the 'start' (seconds), 'end' (seconds), and 'count' (number of screenshots) parameters.`
|
||||
} else if (type === 'pdf') {
|
||||
instruction += `\n\nIf you need to view pages of the PDF document, call the 'read_pdf_pages' tool. You must specify the 'start' (page number) and 'end' (page number) parameters. Maximum 20 pages allowed per call.`
|
||||
}
|
||||
}
|
||||
|
||||
instruction += `\n\nIf you need a local file on disk to run bash commands or scripts (e.g. processing or combining assets), call the 'download_asset' tool with assetId.`
|
||||
|
||||
if (this.userInfo) {
|
||||
instruction += `\n\nUser Info:\nName: ${this.userInfo.name}\nRole: ${this.userInfo.role}`
|
||||
}
|
||||
|
||||
return instruction
|
||||
}
|
||||
}
|
||||
@@ -3,7 +3,6 @@ import { agentChat } from './agent-chat'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import * as workflowUtils from '@shumai/workflow-core'
|
||||
import { AgentChatPromptBuilder } from './agent-chat-prompt-builder'
|
||||
|
||||
vi.mock('@shumai/workflow-core', async () => {
|
||||
const actual = await vi.importActual('@shumai/workflow-core')
|
||||
@@ -43,6 +42,9 @@ describe('Agent Chat Workflow', () => {
|
||||
updateCommentActivity: Object.assign(vi.fn(), { _activityName: 'updateCommentActivity' }),
|
||||
updateTaskUsageActivity: Object.assign(vi.fn(), { _activityName: 'updateTaskUsageActivity' }),
|
||||
deleteCommentActivity: Object.assign(vi.fn(), { _activityName: 'deleteCommentActivity' }),
|
||||
getAssetPathHierarchyActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getAssetPathHierarchyActivity',
|
||||
}),
|
||||
getAssetPathContextActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getAssetPathContextActivity',
|
||||
}),
|
||||
@@ -70,13 +72,21 @@ describe('Agent Chat Workflow', () => {
|
||||
})
|
||||
mockActivities.getCommentActivity.mockResolvedValue({
|
||||
id: 'c1',
|
||||
creatorId: 'user-c1',
|
||||
message: 'hello agent',
|
||||
replyToId: null,
|
||||
attachments: [],
|
||||
})
|
||||
mockActivities.initializeAgentSessionActivity.mockResolvedValue('session-123')
|
||||
mockActivities.getAgentChatContextActivity.mockResolvedValue({ agent: { id: 'b1' } })
|
||||
mockActivities.getAssetPathContextActivity.mockResolvedValue('Path: folder/subfolder/file.png')
|
||||
mockActivities.getAssetPathHierarchyActivity.mockResolvedValue({
|
||||
path: 'folder/subfolder/test-file.png',
|
||||
ancestors: [
|
||||
{ id: 'f1', name: 'folder' },
|
||||
{ id: 'f2', name: 'subfolder' },
|
||||
],
|
||||
})
|
||||
mockActivities.getAssetPathContextActivity.mockResolvedValue('folder/subfolder/test-file.png')
|
||||
mockActivities.agentChatActivity.mockResolvedValue({
|
||||
text: 'Hello user, how can I help you?',
|
||||
sessionId: 'session-123',
|
||||
@@ -119,7 +129,6 @@ describe('Agent Chat Workflow', () => {
|
||||
expect(mockActivities.getCommentActivity).toHaveBeenCalledWith('c1')
|
||||
|
||||
// Verify agent context fetched with the project context forwarded
|
||||
// (required for project-aware role enforcement in the activity)
|
||||
expect(mockActivities.getAgentChatContextActivity).toHaveBeenCalledWith({
|
||||
teamId: 't1',
|
||||
agentId: 'b1',
|
||||
@@ -144,22 +153,31 @@ describe('Agent Chat Workflow', () => {
|
||||
userId: undefined,
|
||||
})
|
||||
|
||||
// Verify agent instruction composition
|
||||
const expectedInstruction1 = new AgentChatPromptBuilder('a1')
|
||||
.withPathContext('Path: folder/subfolder/file.png')
|
||||
.withAssetDetails('test-file.png', 'image/png', undefined, undefined, 'image')
|
||||
.withCommentTimestamp(null)
|
||||
.build()
|
||||
|
||||
// Verify agent chat called with structured messageContext
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
teamId: 't1',
|
||||
agentId: 'b1',
|
||||
message: 'hello agent',
|
||||
agentsInstruction: expectedInstruction1,
|
||||
sessionId: 'session-123',
|
||||
folderId: 'parent-folder-id',
|
||||
assetId: 'a1',
|
||||
messageContext: expect.objectContaining({
|
||||
user: { id: 'user-c1', name: 'Test User', role: 'owner' },
|
||||
currentAsset: expect.objectContaining({
|
||||
id: 'a1',
|
||||
name: 'test-file.png',
|
||||
type: 'file',
|
||||
mediaType: 'image',
|
||||
mimeType: 'image/png',
|
||||
parentId: 'parent-folder-id',
|
||||
path: 'folder/subfolder/test-file.png',
|
||||
ancestors: [
|
||||
{ id: 'f1', name: 'folder' },
|
||||
{ id: 'f2', name: 'subfolder' },
|
||||
],
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
|
||||
@@ -211,17 +229,13 @@ describe('Agent Chat Workflow', () => {
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.initializeAgentSessionActivity).not.toHaveBeenCalled()
|
||||
const expectedInstruction2 = new AgentChatPromptBuilder('a1')
|
||||
.withContinuation(true)
|
||||
.withPathContext('Path: folder/subfolder/file.png')
|
||||
.withAssetDetails('test-file.png', 'image/png', undefined)
|
||||
.withCommentTimestamp(null)
|
||||
.build()
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
sessionId: 'existing-session-456',
|
||||
agentsInstruction: expectedInstruction2,
|
||||
messageContext: expect.objectContaining({
|
||||
currentAsset: expect.objectContaining({ id: 'a1', name: 'test-file.png' }),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
|
||||
@@ -273,16 +287,9 @@ describe('Agent Chat Workflow', () => {
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
const expectedInstruction4 = new AgentChatPromptBuilder('a1')
|
||||
.withPathContext('Path: folder/subfolder/file.png')
|
||||
.withAssetDetails('test-file.png', 'image/png', undefined, undefined, 'image')
|
||||
.withCommentTimestamp(null)
|
||||
.build()
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
imageUrls: ['attachments/image1.png', 'attachments/image2.jpg'],
|
||||
agentsInstruction: expectedInstruction4,
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -315,15 +322,13 @@ describe('Agent Chat Workflow', () => {
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
const expectedInstruction5 = new AgentChatPromptBuilder('a1')
|
||||
.withPathContext('Path: folder/subfolder/file.png')
|
||||
.withAssetDetails('test-asset', 'video/mp4', 10)
|
||||
.withCommentTimestamp(null)
|
||||
.build()
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
agentsInstruction: expectedInstruction5,
|
||||
messageContext: expect.objectContaining({
|
||||
currentAsset: expect.objectContaining({
|
||||
durationSeconds: 10,
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -391,6 +396,7 @@ describe('Agent Chat Workflow', () => {
|
||||
name: 'attachment.png',
|
||||
type: 'file',
|
||||
mediaType: 'image/png',
|
||||
media: { proxyType: 'image' },
|
||||
projectId: 'p1',
|
||||
}
|
||||
}
|
||||
@@ -400,6 +406,7 @@ describe('Agent Chat Workflow', () => {
|
||||
name: 'ref-folder',
|
||||
type: 'folder',
|
||||
mediaType: null,
|
||||
media: null,
|
||||
projectId: 'p1',
|
||||
}
|
||||
}
|
||||
@@ -408,6 +415,7 @@ describe('Agent Chat Workflow', () => {
|
||||
name: 'test-file.png',
|
||||
type: 'file',
|
||||
mediaType: 'image/png',
|
||||
media: { proxyType: 'image' },
|
||||
projectId: 'p1',
|
||||
project: { teamId: 't1' },
|
||||
}
|
||||
@@ -443,20 +451,7 @@ describe('Agent Chat Workflow', () => {
|
||||
expect(mockActivities.createCommentActivity).not.toHaveBeenCalled()
|
||||
expect(mockActivities.updateCommentActivity).not.toHaveBeenCalled()
|
||||
|
||||
// Verify prompt builder is populated and workflow runs agentChatActivity with context instruction
|
||||
const expectedInstruction = new AgentChatPromptBuilder('a1')
|
||||
.withContinuation(true)
|
||||
.withPathContext('folder/subfolder/file.png')
|
||||
.withAssetDetails('test-file.png', 'image/png', undefined)
|
||||
.withCommentTimestamp(undefined)
|
||||
.withAttachedFiles([
|
||||
'- Name: attachment.png (ID: file-attachment-1, Type: file, Media Type: image/png, Project ID: p1, Path: attachment.png)',
|
||||
])
|
||||
.withReferencedAssets([
|
||||
'- Name: ref-folder (ID: referenced-asset-1, Type: folder, Media Type: unknown, Project ID: p1, Path: ref-folder)',
|
||||
])
|
||||
.build()
|
||||
|
||||
// Verify messageContext is populated with attachedFiles and referencedAssets
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
teamId: 't1',
|
||||
@@ -465,15 +460,32 @@ describe('Agent Chat Workflow', () => {
|
||||
imageUrls: [],
|
||||
projectId: 'p1',
|
||||
folderId: '',
|
||||
agentsInstruction: expectedInstruction,
|
||||
sessionId: 'session-direct-123',
|
||||
userId: undefined,
|
||||
userCommentId: undefined,
|
||||
context: { agent: { id: 'b1' } },
|
||||
attachedAssets: [
|
||||
{ id: 'file-attachment-1', name: 'attachment.png', type: 'file' },
|
||||
{ id: 'referenced-asset-1', name: 'ref-folder', type: 'folder' },
|
||||
],
|
||||
messageContext: expect.objectContaining({
|
||||
attachedFiles: [
|
||||
{
|
||||
id: 'file-attachment-1',
|
||||
name: 'attachment.png',
|
||||
type: 'file',
|
||||
mediaType: 'image',
|
||||
mimeType: 'image/png',
|
||||
path: 'attachment.png',
|
||||
},
|
||||
],
|
||||
referencedAssets: [
|
||||
{
|
||||
id: 'referenced-asset-1',
|
||||
name: 'ref-folder',
|
||||
type: 'folder',
|
||||
mediaType: undefined,
|
||||
mimeType: undefined,
|
||||
path: 'ref-folder',
|
||||
},
|
||||
],
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -512,19 +524,18 @@ describe('Agent Chat Workflow', () => {
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
const expectedInstruction = new AgentChatPromptBuilder('v2-latest')
|
||||
.withContinuation(true)
|
||||
.withPathContext('Path: folder/subfolder/file.png')
|
||||
.withAssetDetails('latest-video.mp4', 'video/mp4', 42, undefined, 'video')
|
||||
.build()
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
teamId: 't1',
|
||||
agentId: 'b1',
|
||||
message: 'Explain this version stack video',
|
||||
agentsInstruction: expectedInstruction,
|
||||
sessionId: 'session-vs-123',
|
||||
messageContext: expect.objectContaining({
|
||||
currentAsset: expect.objectContaining({
|
||||
id: 'v2-latest',
|
||||
durationSeconds: 42,
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
@@ -557,7 +568,241 @@ describe('Agent Chat Workflow', () => {
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
agentsInstruction: expect.stringContaining('User Info:\nName: Test User\nRole: owner'),
|
||||
messageContext: expect.objectContaining({
|
||||
user: { id: 'user-alice', name: 'Test User', role: 'owner' },
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should populate comment attachments into structured messageContext.attachedFiles', async () => {
|
||||
mockActivities.getCommentActivity.mockResolvedValue({
|
||||
id: 'c1',
|
||||
creatorId: 'user-c1',
|
||||
message: 'check these attachments',
|
||||
replyToId: null,
|
||||
attachments: [
|
||||
{
|
||||
asset: {
|
||||
id: 'att-doc-1',
|
||||
name: 'brief.pdf',
|
||||
type: 'file',
|
||||
mediaType: 'application/pdf',
|
||||
media: { proxyType: 'pdf' },
|
||||
storageKey: { key: 'brief.pdf' },
|
||||
},
|
||||
},
|
||||
{
|
||||
asset: {
|
||||
id: 'att-img-1',
|
||||
name: 'mockup.png',
|
||||
type: 'file',
|
||||
mediaType: 'image/png',
|
||||
media: { proxyType: 'image' },
|
||||
storageKey: { key: 'mockup.png' },
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
|
||||
mockActivities.getAssetPathContextActivity.mockImplementation(async (id: string) => {
|
||||
if (id === 'att-doc-1') return 'Docs/brief.pdf'
|
||||
if (id === 'att-img-1') return 'Designs/mockup.png'
|
||||
return 'folder/subfolder/file.png'
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { userCommentId: 'c1', agentId: 'b1' },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
imageUrls: ['mockup.png'],
|
||||
messageContext: expect.objectContaining({
|
||||
attachedFiles: [
|
||||
{
|
||||
id: 'att-doc-1',
|
||||
name: 'brief.pdf',
|
||||
type: 'file',
|
||||
mediaType: 'pdf',
|
||||
mimeType: 'application/pdf',
|
||||
path: 'Docs/brief.pdf',
|
||||
},
|
||||
{
|
||||
id: 'att-img-1',
|
||||
name: 'mockup.png',
|
||||
type: 'file',
|
||||
mediaType: 'image',
|
||||
mimeType: 'image/png',
|
||||
path: 'Designs/mockup.png',
|
||||
},
|
||||
],
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should set totalFrames for video assets and totalPages for pdf assets in currentAsset context', async () => {
|
||||
mockActivities.getAssetActivity.mockImplementation(async (id: string) => {
|
||||
if (id === 'video-asset-1') {
|
||||
return {
|
||||
id: 'video-asset-1',
|
||||
project: { teamId: 't1' },
|
||||
type: 'file',
|
||||
name: 'clip.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
media: { proxyType: 'video', duration: 9, frames: 268 },
|
||||
parentId: 'f1',
|
||||
}
|
||||
}
|
||||
if (id === 'pdf-asset-1') {
|
||||
return {
|
||||
id: 'pdf-asset-1',
|
||||
project: { teamId: 't1' },
|
||||
type: 'file',
|
||||
name: 'doc.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
media: { proxyType: 'pdf', frames: 15, duration: 0 },
|
||||
parentId: 'f1',
|
||||
}
|
||||
}
|
||||
return null
|
||||
})
|
||||
|
||||
// Test Video asset
|
||||
const videoTask = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'video-asset-1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { prompt: 'Analyze video', agentId: 'b1', sessionId: 'session-video-1' },
|
||||
},
|
||||
},
|
||||
})
|
||||
await agentChat(videoTask)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
currentAsset: expect.objectContaining({
|
||||
id: 'video-asset-1',
|
||||
mediaType: 'video',
|
||||
durationSeconds: 9,
|
||||
totalFrames: 268,
|
||||
totalPages: undefined,
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
|
||||
// Test PDF asset
|
||||
const pdfTask = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'pdf-asset-1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { prompt: 'Analyze pdf', agentId: 'b1', sessionId: 'session-pdf-1' },
|
||||
},
|
||||
},
|
||||
})
|
||||
await agentChat(pdfTask)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
currentAsset: expect.objectContaining({
|
||||
id: 'pdf-asset-1',
|
||||
mediaType: 'pdf',
|
||||
totalPages: 15,
|
||||
totalFrames: undefined,
|
||||
durationSeconds: undefined,
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should include annotations and second in direct chat messageContext', async () => {
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: {
|
||||
prompt: 'Look at the highlighted zone',
|
||||
agentId: 'b1',
|
||||
sessionId: 'session-markup-1',
|
||||
second: 14.2,
|
||||
annotations: [{ type: 'rectangle', x: 20, y: 30, width: 40, height: 50 }],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
position: { type: 'time', seconds: 14.2 },
|
||||
annotations: [{ type: 'rectangle', x: 20, y: 30, width: 40, height: 50 }],
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should include userCommentId as id in comment messageContext', async () => {
|
||||
mockActivities.getCommentActivity.mockResolvedValue({
|
||||
id: 'comment-with-id-123',
|
||||
creatorId: 'user-c1',
|
||||
message: 'Check this out',
|
||||
replyToId: null,
|
||||
second: 5.0,
|
||||
annotation: [{ type: 'arrow' }],
|
||||
attachments: [],
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'chat',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: {
|
||||
agentId: 'b1',
|
||||
userCommentId: 'comment-with-id-123',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentChat(task)
|
||||
|
||||
expect(mockActivities.agentChatActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
messageContext: expect.objectContaining({
|
||||
id: 'comment-with-id-123',
|
||||
position: { type: 'time', seconds: 5.0 },
|
||||
annotation: true,
|
||||
annotations: [{ type: 'arrow' }],
|
||||
}),
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
import { ApplicationFailure } from '@temporalio/workflow'
|
||||
import type { WorkflowTask } from '@shumai/db'
|
||||
import { executeActivity, getActivities, TaskQueueAgent } from '@shumai/workflow-core'
|
||||
import { AgentChatPromptBuilder } from './agent-chat-prompt-builder'
|
||||
import type {
|
||||
ShumaiMessageContext,
|
||||
ShumaiAssetContext,
|
||||
ShumaiAttachedFileContext,
|
||||
ShumaiMediaPosition,
|
||||
} from '@shumai/dtos'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
|
||||
export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
const {
|
||||
@@ -15,6 +21,7 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
updateTaskUsageActivity,
|
||||
getAgentWorkerQueueActivity,
|
||||
initializeAgentSessionActivity,
|
||||
getAssetPathHierarchyActivity,
|
||||
getAssetPathContextActivity,
|
||||
generateSessionNameActivity,
|
||||
getUserTeamInfoActivity,
|
||||
@@ -47,19 +54,33 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
|
||||
// 1. Get User Comment
|
||||
const userCommentId = payload.agent?.userCommentId
|
||||
let userComment: Awaited<ReturnType<typeof getCommentActivity>> | null = null
|
||||
let prompt = ''
|
||||
let attachmentImageUrls: string[] = []
|
||||
let commentTimestamp: number | undefined
|
||||
let commentAnnotation = false
|
||||
let commentCreatorId: string | undefined
|
||||
|
||||
let commentAnnotations: unknown[] | undefined
|
||||
|
||||
if (userCommentId) {
|
||||
const userComment = await executeActivity(agentWorkerQueue, getCommentActivity, userCommentId)
|
||||
userComment = await executeActivity(agentWorkerQueue, getCommentActivity, userCommentId)
|
||||
if (!userComment) {
|
||||
throw ApplicationFailure.create({ message: 'User comment not found', nonRetryable: true })
|
||||
}
|
||||
prompt = userComment.message || ''
|
||||
commentCreatorId = userComment.creatorId || undefined
|
||||
if (userComment.second !== null && userComment.second !== undefined) {
|
||||
commentTimestamp = userComment.second
|
||||
}
|
||||
if (
|
||||
userComment.annotation &&
|
||||
Array.isArray(userComment.annotation) &&
|
||||
userComment.annotation.length > 0
|
||||
) {
|
||||
commentAnnotation = true
|
||||
commentAnnotations = userComment.annotation
|
||||
}
|
||||
|
||||
// 2. Create Placeholder Comment
|
||||
const placeholder = await executeActivity(agentWorkerQueue, createCommentActivity, {
|
||||
@@ -71,7 +92,7 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
})
|
||||
placeholderCommentId = placeholder.id
|
||||
|
||||
// 5. Prepare Images (Attachments only)
|
||||
// Prepare Images (Attachments only)
|
||||
if (userComment.attachments) {
|
||||
for (const att of userComment.attachments) {
|
||||
const attProxyType = (att.asset?.media as PrismaJson.MediaInfo | null)?.proxyType
|
||||
@@ -83,6 +104,17 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
} else {
|
||||
prompt = payload.agent?.prompt || ''
|
||||
attachmentImageUrls = payload.agent?.imageUrls || []
|
||||
if (payload.agent?.second !== null && payload.agent?.second !== undefined) {
|
||||
commentTimestamp = payload.agent.second
|
||||
}
|
||||
if (
|
||||
payload.agent?.annotations &&
|
||||
Array.isArray(payload.agent.annotations) &&
|
||||
payload.agent.annotations.length > 0
|
||||
) {
|
||||
commentAnnotation = true
|
||||
commentAnnotations = payload.agent.annotations
|
||||
}
|
||||
}
|
||||
|
||||
// 3. Get Asset
|
||||
@@ -118,43 +150,107 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
projectId: payload.projectId,
|
||||
})
|
||||
|
||||
const pathContext = await executeActivity(
|
||||
const pathHierarchy = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getAssetPathContextActivity,
|
||||
getAssetPathHierarchyActivity,
|
||||
task.assetId,
|
||||
)
|
||||
const assetPath = pathHierarchy?.path || ''
|
||||
const ancestors = pathHierarchy?.ancestors || []
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const mediaInfo = asset.media as any
|
||||
const duration = mediaInfo?.duration
|
||||
const totalPages = mediaInfo?.frames || mediaInfo?.metadata?.totalFrames
|
||||
const proxyType =
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(asset.mediaType, asset.name) ||
|
||||
undefined
|
||||
const duration =
|
||||
(proxyType === 'video' || proxyType === 'audio') && typeof mediaInfo?.duration === 'number'
|
||||
? mediaInfo.duration
|
||||
: undefined
|
||||
const totalPages =
|
||||
proxyType === 'pdf' ? mediaInfo?.frames || mediaInfo?.metadata?.totalFrames : undefined
|
||||
const totalFrames =
|
||||
proxyType === 'video' ? mediaInfo?.frames || mediaInfo?.metadata?.totalFrames : undefined
|
||||
|
||||
// Resolve Attached Files Details
|
||||
const attachedFileDetailsList: string[] = []
|
||||
const attachedFiles: ShumaiAttachedFileContext[] = []
|
||||
const attachedAssets: Array<{ id: string; name: string; type: string }> = []
|
||||
if (payload.agent?.attachedFiles) {
|
||||
if (userCommentId && userComment?.attachments) {
|
||||
for (const att of userComment.attachments) {
|
||||
if (att.asset) {
|
||||
const filePath = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getAssetPathContextActivity,
|
||||
att.asset.id,
|
||||
)
|
||||
const attProxyType =
|
||||
(att.asset.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(att.asset.mediaType, att.asset.name) ||
|
||||
undefined
|
||||
attachedFiles.push({
|
||||
id: att.asset.id,
|
||||
name: att.asset.name,
|
||||
type: att.asset.type,
|
||||
mediaType: attProxyType as ShumaiAttachedFileContext['mediaType'],
|
||||
mimeType: att.asset.mediaType || undefined,
|
||||
path: filePath || undefined,
|
||||
url: (att.asset as { url?: string }).url || undefined,
|
||||
})
|
||||
attachedAssets.push({ id: att.asset.id, name: att.asset.name, type: att.asset.type })
|
||||
}
|
||||
}
|
||||
} else if (payload.agent?.attachedFiles) {
|
||||
for (const fileId of payload.agent.attachedFiles) {
|
||||
const file = await executeActivity(agentWorkerQueue, getAssetActivity, fileId)
|
||||
if (file) {
|
||||
const path = await executeActivity(agentWorkerQueue, getAssetPathContextActivity, fileId)
|
||||
attachedFileDetailsList.push(
|
||||
`- Name: ${file.name} (ID: ${file.id}, Type: ${file.type}, Media Type: ${file.mediaType || 'unknown'}, Project ID: ${file.projectId || 'unknown'}, Path: ${path})`,
|
||||
const filePath = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getAssetPathContextActivity,
|
||||
fileId,
|
||||
)
|
||||
const fileProxyType =
|
||||
(file.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(file.mediaType, file.name) ||
|
||||
undefined
|
||||
attachedFiles.push({
|
||||
id: file.id,
|
||||
name: file.name,
|
||||
type: file.type,
|
||||
mediaType: fileProxyType as ShumaiAttachedFileContext['mediaType'],
|
||||
mimeType: file.mediaType || undefined,
|
||||
path: filePath || undefined,
|
||||
url: (file as { url?: string }).url || undefined,
|
||||
})
|
||||
attachedAssets.push({ id: file.id, name: file.name, type: file.type })
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Resolve Referenced Workspace Assets Details
|
||||
const referencedAssetDetailsList: string[] = []
|
||||
const referencedAssets: ShumaiAttachedFileContext[] = []
|
||||
if (payload.agent?.assetIds) {
|
||||
for (const assetId of payload.agent.assetIds) {
|
||||
const referencedAsset = await executeActivity(agentWorkerQueue, getAssetActivity, assetId)
|
||||
if (referencedAsset) {
|
||||
const path = await executeActivity(agentWorkerQueue, getAssetPathContextActivity, assetId)
|
||||
referencedAssetDetailsList.push(
|
||||
`- Name: ${referencedAsset.name} (ID: ${referencedAsset.id}, Type: ${referencedAsset.type}, Media Type: ${referencedAsset.mediaType || 'unknown'}, Project ID: ${referencedAsset.projectId || 'unknown'}, Path: ${path})`,
|
||||
const filePath = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getAssetPathContextActivity,
|
||||
assetId,
|
||||
)
|
||||
const refProxyType =
|
||||
(referencedAsset.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(referencedAsset.mediaType, referencedAsset.name) ||
|
||||
undefined
|
||||
referencedAssets.push({
|
||||
id: referencedAsset.id,
|
||||
name: referencedAsset.name,
|
||||
type: referencedAsset.type,
|
||||
mediaType: refProxyType as ShumaiAttachedFileContext['mediaType'],
|
||||
mimeType: referencedAsset.mediaType || undefined,
|
||||
path: filePath || undefined,
|
||||
url: (referencedAsset as { url?: string }).url || undefined,
|
||||
})
|
||||
attachedAssets.push({
|
||||
id: referencedAsset.id,
|
||||
name: referencedAsset.name,
|
||||
@@ -164,29 +260,59 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
// Resolve User Info
|
||||
const targetUserId = userCommentId ? commentCreatorId : payload.agent?.userId
|
||||
let userInfo: { name: string; role: string } | null = null
|
||||
if (!userCommentId && isNewChat && payload.agent?.userId) {
|
||||
if (targetUserId) {
|
||||
userInfo = await executeActivity(agentWorkerQueue, getUserTeamInfoActivity, {
|
||||
userId: payload.agent.userId,
|
||||
userId: targetUserId,
|
||||
teamId,
|
||||
})
|
||||
}
|
||||
|
||||
const proxyType = (asset.media as PrismaJson.MediaInfo | null)?.proxyType
|
||||
const promptBuilder = new AgentChatPromptBuilder(asset.id)
|
||||
.withContinuation(!isNewChat)
|
||||
.withAssetChanged(payload.agent?.hasAssetChanged)
|
||||
.withPathContext(pathContext)
|
||||
.withAssetDetails(asset.name, asset.mediaType, duration, totalPages, proxyType)
|
||||
.withCommentTimestamp(commentTimestamp)
|
||||
.withAttachedFiles(attachedFileDetailsList)
|
||||
.withReferencedAssets(referencedAssetDetailsList)
|
||||
|
||||
if (userInfo) {
|
||||
promptBuilder.withUserInfo(userInfo.name, userInfo.role)
|
||||
// Build position
|
||||
let mediaPosition: ShumaiMediaPosition | undefined
|
||||
if (commentTimestamp !== undefined && commentTimestamp !== null) {
|
||||
if (proxyType === 'pdf') {
|
||||
mediaPosition = { type: 'page', page: Math.round(commentTimestamp) }
|
||||
} else {
|
||||
mediaPosition = { type: 'time', seconds: commentTimestamp }
|
||||
}
|
||||
}
|
||||
|
||||
const instruction = promptBuilder.build()
|
||||
// Build Current Asset Context
|
||||
const currentAssetContext: ShumaiAssetContext = {
|
||||
id: asset.id,
|
||||
name: asset.name,
|
||||
type: asset.type,
|
||||
mediaType: proxyType as ShumaiAssetContext['mediaType'],
|
||||
mimeType: asset.mediaType || undefined,
|
||||
parentId: asset.parentId || undefined,
|
||||
path: assetPath || undefined,
|
||||
durationSeconds: duration !== undefined ? duration : undefined,
|
||||
totalFrames: totalFrames !== undefined ? totalFrames : undefined,
|
||||
totalPages: totalPages !== undefined ? totalPages : undefined,
|
||||
navigated: payload.agent?.hasAssetChanged === true ? true : undefined,
|
||||
ancestors: ancestors.length > 0 ? ancestors : undefined,
|
||||
}
|
||||
|
||||
// Build structured ShumaiMessageContext
|
||||
const messageContext: ShumaiMessageContext = {
|
||||
...(userCommentId ? { id: userCommentId } : {}),
|
||||
...(userInfo
|
||||
? { user: { id: targetUserId!, name: userInfo.name, role: userInfo.role } }
|
||||
: {}),
|
||||
currentAsset: currentAssetContext,
|
||||
...(mediaPosition ? { position: mediaPosition } : {}),
|
||||
...(commentAnnotation
|
||||
? {
|
||||
annotation: true,
|
||||
annotations: commentAnnotations as ShumaiMessageContext['annotations'],
|
||||
}
|
||||
: {}),
|
||||
...(attachedFiles.length > 0 ? { attachedFiles } : {}),
|
||||
...(referencedAssets.length > 0 ? { referencedAssets } : {}),
|
||||
}
|
||||
|
||||
// 6. Call AI Chat
|
||||
let folderId = ''
|
||||
@@ -205,11 +331,11 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
|
||||
projectId: payload.projectId,
|
||||
folderId,
|
||||
assetId: asset.id,
|
||||
agentsInstruction: instruction,
|
||||
sessionId,
|
||||
userId: payload.agent?.userId,
|
||||
userCommentId: userCommentId || undefined,
|
||||
context,
|
||||
messageContext,
|
||||
attachedAssets,
|
||||
})
|
||||
|
||||
|
||||
@@ -1,140 +0,0 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { agentToolCall } from './agent-tool-call'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import * as workflowUtils from '@shumai/workflow-core'
|
||||
|
||||
vi.mock('@shumai/workflow-core', async () => {
|
||||
const actual = await vi.importActual('@shumai/workflow-core')
|
||||
return {
|
||||
...actual,
|
||||
getActivities: vi.fn(),
|
||||
executeActivity: vi.fn(),
|
||||
}
|
||||
})
|
||||
|
||||
describe('Agent Tool Call Workflow', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mockActivities holds mock functions cast to expected types
|
||||
let mockActivities: any
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
|
||||
mockActivities = {
|
||||
updateTaskStatusActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'updateTaskStatusActivity',
|
||||
}),
|
||||
executeAgentToolActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'executeAgentToolActivity',
|
||||
}),
|
||||
getAgentWorkerQueueActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getAgentWorkerQueueActivity',
|
||||
}),
|
||||
}
|
||||
|
||||
mockActivities.getAgentWorkerQueueActivity.mockResolvedValue('agent_queue')
|
||||
mockActivities.updateTaskStatusActivity.mockResolvedValue({})
|
||||
mockActivities.executeAgentToolActivity.mockResolvedValue({ success: true, count: 42 })
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mockActivities contains vi.fn mock functions which are cast to expected activity proxy types
|
||||
vi.mocked(workflowUtils.getActivities).mockReturnValue(mockActivities as any)
|
||||
vi.mocked(workflowUtils.executeActivity).mockImplementation(async (_queue, act, ...args) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- act is one of the mocked activities
|
||||
return (act as any)(...args)
|
||||
})
|
||||
})
|
||||
|
||||
it('should run agent tool call workflow successfully', async () => {
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'agent_tool_call',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agentToolCall: {
|
||||
toolName: 'list_assets',
|
||||
args: { parent: 'folder-123' },
|
||||
userId: 'user-456',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentToolCall(task)
|
||||
|
||||
// Verify queue discovery
|
||||
expect(mockActivities.getAgentWorkerQueueActivity).toHaveBeenCalled()
|
||||
|
||||
// Verify task processing status
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'processing',
|
||||
})
|
||||
|
||||
// Verify tool execution
|
||||
expect(mockActivities.executeAgentToolActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
toolName: 'list_assets',
|
||||
args: { parent: 'folder-123' },
|
||||
userId: 'user-456',
|
||||
})
|
||||
|
||||
// Verify task completed status with output
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'completed',
|
||||
output: { success: true, count: 42 },
|
||||
})
|
||||
})
|
||||
|
||||
it('should throw if payload or agentToolCall is missing', async () => {
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'agent_tool_call',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
},
|
||||
})
|
||||
|
||||
await expect(agentToolCall(task)).rejects.toThrow('Task payload or agentToolCall is missing')
|
||||
|
||||
// Verify status updated to failed
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'failed',
|
||||
output: { error: 'Task payload or agentToolCall is missing' },
|
||||
})
|
||||
})
|
||||
|
||||
it('should handle tool execution failures by updating task to failed and throwing', async () => {
|
||||
mockActivities.executeAgentToolActivity.mockRejectedValue(new Error('Authz failure'))
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'agent_tool_call',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agentToolCall: {
|
||||
toolName: 'create_folder',
|
||||
args: { parent: 'folder-123', name: 'new-folder' },
|
||||
userId: 'user-456',
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await expect(agentToolCall(task)).rejects.toThrow('Authz failure')
|
||||
|
||||
// Verify task status failed
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'failed',
|
||||
output: { error: 'Authz failure' },
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,60 +0,0 @@
|
||||
import { ApplicationFailure } from '@temporalio/workflow'
|
||||
import type { WorkflowTask } from '@shumai/db'
|
||||
import { getActivities, executeActivity, TaskQueueAgent } from '@shumai/workflow-core'
|
||||
|
||||
export async function agentToolCall(task: WorkflowTask): Promise<void> {
|
||||
const { updateTaskStatusActivity, executeAgentToolActivity, getAgentWorkerQueueActivity } =
|
||||
getActivities()
|
||||
|
||||
let agentWorkerQueue = ''
|
||||
|
||||
try {
|
||||
// 0. Discover queue
|
||||
agentWorkerQueue = await executeActivity(TaskQueueAgent, getAgentWorkerQueueActivity)
|
||||
|
||||
// Update status to processing
|
||||
await executeActivity(agentWorkerQueue, updateTaskStatusActivity, {
|
||||
taskId: task.id,
|
||||
status: 'processing',
|
||||
})
|
||||
|
||||
const payload = task.payload
|
||||
if (!payload || !payload.agentToolCall) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'Task payload or agentToolCall is missing',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const { toolName, args, userId } = payload.agentToolCall
|
||||
|
||||
// Execute the agent activity on specific queue
|
||||
const result = await executeActivity(agentWorkerQueue, executeAgentToolActivity, {
|
||||
taskId: task.id,
|
||||
toolName,
|
||||
args,
|
||||
userId,
|
||||
})
|
||||
|
||||
// Update status to completed with output
|
||||
await executeActivity(agentWorkerQueue, updateTaskStatusActivity, {
|
||||
taskId: task.id,
|
||||
status: 'completed',
|
||||
output: result,
|
||||
})
|
||||
} catch (err) {
|
||||
console.error(`AgentToolCall failed for task ${task.id}:`, err)
|
||||
|
||||
// Update status to failed
|
||||
if (agentWorkerQueue) {
|
||||
await executeActivity(agentWorkerQueue, updateTaskStatusActivity, {
|
||||
taskId: task.id,
|
||||
status: 'failed',
|
||||
output: { error: err instanceof Error ? err.message : String(err) },
|
||||
})
|
||||
}
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
export const agentToolCallWorkflow = agentToolCall
|
||||
@@ -1,18 +1,18 @@
|
||||
{
|
||||
"name": "@shumai/api",
|
||||
"version": "0.3.9",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
"types": "./src/index.ts",
|
||||
"dependencies": {
|
||||
"@hono/zod-validator": "0.7.6",
|
||||
"@shumai/core": "workspace:*",
|
||||
"@shumai/db": "workspace:*",
|
||||
"@shumai/dtos": "workspace:*",
|
||||
"hono": "4.12.23",
|
||||
"@hono/zod-validator": "0.7.6",
|
||||
"zod": "4.4.3",
|
||||
"hono": "4.13.5",
|
||||
"pino": "10.3.1",
|
||||
"ulid": "3.0.2"
|
||||
"ulid": "3.0.2",
|
||||
"zod": "4.5.4"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -148,6 +148,48 @@ describe('Chat API', () => {
|
||||
)
|
||||
})
|
||||
|
||||
it('accepts chat request with annotations, second, and attachmentIds', async () => {
|
||||
vi.mocked(chatService.startOrContinueChat).mockResolvedValue({
|
||||
sessionId: 'session1',
|
||||
taskId: 'task1',
|
||||
})
|
||||
|
||||
vi.mocked(chatService.getNewSessionMessages).mockResolvedValue({
|
||||
messages: [],
|
||||
lastEntryId: null,
|
||||
})
|
||||
|
||||
vi.mocked(chatService.getChatWorkflowStatus).mockResolvedValue({
|
||||
status: 'completed',
|
||||
output: {},
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/team1/chat', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
agentId: 'agent1',
|
||||
textPrompt: 'Review annotation',
|
||||
attachedFiles: ['att1'],
|
||||
annotations: [{ type: 'rectangle', x: 10, y: 20 }],
|
||||
second: 5.5,
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
expect(chatService.startOrContinueChat).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ id: 'user1' }),
|
||||
'team1',
|
||||
expect.objectContaining({
|
||||
agentId: 'agent1',
|
||||
textPrompt: 'Review annotation',
|
||||
attachedFiles: ['att1'],
|
||||
annotations: [{ type: 'rectangle', x: 10, y: 20 }],
|
||||
second: 5.5,
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('sends ping keep-alive SSE events when there are no new messages', async () => {
|
||||
vi.mocked(chatService.startOrContinueChat).mockResolvedValue({
|
||||
sessionId: 'session1',
|
||||
|
||||
@@ -188,6 +188,46 @@ describe('folder api', () => {
|
||||
type: ResourceType.Asset,
|
||||
id: 'test-id',
|
||||
})
|
||||
expect(assetService.listChildren).toHaveBeenCalledWith({
|
||||
assetId: 'test-id',
|
||||
assetType: 'folder',
|
||||
})
|
||||
})
|
||||
|
||||
it('GET /folders/:folderId/children forwards pagination parameters', async () => {
|
||||
vi.mocked(assetService.listChildren).mockResolvedValue({
|
||||
data: [
|
||||
{
|
||||
id: 'child-id-2',
|
||||
name: 'child-folder-2',
|
||||
sizeByte: 0,
|
||||
fileCount: 0,
|
||||
type: 'folder',
|
||||
status: 'active',
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
},
|
||||
],
|
||||
pageInfo: { total: 30, cursor: 'cursorNextToken' },
|
||||
})
|
||||
|
||||
const app = new Hono().use('*', authMiddleware).route('/', folderRoute)
|
||||
const res = await app.request(
|
||||
'/folders/test-id/children?assetType=folder&first=20&after=cursorToken123&prefix=sub',
|
||||
)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(json.pageInfo.cursor).toBe('cursorNextToken')
|
||||
|
||||
expect(assetService.listChildren).toHaveBeenCalledWith({
|
||||
assetId: 'test-id',
|
||||
assetType: 'folder',
|
||||
first: 20,
|
||||
after: 'cursorToken123',
|
||||
prefix: 'sub',
|
||||
})
|
||||
})
|
||||
|
||||
it('DELETE /folders', async () => {
|
||||
|
||||
@@ -120,12 +120,8 @@ const route = new Hono<{ Variables: { user: User } }>()
|
||||
})
|
||||
|
||||
const resp = await assetService.listChildren({
|
||||
...req,
|
||||
assetId: folderId,
|
||||
assetType: req.assetType,
|
||||
projectId: req.projectId,
|
||||
showDeleted: req.showDeleted,
|
||||
sort: req.sort,
|
||||
order: req.order,
|
||||
})
|
||||
return c.json(resp)
|
||||
})
|
||||
|
||||
@@ -25,6 +25,8 @@ import quotaRoute from './quota'
|
||||
import teamRoute from './team'
|
||||
import uploadRoute, { localUploadRoute } from './upload'
|
||||
import versionStackRoute from './versionStack'
|
||||
import kanbanRoute from './kanban'
|
||||
import mediaGenerationRoute from './media-generation'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
@@ -67,6 +69,8 @@ const apiRoute = new Hono<{ Variables: { user: User } }>()
|
||||
.route('/', mcpRoute)
|
||||
.route('/', watermarkTemplateRoute)
|
||||
.route('/', quotaRoute)
|
||||
.route('/', kanbanRoute)
|
||||
.route('/', mediaGenerationRoute)
|
||||
|
||||
app.route('/files', s3Route)
|
||||
|
||||
|
||||
@@ -0,0 +1,130 @@
|
||||
import { zValidator } from '@hono/zod-validator'
|
||||
import { Hono } from 'hono'
|
||||
import { kanbanService } from '@shumai/core/src/kanban/kanban'
|
||||
import { notificationService } from '@shumai/core/src/notification/notification'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import {
|
||||
authzService,
|
||||
Permission,
|
||||
ResourceType,
|
||||
resolveEffectiveRole,
|
||||
} from '@shumai/core/src/authz/authz'
|
||||
import { createKanbanCommentSchema, postAttachmentRequestSchema, AuditAction } from '@shumai/dtos'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
const route = new Hono<{ Variables: { user: User } }>()
|
||||
.post(
|
||||
'/teams/:teamId/kanban/attachments',
|
||||
zValidator('json', postAttachmentRequestSchema),
|
||||
async (c) => {
|
||||
const { teamId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const attachment = await kanbanService.createAttachment(teamId, req)
|
||||
return c.json(attachment)
|
||||
},
|
||||
)
|
||||
.post(
|
||||
'/teams/:teamId/kanban/tasks/:taskId/comments',
|
||||
zValidator('json', createKanbanCommentSchema),
|
||||
async (c) => {
|
||||
const { teamId, taskId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const comment = await kanbanService.addComment(taskId, user.id, req.body, req.attachments)
|
||||
const task = await kanbanService.getTask(taskId)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_comment_create,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
projectId: task.projectId ?? undefined,
|
||||
itemId: comment.id,
|
||||
})
|
||||
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_comment_created',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: taskId,
|
||||
stakeholderIds: [task.creator?.id, task.assignee?.id, task.reporter?.id],
|
||||
commentMessage: req.body,
|
||||
})
|
||||
|
||||
return c.json(comment)
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/kanban/tasks/:taskId/comments', async (c) => {
|
||||
const { taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const comments = await kanbanService.listComments(taskId)
|
||||
return c.json({ data: comments })
|
||||
})
|
||||
.delete('/teams/:teamId/kanban/tasks/:taskId/comments/:commentId', async (c) => {
|
||||
const { teamId, taskId, commentId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const userRole = await resolveEffectiveRole(teamId, undefined, user.id)
|
||||
const task = await kanbanService.getTask(taskId)
|
||||
await kanbanService.deleteComment(taskId, commentId, user.id, userRole)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_comment_delete,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
projectId: task.projectId ?? undefined,
|
||||
itemId: commentId,
|
||||
})
|
||||
|
||||
return c.json({ success: true })
|
||||
})
|
||||
.get('/teams/:teamId/kanban/tasks/:taskId/events', async (c) => {
|
||||
const { taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const events = await kanbanService.listEvents(taskId)
|
||||
return c.json({ data: events })
|
||||
})
|
||||
|
||||
export default route
|
||||
@@ -0,0 +1,131 @@
|
||||
import { zValidator } from '@hono/zod-validator'
|
||||
import { Hono } from 'hono'
|
||||
import { kanbanService } from '@shumai/core/src/kanban/kanban'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import {
|
||||
authzService,
|
||||
Permission,
|
||||
ResourceType,
|
||||
resolveEffectiveRole,
|
||||
} from '@shumai/core/src/authz/authz'
|
||||
import {
|
||||
createKanbanGoalSchema,
|
||||
updateKanbanGoalSchema,
|
||||
listKanbanGoalsRequestSchema,
|
||||
AuditAction,
|
||||
} from '@shumai/dtos'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
const route = new Hono<{ Variables: { user: User } }>()
|
||||
.post('/teams/:teamId/kanban/goals', zValidator('json', createKanbanGoalSchema), async (c) => {
|
||||
const { teamId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const role = await resolveEffectiveRole(teamId, undefined, user.id)
|
||||
const goal = await kanbanService.createGoal(teamId, req, user.id, role)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_goal_create,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
itemId: goal.id,
|
||||
})
|
||||
|
||||
return c.json(goal)
|
||||
})
|
||||
.get(
|
||||
'/teams/:teamId/kanban/goals',
|
||||
zValidator('query', listKanbanGoalsRequestSchema),
|
||||
async (c) => {
|
||||
const { teamId } = c.req.param()
|
||||
const req = c.req.valid('query')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const goals = await kanbanService.listGoals(teamId, req)
|
||||
return c.json({ data: goals })
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/kanban/goals/:goalId', async (c) => {
|
||||
const { goalId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanGoal,
|
||||
id: goalId,
|
||||
})
|
||||
|
||||
const goal = await kanbanService.getGoal(goalId)
|
||||
return c.json(goal)
|
||||
})
|
||||
.patch(
|
||||
'/teams/:teamId/kanban/goals/:goalId',
|
||||
zValidator('json', updateKanbanGoalSchema),
|
||||
async (c) => {
|
||||
const { teamId, goalId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.KanbanGoal,
|
||||
id: goalId,
|
||||
})
|
||||
|
||||
const role = await resolveEffectiveRole(teamId, undefined, user.id)
|
||||
const goal = await kanbanService.updateGoal(goalId, req, role)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_goal_update,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
itemId: goalId,
|
||||
})
|
||||
|
||||
return c.json(goal)
|
||||
},
|
||||
)
|
||||
.delete('/teams/:teamId/kanban/goals/:goalId', async (c) => {
|
||||
const { teamId, goalId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.KanbanGoal,
|
||||
id: goalId,
|
||||
})
|
||||
|
||||
const role = await resolveEffectiveRole(teamId, undefined, user.id)
|
||||
await kanbanService.deleteGoal(goalId, role)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_goal_delete,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
itemId: goalId,
|
||||
})
|
||||
|
||||
return c.json({ ok: true })
|
||||
})
|
||||
|
||||
export default route
|
||||
@@ -0,0 +1,14 @@
|
||||
import { Hono } from 'hono'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
import goalsRoute from './goals'
|
||||
import tasksRoute from './tasks'
|
||||
import commentsRoute from './comments'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
const kanbanRoute = new Hono<{ Variables: { user: User } }>()
|
||||
.route('/', goalsRoute)
|
||||
.route('/', tasksRoute)
|
||||
.route('/', commentsRoute)
|
||||
|
||||
export default kanbanRoute
|
||||
@@ -0,0 +1,689 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { Hono, type Context, type Next } from 'hono'
|
||||
import { kanbanService } from '@shumai/core/src/kanban/kanban'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import { notificationService } from '@shumai/core/src/notification/notification'
|
||||
import { KanbanTaskStatus, KanbanTaskPriority } from '@shumai/db/enums'
|
||||
import kanbanRoute from './index'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz', () => ({
|
||||
authzService: {
|
||||
hasPermission: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
resolveEffectiveRole: vi.fn().mockResolvedValue('owner'),
|
||||
Permission: {
|
||||
Read: 'Read',
|
||||
Edit: 'Edit',
|
||||
Admin: 'Admin',
|
||||
},
|
||||
ResourceType: {
|
||||
Team: 'team',
|
||||
Project: 'project',
|
||||
KanbanGoal: 'kanbanGoal',
|
||||
KanbanTask: 'kanbanTask',
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
|
||||
auditLogService: {
|
||||
logAction: vi.fn().mockResolvedValue({}),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/notification/notification', () => ({
|
||||
notificationService: {
|
||||
notifyKanbanTaskEvent: vi.fn().mockResolvedValue(undefined),
|
||||
create: vi.fn().mockResolvedValue(undefined),
|
||||
},
|
||||
}))
|
||||
|
||||
describe('Kanban API Routes', () => {
|
||||
const teamId = 'team-1'
|
||||
const taskId = 'task-1'
|
||||
const goalId = 'goal-1'
|
||||
|
||||
const authMiddleware = async (c: Context, next: Next) => {
|
||||
c.set('user', { id: 'user-1', name: 'Test User' })
|
||||
await next()
|
||||
}
|
||||
|
||||
let app: Hono
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
vi.mocked(auditLogService.logAction).mockResolvedValue({} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(notificationService.notifyKanbanTaskEvent).mockResolvedValue(undefined as any) // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||
app = new Hono()
|
||||
app.use('*', authMiddleware)
|
||||
app.route('/', kanbanRoute)
|
||||
})
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Goals Endpoints
|
||||
// --------------------------------------------------------------------------
|
||||
describe('Goals Endpoints', () => {
|
||||
it('POST /teams/:teamId/kanban/goals', async () => {
|
||||
const mockCreate = vi.spyOn(kanbanService, 'createGoal').mockResolvedValue({
|
||||
id: goalId,
|
||||
title: 'New Goal',
|
||||
description: 'Goal description',
|
||||
teamId,
|
||||
creatorId: 'user-1',
|
||||
taskCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/goals`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ title: 'New Goal', description: 'Goal description' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.id).toBe(goalId)
|
||||
expect(mockCreate).toHaveBeenCalledWith(
|
||||
teamId,
|
||||
{ title: 'New Goal', description: 'Goal description' },
|
||||
'user-1',
|
||||
'owner',
|
||||
)
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/goals', async () => {
|
||||
const mockList = vi.spyOn(kanbanService, 'listGoals').mockResolvedValue([
|
||||
{
|
||||
id: goalId,
|
||||
title: 'Goal 1',
|
||||
teamId,
|
||||
creatorId: 'user-1',
|
||||
taskCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
},
|
||||
])
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/goals`)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(mockList).toHaveBeenCalledWith(teamId, expect.any(Object))
|
||||
})
|
||||
|
||||
it('PATCH /teams/:teamId/kanban/goals/:goalId', async () => {
|
||||
const mockUpdate = vi.spyOn(kanbanService, 'updateGoal').mockResolvedValue({
|
||||
id: goalId,
|
||||
title: 'Updated Goal',
|
||||
teamId,
|
||||
creatorId: 'user-1',
|
||||
taskCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/goals/${goalId}`, {
|
||||
method: 'PATCH',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ title: 'Updated Goal' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.title).toBe('Updated Goal')
|
||||
expect(mockUpdate).toHaveBeenCalledWith(goalId, { title: 'Updated Goal' }, 'owner')
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/kanban/goals/:goalId', async () => {
|
||||
const mockDelete = vi.spyOn(kanbanService, 'deleteGoal').mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/goals/${goalId}`, {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.ok).toBe(true)
|
||||
expect(mockDelete).toHaveBeenCalledWith(goalId, 'owner')
|
||||
})
|
||||
})
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Tasks Endpoints
|
||||
// --------------------------------------------------------------------------
|
||||
describe('Tasks Endpoints', () => {
|
||||
it('POST /teams/:teamId/kanban/tasks', async () => {
|
||||
const mockCreate = vi.spyOn(kanbanService, 'createTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'New Task',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ title: 'New Task', isAgentTask: false }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.id).toBe(taskId)
|
||||
expect(mockCreate).toHaveBeenCalledWith(teamId, expect.any(Object), 'user-1', 'owner')
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/tasks (with isAgentTask and goal filters)', async () => {
|
||||
const mockList = vi.spyOn(kanbanService, 'listTasks').mockResolvedValue({
|
||||
data: [
|
||||
{
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
},
|
||||
],
|
||||
pageInfo: { total: 1 },
|
||||
})
|
||||
|
||||
const res = await app.request(
|
||||
`/teams/${teamId}/kanban/tasks?isAgentTask=false&status=READY&goalId=goal-1`,
|
||||
)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(mockList).toHaveBeenCalledWith(
|
||||
teamId,
|
||||
expect.objectContaining({
|
||||
isAgentTask: false,
|
||||
status: 'READY',
|
||||
goalId: 'goal-1',
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/tasks/:taskId', async () => {
|
||||
const mockGet = vi.spyOn(kanbanService, 'getTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
dependencies: [],
|
||||
dependents: [],
|
||||
assets: [],
|
||||
comments: [],
|
||||
events: [],
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}`)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.id).toBe(taskId)
|
||||
expect(mockGet).toHaveBeenCalledWith(taskId)
|
||||
})
|
||||
|
||||
it('PATCH /teams/:teamId/kanban/tasks/:taskId', async () => {
|
||||
vi.spyOn(kanbanService, 'getTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Old Task Title',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
dependencies: [],
|
||||
dependents: [],
|
||||
assets: [],
|
||||
comments: [],
|
||||
events: [],
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
const mockUpdate = vi.spyOn(kanbanService, 'updateTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Updated Task Title',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.HIGH,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}`, {
|
||||
method: 'PATCH',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ priority: 'HIGH', status: 'DONE', reason: 'All done' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
expect(mockUpdate).toHaveBeenCalledWith(
|
||||
taskId,
|
||||
{ priority: 'HIGH', status: 'DONE', reason: 'All done' },
|
||||
'user-1',
|
||||
'owner',
|
||||
)
|
||||
})
|
||||
|
||||
it('PATCH /teams/:teamId/kanban/tasks/:taskId with beforeIndex and afterIndex', async () => {
|
||||
vi.spyOn(kanbanService, 'getTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
sortIndex: 'a0V',
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
dependencies: [],
|
||||
dependents: [],
|
||||
assets: [],
|
||||
comments: [],
|
||||
events: [],
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
const mockUpdate = vi.spyOn(kanbanService, 'updateTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
sortIndex: 'a0V',
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}`, {
|
||||
method: 'PATCH',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ status: 'READY', beforeIndex: 'a1', afterIndex: 'a0' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
expect(mockUpdate).toHaveBeenCalledWith(
|
||||
taskId,
|
||||
{ status: 'READY', beforeIndex: 'a1', afterIndex: 'a0' },
|
||||
'user-1',
|
||||
'owner',
|
||||
)
|
||||
})
|
||||
|
||||
it('PATCH /teams/:teamId/kanban/tasks/:taskId with fromStatus for CAS', async () => {
|
||||
vi.spyOn(kanbanService, 'getTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.TODO,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
dependencies: [],
|
||||
dependents: [],
|
||||
assets: [],
|
||||
comments: [],
|
||||
events: [],
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
const mockUpdate = vi.spyOn(kanbanService, 'updateTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task 1',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.IN_PROGRESS,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}`, {
|
||||
method: 'PATCH',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ fromStatus: 'TODO', status: 'IN_PROGRESS' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
expect(mockUpdate).toHaveBeenCalledWith(
|
||||
taskId,
|
||||
{ fromStatus: 'TODO', status: 'IN_PROGRESS' },
|
||||
'user-1',
|
||||
'owner',
|
||||
)
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/kanban/tasks/:taskId', async () => {
|
||||
vi.spyOn(kanbanService, 'getTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task to delete',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
dependencies: [],
|
||||
dependents: [],
|
||||
assets: [],
|
||||
comments: [],
|
||||
events: [],
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
const mockDelete = vi.spyOn(kanbanService, 'deleteTask').mockResolvedValue({
|
||||
id: taskId,
|
||||
title: 'Task to delete',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 0,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}`, {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockDelete).toHaveBeenCalledWith(taskId, 'user-1', 'owner')
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/tasks/:taskId/assets', async () => {
|
||||
const mockListTaskAssets = vi.spyOn(kanbanService, 'listTaskAssets').mockResolvedValue([
|
||||
{
|
||||
id: 'asset-1',
|
||||
name: 'Video.mp4',
|
||||
type: 'file',
|
||||
proxyType: 'video',
|
||||
thumbnailUrl: 'http://example.com/thumb.jpg',
|
||||
path: '/Project/Video.mp4',
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
createdAt: new Date().toISOString(),
|
||||
},
|
||||
])
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/assets`)
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json).toHaveLength(1)
|
||||
expect(json[0].name).toBe('Video.mp4')
|
||||
expect(mockListTaskAssets).toHaveBeenCalledWith(taskId)
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/kanban/tasks/:taskId/assets', async () => {
|
||||
const mockLinkAssets = vi.spyOn(kanbanService, 'linkAssets').mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/assets`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ assetIds: ['asset-1', 'asset-2'] }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockLinkAssets).toHaveBeenCalledWith(teamId, taskId, ['asset-1', 'asset-2'])
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/kanban/tasks/:taskId/assets/:assetId', async () => {
|
||||
const mockUnlinkAsset = vi.spyOn(kanbanService, 'unlinkAsset').mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/assets/asset-1`, {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockUnlinkAsset).toHaveBeenCalledWith(teamId, taskId, 'asset-1')
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/assets/:assetId/tasks', async () => {
|
||||
const mockListTasksForAsset = vi.spyOn(kanbanService, 'listTasksForAsset').mockResolvedValue([
|
||||
{
|
||||
id: taskId,
|
||||
title: 'Task linked to asset',
|
||||
isAgentTask: false,
|
||||
status: KanbanTaskStatus.READY,
|
||||
priority: KanbanTaskPriority.MEDIUM,
|
||||
teamId,
|
||||
creator: { id: 'user-1', name: 'User 1' },
|
||||
commentCount: 0,
|
||||
dependencyCount: 0,
|
||||
dependentCount: 0,
|
||||
assetCount: 1,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
},
|
||||
])
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/assets/asset-1/tasks`)
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.total).toBe(1)
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(mockListTasksForAsset).toHaveBeenCalledWith(teamId, 'asset-1')
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/kanban/assets/:assetId/tasks', async () => {
|
||||
const mockLinkAsset = vi.spyOn(kanbanService, 'linkAsset').mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/assets/asset-1/tasks`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ taskId }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockLinkAsset).toHaveBeenCalledWith(teamId, taskId, 'asset-1')
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/kanban/assets/:assetId/tasks/:taskId', async () => {
|
||||
const mockUnlinkAsset = vi.spyOn(kanbanService, 'unlinkAsset').mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/assets/asset-1/tasks/${taskId}`, {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockUnlinkAsset).toHaveBeenCalledWith(teamId, taskId, 'asset-1')
|
||||
})
|
||||
})
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Comments, Attachments & Events
|
||||
// --------------------------------------------------------------------------
|
||||
describe('Comments, Attachments and Events Endpoints', () => {
|
||||
it('POST /teams/:teamId/kanban/attachments', async () => {
|
||||
const mockAttachment = vi.spyOn(kanbanService, 'createAttachment').mockResolvedValue({
|
||||
id: 'att-1',
|
||||
name: 'test.png',
|
||||
key: 'kanban/attachments/test.png',
|
||||
sizeByte: 1024,
|
||||
uploadUrl: 'http://s3/upload',
|
||||
proxyType: 'image',
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/attachments`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ fileName: 'test.png', size: 1024, contentType: 'image/png' }),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.id).toBe('att-1')
|
||||
expect(mockAttachment).toHaveBeenCalledWith(teamId, {
|
||||
fileName: 'test.png',
|
||||
size: 1024,
|
||||
contentType: 'image/png',
|
||||
})
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/kanban/tasks/:taskId/comments', async () => {
|
||||
const mockAdd = vi.spyOn(kanbanService, 'addComment').mockResolvedValue({
|
||||
id: 'c-1',
|
||||
taskId,
|
||||
author: { id: 'user-1', name: 'User 1' },
|
||||
body: 'Here is a note',
|
||||
attachments: [],
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/comments`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
body: 'Here is a note',
|
||||
attachments: [
|
||||
{
|
||||
id: 'att-1',
|
||||
name: 'test.png',
|
||||
key: 'key-1',
|
||||
sizeByte: 1024,
|
||||
proxyType: 'image',
|
||||
},
|
||||
],
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
expect(mockAdd).toHaveBeenCalledWith(taskId, 'user-1', 'Here is a note', [
|
||||
{
|
||||
id: 'att-1',
|
||||
name: 'test.png',
|
||||
key: 'key-1',
|
||||
sizeByte: 1024,
|
||||
proxyType: 'image',
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/kanban/tasks/:taskId/comments/:commentId', async () => {
|
||||
const mockDelete = vi.spyOn(kanbanService, 'deleteComment').mockResolvedValue()
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/comments/c-1`, {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.success).toBe(true)
|
||||
expect(mockDelete).toHaveBeenCalledWith(taskId, 'c-1', 'user-1', 'owner')
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/tasks/:taskId/comments', async () => {
|
||||
const mockList = vi.spyOn(kanbanService, 'listComments').mockResolvedValue([
|
||||
{
|
||||
id: 'c-1',
|
||||
taskId,
|
||||
author: { id: 'user-1', name: 'User 1' },
|
||||
body: 'Note',
|
||||
attachments: [],
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
},
|
||||
])
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/comments`)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(mockList).toHaveBeenCalledWith(taskId)
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/kanban/tasks/:taskId/events', async () => {
|
||||
const mockEvents = vi.spyOn(kanbanService, 'listEvents').mockResolvedValue([
|
||||
{
|
||||
id: 'e-1',
|
||||
taskId,
|
||||
actor: { id: 'user-1', name: 'User 1' },
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
type: 'CREATED' as any,
|
||||
createdAt: new Date().toISOString(),
|
||||
},
|
||||
])
|
||||
|
||||
const res = await app.request(`/teams/${teamId}/kanban/tasks/${taskId}/events`)
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json()
|
||||
expect(json.data).toHaveLength(1)
|
||||
expect(mockEvents).toHaveBeenCalledWith(taskId)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,331 @@
|
||||
import { zValidator } from '@hono/zod-validator'
|
||||
import { Hono } from 'hono'
|
||||
import { kanbanService } from '@shumai/core/src/kanban/kanban'
|
||||
import { notificationService } from '@shumai/core/src/notification/notification'
|
||||
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
|
||||
import {
|
||||
authzService,
|
||||
Permission,
|
||||
ResourceType,
|
||||
resolveEffectiveRole,
|
||||
} from '@shumai/core/src/authz/authz'
|
||||
import {
|
||||
createKanbanTaskSchema,
|
||||
updateKanbanTaskSchema,
|
||||
listKanbanTasksRequestSchema,
|
||||
linkTaskAssetsSchema,
|
||||
linkAssetToTaskSchema,
|
||||
AuditAction,
|
||||
} from '@shumai/dtos'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
import { HTTPException } from 'hono/http-exception'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
const route = new Hono<{ Variables: { user: User } }>()
|
||||
.post('/teams/:teamId/kanban/tasks', zValidator('json', createKanbanTaskSchema), async (c) => {
|
||||
const { teamId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const role = await resolveEffectiveRole(teamId, undefined, user.id)
|
||||
if (!role) {
|
||||
throw new HTTPException(403, { message: 'User is not a member of the team' })
|
||||
}
|
||||
|
||||
const task = await kanbanService.createTask(teamId, req, user.id, role)
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_task_create,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
projectId: task.projectId ?? undefined,
|
||||
itemId: task.id,
|
||||
})
|
||||
|
||||
if (req.assigneeId && req.assigneeId !== user.id) {
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_assigned',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: task.id,
|
||||
targetUserId: req.assigneeId,
|
||||
})
|
||||
}
|
||||
|
||||
if (req.reporterId && req.reporterId !== user.id && req.reporterId !== req.assigneeId) {
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_created',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: task.id,
|
||||
targetUserId: req.reporterId,
|
||||
})
|
||||
}
|
||||
|
||||
return c.json(task)
|
||||
})
|
||||
.get(
|
||||
'/teams/:teamId/kanban/tasks',
|
||||
zValidator('query', listKanbanTasksRequestSchema),
|
||||
async (c) => {
|
||||
const { teamId } = c.req.param()
|
||||
const req = c.req.valid('query')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const result = await kanbanService.listTasks(teamId, req)
|
||||
return c.json(result)
|
||||
},
|
||||
)
|
||||
.get('/teams/:teamId/kanban/tasks/:taskId', async (c) => {
|
||||
const { taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const task = await kanbanService.getTask(taskId)
|
||||
return c.json(task)
|
||||
})
|
||||
.patch(
|
||||
'/teams/:teamId/kanban/tasks/:taskId',
|
||||
zValidator('json', updateKanbanTaskSchema),
|
||||
async (c) => {
|
||||
const { teamId, taskId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const existing = await kanbanService.getTask(taskId)
|
||||
const role = await resolveEffectiveRole(teamId, existing.projectId ?? undefined, user.id)
|
||||
const task = await kanbanService.updateTask(taskId, req, user.id, role)
|
||||
|
||||
const hasMeaningfulChanges =
|
||||
req.title !== undefined ||
|
||||
req.description !== undefined ||
|
||||
req.priority !== undefined ||
|
||||
req.startDate !== undefined ||
|
||||
req.dueDate !== undefined ||
|
||||
req.goalId !== undefined ||
|
||||
req.assigneeId !== undefined ||
|
||||
req.reporterId !== undefined ||
|
||||
req.targetFolderId !== undefined ||
|
||||
(req.status !== undefined && req.status !== existing.status)
|
||||
|
||||
if (hasMeaningfulChanges) {
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_task_update,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
projectId: task.projectId ?? undefined,
|
||||
itemId: task.id,
|
||||
})
|
||||
}
|
||||
|
||||
if (req.status !== undefined && req.status !== existing.status) {
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_status_updated',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: task.id,
|
||||
stakeholderIds: [task.creator?.id, task.assignee?.id, task.reporter?.id],
|
||||
})
|
||||
}
|
||||
|
||||
if (
|
||||
req.assigneeId !== undefined &&
|
||||
req.assigneeId !== existing.assignee?.id &&
|
||||
req.assigneeId !== null &&
|
||||
req.assigneeId !== user.id
|
||||
) {
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_assigned',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: task.id,
|
||||
targetUserId: req.assigneeId,
|
||||
})
|
||||
}
|
||||
|
||||
const hasOtherDetailsChanged =
|
||||
req.title !== undefined ||
|
||||
req.description !== undefined ||
|
||||
req.priority !== undefined ||
|
||||
req.startDate !== undefined ||
|
||||
req.dueDate !== undefined ||
|
||||
req.goalId !== undefined ||
|
||||
req.reporterId !== undefined ||
|
||||
req.targetFolderId !== undefined
|
||||
|
||||
if (hasOtherDetailsChanged && req.status === undefined) {
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_updated',
|
||||
teamId,
|
||||
projectId: task.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: task.id,
|
||||
stakeholderIds: [task.creator?.id, task.assignee?.id, task.reporter?.id],
|
||||
})
|
||||
}
|
||||
|
||||
return c.json(task)
|
||||
},
|
||||
)
|
||||
.delete('/teams/:teamId/kanban/tasks/:taskId', async (c) => {
|
||||
const { teamId, taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const existing = await kanbanService.getTask(taskId)
|
||||
const role = await resolveEffectiveRole(teamId, existing.projectId ?? undefined, user.id)
|
||||
|
||||
notificationService.notifyKanbanTaskEvent({
|
||||
type: 'kanban_task_deleted',
|
||||
teamId,
|
||||
projectId: existing.projectId,
|
||||
creatorId: user.id,
|
||||
kanbanTaskId: taskId,
|
||||
stakeholderIds: [existing.creator?.id, existing.assignee?.id, existing.reporter?.id],
|
||||
})
|
||||
|
||||
await auditLogService.logAction({
|
||||
action: AuditAction.kanban_task_delete,
|
||||
teamId,
|
||||
userId: user.id,
|
||||
projectId: existing.projectId ?? undefined,
|
||||
itemId: taskId,
|
||||
})
|
||||
|
||||
await kanbanService.deleteTask(taskId, user.id, role)
|
||||
return c.json({ success: true })
|
||||
})
|
||||
.get('/teams/:teamId/kanban/tasks/:taskId/assets', async (c) => {
|
||||
const { taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
const assets = await kanbanService.listTaskAssets(taskId)
|
||||
return c.json(assets)
|
||||
})
|
||||
.post(
|
||||
'/teams/:teamId/kanban/tasks/:taskId/assets',
|
||||
zValidator('json', linkTaskAssetsSchema),
|
||||
async (c) => {
|
||||
const { teamId, taskId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
await kanbanService.linkAssets(teamId, taskId, req.assetIds)
|
||||
return c.json({ success: true })
|
||||
},
|
||||
)
|
||||
.delete('/teams/:teamId/kanban/tasks/:taskId/assets/:assetId', async (c) => {
|
||||
const { teamId, taskId, assetId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
await kanbanService.unlinkAsset(teamId, taskId, assetId)
|
||||
return c.json({ success: true })
|
||||
})
|
||||
.get('/teams/:teamId/kanban/assets/:assetId/tasks', async (c) => {
|
||||
const { teamId, assetId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Read,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const tasks = await kanbanService.listTasksForAsset(teamId, assetId)
|
||||
return c.json({ data: tasks, total: tasks.length })
|
||||
})
|
||||
.post(
|
||||
'/teams/:teamId/kanban/assets/:assetId/tasks',
|
||||
zValidator('json', linkAssetToTaskSchema),
|
||||
async (c) => {
|
||||
const { teamId, assetId } = c.req.param()
|
||||
const req = c.req.valid('json')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: req.taskId,
|
||||
})
|
||||
|
||||
await kanbanService.linkAsset(teamId, req.taskId, assetId)
|
||||
return c.json({ success: true })
|
||||
},
|
||||
)
|
||||
.delete('/teams/:teamId/kanban/assets/:assetId/tasks/:taskId', async (c) => {
|
||||
const { teamId, assetId, taskId } = c.req.param()
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Edit,
|
||||
type: ResourceType.KanbanTask,
|
||||
id: taskId,
|
||||
})
|
||||
|
||||
await kanbanService.unlinkAsset(teamId, taskId, assetId)
|
||||
return c.json({ success: true })
|
||||
})
|
||||
|
||||
export default route
|
||||
@@ -0,0 +1,136 @@
|
||||
import { describe, expect, it, vi, beforeEach } from 'vitest'
|
||||
import { Hono } from 'hono'
|
||||
import mediaGenerationRoute from './media-generation'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/core/src/authz/authz')
|
||||
vi.mock('@shumai/core/src/media-generation/media-generation')
|
||||
|
||||
describe('media-generation api', () => {
|
||||
const app = new Hono<{ Variables: { user: { id: string; name: string } } }>()
|
||||
.use('*', async (c, next) => {
|
||||
c.set('user', { id: 'user1', name: 'Test User' })
|
||||
await next()
|
||||
})
|
||||
.route('/', mediaGenerationRoute)
|
||||
|
||||
beforeEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
|
||||
})
|
||||
|
||||
it('GET /teams/:teamId/media-generation returns settings', async () => {
|
||||
vi.mocked(mediaGenerationService.getSettings).mockResolvedValue({
|
||||
providers: [
|
||||
{
|
||||
provider: 'openai',
|
||||
defaultEnvKey: 'OPENAI_API_KEY',
|
||||
apiKeyConfigured: true,
|
||||
status: 'configured_env',
|
||||
supportedTypes: ['image'],
|
||||
},
|
||||
],
|
||||
enabledModels: [],
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/media-generation')
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.providers).toHaveLength(1)
|
||||
expect(data.providers[0].provider).toBe('openai')
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: expect.anything(),
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
})
|
||||
expect(mediaGenerationService.getSettings).toHaveBeenCalledWith('t1')
|
||||
})
|
||||
|
||||
it('PUT /teams/:teamId/media-generation/providers/:provider updates api key and models', async () => {
|
||||
vi.mocked(mediaGenerationService.updateProvider).mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request('/teams/t1/media-generation/providers/openai', {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
apiKey: 'sk-new-key',
|
||||
models: [{ type: 'image', modelId: 'dall-e-3', name: 'DALL-E 3' }],
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.success).toBe(true)
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: expect.anything(),
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
})
|
||||
expect(mediaGenerationService.updateProvider).toHaveBeenCalledWith('t1', 'openai', {
|
||||
apiKey: 'sk-new-key',
|
||||
models: [{ type: 'image', modelId: 'dall-e-3', name: 'DALL-E 3' }],
|
||||
})
|
||||
})
|
||||
|
||||
it('POST /teams/:teamId/media-generation/models adds an enabled model', async () => {
|
||||
vi.mocked(mediaGenerationService.addEnabledModel).mockResolvedValue({
|
||||
id: 'm1',
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3',
|
||||
createdAt: new Date().toISOString(),
|
||||
})
|
||||
|
||||
const res = await app.request('/teams/t1/media-generation/models', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3',
|
||||
}),
|
||||
})
|
||||
|
||||
expect(res.status).toBe(201)
|
||||
const data = await res.json()
|
||||
expect(data.id).toBe('m1')
|
||||
expect(data.modelId).toBe('dall-e-3')
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: expect.anything(),
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
})
|
||||
expect(mediaGenerationService.addEnabledModel).toHaveBeenCalledWith('t1', {
|
||||
type: 'image',
|
||||
provider: 'openai',
|
||||
modelId: 'dall-e-3',
|
||||
name: 'DALL-E 3',
|
||||
})
|
||||
})
|
||||
|
||||
it('DELETE /teams/:teamId/media-generation/models/:modelId removes an enabled model', async () => {
|
||||
vi.mocked(mediaGenerationService.removeEnabledModel).mockResolvedValue(undefined)
|
||||
|
||||
const res = await app.request('/teams/t1/media-generation/models/m1', {
|
||||
method: 'DELETE',
|
||||
})
|
||||
|
||||
expect(res.status).toBe(200)
|
||||
const data = await res.json()
|
||||
expect(data.success).toBe(true)
|
||||
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
||||
user: expect.anything(),
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: 't1',
|
||||
})
|
||||
expect(mediaGenerationService.removeEnabledModel).toHaveBeenCalledWith('t1', 'm1')
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,97 @@
|
||||
import { zValidator } from '@hono/zod-validator'
|
||||
import { Hono } from 'hono'
|
||||
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
|
||||
import { mediaGenerationService } from '@shumai/core/src/media-generation/media-generation'
|
||||
import {
|
||||
createEnabledMediaModelSchema,
|
||||
getCuratedMediaModelsQuerySchema,
|
||||
updateMediaProviderApiKeySchema,
|
||||
} from '@shumai/dtos'
|
||||
import type { Prisma } from '@shumai/db'
|
||||
|
||||
type User = Prisma.UserGetPayload<Record<string, never>>
|
||||
|
||||
const route = new Hono<{ Variables: { user: User } }>()
|
||||
.get('/teams/:teamId/media-generation', async (c) => {
|
||||
const teamId = c.req.param('teamId')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const settings = await mediaGenerationService.getSettings(teamId)
|
||||
return c.json(settings)
|
||||
})
|
||||
|
||||
.put(
|
||||
'/teams/:teamId/media-generation/providers/:provider',
|
||||
zValidator('json', updateMediaProviderApiKeySchema),
|
||||
async (c) => {
|
||||
const teamId = c.req.param('teamId')
|
||||
const provider = c.req.param('provider')
|
||||
const user = c.get('user')
|
||||
const body = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
await mediaGenerationService.updateProvider(teamId, provider, body)
|
||||
return c.json({ success: true })
|
||||
},
|
||||
)
|
||||
|
||||
.post(
|
||||
'/teams/:teamId/media-generation/models',
|
||||
zValidator('json', createEnabledMediaModelSchema),
|
||||
async (c) => {
|
||||
const teamId = c.req.param('teamId')
|
||||
const user = c.get('user')
|
||||
const body = c.req.valid('json')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
const model = await mediaGenerationService.addEnabledModel(teamId, body)
|
||||
return c.json(model, 201)
|
||||
},
|
||||
)
|
||||
|
||||
.get(
|
||||
'/teams/:teamId/media-generation/models/curated',
|
||||
zValidator('query', getCuratedMediaModelsQuerySchema),
|
||||
async (c) => {
|
||||
const { provider, type } = c.req.valid('query')
|
||||
const models = mediaGenerationService.getCuratedModels(provider, type)
|
||||
return c.json(models)
|
||||
},
|
||||
)
|
||||
|
||||
.delete('/teams/:teamId/media-generation/models/:modelId', async (c) => {
|
||||
const teamId = c.req.param('teamId')
|
||||
const modelId = c.req.param('modelId')
|
||||
const user = c.get('user')
|
||||
|
||||
await authzService.hasPermission({
|
||||
user,
|
||||
permission: Permission.Admin,
|
||||
type: ResourceType.Team,
|
||||
id: teamId,
|
||||
})
|
||||
|
||||
await mediaGenerationService.removeEnabledModel(teamId, modelId)
|
||||
return c.json({ success: true })
|
||||
})
|
||||
|
||||
export default route
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user