mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-20 23:38:41 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
70b81355c2 | ||
|
|
1d552e4ae4 | ||
|
|
b37b2172e7 | ||
|
|
941000d277 | ||
|
|
4a61e87a27 | ||
|
|
04fd571bd9 | ||
|
|
3a05332cd6 | ||
|
|
51f63fc9e4 | ||
|
|
b35c824a27 | ||
|
|
f62df9555a | ||
|
|
67b767f1e8 | ||
|
|
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 | ||
|
|
4c0fd29b7f | ||
|
|
ffef67be8f | ||
|
|
4d100bf542 | ||
|
|
8a75d015a1 | ||
|
|
f806272c06 | ||
|
|
4935eeff28 | ||
|
|
eed0264b9c | ||
|
|
dd82daf65c | ||
|
|
55d9596835 | ||
|
|
cb1c1c502b | ||
|
|
6d4f62d6f6 | ||
|
|
43808216e6 | ||
|
|
f66bb7af73 | ||
|
|
ae86d56a7d | ||
|
|
1cee103b1c | ||
|
|
3c3b6880e4 | ||
|
|
0b84402c83 | ||
|
|
61a61abc7c | ||
|
|
fc878775c2 | ||
|
|
7acf736300 | ||
|
|
9d50301a43 | ||
|
|
7f185ca23c | ||
|
|
94582c9001 | ||
|
|
41b73feeab |
+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
|
||||
|
||||
|
||||
@@ -54,5 +54,6 @@ jobs:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
context: .
|
||||
push: true
|
||||
provenance: false
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
+11
-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
|
||||
|
||||
@@ -8,6 +8,7 @@ WORKDIR /app
|
||||
COPY package.json bun.lock ./
|
||||
COPY --parents packages/*/package.json ./
|
||||
COPY --parents apps/*/package.json ./
|
||||
COPY patches/ ./patches/
|
||||
|
||||
# Install dependencies (including devDependencies for build tools)
|
||||
RUN bun install --frozen-lockfile
|
||||
@@ -17,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
|
||||
|
||||
@@ -24,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/
|
||||
@@ -79,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>
|
||||
|
||||

|
||||
@@ -37,6 +44,7 @@ But Shumai goes beyond being a Frame.io alternative. With modern models like GPT
|
||||
* **Isolated Sandbox Execution**: Run agent-submitted scripts safely in a sandboxed environment.
|
||||
* **AI Metadata Autofill**: Automatically fill in custom metadata for new assets.
|
||||
* **Semantic Search**: Find assets by visual or conceptual meaning using vector embeddings (Gemini Embedding 2).
|
||||
* **Resource Quotas**: Set usage limits on AI tokens, costs, and tool execution per member, role, or team-wide, with real-time tracking.
|
||||
|
||||
Here is a short demo video showing what the Shumai agent can do:
|
||||
|
||||
@@ -44,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]
|
||||
@@ -301,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
|
||||
```
|
||||
|
||||
+42
-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>
|
||||
|
||||

|
||||
@@ -38,11 +44,19 @@ Shumai 是一个开源的 Frame.io 替代方案,专为创意团队打造,让
|
||||
* **沙箱隔离执行**:Agent 生成的脚本会在隔离环境里运行,更安全。
|
||||
* **AI 自动补全元数据**:新素材上传后,系统可以自动帮你补一些元数据。
|
||||
* **语义搜索**:支持按画面内容或语义找素材,底层用的是向量 embedding(Gemini Embedding 2)。
|
||||
* **资源配额**:支持按成员、角色或全团队对 AI Token、成本和工具调用设置使用上限与实时用量监控。
|
||||
|
||||
下面是一个简短的 demo 视频,展示了 Shumai Agent 能做什么:
|
||||
|
||||
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 封面图,作为文件列表中的预览图。此外:
|
||||
>
|
||||
@@ -56,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/),然后按照以下步骤操作:
|
||||
|
||||
@@ -326,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.6",
|
||||
"version": "0.4.4",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -4,6 +4,7 @@ loadEnvConfig(process.cwd(), process.env.NODE_ENV !== 'production')
|
||||
import { workflowService } from '@shumai/workflow-core'
|
||||
import { TaskQueueAgent } from '@shumai/workflow-core'
|
||||
import { initAgentWorkflows } from '@shumai/agent'
|
||||
import { sandboxService } from '@shumai/core'
|
||||
import { handleDaemonCommands } from '@shumai/core/src/utils/daemon'
|
||||
|
||||
if (process.argv.includes('--check')) {
|
||||
@@ -14,6 +15,9 @@ if (process.argv.includes('--check')) {
|
||||
async function run() {
|
||||
// Initialize workflows and activities
|
||||
initAgentWorkflows()
|
||||
await sandboxService.ensureInitialized().catch((err) => {
|
||||
console.error('Failed to eagerly initialize sandbox in agent worker:', err)
|
||||
})
|
||||
|
||||
console.log('🚀 Starting Agent Worker...')
|
||||
|
||||
|
||||
@@ -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.6",
|
||||
"version": "0.4.4",
|
||||
"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.6",
|
||||
"version": "0.4.4",
|
||||
"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 |
|
||||
@@ -63,6 +65,7 @@ apps/web/e2e/
|
||||
| Owner invites a member via invite link and the invitee joins | `tests/team/invite-member.spec.ts` |
|
||||
| Owner removes a member via the members dialog; the membership is deleted from the DB | `tests/team/remove-member.spec.ts` |
|
||||
| Owner changes a team member role in the members dialog and permissions update | `tests/team/change-member-role.spec.ts` |
|
||||
| Owner manages resource quotas in settings and resets usage from the dashboard | `tests/team/quotas-settings.spec.ts` |
|
||||
|
||||
### project
|
||||
| Test | File |
|
||||
@@ -80,12 +83,17 @@ apps/web/e2e/
|
||||
| Owner drags a file into a folder and a folder into another folder | `tests/project/move-folder-file.spec.ts` |
|
||||
| Owner drags a file onto a file to create a version stack | `tests/project/version-stack-create.spec.ts` |
|
||||
| Owner drags a file onto a version stack to add a new version | `tests/project/version-stack-add-version.spec.ts` |
|
||||
| Owner manages version stack: removes version from 3-version stack | `tests/project/version-stack-manage.spec.ts` |
|
||||
| Owner removes version from 2-version stack which dissolves into standalone files | `tests/project/version-stack-manage.spec.ts` |
|
||||
| Dissolving a shared version stack renders the remaining standalone file name on the share page | `tests/project/version-stack-manage.spec.ts` |
|
||||
| Moving a shared file into a shared version stack leaves only 1 stack card on the share page | `tests/project/version-stack-manage.spec.ts` |
|
||||
| Owner searches the file list by an English name keyword | `tests/project/search-file-list.spec.ts` |
|
||||
| Owner searches the file list by Chinese, Japanese, and Korean name keywords | `tests/project/search-file-list.spec.ts` |
|
||||
| Owner searches the file list with a keyword and a filter condition | `tests/project/search-file-list.spec.ts` |
|
||||
| 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 |
|
||||
|
||||
+16
-11
@@ -21,19 +21,23 @@ const currentDir = path.dirname(fileURLToPath(import.meta.url))
|
||||
const envPath = path.resolve(currentDir, '.env.e2e')
|
||||
const fixturesDir = path.resolve(currentDir, '../../../packages/e2e/fixtures')
|
||||
|
||||
// Load E2E environment variables if present
|
||||
if (fs.existsSync(envPath)) {
|
||||
const content = fs.readFileSync(envPath, 'utf8')
|
||||
content.split('\n').forEach((line) => {
|
||||
const parts = line.split('=')
|
||||
if (parts.length >= 2) {
|
||||
const key = parts[0].trim()
|
||||
const value = parts.slice(1).join('=').trim()
|
||||
process.env[key] = value
|
||||
}
|
||||
})
|
||||
function loadEnv() {
|
||||
if (fs.existsSync(envPath)) {
|
||||
const content = fs.readFileSync(envPath, 'utf8')
|
||||
content.split('\n').forEach((line) => {
|
||||
const parts = line.split('=')
|
||||
if (parts.length >= 2) {
|
||||
const key = parts[0].trim()
|
||||
const value = parts.slice(1).join('=').trim()
|
||||
process.env[key] = value
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Load E2E environment variables if present
|
||||
loadEnv()
|
||||
|
||||
export interface OwnerFixture {
|
||||
/** Page opened in a browser context logged in as the team owner. */
|
||||
page: Page
|
||||
@@ -104,6 +108,7 @@ export const test = base.extend<{
|
||||
prisma: [
|
||||
// eslint-disable-next-line no-empty-pattern
|
||||
async ({}, use) => {
|
||||
loadEnv()
|
||||
const connectionString = process.env.DATABASE_URL
|
||||
const pool = new Pool({ connectionString })
|
||||
const adapter = new PrismaPg(pool)
|
||||
|
||||
@@ -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)
|
||||
})
|
||||
@@ -0,0 +1,233 @@
|
||||
import { expect, test } from '../../fixtures'
|
||||
import { seedFile } from '../../helpers/assets'
|
||||
import { dragCard } from '../../helpers/dnd'
|
||||
import { apiAddAssetsToShare, apiCreateShare, fileCard } from '../../helpers/files'
|
||||
|
||||
test('owner manages versions: removes a version from a 3-version stack', async ({
|
||||
project,
|
||||
prisma,
|
||||
}) => {
|
||||
const { page, projectId, rootFolderId } = project
|
||||
|
||||
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-mng-a-${Date.now()}`)
|
||||
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-mng-b-${Date.now()}`)
|
||||
const fileC = await seedFile(prisma, projectId, rootFolderId, `e2e-mng-c-${Date.now()}`)
|
||||
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
await expect(fileCard(page, fileA.name)).toBeVisible()
|
||||
await expect(fileCard(page, fileB.name)).toBeVisible()
|
||||
await expect(fileCard(page, fileC.name)).toBeVisible()
|
||||
|
||||
// 1. Create a 3-version stack: B on A -> stack (v2), then C on stack -> stack (v3)
|
||||
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
|
||||
await expect(page.getByText('v2', { exact: true })).toBeVisible()
|
||||
|
||||
await dragCard(page, fileCard(page, fileC.name), fileCard(page, fileB.name))
|
||||
await expect(page.getByText('v3', { exact: true })).toBeVisible()
|
||||
|
||||
const stack = await prisma.asset.findFirstOrThrow({
|
||||
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
|
||||
})
|
||||
expect(stack.fileCount).toBe(3)
|
||||
|
||||
// 2. Navigate to file viewer for the stack
|
||||
await page.goto(`/projects/${projectId}/files/${stack.id}`)
|
||||
|
||||
// 3. Open breadcrumb menu and click "Manage versions..."
|
||||
// Click on the asset name / badge dropdown trigger
|
||||
await page.getByRole('button', { name: new RegExp(fileC.name) }).click()
|
||||
// Hover or click on Versions sub-menu trigger
|
||||
await page.getByRole('menuitem', { name: 'Versions', exact: true }).hover()
|
||||
// Click "Manage versions..."
|
||||
await page.getByRole('button', { name: /manage versions$/i }).click()
|
||||
|
||||
// 4. Verify Manage versions dialog is visible with all 3 versions
|
||||
const dialog = page.getByRole('dialog')
|
||||
await expect(dialog).toBeVisible()
|
||||
await expect(dialog.getByText('Manage versions')).toBeVisible()
|
||||
await expect(dialog.getByText(fileA.name)).toBeVisible()
|
||||
await expect(dialog.getByText(fileB.name)).toBeVisible()
|
||||
await expect(dialog.getByText(fileC.name)).toBeVisible()
|
||||
|
||||
// 5. Remove fileB from stack: hover its row and click Remove from stack
|
||||
const rowB = dialog.locator('div.group', { hasText: fileB.name })
|
||||
await rowB.hover()
|
||||
const moreButton = rowB.getByRole('button', { name: 'More options' })
|
||||
await moreButton.click()
|
||||
await page.getByRole('menuitem', { name: /remove from stack/i }).click()
|
||||
|
||||
// 6. Verify toast and that fileB is removed from dialog
|
||||
await expect(page.getByText(/version removed from stack/i)).toBeVisible()
|
||||
await expect(dialog.getByText(fileB.name)).not.toBeVisible()
|
||||
await expect(dialog.getByText(fileA.name)).toBeVisible()
|
||||
await expect(dialog.getByText(fileC.name)).toBeVisible()
|
||||
|
||||
// DB: stack now has 2 versions (fileA and fileC), and fileB is standalone in root folder
|
||||
await expect
|
||||
.poll(async () => {
|
||||
const s = await prisma.asset.findUnique({ where: { id: stack.id } })
|
||||
return s?.fileCount
|
||||
})
|
||||
.toBe(2)
|
||||
|
||||
const updatedFileB = await prisma.asset.findUnique({ where: { id: fileB.id } })
|
||||
expect(updatedFileB?.parentId).toBe(rootFolderId)
|
||||
})
|
||||
|
||||
test('owner removes version from 2-version stack dissolving the stack into standalone files', async ({
|
||||
project,
|
||||
prisma,
|
||||
}) => {
|
||||
const { page, projectId, rootFolderId } = project
|
||||
|
||||
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-dis-a-${Date.now()}`)
|
||||
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-dis-b-${Date.now()}`)
|
||||
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
|
||||
await expect(page.getByText('v2', { exact: true })).toBeVisible()
|
||||
|
||||
const stack = await prisma.asset.findFirstOrThrow({
|
||||
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
|
||||
})
|
||||
|
||||
// Open file view
|
||||
await page.goto(`/projects/${projectId}/files/${stack.id}`)
|
||||
|
||||
// Open breadcrumb menu and click "Manage versions..."
|
||||
await page.getByRole('button', { name: new RegExp(fileB.name) }).click()
|
||||
await page.getByRole('menuitem', { name: 'Versions', exact: true }).hover()
|
||||
await page.getByRole('button', { name: /manage versions$/i }).click()
|
||||
|
||||
const dialog = page.getByRole('dialog')
|
||||
await expect(dialog).toBeVisible()
|
||||
|
||||
// Remove fileB -> stack dissolves -> only fileA remains
|
||||
const rowB = dialog.locator('div.group', { hasText: fileB.name })
|
||||
await rowB.hover()
|
||||
const moreButton = rowB.getByRole('button', { name: 'More options' })
|
||||
await moreButton.click()
|
||||
await page.getByRole('menuitem', { name: /remove from stack/i }).click()
|
||||
|
||||
// Dialog should close automatically when stack dissolves
|
||||
await expect(dialog).not.toBeVisible()
|
||||
|
||||
// DB: stack asset is deleted
|
||||
await expect
|
||||
.poll(async () => {
|
||||
const s = await prisma.asset.findUnique({ where: { id: stack.id } })
|
||||
return s === null
|
||||
})
|
||||
.toBe(true)
|
||||
|
||||
// Both fileA and fileB are now standalone files in rootFolder
|
||||
const updatedFileA = await prisma.asset.findUnique({ where: { id: fileA.id } })
|
||||
const updatedFileB = await prisma.asset.findUnique({ where: { id: fileB.id } })
|
||||
expect(updatedFileA?.parentId).toBe(rootFolderId)
|
||||
expect(updatedFileB?.parentId).toBe(rootFolderId)
|
||||
})
|
||||
|
||||
test('dissolving a shared version stack renders the remaining standalone file name on the share page', async ({
|
||||
project,
|
||||
prisma,
|
||||
}) => {
|
||||
const { page, projectId, rootFolderId } = project
|
||||
|
||||
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-shd-a-${Date.now()}`)
|
||||
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-shd-b-${Date.now()}`)
|
||||
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
|
||||
await expect(page.getByText('v2', { exact: true })).toBeVisible()
|
||||
|
||||
const stack = await prisma.asset.findFirstOrThrow({
|
||||
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
|
||||
})
|
||||
|
||||
// Share the version stack
|
||||
await fileCard(page, fileB.name).click({ button: 'right' })
|
||||
await page.getByRole('menuitem', { name: 'Create Share Link' }).click()
|
||||
const toast = page.locator('[data-sonner-toast]').filter({ hasText: 'Share link created' })
|
||||
await expect(toast).toBeVisible()
|
||||
|
||||
const share = await prisma.shareLink.findFirstOrThrow({
|
||||
where: { projectId },
|
||||
orderBy: { createdAt: 'desc' },
|
||||
})
|
||||
|
||||
// Open file viewer for the stack
|
||||
await page.goto(`/projects/${projectId}/files/${stack.id}`)
|
||||
|
||||
// Open breadcrumb menu and click "Manage versions"
|
||||
await page.getByRole('button', { name: new RegExp(fileB.name) }).click()
|
||||
await page.getByRole('menuitem', { name: 'Versions', exact: true }).hover()
|
||||
await page.getByRole('button', { name: /manage versions$/i }).click()
|
||||
|
||||
const dialog = page.getByRole('dialog')
|
||||
await expect(dialog).toBeVisible()
|
||||
|
||||
// Remove fileB -> stack dissolves -> only fileA remains
|
||||
const rowB = dialog.locator('div.group', { hasText: fileB.name })
|
||||
await rowB.hover()
|
||||
const moreButton = rowB.getByRole('button', { name: 'More options' })
|
||||
await moreButton.click()
|
||||
await page.getByRole('menuitem', { name: /remove from stack/i }).click()
|
||||
|
||||
await expect(dialog).not.toBeVisible()
|
||||
|
||||
// Navigate to public share page: verify fileA is displayed with its non-empty name
|
||||
await page.goto(`/share/${share.id}`)
|
||||
await expect(fileCard(page, fileA.name)).toBeVisible()
|
||||
await expect(fileCard(page, fileB.name)).not.toBeVisible()
|
||||
})
|
||||
|
||||
test('moving a shared file into a shared version stack leaves only 1 stack card on the share page', async ({
|
||||
project,
|
||||
prisma,
|
||||
}) => {
|
||||
const { page, projectId, rootFolderId } = project
|
||||
|
||||
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-mvsh-a-${Date.now()}`)
|
||||
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-mvsh-b-${Date.now()}`)
|
||||
const fileC = await seedFile(prisma, projectId, rootFolderId, `e2e-mvsh-c-${Date.now()}`)
|
||||
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
|
||||
// 1. Create a version stack from file B and file A (stack has v2, displays file B)
|
||||
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
|
||||
await expect(page.getByText('v2', { exact: true })).toBeVisible()
|
||||
|
||||
const stack = await prisma.asset.findFirstOrThrow({
|
||||
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
|
||||
})
|
||||
|
||||
// 2. Create a share link and add both stack AB and file C to it
|
||||
const share = await apiCreateShare(project.context.request, projectId, `Test Share ${Date.now()}`)
|
||||
await apiAddAssetsToShare(project.context.request, share.id, [stack.id, fileC.id])
|
||||
|
||||
// Verify initial share page has both stack and file C
|
||||
await page.goto(`/share/${share.id}`)
|
||||
await expect(fileCard(page, fileB.name)).toBeVisible()
|
||||
await expect(fileCard(page, fileC.name)).toBeVisible()
|
||||
|
||||
// 3. In project page, drop file C onto stack card (displays file B)
|
||||
await page.goto(`/projects/${projectId}`)
|
||||
await dragCard(page, fileCard(page, fileC.name), fileCard(page, fileB.name))
|
||||
await expect(page.getByText('v3', { exact: true })).toBeVisible()
|
||||
|
||||
// 4. Return to public share page: now only 1 card exists (the stack showing file C with v3)
|
||||
await page.goto(`/share/${share.id}`)
|
||||
await expect(page.getByText('v3', { exact: true })).toBeVisible()
|
||||
await expect(fileCard(page, fileC.name)).toBeVisible()
|
||||
await expect(fileCard(page, fileB.name)).not.toBeVisible()
|
||||
|
||||
// DB: share rootFolder fileCount is 1 and exactly 1 symlink exists
|
||||
const symlinks = await prisma.asset.findMany({
|
||||
where: { parentId: share.rootFolderId, type: 'symlink' },
|
||||
})
|
||||
expect(symlinks).toHaveLength(1)
|
||||
expect(symlinks[0].targetId).toBe(stack.id)
|
||||
|
||||
const updatedShareRoot = await prisma.asset.findUnique({ where: { id: share.rootFolderId } })
|
||||
expect(updatedShareRoot?.fileCount).toBe(1)
|
||||
})
|
||||
@@ -0,0 +1,126 @@
|
||||
import { expect, test } from '../../fixtures'
|
||||
|
||||
test('owner manages resource quotas in settings and resets usage from the dashboard', async ({
|
||||
owner,
|
||||
prisma,
|
||||
}) => {
|
||||
const { page, teamId, email } = owner
|
||||
|
||||
// 1. Navigate to team settings
|
||||
await page.goto(`/teams/${teamId}/settings`)
|
||||
|
||||
// 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()
|
||||
|
||||
// 4. Open Create Quota Dialog
|
||||
await page
|
||||
.getByRole('button', { name: /Add Quota|添加配额/i })
|
||||
.first()
|
||||
.click()
|
||||
await expect(page.getByText(/Create Quota Rule|创建配额规则/i)).toBeVisible()
|
||||
|
||||
// 5. Fill and submit new quota rule
|
||||
await page.fill('#quota-limit', '50000')
|
||||
await page.getByRole('button', { name: /^(Create|创建)$/i }).click()
|
||||
|
||||
// 6. Verify quota rule card appears in the list
|
||||
await expect(page.getByText(/50,000 tokens|50000 tokens/i)).toBeVisible()
|
||||
await expect(page.getByText(/Each Member|每个成员/i)).toBeVisible()
|
||||
|
||||
// Verify in database
|
||||
const createdRule = await prisma.quotaRule.findFirst({
|
||||
where: { teamId, limit: 50000 },
|
||||
})
|
||||
expect(createdRule).not.toBeNull()
|
||||
expect(createdRule?.enabled).toBe(true)
|
||||
|
||||
// 7. Usage is now monitored from the dashboard, not the settings rule card.
|
||||
await expect(page.getByRole('button', { name: /View Usage|查看使用量/i })).not.toBeVisible()
|
||||
|
||||
// 8. Toggle quota rule switch
|
||||
await page.getByRole('switch').click()
|
||||
await expect(page.getByRole('switch')).not.toBeChecked()
|
||||
const disabledRule = await prisma.quotaRule.findFirst({
|
||||
where: { id: createdRule?.id },
|
||||
})
|
||||
expect(disabledRule?.enabled).toBe(false)
|
||||
|
||||
// Toggle back on
|
||||
await page.getByRole('switch').click()
|
||||
await expect(page.getByRole('switch')).toBeChecked()
|
||||
|
||||
// 9. Open Edit Dialog by clicking the quota card
|
||||
await page.getByText(/50,000 tokens|50000 tokens/i).click()
|
||||
await expect(page.getByText(/Edit Quota Rule|编辑配额规则/i)).toBeVisible()
|
||||
await expect(page.getByRole('button', { name: /Each Member|每个成员/i })).toBeDisabled()
|
||||
await expect(page.locator('#quota-resource')).toBeDisabled()
|
||||
|
||||
// 10. Update limit
|
||||
await page.fill('#quota-limit', '75000')
|
||||
await page.getByRole('button', { name: /^(Save|保存)$/i }).click()
|
||||
|
||||
// Verify updated limit in UI and DB
|
||||
await expect(page.getByText(/75,000 tokens|75000 tokens/i)).toBeVisible()
|
||||
const updatedRule = await prisma.quotaRule.findFirst({
|
||||
where: { id: createdRule?.id },
|
||||
})
|
||||
expect(updatedRule?.limit).toBe(75000)
|
||||
|
||||
// 11. Verify quota usage and reset it from the dashboard
|
||||
const ownerUser = await prisma.user.findUnique({ where: { email } })
|
||||
expect(ownerUser).not.toBeNull()
|
||||
await prisma.quotaRecord.create({
|
||||
data: {
|
||||
ruleId: createdRule?.id as string,
|
||||
teamId,
|
||||
userId: ownerUser?.id,
|
||||
periodStart: new Date(),
|
||||
periodEnd: new Date(Date.now() + 24 * 60 * 60 * 1000),
|
||||
consumed: 100,
|
||||
},
|
||||
})
|
||||
await page.goto(`/teams/${teamId}/dashboard`)
|
||||
await page.getByRole('button', { name: /Quotas|配额/i }).click()
|
||||
await expect(
|
||||
page.getByText(/Monitor live quota usage|在仪表盘中监控实时配额使用情况/),
|
||||
).toBeVisible()
|
||||
|
||||
const quotaRuleButton = page.getByRole('button', { name: /Expand quota rule|展开配额规则/i })
|
||||
await quotaRuleButton.click()
|
||||
await expect(page.getByText(/^100 \/ 75,000 tokens$|^100 \/ 75000 tokens$/i)).toBeVisible()
|
||||
await page.getByRole('button', { name: /Reset Usage|重置使用量/i }).click()
|
||||
await expect(page.getByRole('alertdialog')).toBeVisible()
|
||||
await page.getByRole('button', { name: /Confirm|确认/i }).click()
|
||||
await expect(page.getByText(/^0 \/ 75,000 tokens$|^0 \/ 75000 tokens$/i)).toBeVisible()
|
||||
|
||||
const resetRecord = await prisma.quotaRecord.findFirst({
|
||||
where: { ruleId: createdRule?.id, userId: ownerUser?.id },
|
||||
})
|
||||
expect(resetRecord?.consumed).toBe(0)
|
||||
|
||||
// 12. Delete quota rule from settings
|
||||
await page.goto(`/teams/${teamId}/settings`)
|
||||
await page.getByRole('button', { name: /Quotas|配额/i }).click()
|
||||
await page.getByRole('button', { name: 'Quota actions' }).first().click()
|
||||
await page.getByRole('menuitem', { name: /Delete|删除/i }).click()
|
||||
await page
|
||||
.getByRole('button', { name: /Delete|删除/i })
|
||||
.last()
|
||||
.click()
|
||||
|
||||
// Verify empty state returns
|
||||
await expect(page.getByText(/No resource quotas configured|暂未配置资源配额/i)).toBeVisible()
|
||||
const deletedRule = await prisma.quotaRule.findFirst({
|
||||
where: { id: createdRule?.id },
|
||||
})
|
||||
expect(deletedRule).toBeNull()
|
||||
})
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@shumai/web-app",
|
||||
"version": "0.3.6",
|
||||
"version": "0.4.4",
|
||||
"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,21 +11,52 @@ 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'
|
||||
import { sandboxService } from '@shumai/core'
|
||||
|
||||
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()
|
||||
initTranscodeWorkflows()
|
||||
await sandboxService.ensureInitialized().catch((err) => {
|
||||
console.error('Failed to eagerly initialize sandbox in web app:', err)
|
||||
})
|
||||
|
||||
// Start services
|
||||
await metadataService.syncSystemFields().catch(console.error)
|
||||
await migrateLegacyAgentAvatars().catch(console.error)
|
||||
assetService.startCleanupJob()
|
||||
workflowService.start()
|
||||
if (process.env.WORKFLOW_EXECUTOR === 'temporal') {
|
||||
|
||||
+8
-2
@@ -42,7 +42,9 @@
|
||||
"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",
|
||||
"using-shumai/agent-tools",
|
||||
"using-shumai/mcp-servers",
|
||||
@@ -50,8 +52,12 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Media Transcoding Settings",
|
||||
"pages": ["using-shumai/transcode-settings"]
|
||||
"group": "Team 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 |
@@ -25,7 +25,7 @@ To protect your workspace environments and sensitive data, the sandbox enforces
|
||||
|
||||
## Domain Whitelisting
|
||||
|
||||
By default, sandboxed scripts cannot make network requests to the internet. Team Owners must explicitly authorize external APIs by managing domain access:
|
||||
By default, Network Sandbox is **disabled** (allowing all outbound network requests). Team Owners can toggle Network Sandbox **ON** in Sandbox Settings to enforce strict domain whitelisting:
|
||||
|
||||
### Allowed Domains
|
||||
|
||||
|
||||
@@ -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,53 @@
|
||||
---
|
||||
title: AGENTS.md Context & Instructions
|
||||
description: Provide hierarchical, folder-specific instructions and context to AI agents.
|
||||
---
|
||||
|
||||
In addition to global agent system prompts and skills, Shumai allows you to define project-level and folder-level instructions using **`AGENTS.md`**.
|
||||
|
||||
When an AI agent (such as a Chat Agent or Autofill Agent) operates within a project or folder, Shumai automatically loads the corresponding `AGENTS.md` files to provide context, operational rules, and project-specific knowledge.
|
||||
|
||||
---
|
||||
|
||||
## Hierarchical Traversal & Inheritance
|
||||
|
||||
Shumai uses a hierarchical context model for `AGENTS.md`:
|
||||
|
||||
- **Upward Traversal**: When an agent works on a file or folder, Shumai traverses the folder tree upwards from the current folder all the way to the **project root level**.
|
||||
- **Combined Context**: All `AGENTS.md` files found along this path are loaded into the agent's context in order (from the project root down to the current folder).
|
||||
- **Layered Rules**: This lets you define broad, project-wide rules and guidelines at the project root `AGENTS.md`, while adding specific rules, vocabulary, or autofill hints in nested subfolder `AGENTS.md` files.
|
||||
|
||||
---
|
||||
|
||||
## What to Include in AGENTS.md
|
||||
|
||||
You can use `AGENTS.md` to define any instructions you want the agent to follow when working in that folder or project:
|
||||
|
||||
- **Project & Folder Overview**: Describe what assets are stored in the folder and how they relate to the broader project.
|
||||
- **Agent Behavioral Rules**: Specify guardrails, tone, required formats, or things the agent should and shouldn't do when answering queries or leaving comments.
|
||||
- **Terminology & Domain Knowledge**: Define specialized vocabulary, acronyms, brand naming conventions, or project-specific jargon.
|
||||
- **Metadata & Autofill Instructions**: Guide the **Autofill Agent** on how to summarize assets, generate tags, or populate specific custom metadata fields for files in this folder.
|
||||
|
||||
---
|
||||
|
||||
## Accessing and Editing AGENTS.md
|
||||
|
||||
### Opening the Editor
|
||||
|
||||
To view or edit `AGENTS.md`:
|
||||
|
||||
1. Open any project or folder in the Shumai web application.
|
||||
2. Click the **`AGENTS.md`** button in the top navigation toolbar, or right-click any folder in the file browser and choose **AGENTS.md**.
|
||||
3. A dedicated WYSIWYG Markdown editor opens with full formatting support (headings, lists, code blocks, bold/italics, and links).
|
||||
|
||||
### Auto-Save
|
||||
|
||||
As you make changes in the editor, Shumai automatically saves your edits in the background with visual save status indicators (`Saving...`, `Saved`).
|
||||
|
||||
---
|
||||
|
||||
## Permissions & Read-Only Mode
|
||||
|
||||
- **Viewing**: All team members who have read access to the project can view `AGENTS.md`.
|
||||
- **Editing**: **Only Team Owners** are permitted to create, edit, or delete `AGENTS.md` files.
|
||||
- **Read-Only State**: Non-owner members will see a clear read-only indicator in the toolbar explaining that only team owners can edit instructions for the file.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,121 @@
|
||||
---
|
||||
title: Resource Quotas
|
||||
description: Configure team resource quotas, monitor live usage, and reset quota windows from the dashboard.
|
||||
---
|
||||
|
||||
AI workflows and media processing tools can consume significant compute and API credits. Shumai provides a **Resource Quotas** system that allows Team Owners to set granular rate limits, govern budgets, and monitor real-time usage across team members and roles.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Resource Quotas allow you to define maximum usage limits across specific time windows (e.g., hourly, daily, or weekly). When a member or team reaches their assigned quota, further actions for that resource are safely blocked until the quota period resets.
|
||||
|
||||
Quota configuration and usage monitoring are separate parts of the team experience:
|
||||
|
||||
- To create and manage quota rules, open **Team Settings** and navigate to the **Quotas** tab.
|
||||
- To monitor live usage, open the **Team Dashboard** and select **Quotas** under the **TEAM** section.
|
||||
|
||||
The quota dashboard is available to Team Owners.
|
||||
|
||||
---
|
||||
|
||||
## Scope Modes
|
||||
|
||||
When creating or editing a quota rule, you can define how the limit is applied:
|
||||
|
||||
### 1. Each Member
|
||||
|
||||
- **Behavior**: Every member in the scope receives their own independent limit. Usage by one member does not affect the remaining quota of others.
|
||||
- **Optional Role Filter**: You can restrict the quota to members with a specific role (e.g. only **Editors** or **Reviewers**), or apply it to the entire team.
|
||||
- **Use Case**: Give each editor a daily budget of 100,000 tokens.
|
||||
|
||||
### 2. All Members (Shared Pool)
|
||||
|
||||
- **Behavior**: The quota limit is shared as a collective pool across all matching members. Every member's consumption draws from the same total.
|
||||
- **Optional Role Filter**: Apply the shared pool to all team members or restrict it to a specific role.
|
||||
- **Use Case**: Cap the total team spending on AI models to $50 per day.
|
||||
|
||||
### 3. Selected Members
|
||||
|
||||
- **Behavior**: Assign individual limits to specific chosen team members.
|
||||
- **Use Case**: Grant higher limits to senior artists or technical directors while keeping standard limits for others.
|
||||
|
||||
---
|
||||
|
||||
## Supported Resource Types
|
||||
|
||||
Shumai supports quota enforcement across multiple layers of the AI and agent architecture:
|
||||
|
||||
| Resource Type | Description | Target Specification |
|
||||
| :-------------------------- | :-------------------------------------------------------------------------------------- | :----------------------------------- |
|
||||
| **Total Tokens** | Total LLM input and output tokens consumed in chat, comments, and autofill. | Team, Role, or Members |
|
||||
| **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. `read_asset`, `download_asset`, `create_file`). | Tool name |
|
||||
|
||||
### Bash Command Wildcard Matching
|
||||
|
||||
For sandboxed bash execution, you can restrict specific command patterns using wildcards (`*` and `?`):
|
||||
|
||||
- `*`: Matches any bash command execution.
|
||||
- `npm *`: Matches any npm command (e.g., `npm install`, `npm test`).
|
||||
- `git commit*`: Matches git commit invocations.
|
||||
|
||||
---
|
||||
|
||||
## Time Periods & Rollover
|
||||
|
||||
Quotas can be configured with the following reset periods:
|
||||
|
||||
- **1 Hour** (`1hour`)
|
||||
- **5 Hours** (`5hour`)
|
||||
- **1 Day** (`1day`)
|
||||
- **7 Days** (`7day`)
|
||||
|
||||
### Lazy Reset Mechanism
|
||||
|
||||
Shumai tracks usage windows automatically. When a period window expires, the system resets the quota upon the member's next request, seamlessly starting a fresh window without requiring background maintenance tasks.
|
||||
|
||||
---
|
||||
|
||||
## Monitoring Live Usage
|
||||
|
||||
Team Owners can inspect live consumption from the team dashboard:
|
||||
|
||||
1. Open the **Team Dashboard**.
|
||||
2. Select **Quotas** under the **TEAM** section.
|
||||
3. Quota rules are shown as first-level collapsible entries.
|
||||
4. Expand a rule to view its usage records.
|
||||
|
||||
Each usage record displays:
|
||||
|
||||
- **Consumption Status**: Progress bar showing consumed units versus the total limit.
|
||||
- **Remaining Allowance**: Percentage and numerical amount remaining.
|
||||
- **Refresh Countdown**: Remaining time until the active window resets (e.g., _"Refreshes in 45m"_).
|
||||
- **Target**: The team shared pool, role pool, or individual member associated with the record.
|
||||
- **Member Search**: For member-scoped rules, search the usage records by member name or email.
|
||||
|
||||
Usage records are loaded when a rule is expanded and refresh automatically while the rule is open.
|
||||
|
||||
### Manually Resetting a Usage Record
|
||||
|
||||
Each usage record includes a **Reset Usage** action. After confirming the action:
|
||||
|
||||
- Consumption is set to zero.
|
||||
- The quota period starts immediately.
|
||||
- The period ends after the configured quota duration.
|
||||
- For example, resetting a one-day quota at 10:00 starts a new window from 10:00 until 10:00 the following day.
|
||||
|
||||
A reset can also initialize a zero-consumption record for a member or shared pool that has not received usage yet. Resets are recorded in the team audit log.
|
||||
|
||||
---
|
||||
|
||||
## Managing Quota Rules
|
||||
|
||||
- **Enable / Disable**: Toggle the switch on any quota card in Team Settings to temporarily pause or resume enforcement without deleting the rule.
|
||||
- **Edit Rules**: Click any quota card in Team Settings to update limits, change reset periods, or adjust member selections.
|
||||
- **Delete Rules**: Open the card action menu (`⋮`) in Team Settings and select **Delete** to remove the quota rule.
|
||||
|
||||
Quota usage is monitored and reset from the Team Dashboard rather than from the settings rule cards.
|
||||
+2
-1
@@ -22,7 +22,7 @@ const baseNamingConvention = [
|
||||
filter: {
|
||||
// Allow CSS variables, common HTTP headers, library-specific names, paths, and hyphenated/numeric keys
|
||||
regex:
|
||||
'^(Authorization|Content-Type|Accept|--.*|string_contains|disableCSRFCheck|X-Frameio-.*|/.*|field-.*|class-name|icon-.*|[0-9]+|@typescript-eslint/.*|Variables|Read|Edit|Admin|Bucket|Key|Body|ContentLength|ContentType|Prefix|ContinuationToken|Signature)$',
|
||||
'^(Authorization|Content-Type|Accept|--.*|string_contains|disableCSRFCheck|X-Frameio-.*|/.*|field-.*|class-name|icon-.*|[0-9]+|@typescript-eslint/.*|Variables|Read|Edit|Admin|Bucket|Key|Body|ContentLength|ContentType|Prefix|ContinuationToken|Signature|CopySource|Delete|Objects|Quiet|ResponseContentDisposition|UploadId|PartNumber)$',
|
||||
match: false,
|
||||
},
|
||||
},
|
||||
@@ -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/**',
|
||||
|
||||
+20
-17
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "shumai",
|
||||
"version": "0.3.6",
|
||||
"version": "0.4.4",
|
||||
"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,28 +42,31 @@
|
||||
},
|
||||
"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.6",
|
||||
"version": "0.4.4",
|
||||
"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:*",
|
||||
"@sinclair/typebox": "0.34.49",
|
||||
"@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.3.22",
|
||||
"ulid": "3.0.2",
|
||||
"zod": "4.4.3"
|
||||
"zod": "4.5.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/adm-zip": "0.5.8"
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -6,6 +6,7 @@ import {
|
||||
saveAssetEmbeddingsActivity,
|
||||
generateImageEmbeddingActivity,
|
||||
generateVideoChunkEmbeddingActivity,
|
||||
generateEmbeddingActivity,
|
||||
} from './ai'
|
||||
import { s3Service } from '@shumai/core/src/s3/s3'
|
||||
import { transcodeService } from '@shumai/core'
|
||||
@@ -35,12 +36,16 @@ vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
putObject: vi.fn(),
|
||||
headObject: vi.fn(),
|
||||
listObjects: vi.fn(),
|
||||
downloadToFile: vi.fn(),
|
||||
resolveInput: vi.fn().mockImplementation(async (_bucket, key) => `https://mock-storage/${key}`),
|
||||
},
|
||||
}))
|
||||
|
||||
vi.mock('@shumai/core/src/transcode/transcode', () => ({
|
||||
transcodeService: {
|
||||
extractVideoFrames: vi.fn(),
|
||||
createTempDir: vi.fn().mockReturnValue('/tmp'),
|
||||
removeDir: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
@@ -121,6 +126,33 @@ describe('AI Activities Unit Tests', () => {
|
||||
)
|
||||
})
|
||||
|
||||
it('should resolve video input via resolveInput and avoid downloadToFile in generateEmbeddingActivity', async () => {
|
||||
vi.mocked(s3Service.downloadToFile).mockClear()
|
||||
vi.mocked(s3Service.resolveInput).mockClear()
|
||||
vi.mocked(s3Service.resolveInput).mockResolvedValue(
|
||||
'https://mock-storage/files/asset-123/video.mp4',
|
||||
)
|
||||
|
||||
const res = await generateEmbeddingActivity({
|
||||
teamId: 't1',
|
||||
assetId: 'asset-123',
|
||||
context: {
|
||||
agent: {},
|
||||
asset: {
|
||||
mediaType: 'video/mp4',
|
||||
name: 'sample.mp4',
|
||||
storageKey: { key: 'files/asset-123/video.mp4' },
|
||||
media: { proxyType: 'video' },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
expect(s3Service.resolveInput).toHaveBeenCalledWith('shumai', 'files/asset-123/video.mp4')
|
||||
expect(s3Service.downloadToFile).not.toHaveBeenCalled()
|
||||
expect(s3Service.getObject).not.toHaveBeenCalledWith('shumai', 'files/asset-123/video.mp4')
|
||||
expect(res.embeddings.length).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it('should generate text embedding successfully', async () => {
|
||||
const res = await generateTextEmbeddingActivity({
|
||||
text: 'Search query',
|
||||
@@ -190,6 +222,30 @@ describe('AI Activities Unit Tests', () => {
|
||||
'image/webp',
|
||||
)
|
||||
})
|
||||
|
||||
it('should resolveInput from s3Service when filePath is not provided', async () => {
|
||||
vi.mocked(s3Service.headObject).mockRejectedValue(new Error('Not Found'))
|
||||
vi.mocked(s3Service.resolveInput).mockResolvedValue('https://mock-storage/project/video.mp4')
|
||||
vi.mocked(transcodeService.extractVideoFrames).mockResolvedValue(['/tmp/out1.webp'])
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(s3Service.putObject).mockResolvedValue({} as any)
|
||||
|
||||
const res = await extractAiMetadataActivity({
|
||||
assetKey: 'project/video.mp4',
|
||||
type: 'autofill',
|
||||
isImage: false,
|
||||
})
|
||||
|
||||
expect(res).toEqual(['project/ai_metadata/out1.webp'])
|
||||
expect(s3Service.resolveInput).toHaveBeenCalledWith('shumai', 'project/video.mp4')
|
||||
expect(transcodeService.extractVideoFrames).toHaveBeenCalledWith({
|
||||
inputFile: 'https://mock-storage/project/video.mp4',
|
||||
outputDir: expect.any(String),
|
||||
numFrames: 30,
|
||||
frameHeight: 720,
|
||||
isImage: false,
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ import { promisify } from 'util'
|
||||
import { ApplicationFailure } from '@temporalio/activity'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
import { ulid } from 'ulid'
|
||||
|
||||
const execFileAsync = promisify(execFile)
|
||||
|
||||
@@ -107,49 +108,52 @@ export async function generateEmbeddingActivity(params: GenerateEmbeddingParams)
|
||||
throw ApplicationFailure.create({ message: 'asset has no key', nonRetryable: true })
|
||||
}
|
||||
|
||||
const { buffer: data } = await s3Service.getObject(process.env.S3_BUCKET || 'shumai', key)
|
||||
|
||||
const bucket = process.env.S3_BUCKET || 'shumai'
|
||||
const results: GeneratedEmbedding[] = []
|
||||
|
||||
if (isImage) {
|
||||
const { buffer: data } = await s3Service.getObject(bucket, key)
|
||||
const embVec = await generateMultimodalEmbedding(ai, data, asset.mediaType)
|
||||
results.push({ embedding: embVec })
|
||||
} else if (isVideo) {
|
||||
const tmpFile = path.join(os.tmpdir(), `video-${Date.now()}.mp4`)
|
||||
fs.writeFileSync(tmpFile, data)
|
||||
const inputSource = await s3Service.resolveInput(bucket, key)
|
||||
const isRemote = inputSource.startsWith('http://') || inputSource.startsWith('https://')
|
||||
|
||||
try {
|
||||
const { stdout } = await execFileAsync('ffprobe', [
|
||||
'-v',
|
||||
'error',
|
||||
'-show_entries',
|
||||
'format=duration',
|
||||
'-of',
|
||||
'default=noprint_wrappers=1:nokey=1',
|
||||
tmpFile,
|
||||
])
|
||||
const duration = parseFloat(stdout.trim())
|
||||
if (isNaN(duration)) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'failed to parse video duration',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
const { stdout } = await execFileAsync('ffprobe', [
|
||||
'-v',
|
||||
'error',
|
||||
'-show_entries',
|
||||
'format=duration',
|
||||
'-of',
|
||||
'default=noprint_wrappers=1:nokey=1',
|
||||
inputSource,
|
||||
])
|
||||
const duration = parseFloat(stdout.trim())
|
||||
if (isNaN(duration)) {
|
||||
throw ApplicationFailure.create({
|
||||
message: 'failed to parse video duration',
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const chunkSize = 60.0
|
||||
for (let start = 0.0; start < duration; start += chunkSize) {
|
||||
let end = start + chunkSize
|
||||
if (end > duration) end = duration
|
||||
const chunkSize = 60.0
|
||||
for (let start = 0.0; start < duration; start += chunkSize) {
|
||||
let end = start + chunkSize
|
||||
if (end > duration) end = duration
|
||||
|
||||
const chunkTmp = path.join(os.tmpdir(), `video-chunk-${Date.now()}.mp4`)
|
||||
const chunkTmp = path.join(os.tmpdir(), `video-chunk-${Date.now()}-${ulid()}.mp4`)
|
||||
try {
|
||||
await execFileAsync('ffmpeg', [
|
||||
'-y',
|
||||
'-loglevel',
|
||||
'warning',
|
||||
'-i',
|
||||
tmpFile,
|
||||
...(isRemote
|
||||
? ['-reconnect', '1', '-reconnect_streamed', '1', '-reconnect_delay_max', '5']
|
||||
: []),
|
||||
'-ss',
|
||||
start.toString(),
|
||||
'-i',
|
||||
inputSource,
|
||||
'-t',
|
||||
(end - start).toString(),
|
||||
'-c',
|
||||
@@ -158,7 +162,6 @@ export async function generateEmbeddingActivity(params: GenerateEmbeddingParams)
|
||||
])
|
||||
|
||||
const chunkData = fs.readFileSync(chunkTmp)
|
||||
fs.unlinkSync(chunkTmp)
|
||||
|
||||
try {
|
||||
const embVec = await generateMultimodalEmbedding(ai, chunkData, 'video/mp4')
|
||||
@@ -169,9 +172,11 @@ export async function generateEmbeddingActivity(params: GenerateEmbeddingParams)
|
||||
`failed to generate video embedding for chunk ${start}-${end}: ${e.message}`,
|
||||
)
|
||||
}
|
||||
} finally {
|
||||
if (fs.existsSync(chunkTmp)) {
|
||||
fs.unlinkSync(chunkTmp)
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
fs.unlinkSync(tmpFile)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -233,7 +238,7 @@ export async function generateTextEmbeddingActivity(params: GenerateTextEmbeddin
|
||||
|
||||
export interface ExtractAiMetadataParams {
|
||||
assetKey: string
|
||||
filePath: string
|
||||
filePath?: string
|
||||
type: 'autofill'
|
||||
isImage: boolean
|
||||
}
|
||||
@@ -246,7 +251,12 @@ export async function extractAiMetadataActivity(
|
||||
const aiDir = path.join(assetDir, 'ai_metadata')
|
||||
const generatedFiles: string[] = []
|
||||
|
||||
const tmpDir = path.dirname(params.filePath)
|
||||
let tmpDir = params.filePath ? path.dirname(params.filePath) : ''
|
||||
let cleanupTmp = false
|
||||
if (!tmpDir) {
|
||||
tmpDir = transcodeService.createTempDir('ai-meta-')
|
||||
cleanupTmp = true
|
||||
}
|
||||
|
||||
try {
|
||||
if (params.type === 'autofill') {
|
||||
@@ -259,8 +269,10 @@ export async function extractAiMetadataActivity(
|
||||
// Not found
|
||||
}
|
||||
|
||||
const inputSource = params.filePath || (await s3Service.resolveInput(bucket, params.assetKey))
|
||||
|
||||
const files = await transcodeService.extractVideoFrames({
|
||||
inputFile: params.filePath,
|
||||
inputFile: inputSource,
|
||||
outputDir: tmpDir,
|
||||
numFrames: 30,
|
||||
frameHeight: 720,
|
||||
@@ -276,7 +288,9 @@ export async function extractAiMetadataActivity(
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
// Files are in tmpDir which will be cleaned up by cleanupTmpDirActivity
|
||||
if (cleanupTmp && tmpDir) {
|
||||
transcodeService.removeDir(tmpDir)
|
||||
}
|
||||
}
|
||||
|
||||
return generatedFiles
|
||||
|
||||
@@ -0,0 +1,324 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { sandboxService } from '@shumai/core'
|
||||
import type { SandboxProvider, SandboxConfig, WrapCommandOptions } from '@shumai/core'
|
||||
import { createAgentSession, type DbProviderInfo } from './index'
|
||||
import { createSandboxedBashTool } from './tools/sandboxed-bash'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { setupTestDbHooks } from '@shumai/db/test'
|
||||
import { spawn } from 'node:child_process'
|
||||
import { EventEmitter } from 'node:events'
|
||||
|
||||
vi.mock('node:child_process')
|
||||
|
||||
class TestSandboxProvider implements SandboxProvider {
|
||||
initialized = false
|
||||
config: SandboxConfig | null = null
|
||||
initializeCalls = 0
|
||||
updateConfigCalls = 0
|
||||
resetCalls = 0
|
||||
wrapCommandCalls: Array<{ command: string; options?: WrapCommandOptions }> = []
|
||||
violationsByCommandId = new Map<string, string>()
|
||||
|
||||
async initialize(config: SandboxConfig): Promise<void> {
|
||||
this.initialized = true
|
||||
this.config = config
|
||||
this.initializeCalls++
|
||||
}
|
||||
|
||||
async wrapCommand(command: string, options?: WrapCommandOptions): Promise<string> {
|
||||
this.wrapCommandCalls.push({ command, options })
|
||||
return `sandboxed-${command}`
|
||||
}
|
||||
|
||||
async updateConfig(config: Partial<SandboxConfig>): Promise<void> {
|
||||
this.updateConfigCalls++
|
||||
if (this.config && config.network) {
|
||||
this.config.network = { ...this.config.network, ...config.network }
|
||||
}
|
||||
}
|
||||
|
||||
async reset(): Promise<void> {
|
||||
this.resetCalls++
|
||||
this.initialized = false
|
||||
this.config = null
|
||||
}
|
||||
|
||||
isInitialized(): boolean {
|
||||
return this.initialized
|
||||
}
|
||||
|
||||
getBlockedHostForCommand(commandId: string): string | null {
|
||||
return this.violationsByCommandId.get(commandId) ?? null
|
||||
}
|
||||
}
|
||||
|
||||
const mockProviders: DbProviderInfo[] = [
|
||||
{
|
||||
name: 'google',
|
||||
config: { api: 'google-generative-ai', apiKey: 'GOOGLE_API_KEY' },
|
||||
models: [
|
||||
{
|
||||
modelId: 'gemini',
|
||||
name: 'Gemini',
|
||||
config: {
|
||||
api: 'google-generative-ai',
|
||||
reasoning: false,
|
||||
input: ['text'],
|
||||
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
||||
contextWindow: 8192,
|
||||
maxTokens: 4096,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
]
|
||||
|
||||
describe('Concurrent Sandbox Sessions', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
let testProvider: TestSandboxProvider
|
||||
|
||||
beforeEach(async () => {
|
||||
vi.clearAllMocks()
|
||||
testProvider = new TestSandboxProvider()
|
||||
sandboxService.setProvider(testProvider)
|
||||
})
|
||||
|
||||
it('does not reset sandbox when new sessions start while a command is running', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Concurrent Test Team' },
|
||||
})
|
||||
await prisma.sandbox.create({
|
||||
data: {
|
||||
teamId: team.id,
|
||||
networkSandboxEnabled: true,
|
||||
allowedDomains: ['api.github.com'],
|
||||
},
|
||||
})
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-1',
|
||||
name: 'Agent User',
|
||||
email: 'agent-user@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'agent-1',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
// 1. Session A starts and syncs domains
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-1',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'Session A prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: ['api.github.com'],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
expect(testProvider.initializeCalls).toBe(1)
|
||||
expect(testProvider.resetCalls).toBe(0)
|
||||
|
||||
// 2. Session A runs a bash command that takes time
|
||||
const tool = createSandboxedBashTool('/mock/cwd')
|
||||
|
||||
const mockStdout = new EventEmitter()
|
||||
const mockStderr = new EventEmitter()
|
||||
const mockChild = Object.assign(new EventEmitter(), {
|
||||
stdout: mockStdout,
|
||||
stderr: mockStderr,
|
||||
pid: 999,
|
||||
kill: vi.fn(),
|
||||
})
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mock spawn return value
|
||||
;(spawn as any).mockReturnValue(mockChild)
|
||||
|
||||
const sessionExecutionA = tool.execute('call-session-a-1', {
|
||||
command: 'curl https://api.github.com/repos',
|
||||
source: 'skill',
|
||||
})
|
||||
|
||||
// 3. Concurrently, Session B starts with additional allowed domains
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-1',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'Session B prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: ['api.github.com', 'pypi.org'],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
// Assert sandbox was hot-reloaded without any reset!
|
||||
expect(testProvider.resetCalls).toBe(0)
|
||||
expect(testProvider.updateConfigCalls).toBe(1)
|
||||
expect(sandboxService.getCurrentAllowedDomains()).toEqual(['api.github.com', 'pypi.org'])
|
||||
|
||||
// 4. Concurrently, Session C starts with the same domains (should be no-op, no reset, no updateConfig)
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-1',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'Session C prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: ['pypi.org', 'api.github.com'],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
expect(testProvider.resetCalls).toBe(0)
|
||||
expect(testProvider.updateConfigCalls).toBe(1) // Still 1, no duplicate update
|
||||
|
||||
// 5. Session A's command completes successfully
|
||||
mockStdout.emit('data', Buffer.from('{"status":"ok"}'))
|
||||
mockChild.emit('close', 0)
|
||||
|
||||
const result = await sessionExecutionA
|
||||
expect(result.details).toEqual(
|
||||
expect.objectContaining({
|
||||
exitCode: 0,
|
||||
}),
|
||||
)
|
||||
|
||||
// Verify command was wrapped with options containing commandId: 'call-session-a-1'
|
||||
expect(testProvider.wrapCommandCalls).toContainEqual({
|
||||
command: 'curl https://api.github.com/repos',
|
||||
options: { commandId: 'call-session-a-1' },
|
||||
})
|
||||
})
|
||||
|
||||
it('isolates blocked host violations per commandId during concurrent execution', async () => {
|
||||
await sandboxService.ensureInitialized({ allowedDomains: ['api.github.com'] })
|
||||
|
||||
// Command 1 and Command 2 run concurrently
|
||||
await sandboxService.wrapCommand('curl http://blocked1.com', { commandId: 'cmd-1' })
|
||||
await sandboxService.wrapCommand('curl http://blocked2.com', { commandId: 'cmd-2' })
|
||||
|
||||
testProvider.violationsByCommandId.set('cmd-1', 'blocked1.com')
|
||||
testProvider.violationsByCommandId.set('cmd-2', 'blocked2.com')
|
||||
|
||||
// Blocked hosts should be accurately isolated
|
||||
expect(sandboxService.getBlockedHost('cmd-1')).toBe('blocked1.com')
|
||||
expect(sandboxService.getBlockedHost('cmd-2')).toBe('blocked2.com')
|
||||
expect(sandboxService.getBlockedHost('cmd-unknown')).toBe('')
|
||||
})
|
||||
|
||||
it('does not reject concurrent allowed command when another command is blocked', async () => {
|
||||
await sandboxService.ensureInitialized({ allowedDomains: ['api.github.com'] })
|
||||
|
||||
const tool = createSandboxedBashTool('/mock/cwd', undefined, {
|
||||
getBlockedHost: (commandId?: string) => sandboxService.getBlockedHost(commandId),
|
||||
clearBlockedHost: () => sandboxService.clearBlockedHost(),
|
||||
})
|
||||
|
||||
const childBlocked = Object.assign(new EventEmitter(), {
|
||||
stdout: new EventEmitter(),
|
||||
stderr: new EventEmitter(),
|
||||
pid: 101,
|
||||
kill: vi.fn(),
|
||||
})
|
||||
const childAllowed = Object.assign(new EventEmitter(), {
|
||||
stdout: new EventEmitter(),
|
||||
stderr: new EventEmitter(),
|
||||
pid: 102,
|
||||
kill: vi.fn(),
|
||||
})
|
||||
|
||||
let spawnIndex = 0
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mock spawn implementation
|
||||
;(spawn as any).mockImplementation(() => {
|
||||
spawnIndex++
|
||||
return spawnIndex === 1 ? childBlocked : childAllowed
|
||||
})
|
||||
|
||||
// Record violation for the blocked command only
|
||||
testProvider.violationsByCommandId.set('call-blocked', 'blocked-target.com')
|
||||
|
||||
const blockedExecution = tool.execute('call-blocked', {
|
||||
command: 'curl http://blocked-target.com',
|
||||
source: 'skill',
|
||||
})
|
||||
const allowedExecution = tool.execute('call-allowed', {
|
||||
command: 'curl https://api.github.com/data',
|
||||
source: 'skill',
|
||||
})
|
||||
|
||||
await vi.waitFor(() => expect(spawn).toHaveBeenCalledTimes(2))
|
||||
|
||||
childBlocked.stdout.emit('data', Buffer.from('blocked output'))
|
||||
childBlocked.emit('close', 0)
|
||||
|
||||
childAllowed.stdout.emit('data', Buffer.from('allowed output'))
|
||||
childAllowed.emit('close', 0)
|
||||
|
||||
await expect(blockedExecution).rejects.toThrow(
|
||||
'Network request to blocked-target.com is blocked',
|
||||
)
|
||||
const allowedResult = await allowedExecution
|
||||
expect(allowedResult.details).toEqual(expect.objectContaining({ exitCode: 0 }))
|
||||
})
|
||||
|
||||
it('does not synchronize or overwrite sandbox allowlist when allowedDomains is omitted (e.g. naming sessions)', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Omitted Domains Team' },
|
||||
})
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-omitted',
|
||||
name: 'Agent User',
|
||||
email: 'agent-omitted@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'agent-omitted',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
// 1. First session sets allowedDomains to ['*.github.com']
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-omitted',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'Main prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: ['*.github.com'],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
expect(sandboxService.getCurrentAllowedDomains()).toEqual(['*.github.com'])
|
||||
const updateCallsBefore = testProvider.updateConfigCalls
|
||||
|
||||
// 2. Utility / naming session runs WITHOUT allowedDomains
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-omitted',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'Title generator',
|
||||
teamSkills: [],
|
||||
// allowedDomains omitted
|
||||
disableTools: true,
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
// Assert sandbox was NOT touched or overwritten
|
||||
expect(testProvider.updateConfigCalls).toBe(updateCallsBefore)
|
||||
expect(sandboxService.getCurrentAllowedDomains()).toEqual(['*.github.com'])
|
||||
})
|
||||
})
|
||||
@@ -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
|
||||
|
||||
@@ -8,8 +8,12 @@ import {
|
||||
} from './index'
|
||||
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'
|
||||
import { Value } from 'typebox/value'
|
||||
import * as path from 'path'
|
||||
import * as childProcess from 'node:child_process'
|
||||
import * as fs from 'fs'
|
||||
@@ -89,10 +93,16 @@ describe('Sandbox Network isolation integration', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
it('should register callback that pushes blocked hosts to database and propagates to bash tool', async () => {
|
||||
// 1. Create a team
|
||||
// 1. Create a team and enabled sandbox
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Sandbox Team' },
|
||||
})
|
||||
await prisma.sandbox.create({
|
||||
data: {
|
||||
teamId: team.id,
|
||||
networkSandboxEnabled: true,
|
||||
},
|
||||
})
|
||||
|
||||
// Ensure agent user and agent exist in database to avoid foreign key violation
|
||||
await prisma.user.create({
|
||||
@@ -198,6 +208,12 @@ describe('Sandbox Network isolation integration', () => {
|
||||
const team2 = await prisma.team.create({
|
||||
data: { name: 'Team 2' },
|
||||
})
|
||||
await prisma.sandbox.create({
|
||||
data: { teamId: team1.id, networkSandboxEnabled: true },
|
||||
})
|
||||
await prisma.sandbox.create({
|
||||
data: { teamId: team2.id, networkSandboxEnabled: true },
|
||||
})
|
||||
|
||||
// Ensure agent user and agents exist in database
|
||||
await prisma.user.create({
|
||||
@@ -290,6 +306,64 @@ describe('Sandbox Network isolation integration', () => {
|
||||
}
|
||||
})
|
||||
|
||||
it('should bypass domain blocking and pending domain recording when networkSandboxEnabled is false', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Disabled Sandbox Team' },
|
||||
})
|
||||
await prisma.sandbox.create({
|
||||
data: { teamId: team.id, networkSandboxEnabled: false },
|
||||
})
|
||||
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'agent-disabled',
|
||||
name: 'Ai Agent Disabled',
|
||||
email: 'disabled@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'agent-disabled',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'openai', model: 'gpt-4' },
|
||||
},
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
vi.spyOn(SandboxManager, 'wrapWithSandbox').mockImplementation(async (cmd) => cmd)
|
||||
|
||||
await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'agent-disabled',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: ['*'],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
expect(initializeSpy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
network: expect.objectContaining({
|
||||
allowedDomains: ['*'],
|
||||
}),
|
||||
}),
|
||||
expect.any(Function),
|
||||
)
|
||||
|
||||
const callback = initializeSpy.mock.calls[0][1]
|
||||
const res = await callback!({ host: 'any-external-domain.com', port: 443 })
|
||||
expect(res).toBe(true)
|
||||
|
||||
const sandbox = await prisma.sandbox.findUnique({
|
||||
where: { teamId: team.id },
|
||||
})
|
||||
expect(sandbox?.pendingDomains).toEqual([])
|
||||
})
|
||||
|
||||
it('should pass thinkingLevel to AgentHarness and default to off', async () => {
|
||||
const team = await prisma.team.create({
|
||||
data: { name: 'Test Team' },
|
||||
@@ -814,6 +888,207 @@ describe('createAgentSession bash restriction for non-owner users', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('createAgentSession typed metadata schema', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
})
|
||||
|
||||
async function setupSessionWithProject(opts: { withCreationFields: boolean }) {
|
||||
const team = await prisma.team.create({ data: { name: 'Typed Metadata Team' } })
|
||||
const project = await prisma.project.create({
|
||||
data: { name: 'Typed Metadata Project', teamId: team.id },
|
||||
})
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Typed Metadata User', email: 'typed-metadata@shumai.ai' },
|
||||
})
|
||||
await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: user.id, role: 'owner' },
|
||||
})
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'typed-metadata-agent',
|
||||
name: 'Ai Agent Typed Metadata',
|
||||
email: 'typed-metadata-agent@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'typed-metadata-agent',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
if (opts.withCreationFields) {
|
||||
await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'prompt',
|
||||
scope: 'PROJECT',
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
config: { name: 'Prompt', type: 'text', autofillSource: 'CREATION_CONTEXT' },
|
||||
},
|
||||
})
|
||||
await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'source',
|
||||
scope: 'PROJECT',
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
config: {
|
||||
name: 'Source',
|
||||
type: 'select',
|
||||
autofillSource: 'CREATION_CONTEXT',
|
||||
select: {
|
||||
options: [{ id: 'gemini', displayName: 'Gemini', color: '#ffffff' }],
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
await prisma.metadataField.create({
|
||||
data: {
|
||||
key: 'manualNotes',
|
||||
scope: 'PROJECT',
|
||||
projectId: project.id,
|
||||
teamId: team.id,
|
||||
config: { name: 'Manual Notes', type: 'text', autofillSource: 'NONE' },
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
agentId: 'typed-metadata-agent',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
userId: user.id,
|
||||
projectId: project.id,
|
||||
})
|
||||
return { harness }
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
}
|
||||
|
||||
it('should build create_file/create_version with the project CREATION_CONTEXT fields', async () => {
|
||||
const { harness } = await setupSessionWithProject({ withCreationFields: true })
|
||||
const tools = harness.getTools()
|
||||
|
||||
expect(tools.some((t) => t.name === 'list_autofill_fields')).toBe(false)
|
||||
|
||||
const createFile = tools.find((t) => t.name === 'create_file')
|
||||
const createVersion = tools.find((t) => t.name === 'create_version')
|
||||
expect(createFile).toBeDefined()
|
||||
expect(createVersion).toBeDefined()
|
||||
|
||||
const checkFile = (args: Record<string, unknown>) =>
|
||||
Value.Check(createFile!.parameters as unknown as TSchema, {
|
||||
parent: 'f1',
|
||||
path: '/tmp/x.md',
|
||||
data: null,
|
||||
...args,
|
||||
})
|
||||
const checkVersion = (args: Record<string, unknown>) =>
|
||||
Value.Check(createVersion!.parameters as unknown as TSchema, {
|
||||
parent: 'f1',
|
||||
path: '/tmp/x.md',
|
||||
...args,
|
||||
})
|
||||
|
||||
for (const check of [checkFile, checkVersion]) {
|
||||
// Declared CREATION_CONTEXT fields (all-required, nullable) validate; other keys do not
|
||||
expect(check({ metadata: { prompt: 'hello', source: null } })).toBe(true)
|
||||
expect(check({ metadata: { prompt: null, source: 'gemini' } })).toBe(true)
|
||||
expect(check({ metadata: null })).toBe(true)
|
||||
expect(check({ metadata: { prompt: null, source: null, manualNotes: 'no' } })).toBe(false)
|
||||
expect(check({ metadata: { prompt: null, source: null, bogus: 1 } })).toBe(false)
|
||||
expect(check({ metadata: { prompt: 'hello' } })).toBe(false)
|
||||
}
|
||||
})
|
||||
|
||||
it('should omit the metadata parameter when the project has no CREATION_CONTEXT fields', async () => {
|
||||
const { harness } = await setupSessionWithProject({ withCreationFields: false })
|
||||
const createFile = harness.getTools().find((t) => t.name === 'create_file')
|
||||
const createVersion = harness.getTools().find((t) => t.name === 'create_version')
|
||||
expect(createFile).toBeDefined()
|
||||
expect(createVersion).toBeDefined()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
const fileProps = (createFile!.parameters as any).properties
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
const versionProps = (createVersion!.parameters as any).properties
|
||||
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', () => {
|
||||
setupTestDbHooks()
|
||||
|
||||
@@ -958,4 +1233,323 @@ describe('createAgentSession enabled skill filtering', () => {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
|
||||
it('enforces agent tool call count quota on tool execution', async () => {
|
||||
const team = await prisma.team.create({ data: { name: 'Tool Quota Enforcement Team' } })
|
||||
const user = await prisma.user.create({
|
||||
data: { name: 'Member User', email: 'member-tool-quota@shumai.ai', password: 'pw' },
|
||||
})
|
||||
await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: user.id, role: 'editor' },
|
||||
})
|
||||
await prisma.user.create({
|
||||
data: {
|
||||
id: 'tool-quota-agent',
|
||||
name: 'Tool Quota Agent',
|
||||
email: 'tool-quota-agent@shumai.ai',
|
||||
type: 'agent',
|
||||
},
|
||||
})
|
||||
await prisma.agent.create({
|
||||
data: {
|
||||
id: 'tool-quota-agent',
|
||||
teamId: team.id,
|
||||
type: 'chat',
|
||||
config: { provider: 'google', model: 'gemini' },
|
||||
},
|
||||
})
|
||||
|
||||
await quotaService.createRule(team.id, {
|
||||
scopeMode: 'all_members',
|
||||
resource: 'agent_tool_call_count',
|
||||
resourceData: { name: 'read_thread' },
|
||||
limit: 1,
|
||||
period: '1hour',
|
||||
enabled: true,
|
||||
})
|
||||
|
||||
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
|
||||
try {
|
||||
const { harness } = await createAgentSession({
|
||||
teamId: team.id,
|
||||
userId: user.id,
|
||||
agentId: 'tool-quota-agent',
|
||||
providerName: 'google',
|
||||
modelId: 'gemini',
|
||||
systemPrompt: 'prompt',
|
||||
teamSkills: [],
|
||||
enabledSkillIds: [],
|
||||
allowedDomains: [],
|
||||
providers: mockProviders,
|
||||
})
|
||||
|
||||
const readThreadTool = harness.getTools().find((t) => t.name === 'read_thread')
|
||||
expect(readThreadTool).toBeDefined()
|
||||
|
||||
// First call executes and consumes quota
|
||||
const res1 = await readThreadTool!.execute(
|
||||
'call-1',
|
||||
{ threadId: 'non-existent' },
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
)
|
||||
expect(res1).toBeDefined()
|
||||
|
||||
// Second call exceeds quota and returns error
|
||||
const res2 = await readThreadTool!.execute(
|
||||
'call-2',
|
||||
{ threadId: 'non-existent' },
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
)
|
||||
expect(res2).toBeDefined()
|
||||
const textContent = res2.content[0]
|
||||
if (textContent && textContent.type === 'text') {
|
||||
expect(textContent.text).toContain('Quota exceeded')
|
||||
} else {
|
||||
expect.unreachable('Expected text content')
|
||||
}
|
||||
} finally {
|
||||
initializeSpy.mockRestore()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
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()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
+230
-127
@@ -1,4 +1,4 @@
|
||||
import { SandboxManager } from '@anthropic-ai/sandbox-runtime'
|
||||
import { sandboxService } from '@shumai/core'
|
||||
import {
|
||||
AgentHarness,
|
||||
Session,
|
||||
@@ -9,24 +9,32 @@ import type { Api, Model } from '@earendil-works/pi-ai'
|
||||
import { createModels, InMemoryCredentialStore } from '@earendil-works/pi-ai'
|
||||
import { builtinProviders } from '@earendil-works/pi-ai/providers/all'
|
||||
import { agentService } from '@shumai/core/src/agent/agent'
|
||||
import { prisma, type TeamMemberRole } from '@shumai/db'
|
||||
import { Type, type TSchema } from '@sinclair/typebox'
|
||||
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
|
||||
import { quotaService, QuotaExceededError } from '@shumai/core/src/quota/quota-service'
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
import { prisma } from '@shumai/db'
|
||||
import { Type, type TSchema } from 'typebox'
|
||||
import * as fs from 'fs'
|
||||
import * as os from 'os'
|
||||
import * as path from 'path'
|
||||
import { DatabaseSessionStorage } from './database-session-storage'
|
||||
import { createAnalyzeImageTool } from './tools/analyze-image'
|
||||
import { metadataService } from '@shumai/core/src/metadata/metadata'
|
||||
import { createCreateFileTool } from './tools/create-file'
|
||||
import { createListAutofillFieldsTool } from './tools/list-autofill-fields'
|
||||
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
|
||||
@@ -67,10 +75,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
|
||||
}
|
||||
@@ -99,9 +107,11 @@ export interface CreateAgentSessionParams {
|
||||
systemPrompt: string
|
||||
teamSkills: Array<{ id: string; name: string; description?: string | null }>
|
||||
enabledSkillIds?: string[]
|
||||
allowedDomains: string[]
|
||||
allowedDomains?: string[]
|
||||
sessionId?: string
|
||||
userId?: string
|
||||
projectId?: string
|
||||
assetId?: string
|
||||
userCommentId?: string | null
|
||||
customTools?: AgentTool[]
|
||||
thinkingLevel?: string
|
||||
@@ -111,18 +121,6 @@ export interface CreateAgentSessionParams {
|
||||
baseDelayMs?: number
|
||||
}
|
||||
|
||||
async function resolveTeamMemberRole(
|
||||
teamId: string,
|
||||
userId?: string,
|
||||
): Promise<TeamMemberRole | undefined> {
|
||||
if (!userId) return undefined
|
||||
const member = await prisma.teamMember.findUnique({
|
||||
where: { teamIdUserId: { teamId, userId } },
|
||||
select: { role: true },
|
||||
})
|
||||
return member?.role
|
||||
}
|
||||
|
||||
/**
|
||||
* Security instructions appended to the system prompt when the requesting user is not a team
|
||||
* owner (i.e. editor/reviewer). These complement the hard enforcement in the bash tool itself
|
||||
@@ -150,6 +148,8 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
allowedDomains,
|
||||
sessionId,
|
||||
userId,
|
||||
projectId,
|
||||
assetId,
|
||||
userCommentId: passedUserCommentId,
|
||||
customTools = [],
|
||||
thinkingLevel,
|
||||
@@ -177,73 +177,67 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
const piDir = path.join(process.cwd(), '.pi')
|
||||
if (!fs.existsSync(piDir)) fs.mkdirSync(piDir, { recursive: true })
|
||||
|
||||
const allowWrite = [piDir, os.tmpdir()]
|
||||
const role = userId ? await resolveEffectiveRole(teamId, projectId, userId) : undefined
|
||||
const isOwner = !userId || role === 'owner'
|
||||
const restricted = !isOwner
|
||||
|
||||
const sandboxState = {
|
||||
blockedHost: '',
|
||||
}
|
||||
|
||||
const sandboxAskCallback = async ({ host }: { host: string; port?: number }) => {
|
||||
try {
|
||||
const sandbox = await prisma.sandbox.findUnique({
|
||||
where: { teamId },
|
||||
})
|
||||
const pendingDomains = sandbox?.pendingDomains || []
|
||||
if (!pendingDomains.includes(host)) {
|
||||
await prisma.sandbox.upsert({
|
||||
where: { teamId },
|
||||
create: {
|
||||
teamId,
|
||||
pendingDomains: [host],
|
||||
},
|
||||
update: {
|
||||
pendingDomains: {
|
||||
push: host,
|
||||
const wrapToolWithQuota = (tool: AgentTool): AgentTool => {
|
||||
const originalExecute = tool.execute
|
||||
return {
|
||||
...tool,
|
||||
execute: async (toolCallId, args, signal, onUpdate) => {
|
||||
try {
|
||||
await quotaService.checkQuota(
|
||||
{
|
||||
teamId,
|
||||
userId,
|
||||
role,
|
||||
resource: 'agent_tool_call_count',
|
||||
resourceData: { name: tool.name, toolName: tool.name },
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
} catch (err) {
|
||||
console.error('Failed to update sandbox pending domains:', err)
|
||||
1,
|
||||
)
|
||||
} catch (err) {
|
||||
if (err instanceof QuotaExceededError) {
|
||||
return {
|
||||
content: [{ type: 'text', text: `Quota exceeded: ${err.message}` }],
|
||||
details: { error: err.message },
|
||||
}
|
||||
}
|
||||
throw err
|
||||
}
|
||||
|
||||
const result = await originalExecute(toolCallId, args, signal, onUpdate)
|
||||
|
||||
try {
|
||||
await quotaService.consumeQuota(
|
||||
{
|
||||
teamId,
|
||||
userId,
|
||||
role,
|
||||
resource: 'agent_tool_call_count',
|
||||
resourceData: { name: tool.name, toolName: tool.name },
|
||||
},
|
||||
1,
|
||||
)
|
||||
} catch (err) {
|
||||
logger.error({ err }, 'Failed to record quota usage for agent tool call')
|
||||
}
|
||||
|
||||
return result
|
||||
},
|
||||
}
|
||||
|
||||
sandboxState.blockedHost = host
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// SandboxManager.initialize is a global operation that applies to the entire process.
|
||||
// We reset it first to ensure any previous process-global SOCKS/HTTP proxy servers
|
||||
// and callbacks are cleaned up, allowing the new callback and allowedDomains to take effect.
|
||||
await SandboxManager.reset()
|
||||
await SandboxManager.initialize(
|
||||
{
|
||||
network: {
|
||||
allowedDomains,
|
||||
deniedDomains: [],
|
||||
},
|
||||
filesystem: {
|
||||
denyRead: ['.env', '.env.*', '*.pem', '*.key'],
|
||||
allowWrite,
|
||||
denyWrite: ['.env', '.env.*', '*.pem', '*.key'],
|
||||
},
|
||||
enableWeakerNestedSandbox: process.env.ENABLE_WEAKER_NESTED_SANDBOX === 'true',
|
||||
},
|
||||
sandboxAskCallback,
|
||||
)
|
||||
if (allowedDomains !== undefined) {
|
||||
await sandboxService.syncAllowedDomains(allowedDomains, teamId)
|
||||
}
|
||||
|
||||
const skillEnvs: Record<string, string> = {}
|
||||
const onEnvsAdded = (envs: Record<string, string>) => {
|
||||
Object.assign(skillEnvs, envs)
|
||||
}
|
||||
|
||||
// Resolve the requesting user's team role to enforce owner-only bash privileges.
|
||||
// A user who is not a member of the team is treated as restricted (fail-closed),
|
||||
// while flows without a user context (e.g. autofill) remain unrestricted.
|
||||
const role = await resolveTeamMemberRole(teamId, userId)
|
||||
const isOwner = !userId || role === 'owner'
|
||||
const restricted = !isOwner
|
||||
|
||||
// Restore env variables from previously loaded skills in this session
|
||||
let skillLoadedInSession = false
|
||||
if (sessionId) {
|
||||
@@ -252,6 +246,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
|
||||
@@ -269,29 +264,47 @@ 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),
|
||||
)
|
||||
}
|
||||
|
||||
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]
|
||||
|
||||
const mediaTools: AgentTool[] = []
|
||||
if (userId) {
|
||||
mediaTools.push(createReadAssetTool(userId))
|
||||
} else if (agent?.type === 'autofill' && assetId) {
|
||||
mediaTools.push(
|
||||
createReadAssetTool({
|
||||
teamId,
|
||||
agentType: 'autofill',
|
||||
targetAssetId: assetId,
|
||||
}),
|
||||
)
|
||||
}
|
||||
|
||||
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, {
|
||||
getBlockedHost: () => sandboxState.blockedHost,
|
||||
teamId,
|
||||
userId,
|
||||
role,
|
||||
getBlockedHost: (commandId?: string) => sandboxService.getBlockedHost(commandId),
|
||||
clearBlockedHost: () => {
|
||||
sandboxState.blockedHost = ''
|
||||
sandboxService.clearBlockedHost()
|
||||
},
|
||||
// Non-owner users can only run bash commands required by a loaded skill
|
||||
restrictedUser: restricted,
|
||||
@@ -309,7 +322,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
bashInjected = true
|
||||
// Pass the full post-update tool list as activeToolNames: setTools only updates the
|
||||
// registry otherwise, and the model would never see the bash tool on the next turn.
|
||||
const next = [...harness.getTools(), sandboxedBash]
|
||||
const next = [...harness.getTools(), wrapToolWithQuota(sandboxedBash)]
|
||||
await harness.setTools(
|
||||
next,
|
||||
next.map((t) => t.name),
|
||||
@@ -320,22 +333,27 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
onEnvsAdded,
|
||||
restricted ? onSkillLoaded : undefined,
|
||||
enabledSkillIds,
|
||||
projectId,
|
||||
)
|
||||
|
||||
const systemTools: AgentTool[] = []
|
||||
if (userId) {
|
||||
const metadataSchema = await buildProjectMetadataSchema(projectId)
|
||||
const agentContext = { teamId, agentId }
|
||||
systemTools.push(
|
||||
createListAssetsTool(userId),
|
||||
createCreateFolderTool(userId),
|
||||
createCreateFileTool(userId),
|
||||
createCreateVersionTool(userId),
|
||||
createCreateFolderTool(userId, agentContext),
|
||||
createCreateFileTool(userId, metadataSchema, agentContext),
|
||||
createCreateVersionTool(userId, metadataSchema, agentContext),
|
||||
createDownloadAssetTool(userId),
|
||||
createListAutofillFieldsTool(userId),
|
||||
createRenameAssetTool(userId, agentContext),
|
||||
createMoveAssetsTool(userId, agentContext),
|
||||
createDeleteAssetTool(userId, agentContext),
|
||||
)
|
||||
}
|
||||
|
||||
const readThread = createReadThreadTool()
|
||||
const allTools = [
|
||||
const rawTools = [
|
||||
...mediaTools,
|
||||
readSkill,
|
||||
readThread,
|
||||
@@ -343,6 +361,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
|
||||
...systemTools,
|
||||
...customTools,
|
||||
]
|
||||
const allTools = rawTools.map((tool) => wrapToolWithQuota(tool))
|
||||
const enabledTools = disableTools
|
||||
? []
|
||||
: allTools.filter((tool) => !deniedTools.includes(tool.name))
|
||||
@@ -400,6 +419,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 }
|
||||
}
|
||||
|
||||
@@ -410,58 +452,116 @@ export interface AutofillField {
|
||||
}
|
||||
|
||||
export function fieldsToTypeBoxSchema(fields: AutofillField[]) {
|
||||
const newOptionSchema = Type.Object(
|
||||
{
|
||||
newOption: Type.Object(
|
||||
{
|
||||
value: Type.String({
|
||||
minLength: 1,
|
||||
description:
|
||||
'The new option display name/value to create and select if none of the existing options match.',
|
||||
}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
const properties: Record<string, TSchema> = {}
|
||||
for (const f of fields) {
|
||||
let schema: TSchema
|
||||
const fieldName = f.config.name
|
||||
const fieldDesc = f.description || fieldName
|
||||
const baseDescription = `The field '${fieldName}' represents ${fieldDesc}.`
|
||||
switch (f.config.type) {
|
||||
case 'text':
|
||||
case 'longText':
|
||||
schema = Type.String()
|
||||
schema = Type.String({ description: baseDescription })
|
||||
break
|
||||
case 'number':
|
||||
case 'rating':
|
||||
schema = Type.Number()
|
||||
schema = Type.Number({ description: baseDescription })
|
||||
break
|
||||
case 'toggle':
|
||||
schema = Type.Boolean()
|
||||
schema = Type.Boolean({ description: baseDescription })
|
||||
break
|
||||
case 'select': {
|
||||
const options = f.config.select?.options || []
|
||||
schema = Type.String({
|
||||
enum: options.map((o) => o.id),
|
||||
})
|
||||
const description =
|
||||
options.length > 0
|
||||
? `${baseDescription}\nSelect one existing option ID or provide {"newOption": {"value": "..."}} to create a new option.\n\nAvailable options:\n${options.map((o) => `- ${o.displayName} => ${o.id}`).join('\n')}`
|
||||
: `${baseDescription}\nProvide {"newOption": {"value": "..."}} with the desired option name.`
|
||||
if (options.length > 0) {
|
||||
const optionLines = options.map((o) => `- ${o.displayName} => ${o.id}`).join('\n')
|
||||
schema.description = `The field '${fieldName}' represents ${fieldDesc}.\nSelect one option and return the option ID as the value.\n\nAvailable options:\n${optionLines}`
|
||||
schema = Type.Union(
|
||||
[
|
||||
Type.String({
|
||||
enum: options.map((o) => o.id),
|
||||
}),
|
||||
newOptionSchema,
|
||||
],
|
||||
{ description },
|
||||
)
|
||||
} else {
|
||||
schema = Type.Object(newOptionSchema.properties, {
|
||||
additionalProperties: false,
|
||||
description,
|
||||
})
|
||||
}
|
||||
break
|
||||
}
|
||||
case 'selectMulti': {
|
||||
const options = f.config.selectMulti?.options || []
|
||||
schema = Type.Array(
|
||||
Type.String({
|
||||
enum: options.map((o) => o.id),
|
||||
}),
|
||||
)
|
||||
if (options.length > 0) {
|
||||
const optionLines = options.map((o) => `- ${o.displayName} => ${o.id}`).join('\n')
|
||||
schema.description = `The field '${fieldName}' represents ${fieldDesc}.\nSelect applicable options and return the option IDs as the value.\n\nAvailable options:\n${optionLines}`
|
||||
}
|
||||
const description =
|
||||
options.length > 0
|
||||
? `${baseDescription}\nSelect applicable option IDs or provide {"newOption": {"value": "..."}} objects for new options (e.g. ["opt1", {"newOption": {"value": "new_name"}}]).\n\nAvailable options:\n${options.map((o) => `- ${o.displayName} => ${o.id}`).join('\n')}`
|
||||
: `${baseDescription}\nProvide an array of {"newOption": {"value": "..."}} objects for new options.`
|
||||
const itemSchema =
|
||||
options.length > 0
|
||||
? Type.Union([
|
||||
Type.String({
|
||||
enum: options.map((o) => o.id),
|
||||
}),
|
||||
newOptionSchema,
|
||||
])
|
||||
: newOptionSchema
|
||||
schema = Type.Array(itemSchema, { description })
|
||||
break
|
||||
}
|
||||
default:
|
||||
schema = Type.String()
|
||||
schema = Type.String({ description: baseDescription })
|
||||
}
|
||||
|
||||
if (!schema.description) {
|
||||
schema.description = `The field '${fieldName}' represents ${fieldDesc}.`
|
||||
}
|
||||
properties[f.id] = schema
|
||||
// Every field is required but nullable: the agent must return each field key,
|
||||
// using `null` for values it does not know. Nulls are skipped when persisting.
|
||||
// This matches the OpenAI structured-outputs strict-mode convention (all
|
||||
// properties required, optionality expressed via `null`).
|
||||
properties[f.id] = Type.Union([schema, Type.Null()])
|
||||
}
|
||||
|
||||
return Type.Object(properties)
|
||||
return Type.Object(properties, { additionalProperties: false })
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the strict, all-optional metadata schema for the project's CREATION_CONTEXT
|
||||
* fields (the same field set the agent may attach when creating files/versions).
|
||||
* Returns undefined when no project is known or the project defines no fields, in
|
||||
* which case the `metadata` parameter is omitted from the tools entirely.
|
||||
*/
|
||||
async function buildProjectMetadataSchema(projectId?: string): Promise<TSchema | undefined> {
|
||||
if (!projectId) return undefined
|
||||
const fields = await metadataService.listProjectFields('', projectId)
|
||||
const creationFields: AutofillField[] = []
|
||||
for (const f of fields) {
|
||||
const config = f.field.config
|
||||
if (!config || config.autofillSource !== 'CREATION_CONTEXT') continue
|
||||
creationFields.push({
|
||||
id: f.field.key,
|
||||
config,
|
||||
description: f.field.description,
|
||||
})
|
||||
}
|
||||
if (creationFields.length === 0) return undefined
|
||||
return fieldsToTypeBoxSchema(creationFields)
|
||||
}
|
||||
|
||||
function escapeXml(str: string): string {
|
||||
@@ -510,7 +610,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() {
|
||||
@@ -518,7 +617,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)
|
||||
@@ -537,8 +635,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'
|
||||
|
||||
@@ -0,0 +1,117 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
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 { assetService } from '@shumai/core/src/asset/asset'
|
||||
import { authzService } from '@shumai/core/src/authz/authz'
|
||||
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
uploadFileToKey: vi.fn(),
|
||||
putObject: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
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 }),
|
||||
},
|
||||
}))
|
||||
|
||||
/**
|
||||
* Reproduce: pi-ai <= 0.82.1 runs its lenient coercion on typebox v1 schemas and
|
||||
* converts `null` in a `[string, null]` union into `""` (see
|
||||
* coerceWithUnionSchema in @earendil-works/pi-ai/dist/utils/validation.js).
|
||||
*
|
||||
* When the agent calls create_file with `path: null, data: {...}`, the harness
|
||||
* validates first: the `null` path becomes `""`, so the tool's
|
||||
* assertExactlyOneSource believes BOTH path and data were provided and throws
|
||||
* "Provide exactly one of ..." even though the call is valid.
|
||||
*
|
||||
* Fixed upstream in pi-ai 0.84.0 (#7328): values that already match a union arm
|
||||
* are preserved before coercion. This test should pass once @earendil-works/pi-ai
|
||||
* is upgraded to >= 0.84.0.
|
||||
*/
|
||||
describe('reproduce null coercion in harness tool validation', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('keeps path: null when data is provided (no false "exactly one" error)', async () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
|
||||
const validated = validateToolArguments(
|
||||
{
|
||||
name: 'create_file',
|
||||
description: '',
|
||||
parameters: tool.parameters,
|
||||
} as Parameters<typeof validateToolArguments>[0],
|
||||
{
|
||||
type: 'toolCall',
|
||||
id: 'call-1',
|
||||
name: 'create_file',
|
||||
arguments: {
|
||||
parent: '01KYKNP52YERGJ6Q4GTPF5FRQF',
|
||||
path: null,
|
||||
data: { name: 'random_text.txt', content: 'hello' },
|
||||
},
|
||||
} as Parameters<typeof validateToolArguments>[1],
|
||||
) as { path?: unknown; data?: unknown }
|
||||
|
||||
// The `null` path must survive validation untouched; coercion to "" makes
|
||||
// the tool think both path and data were provided.
|
||||
expect(validated.path).toBeNull()
|
||||
expect(validated.data).toEqual({ name: 'random_text.txt', content: 'hello' })
|
||||
|
||||
// execute must accept the valid call (data-only) without throwing
|
||||
const result = await tool.execute('call-1', validated as never)
|
||||
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(authzService.hasPermission).toHaveBeenCalledTimes(1)
|
||||
expect(assetService.createFile).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
it('keeps null metadata values (the "unknown" sentinel) through validation', () => {
|
||||
const tool = createCreateFileTool(
|
||||
'user-1',
|
||||
fieldsToTypeBoxSchema([{ id: 'prompt', config: { name: 'Prompt', type: 'text' } }]),
|
||||
)
|
||||
const validated = validateToolArguments(
|
||||
{
|
||||
name: 'create_file',
|
||||
description: '',
|
||||
parameters: tool.parameters,
|
||||
} as Parameters<typeof validateToolArguments>[0],
|
||||
{
|
||||
type: 'toolCall',
|
||||
id: 'call-1',
|
||||
name: 'create_file',
|
||||
arguments: {
|
||||
parent: 'folder-1',
|
||||
path: null,
|
||||
data: { name: 'a.md', content: 'x' },
|
||||
metadata: { prompt: null },
|
||||
},
|
||||
} as Parameters<typeof validateToolArguments>[1],
|
||||
) as { metadata?: Record<string, unknown> }
|
||||
|
||||
expect(validated.metadata).toEqual({ prompt: null })
|
||||
})
|
||||
})
|
||||
@@ -1,6 +1,22 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
import { type TSchema } from 'typebox'
|
||||
import { Value } from 'typebox/value'
|
||||
import { fieldsToTypeBoxSchema, type AutofillField } from './index'
|
||||
|
||||
interface AnyOfFieldSchema {
|
||||
type?: string
|
||||
enum?: string[]
|
||||
const?: string
|
||||
description?: string
|
||||
items?: { enum?: string[]; type?: string }
|
||||
anyOf?: AnyOfFieldSchema[]
|
||||
}
|
||||
|
||||
function propsOf(schema: TSchema): Record<string, { anyOf?: AnyOfFieldSchema[] }> {
|
||||
return (schema as unknown as { properties: Record<string, { anyOf?: AnyOfFieldSchema[] }> })
|
||||
.properties
|
||||
}
|
||||
|
||||
describe('fieldsToTypeBoxSchema', () => {
|
||||
it('converts text fields', () => {
|
||||
const fields: AutofillField[] = [
|
||||
@@ -8,10 +24,12 @@ describe('fieldsToTypeBoxSchema', () => {
|
||||
{ id: 'f2', config: { name: 'Desc', type: 'longText' } },
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('string')
|
||||
expect(schema.properties.f1.description).toBe("The field 'Title' represents The title.")
|
||||
expect(schema.properties.f2.type).toBe('string')
|
||||
expect(schema.properties.f2.description).toBe("The field 'Desc' represents Desc.")
|
||||
const props = propsOf(schema)
|
||||
expect(props.f1.anyOf![0].type).toBe('string')
|
||||
expect(props.f1.anyOf![1].type).toBe('null')
|
||||
expect(props.f1.anyOf![0].description).toBe("The field 'Title' represents The title.")
|
||||
expect(props.f2.anyOf![0].type).toBe('string')
|
||||
expect(props.f2.anyOf![0].description).toBe("The field 'Desc' represents Desc.")
|
||||
})
|
||||
|
||||
it('converts numeric fields', () => {
|
||||
@@ -20,17 +38,18 @@ describe('fieldsToTypeBoxSchema', () => {
|
||||
{ id: 'f2', config: { name: 'Rating', type: 'rating' } },
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('number')
|
||||
expect(schema.properties.f2.type).toBe('number')
|
||||
const props = propsOf(schema)
|
||||
expect(props.f1.anyOf![0].type).toBe('number')
|
||||
expect(props.f2.anyOf![0].type).toBe('number')
|
||||
})
|
||||
|
||||
it('converts toggle fields', () => {
|
||||
const fields: AutofillField[] = [{ id: 'f1', config: { name: 'Active', type: 'toggle' } }]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('boolean')
|
||||
expect(propsOf(schema).f1.anyOf![0].type).toBe('boolean')
|
||||
})
|
||||
|
||||
it('converts select fields with enums and option descriptions', () => {
|
||||
it('converts select fields with enums, newOption support and option descriptions', () => {
|
||||
const fields: AutofillField[] = [
|
||||
{
|
||||
id: 'f1',
|
||||
@@ -48,14 +67,41 @@ describe('fieldsToTypeBoxSchema', () => {
|
||||
},
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('string')
|
||||
expect(schema.properties.f1.enum).toEqual(['opt1', 'opt2'])
|
||||
expect(schema.properties.f1.description).toBe(
|
||||
"The field 'Species' represents Species of animal.\nSelect one option and return the option ID as the value.\n\nAvailable options:\n- Option 1 => opt1\n- Option 2 => opt2",
|
||||
const selectSchema = propsOf(schema).f1.anyOf![0]
|
||||
expect(selectSchema.anyOf![0].type).toBe('string')
|
||||
expect(selectSchema.anyOf![0].enum).toEqual(['opt1', 'opt2'])
|
||||
expect(selectSchema.anyOf![1].type).toBe('object')
|
||||
expect(selectSchema.description).toBe(
|
||||
'The field \'Species\' represents Species of animal.\nSelect one existing option ID or provide {"newOption": {"value": "..."}} to create a new option.\n\nAvailable options:\n- Option 1 => opt1\n- Option 2 => opt2',
|
||||
)
|
||||
// Declared option IDs, newOption objects, and null are valid
|
||||
expect(Value.Check(schema, { f1: 'opt1' })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: 'opt2' })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: { newOption: { value: 'kling' } } })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: null })).toBe(true)
|
||||
// Arbitrary strings or invalid objects are rejected
|
||||
expect(Value.Check(schema, { f1: 'not-an-option' })).toBe(false)
|
||||
expect(Value.Check(schema, { f1: { newOption: { foo: 'bar' } } })).toBe(false)
|
||||
})
|
||||
|
||||
it('converts selectMulti fields with array enums and option descriptions', () => {
|
||||
it('converts select fields with empty options to newOption schema only', () => {
|
||||
const fields: AutofillField[] = [
|
||||
{
|
||||
id: 'f1',
|
||||
config: {
|
||||
name: 'Provider',
|
||||
type: 'select',
|
||||
select: { options: [] },
|
||||
},
|
||||
},
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(Value.Check(schema, { f1: { newOption: { value: 'kling' } } })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: null })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: 'any-string' })).toBe(false)
|
||||
})
|
||||
|
||||
it('converts selectMulti fields with array enums, newOption support and option descriptions', () => {
|
||||
const fields: AutofillField[] = [
|
||||
{
|
||||
id: 'f1',
|
||||
@@ -72,11 +118,35 @@ describe('fieldsToTypeBoxSchema', () => {
|
||||
},
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('array')
|
||||
expect(schema.properties.f1.items.enum).toEqual(['opt1', 'opt2'])
|
||||
expect(schema.properties.f1.description).toBe(
|
||||
"The field 'Tags' represents Tags.\nSelect applicable options and return the option IDs as the value.\n\nAvailable options:\n- Tag 1 => opt1\n- Tag 2 => opt2",
|
||||
const selectMultiSchema = propsOf(schema).f1.anyOf![0]
|
||||
expect(selectMultiSchema.type).toBe('array')
|
||||
expect(selectMultiSchema.description).toBe(
|
||||
'The field \'Tags\' represents Tags.\nSelect applicable option IDs or provide {"newOption": {"value": "..."}} objects for new options (e.g. ["opt1", {"newOption": {"value": "new_name"}}]).\n\nAvailable options:\n- Tag 1 => opt1\n- Tag 2 => opt2',
|
||||
)
|
||||
expect(Value.Check(schema, { f1: ['opt1', 'opt2'] })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: [{ newOption: { value: 'Tag 3' } }] })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: ['opt1', { newOption: { value: 'Tag 3' } }] })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: null })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: ['opt1', 'bad'] })).toBe(false)
|
||||
expect(Value.Check(schema, { f1: ['opt1', { newOption: { bad: 'value' } }] })).toBe(false)
|
||||
})
|
||||
|
||||
it('converts selectMulti fields with empty options to array of newOption schema', () => {
|
||||
const fields: AutofillField[] = [
|
||||
{
|
||||
id: 'f1',
|
||||
config: {
|
||||
name: 'Tags',
|
||||
type: 'selectMulti',
|
||||
selectMulti: { options: [] },
|
||||
},
|
||||
},
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(Value.Check(schema, { f1: [{ newOption: { value: 'Tag 1' } }] })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: [] })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: null })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: ['tag1'] })).toBe(false)
|
||||
})
|
||||
|
||||
it('defaults to string for unknown types', () => {
|
||||
@@ -85,6 +155,22 @@ describe('fieldsToTypeBoxSchema', () => {
|
||||
{ id: 'f1', config: { name: 'Unknown', type: 'invalid' } },
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
expect(schema.properties.f1.type).toBe('string')
|
||||
expect(propsOf(schema).f1.anyOf![0].type).toBe('string')
|
||||
})
|
||||
|
||||
it('marks every property required (nullable) and rejects unknown keys', () => {
|
||||
const fields: AutofillField[] = [
|
||||
{ id: 'f1', config: { name: 'Title', type: 'text' } },
|
||||
{ id: 'f2', config: { name: 'Rating', type: 'rating' } },
|
||||
]
|
||||
const schema = fieldsToTypeBoxSchema(fields)
|
||||
const props = propsOf(schema)
|
||||
// typebox v1 objects are strict by default: unknown keys are rejected
|
||||
expect(props.f1.anyOf![0].type).toBe('string')
|
||||
expect(props.f1.anyOf![1].type).toBe('null')
|
||||
expect(Value.Check(schema, { f1: 'x', f2: null })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: null, f2: 3 })).toBe(true)
|
||||
expect(Value.Check(schema, { f1: 'x' })).toBe(false)
|
||||
expect(Value.Check(schema, { f1: 'x', f2: null, extra: 1 })).toBe(false)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -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 '@sinclair/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.`)
|
||||
}
|
||||
@@ -1,7 +1,12 @@
|
||||
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'
|
||||
import * as path from 'path'
|
||||
@@ -13,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', () => {
|
||||
@@ -44,7 +67,7 @@ describe('createCreateFileTool', () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-test.md')
|
||||
|
||||
const tool = createCreateFileTool('user-1')
|
||||
const result = await tool.execute('call-1', { parent: 'folder-1', path: filePath })
|
||||
const result = await tool.execute('call-1', { parent: 'folder-1', path: filePath, data: null })
|
||||
|
||||
expect(s3Service.uploadFileToKey).toHaveBeenCalledTimes(1)
|
||||
expect(s3Service.putObject).not.toHaveBeenCalled()
|
||||
@@ -54,62 +77,127 @@ 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 optional context to the agent tool workflow when provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-context.md')
|
||||
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' } },
|
||||
])
|
||||
|
||||
const tool = createCreateFileTool('user-1')
|
||||
const tool = createCreateFileTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: filePath,
|
||||
context: 'Generated using gemini',
|
||||
data: null,
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({ context: 'Generated using gemini' }),
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should not include context in args when not provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-no-context.md')
|
||||
it('should forward select and selectMulti newOption metadata', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-file-new-option.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{
|
||||
id: 'provider',
|
||||
config: {
|
||||
name: 'Provider',
|
||||
type: 'select',
|
||||
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
|
||||
},
|
||||
},
|
||||
{
|
||||
id: 'tags',
|
||||
config: {
|
||||
name: 'Tags',
|
||||
type: 'selectMulti',
|
||||
selectMulti: { options: [{ id: 'tag1', displayName: 'Tag 1', color: '#3b82f6' }] },
|
||||
},
|
||||
},
|
||||
])
|
||||
|
||||
const tool = createCreateFileTool('user-1')
|
||||
await tool.execute('call-1', { parent: 'folder-1', path: filePath })
|
||||
const tool = createCreateFileTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: filePath,
|
||||
data: null,
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
})
|
||||
|
||||
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
|
||||
expect(callArgs).not.toHaveProperty('context')
|
||||
expect(assetService.createFile).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
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' } },
|
||||
])
|
||||
|
||||
const tool = createCreateFileTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: filePath,
|
||||
data: null,
|
||||
metadata: null,
|
||||
})
|
||||
|
||||
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 () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
await expect(
|
||||
tool.execute('call-1', { parent: 'folder-1', path: '/nonexistent/file.md' }),
|
||||
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 () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: null,
|
||||
data: { name: 'notes.md', content: '# Notes\n\nHello' },
|
||||
})
|
||||
|
||||
@@ -125,26 +213,30 @@ 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 () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: null,
|
||||
data: { name: 'script.ts', content: 'const x = 1' },
|
||||
})
|
||||
|
||||
@@ -162,6 +254,7 @@ describe('createCreateFileTool', () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
await tool.execute('call-1', {
|
||||
parent: 'folder-1',
|
||||
path: null,
|
||||
data: { name: 'my/notes.md', content: 'hello' },
|
||||
})
|
||||
|
||||
@@ -174,18 +267,16 @@ 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' }),
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw when neither "path" nor "data" is provided', async () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
await expect(tool.execute('call-1', { parent: 'folder-1' })).rejects.toThrow(
|
||||
'Provide exactly one of "path" (a local file) or "data" (name and content).',
|
||||
)
|
||||
await expect(
|
||||
tool.execute('call-1', { parent: 'folder-1', path: null, data: null }),
|
||||
).rejects.toThrow('Provide exactly one of "path" (a local file) or "data" (name and content).')
|
||||
})
|
||||
|
||||
it('should throw when both "path" and "data" are provided', async () => {
|
||||
@@ -199,6 +290,83 @@ 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', () => {
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
{
|
||||
id: 'source',
|
||||
config: {
|
||||
name: 'Source',
|
||||
type: 'select',
|
||||
select: { options: [{ id: 'gemini', displayName: 'Gemini', color: '#ffffff' }] },
|
||||
},
|
||||
},
|
||||
{ id: 'rating', config: { name: 'Rating', type: 'rating' } },
|
||||
])
|
||||
|
||||
const tool = createCreateFileTool('user-1', metadataSchema)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
const meta = (tool.parameters as any).properties.metadata
|
||||
// `metadata` is a nullable union: [strict object, null]
|
||||
const metaObject = meta.anyOf[0]
|
||||
|
||||
expect(meta).toBeDefined()
|
||||
expect(metaObject.required).toEqual(['prompt', 'source', 'rating'])
|
||||
expect(metaObject.additionalProperties).toBe(false)
|
||||
expect(metaObject.properties.prompt.anyOf[0].type).toBe('string')
|
||||
expect(metaObject.properties.prompt.anyOf[1].type).toBe('null')
|
||||
expect(metaObject.properties.source.anyOf[0].anyOf[0].enum).toEqual(['gemini'])
|
||||
expect(metaObject.properties.rating.anyOf[0].type).toBe('number')
|
||||
|
||||
// Every field must be present (use null when unknown); unknown keys and bad enums are rejected
|
||||
expect(Value.Check(meta, { prompt: 'hello', source: 'gemini', rating: 5 })).toBe(true)
|
||||
expect(
|
||||
Value.Check(meta, {
|
||||
prompt: 'hello',
|
||||
source: { newOption: { value: 'kling' } },
|
||||
rating: 5,
|
||||
}),
|
||||
).toBe(true)
|
||||
expect(Value.Check(meta, { prompt: null, source: null, rating: null })).toBe(true)
|
||||
expect(Value.Check(meta, { prompt: 'hello', source: null, rating: null })).toBe(true)
|
||||
expect(Value.Check(meta, { prompt: 'hello' })).toBe(false)
|
||||
expect(
|
||||
Value.Check(meta, { prompt: 'hello', source: 'gemini', rating: 5, unknownKey: 'x' }),
|
||||
).toBe(false)
|
||||
expect(Value.Check(meta, { prompt: 'hello', source: 'not-an-option', rating: null })).toBe(
|
||||
false,
|
||||
)
|
||||
})
|
||||
|
||||
it('should omit the metadata parameter when no schema is provided', () => {
|
||||
const tool = createCreateFileTool('user-1')
|
||||
// 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,70 +1,87 @@
|
||||
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 } from '@sinclair/typebox'
|
||||
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'
|
||||
|
||||
const createFileSchema = Type.Object({
|
||||
parent: Type.String({
|
||||
description: 'The parent folder ID under which to create the file. This parameter is required.',
|
||||
}),
|
||||
path: Type.Optional(
|
||||
Type.String({
|
||||
description:
|
||||
'The absolute or relative local path to an existing file on disk. Provide either this or "data", but not both.',
|
||||
}),
|
||||
),
|
||||
data: Type.Optional(
|
||||
Type.Object({
|
||||
name: Type.String({
|
||||
minLength: 1,
|
||||
description:
|
||||
'The desired name for the new file, including its extension (e.g. "notes.md").',
|
||||
}),
|
||||
content: Type.String({
|
||||
description: 'The full content of the file as a plain string.',
|
||||
}),
|
||||
}),
|
||||
),
|
||||
context: Type.Optional(
|
||||
Type.String({
|
||||
description:
|
||||
'Optional context passed to the AI metadata autofill workflow for fields that cannot be inferred from file content alone ' +
|
||||
'(e.g. the model or prompt used to generate the asset). ' +
|
||||
'Use list_autofill_fields first to check which fields can be autofilled. ' +
|
||||
'Keep the context short and only include information relevant to those fields.',
|
||||
}),
|
||||
),
|
||||
})
|
||||
interface CreateFileToolParams {
|
||||
parent: string
|
||||
path: string | null
|
||||
data: { name: string; content: string } | null
|
||||
metadata?: Record<string, unknown> | null
|
||||
}
|
||||
|
||||
function assertExactlyOneSource(params: {
|
||||
path?: string
|
||||
data?: { name: string; content: string }
|
||||
}) {
|
||||
const hasPath = params.path !== undefined
|
||||
const hasData = params.data !== undefined
|
||||
function assertExactlyOneSource(params: CreateFileToolParams) {
|
||||
const hasPath = params.path !== null
|
||||
const hasData = params.data !== null
|
||||
if (hasPath === hasData) {
|
||||
throw new Error('Provide exactly one of "path" (a local file) or "data" (name and content).')
|
||||
}
|
||||
return hasPath ? params.path! : params.data!
|
||||
}
|
||||
|
||||
export function createCreateFileTool(userId: string): AgentTool<typeof createFileSchema> {
|
||||
return {
|
||||
export function createCreateFileTool(
|
||||
userId: string,
|
||||
metadataSchema?: TSchema,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool {
|
||||
const createFileSchema = Type.Object(
|
||||
{
|
||||
parent: Type.String({
|
||||
description:
|
||||
'The parent folder ID under which to create the file. This parameter is required.',
|
||||
}),
|
||||
path: Type.Union([
|
||||
Type.String({
|
||||
description:
|
||||
'The absolute or relative local path to an existing file on disk. Provide a value here OR in "data", but not both. Use null if you are providing "data".',
|
||||
}),
|
||||
Type.Null(),
|
||||
]),
|
||||
data: Type.Union([
|
||||
Type.Object(
|
||||
{
|
||||
name: Type.String({
|
||||
minLength: 1,
|
||||
description:
|
||||
'The desired name for the new file, including its extension (e.g. "notes.md").',
|
||||
}),
|
||||
content: Type.String({
|
||||
description: 'The full content of the file as a plain string.',
|
||||
}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
),
|
||||
Type.Null(),
|
||||
]),
|
||||
...(metadataSchema ? { metadata: Type.Union([metadataSchema, Type.Null()]) } : {}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
const tool: AgentTool = {
|
||||
name: 'create_file',
|
||||
label: 'Create File',
|
||||
description:
|
||||
'Create a new file under a folder. You MUST choose exactly ONE creation method: ' +
|
||||
'(1) provide "path" to upload an existing local file, OR ' +
|
||||
'(2) provide "data" with name and content to create a new text file. ' +
|
||||
'Never provide both "path" and "data" together. Never omit both.',
|
||||
'Set the unused parameter to null. ' +
|
||||
'The optional "metadata" parameter accepts only the CREATION_CONTEXT fields declared in its schema; never invent field keys, and use null for fields you do not know.',
|
||||
parameters: createFileSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const source = assertExactlyOneSource(params)
|
||||
// The harness validates tool args against `createFileSchema` before calling
|
||||
// execute, so `params` is guaranteed to match this shape.
|
||||
const p = params as CreateFileToolParams
|
||||
const source = assertExactlyOneSource(p)
|
||||
|
||||
let name: string
|
||||
let size: number
|
||||
@@ -96,23 +113,47 @@ export function createCreateFileTool(userId: string): AgentTool<typeof createFil
|
||||
await s3Service.putObject(process.env.S3_BUCKET || 'shumai', s3Key, content, size, mimeType)
|
||||
}
|
||||
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'create_file',
|
||||
args: {
|
||||
parent: params.parent,
|
||||
s3Key,
|
||||
name,
|
||||
size,
|
||||
contentType: mimeType,
|
||||
...(params.context ? { context: params.context } : {}),
|
||||
},
|
||||
userId,
|
||||
assetId: params.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: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
return tool
|
||||
}
|
||||
|
||||
@@ -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 '@sinclair/typebox'
|
||||
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: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1,7 +1,12 @@
|
||||
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'
|
||||
import * as path from 'path'
|
||||
@@ -12,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', () => {
|
||||
@@ -39,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')
|
||||
@@ -51,47 +74,104 @@ 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 optional context to the agent tool workflow when provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-context.md')
|
||||
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' } },
|
||||
])
|
||||
|
||||
const tool = createCreateVersionTool('user-1')
|
||||
const tool = createCreateVersionTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', {
|
||||
parent: 'file-1',
|
||||
path: filePath,
|
||||
context: 'Generated using gemini',
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
})
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
args: expect.objectContaining({ context: 'Generated using gemini' }),
|
||||
metadata: { prompt: 'Generated using gemini' },
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should not include context in args when not provided', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-no-context.md')
|
||||
it('should forward select and selectMulti newOption metadata', async () => {
|
||||
const filePath = createTempFile('# Hello from disk', 'create-version-new-option.md')
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{
|
||||
id: 'provider',
|
||||
config: {
|
||||
name: 'Provider',
|
||||
type: 'select',
|
||||
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
|
||||
},
|
||||
},
|
||||
{
|
||||
id: 'tags',
|
||||
config: {
|
||||
name: 'Tags',
|
||||
type: 'selectMulti',
|
||||
selectMulti: { options: [{ id: 'tag1', displayName: 'Tag 1', color: '#3b82f6' }] },
|
||||
},
|
||||
},
|
||||
])
|
||||
|
||||
const tool = createCreateVersionTool('user-1')
|
||||
await tool.execute('call-1', { parent: 'file-1', path: filePath })
|
||||
const tool = createCreateVersionTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', {
|
||||
parent: 'file-1',
|
||||
path: filePath,
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
})
|
||||
|
||||
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
|
||||
expect(callArgs).not.toHaveProperty('context')
|
||||
expect(assetService.createVersion).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
metadata: {
|
||||
provider: { newOption: { value: 'Kling' } },
|
||||
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
|
||||
},
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
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' } },
|
||||
])
|
||||
|
||||
const tool = createCreateVersionTool('user-1', metadataSchema)
|
||||
await tool.execute('call-1', { parent: 'file-1', path: filePath, metadata: null })
|
||||
|
||||
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 () => {
|
||||
@@ -100,6 +180,62 @@ 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', () => {
|
||||
const metadataSchema = fieldsToTypeBoxSchema([
|
||||
{ id: 'prompt', config: { name: 'Prompt', type: 'text' } },
|
||||
{ id: 'toggle', config: { name: 'Active', type: 'toggle' } },
|
||||
])
|
||||
|
||||
const tool = createCreateVersionTool('user-1', metadataSchema)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- inspecting the runtime schema shape of the dynamically-built tool
|
||||
const meta = (tool.parameters as any).properties.metadata
|
||||
// `metadata` is a nullable union: [strict object, null]
|
||||
const metaObject = meta.anyOf[0]
|
||||
|
||||
expect(meta).toBeDefined()
|
||||
expect(metaObject.required).toEqual(['prompt', 'toggle'])
|
||||
expect(metaObject.additionalProperties).toBe(false)
|
||||
expect(metaObject.properties.prompt.anyOf[0].type).toBe('string')
|
||||
expect(metaObject.properties.prompt.anyOf[1].type).toBe('null')
|
||||
expect(metaObject.properties.toggle.anyOf[0].type).toBe('boolean')
|
||||
|
||||
expect(Value.Check(meta, { prompt: 'p', toggle: true })).toBe(true)
|
||||
expect(Value.Check(meta, { prompt: null, toggle: null })).toBe(true)
|
||||
expect(Value.Check(meta, { prompt: 'p', toggle: null, unknownKey: 'x' })).toBe(false)
|
||||
})
|
||||
|
||||
it('should omit the metadata parameter when no schema is provided', () => {
|
||||
const tool = createCreateVersionTool('user-1')
|
||||
// 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,69 +1,108 @@
|
||||
import { Type } from '@sinclair/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'
|
||||
|
||||
const createVersionSchema = Type.Object({
|
||||
parent: Type.String({
|
||||
description:
|
||||
'The parent file ID for which to create a new version. This parameter is required.',
|
||||
}),
|
||||
path: Type.String({
|
||||
description:
|
||||
'The absolute or relative local path to the file on disk. This parameter is required.',
|
||||
}),
|
||||
context: Type.Optional(
|
||||
Type.String({
|
||||
description:
|
||||
'Optional context passed to the AI metadata autofill workflow for fields that cannot be inferred from file content alone ' +
|
||||
'(e.g. the model or prompt used to generate the asset). ' +
|
||||
'Use list_autofill_fields first to check which fields can be autofilled. ' +
|
||||
'Keep the context short and only include information relevant to those fields.',
|
||||
}),
|
||||
),
|
||||
})
|
||||
interface CreateVersionToolParams {
|
||||
parent: string
|
||||
path: string
|
||||
metadata?: Record<string, unknown> | null
|
||||
}
|
||||
|
||||
export function createCreateVersionTool(userId: string): AgentTool<typeof createVersionSchema> {
|
||||
return {
|
||||
export function createCreateVersionTool(
|
||||
userId: string,
|
||||
metadataSchema?: TSchema,
|
||||
agentContext?: { teamId?: string; agentId?: string },
|
||||
): AgentTool {
|
||||
const createVersionSchema = Type.Object(
|
||||
{
|
||||
parent: Type.String({
|
||||
description:
|
||||
'The parent file ID for which to create a new version. This parameter is required.',
|
||||
}),
|
||||
path: Type.String({
|
||||
description:
|
||||
'The absolute or relative local path to the file on disk. This parameter is required.',
|
||||
}),
|
||||
...(metadataSchema ? { metadata: Type.Union([metadataSchema, Type.Null()]) } : {}),
|
||||
},
|
||||
{ additionalProperties: false },
|
||||
)
|
||||
|
||||
const tool: AgentTool = {
|
||||
name: 'create_version',
|
||||
label: 'Create Version',
|
||||
description: 'Create a new version of an existing file from a local file path.',
|
||||
description:
|
||||
'Create a new version of an existing file from a local file path. ' +
|
||||
'The optional "metadata" parameter accepts only the CREATION_CONTEXT fields declared in its schema; never invent field keys, and use null for fields you do not know.',
|
||||
parameters: createVersionSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const absolutePath = path.resolve(process.cwd(), params.path)
|
||||
// The harness validates tool args against `createVersionSchema` before calling
|
||||
// execute, so `params` is guaranteed to match this shape.
|
||||
const p = params as CreateVersionToolParams
|
||||
const absolutePath = path.resolve(process.cwd(), p.path)
|
||||
if (!fs.existsSync(absolutePath)) {
|
||||
throw new Error(`Local file not found at path: ${params.path}`)
|
||||
throw new Error(`Local file not found at path: ${p.path}`)
|
||||
}
|
||||
|
||||
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: params.parent,
|
||||
s3Key,
|
||||
name: path.basename(absolutePath),
|
||||
size: fileSize,
|
||||
contentType: mimeType,
|
||||
...(params.context ? { context: params.context } : {}),
|
||||
},
|
||||
userId,
|
||||
assetId: params.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: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
return tool
|
||||
}
|
||||
|
||||
@@ -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(),
|
||||
},
|
||||
},
|
||||
}
|
||||
})
|
||||
@@ -22,6 +30,8 @@ vi.mock('@shumai/db', async (importOriginal) => {
|
||||
vi.mock('@shumai/core/src/s3/s3', () => ({
|
||||
s3Service: {
|
||||
getObject: vi.fn(),
|
||||
headObject: vi.fn(),
|
||||
downloadToFile: vi.fn(),
|
||||
},
|
||||
}))
|
||||
|
||||
@@ -52,163 +62,378 @@ 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.downloadToFile).mockImplementation(async (_b, _k, dest) => {
|
||||
await fs.promises.writeFile(dest, 'fake-proxy-image-bytes')
|
||||
})
|
||||
vi.mocked(s3Service.headObject).mockResolvedValue({
|
||||
contentType: 'image/webp',
|
||||
} as unknown as Awaited<ReturnType<typeof s3Service.headObject>>)
|
||||
|
||||
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',
|
||||
})
|
||||
|
||||
const expectedPath = path.join(piDir, 'asset-img-1_sample_photo.jpg')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(s3Service.downloadToFile).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'proxy/sample_photo.webp',
|
||||
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.downloadToFile).mockImplementation(async (_b, _k, dest) => {
|
||||
await fs.promises.writeFile(dest, 'fake-version-bytes')
|
||||
})
|
||||
vi.mocked(s3Service.headObject).mockResolvedValue({
|
||||
contentType: 'image/webp',
|
||||
} as unknown as Awaited<ReturnType<typeof s3Service.headObject>>)
|
||||
|
||||
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 },
|
||||
})
|
||||
|
||||
const expectedPath = path.join(piDir, 'file-ver-2_banana_pig.png')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(s3Service.downloadToFile).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'proxy/banana_pig.webp',
|
||||
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.downloadToFile).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.downloadToFile).mockImplementation(async (_b, _k, dest) => {
|
||||
await fs.promises.writeFile(dest, 'fake-screenshot-bytes')
|
||||
})
|
||||
vi.mocked(s3Service.headObject).mockResolvedValue({
|
||||
contentType: 'image/webp',
|
||||
} as unknown as Awaited<ReturnType<typeof s3Service.headObject>>)
|
||||
|
||||
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',
|
||||
})
|
||||
|
||||
const expectedPath = path.join(piDir, 'shot_5.0s.webp')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(s3Service.downloadToFile).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/ast-123/screenshots/shot_5.0s.webp',
|
||||
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.downloadToFile).mockImplementation(async (_b, _k, dest) => {
|
||||
await fs.promises.writeFile(dest, 'fake-original-photo-bytes')
|
||||
})
|
||||
vi.mocked(s3Service.headObject).mockResolvedValue({
|
||||
contentType: 'image/png',
|
||||
} as unknown as Awaited<ReturnType<typeof s3Service.headObject>>)
|
||||
|
||||
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',
|
||||
})
|
||||
|
||||
const expectedPath = path.join(piDir, 'photo.png')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(s3Service.downloadToFile).toHaveBeenCalledWith(
|
||||
'shumai',
|
||||
'files/upload-ulid-456/photo.png',
|
||||
expectedPath,
|
||||
)
|
||||
|
||||
expect(fs.existsSync(expectedPath)).toBe(true)
|
||||
expect(result.details.assetId).toBe('asset-photo-1')
|
||||
})
|
||||
|
||||
it('should fall back to file MIME detection when headObject returns generic application/octet-stream', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue(null)
|
||||
vi.mocked(prisma.storageKey.findFirst).mockResolvedValue({
|
||||
id: 'sk-2',
|
||||
key: 'files/upload-ulid-789/graphic.png',
|
||||
assets: [{ id: 'asset-graphic-1' }],
|
||||
} as unknown as StorageKey & { assets: Asset[] })
|
||||
vi.mocked(authzService.hasPermission).mockResolvedValue()
|
||||
|
||||
vi.mocked(s3Service.downloadToFile).mockImplementation(async (_b, _k, dest) => {
|
||||
const pngHeader = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a])
|
||||
await fs.promises.writeFile(dest, pngHeader)
|
||||
})
|
||||
vi.mocked(s3Service.headObject).mockResolvedValue({
|
||||
contentType: 'application/octet-stream',
|
||||
} as unknown as Awaited<ReturnType<typeof s3Service.headObject>>)
|
||||
|
||||
const tool = createDownloadAssetTool('user-1')
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: null,
|
||||
key: 'files/upload-ulid-789/graphic.png',
|
||||
})
|
||||
|
||||
const expectedPath = path.join(piDir, 'graphic.png')
|
||||
createdFiles.push(expectedPath)
|
||||
|
||||
expect(result.details.contentType).toBe('image/png')
|
||||
})
|
||||
})
|
||||
|
||||
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.',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,88 +1,147 @@
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
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, readFileMimeType } 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,146 @@ 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 objectInfo = await s3Service.headObject(bucket, mediaKey).catch(() => null)
|
||||
await s3Service.downloadToFile(bucket, mediaKey, targetFilePath)
|
||||
const stat = await fs.promises
|
||||
.stat(targetFilePath)
|
||||
.catch(() => ({ size: objectInfo?.size ?? 0 }))
|
||||
const contentType =
|
||||
objectInfo?.contentType && objectInfo.contentType !== 'application/octet-stream'
|
||||
? objectInfo.contentType
|
||||
: readFileMimeType(targetFilePath)
|
||||
|
||||
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,
|
||||
size: stat.size,
|
||||
},
|
||||
],
|
||||
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 objectInfo = await s3Service.headObject(bucket, key).catch(() => null)
|
||||
await s3Service.downloadToFile(bucket, key, targetFilePath)
|
||||
const stat = await fs.promises
|
||||
.stat(targetFilePath)
|
||||
.catch(() => ({ size: objectInfo?.size ?? 0 }))
|
||||
const contentType =
|
||||
objectInfo?.contentType && objectInfo.contentType !== 'application/octet-stream'
|
||||
? objectInfo.contentType
|
||||
: readFileMimeType(targetFilePath)
|
||||
|
||||
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,
|
||||
size: stat.size,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
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 '@sinclair/typebox'
|
||||
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: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createListAutofillFieldsTool } from './list-autofill-fields'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
|
||||
vi.mock('./utils', () => ({
|
||||
executeAgentToolWorkflow: vi.fn().mockResolvedValue({
|
||||
fields: [{ name: 'Source', type: 'select', options: [{ displayName: 'Gemini' }] }],
|
||||
}),
|
||||
}))
|
||||
|
||||
describe('createListAutofillFieldsTool', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
|
||||
it('should list autofill fields for the parent folder via the agent tool workflow', async () => {
|
||||
const tool = createListAutofillFieldsTool('user-1')
|
||||
const result = await tool.execute('call-1', { parent: 'folder-1' })
|
||||
|
||||
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
|
||||
toolName: 'list_autofill_fields',
|
||||
args: { parent: 'folder-1' },
|
||||
userId: 'user-1',
|
||||
assetId: 'folder-1',
|
||||
})
|
||||
|
||||
expect(result.details).toEqual({
|
||||
fields: [{ name: 'Source', type: 'select', options: [{ displayName: 'Gemini' }] }],
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,35 +0,0 @@
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { executeAgentToolWorkflow } from './utils'
|
||||
|
||||
const listAutofillFieldsSchema = Type.Object({
|
||||
parent: Type.String({
|
||||
description:
|
||||
'The parent folder ID whose project autofillable metadata fields to list. This parameter is required.',
|
||||
}),
|
||||
})
|
||||
|
||||
export function createListAutofillFieldsTool(
|
||||
userId: string,
|
||||
): AgentTool<typeof listAutofillFieldsSchema> {
|
||||
return {
|
||||
name: 'list_autofill_fields',
|
||||
label: 'List Autofill Fields',
|
||||
description:
|
||||
'List the AI-autofillable metadata fields defined for the project of a parent folder, including their types and available options. ' +
|
||||
'Use this before creating a file or version so you can pass relevant context (e.g. the model or prompt used to generate the asset) to create_file/create_version.',
|
||||
parameters: listAutofillFieldsSchema,
|
||||
execute: async (_toolCallId, params) => {
|
||||
const result = await executeAgentToolWorkflow({
|
||||
toolName: 'list_autofill_fields',
|
||||
args: params,
|
||||
userId,
|
||||
assetId: params.parent,
|
||||
})
|
||||
return {
|
||||
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
|
||||
details: result,
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -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,775 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { createReadAssetTool, type ReadAssetAuthContext } 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")',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('ReadAssetAuthContext & Security Boundaries', () => {
|
||||
it('throws authorization error if chat agent lacks userId', async () => {
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'chat',
|
||||
teamId: 'team-1',
|
||||
})
|
||||
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('throws error if autofill agent lacks targetAssetId', async () => {
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'autofill',
|
||||
teamId: 'team-1',
|
||||
} as unknown as ReadAssetAuthContext)
|
||||
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'asset-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Target asset ID is required for autofill agent authorization.')
|
||||
})
|
||||
|
||||
it('throws error if autofill agent lacks teamId', async () => {
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'autofill',
|
||||
targetAssetId: 'asset-1',
|
||||
} as unknown as ReadAssetAuthContext)
|
||||
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'asset-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Team ID is required for autofill agent authorization.')
|
||||
})
|
||||
|
||||
it('denies autofill agent if asset belongs to another team', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'asset-1',
|
||||
project: { teamId: 'other-team' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'autofill',
|
||||
teamId: 'team-1',
|
||||
targetAssetId: 'asset-1',
|
||||
})
|
||||
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'asset-1',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Access denied: asset asset-1 does not belong to team team-1.')
|
||||
})
|
||||
|
||||
it('denies autofill agent if reading an unrelated asset not matching targetAssetId', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'other-asset',
|
||||
parentId: null,
|
||||
project: { teamId: 'team-1' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'autofill',
|
||||
teamId: 'team-1',
|
||||
targetAssetId: 'target-asset-id',
|
||||
})
|
||||
|
||||
await expect(
|
||||
tool.execute('call-1', {
|
||||
assetId: 'other-asset',
|
||||
annotationId: null,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
}),
|
||||
).rejects.toThrow('Access denied: autofill agent can only read target asset target-asset-id.')
|
||||
})
|
||||
|
||||
it('allows autofill agent to read target asset without userId', async () => {
|
||||
vi.mocked(prisma.asset.findUnique).mockResolvedValue({
|
||||
id: 'target-asset-id',
|
||||
name: 'test.png',
|
||||
mediaType: 'image/png',
|
||||
storageKey: { key: 'raw/test.png' },
|
||||
media: { proxyType: 'image' },
|
||||
project: { teamId: 'team-1' },
|
||||
} as unknown as Asset)
|
||||
|
||||
const tool = createReadAssetTool({
|
||||
agentType: 'autofill',
|
||||
teamId: 'team-1',
|
||||
targetAssetId: 'target-asset-id',
|
||||
})
|
||||
|
||||
const result = await tool.execute('call-1', {
|
||||
assetId: 'target-asset-id',
|
||||
annotationId: null,
|
||||
s3KeyOnly: true,
|
||||
imageConfig: null,
|
||||
videoConfig: null,
|
||||
docConfig: null,
|
||||
})
|
||||
|
||||
expect(authzService.hasPermission).not.toHaveBeenCalled()
|
||||
expect(result.content.length).toBe(1)
|
||||
expect((result.content[0] as { type: 'text'; text: string }).text).toContain(
|
||||
'target-asset-id',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,690 @@
|
||||
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 type ReadAssetAuthContext =
|
||||
| {
|
||||
userId?: string
|
||||
teamId?: string
|
||||
agentType?: 'chat' | 'embedding'
|
||||
targetAssetId?: string
|
||||
}
|
||||
| {
|
||||
userId?: undefined
|
||||
teamId: string
|
||||
agentType: 'autofill'
|
||||
targetAssetId: string
|
||||
}
|
||||
|
||||
export function createReadAssetTool(
|
||||
auth: string | ReadAssetAuthContext,
|
||||
): AgentTool<typeof readAssetSchema> {
|
||||
const authContext: ReadAssetAuthContext =
|
||||
typeof auth === 'string' ? { userId: auth, agentType: 'chat' } : auth
|
||||
const { userId, teamId, agentType = 'chat', targetAssetId } = authContext
|
||||
|
||||
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 (agentType === 'autofill' && !userId) {
|
||||
if (!targetAssetId) {
|
||||
throw new Error('Target asset ID is required for autofill agent authorization.')
|
||||
}
|
||||
if (!teamId) {
|
||||
throw new Error('Team ID is required for autofill agent authorization.')
|
||||
}
|
||||
|
||||
// System background execution for Autofill Agent
|
||||
const assetRecord = await prisma.asset.findUnique({
|
||||
where: { id: assetId },
|
||||
include: { project: true, teamRootFolder: true },
|
||||
})
|
||||
if (!assetRecord) {
|
||||
throw new Error(`Asset with ID ${assetId} not found.`)
|
||||
}
|
||||
|
||||
// Strict team boundary check
|
||||
const assetTeamId = assetRecord.project?.teamId || assetRecord.teamRootFolder?.id
|
||||
if (!assetTeamId || assetTeamId !== teamId) {
|
||||
throw new Error(`Access denied: asset ${assetId} does not belong to team ${teamId}.`)
|
||||
}
|
||||
|
||||
// Strict target asset boundary check (allows the target asset or its version stack children)
|
||||
if (assetRecord.id !== targetAssetId && assetRecord.parentId !== targetAssetId) {
|
||||
throw new Error(
|
||||
`Access denied: autofill agent can only read target asset ${targetAssetId}.`,
|
||||
)
|
||||
}
|
||||
} else {
|
||||
// Chat agents or user-driven executions strictly require a userId and full ACL validation
|
||||
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 '@sinclair/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,
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -307,6 +307,77 @@ describe('readSkillTool', () => {
|
||||
reviewerTool.execute('1', { skillId: ownerSkill.id }, undefined, undefined),
|
||||
).rejects.toThrow('Permission denied')
|
||||
})
|
||||
|
||||
it('uses the effective project role for skill permission checks', async () => {
|
||||
const team = await prisma.team.create({ data: { name: 'Project Skill Team' } })
|
||||
const project = await prisma.project.create({ data: { name: 'Skill Proj', teamId: team.id } })
|
||||
const editorSkill = await prisma.skill.create({
|
||||
data: {
|
||||
name: 'Editor Project Skill',
|
||||
assetId: 'asset1',
|
||||
hash: 'proj-editor-hash',
|
||||
teamId: team.id,
|
||||
permission: 'editor',
|
||||
},
|
||||
})
|
||||
|
||||
// Team editor demoted to project reviewer: denied inside the project
|
||||
const demoted = await prisma.user.create({
|
||||
data: { name: 'Demoted Skill', email: 'dem-skill@test.com' },
|
||||
})
|
||||
const demotedTm = await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: demoted.id, role: 'editor', scope: 'team' },
|
||||
})
|
||||
await prisma.projectMember.create({
|
||||
data: { projectId: project.id, teamMemberId: demotedTm.id, role: 'reviewer' },
|
||||
})
|
||||
|
||||
const demotedTool = createReadSkillTool(
|
||||
demoted.id,
|
||||
() => {},
|
||||
undefined,
|
||||
undefined,
|
||||
project.id,
|
||||
)
|
||||
await expect(
|
||||
demotedTool.execute('1', { skillId: editorSkill.id }, undefined, undefined),
|
||||
).rejects.toThrow('Permission denied')
|
||||
|
||||
// Project-scoped member invited as editor: allowed
|
||||
const projEditor = await prisma.user.create({
|
||||
data: { name: 'PE Skill', email: 'pe-skill@test.com' },
|
||||
})
|
||||
const projEditorTm = await prisma.teamMember.create({
|
||||
data: { teamId: team.id, userId: projEditor.id, role: 'reviewer', scope: 'project' },
|
||||
})
|
||||
await prisma.projectMember.create({
|
||||
data: { projectId: project.id, teamMemberId: projEditorTm.id, role: 'editor' },
|
||||
})
|
||||
|
||||
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mocking node fs calls
|
||||
vi.spyOn(fs, 'readFileSync').mockImplementation((path: any) => {
|
||||
if (path.toString().endsWith('.hash')) return 'proj-editor-hash'
|
||||
if (path.toString().endsWith('SKILL.md')) return '# Editor Project Skill Content'
|
||||
return ''
|
||||
})
|
||||
|
||||
const projEditorTool = createReadSkillTool(
|
||||
projEditor.id,
|
||||
() => {},
|
||||
undefined,
|
||||
undefined,
|
||||
project.id,
|
||||
)
|
||||
const result = await projEditorTool.execute(
|
||||
'1',
|
||||
{ skillId: editorSkill.id },
|
||||
undefined,
|
||||
undefined,
|
||||
)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
expect((result.content[0] as any).text).toBe('# Editor Project Skill Content')
|
||||
})
|
||||
})
|
||||
|
||||
describe('onSkillLoaded callback', () => {
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { Type } from 'typebox'
|
||||
import { type AgentTool } from '@earendil-works/pi-agent-core'
|
||||
import { agentService } from '@shumai/core/src/agent/agent'
|
||||
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
|
||||
|
||||
const readSkillSchema = Type.Object({
|
||||
skillId: Type.String({ description: 'The ID of the skill to read' }),
|
||||
@@ -18,6 +19,7 @@ export const createReadSkillTool = (
|
||||
onEnvsAdded: (envs: Record<string, string>) => void,
|
||||
onSkillLoaded?: () => Promise<void> | void,
|
||||
enabledSkillIds?: string[],
|
||||
projectId?: string,
|
||||
): AgentTool<typeof readSkillSchema, { skillId: string }> => ({
|
||||
name: 'read_skill',
|
||||
label: 'Read Agent Skill',
|
||||
@@ -39,17 +41,14 @@ export const createReadSkillTool = (
|
||||
}
|
||||
|
||||
const requiredLevel = ROLE_HIERARCHY[skill.permission] || 1
|
||||
const effectiveRole = userId
|
||||
? await resolveEffectiveRole(skill.teamId, projectId, userId)
|
||||
: null
|
||||
|
||||
if (userId) {
|
||||
const member = await prisma.teamMember.findUnique({
|
||||
where: {
|
||||
teamIdUserId: {
|
||||
teamId: skill.teamId,
|
||||
userId,
|
||||
},
|
||||
},
|
||||
})
|
||||
const userLevel = member ? ROLE_HIERARCHY[member.role] || 0 : 0
|
||||
// Resolve the user's effective role for the project context (project
|
||||
// override wins; project-scoped members without project access are denied).
|
||||
const userLevel = effectiveRole ? ROLE_HIERARCHY[effectiveRole] || 0 : 0
|
||||
if (userLevel < requiredLevel) {
|
||||
throw new Error(
|
||||
`Permission denied: Insufficient role to load skill "${skill.name}". Minimum required role is "${skill.permission}".`,
|
||||
|
||||
@@ -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="..." />')
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,14 +1,28 @@
|
||||
import { prisma } from '@shumai/db'
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { Type } from 'typebox'
|
||||
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: {},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -66,7 +66,13 @@ describe('createSandboxedBashTool', () => {
|
||||
|
||||
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
|
||||
|
||||
expect(SandboxManager.wrapWithSandbox).toHaveBeenCalledWith('echo hello')
|
||||
expect(SandboxManager.wrapWithSandbox).toHaveBeenCalledWith(
|
||||
'echo hello',
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
{ commandId: '1' },
|
||||
)
|
||||
expect(spawn).toHaveBeenCalledWith(
|
||||
'bash',
|
||||
['-c', 'sandboxed-echo hello'],
|
||||
@@ -116,7 +122,13 @@ describe('createSandboxedBashTool', () => {
|
||||
const executePromise = tool.execute('1', { command: 'echo skill', source: 'skill' }, signal)
|
||||
|
||||
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
|
||||
expect(SandboxManager.wrapWithSandbox).toHaveBeenCalledWith('echo skill')
|
||||
expect(SandboxManager.wrapWithSandbox).toHaveBeenCalledWith(
|
||||
'echo skill',
|
||||
undefined,
|
||||
undefined,
|
||||
undefined,
|
||||
{ commandId: '1' },
|
||||
)
|
||||
|
||||
mockStdout.emit('data', Buffer.from('skill output'))
|
||||
mockChild.emit('close', 0)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { logger } from '@shumai/core/src/logger'
|
||||
import { SandboxManager } from '@anthropic-ai/sandbox-runtime'
|
||||
import { sandboxService } from '@shumai/core/src/sandbox/sandbox-service'
|
||||
import { type AgentTool, type AgentToolResult } from '@earendil-works/pi-agent-core'
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { Type } from 'typebox'
|
||||
import { spawn } from 'node:child_process'
|
||||
import { OutputAccumulator } from '../utils/output-accumulator'
|
||||
import {
|
||||
@@ -10,6 +10,8 @@ import {
|
||||
formatSize,
|
||||
type TruncationResult,
|
||||
} from '../utils/truncate'
|
||||
import { quotaService } from '@shumai/core/src/quota/quota-service'
|
||||
import type { TeamMemberRole } from '@shumai/db'
|
||||
|
||||
const BashSource = Type.String({
|
||||
enum: ['user', 'skill'],
|
||||
@@ -33,7 +35,10 @@ export interface BashDetails {
|
||||
}
|
||||
|
||||
export interface SandboxedBashOptions {
|
||||
getBlockedHost?: () => string
|
||||
teamId?: string
|
||||
userId?: string
|
||||
role?: TeamMemberRole | null
|
||||
getBlockedHost?: (commandId?: string) => string
|
||||
clearBlockedHost?: () => void
|
||||
/**
|
||||
* When true, the tool only allows commands requested by a loaded skill (source="skill").
|
||||
@@ -66,8 +71,20 @@ export const createSandboxedBashTool = (
|
||||
'Only commands required by a loaded skill (source="skill") can be executed.',
|
||||
)
|
||||
}
|
||||
if (options?.teamId) {
|
||||
await quotaService.checkQuota(
|
||||
{
|
||||
teamId: options.teamId,
|
||||
userId: options.userId,
|
||||
role: options.role,
|
||||
resource: 'agent_bash_call_count',
|
||||
resourceData: { command },
|
||||
},
|
||||
1,
|
||||
)
|
||||
}
|
||||
options?.clearBlockedHost?.()
|
||||
const wrappedCommand = await SandboxManager.wrapWithSandbox(command)
|
||||
const wrappedCommand = await sandboxService.wrapCommand(command, { commandId: toolCallId })
|
||||
|
||||
const output = new OutputAccumulator({ tempFilePrefix: 'shumai-bash' })
|
||||
let acceptingOutput = true
|
||||
@@ -215,10 +232,27 @@ export const createSandboxedBashTool = (
|
||||
if (timeoutHandle) clearTimeout(timeoutHandle)
|
||||
signal?.removeEventListener('abort', onAbort)
|
||||
|
||||
const blocked = options?.getBlockedHost?.()
|
||||
const blocked = options?.getBlockedHost?.(toolCallId)
|
||||
const snapshot = await finishOutput()
|
||||
const { text: outputText, details: truncationDetails } = formatOutput(snapshot)
|
||||
|
||||
if (options?.teamId) {
|
||||
try {
|
||||
await quotaService.consumeQuota(
|
||||
{
|
||||
teamId: options.teamId,
|
||||
userId: options.userId,
|
||||
role: options.role,
|
||||
resource: 'agent_bash_call_count',
|
||||
resourceData: { command },
|
||||
},
|
||||
1,
|
||||
)
|
||||
} catch (err) {
|
||||
logger.error({ err }, 'Failed to record quota usage for bash command')
|
||||
}
|
||||
}
|
||||
|
||||
if (signal?.aborted) {
|
||||
logger.error({ command, outputText }, 'Sandboxed bash command aborted')
|
||||
reject(new Error(appendStatus(outputText, 'Command aborted')))
|
||||
|
||||
@@ -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 '@sinclair/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
|
||||
}
|
||||
@@ -27,9 +27,6 @@ describe('Agent Autofill Workflow', () => {
|
||||
_activityName: 'updateTaskStatusActivity',
|
||||
}),
|
||||
getAssetActivity: Object.assign(vi.fn(), { _activityName: 'getAssetActivity' }),
|
||||
extractAiMetadataActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'extractAiMetadataActivity',
|
||||
}),
|
||||
getProjectAutofillFieldsActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getProjectAutofillFieldsActivity',
|
||||
}),
|
||||
@@ -46,39 +43,27 @@ describe('Agent Autofill Workflow', () => {
|
||||
}),
|
||||
createCommentActivity: Object.assign(vi.fn(), { _activityName: 'createCommentActivity' }),
|
||||
updateCommentActivity: Object.assign(vi.fn(), { _activityName: 'updateCommentActivity' }),
|
||||
getTranscodeWorkerQueueActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getTranscodeWorkerQueueActivity',
|
||||
}),
|
||||
getAgentWorkerQueueActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'getAgentWorkerQueueActivity',
|
||||
}),
|
||||
downloadMediaToTmpActivity: Object.assign(vi.fn(), {
|
||||
_activityName: 'downloadMediaToTmpActivity',
|
||||
}),
|
||||
cleanupTmpDirActivity: Object.assign(vi.fn(), { _activityName: 'cleanupTmpDirActivity' }),
|
||||
}
|
||||
|
||||
mockActivities.getAgentWorkerQueueActivity.mockResolvedValue('agent_queue')
|
||||
mockActivities.getTranscodeWorkerQueueActivity.mockResolvedValue('transcode_queue')
|
||||
mockActivities.updateTaskStatusActivity.mockResolvedValue({})
|
||||
mockActivities.createCommentActivity.mockResolvedValue({ id: 'comment-placeholder-id' })
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'a1',
|
||||
name: 'test.png',
|
||||
projectId: 'p1',
|
||||
storageKey: { key: 'asset-key' },
|
||||
project: { id: 'p1', teamId: 't1' },
|
||||
mediaType: 'image/png',
|
||||
media: { proxyType: 'image' },
|
||||
media: { proxyType: 'image', duration: 10 },
|
||||
})
|
||||
mockActivities.downloadMediaToTmpActivity.mockResolvedValue({
|
||||
filePath: '/tmp/test.png',
|
||||
tmpDir: '/tmp/test-dir',
|
||||
})
|
||||
mockActivities.extractAiMetadataActivity.mockResolvedValue(['/tmp/test-dir/1.webp'])
|
||||
mockActivities.getProjectAutofillFieldsActivity.mockResolvedValue([
|
||||
{ key: 'title', config: { name: 'Title', type: 'text' }, description: 'The title' },
|
||||
])
|
||||
mockActivities.getAgentAutofillContextActivity.mockResolvedValue({ agent: { id: 'b1' } })
|
||||
mockActivities.getAssetAutofillContextActivity.mockResolvedValue('Generated using gemini')
|
||||
mockActivities.autofillAiActivity.mockResolvedValue({
|
||||
text: '{"title":"Extracted Title"}',
|
||||
sessionId: 'session-123',
|
||||
@@ -110,7 +95,6 @@ describe('Agent Autofill Workflow', () => {
|
||||
|
||||
// Verify queue discovery
|
||||
expect(mockActivities.getAgentWorkerQueueActivity).toHaveBeenCalled()
|
||||
expect(mockActivities.getTranscodeWorkerQueueActivity).toHaveBeenCalled()
|
||||
|
||||
// Verify task processing status
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
@@ -118,6 +102,9 @@ describe('Agent Autofill Workflow', () => {
|
||||
status: 'processing',
|
||||
})
|
||||
|
||||
// Verify asset fetched
|
||||
expect(mockActivities.getAssetActivity).toHaveBeenCalledWith('a1')
|
||||
|
||||
// Verify placeholder comment created
|
||||
expect(mockActivities.createCommentActivity).toHaveBeenCalledWith({
|
||||
assetId: 'a1',
|
||||
@@ -126,26 +113,21 @@ describe('Agent Autofill Workflow', () => {
|
||||
agentId: 'agent-1',
|
||||
})
|
||||
|
||||
// Verify download, extraction and fields fetched
|
||||
expect(mockActivities.downloadMediaToTmpActivity).toHaveBeenCalledWith({
|
||||
assetKey: 'asset-key',
|
||||
})
|
||||
expect(mockActivities.extractAiMetadataActivity).toHaveBeenCalledWith({
|
||||
assetKey: 'asset-key',
|
||||
filePath: '/tmp/test.png',
|
||||
type: 'autofill',
|
||||
isImage: true,
|
||||
})
|
||||
// Verify fields and context fetched
|
||||
expect(mockActivities.getProjectAutofillFieldsActivity).toHaveBeenCalledWith('p1')
|
||||
expect(mockActivities.getAgentAutofillContextActivity).toHaveBeenCalledWith({
|
||||
teamId: 't1',
|
||||
})
|
||||
expect(mockActivities.getAssetAutofillContextActivity).toHaveBeenCalledWith('a1')
|
||||
|
||||
// Verify AI autofill called with mapped fields
|
||||
// Verify AI autofill called with asset details and mapped fields
|
||||
expect(mockActivities.autofillAiActivity).toHaveBeenCalledWith({
|
||||
teamId: 't1',
|
||||
images: ['/tmp/test-dir/1.webp'],
|
||||
assetId: 'a1',
|
||||
assetName: 'test.png',
|
||||
mediaType: 'image/png',
|
||||
duration: undefined,
|
||||
pageCount: undefined,
|
||||
projectId: 'p1',
|
||||
fields: [
|
||||
{
|
||||
id: 'title',
|
||||
@@ -154,7 +136,6 @@ describe('Agent Autofill Workflow', () => {
|
||||
},
|
||||
],
|
||||
context: { agent: { id: 'b1' } },
|
||||
agentContext: 'Generated using gemini',
|
||||
})
|
||||
|
||||
// Verify task usage update
|
||||
@@ -183,11 +164,6 @@ describe('Agent Autofill Workflow', () => {
|
||||
sessionId: 'session-123',
|
||||
})
|
||||
|
||||
// Verify cleanup was called
|
||||
expect(mockActivities.cleanupTmpDirActivity).toHaveBeenCalledWith({
|
||||
tmpDir: '/tmp/test-dir',
|
||||
})
|
||||
|
||||
// Verify completed task status
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
@@ -195,72 +171,35 @@ describe('Agent Autofill Workflow', () => {
|
||||
})
|
||||
})
|
||||
|
||||
it('should run autofill without agentContext when the asset has no context', async () => {
|
||||
mockActivities.getAssetAutofillContextActivity.mockResolvedValue(null)
|
||||
it('should pass pageCount for PDF assets to autofillAiActivity', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'a2',
|
||||
name: 'document.pdf',
|
||||
projectId: 'p1',
|
||||
project: { id: 'p1', teamId: 't1' },
|
||||
mediaType: 'application/pdf',
|
||||
media: { metadata: { totalFrames: 15 } },
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_metadata_autofill',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { sessionId: 's1', agentId: 'agent-1' },
|
||||
},
|
||||
assetId: 'a2',
|
||||
},
|
||||
})
|
||||
|
||||
await agentAutofillMedia(task)
|
||||
|
||||
expect(mockActivities.getAssetAutofillContextActivity).toHaveBeenCalledWith('a1')
|
||||
expect(mockActivities.autofillAiActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
teamId: 't1',
|
||||
images: ['/tmp/test-dir/1.webp'],
|
||||
fields: [
|
||||
{
|
||||
id: 'title',
|
||||
config: { name: 'Title', type: 'text' },
|
||||
description: 'The title',
|
||||
},
|
||||
],
|
||||
context: { agent: { id: 'b1' } },
|
||||
assetId: 'a2',
|
||||
assetName: 'document.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
pageCount: 15,
|
||||
duration: undefined,
|
||||
}),
|
||||
)
|
||||
const aiCallArgs = mockActivities.autofillAiActivity.mock.calls[0][0]
|
||||
expect(aiCallArgs).not.toHaveProperty('agentContext')
|
||||
})
|
||||
|
||||
it('should complete early if no image files could be extracted', async () => {
|
||||
mockActivities.extractAiMetadataActivity.mockResolvedValue([])
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_metadata_autofill',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
},
|
||||
})
|
||||
|
||||
await agentAutofillMedia(task)
|
||||
|
||||
expect(mockActivities.updateCommentActivity).toHaveBeenCalledWith({
|
||||
commentId: 'comment-placeholder-id',
|
||||
message: 'Autofill completed: No images could be extracted for analysis.',
|
||||
})
|
||||
|
||||
expect(mockActivities.autofillAiActivity).not.toHaveBeenCalled()
|
||||
expect(mockActivities.updateAssetMetadataActivity).not.toHaveBeenCalled()
|
||||
|
||||
// Verify cleanup still runs
|
||||
expect(mockActivities.cleanupTmpDirActivity).toHaveBeenCalledWith({
|
||||
tmpDir: '/tmp/test-dir',
|
||||
})
|
||||
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'completed',
|
||||
})
|
||||
})
|
||||
|
||||
it('should complete early if no autofill fields are defined in the project', async () => {
|
||||
@@ -284,18 +223,13 @@ describe('Agent Autofill Workflow', () => {
|
||||
expect(mockActivities.autofillAiActivity).not.toHaveBeenCalled()
|
||||
expect(mockActivities.updateAssetMetadataActivity).not.toHaveBeenCalled()
|
||||
|
||||
// Verify cleanup still runs
|
||||
expect(mockActivities.cleanupTmpDirActivity).toHaveBeenCalledWith({
|
||||
tmpDir: '/tmp/test-dir',
|
||||
})
|
||||
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'completed',
|
||||
})
|
||||
})
|
||||
|
||||
it('should handle failures, update placeholder with error, set status to failed, and cleanup tmp directory', async () => {
|
||||
it('should handle failures, update placeholder with error, and set status to failed', async () => {
|
||||
mockActivities.getProjectAutofillFieldsActivity.mockRejectedValue(new Error('DB failure'))
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
@@ -320,39 +254,108 @@ describe('Agent Autofill Workflow', () => {
|
||||
status: 'failed',
|
||||
output: { error: 'DB failure' },
|
||||
})
|
||||
})
|
||||
|
||||
// Verify cleanup still runs in finally block
|
||||
expect(mockActivities.cleanupTmpDirActivity).toHaveBeenCalledWith({
|
||||
tmpDir: '/tmp/test-dir',
|
||||
it('should fail with non-retryable ApplicationFailure when asset or project is not found', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue(null)
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_metadata_autofill',
|
||||
status: 'pending',
|
||||
assetId: 'a-missing',
|
||||
},
|
||||
})
|
||||
|
||||
await expect(agentAutofillMedia(task)).rejects.toThrow('Asset or project not found')
|
||||
|
||||
// Verify task failed status
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'failed',
|
||||
output: { error: 'Asset or project not found' },
|
||||
})
|
||||
})
|
||||
|
||||
it('should fail with non-retryable ApplicationFailure for unsupported audio files', async () => {
|
||||
it('should not pass pageCount for video assets when calling autofillAiActivity', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'a1',
|
||||
storageKey: { key: 'asset-key' },
|
||||
id: 'v1',
|
||||
name: 'test.mp4',
|
||||
projectId: 'p1',
|
||||
storageKey: { key: 'asset-video-key' },
|
||||
project: { id: 'p1', teamId: 't1' },
|
||||
mediaType: 'audio/mp3',
|
||||
media: { proxyType: 'audio' },
|
||||
mediaType: 'video/mp4',
|
||||
media: {
|
||||
proxyType: 'video',
|
||||
duration: 10.1,
|
||||
frames: 300,
|
||||
metadata: { totalFrames: 300 },
|
||||
},
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_metadata_autofill',
|
||||
status: 'pending',
|
||||
assetId: 'a1',
|
||||
assetId: 'v1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { sessionId: 's1', agentId: 'agent-1' },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await expect(agentAutofillMedia(task)).rejects.toThrow(
|
||||
'unsupported media type for autofill: audio/mp3',
|
||||
)
|
||||
await agentAutofillMedia(task)
|
||||
|
||||
// Verify task failed status
|
||||
expect(mockActivities.updateTaskStatusActivity).toHaveBeenCalledWith({
|
||||
taskId: task.id,
|
||||
status: 'failed',
|
||||
output: { error: 'unsupported media type for autofill: audio/mp3' },
|
||||
expect(mockActivities.autofillAiActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
assetId: 'v1',
|
||||
assetName: 'test.mp4',
|
||||
mediaType: 'video/mp4',
|
||||
duration: 10.1,
|
||||
pageCount: undefined,
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('should pass pageCount and no duration for pdf assets when calling autofillAiActivity', async () => {
|
||||
mockActivities.getAssetActivity.mockResolvedValue({
|
||||
id: 'doc1',
|
||||
name: 'test.pdf',
|
||||
projectId: 'p1',
|
||||
storageKey: { key: 'asset-doc-key' },
|
||||
project: { id: 'p1', teamId: 't1' },
|
||||
mediaType: 'application/pdf',
|
||||
media: {
|
||||
proxyType: 'pdf',
|
||||
duration: 0,
|
||||
frames: 25,
|
||||
metadata: { totalFrames: 25 },
|
||||
},
|
||||
})
|
||||
|
||||
const task = await prisma.workflowTask.create({
|
||||
data: {
|
||||
type: 'ai_metadata_autofill',
|
||||
status: 'pending',
|
||||
assetId: 'doc1',
|
||||
payload: {
|
||||
projectId: 'p1',
|
||||
agent: { sessionId: 's1', agentId: 'agent-1' },
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
await agentAutofillMedia(task)
|
||||
|
||||
expect(mockActivities.autofillAiActivity).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
assetId: 'doc1',
|
||||
assetName: 'test.pdf',
|
||||
mediaType: 'application/pdf',
|
||||
duration: undefined,
|
||||
pageCount: 25,
|
||||
}),
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
import type { WorkflowTask } from '@shumai/db'
|
||||
import {
|
||||
executeActivity,
|
||||
getActivities,
|
||||
TaskQueueAgent,
|
||||
TaskQueueTranscode,
|
||||
} from '@shumai/workflow-core'
|
||||
import { executeActivity, getActivities, TaskQueueAgent } from '@shumai/workflow-core'
|
||||
import { ApplicationFailure } from '@temporalio/workflow'
|
||||
import { getProxyType } from '@shumai/core/src/utils/mime'
|
||||
|
||||
@@ -12,33 +7,22 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
const {
|
||||
updateTaskStatusActivity,
|
||||
getAssetActivity,
|
||||
extractAiMetadataActivity,
|
||||
getProjectAutofillFieldsActivity,
|
||||
getAgentAutofillContextActivity,
|
||||
getAssetAutofillContextActivity,
|
||||
autofillAiActivity,
|
||||
updateTaskUsageActivity,
|
||||
updateAssetMetadataActivity,
|
||||
createCommentActivity,
|
||||
updateCommentActivity,
|
||||
getTranscodeWorkerQueueActivity,
|
||||
getAgentWorkerQueueActivity,
|
||||
downloadMediaToTmpActivity,
|
||||
cleanupTmpDirActivity,
|
||||
} = getActivities()
|
||||
|
||||
let placeholderCommentId: string | undefined
|
||||
let tmpDir: string | undefined
|
||||
let transcodeWorkerQueue = ''
|
||||
let agentWorkerQueue = ''
|
||||
|
||||
try {
|
||||
// 0. Discover queues
|
||||
agentWorkerQueue = await executeActivity(TaskQueueAgent, getAgentWorkerQueueActivity)
|
||||
transcodeWorkerQueue = await executeActivity(
|
||||
TaskQueueTranscode,
|
||||
getTranscodeWorkerQueueActivity,
|
||||
)
|
||||
|
||||
// Update status to processing
|
||||
await executeActivity(agentWorkerQueue, updateTaskStatusActivity, {
|
||||
@@ -58,56 +42,13 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
|
||||
// 1. Get Asset
|
||||
const asset = await executeActivity(agentWorkerQueue, getAssetActivity, task.assetId)
|
||||
const key = asset?.storageKey?.key
|
||||
if (!asset || !asset.project || !key) {
|
||||
if (!asset || !asset.project) {
|
||||
throw ApplicationFailure.create({ message: 'Asset or project not found', nonRetryable: true })
|
||||
}
|
||||
const teamId = asset.project.teamId
|
||||
const projectId = asset.project.id
|
||||
|
||||
// 2. Prepare Data (Images)
|
||||
const proxyType =
|
||||
(asset.media as PrismaJson.MediaInfo | null)?.proxyType ||
|
||||
getProxyType(asset.mediaType, asset.name)
|
||||
const isImage = proxyType === 'image'
|
||||
const isVideo = proxyType === 'video'
|
||||
|
||||
if (!isImage && !isVideo) {
|
||||
throw ApplicationFailure.create({
|
||||
message: `unsupported media type for autofill: ${asset.mediaType}`,
|
||||
nonRetryable: true,
|
||||
})
|
||||
}
|
||||
|
||||
const download = await executeActivity(transcodeWorkerQueue, downloadMediaToTmpActivity, {
|
||||
assetKey: key,
|
||||
})
|
||||
const { filePath } = download
|
||||
tmpDir = download.tmpDir
|
||||
|
||||
const generatedFiles = await executeActivity(transcodeWorkerQueue, extractAiMetadataActivity, {
|
||||
assetKey: key,
|
||||
filePath,
|
||||
type: 'autofill',
|
||||
isImage,
|
||||
})
|
||||
|
||||
if (generatedFiles.length === 0) {
|
||||
// If no images could be extracted, we can't do much
|
||||
if (placeholderCommentId) {
|
||||
await executeActivity(agentWorkerQueue, updateCommentActivity, {
|
||||
commentId: placeholderCommentId,
|
||||
message: 'Autofill completed: No images could be extracted for analysis.',
|
||||
})
|
||||
}
|
||||
await executeActivity(agentWorkerQueue, updateTaskStatusActivity, {
|
||||
taskId: task.id,
|
||||
status: 'completed',
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
// 3. Get Project Autofill Fields
|
||||
// 2. Get Project Autofill Fields
|
||||
const fields = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getProjectAutofillFieldsActivity,
|
||||
@@ -127,22 +68,37 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
return
|
||||
}
|
||||
|
||||
// 3b. Fetch Agent Context
|
||||
// 3. Fetch Agent Context
|
||||
const context = await executeActivity(agentWorkerQueue, getAgentAutofillContextActivity, {
|
||||
teamId,
|
||||
})
|
||||
|
||||
// 3c. Fetch Agent-Provided Autofill Context (from create_file/create_version)
|
||||
const agentContext = await executeActivity(
|
||||
agentWorkerQueue,
|
||||
getAssetAutofillContextActivity,
|
||||
asset.id,
|
||||
)
|
||||
// 4. Call AI Service (inspects asset on demand via read_asset)
|
||||
const mediaInfo = asset.media as PrismaJson.MediaInfo | null
|
||||
const proxyType = mediaInfo?.proxyType || getProxyType(asset.mediaType, asset.name) || undefined
|
||||
|
||||
const duration =
|
||||
(proxyType === 'video' || proxyType === 'audio') && typeof mediaInfo?.duration === 'number'
|
||||
? mediaInfo.duration
|
||||
: undefined
|
||||
|
||||
const pageCount =
|
||||
proxyType === 'pdf'
|
||||
? typeof mediaInfo?.metadata?.totalFrames === 'number'
|
||||
? mediaInfo.metadata.totalFrames
|
||||
: typeof mediaInfo?.frames === 'number'
|
||||
? mediaInfo.frames
|
||||
: undefined
|
||||
: undefined
|
||||
|
||||
// 4. Call AI Service
|
||||
const aiResult = await executeActivity(agentWorkerQueue, autofillAiActivity, {
|
||||
teamId,
|
||||
images: generatedFiles,
|
||||
assetId: asset.id,
|
||||
assetName: asset.name,
|
||||
mediaType: asset.mediaType ?? undefined,
|
||||
duration,
|
||||
pageCount,
|
||||
projectId: asset.projectId ?? undefined,
|
||||
fields: fields.map(
|
||||
(f: { key: string; config: Record<string, unknown>; description?: string | null }) => ({
|
||||
id: f.key,
|
||||
@@ -151,7 +107,6 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
}),
|
||||
),
|
||||
context,
|
||||
...(agentContext ? { agentContext } : {}),
|
||||
})
|
||||
|
||||
if (aiResult.usage) {
|
||||
@@ -166,10 +121,12 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
|
||||
// 6. Update Asset Metadata
|
||||
const result = JSON.parse(aiResult.text)
|
||||
const metadataUpdates = Object.entries(result).map(([key, value]) => ({
|
||||
key,
|
||||
value,
|
||||
}))
|
||||
const metadataUpdates = Object.entries(result)
|
||||
.filter(([, value]) => value !== null)
|
||||
.map(([key, value]) => ({
|
||||
key,
|
||||
value,
|
||||
}))
|
||||
|
||||
if (metadataUpdates.length > 0) {
|
||||
await executeActivity(agentWorkerQueue, updateAssetMetadataActivity, {
|
||||
@@ -216,14 +173,6 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
|
||||
})
|
||||
}
|
||||
throw err
|
||||
} finally {
|
||||
if (tmpDir && transcodeWorkerQueue) {
|
||||
try {
|
||||
await executeActivity(transcodeWorkerQueue, cleanupTmpDirActivity, { tmpDir })
|
||||
} catch (cleanupErr) {
|
||||
console.error('Failed to cleanup tmp dir:', cleanupErr)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -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.")
|
||||
})
|
||||
})
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user