Compare commits

...
24 Commits
Author SHA1 Message Date
yiling 4c0fd29b7f Release v0.3.9 2026-08-18 18:42:59 +08:00
Yiling-J ffef67be8f feat(quota): move usage monitoring to team dashboard (#327) 2026-08-18 15:57:36 +08:00
Yiling-J 4d100bf542 docs(team-settings): add resource quotas documentation and update readme features (#326)
* docs(team-settings): add resource quotas documentation and update readme features

* fix(webui): correct sandbox filesystem description
2026-08-18 14:48:12 +08:00
Yiling-J 8a75d015a1 fix(quota): exclude agents from quota rules and usage records (#325)
* fix(quota): exclude agents from quota rules and usage records

* refactor(quota): remove agent_skill_call_count resource type and related logic

* chore(db): replace manual migration with prisma-generated migration
2026-08-18 11:56:03 +08:00
Yiling-J f806272c06 feat(settings): reorganize settings into personal, team, and AI sections (#324) 2026-08-18 08:35:23 +08:00
Yiling-J 4935eeff28 fix(webui): preserve selected chatbot agent preference on reload (#323) 2026-08-17 20:47:57 +08:00
Yiling-J eed0264b9c feat(quota): add 2-level database-backed resource quota system (#318)
* feat(quota): add database-backed resource quota system

* feat(webui): add resource quota management in team settings (#319)

* feat(webui): add resource quota settings in team management

* refactor(webui): update quotas list to full row layout and restrict skill/mcp to select list

* feat(quota): refactor quota system to 2-level rules and records

* fix(webui): fix overflow and scroll area in quota usage records dialog

* fix(webui): ensure quota records scroll area has explicit max height

* feat(webui): improve quota cards interaction and restrict editable fields in edit mode

* fix(quota): serialize initial records, validate merged updates, and reset on dimension changes (#320)

* feat(quota): replace network quota with agent tools quota (#321)

* feat(webui): show remaining time until next refresh in quota usage records

* fix(webui): rename bash quota resource to Agent Bash Calls

* refactor(quota): remove unused reserved field from quota records

* refactor(quota): remove quota rule cache (#322)
2026-08-17 20:24:05 +08:00
Yiling-J dd82daf65c feat(webui): use project members for asset comment mentions (#315)
* feat(webui): use project members for asset comment mentions

* refactor(project): remove legacy unused bots endpoint and props
2026-08-16 16:44:50 +08:00
Yiling-J 55d9596835 feat(authz): enforce project-aware roles for agent/skill/mcp permissions (#314)
* feat(authz): enforce project-aware roles for agent/skill/mcp permissions

Introduce a shared resolveEffectiveRole helper that mirrors AuthzService
precedence rules (projectMember.role override -> team role for team-scoped
members -> restricted), and route all agent/skill/mcp runtime permission
checks through it. Previously these checks used the raw teamMember.role,
which let project-only members execute team-level agents/skills/MCP tools
and ignored per-project role overrides.

Changes:
- authz: add resolveEffectiveRole(teamId, projectId, userId, db) and
  refactor hasPermission to use it (behavior-preserving)
- chat/asset/agent-activity: gate agent usage by the effective project role
- read_skill: enforce skill permission via effective role (projectId
  threaded from the agent session)
- mcp-service: checkPermission and buildAgentTools filter by effective
  role; un-permitted servers' tools are no longer advertised to the model
- agent activity: only advertise skills the user's effective role permits
- listProjectMembers: filter included agent bots by the requester's
  effective project role
- new GET /projects/:projectId/chat-agents API returning chat agents
  scoped to the project and the user's effective role; WebUI chat selector
  now uses it (settings keeps the team-level API)
- tests: effective-role resolver, chat/mention/MCP/skill project-role
  matrices, listProjectChatAgents, listProjectMembers filter, API route

* fix(agent): forward projectId to getAgentChatContextActivity in agentChat workflow

The agentChat workflow called getAgentChatContextActivity without passing
projectId from the task payload, so project-scoped members (scope:
'project') resolved a null effective role in the activity and were denied
with 'Insufficient role to use agent' even though the chat selector and
chat.ts both authorized them. Forward payload.projectId so the activity
enforces the user's effective project role, and assert the forwarding in
the workflow unit test (fails without the fix).
2026-08-16 15:44:45 +08:00
Yiling-J cb1c1c502b feat(agent): add permission controls for chat agents (#313)
* feat(agent): add permission controls for chat agents

* refactor(agent): extract shared agent permission helpers

Consolidate the duplicated role-hierarchy logic into
packages/core/src/agent/permissions.ts:

- getRoleLevel(): numeric level for a team role (fail closed at 0)
- getAgentRequiredLevel(): required level for an agent permission
  (defaults to reviewer/1)
- getAllowedAgentRoles(): inclusive role set for filtering

The typed Record over TeamMemberRole makes the mapping exhaustive,
so adding a new role fails compilation until all sites are updated.
Used by ChatService.startOrContinueChat, AssetService comment
mentions, getAgentChatContextActivity, AgentService.listAgents, and
TeamService.getTeamMembers, replacing four inline copies of the
hierarchy and the allowed-roles conditionals.

Also fix the API permission-denial test to mock HTTPException(403)
and assert a 403 response instead of a generic Error/500, matching
real authzService behavior.

* test(agent): fix flaky comment DAG tests by spacing ULID id generation

ULID ids have 1ms timestamp granularity; back-to-back comment creates
frequently land in the same millisecond, in which case Prisma ULIDs sort
by their random suffix instead of creation order. The DAG spine in
initializeAgentSessionActivity chains top-level comments by id, so a
shuffled order produces paths that omit preceding comments, making the
path-to-root assertions flaky (~80% of full-file runs locally).

Add a 2ms sleep between consecutive comment creates in the affected
tests, guaranteeing strictly increasing ULID timestamps. A 2ms delay is
sufficient because the next create always fires at least 2ms after the
previous ULID was generated. Production is unaffected: real comments
arrive seconds apart via separate requests.
2026-08-16 11:16:14 +08:00
yiling 6d4f62d6f6 Release v0.3.8 2026-08-15 20:35:30 +08:00
Yiling-J 43808216e6 fix(core): rename latest version child record on version stack rename (#312) 2026-08-15 16:18:11 +08:00
Yiling-J f66bb7af73 feat(version-stack): add manage versions dialog and version removal (#311)
* feat(version-stack): add manage versions dialog and version removal

* fix(webui): remove ellipsis and add pointer cursor to manage versions button

* fix(version-stack): handle symlink deduplication and name sync for share links

* refactor(version-stack): extract shared symlink dedup helper

The 'repoint first symlink per share folder, delete duplicates with
fileCount decrement' logic was triplicated across createVersionStack,
reparentAssets, and reparentFileToFile with subtle variations. Extract
it into dedupeSymlinksToTarget() in packages/core/src/asset/symlink.ts
and call it from all three sites (behavior unchanged), with a dedicated
test suite covering the edge cases.
2026-08-15 15:37:17 +08:00
Yiling-J ae86d56a7d feat(webui): improve AGENTS.md editor placeholder and read-only notice (#310)
* feat(webui): improve AGENTS.md editor placeholder and read-only notice

* docs: add AGENTS.md documentation under Shumai Agent Settings
2026-08-15 11:00:30 +08:00
Yiling-J 1cee103b1c feat(agent): add nested agents.md support across backend and webui (#309)
* feat(agent): add nested agents.md support across backend and webui

* fix(webui): update agentsmd route paths and unnest folder agentsmd route

* fix(agent): flush agents.md autosave on close and address review feedback

- Flush pending debounced AGENTS.md autosave on close/unmount so edits
  made within 750ms of navigating away are no longer silently lost
- Serialize autosaves through a promise chain so an older in-flight
  request can never overwrite newer content on the server
- Internationalize the hardcoded "Failed to save" and
  "Loading AGENTS.md..." strings (en + zh)
- Validate that AGENTS.md is only stored on folder/root assets in
  AssetService, preventing bogus virtual paths for file assets
- Cap updateAgentsMd content at 100k chars via Zod validation
- Remove unused getAgentsMd/updateAgentsMd response DTO schemas
- Drop unused teamId prop from AgentsMdEditor
- Add tests: non-folder asset rejection, oversized content 400,
  and agent-chat workflow assetId passthrough

* refactor(db): isolate AGENTS.md content in dedicated 1:1 AssetAgentMd table

* style(webui): unify top bar button hover styles and add wand icon to agentsmd button

* style(webui): update agentsmd button state colors and remove presence dot

* fix(webui): fix close button overflow and stabilize debounced autosave in agentsmd editor

* fix(webui): update debounce to 1s and await pending save before closing agentsmd editor

* feat(webui): add terminal AGENTS.md breadcrumb on agentsmd editor page

* fix(webui): use ScrollArea for markdown editor scrolling
2026-08-15 10:25:46 +08:00
Yiling-J 3c3b6880e4 feat(webui): replace legacy markdown editor with new lexical wysiwyg editor (#308)
* feat(webui): replace legacy markdown editor with new lexical wysiwyg editor

* refactor(webui): organize markdown editor files into components/markdown-editor folder
2026-08-14 16:27:14 +08:00
yiling 0b84402c83 Release v0.3.7 2026-08-14 14:47:18 +08:00
Yiling-J 61a61abc7c fix(webui): fix select field height and multi-select overflow/interaction issues (#307)
* fix(webui): standardize single-select custom field height

* fix(webui): fix multi-select badge overflow calculation and simplify direct edit
2026-08-14 14:35:17 +08:00
Yiling-J fc878775c2 feat(agent): support dynamic newOption in select and selectMulti metadata fields (#306)
* feat(webui): redesign select and multi-select metadata fields with search box and dynamic option creation

* fix(webui): stabilize select popover placement and preserve field visibility in store

* refactor(webui): enforce 2-row collapsed height and whitespace-pre-wrap on LongTextField

* feat(agent): support dynamic newOption in select and selectMulti metadata fields

* fix(metadata): address code review feedback on selectMulti item validation and WebUI option deduplication
2026-08-14 10:56:18 +08:00
Yiling-J 7acf736300 feat(webui): redesign select metadata fields and improve long text field widget (#305)
* feat(webui): redesign select and multi-select metadata fields with search box and dynamic option creation

* fix(webui): stabilize select popover placement and preserve field visibility in store

* refactor(webui): enforce 2-row collapsed height and whitespace-pre-wrap on LongTextField
2026-08-13 22:46:40 +08:00
Yiling-J 9d50301a43 feat(sandbox): default Network Sandbox to off and add settings toggle switch (#304) 2026-08-13 20:50:34 +08:00
Yiling-J 7f185ca23c feat(agent): type-safe CREATION_CONTEXT metadata on create_file/create_version (#303)
* feat(agent): type-safe CREATION_CONTEXT metadata on create_file/create_version

Build the create_file and create_version tool metadata parameter from the
project's CREATION_CONTEXT fields at harness creation time, instead of the
schemaless key-value map that required the agent to call list_autofill_fields
first.

- Thread projectId from the chat workflow into createAgentSession and build
  a strict, all-required (nullable) metadata schema via fieldsToTypeBoxSchema
  (additionalProperties: false, option IDs enforced via enum).
- Remove the list_autofill_fields tool and its activity case.
- Reject metadata keys that are not CREATION_CONTEXT fields of the target
  project with a clear non-retryable error telling the agent to omit metadata.
- Skip null metadata values when persisting (create_file/create_version and
  the autofill workflow).
- Switch the touched schemas from @sinclair/typebox 0.34 to typebox v1 to
  match the harness validator.

* refactor(agent): migrate remaining tools from @sinclair/typebox 0.34 to typebox v1

All agent tool schemas now use the same typebox v1 package as the harness
validator; drop the @sinclair/typebox 0.34 dependency from @shumai/agent.

* test(agent): reproduce null coercion in harness tool validation

The pi-ai harness (<=0.82.1) coerces null values in [string, null] unions to
'' during tool argument validation for typebox v1 schemas. A valid create_file
call with path: null + data: {...} therefore arrives at execute with path: ''
and fails with 'Provide exactly one of path or data'. Null metadata values
(the 'unknown' sentinel) are likewise turned into ''.

This test reproduces both failures. It is expected to fail until
@earendil-works/pi-ai is upgraded to >=0.84.0 (#7328), which preserves values
that already match a union arm.

* fix(agent): patch pi-ai 0.82.1 to preserve null in nullable union tool args

Apply the upstream fix for earendil-works/pi#7328 (PR #7373) via a bun
patch instead of upgrading pi-ai. coerceWithUnionSchema now returns the
original value when it already validates against any union member,
instead of coercing null in [string, null] unions into "".

Fixes the create_file false "Provide exactly one of path or data" error
when the model passes path: null with data. Reproduced by
packages/agent/src/reproduce-tool-null-coercion.test.ts, which now passes.

* fix(docker): copy bun patch dir before frozen-lockfile install

The pi-ai patchedDependencies entry makes bun install --frozen-lockfile
fail in the builder stage because patches/ was not present in the image
yet. Copy it alongside package.json/bun.lock so the patch applies.

* refactor(agent): simplify metadata guidance in system prompt and error message

Shorten the create_file/create_version metadata instructions in the system
prompt and reword the invalid-metadata-key error to not reference
CREATION_CONTEXT internals. Update the matching test assertion.
2026-08-13 20:06:09 +08:00
yiling 94582c9001 try fixing aliyun docker push 2026-08-13 15:06:44 +08:00
Yiling-J 41b73feeab feat(metadata): replace aiAutofill boolean with autofillSource enum (#302)
* feat(metadata): replace aiAutofill boolean with autofillSource enum

* fix(agent): validate creation-context metadata and make writes transactional

Address code review feedback on the autofillSource migration:

- Update the agent system prompt to reference the 'metadata' parameter of
  create_file/create_version instead of the removed 'context' parameter,
  which was being silently discarded by the activity
- Write metadata inside the caller's transaction via the new
  metadataService.updateAssetMetadataInTx, keeping metadata rows atomic
  with asset creation instead of opening a separate non-atomic transaction
- Reject metadata keys that are not defined CREATION_CONTEXT fields of the
  project with a non-retryable ApplicationFailure before creating the asset
- Remove dead agentContext handling from autofillAiActivity and its tests,
  and drop the unused ai_autofill i18n keys (paraglide recompiled)
- Derive the DTO autofillSource enum from the AutofillSource const instead
  of a hardcoded z.enum to prevent drift
2026-08-13 13:41:46 +08:00
448 changed files with 27062 additions and 2401 deletions
+1
View File
@@ -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 }}
+1
View File
@@ -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
+1
View File
@@ -37,6 +37,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:
+1
View File
@@ -38,6 +38,7 @@ Shumai 是一个开源的 Frame.io 替代方案,专为创意团队打造,让
* **沙箱隔离执行**:Agent 生成的脚本会在隔离环境里运行,更安全。
* **AI 自动补全元数据**:新素材上传后,系统可以自动帮你补一些元数据。
* **语义搜索**:支持按画面内容或语义找素材,底层用的是向量 embedding(Gemini Embedding 2)。
* **资源配额**:支持按成员、角色或全团队对 AI Token、成本和工具调用设置使用上限与实时用量监控。
下面是一个简短的 demo 视频,展示了 Shumai Agent 能做什么:
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent-app",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/cli",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/transcode-app",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"bin": {
+5
View File
@@ -63,6 +63,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,6 +81,10 @@ 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` |
+16 -11
View File
@@ -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)
@@ -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,121 @@
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()
// 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 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/web-app",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"dependencies": {
+18 -15
View File
@@ -33,7 +33,7 @@
},
"apps/agent": {
"name": "@shumai/agent-app",
"version": "0.3.5",
"version": "0.3.7",
"bin": {
"shumai-agent": "./src/index.ts",
},
@@ -45,7 +45,7 @@
},
"apps/cli": {
"name": "@shumai/cli",
"version": "0.3.5",
"version": "0.3.7",
"bin": {
"shumai-cli": "./src/index.ts",
},
@@ -60,7 +60,7 @@
},
"apps/transcode": {
"name": "@shumai/transcode-app",
"version": "0.3.5",
"version": "0.3.7",
"bin": {
"shumai-transcode": "./src/index.ts",
},
@@ -72,7 +72,7 @@
},
"apps/web": {
"name": "@shumai/web-app",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@shumai/agent": "workspace:*",
"@shumai/api": "workspace:*",
@@ -92,7 +92,7 @@
},
"packages/agent": {
"name": "@shumai/agent",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@anthropic-ai/sandbox-runtime": "0.0.66",
"@earendil-works/pi-agent-core": "0.82.1",
@@ -102,12 +102,12 @@
"@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",
"jittered-fractional-indexing": "1.0.1",
"typebox": "1.1.38",
"ulid": "3.0.2",
"zod": "4.4.3",
},
@@ -117,7 +117,7 @@
},
"packages/api": {
"name": "@shumai/api",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@hono/zod-validator": "0.7.6",
"@shumai/core": "workspace:*",
@@ -131,7 +131,7 @@
},
"packages/core": {
"name": "@shumai/core",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@earendil-works/pi-agent-core": "0.82.1",
"@earendil-works/pi-ai": "0.82.1",
@@ -166,7 +166,7 @@
},
"packages/db": {
"name": "@shumai/db",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@earendil-works/pi-agent-core": "0.82.1",
"@prisma/adapter-pg": "7.8.0",
@@ -182,7 +182,7 @@
},
"packages/dtos": {
"name": "@shumai/dtos",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@earendil-works/pi-agent-core": "0.82.1",
"zod": "4.4.3",
@@ -190,7 +190,7 @@
},
"packages/e2e": {
"name": "@shumai/e2e",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@earendil-works/pi-agent-core": "0.82.1",
"@google/genai": "1.52.0",
@@ -205,11 +205,11 @@
},
"packages/tableprinter": {
"name": "@shumai/tableprinter",
"version": "0.3.5",
"version": "0.3.7",
},
"packages/transcode": {
"name": "@shumai/transcode",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -223,7 +223,7 @@
},
"packages/webui": {
"name": "@shumai/webui",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@base-ui/react": "1.5.0",
"@dnd-kit/abstract": "0.4.0",
@@ -321,7 +321,7 @@
},
"packages/workflow-core": {
"name": "@shumai/workflow-core",
"version": "0.3.5",
"version": "0.3.7",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -333,6 +333,9 @@
},
},
},
"patchedDependencies": {
"@earendil-works/pi-ai@0.82.1": "patches/@earendil-works%2Fpi-ai@0.82.1.patch",
},
"packages": {
"@alloc/quick-lru": ["@alloc/quick-lru@5.2.0", "", {}, "sha512-UrcABB+4bUrFABwbluTIBErXwvbsU/V7TZWfmbgJfbkwiBuziS9gxdODUyuiecfdGQ85jglMW6juS3+z5TsKLw=="],
+49
View File
@@ -0,0 +1,49 @@
# Code Quality Review: Quota Usage Dashboard
## Context
The change moves quota usage monitoring from the settings rule-card dialog to an owner-only dashboard section, adds collapsible rule/record display, and adds an audited manual record reset operation.
## Review
### Correctness
- The reset service validates team ownership, scope mode, membership, role filters, and selected-member membership.
- Reset and first-use record creation are serialized with a quota-rule row lock.
- Reset starts a new window at the current time and clears consumption.
- API and service tests cover shared records, member records, invalid targets, cross-team access, request validation, and audit logging.
- The application E2E test covers the settings/dashboard flow and verifies the persisted reset.
### Readability and architecture
- Business logic remains in `QuotaService`; the API only validates, authorizes, invokes the service, and maps the audit action.
- The dashboard owns usage presentation, while quota formatting metadata is shared between dashboard and settings.
- The removed usage dialog and obsolete translation messages are not referenced after the refactor.
### Security
- The reset endpoint retains owner-level team authorization.
- Request input is validated with Zod.
- SQL uses Prisma tagged-template parameters and does not interpolate raw user input.
### Performance
- Usage records are queried only after a rule is expanded.
- Expanded rules refresh every ten seconds, matching the previous usage dialog behavior.
- Quota rules retain the existing bounded list endpoint and descending ID ordering.
## Verification
- `bun run lint` passed.
- `bun run format` passed.
- `bun run typecheck` passed.
- `bun run test` passed: 124 files, 1190 tests.
- Quota API/core tests passed: 2 files, 30 tests.
- Quota application E2E passed.
- WebUI harness E2E passed: 9 tests.
- Workflow E2E passed: 14 files, 58 tests.
- `git diff --check` passed.
## Verdict
Approve. No critical or required findings remain.
+3 -2
View File
@@ -43,6 +43,7 @@
"pages": [
"using-shumai/agent-providers",
"using-shumai/agents",
"using-shumai/agents-md",
"using-shumai/agent-skills",
"using-shumai/agent-tools",
"using-shumai/mcp-servers",
@@ -50,8 +51,8 @@
]
},
{
"group": "Media Transcoding Settings",
"pages": ["using-shumai/transcode-settings"]
"group": "Team Settings",
"pages": ["using-shumai/transcode-settings", "using-shumai/quotas-settings"]
},
{
"group": "Configuration",
+1 -1
View File
@@ -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
+53
View File
@@ -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.
+121
View File
@@ -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. `analyze_image`, `screenshot`, `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.
+4 -1
View File
@@ -1,6 +1,6 @@
{
"name": "shumai",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"repository": {
@@ -65,5 +65,8 @@
"typescript-eslint": "8.60.1",
"vite-tsconfig-paths": "6.1.1",
"vitest": "4.1.8"
},
"patchedDependencies": {
"@earendil-works/pi-ai@0.82.1": "patches/@earendil-works%2Fpi-ai@0.82.1.patch"
}
}
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"main": "./src/index.ts",
@@ -14,12 +14,12 @@
"@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",
"jittered-fractional-indexing": "1.0.1",
"typebox": "1.1.38",
"ulid": "3.0.2",
"zod": "4.4.3"
},
+339 -235
View File
@@ -9,7 +9,6 @@ import {
updateCommentActivity,
getAgentChatContextActivity,
getAgentAutofillContextActivity,
getAssetAutofillContextActivity,
getAssetActivity,
getCommentActivity,
getProjectAutofillFieldsActivity,
@@ -19,6 +18,7 @@ import {
generateSessionNameActivity,
type GenerateSessionNameParams,
getUserTeamInfoActivity,
formatProjectContextPrompt,
} from './agent'
import * as piAgent from '../index'
import { type AgentHarness, type Session } from '@earendil-works/pi-agent-core'
@@ -460,58 +460,7 @@ describe('Agent Activities', () => {
expect(res.usage.inputTokens).toBe(5)
})
it('should include agentContext in the autofill prompt when provided', async () => {
const mockHarness = {
subscribe: vi.fn(),
prompt: vi.fn().mockResolvedValue({
content: [{ type: 'text', text: 'Captured' }],
usage: { input: 5, output: 5 },
}),
}
const mockSession = {
getEntries: vi.fn().mockResolvedValue([]),
getStorage: vi.fn().mockReturnValue({ sessionId: 'mock-session-id' }),
}
vi.mocked(piAgent.createAgentSession).mockImplementation(async (config: unknown) => {
const params = config as {
customTools: Array<{
name: string
execute: (id: string, args: Record<string, unknown>) => Promise<unknown>
}>
}
const tool = params.customTools.find((t) => t.name === 'autofill_metadata')
if (tool) {
await tool.execute('1', { f1: 'val' })
}
return {
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Mock AgentHarness instance for activity test
harness: mockHarness as unknown as AgentHarness<any, any, any, any>,
}
})
const context = {
agent: { id: 'b1', provider: { name: 'google' }, modelRef: { modelId: 'gemini' } },
dbProviders: [],
teamSkills: [],
allowedDomains: [],
} as unknown as AgentExecutionContext
await autofillAiActivity({
teamId: 't1',
images: [],
fields: [{ id: 'f1', config: { name: 'F1', type: 'text' } }],
context,
agentContext: 'Generated using gemini',
})
const capturedPrompt = mockHarness.prompt.mock.calls[0]?.[0] ?? ''
expect(capturedPrompt).toContain('Generated using gemini')
expect(capturedPrompt).toContain('<context>')
})
it('should not include agentContext in the autofill prompt when absent', async () => {
it('should use the base autofill prompt without any creation-context injection', async () => {
const mockHarness = {
subscribe: vi.fn(),
prompt: vi.fn().mockResolvedValue({
@@ -557,6 +506,7 @@ describe('Agent Activities', () => {
})
const capturedPrompt = mockHarness.prompt.mock.calls[0]?.[0] ?? ''
expect(capturedPrompt).toContain('Analyze the provided images and extract metadata.')
expect(capturedPrompt).not.toContain('<context>')
})
})
@@ -564,6 +514,11 @@ describe('Agent Activities', () => {
describe('Agent Database Activities Integration', () => {
setupTestDbHooks()
// Space out comment creations: ULID ids have 1ms timestamp granularity, so
// back-to-back creates landing in the same millisecond sort by random suffix
// and can break the id-ordered DAG spine in initializeAgentSessionActivity.
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
let team: Team
let user: User
let project: Project
@@ -621,6 +576,7 @@ describe('Agent Database Activities Integration', () => {
},
})
await sleep(2)
// Create second comment that user responds with, triggering session initialization
const userComment = await prisma.assetComment.create({
data: {
@@ -668,11 +624,13 @@ describe('Agent Database Activities Integration', () => {
const mainComment1 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'Main Comment 1', creatorId: user.id },
})
await sleep(2)
const mainComment2 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'Main Comment 2', creatorId: user.id },
})
// 2. Thread reply under mainComment1
await sleep(2)
const threadReply1 = await prisma.assetComment.create({
data: {
assetId: asset.id,
@@ -781,10 +739,12 @@ describe('Agent Database Activities Integration', () => {
const msg1 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg1', creatorId: user.id },
})
await sleep(2)
// msg2 (top level)
const msg2 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg2', creatorId: user.id },
})
await sleep(2)
// msg3 (top level asking agent)
const msg3 = await prisma.assetComment.create({
data: { assetId: asset.id, message: '[ask agent] msg3', creatorId: user.id },
@@ -799,6 +759,7 @@ describe('Agent Database Activities Integration', () => {
})
// agent response msg4
await sleep(2)
const msg4 = await prisma.assetComment.create({
data: {
assetId: asset.id,
@@ -810,6 +771,7 @@ describe('Agent Database Activities Integration', () => {
})
// msg5 (top level asking agent)
await sleep(2)
const msg5 = await prisma.assetComment.create({
data: { assetId: asset.id, message: '[ask agent] msg5', creatorId: user.id },
})
@@ -833,6 +795,7 @@ describe('Agent Database Activities Integration', () => {
expect(session3Id).not.toBe(session5Id)
// msg7 (reply to msg3 asking agent again)
await sleep(2)
const msg7 = await prisma.assetComment.create({
data: {
assetId: asset.id,
@@ -881,10 +844,12 @@ describe('Agent Database Activities Integration', () => {
const msg1 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg1', creatorId: user.id },
})
await sleep(2)
// msg2 (top level)
const msg2 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg2', creatorId: user.id },
})
await sleep(2)
// msg3 (top level asking agent)
const msg3 = await prisma.assetComment.create({
data: { assetId: asset.id, message: '<@shumai-x1> what did i say', creatorId: user.id },
@@ -919,10 +884,12 @@ describe('Agent Database Activities Integration', () => {
const msg1 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg1', creatorId: user.id },
})
await sleep(2)
// msg2 (top level)
const msg2 = await prisma.assetComment.create({
data: { assetId: asset.id, message: 'msg2', creatorId: user.id },
})
await sleep(2)
// msg3 (top level asking agent)
const msg3 = await prisma.assetComment.create({
data: { assetId: asset.id, message: '<@shumai-x1> what did i say', creatorId: user.id },
@@ -1136,6 +1103,55 @@ describe('Agent Database Activities Integration', () => {
expect(chatCtx.enabledSkillIds).toEqual([enabledSkill.id])
expect(chatCtx.teamSkills.map((s) => s.id)).not.toContain(disabledSkill.id)
// Test permission enforcement in getAgentChatContextActivity
// Create owner-only agent
const ownerAgentUser = await prisma.user.create({
data: { name: 'Owner Bot', email: `ownerbot-${Date.now()}@shumai.ai`, type: 'agent' },
})
const ownerAgent = await prisma.agent.create({
data: {
id: ownerAgentUser.id,
teamId: team.id,
type: 'chat',
permission: 'owner',
providerId: provider.id,
modelId: model.id,
config: { provider: 'openai', model: 'gpt-4' },
},
})
// Create owner and reviewer members
const ownerUser = await prisma.user.create({
data: { name: 'Owner User', email: `owner-${Date.now()}@shumai.ai` },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: ownerUser.id, role: 'owner' },
})
const reviewerUser = await prisma.user.create({
data: { name: 'Reviewer User', email: `reviewer-${Date.now()}@shumai.ai` },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: reviewerUser.id, role: 'reviewer' },
})
// Owner should succeed
const ownerCtx = await getAgentChatContextActivity({
teamId: team.id,
agentId: ownerAgent.id,
userId: ownerUser.id,
})
expect(ownerCtx.agent.id).toBe(ownerAgent.id)
// Reviewer should fail with non-retryable ApplicationFailure
await expect(
getAgentChatContextActivity({
teamId: team.id,
agentId: ownerAgent.id,
userId: reviewerUser.id,
}),
).rejects.toThrow('Permission denied')
// Create User for autofill agent
const autofillUser = await prisma.user.create({
data: {
@@ -1342,8 +1358,7 @@ describe('Agent Database Activities Integration', () => {
key: 'field_key_1',
scope: 'TEAM',
teamId: team.id,
aiAutofill: true,
config: { name: 'Title Extractor', type: 'text' },
config: { name: 'Title Extractor', type: 'text', autofillSource: 'CONTENT' },
},
})
@@ -1363,37 +1378,6 @@ describe('Agent Database Activities Integration', () => {
})
})
describe('getAssetAutofillContextActivity', () => {
it('should return the stored autofill context for an asset', async () => {
const withContext = await prisma.asset.create({
data: {
name: 'ctx.png',
type: AssetType.file,
status: AssetStatus.uploaded,
projectId: project.id,
autofillContext: 'Generated using gemini',
},
})
const ctx = await getAssetAutofillContextActivity(withContext.id)
expect(ctx).toBe('Generated using gemini')
})
it('should return null when the asset has no autofill context', async () => {
const noContext = await prisma.asset.create({
data: {
name: 'plain.png',
type: AssetType.file,
status: AssetStatus.uploaded,
projectId: project.id,
},
})
const ctx = await getAssetAutofillContextActivity(noContext.id)
expect(ctx).toBeNull()
})
})
describe('executeAgentToolActivity', () => {
beforeEach(() => {
vi.spyOn(authzService, 'hasPermission').mockResolvedValue()
@@ -1553,7 +1537,17 @@ describe('Agent Database Activities Integration', () => {
expect(uploadService.triggerPostUploadWorkflows).toHaveBeenCalled()
})
it('should persist autofillContext on the created file when context is provided', async () => {
it('should persist metadata on the created file when metadata map is provided', async () => {
await prisma.metadataField.create({
data: {
key: 'prompt',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
config: { name: 'Prompt', type: 'text', autofillSource: 'CREATION_CONTEXT' },
},
})
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
@@ -1574,16 +1568,46 @@ describe('Agent Database Activities Integration', () => {
name: 'ctx.txt',
size: 100,
contentType: 'text/plain',
context: 'Generated using gemini',
metadata: { prompt: 'Generated using gemini' },
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBe('Generated using gemini')
const val = await prisma.assetMetadataValue.findFirst({
where: { assetId: res.id, fieldKey: 'prompt' },
})
expect(val?.stringValue).toBe('Generated using gemini')
})
it('should not set autofillContext when context is not provided', async () => {
it('should persist select and selectMulti metadata with dynamic newOption', async () => {
const selectField = await prisma.metadataField.create({
data: {
key: 'provider',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Provider',
type: 'select',
autofillSource: 'CREATION_CONTEXT',
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
},
},
})
const multiField = await prisma.metadataField.create({
data: {
key: 'tags',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Tags',
type: 'selectMulti',
autofillSource: 'CREATION_CONTEXT',
selectMulti: { options: [{ id: 'tag1', displayName: 'Tag 1', color: '#3b82f6' }] },
},
},
})
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
@@ -1600,16 +1624,80 @@ describe('Agent Database Activities Integration', () => {
toolName: 'create_file',
args: {
parent: folder.id,
s3Key: 'uploads/plain.txt',
name: 'plain.txt',
s3Key: 'uploads/new_opt.txt',
name: 'new_opt.txt',
size: 100,
contentType: 'text/plain',
metadata: {
provider: { newOption: { value: 'Kling' } },
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
},
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBeNull()
// Verify select field
const providerVal = await prisma.assetMetadataValue.findFirst({
where: { assetId: res.id, fieldKey: selectField.key },
})
expect(providerVal?.stringValue).toBe('kling')
// Verify select field config was updated with new option
const updatedSelectField = await prisma.metadataField.findUnique({
where: { key: selectField.key },
})
const selectOpts =
(updatedSelectField?.config as PrismaJson.FieldConfig)?.select?.options || []
expect(selectOpts.some((o) => o.displayName === 'Kling' && o.id === 'kling')).toBe(true)
// Verify selectMulti field
const tagsVal = await prisma.assetMetadataValue.findFirst({
where: { assetId: res.id, fieldKey: multiField.key },
})
expect(tagsVal?.jsonValue).toEqual(['tag1', 'tag-2'])
// Verify selectMulti field config was updated with new option
const updatedMultiField = await prisma.metadataField.findUnique({
where: { key: multiField.key },
})
const multiOpts =
(updatedMultiField?.config as PrismaJson.FieldConfig)?.selectMulti?.options || []
expect(multiOpts.some((o) => o.displayName === 'Tag 2' && o.id === 'tag-2')).toBe(true)
})
it('should reject metadata with keys that are not valid in this project', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
fileCount: 0,
sizeByte: 0,
},
})
await expect(
executeAgentToolActivity({
taskId: 'task-1',
toolName: 'create_file',
args: {
parent: folder.id,
s3Key: 'uploads/ctx.txt',
name: 'ctx.txt',
size: 100,
contentType: 'text/plain',
metadata: { prompt: 'ok', unknownKey: 'not allowed' },
},
userId: user.id,
}),
).rejects.toThrow(/not valid in this project/)
// No metadata value should have been written for the unknown key
const val = await prisma.assetMetadataValue.findFirst({
where: { fieldKey: 'unknownKey' },
})
expect(val).toBeNull()
})
})
@@ -1720,7 +1808,17 @@ describe('Agent Database Activities Integration', () => {
expect(Number(updatedStack?.sizeByte)).toBe(350)
})
it('should persist autofillContext when creating a new version stack', async () => {
it('should persist metadata on the created version when metadata map is provided', async () => {
await prisma.metadataField.create({
data: {
key: 'prompt',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
config: { name: 'Prompt', type: 'text', autofillSource: 'CREATION_CONTEXT' },
},
})
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
@@ -1752,45 +1850,51 @@ describe('Agent Database Activities Integration', () => {
name: 'v2.txt',
size: 300,
contentType: 'text/plain',
context: 'Generated using seedance',
metadata: { prompt: 'Generated using seedance' },
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBe('Generated using seedance')
const val = await prisma.assetMetadataValue.findFirst({
where: { assetId: res.id, fieldKey: 'prompt' },
})
expect(val?.stringValue).toBe('Generated using seedance')
})
it('should persist autofillContext when adding to an existing version stack', async () => {
it('should persist select and selectMulti newOption metadata in create_version', async () => {
const selectField = await prisma.metadataField.create({
data: {
key: 'versionProvider',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Version Provider',
type: 'select',
autofillSource: 'CREATION_CONTEXT',
select: { options: [{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' }] },
},
},
})
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
},
})
const stack = await prisma.asset.create({
data: {
name: 'VersionStack',
type: AssetType.version_stack,
status: AssetStatus.uploaded,
projectId: project.id,
parentId: folder.id,
fileCount: 1,
sizeByte: 100,
sizeByte: 200,
},
})
const existingFileVersion = await prisma.asset.create({
const fileAsset = await prisma.asset.create({
data: {
name: 'v1.txt',
type: AssetType.file,
status: AssetStatus.uploaded,
projectId: project.id,
parentId: stack.id,
sizeByte: 100,
parentId: folder.id,
sizeByte: 200,
},
})
@@ -1798,137 +1902,28 @@ describe('Agent Database Activities Integration', () => {
taskId: 'task-1',
toolName: 'create_version',
args: {
parent: existingFileVersion.id,
parent: fileAsset.id,
s3Key: 'uploads/v2.txt',
name: 'v2.txt',
size: 250,
size: 300,
contentType: 'text/plain',
context: 'Generated using sora2',
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBe('Generated using sora2')
})
})
describe('list_autofill_fields', () => {
it('should return only aiAutofill fields with their options', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
},
})
await prisma.metadataField.create({
data: {
key: 'source',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
aiAutofill: true,
config: {
name: 'Source',
type: 'select',
select: {
options: [
{ id: 'gemini', displayName: 'Gemini', color: '#ffffff' },
{ id: 'seedance', displayName: 'Seedance', color: '#ffffff' },
],
},
metadata: {
versionProvider: { newOption: { value: 'Midjourney' } },
},
description: 'Generation source',
},
})
await prisma.metadataField.create({
data: {
key: 'title',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
aiAutofill: true,
config: { name: 'Title', type: 'text' },
},
})
await prisma.metadataField.create({
data: {
key: 'manual_notes',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
aiAutofill: false,
config: { name: 'Manual Notes', type: 'text' },
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'list_autofill_fields',
args: { parent: folder.id },
userId: user.id,
})
expect(res.fields).toHaveLength(2)
const source = res.fields.find((f: { name: string }) => f.name === 'Source')
expect(source?.name).toBe('Source')
expect(source?.type).toBe('select')
expect(source?.description).toBe('Generation source')
expect(source?.options).toEqual([{ displayName: 'Gemini' }, { displayName: 'Seedance' }])
expect(res.fields.find((f: { name: string }) => f.name === 'Manual Notes')).toBeUndefined()
})
it('should resolve the project through the ancestor chain', async () => {
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
},
const val = await prisma.assetMetadataValue.findFirst({
where: { assetId: res.id, fieldKey: selectField.key },
})
const subFolder = await prisma.asset.create({
data: {
name: 'Sub',
type: AssetType.folder,
status: AssetStatus.uploaded,
parentId: rootFolder.id,
},
expect(val?.stringValue).toBe('midjourney')
const updatedField = await prisma.metadataField.findUnique({
where: { key: selectField.key },
})
await prisma.metadataField.create({
data: {
key: 'title_2',
scope: 'PROJECT',
projectId: project.id,
teamId: team.id,
aiAutofill: true,
config: { name: 'Title 2', type: 'text' },
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'list_autofill_fields',
args: { parent: subFolder.id },
userId: user.id,
})
expect(res.fields.length).toBeGreaterThan(0)
})
it('should fail when parent is missing', async () => {
await expect(
executeAgentToolActivity({
taskId: 'task-1',
toolName: 'list_autofill_fields',
args: {},
userId: user.id,
}),
).rejects.toThrow('parent parameter is required')
const opts = (updatedField?.config as PrismaJson.FieldConfig)?.select?.options || []
expect(opts.some((o) => o.displayName === 'Midjourney' && o.id === 'midjourney')).toBe(true)
})
})
})
@@ -2113,4 +2108,113 @@ describe('Agent Database Activities Integration', () => {
expect(piAgent.createAgentSession).not.toHaveBeenCalled()
})
})
describe('Nested AGENTS.md prompt injection', () => {
it('formatProjectContextPrompt formats context files into XML project_context block', () => {
expect(formatProjectContextPrompt([])).toBe('')
const formatted = formatProjectContextPrompt([
{ path: '/AGENTS.md', content: 'Root rules' },
{ path: '/subfolder/AGENTS.md', content: 'Subfolder rules' },
])
expect(formatted).toBe(
'\n\n<project_context>\n\nProject-specific instructions and guidelines:\n\n<project_instructions path="/AGENTS.md">\nRoot rules\n</project_instructions>\n\n<project_instructions path="/subfolder/AGENTS.md">\nSubfolder rules\n</project_instructions>\n\n</project_context>',
)
})
it('agentChatActivity injects nested AGENTS.md instructions into systemPrompt', async () => {
const user = await prisma.user.create({
data: { name: 'User_Chat_Md', email: `chat-md-${Date.now()}@example.com` },
})
const team = await prisma.team.create({
data: { name: 'Team_Chat_Md_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_Chat_Md', teamId: team.id },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.root,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await prisma.assetAgentMd.create({
data: {
assetId: rootFolder.id,
content: '# Root Policy',
},
})
const subfolder = await prisma.asset.create({
data: {
name: 'subfolder',
type: AssetType.folder,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await prisma.assetAgentMd.create({
data: {
assetId: subfolder.id,
content: '# Subfolder Policy',
},
})
const mockHarness = {
subscribe: vi.fn(),
prompt: vi.fn().mockResolvedValue({
content: [{ type: 'text', text: 'Chat reply' }],
usage: { input: 10, output: 20 },
}),
}
const mockSession = {
getEntries: vi.fn().mockResolvedValue([]),
getStorage: vi.fn().mockReturnValue({ sessionId: 'mock-session-id' }),
}
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Mock AgentHarness instance for activity test
harness: mockHarness as unknown as AgentHarness<any, any, any, any>,
})
const context = {
agent: { id: 'agent-1', provider: { name: 'google' }, modelRef: { modelId: 'gemini' } },
dbProviders: [],
teamSkills: [],
allowedDomains: [],
} as unknown as AgentExecutionContext
await agentChatActivity({
teamId: team.id,
agentId: 'agent-1',
message: 'Hello',
imageUrls: [],
projectId: project.id,
folderId: subfolder.id,
assetId: subfolder.id,
sessionId: 'mock-session-id',
userId: user.id,
context,
})
expect(piAgent.createAgentSession).toHaveBeenCalledWith(
expect.objectContaining({
systemPrompt: expect.stringContaining('<project_context>'),
}),
)
const lastCall = vi.mocked(piAgent.createAgentSession).mock.calls.at(-1)
const systemPromptArg = lastCall?.[0].systemPrompt as string
expect(systemPromptArg).toContain(
'<project_instructions path="/AGENTS.md">\n# Root Policy\n</project_instructions>',
)
expect(systemPromptArg).toContain(
'<project_instructions path="/subfolder/AGENTS.md">\n# Subfolder Policy\n</project_instructions>',
)
})
})
})
+255 -112
View File
@@ -5,7 +5,12 @@ import {
} from '@earendil-works/pi-agent-core'
import { type ImageContent } from '@earendil-works/pi-ai'
import { assetService } from '@shumai/core/src/asset/asset'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import {
authzService,
Permission,
ResourceType,
resolveEffectiveRole,
} from '@shumai/core/src/authz/authz'
import { logger } from '@shumai/core/src/logger'
import { mcpService } from '@shumai/core/src/mcp/mcp-service'
import { metadataService } from '@shumai/core/src/metadata/metadata'
@@ -13,6 +18,7 @@ import { encodeCursor, paginateQuery } from '@shumai/core/src/pagination'
import { s3Service } from '@shumai/core/src/s3/s3'
import { uploadService } from '@shumai/core/src/upload/upload'
import { VersionStackService } from '@shumai/core/src/versionStack/versionStack'
import { getAgentRequiredLevel, getRoleLevel } from '@shumai/core/src/agent/permissions'
import { AssetType, prisma, Prisma, type Skill } from '@shumai/db'
import { registerLocalCancelHandler, unregisterLocalCancelHandler } from '@shumai/workflow-core'
import { ApplicationFailure, Context } from '@temporalio/activity'
@@ -27,6 +33,7 @@ import {
} from '../index'
import { aiUsageService } from '@shumai/core/src/ai-usage/ai-usage'
import { quotaService, QuotaExceededError } from '@shumai/core/src/quota/quota-service'
import { UpdateAssetMetadataRequest } from '@shumai/dtos'
export interface Usage {
@@ -65,6 +72,18 @@ export interface AgentExecutionContext {
allowedDomains: string[]
}
export function formatProjectContextPrompt(
contextFiles: Array<{ path: string; content: string }>,
): string {
if (contextFiles.length === 0) return ''
let prompt = '\n\n<project_context>\n\nProject-specific instructions and guidelines:\n\n'
for (const { path: filePath, content } of contextFiles) {
prompt += `<project_instructions path="${filePath}">\n${content}\n</project_instructions>\n\n`
}
prompt += '</project_context>'
return prompt
}
async function executeAgentPrompt(params: {
taskId?: string
teamId: string
@@ -74,6 +93,8 @@ async function executeAgentPrompt(params: {
agentsInstruction: string
sessionId?: string
userId?: string
projectId?: string
assetId?: string
userCommentId?: string | null
tools?: AgentTool[]
context: AgentExecutionContext
@@ -104,7 +125,7 @@ shumai has its own cloud file system. If a user asks you to perform file system
If you need to create files in the local filesystem (for example, a temporary file for uploading), only the '.pi' folder in the current directory has write permissions. Do NOT attempt to create files in any other directories.
When creating a file or version, first use 'list_autofill_fields' to inspect the project's AI-autofillable metadata fields. If relevant metadata depends on information unavailable from the file content (for example, the AI model or prompt used to generate the asset), include a context in the 'context' field of 'create_file' or 'create_version'. Keep the context short and only include information relevant to those fields.`
When creating a file or version, you may attach metadata (for example, the AI model or prompt used to generate the asset). The allowed field keys and value types are declared directly in the 'metadata' parameter of the 'create_file' and 'create_version' tools.`
if (agent.soul) {
systemPrompt = `${systemPrompt}\n\nAgent Personality and Core Instructions:\n${agent.soul}`
@@ -113,6 +134,40 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
// Note: params.agentsInstruction is no longer appended to systemPrompt here.
// Instead, it is persisted as a custom message session entry in the conversation history below.
let targetAssetId = params.assetId
if (!targetAssetId) {
if (params.userCommentId) {
const comment = await prisma.assetComment.findUnique({
where: { id: params.userCommentId },
select: { assetId: true },
})
if (comment?.assetId) {
targetAssetId = comment.assetId
}
} else if (params.taskId) {
const task = await prisma.workflowTask.findUnique({
where: { id: params.taskId },
select: { assetId: true },
})
if (task?.assetId) {
targetAssetId = task.assetId
}
} else if (params.projectId) {
const project = await prisma.project.findUnique({
where: { id: params.projectId },
select: { rootFolderId: true },
})
if (project?.rootFolderId) {
targetAssetId = project.rootFolderId
}
}
}
const contextFiles = targetAssetId ? await assetService.getNestedAgentsMd(targetAssetId) : []
if (contextFiles.length > 0) {
systemPrompt += formatProjectContextPrompt(contextFiles)
}
const modelConfig = agent.modelRef?.config
if (modelConfig?.input) {
systemPrompt += `\n\nYour current model supports the following input types: ${modelConfig.input.join(', ')}.`
@@ -125,7 +180,12 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
// sessions never receive MCP tools even if a server is assigned.
const mcpTools =
agent.type === 'chat'
? await mcpService.buildAgentTools(params.agentId, params.teamId, params.userId)
? await mcpService.buildAgentTools(
params.agentId,
params.teamId,
params.userId,
params.projectId,
)
: []
const { session, harness } = await createAgentSession({
@@ -144,6 +204,7 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
allowedDomains,
sessionId: params.sessionId,
userId: params.userId,
projectId: params.projectId,
userCommentId: params.userCommentId,
customTools: [...(params.tools || []), ...mcpTools],
providers: dbProviders.map((p) => ({
@@ -237,6 +298,39 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
let grandTotalTokens = 0
let totalCost = 0
const effectiveRole = params.userId
? await resolveEffectiveRole(params.teamId, params.projectId, params.userId)
: undefined
try {
await quotaService.checkQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_total_tokens',
},
0,
)
await quotaService.checkQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_cost',
},
0,
)
} catch (err) {
if (err instanceof QuotaExceededError) {
throw ApplicationFailure.create({
message: err.message,
nonRetryable: true,
})
}
throw err
}
harness.subscribe(async (event) => {
if (event.type === 'message_end' && event.message.role === 'assistant') {
const assistantMsg = event.message
@@ -267,6 +361,29 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
} catch (err) {
logger.error({ err }, 'Failed to record AI usage')
}
try {
await quotaService.consumeQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_total_tokens',
},
totalTokens,
)
await quotaService.consumeQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_cost',
},
cost,
)
} catch (err) {
logger.error({ err }, 'Failed to record quota usage for AI call')
}
}
}
})
@@ -279,6 +396,29 @@ When creating a file or version, first use 'list_autofill_fields' to inspect the
totalCacheReadTokens = assistantMessage.usage.cacheRead || 0
grandTotalTokens = assistantMessage.usage.totalTokens || totalInputTokens + totalOutputTokens
totalCost = assistantMessage.usage.cost?.total || 0
try {
await quotaService.consumeQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_total_tokens',
},
grandTotalTokens,
)
await quotaService.consumeQuota(
{
teamId: params.teamId,
userId: params.userId,
role: effectiveRole,
resource: 'agent_cost',
},
totalCost,
)
} catch (err) {
logger.error({ err }, 'Failed to record fallback quota usage for AI call')
}
}
const sessionEntries = await session.getEntries()
@@ -347,6 +487,7 @@ export interface AgentChatParams {
imageUrls: string[]
projectId: string
folderId: string
assetId?: string
agentsInstruction?: string
sessionId: string
userId?: string
@@ -411,6 +552,8 @@ export async function agentChatActivity(params: AgentChatParams) {
agentsInstruction: params.agentsInstruction || '',
sessionId,
userId: params.userId,
projectId: params.projectId,
assetId: params.assetId || params.folderId,
userCommentId: params.userCommentId,
context: params.context,
attachedAssets: params.attachedAssets,
@@ -422,17 +565,12 @@ export interface AutofillAiParams {
images: string[]
fields: AutofillField[]
context: AgentExecutionContext
agentContext?: string
assetId?: string
projectId?: string
}
export async function autofillAiActivity(params: AutofillAiParams) {
let prompt = 'Analyze the provided images and extract metadata.'
if (params.agentContext && params.agentContext.trim()) {
prompt +=
'\n\nAdditional context about this file, provided during creation:\n' +
`<context>\n${params.agentContext.trim()}\n</context>\n` +
'Use this context to inform your answers, especially for fields that cannot be determined from the images alone (e.g. generation model/source).'
}
const prompt = 'Analyze the provided images and extract metadata.'
const toolSchema = fieldsToTypeBoxSchema(params.fields)
let capturedData: Record<string, unknown> | null = null
@@ -462,6 +600,8 @@ export async function autofillAiActivity(params: AutofillAiParams) {
agentsInstruction: '',
sessionId: undefined,
userId: undefined,
projectId: params.projectId,
assetId: params.assetId,
tools: [autofillTool],
context: params.context,
})
@@ -837,6 +977,8 @@ export async function updateCommentActivity(params: {
export async function getAgentChatContextActivity(params: {
teamId: string
agentId: string
userId?: string
projectId?: string
}): Promise<AgentExecutionContext> {
const team = await prisma.team.findUnique({
where: { id: params.teamId },
@@ -864,6 +1006,18 @@ export async function getAgentChatContextActivity(params: {
})
}
if (params.userId) {
const effectiveRole = await resolveEffectiveRole(params.teamId, params.projectId, params.userId)
const userLevel = getRoleLevel(effectiveRole)
const requiredLevel = getAgentRequiredLevel(agent.permission)
if (userLevel < requiredLevel) {
throw ApplicationFailure.create({
message: `Permission denied: Insufficient role to use agent "${params.agentId}". Minimum required role is "${agent.permission}".`,
nonRetryable: true,
})
}
}
if (!agent.provider) {
throw ApplicationFailure.create({
message: 'agent has no provider configured',
@@ -885,10 +1039,22 @@ export async function getAgentChatContextActivity(params: {
include: { models: true },
})
// Only advertise skills that are explicitly enabled for this agent (agent_skills).
// Disabled skills must not be listed in the system prompt nor loadable via read_skill.
// Only advertise skills that are explicitly enabled for this agent (agent_skills)
// AND permitted for the requesting user's effective role. Disabled or
// un-permitted skills must not be listed in the system prompt nor loadable
// via read_skill (read_skill keeps its own permission check as a backstop).
const enabledSkills = (agent.skills ?? []).map((as) => as.skill)
const enabledSkillIds = enabledSkills.map((s) => s.id)
let permittedSkills = enabledSkills
if (params.userId) {
const effectiveRole = await resolveEffectiveRole(params.teamId, params.projectId, params.userId)
if (!effectiveRole) {
permittedSkills = []
} else {
const userLevel = getRoleLevel(effectiveRole)
permittedSkills = enabledSkills.filter((s) => (getRoleLevel(s.permission) || 1) <= userLevel)
}
}
const enabledSkillIds = permittedSkills.map((s) => s.id)
// Fetch the agent's assigned MCP servers
const assignments = await prisma.agentMcpServer.findMany({
@@ -900,12 +1066,12 @@ export async function getAgentChatContextActivity(params: {
const sandbox = await prisma.sandbox.findUnique({
where: { teamId: params.teamId },
})
const allowedDomains = sandbox?.allowedDomains || []
const allowedDomains = sandbox?.networkSandboxEnabled ? sandbox.allowedDomains : ['*']
return {
agent,
dbProviders,
teamSkills: enabledSkills,
teamSkills: permittedSkills,
mcpServers,
enabledSkillIds,
allowedDomains,
@@ -984,7 +1150,7 @@ export async function getAgentAutofillContextActivity(params: {
const sandbox = await prisma.sandbox.findUnique({
where: { teamId: params.teamId },
})
const allowedDomains = sandbox?.allowedDomains || []
const allowedDomains = sandbox?.networkSandboxEnabled ? sandbox.allowedDomains : ['*']
return {
agent: agentWithDetails,
@@ -1043,15 +1209,7 @@ export async function getCommentActivity(commentId: string) {
export async function getProjectAutofillFieldsActivity(projectId: string) {
const fields = await metadataService.listProjectFields('', projectId)
return fields.filter((f) => f.field.aiAutofill).map((f) => f.field)
}
export async function getAssetAutofillContextActivity(assetId: string): Promise<string | null> {
const asset = await prisma.asset.findUnique({
where: { id: assetId },
select: { autofillContext: true },
})
return asset?.autofillContext ?? null
return fields.filter((f) => f.field.config?.autofillSource === 'CONTENT').map((f) => f.field)
}
export async function updateAssetMetadataActivity(params: {
@@ -1100,7 +1258,37 @@ export interface ExecuteAgentToolParams {
userId?: string
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
/**
* Validates that every metadata key provided by the agent is a defined
* CREATION_CONTEXT field of the project. Unknown keys are rejected with a
* non-retryable failure so Temporal does not retry expected validation errors.
*/
async function validateCreationContextMetadata(
userId: string,
projectId: string,
metadata: Record<string, unknown> | undefined,
): Promise<void> {
if (!metadata || Object.keys(metadata).length === 0) return
const fields = await metadataService.listProjectFields(userId, projectId)
const allowedKeys = new Set(
fields
.filter((f) => f.field.config?.autofillSource === 'CREATION_CONTEXT')
.map((f) => f.field.key),
)
const invalidKeys = Object.keys(metadata).filter((key) => !allowedKeys.has(key))
if (invalidKeys.length > 0) {
throw ApplicationFailure.create({
message:
`metadata contains keys that are not valid in this project: ${invalidKeys.join(', ')}. ` +
"The valid metadata fields are fixed to the current conversation's project. " +
'If the target folder or file belongs to a different project, call the tool WITHOUT the metadata parameter.',
nonRetryable: true,
})
}
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Activity return type is a union of tool result shapes
export async function executeAgentToolActivity(params: ExecuteAgentToolParams): Promise<any> {
const { toolName, args, userId } = params
if (!userId) {
@@ -1174,9 +1362,7 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
{ first: limit, after },
)
const stackIds = assets
.filter((a) => a.type === AssetType.version_stack && (!a.name || a.name === ''))
.map((a) => a.id)
const stackIds = assets.filter((a) => a.type === AssetType.version_stack).map((a) => a.id)
const latestVersionsMap = new Map<string, Prisma.AssetGetPayload<Record<string, never>>>()
@@ -1197,10 +1383,7 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
const latestVersion = latestVersionsMap.get(a.id)
return {
id: a.id,
name:
a.type === AssetType.version_stack && (!a.name || a.name === '')
? (latestVersion?.name ?? a.name)
: a.name,
name: a.type === AssetType.version_stack ? (latestVersion?.name ?? a.name) : a.name,
type: a.type,
size:
a.type === AssetType.version_stack && latestVersion
@@ -1254,7 +1437,10 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
const name = args.name as string
const fileSize = args.size as number
const mimeType = args.contentType as string
const context = typeof args.context === 'string' ? args.context : undefined
const metadata =
typeof args.metadata === 'object' && args.metadata !== null
? (args.metadata as Record<string, unknown>)
: undefined
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
throw ApplicationFailure.create({
message: 'parent, s3Key, name, size, and contentType parameters are required',
@@ -1288,6 +1474,9 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
})
}
// Validate that any provided metadata keys are defined CREATION_CONTEXT fields
await validateCreationContextMetadata(userId, parentAsset.projectId, metadata)
// Create asset via assetService
const newFile = await assetService.createAsset({
name,
@@ -1304,12 +1493,14 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await assetService.updateAncestorsSize(tx as any, parent, fileSize)
// Persist autofill context provided by the agent (used by the autofill workflow)
if (context) {
await tx.asset.update({
where: { id: newFile.id },
data: { autofillContext: context },
})
// Persist creation context metadata provided by the agent
if (metadata) {
const metadataUpdates = Object.entries(metadata)
.filter(([, value]) => value !== null)
.map(([key, value]) => ({ key, value }))
if (metadataUpdates.length > 0) {
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
}
}
// Trigger post-upload transcode and AI workflows
@@ -1335,7 +1526,10 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
const name = args.name as string
const fileSize = args.size as number
const mimeType = args.contentType as string
const context = typeof args.context === 'string' ? args.context : undefined
const metadata =
typeof args.metadata === 'object' && args.metadata !== null
? (args.metadata as Record<string, unknown>)
: undefined
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
throw ApplicationFailure.create({
message: 'parent, s3Key, name, size, and contentType parameters are required',
@@ -1361,6 +1555,9 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
})
}
// Validate that any provided metadata keys are defined CREATION_CONTEXT fields
await validateCreationContextMetadata(userId, parentFile.projectId, metadata)
// Authz check: verify Edit permission on the parent file (resource ID is parent file id)
await authzService.hasPermission({
user,
@@ -1400,12 +1597,14 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
where: { id: newFile.id },
data: { sortIndex: newSortIndex },
})
// Persist autofill context provided by the agent (used by the autofill workflow)
if (context) {
await tx.asset.update({
where: { id: newFile.id },
data: { autofillContext: context },
})
// Persist creation context metadata provided by the agent
if (metadata) {
const metadataUpdates = Object.entries(metadata)
.filter(([, value]) => value !== null)
.map(([key, value]) => ({ key, value }))
if (metadataUpdates.length > 0) {
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
}
}
// Increment stack's size (fileCount is incremented by createAsset already)
const updatedStack = await tx.asset.update({
@@ -1465,12 +1664,14 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
projectId: parentFile.projectId!,
creatorId: userId,
})
// Persist autofill context provided by the agent (used by the autofill workflow)
if (context) {
await tx.asset.update({
where: { id: newFile.id },
data: { autofillContext: context },
})
// Persist creation context metadata provided by the agent
if (metadata) {
const metadataUpdates = Object.entries(metadata)
.filter(([, value]) => value !== null)
.map(([key, value]) => ({ key, value }))
if (metadataUpdates.length > 0) {
await metadataService.updateAssetMetadataInTx(tx, newFile.id, metadataUpdates)
}
}
// Update ancestors' size (add size of the new file version)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1494,49 +1695,6 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
}
}
case 'list_autofill_fields': {
const parent = args.parent
if (!parent) {
throw ApplicationFailure.create({
message: 'parent parameter is required',
nonRetryable: true,
})
}
// Authz check
await authzService.hasPermission({
user,
permission: Permission.Read,
type: ResourceType.Asset,
id: parent,
})
// Resolve projectId from the parent asset (climb ancestor chain if needed)
const projectId = await resolveAssetProjectId(parent)
if (!projectId) {
throw ApplicationFailure.create({
message: `Could not resolve project for parent: ${parent}`,
nonRetryable: true,
})
}
const fields = await metadataService.listProjectFields(userId, projectId)
const autofillFields = fields
.filter((f) => f.field.aiAutofill)
.map((f) => ({
name: f.field.config?.name,
type: f.field.config?.type,
description: f.field.description,
options: (
f.field.config?.select?.options ??
f.field.config?.selectMulti?.options ??
[]
).map((o) => ({ displayName: o.displayName })),
}))
return { fields: autofillFields }
}
default:
throw ApplicationFailure.create({
message: `Unsupported tool name: ${toolName}`,
@@ -1545,21 +1703,6 @@ export async function executeAgentToolActivity(params: ExecuteAgentToolParams):
}
}
async function resolveAssetProjectId(assetId: string): Promise<string | null> {
let currentId: string | null = assetId
while (currentId) {
/* prettier-ignore */
const assetNode = (await prisma.asset.findUnique({
where: { id: currentId },
select: { id: true, projectId: true, parentId: true },
})) as { id: string; projectId: string | null; parentId: string | null } | null
if (!assetNode) break
if (assetNode.projectId) return assetNode.projectId
currentId = assetNode.parentId
}
return null
}
export interface GenerateSessionNameParams {
teamId: string
agentId: string
+299 -1
View File
@@ -8,8 +8,11 @@ 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 { 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 +92,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 +207,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 +305,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 +887,149 @@ 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)
})
})
describe('createAgentSession enabled skill filtering', () => {
setupTestDbHooks()
@@ -958,4 +1174,86 @@ 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()
}
})
})
+154 -51
View File
@@ -9,15 +9,18 @@ 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 { metadataService } from '@shumai/core/src/metadata/metadata'
import { createAnalyzeImageTool } from './tools/analyze-image'
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'
@@ -102,6 +105,7 @@ export interface CreateAgentSessionParams {
allowedDomains: string[]
sessionId?: string
userId?: string
projectId?: string
userCommentId?: string | null
customTools?: AgentTool[]
thinkingLevel?: string
@@ -111,18 +115,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 +142,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
allowedDomains,
sessionId,
userId,
projectId,
userCommentId: passedUserCommentId,
customTools = [],
thinkingLevel,
@@ -183,11 +176,17 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
blockedHost: '',
}
const role = userId ? await resolveEffectiveRole(teamId, projectId, userId) : undefined
const isOwner = !userId || role === 'owner'
const restricted = !isOwner
const sandboxAskCallback = async ({ host }: { host: string; port?: number }) => {
try {
const sandbox = await prisma.sandbox.findUnique({
where: { teamId },
})
if (sandbox && !sandbox.networkSandboxEnabled) {
return true
}
const pendingDomains = sandbox?.pendingDomains || []
if (!pendingDomains.includes(host)) {
await prisma.sandbox.upsert({
@@ -212,6 +211,54 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
return false
}
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 },
},
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
},
}
}
// 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.
@@ -237,13 +284,6 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
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) {
@@ -289,6 +329,9 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
const deniedTools = agentConfig?.deniedTools || []
const sandboxedBash = createSandboxedBashTool(process.cwd(), skillEnvs, {
teamId,
userId,
role,
getBlockedHost: () => sandboxState.blockedHost,
clearBlockedHost: () => {
sandboxState.blockedHost = ''
@@ -309,7 +352,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 +363,23 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
onEnvsAdded,
restricted ? onSkillLoaded : undefined,
enabledSkillIds,
projectId,
)
const systemTools: AgentTool[] = []
if (userId) {
const metadataSchema = await buildProjectMetadataSchema(projectId)
systemTools.push(
createListAssetsTool(userId),
createCreateFolderTool(userId),
createCreateFileTool(userId),
createCreateVersionTool(userId),
createCreateFileTool(userId, metadataSchema),
createCreateVersionTool(userId, metadataSchema),
createDownloadAssetTool(userId),
createListAutofillFieldsTool(userId),
)
}
const readThread = createReadThreadTool()
const allTools = [
const rawTools = [
...mediaTools,
readSkill,
readThread,
@@ -343,6 +387,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))
@@ -410,58 +455,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 {
@@ -0,0 +1,97 @@
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 { executeAgentToolWorkflow } from './tools/utils'
vi.mock('@shumai/core/src/s3/s3', () => ({
s3Service: {
uploadFileToKey: vi.fn(),
putObject: vi.fn(),
},
}))
vi.mock('./tools/utils', () => ({
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'test', type: 'file' }),
}))
/**
* 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({ id: 'file-1', name: 'test', type: 'file' })
expect(s3Service.putObject).toHaveBeenCalledTimes(1)
expect(executeAgentToolWorkflow).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 })
})
})
+104 -18
View File
@@ -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 -1
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { type ImageContent } from '@earendil-works/pi-ai'
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
+130 -15
View File
@@ -1,7 +1,9 @@
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 { Value } from 'typebox/value'
import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
@@ -44,7 +46,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()
@@ -70,37 +72,93 @@ describe('createCreateFileTool', () => {
expect(result.details).toEqual({ id: 'file-1', name: 'test', type: 'file' })
})
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 the agent tool workflow 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.objectContaining({
args: expect.objectContaining({ context: 'Generated using gemini' }),
args: expect.objectContaining({ 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' } }],
},
})
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
expect.objectContaining({
args: expect.objectContaining({
metadata: {
provider: { newOption: { value: 'Kling' } },
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
},
}),
}),
)
})
it('should not include metadata in args 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(executeAgentToolWorkflow).mock.calls[0][0].args
expect(callArgs).not.toHaveProperty('context')
expect(callArgs).not.toHaveProperty('metadata')
})
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()
@@ -110,6 +168,7 @@ describe('createCreateFileTool', () => {
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' },
})
@@ -145,6 +204,7 @@ describe('createCreateFileTool', () => {
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 +222,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' },
})
@@ -183,9 +244,9 @@ describe('createCreateFileTool', () => {
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 () => {
@@ -201,4 +262,58 @@ describe('createCreateFileTool', () => {
expect(s3Service.putObject).not.toHaveBeenCalled()
expect(executeAgentToolWorkflow).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()
})
})
+56 -46
View File
@@ -2,69 +2,78 @@ import { type AgentTool } from '@earendil-works/pi-agent-core'
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, 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): 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
@@ -99,15 +108,15 @@ export function createCreateFileTool(userId: string): AgentTool<typeof createFil
const result = await executeAgentToolWorkflow({
toolName: 'create_file',
args: {
parent: params.parent,
parent: p.parent,
s3Key,
name,
size,
contentType: mimeType,
...(params.context ? { context: params.context } : {}),
...(p.metadata ? { metadata: p.metadata } : {}),
},
userId,
assetId: params.parent,
assetId: p.parent,
})
return {
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
@@ -115,4 +124,5 @@ export function createCreateFileTool(userId: string): AgentTool<typeof createFil
}
},
}
return tool
}
+1 -1
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { executeAgentToolWorkflow } from './utils'
+91 -10
View File
@@ -1,7 +1,9 @@
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 { Value } from 'typebox/value'
import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
@@ -67,31 +69,80 @@ describe('createCreateVersionTool', () => {
expect(result.details).toEqual({ id: 'file-1', name: 'v2', type: 'file' })
})
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 the agent tool workflow 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.objectContaining({
args: expect.objectContaining({ context: 'Generated using gemini' }),
args: expect.objectContaining({ 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' } }],
},
})
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
expect.objectContaining({
args: expect.objectContaining({
metadata: {
provider: { newOption: { value: 'Kling' } },
tags: ['tag1', { newOption: { value: 'Tag 2' } }],
},
}),
}),
)
})
it('should not include metadata in args 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(executeAgentToolWorkflow).mock.calls[0][0].args
expect(callArgs).not.toHaveProperty('context')
expect(callArgs).not.toHaveProperty('metadata')
})
it('should throw when the local file does not exist', async () => {
@@ -102,4 +153,34 @@ describe('createCreateVersionTool', () => {
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
expect(executeAgentToolWorkflow).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()
})
})
+35 -28
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type, type TSchema } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { executeAgentToolWorkflow } from './utils'
import * as fs from 'fs'
@@ -8,36 +8,42 @@ import { readFileMimeType } from '@shumai/core/src/utils/file-mime'
import { ulid } from 'ulid'
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
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): 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
@@ -50,15 +56,15 @@ export function createCreateVersionTool(userId: string): AgentTool<typeof create
const result = await executeAgentToolWorkflow({
toolName: 'create_version',
args: {
parent: params.parent,
parent: p.parent,
s3Key,
name: path.basename(absolutePath),
size: fileSize,
contentType: mimeType,
...(params.context ? { context: params.context } : {}),
...(p.metadata ? { metadata: p.metadata } : {}),
},
userId,
assetId: params.parent,
assetId: p.parent,
})
return {
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
@@ -66,4 +72,5 @@ export function createCreateVersionTool(userId: string): AgentTool<typeof create
}
},
}
return tool
}
+1 -1
View File
@@ -1,4 +1,4 @@
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'
+1 -1
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { executeAgentToolWorkflow } from './utils'
@@ -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,
}
},
}
}
+1 -1
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { type ImageContent } from '@earendil-works/pi-ai'
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
@@ -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', () => {
+9 -10
View File
@@ -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}".`,
+1 -1
View File
@@ -1,5 +1,5 @@
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({
+35 -1
View File
@@ -1,7 +1,7 @@
import { logger } from '@shumai/core/src/logger'
import { SandboxManager } from '@anthropic-ai/sandbox-runtime'
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,6 +35,9 @@ export interface BashDetails {
}
export interface SandboxedBashOptions {
teamId?: string
userId?: string
role?: TeamMemberRole | null
getBlockedHost?: () => string
clearBlockedHost?: () => void
/**
@@ -66,6 +71,18 @@ 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)
@@ -219,6 +236,23 @@ export const createSandboxedBashTool = (
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 -1
View File
@@ -1,4 +1,4 @@
import { Type } from '@sinclair/typebox'
import { Type } from 'typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { type ImageContent } from '@earendil-works/pi-ai'
import { prisma, WorkflowTaskType, WorkflowTaskStatus, type User } from '@shumai/db'
@@ -64,6 +64,7 @@ describe('Agent Autofill Workflow', () => {
mockActivities.createCommentActivity.mockResolvedValue({ id: 'comment-placeholder-id' })
mockActivities.getAssetActivity.mockResolvedValue({
id: 'a1',
projectId: 'p1',
storageKey: { key: 'asset-key' },
project: { id: 'p1', teamId: 't1' },
mediaType: 'image/png',
@@ -78,7 +79,6 @@ describe('Agent Autofill Workflow', () => {
{ 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',
@@ -118,6 +118,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',
@@ -140,11 +143,12 @@ describe('Agent Autofill Workflow', () => {
expect(mockActivities.getAgentAutofillContextActivity).toHaveBeenCalledWith({
teamId: 't1',
})
expect(mockActivities.getAssetAutofillContextActivity).toHaveBeenCalledWith('a1')
// Verify AI autofill called with mapped fields
expect(mockActivities.autofillAiActivity).toHaveBeenCalledWith({
teamId: 't1',
assetId: 'a1',
projectId: 'p1',
images: ['/tmp/test-dir/1.webp'],
fields: [
{
@@ -154,7 +158,6 @@ describe('Agent Autofill Workflow', () => {
},
],
context: { agent: { id: 'b1' } },
agentContext: 'Generated using gemini',
})
// Verify task usage update
@@ -195,42 +198,6 @@ describe('Agent Autofill Workflow', () => {
})
})
it('should run autofill without agentContext when the asset has no context', async () => {
mockActivities.getAssetAutofillContextActivity.mockResolvedValue(null)
const task = await prisma.workflowTask.create({
data: {
type: 'ai_metadata_autofill',
status: 'pending',
assetId: 'a1',
payload: {
projectId: 'p1',
agent: { sessionId: 's1', agentId: 'agent-1' },
},
},
})
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' } },
}),
)
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([])
+8 -13
View File
@@ -15,7 +15,6 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
extractAiMetadataActivity,
getProjectAutofillFieldsActivity,
getAgentAutofillContextActivity,
getAssetAutofillContextActivity,
autofillAiActivity,
updateTaskUsageActivity,
updateAssetMetadataActivity,
@@ -132,17 +131,12 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
teamId,
})
// 3c. Fetch Agent-Provided Autofill Context (from create_file/create_version)
const agentContext = await executeActivity(
agentWorkerQueue,
getAssetAutofillContextActivity,
asset.id,
)
// 4. Call AI Service
const aiResult = await executeActivity(agentWorkerQueue, autofillAiActivity, {
teamId,
images: generatedFiles,
assetId: asset.id,
projectId: asset.projectId ?? undefined,
fields: fields.map(
(f: { key: string; config: Record<string, unknown>; description?: string | null }) => ({
id: f.key,
@@ -151,7 +145,6 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
}),
),
context,
...(agentContext ? { agentContext } : {}),
})
if (aiResult.usage) {
@@ -166,10 +159,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, {
@@ -118,6 +118,15 @@ describe('Agent Chat Workflow', () => {
// Verify comment context fetched
expect(mockActivities.getCommentActivity).toHaveBeenCalledWith('c1')
// Verify agent context fetched with the project context forwarded
// (required for project-aware role enforcement in the activity)
expect(mockActivities.getAgentChatContextActivity).toHaveBeenCalledWith({
teamId: 't1',
agentId: 'b1',
userId: undefined,
projectId: 'p1',
})
// Verify placeholder comment created
expect(mockActivities.createCommentActivity).toHaveBeenCalledWith({
assetId: 'a1',
@@ -150,6 +159,7 @@ describe('Agent Chat Workflow', () => {
agentsInstruction: expectedInstruction1,
sessionId: 'session-123',
folderId: 'parent-folder-id',
assetId: 'a1',
}),
)
@@ -114,6 +114,8 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
const context = await executeActivity(agentWorkerQueue, getAgentChatContextActivity, {
teamId,
agentId: agentId,
userId: payload.agent?.userId,
projectId: payload.projectId,
})
const pathContext = await executeActivity(
@@ -202,6 +204,7 @@ export async function agentChat(task: WorkflowTask): Promise<void> {
imageUrls: attachmentImageUrls,
projectId: payload.projectId,
folderId,
assetId: asset.id,
agentsInstruction: instruction,
sessionId,
userId: payload.agent?.userId,
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/api",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"main": "./src/index.ts",
+152
View File
@@ -1,7 +1,9 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import { HTTPException } from 'hono/http-exception'
import { agentService } from '@shumai/core/src/agent/agent'
import { authzService } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import type { AgentInfo } from '@shumai/dtos'
import app from './agent'
vi.mock('@shumai/core/src/agent/agent')
@@ -12,6 +14,24 @@ vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
},
}))
/**
* Shape of the agent rows returned by the (mocked) service methods. Mirrors
* the real AgentInfoSource consumed by AgentService.toAgentInfo.
*/
interface MockAgentRow {
id: string
user: { name: string; image?: string | null }
type: string
enabled?: boolean
permission?: string
providerId?: string | null
modelId?: string | null
soul?: string | null
config?: { thinkingLevel?: string; systemPrompt?: string; deniedTools?: string[] }
skills?: Array<{ id: string; skillId: string; skill?: { id: string; name: string } }>
mcpServers?: Array<{ mcpServerId: string }>
}
describe('Agent API', () => {
beforeEach(() => {
vi.clearAllMocks()
@@ -20,6 +40,32 @@ describe('Agent API', () => {
id: 'agent1',
teamId: 'team1',
} as unknown as Awaited<ReturnType<typeof agentService.getAgent>>)
// The route delegates AgentInfo mapping to the service; replicate the real
// mapping so response assertions keep working.
vi.mocked(agentService.toAgentInfo).mockImplementation(async (agent) => {
const config = agent.config as MockAgentRow['config']
return {
id: agent.id,
name: agent.user.name,
type: agent.type,
enabled: agent.enabled ?? true,
permission: agent.permission ?? 'reviewer',
avatar: agent.user.image || undefined,
providerId: agent.providerId || undefined,
modelId: agent.modelId || undefined,
thinkingLevel: config?.thinkingLevel || 'off',
systemPrompt: config?.systemPrompt,
soul: agent.soul || undefined,
skills: (agent.skills || []).map((s) => ({
id: s.id,
skillId: s.skillId,
skill: s.skill,
})),
mcpServerIds: (agent.mcpServers || []).map((m) => m.mcpServerId),
deniedTools: config?.deniedTools || [],
} as unknown as AgentInfo
})
})
describe('GET /teams/:teamId/agents', () => {
@@ -183,6 +229,63 @@ describe('Agent API', () => {
})
})
describe('PATCH /agents/:agentId/permission', () => {
it('updates agent permission when user is admin', async () => {
const mockAgent = {
id: 'agent1',
teamId: 'team1',
user: { name: 'Bot 1', image: 'avatar1' },
type: 'chat',
enabled: true,
permission: 'owner',
config: {
provider: 'prov1',
model: 'model1',
},
skills: [],
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(agentService.updateAgentPermission).mockResolvedValue(mockAgent as any)
const res = await app.request('/agents/agent1/permission', {
method: 'PATCH',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ permission: 'owner' }),
})
expect(res.status).toBe(200)
const data = await res.json()
expect(data.permission).toBe('owner')
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: undefined,
permission: 'Admin',
type: 'agent',
id: 'agent1',
})
expect(agentService.updateAgentPermission).toHaveBeenCalledWith('agent1', 'owner')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'agent_update',
teamId: 'team1',
userId: undefined,
itemId: 'agent1',
})
})
it('denies access when user is not admin', async () => {
vi.mocked(authzService.hasPermission).mockRejectedValue(
new HTTPException(403, { message: 'Forbidden' }),
)
const res = await app.request('/agents/agent1/permission', {
method: 'PATCH',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ permission: 'owner' }),
})
expect(res.status).toBe(403)
})
})
describe('GET /agent-sessions/:sessionId/entries', () => {
it('returns entries of agent session if user is admin', async () => {
const mockEntries = [
@@ -258,4 +361,53 @@ describe('Agent API', () => {
})
})
})
describe('GET /projects/:projectId/chat-agents', () => {
it('returns project-scoped chat agents for the user', async () => {
const mockAgents = [
{
id: 'agent1',
name: 'Chat Bot',
type: 'chat',
enabled: true,
permission: 'reviewer',
skills: [],
mcpServerIds: [],
deniedTools: [],
},
]
vi.mocked(agentService.listProjectChatAgents).mockResolvedValue(
mockAgents as unknown as Awaited<ReturnType<typeof agentService.listProjectChatAgents>>,
)
const res = await app.request('/projects/project1/chat-agents', {
headers: { 'Content-Type': 'application/json' },
})
expect(res.status).toBe(200)
const data = await res.json()
expect(data).toHaveLength(1)
expect(data[0].name).toBe('Chat Bot')
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: undefined,
permission: 'Read',
type: 'project',
id: 'project1',
})
expect(agentService.listProjectChatAgents).toHaveBeenCalledWith('project1', undefined)
})
it('denies access when the user has no project access', async () => {
vi.mocked(authzService.hasPermission).mockRejectedValue(
new HTTPException(403, { message: 'Forbidden' }),
)
const res = await app.request('/projects/project1/chat-agents', {
headers: { 'Content-Type': 'application/json' },
})
expect(res.status).toBe(403)
expect(agentService.listProjectChatAgents).not.toHaveBeenCalled()
})
})
})
+48 -65
View File
@@ -2,13 +2,12 @@ import { Hono } from 'hono'
import { zValidator } from '@hono/zod-validator'
import { agentService } from '@shumai/core/src/agent/agent'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { getAvatarUrl } from '@shumai/core/src/user/avatar'
import {
createAgentRequestSchema,
updateAgentRequestSchema,
updateAgentPermissionRequestSchema,
paginationParamsSchema,
AgentInfo,
AgentType,
AuditAction,
} from '@shumai/dtos'
@@ -29,35 +28,28 @@ const route = new Hono<{ Variables: { user: User } }>()
id: teamId,
})
const agents = await agentService.listAgents({ teamId })
const agents = await agentService.listAgents({ teamId, userId: userReq?.id })
const res: AgentInfo[] = await Promise.all(
agents.map(async (agent) => {
const config = agent.config as unknown as PrismaJson.AgentConfig
return {
id: agent.id,
name: agent.user.name,
type: agent.type as AgentType,
enabled: agent.enabled,
avatar: (await getAvatarUrl(agent.user.image)) || undefined,
providerId: agent.providerId || undefined,
modelId: agent.modelId || undefined,
thinkingLevel: config.thinkingLevel || 'off',
systemPrompt: config.systemPrompt,
soul: agent.soul || undefined,
skills: agent.skills.map((s) => ({
id: s.id,
skillId: s.skillId,
skill: s.skill,
})),
mcpServerIds: (agent.mcpServers || []).map((m) => m.mcpServerId),
deniedTools: config.deniedTools || [],
}
}),
agents.map((agent) => agentService.toAgentInfo(agent)),
)
return c.json(res, 200)
})
.get('/projects/:projectId/chat-agents', async (c) => {
const projectId = c.req.param('projectId')
const userReq = c.get('user')
await authzService.hasPermission({
user: userReq,
permission: Permission.Read,
type: ResourceType.Project,
id: projectId,
})
const agents = await agentService.listProjectChatAgents(projectId, userReq?.id)
return c.json(agents, 200)
})
.post('/teams/:teamId/agents', zValidator('json', createAgentRequestSchema), async (c) => {
const teamId = c.req.param('teamId')
const userReq = c.get('user')
@@ -77,26 +69,7 @@ const route = new Hono<{ Variables: { user: User } }>()
if (!agent) throw new Error('failed to create agent')
const config = agent.config as unknown as PrismaJson.AgentConfig
const info: AgentInfo = {
id: agent.id,
name: agent.user.name,
type: agent.type as AgentType,
enabled: agent.enabled,
avatar: (await getAvatarUrl(agent.user.image)) || undefined,
providerId: agent.providerId || undefined,
modelId: agent.modelId || undefined,
thinkingLevel: config.thinkingLevel || 'off',
systemPrompt: config.systemPrompt,
soul: agent.soul || undefined,
skills: agent.skills.map((s) => ({
id: s.id,
skillId: s.skillId,
skill: s.skill,
})),
mcpServerIds: (agent.mcpServers || []).map((m) => m.mcpServerId),
deniedTools: config.deniedTools || [],
}
const info = await agentService.toAgentInfo(agent)
await auditLogService.logAction({
action: AuditAction.agent_create,
@@ -131,29 +104,39 @@ const route = new Hono<{ Variables: { user: User } }>()
itemId: agent.id,
})
const config = agent.config as unknown as PrismaJson.AgentConfig
const info: AgentInfo = {
id: agent.id,
name: agent.user.name,
type: agent.type as AgentType,
enabled: agent.enabled,
avatar: (await getAvatarUrl(agent.user.image)) || undefined,
providerId: agent.providerId || undefined,
modelId: agent.modelId || undefined,
thinkingLevel: config.thinkingLevel || 'off',
systemPrompt: config.systemPrompt,
soul: agent.soul || undefined,
skills: agent.skills.map((s) => ({
id: s.id,
skillId: s.skillId,
skill: s.skill,
})),
mcpServerIds: (agent.mcpServers || []).map((m) => m.mcpServerId),
deniedTools: config.deniedTools || [],
}
const info = await agentService.toAgentInfo(agent)
return c.json(info, 200)
})
.patch(
'/agents/:agentId/permission',
zValidator('json', updateAgentPermissionRequestSchema),
async (c) => {
const agentId = c.req.param('agentId')
const userReq = c.get('user')
const req = c.req.valid('json')
await authzService.hasPermission({
user: userReq,
permission: Permission.Admin,
type: ResourceType.Agent,
id: agentId,
})
const agent = await agentService.updateAgentPermission(agentId, req.permission)
await auditLogService.logAction({
action: AuditAction.agent_update,
teamId: agent.teamId,
userId: userReq?.id,
itemId: agent.id,
})
const info = await agentService.toAgentInfo(agent)
return c.json(info, 200)
},
)
.delete('/agents/:agentId', async (c) => {
const agentId = c.req.param('agentId')
const userReq = c.get('user')
+55
View File
@@ -310,4 +310,59 @@ describe('folder api', () => {
beforeIndex: 'index-1',
})
})
it('GET /folders/:folderId/agentsmd', async () => {
vi.spyOn(assetService, 'getAgentsMd').mockResolvedValue('# Folder Guidelines')
const app = new Hono().use('*', authMiddleware).route('/', folderRoute)
const res = await app.request('/folders/test-id/agentsmd')
expect(res.status).toBe(200)
const json = await res.json()
expect(json.content).toBe('# Folder Guidelines')
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: { id: 'user1', name: 'Test User' },
permission: Permission.Read,
type: ResourceType.Asset,
id: 'test-id',
})
expect(assetService.getAgentsMd).toHaveBeenCalledWith('test-id')
})
it('PATCH /folders/:folderId/agentsmd', async () => {
vi.spyOn(assetService, 'updateAgentsMd').mockResolvedValue({ content: '# Updated Guidelines' })
const app = new Hono().use('*', authMiddleware).route('/', folderRoute)
const res = await app.request('/folders/test-id/agentsmd', {
method: 'PATCH',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ content: '# Updated Guidelines' }),
})
expect(res.status).toBe(200)
const json = await res.json()
expect(json.content).toBe('# Updated Guidelines')
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: { id: 'user1', name: 'Test User' },
permission: Permission.Admin,
type: ResourceType.Asset,
id: 'test-id',
})
expect(assetService.updateAgentsMd).toHaveBeenCalledWith('test-id', '# Updated Guidelines')
})
it('PATCH /folders/:folderId/agentsmd rejects oversized content', async () => {
const mockUpdate = vi.spyOn(assetService, 'updateAgentsMd').mockResolvedValue({ content: '' })
const app = new Hono().use('*', authMiddleware).route('/', folderRoute)
const res = await app.request('/folders/test-id/agentsmd', {
method: 'PATCH',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ content: 'x'.repeat(100_001) }),
})
expect(res.status).toBe(400)
expect(mockUpdate).not.toHaveBeenCalled()
})
})
+44
View File
@@ -8,6 +8,7 @@ import {
updateFolderRequestSchema,
deleteFoldersRequestSchema,
restoreFoldersRequestSchema,
updateAgentsMdRequestSchema,
} from '@shumai/dtos'
import { listChildrenRequestSchema, updateAssetOrderRequestSchema, AuditAction } from '@shumai/dtos'
import { searchRequestSchema } from '@shumai/dtos'
@@ -189,5 +190,48 @@ const route = new Hono<{ Variables: { user: User } }>()
const result = await searchService.search(folderId, req)
return c.json(result)
})
.get('/folders/:folderId/agentsmd', async (c) => {
const folderId = c.req.param('folderId')
const user = c.get('user')
await authzService.hasPermission({
user,
permission: Permission.Read,
type: ResourceType.Asset,
id: folderId,
})
const content = await assetService.getAgentsMd(folderId)
return c.json({ content })
})
.patch(
'/folders/:folderId/agentsmd',
zValidator('json', updateAgentsMdRequestSchema),
async (c) => {
const folderId = c.req.param('folderId')
const user = c.get('user')
const req = c.req.valid('json')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Asset,
id: folderId,
})
const res = await assetService.updateAgentsMd(folderId, req.content)
const ctx = await assetService.getAssetContext(folderId)
await auditLogService.logAction({
action: AuditAction.folder_update,
teamId: ctx.teamId,
userId: user.id,
projectId: ctx.projectId,
itemId: folderId,
})
return c.json(res)
},
)
export default route
+2
View File
@@ -21,6 +21,7 @@ import s3Route from './s3'
import shareRoute from './share'
import skillRoute from './skill'
import watermarkTemplateRoute from './watermark-template'
import quotaRoute from './quota'
import teamRoute from './team'
import uploadRoute, { localUploadRoute } from './upload'
import versionStackRoute from './versionStack'
@@ -65,6 +66,7 @@ const apiRoute = new Hono<{ Variables: { user: User } }>()
.route('/', skillRoute)
.route('/', mcpRoute)
.route('/', watermarkTemplateRoute)
.route('/', quotaRoute)
app.route('/files', s3Route)
+7 -13
View File
@@ -46,10 +46,9 @@ describe('metadata api', () => {
const mockField = {
key: 'field1',
scope: 'TEAM',
config: { name: 'Test Field', type: 'text' },
config: { name: 'Test Field', type: 'text', autofillSource: 'CONTENT' },
readOnly: false,
description: 'desc',
aiAutofill: true,
}
// Using any here because mocking complex service return types or Hono context is overly verbose for this test.
@@ -62,7 +61,7 @@ describe('metadata api', () => {
expect(json).toHaveLength(1)
expect(json[0].id).toBe('field1')
expect(json[0].config.name).toBe('Test Field')
expect(json[0].aiAutofill).toBe(true)
expect(json[0].config.autofillSource).toBe('CONTENT')
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: expect.anything(),
permission: Permission.Read,
@@ -75,10 +74,9 @@ describe('metadata api', () => {
const mockField = {
key: 'newfield',
scope: 'TEAM',
config: { name: 'New Field', type: 'text' },
config: { name: 'New Field', type: 'text', autofillSource: 'CONTENT' },
readOnly: false,
description: 'desc',
aiAutofill: true,
}
// Using any here because mocking complex service return types or Hono context is overly verbose for this test.
@@ -88,8 +86,7 @@ describe('metadata api', () => {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
config: { name: 'New Field', type: 'text' },
aiAutofill: true,
config: { name: 'New Field', type: 'text', autofillSource: 'CONTENT' },
description: 'desc',
}),
})
@@ -115,10 +112,9 @@ describe('metadata api', () => {
const mockField = {
key: 'field1',
scope: 'PROJECT',
config: { name: 'Project Field', type: 'text' },
config: { name: 'Project Field', type: 'text', autofillSource: 'NONE' },
readOnly: false,
description: 'desc',
aiAutofill: false,
}
vi.mocked(metadataService.listProjectFields).mockResolvedValue([
@@ -198,10 +194,9 @@ describe('metadata api', () => {
const mockField = {
key: 'f1',
scope: 'TEAM',
config: { name: 'Updated Field', type: 'text' },
config: { name: 'Updated Field', type: 'text', autofillSource: 'CONTENT' },
readOnly: false,
description: 'desc',
aiAutofill: true,
teamId: 't1',
}
@@ -214,8 +209,7 @@ describe('metadata api', () => {
method: 'PUT',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
config: { name: 'Updated Field', type: 'text' },
aiAutofill: true,
config: { name: 'Updated Field', type: 'text', autofillSource: 'CONTENT' },
description: 'desc',
}),
})
-1
View File
@@ -27,7 +27,6 @@ function toFieldInfo(
readOnly: f.readOnly,
visible: visible,
description: f.description,
aiAutofill: f.aiAutofill,
}
}
+69
View File
@@ -264,6 +264,75 @@ describe('project api', () => {
expect(assetService.emptyTrash).toHaveBeenCalledWith('p1')
})
it('GET /projects/:projectId/members', async () => {
vi.mocked(projectService.listProjectMembers).mockResolvedValue([
{
id: 'user1',
name: 'Test User',
role: 'editor',
type: 'human',
},
])
const res = await app.request('/projects/p1/members')
expect(res.status).toBe(200)
const json = await res.json()
expect(json).toEqual([
{
id: 'user1',
name: 'Test User',
role: 'editor',
type: 'human',
},
])
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: expect.anything(),
permission: Permission.Read,
type: ResourceType.Project,
id: 'p1',
})
expect(projectService.listProjectMembers).toHaveBeenCalledWith({
projectId: 'p1',
includeAgents: false,
requesterUserId: 'user1',
})
})
it('GET /projects/:projectId/members?includeAgents=true', async () => {
vi.mocked(projectService.listProjectMembers).mockResolvedValue([
{
id: 'user1',
name: 'Test User',
role: 'editor',
type: 'human',
},
{
id: 'agent1',
name: 'Agent Bot',
role: 'bot',
type: 'agent',
},
])
const res = await app.request('/projects/p1/members?includeAgents=true')
expect(res.status).toBe(200)
const json = await res.json()
expect(json).toHaveLength(2)
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: expect.anything(),
permission: Permission.Read,
type: ResourceType.Project,
id: 'p1',
})
expect(projectService.listProjectMembers).toHaveBeenCalledWith({
projectId: 'p1',
includeAgents: true,
requesterUserId: 'user1',
})
})
it('POST /projects/:projectId/members', async () => {
vi.mocked(projectService.addProjectMember).mockResolvedValue(undefined)
+1 -15
View File
@@ -241,24 +241,10 @@ const route = new Hono<{ Variables: { user: User } }>()
const members = await projectService.listProjectMembers({
projectId,
includeAgents: includeAgents,
requesterUserId: user.id,
})
return c.json(members)
})
.get('/projects/:projectId/bots', async (c) => {
const projectId = c.req.param('projectId')
const user = c.get('user')
await authzService.hasPermission({
user,
permission: Permission.Read,
type: ResourceType.Project,
id: projectId,
})
// STUB: AgentService is not migrated yet.
return c.json([])
})
.post(
'/projects/:projectId/reparent',
zValidator('json', reparentAssetsRequestSchema),
-1
View File
@@ -93,7 +93,6 @@ function toFieldInfo(
readOnly: f.readOnly,
visible: visible,
description: f.description,
aiAutofill: f.aiAutofill,
}
}
+311
View File
@@ -0,0 +1,311 @@
import { describe, expect, test, vi, beforeEach } from 'vitest'
import { Hono } from 'hono'
import quotaRoute from './quota'
import { quotaService } from '@shumai/core/src/quota/quota-service'
import { authMiddleware } from './middleware/auth'
import { authzService, ResourceType, Permission } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import { AuditAction } from '@shumai/dtos'
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('@shumai/core/src/quota/quota-service', () => ({
quotaService: {
listRules: vi.fn(),
createRule: vi.fn(),
getRule: vi.fn(),
listRuleRecords: vi.fn(),
resetRecord: vi.fn(),
updateRule: vi.fn(),
deleteRule: vi.fn(),
},
}))
vi.mock('./middleware/auth', () => ({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
authMiddleware: async (c: any, next: any) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
c.set('user', { id: 'user1', name: 'Test User' } as any)
await next()
},
}))
vi.mock('@shumai/core/src/authz/authz', () => ({
authzService: {
hasPermission: vi.fn().mockResolvedValue(undefined),
},
Permission: {
Read: 'Read',
Edit: 'Edit',
Admin: 'Admin',
},
ResourceType: {
Team: 'team',
QuotaRule: 'quotaRule',
},
}))
describe('Quota API', () => {
const app = new Hono().use('*', authMiddleware).route('/', quotaRoute)
beforeEach(() => {
vi.restoreAllMocks()
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
})
describe('GET /teams/:teamId/quotas', () => {
test('Success listing quota rules', async () => {
const mockResult = {
total: 1,
rules: [
{
id: 'rule1',
teamId: 'team1',
scopeMode: 'all_members' as const,
resource: 'agent_total_tokens' as const,
limit: 50000,
period: '1hour' as const,
enabled: true,
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
},
],
}
vi.spyOn(quotaService, 'listRules').mockResolvedValue(mockResult)
const res = await app.request('/teams/team1/quotas', {
method: 'GET',
headers: { Authorization: 'Bearer test' },
})
expect(res.status).toBe(200)
expect(await res.json()).toEqual(mockResult)
expect(authzService.hasPermission).toHaveBeenCalledWith(
expect.objectContaining({
type: ResourceType.Team,
id: 'team1',
permission: Permission.Admin,
}),
)
})
})
describe('POST /teams/:teamId/quotas', () => {
test('Success creating rule with audit log', async () => {
const mockRule = {
id: 'rule1',
teamId: 'team1',
scopeMode: 'all_members' as const,
resource: 'agent_total_tokens' as const,
limit: 100000,
period: '1day' as const,
enabled: true,
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
}
vi.spyOn(quotaService, 'createRule').mockResolvedValue(mockRule)
const res = await app.request('/teams/team1/quotas', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer test',
},
body: JSON.stringify({
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 100000,
period: '1day',
}),
})
expect(res.status).toBe(201)
expect(await res.json()).toEqual(mockRule)
expect(quotaService.createRule).toHaveBeenCalledWith('team1', {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 100000,
period: '1day',
enabled: true,
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: AuditAction.quota_rule_create,
teamId: 'team1',
userId: 'user1',
itemId: 'rule1',
})
})
})
describe('GET /teams/:teamId/quotas/:id', () => {
test('Success fetching single rule', async () => {
const mockRule = {
id: 'rule1',
teamId: 'team1',
scopeMode: 'all_members' as const,
resource: 'agent_cost' as const,
limit: 50,
period: '1day' as const,
enabled: true,
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
}
vi.spyOn(quotaService, 'getRule').mockResolvedValue(mockRule)
const res = await app.request('/teams/team1/quotas/rule1', {
method: 'GET',
headers: { Authorization: 'Bearer test' },
})
expect(res.status).toBe(200)
expect(await res.json()).toEqual(mockRule)
})
})
describe('GET /teams/:teamId/quotas/:id/records', () => {
test('Success listing records for a rule', async () => {
const mockRecordsResult = {
total: 1,
records: [
{
id: 'rec1',
ruleId: 'rule1',
teamId: 'team1',
userId: null,
user: null,
periodStart: null,
periodEnd: null,
consumed: 0,
remaining: 50,
percent: 0,
isWindowActive: false,
},
],
}
vi.spyOn(quotaService, 'listRuleRecords').mockResolvedValue(mockRecordsResult)
const res = await app.request('/teams/team1/quotas/rule1/records', {
method: 'GET',
headers: { Authorization: 'Bearer test' },
})
expect(res.status).toBe(200)
expect(await res.json()).toEqual(mockRecordsResult)
expect(quotaService.listRuleRecords).toHaveBeenCalledWith('team1', 'rule1')
})
})
describe('POST /teams/:teamId/quotas/:id/records/reset', () => {
test('Rejects a reset request without a userId', async () => {
const res = await app.request('/teams/team1/quotas/rule1/records/reset', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer test',
},
body: JSON.stringify({}),
})
expect(res.status).toBe(400)
expect(quotaService.resetRecord).not.toHaveBeenCalled()
})
test('Success resetting a quota record with audit log', async () => {
const mockRecord = {
id: 'record1',
ruleId: 'rule1',
teamId: 'team1',
userId: 'user2',
user: null,
periodStart: new Date().toISOString(),
periodEnd: new Date(Date.now() + 60 * 60 * 1000).toISOString(),
consumed: 0,
remaining: 100,
percent: 0,
isWindowActive: true,
}
vi.spyOn(quotaService, 'resetRecord').mockResolvedValue(mockRecord)
const res = await app.request('/teams/team1/quotas/rule1/records/reset', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer test',
},
body: JSON.stringify({ userId: 'user2' }),
})
expect(res.status).toBe(200)
expect(await res.json()).toEqual(mockRecord)
expect(quotaService.resetRecord).toHaveBeenCalledWith('team1', 'rule1', 'user2')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: AuditAction.quota_record_reset,
teamId: 'team1',
userId: 'user1',
itemId: 'record1',
})
})
})
describe('PUT /teams/:teamId/quotas/:id', () => {
test('Success updating rule with audit log', async () => {
const updatedRule = {
id: 'rule1',
teamId: 'team1',
scopeMode: 'all_members' as const,
resource: 'agent_cost' as const,
limit: 100,
period: '1day' as const,
enabled: false,
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
}
vi.spyOn(quotaService, 'updateRule').mockResolvedValue(updatedRule)
const res = await app.request('/teams/team1/quotas/rule1', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer test',
},
body: JSON.stringify({
limit: 100,
enabled: false,
}),
})
expect(res.status).toBe(200)
expect(await res.json()).toEqual(updatedRule)
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: AuditAction.quota_rule_update,
teamId: 'team1',
userId: 'user1',
itemId: 'rule1',
})
})
})
describe('DELETE /teams/:teamId/quotas/:id', () => {
test('Success deleting rule with audit log', async () => {
vi.spyOn(quotaService, 'deleteRule').mockResolvedValue(undefined)
const res = await app.request('/teams/team1/quotas/rule1', {
method: 'DELETE',
headers: { Authorization: 'Bearer test' },
})
expect(res.status).toBe(204)
expect(quotaService.deleteRule).toHaveBeenCalledWith('team1', 'rule1')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: AuditAction.quota_rule_delete,
teamId: 'team1',
userId: 'user1',
itemId: 'rule1',
})
})
})
})
+152
View File
@@ -0,0 +1,152 @@
import { Hono } from 'hono'
import { zValidator } from '@hono/zod-validator'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { quotaService } from '@shumai/core/src/quota/quota-service'
import {
createQuotaRuleRequestSchema,
resetQuotaRecordRequestSchema,
updateQuotaRuleRequestSchema,
AuditAction,
} from '@shumai/dtos'
import type { Prisma } from '@shumai/db'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
type User = Prisma.UserGetPayload<Record<string, never>>
const route = new Hono<{ Variables: { user: User } }>()
.get('/teams/:teamId/quotas', async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const data = await quotaService.listRules(teamId)
return c.json(data)
})
.post('/teams/:teamId/quotas', zValidator('json', createQuotaRuleRequestSchema), async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const req = c.req.valid('json')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const rule = await quotaService.createRule(teamId, req)
await auditLogService.logAction({
action: AuditAction.quota_rule_create,
teamId,
userId: user?.id,
itemId: rule.id,
})
return c.json(rule, 201)
})
.get('/teams/:teamId/quotas/:id', async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const id = c.req.param('id')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const rule = await quotaService.getRule(teamId, id)
return c.json(rule)
})
.get('/teams/:teamId/quotas/:id/records', async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const id = c.req.param('id')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const data = await quotaService.listRuleRecords(teamId, id)
return c.json(data)
})
.post(
'/teams/:teamId/quotas/:id/records/reset',
zValidator('json', resetQuotaRecordRequestSchema),
async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const id = c.req.param('id')
const req = c.req.valid('json')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const record = await quotaService.resetRecord(teamId, id, req.userId)
await auditLogService.logAction({
action: AuditAction.quota_record_reset,
teamId,
userId: user?.id,
itemId: record.id ?? id,
})
return c.json(record)
},
)
.put('/teams/:teamId/quotas/:id', zValidator('json', updateQuotaRuleRequestSchema), async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const id = c.req.param('id')
const req = c.req.valid('json')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const rule = await quotaService.updateRule(teamId, id, req)
await auditLogService.logAction({
action: AuditAction.quota_rule_update,
teamId,
userId: user?.id,
itemId: id,
})
return c.json(rule)
})
.delete('/teams/:teamId/quotas/:id', async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const id = c.req.param('id')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
await quotaService.deleteRule(teamId, id)
await auditLogService.logAction({
action: AuditAction.quota_rule_delete,
teamId,
userId: user?.id,
itemId: id,
})
return new Response(null, { status: 204 })
})
export default route
+10 -1
View File
@@ -292,6 +292,7 @@ describe('team api', () => {
it('GET /teams/:teamId/sandbox returns sandbox settings', async () => {
mockGetSandboxSettings.mockResolvedValue({
networkSandboxEnabled: false,
allowedDomains: ['example.com'],
pendingDomains: ['pending.com'],
})
@@ -300,6 +301,7 @@ describe('team api', () => {
expect(res.status).toBe(200)
const data = await res.json()
expect(data.networkSandboxEnabled).toBe(false)
expect(data.allowedDomains).toEqual(['example.com'])
expect(data.pendingDomains).toEqual(['pending.com'])
expect(authzService.hasPermission).toHaveBeenCalledWith(
@@ -314,6 +316,7 @@ describe('team api', () => {
it('PUT /teams/:teamId/sandbox updates sandbox settings', async () => {
mockUpdateSandboxSettings.mockResolvedValue({
networkSandboxEnabled: true,
allowedDomains: ['new.com'],
pendingDomains: ['new-pending.com'],
})
@@ -321,11 +324,16 @@ describe('team api', () => {
const res = await app.request('/teams/t1/sandbox', {
method: 'PUT',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ allowedDomains: ['new.com'], pendingDomains: ['new-pending.com'] }),
body: JSON.stringify({
networkSandboxEnabled: true,
allowedDomains: ['new.com'],
pendingDomains: ['new-pending.com'],
}),
})
expect(res.status).toBe(200)
const data = await res.json()
expect(data.networkSandboxEnabled).toBe(true)
expect(data.allowedDomains).toEqual(['new.com'])
expect(data.pendingDomains).toEqual(['new-pending.com'])
expect(authzService.hasPermission).toHaveBeenCalledWith(
@@ -336,6 +344,7 @@ describe('team api', () => {
}),
)
expect(mockUpdateSandboxSettings).toHaveBeenCalledWith('t1', {
networkSandboxEnabled: true,
allowedDomains: ['new.com'],
pendingDomains: ['new-pending.com'],
})
+28
View File
@@ -32,12 +32,14 @@ vi.mock('./middleware/auth', () => ({
describe('versionStack api', () => {
let mockCreateVersionStack: any // eslint-disable-line @typescript-eslint/no-explicit-any
let mockChangeStackFileVersion: any // eslint-disable-line @typescript-eslint/no-explicit-any
let mockRemoveVersionFromStack: any // eslint-disable-line @typescript-eslint/no-explicit-any
let mockGetAsset: any // eslint-disable-line @typescript-eslint/no-explicit-any
let mockGetStackVersions: any // eslint-disable-line @typescript-eslint/no-explicit-any
beforeEach(() => {
mockCreateVersionStack = vi.spyOn(versionStackService, 'createVersionStack')
mockChangeStackFileVersion = vi.spyOn(versionStackService, 'changeStackFileVersion')
mockRemoveVersionFromStack = vi.spyOn(versionStackService, 'removeVersionFromStack')
mockGetAsset = vi.spyOn(assetService, 'getAsset')
mockGetStackVersions = vi.spyOn(assetService, 'getStackVersions')
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
@@ -146,4 +148,30 @@ describe('versionStack api', () => {
expect(mockGetStackVersions).toHaveBeenCalledWith('stack1')
})
})
describe('DELETE /version_stacks/:stackId/versions/:versionId', () => {
it('should remove version from stack and return 200', async () => {
mockRemoveVersionFromStack.mockResolvedValue()
const app = new Hono().use('*', authMiddleware).route('/', versionStackRoute)
const res = await app.request('/version_stacks/stack1/versions/v1', {
method: 'DELETE',
})
expect(res.status).toBe(200)
expect(authzService.hasPermission).toHaveBeenCalledWith(
expect.objectContaining({
type: ResourceType.Asset,
id: 'stack1',
permission: Permission.Edit,
}),
)
expect(mockRemoveVersionFromStack).toHaveBeenCalledWith({
stackId: 'stack1',
fileId: 'v1',
})
})
})
})
+19
View File
@@ -75,5 +75,24 @@ const route = app
const versions = await assetService.getStackVersions(stackId)
return c.json(versions)
})
.delete('/version_stacks/:stackId/versions/:versionId', async (c) => {
const stackId = c.req.param('stackId')
const versionId = c.req.param('versionId')
const user = c.get('user')
await authzService.hasPermission({
user,
permission: Permission.Edit,
type: ResourceType.Asset,
id: stackId,
})
await versionStackService.removeVersionFromStack({
stackId,
fileId: versionId,
})
return new Response(null, { status: 200 })
})
export default route
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/core",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"main": "./src/index.ts",
+264
View File
@@ -421,4 +421,268 @@ describe('AgentService', () => {
expect(result).toBeNull()
})
})
describe('agent permissions', () => {
test('createAgent with custom permission and updateAgentPermission', async () => {
const db = prisma
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
const agent = await svc.createAgent({
teamId: team.id,
name: 'Owner Only Agent',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'owner',
providerId: provider.id,
modelId: model.id,
})
expect(agent?.permission).toBe('owner')
const updated = await svc.updateAgentPermission(agent!.id, 'editor')
expect(updated.permission).toBe('editor')
const updatedViaUpdateAgent = await svc.updateAgent({
agentId: agent!.id,
name: 'Owner Only Agent Updated',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
expect(updatedViaUpdateAgent.permission).toBe('reviewer')
})
test('listAgents filters chat agents by requester role when userId is provided', async () => {
const db = prisma
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
// Create 3 chat agents with different permissions
const reviewerAgent = await svc.createAgent({
teamId: team.id,
name: 'All Users Agent',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
const editorAgent = await svc.createAgent({
teamId: team.id,
name: 'Editor Agent',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'editor',
providerId: provider.id,
modelId: model.id,
})
const ownerAgent = await svc.createAgent({
teamId: team.id,
name: 'Owner Agent',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'owner',
providerId: provider.id,
modelId: model.id,
})
// Create 3 test users with different roles in the team
const reviewerUser = await db.user.create({
data: { name: 'Reviewer User', email: 'rev@shumai.ai' },
})
await db.teamMember.create({
data: { teamId: team.id, userId: reviewerUser.id, role: 'reviewer' },
})
const editorUser = await db.user.create({
data: { name: 'Editor User', email: 'ed@shumai.ai' },
})
await db.teamMember.create({
data: { teamId: team.id, userId: editorUser.id, role: 'editor' },
})
const ownerUser = await db.user.create({
data: { name: 'Owner User', email: 'own@shumai.ai' },
})
await db.teamMember.create({
data: { teamId: team.id, userId: ownerUser.id, role: 'owner' },
})
// Reviewer should only see reviewerAgent
const reviewerList = await svc.listAgents({ teamId: team.id, userId: reviewerUser.id })
const reviewerAgentIds = reviewerList.map((a) => a.id)
expect(reviewerAgentIds).toContain(reviewerAgent!.id)
expect(reviewerAgentIds).not.toContain(editorAgent!.id)
expect(reviewerAgentIds).not.toContain(ownerAgent!.id)
// Editor should see reviewerAgent and editorAgent
const editorList = await svc.listAgents({ teamId: team.id, userId: editorUser.id })
const editorAgentIds = editorList.map((a) => a.id)
expect(editorAgentIds).toContain(reviewerAgent!.id)
expect(editorAgentIds).toContain(editorAgent!.id)
expect(editorAgentIds).not.toContain(ownerAgent!.id)
// Owner should see all agents
const ownerList = await svc.listAgents({ teamId: team.id, userId: ownerUser.id })
const ownerAgentIds = ownerList.map((a) => a.id)
expect(ownerAgentIds).toContain(reviewerAgent!.id)
expect(ownerAgentIds).toContain(editorAgent!.id)
expect(ownerAgentIds).toContain(ownerAgent!.id)
})
test('listProjectChatAgents filters by effective project role and chat/enabled only', async () => {
const db = prisma
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
const project = await db.project.create({
data: { name: 'Proj Agents', teamId: team.id },
})
// Two chat agents + one disabled chat agent + one embedding agent
const reviewerAgent = await svc.createAgent({
teamId: team.id,
name: 'Reviewer Chat',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
const editorAgent = await svc.createAgent({
teamId: team.id,
name: 'Editor Chat',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'editor',
providerId: provider.id,
modelId: model.id,
})
const disabledAgent = await svc.createAgent({
teamId: team.id,
name: 'Disabled Chat',
type: 'chat',
enabled: false,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
// Team reviewer, promoted to project owner in this project
const projectOwner = await db.user.create({
data: { name: 'Proj Owner', email: 'projowner@shumai.ai' },
})
const projectOwnerTm = await db.teamMember.create({
data: { teamId: team.id, userId: projectOwner.id, role: 'reviewer', scope: 'team' },
})
await db.projectMember.create({
data: { projectId: project.id, teamMemberId: projectOwnerTm.id, role: 'owner' },
})
const list = await svc.listProjectChatAgents(project.id, projectOwner.id)
const ids = list.map((a) => a.id)
expect(ids).toContain(reviewerAgent!.id)
expect(ids).toContain(editorAgent!.id)
expect(ids).not.toContain(disabledAgent!.id)
expect(list.every((a) => a.type === 'chat')).toBe(true)
expect(list.every((a) => a.enabled)).toBe(true)
})
test('listProjectChatAgents restricts project-scoped members to their project role', async () => {
const db = prisma
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
const project = await db.project.create({
data: { name: 'Proj Guest', teamId: team.id },
})
const reviewerAgent = await svc.createAgent({
teamId: team.id,
name: 'Reviewer Chat',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
const editorAgent = await svc.createAgent({
teamId: team.id,
name: 'Editor Chat',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'editor',
providerId: provider.id,
modelId: model.id,
})
// Project-scoped member invited as reviewer in this project
const guest = await db.user.create({
data: { name: 'Guest', email: 'guest@shumai.ai' },
})
const guestTm = await db.teamMember.create({
data: { teamId: team.id, userId: guest.id, role: 'reviewer', scope: 'project' },
})
await db.projectMember.create({
data: { projectId: project.id, teamMemberId: guestTm.id, role: 'reviewer' },
})
const ids = (await svc.listProjectChatAgents(project.id, guest.id)).map((a) => a.id)
expect(ids).toContain(reviewerAgent!.id)
expect(ids).not.toContain(editorAgent!.id)
})
test('listProjectChatAgents returns empty for users outside the project', async () => {
const db = prisma
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
const project = await db.project.create({
data: { name: 'Proj Closed', teamId: team.id },
})
const projectB = await db.project.create({
data: { name: 'Proj Other', teamId: team.id },
})
await svc.createAgent({
teamId: team.id,
name: 'Reviewer Chat',
type: 'chat',
enabled: true,
thinkingLevel: 'off',
permission: 'reviewer',
providerId: provider.id,
modelId: model.id,
})
// Project-scoped member of projectB only
const guest = await db.user.create({
data: { name: 'Guest B', email: 'guestb@shumai.ai' },
})
const guestTm = await db.teamMember.create({
data: { teamId: team.id, userId: guest.id, role: 'reviewer', scope: 'project' },
})
await db.projectMember.create({
data: { projectId: projectB.id, teamMemberId: guestTm.id, role: 'reviewer' },
})
const ids = (await svc.listProjectChatAgents(project.id, guest.id)).map((a) => a.id)
expect(ids).toHaveLength(0)
})
})
})
+141 -1
View File
@@ -1,10 +1,12 @@
import { prisma, type Prisma } from '@shumai/db'
import { prisma, type Prisma, type TeamMemberRole } from '@shumai/db'
import {
CreateAgentParams,
DeleteAgentParams,
ListAgentsParams,
UpdateAgentParams,
AgentSessionInfo,
AgentInfo,
AgentType,
} from '@shumai/dtos'
import {
paginateQuery,
@@ -14,10 +16,35 @@ import {
import '@shumai/db/src/prisma-json-types'
import { s3Service } from '@shumai/core/src/s3/s3'
import { getAvatarUrl } from '@shumai/core/src/user/avatar'
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
import { getAllowedAgentRoles } from './permissions'
import AdmZip from 'adm-zip'
import * as fs from 'fs'
import * as path from 'path'
const agentInclude = {
user: true,
provider: true,
modelRef: true,
skills: { include: { skill: true } },
mcpServers: true,
} satisfies Prisma.AgentInclude
/** Structural shape consumed by `toAgentInfo` (works with any standard include). */
interface AgentInfoSource {
id: string
type: AgentType
enabled: boolean
permission: TeamMemberRole
providerId: string | null
modelId: string | null
config: unknown
soul: string | null
user: { name: string; image: string | null }
skills: Array<{ id: string; skillId: string; skill: { id: string; name: string } }>
mcpServers: Array<{ mcpServerId: string }>
}
function extractS3Key(urlOrKey?: string | null): string | null | undefined {
if (!urlOrKey) return urlOrKey
const match = urlOrKey.match(/files\/[A-Z0-9]{26}/)
@@ -114,6 +141,7 @@ export class AgentService {
name,
type,
enabled,
permission,
avatar,
providerId,
modelId,
@@ -179,6 +207,7 @@ export class AgentService {
teamId,
type,
enabled: enabled ?? true,
permission: permission || 'reviewer',
providerId: providerId || null,
modelId: modelId || null,
soul,
@@ -224,6 +253,7 @@ export class AgentService {
name,
type,
enabled,
permission,
avatar,
providerId,
modelId,
@@ -300,6 +330,7 @@ export class AgentService {
data: {
type,
enabled: enabled ?? true,
...(permission ? { permission } : {}),
providerId: providerId || null,
modelId: modelId || null,
soul,
@@ -327,6 +358,29 @@ export class AgentService {
})
}
async updateAgentPermission(agentId: string, permission: 'owner' | 'editor' | 'reviewer') {
const existing = await this.prismaClient.agent.findUnique({
where: { id: agentId },
})
if (!existing) throw new Error('agent not found')
return this.prismaClient.agent.update({
where: { id: agentId },
data: { permission },
include: {
user: true,
provider: true,
modelRef: true,
skills: {
include: {
skill: true,
},
},
mcpServers: true,
},
})
}
async getAgent(params: { agentId: string }) {
return this.prismaClient.agent.findUnique({
where: { id: params.agentId },
@@ -348,10 +402,96 @@ export class AgentService {
})
}
/**
* Map an agent (with the standard relations include) to the AgentInfo DTO.
* Shared by the team-level agent list and the project-scoped chat-agent list.
*/
async toAgentInfo(agent: AgentInfoSource): Promise<AgentInfo> {
const config = agent.config as unknown as PrismaJson.AgentConfig
return {
id: agent.id,
name: agent.user.name,
type: agent.type as AgentType,
enabled: agent.enabled,
permission: agent.permission,
avatar: (await getAvatarUrl(agent.user.image)) || undefined,
providerId: agent.providerId || undefined,
modelId: agent.modelId || undefined,
thinkingLevel: config.thinkingLevel || 'off',
systemPrompt: config.systemPrompt,
soul: agent.soul || undefined,
skills: agent.skills.map((s) => ({
id: s.id,
skillId: s.skillId,
skill: s.skill,
})),
mcpServerIds: (agent.mcpServers || []).map((m) => m.mcpServerId),
deniedTools: config.deniedTools || [],
}
}
/**
* List the chat agents available to a user inside a specific project,
* resolved against the user's effective project role (project override wins;
* restricted users get an empty list). Used by the one-to-one chat selector.
*/
async listProjectChatAgents(projectId: string, userId: string): Promise<AgentInfo[]> {
const project = await this.prismaClient.project.findUnique({
where: { id: projectId },
select: { teamId: true },
})
if (!project) return []
const effectiveRole = await resolveEffectiveRole(project.teamId, projectId, userId)
if (!effectiveRole) return []
const allowedRoles = getAllowedAgentRoles(effectiveRole)
const agents = await this.prismaClient.agent.findMany({
where: {
teamId: project.teamId,
type: 'chat',
enabled: true,
permission: { in: allowedRoles },
},
orderBy: { id: 'desc' },
include: agentInclude,
})
return Promise.all(agents.map((agent) => this.toAgentInfo(agent)))
}
async listAgents(params: ListAgentsParams) {
const allowedRoles = params.userId
? getAllowedAgentRoles(
(
await this.prismaClient.teamMember.findUnique({
where: {
teamIdUserId: {
teamId: params.teamId,
userId: params.userId,
},
},
select: { role: true },
})
)?.role,
)
: null
return this.prismaClient.agent.findMany({
where: {
teamId: params.teamId,
...(allowedRoles
? {
OR: [
{ type: { not: 'chat' } },
{
type: 'chat',
permission: { in: allowedRoles },
},
],
}
: {}),
},
orderBy: {
id: 'desc',
@@ -0,0 +1,43 @@
import { describe, it, expect } from 'vitest'
import { getRoleLevel, getAgentRequiredLevel, getAllowedAgentRoles } from './permissions'
describe('agent permission helpers', () => {
describe('getRoleLevel', () => {
it('maps each role to its level', () => {
expect(getRoleLevel('reviewer')).toBe(1)
expect(getRoleLevel('editor')).toBe(2)
expect(getRoleLevel('owner')).toBe(3)
})
it('resolves missing roles to 0 (fail closed)', () => {
expect(getRoleLevel(null)).toBe(0)
expect(getRoleLevel(undefined)).toBe(0)
})
})
describe('getAgentRequiredLevel', () => {
it('maps each permission to its required level', () => {
expect(getAgentRequiredLevel('reviewer')).toBe(1)
expect(getAgentRequiredLevel('editor')).toBe(2)
expect(getAgentRequiredLevel('owner')).toBe(3)
})
it('defaults missing permissions to reviewer level (1)', () => {
expect(getAgentRequiredLevel(null)).toBe(1)
expect(getAgentRequiredLevel(undefined)).toBe(1)
})
})
describe('getAllowedAgentRoles', () => {
it('returns inclusive role sets per hierarchy', () => {
expect(getAllowedAgentRoles('owner')).toEqual(['reviewer', 'editor', 'owner'])
expect(getAllowedAgentRoles('editor')).toEqual(['reviewer', 'editor'])
expect(getAllowedAgentRoles('reviewer')).toEqual(['reviewer'])
})
it('defaults missing roles to reviewer only', () => {
expect(getAllowedAgentRoles(null)).toEqual(['reviewer'])
expect(getAllowedAgentRoles(undefined)).toEqual(['reviewer'])
})
})
})
+44
View File
@@ -0,0 +1,44 @@
import type { TeamMemberRole } from '@shumai/db'
/**
* Numeric levels for the team role hierarchy used by agent permissions.
* The record is typed exhaustively over `TeamMemberRole`, so adding a new
* role to the enum will fail compilation until it is handled here.
*/
const ROLE_LEVELS: Record<TeamMemberRole, number> = {
reviewer: 1,
editor: 2,
owner: 3,
}
/**
* Numeric level of a team role for agent-permission comparisons.
* Unknown or missing roles resolve to 0, which is below every agent
* permission, so lookups fail closed.
*/
export function getRoleLevel(role: TeamMemberRole | null | undefined): number {
if (!role) return 0
return ROLE_LEVELS[role] ?? 0
}
/**
* Minimum role level required to use an agent with the given permission.
* Unknown or missing permissions resolve to 1 (reviewer), the most
* permissive default.
*/
export function getAgentRequiredLevel(permission: TeamMemberRole | null | undefined): number {
if (!permission) return 1
return ROLE_LEVELS[permission] ?? 1
}
/**
* Roles allowed to use agents, following the inclusive role hierarchy:
* owner sees owner+editor+reviewer agents, editor sees editor+reviewer,
* reviewer (or any unknown/missing role) sees reviewer agents only.
*/
export function getAllowedAgentRoles(role: TeamMemberRole | null | undefined): TeamMemberRole[] {
const level = getRoleLevel(role)
if (level >= 3) return ['reviewer', 'editor', 'owner']
if (level === 2) return ['reviewer', 'editor']
return ['reviewer']
}
+765 -19
View File
@@ -41,6 +41,13 @@ describe('AssetService', () => {
const team = await prisma.team.create({
data: { name: 'TestTeam_Asset_' + Date.now() },
})
await prisma.teamMember.create({
data: {
teamId: team.id,
userId: user.id,
role: 'owner',
},
})
const project = await prisma.project.create({
data: { name: 'TestProject_Asset', teamId: team.id },
})
@@ -734,15 +741,6 @@ describe('AssetService', () => {
attachmentIds: [],
})
// 2. Add user as a team member with owner role (team owner)
await prisma.teamMember.create({
data: {
teamId: project.teamId,
userId: user.id,
role: 'owner',
},
})
// Create another user
const otherUser = await prisma.user.create({
data: {
@@ -813,16 +811,7 @@ describe('AssetService', () => {
it('deleteComment cleans up S3 attachment files and database records', async () => {
const { user, project, assets } = await setupBasicAssets()
// 1. Add user as team owner
await prisma.teamMember.create({
data: {
teamId: project.teamId,
userId: user.id,
role: 'owner',
},
})
// 2. Create StorageKey and Asset for attachment
// 1. Create StorageKey and Asset for attachment
const storageKey = await prisma.storageKey.create({
data: {
key: 'attachments/test-attachment-file.png',
@@ -1245,6 +1234,152 @@ describe('AssetService', () => {
expect(p3b?.agent?.userId).toBe(user.id)
})
it('silently skips triggering agent workflow when comment creator lacks permission', async () => {
const { project } = await setupBasicAssets()
const file = await prisma.asset.create({
data: {
name: 'perm-file',
type: AssetType.file,
projectId: project.id,
status: 'uploaded',
},
})
// Create owner-only bot agent
const ownerBotUser = await prisma.user.create({
data: {
name: 'Owner Bot Agent',
type: 'agent',
email: `owner-bot-${Date.now()}@shumai.ai`,
},
})
const ownerAgent = await prisma.agent.create({
data: {
id: ownerBotUser.id,
teamId: project.teamId,
type: 'chat',
permission: 'owner',
config: { provider: 'p', model: 'm' },
},
})
// Create a reviewer user
const reviewerUser = await prisma.user.create({
data: {
name: 'Reviewer Member',
email: `rev-comment-${Date.now()}@shumai.ai`,
password: 'pw',
},
})
await prisma.teamMember.create({
data: { teamId: project.teamId, userId: reviewerUser.id, role: 'reviewer' },
})
// Reviewer mentions owner-only agent
const comment = await assetService.createComment({
assetId: file.id,
userId: reviewerUser.id,
message: `Hello <@${ownerAgent.id}>`,
attachmentIds: [],
})
// Comment was saved successfully
expect(comment.id).toBeDefined()
// But no workflow task was created for ownerAgent
const tasks = await prisma.workflowTask.findMany({
where: {
assetId: file.id,
payload: { path: ['agent', 'userCommentId'], equals: comment.id },
},
})
expect(tasks.length).toBe(0)
})
it('uses the effective project role for bot mention permission checks', async () => {
const { project } = await setupBasicAssets()
const file = await prisma.asset.create({
data: {
name: 'perm-file-2',
type: AssetType.file,
projectId: project.id,
status: 'uploaded',
},
})
// Editor-permission chat agent
const editorBotUser = await prisma.user.create({
data: {
name: 'Editor Bot Agent',
type: 'agent',
email: `editor-bot-${Date.now()}@shumai.ai`,
},
})
const editorAgent = await prisma.agent.create({
data: {
id: editorBotUser.id,
teamId: project.teamId,
type: 'chat',
permission: 'editor',
config: { provider: 'p', model: 'm' },
},
})
// Team editor, demoted to project reviewer in this project
const demoted = await prisma.user.create({
data: { name: 'Demoted Member', email: `dem-${Date.now()}@shumai.ai`, password: 'pw' },
})
const demotedTm = await prisma.teamMember.create({
data: { teamId: project.teamId, userId: demoted.id, role: 'editor', scope: 'team' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: demotedTm.id, role: 'reviewer' },
})
// Project-scoped member invited as editor
const projEditor = await prisma.user.create({
data: { name: 'Proj Editor', email: `pe-${Date.now()}@shumai.ai`, password: 'pw' },
})
const projEditorTm = await prisma.teamMember.create({
data: { teamId: project.teamId, userId: projEditor.id, role: 'reviewer', scope: 'project' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: projEditorTm.id, role: 'editor' },
})
// Demoted team editor (project reviewer) mentioning the editor agent: no workflow
const demotedComment = await assetService.createComment({
assetId: file.id,
userId: demoted.id,
message: `Hello <@${editorAgent.id}>`,
attachmentIds: [],
})
const demotedTasks = await prisma.workflowTask.findMany({
where: {
assetId: file.id,
payload: { path: ['agent', 'userCommentId'], equals: demotedComment.id },
},
})
expect(demotedTasks.length).toBe(0)
// Project-scoped editor mentioning the editor agent: workflow created
const peComment = await assetService.createComment({
assetId: file.id,
userId: projEditor.id,
message: `Hello <@${editorAgent.id}>`,
attachmentIds: [],
})
const peTasks = await prisma.workflowTask.findMany({
where: {
assetId: file.id,
payload: { path: ['agent', 'userCommentId'], equals: peComment.id },
},
})
expect(peTasks.length).toBe(1)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((peTasks[0].payload as any)?.agent?.userId).toBe(projEditor.id)
})
it('updates asset order correctly', async () => {
const { user, project } = await setupBasicAssets()
@@ -2830,4 +2965,615 @@ describe('AssetService — natural sort by name', () => {
)
})
})
describe('AGENTS.md methods', () => {
it('getAgentsMd returns null when no agentmd is set', async () => {
const team = await prisma.team.create({
data: { name: 'Team_AgentsMd_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_AgentsMd', teamId: team.id },
})
const folder = await prisma.asset.create({
data: {
name: 'Folder_No_Md',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const content = await assetService.getAgentsMd(folder.id)
expect(content).toBeNull()
})
it('updateAgentsMd updates and getAgentsMd retrieves agentmd, and empty deletes', async () => {
const team = await prisma.team.create({
data: { name: 'Team_AgentsMd2_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_AgentsMd2', teamId: team.id },
})
const folder = await prisma.asset.create({
data: {
name: 'Folder_With_Md',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const updateResult = await assetService.updateAgentsMd(folder.id, '# Custom Guidelines')
expect(updateResult).toEqual({ content: '# Custom Guidelines' })
const content = await assetService.getAgentsMd(folder.id)
expect(content).toBe('# Custom Guidelines')
let folderInfo = await assetService.getAsset({ assetId: folder.id })
expect(folderInfo?.hasAgentsMd).toBe(true)
// Empty string deletes the record
const clearResult = await assetService.updateAgentsMd(folder.id, ' ')
expect(clearResult).toEqual({ content: '' })
const emptyContent = await assetService.getAgentsMd(folder.id)
expect(emptyContent).toBeNull()
folderInfo = await assetService.getAsset({ assetId: folder.id })
expect(folderInfo?.hasAgentsMd).toBe(false)
})
it('getNestedAgentsMd traverses hierarchy from root to leaf and formats virtual paths', async () => {
const team = await prisma.team.create({
data: { name: 'Team_NestedMd_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_NestedMd', teamId: team.id },
})
// 1. Root folder
const rootFolder = await prisma.asset.create({
data: {
name: 'Root Folder',
type: AssetType.root,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await prisma.assetAgentMd.create({
data: {
assetId: rootFolder.id,
content: '# Root Instructions\nFollow global rules.',
},
})
// 2. Subfolder 1: marketing (has agentmd)
const marketingFolder = await prisma.asset.create({
data: {
name: 'marketing',
type: AssetType.folder,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await prisma.assetAgentMd.create({
data: {
assetId: marketingFolder.id,
content: '# Marketing Instructions\nTone must be upbeat.',
},
})
// 3. Subfolder 2: campaigns (no agentmd)
const campaignsFolder = await prisma.asset.create({
data: {
name: 'campaigns',
type: AssetType.folder,
parentId: marketingFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
// 4. Subfolder 3: video-ads (has agentmd)
const videoAdsFolder = await prisma.asset.create({
data: {
name: 'video-ads',
type: AssetType.folder,
parentId: campaignsFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await prisma.assetAgentMd.create({
data: {
assetId: videoAdsFolder.id,
content: '# Video Ads Instructions\nInclude resolution tags.',
},
})
// 5. File inside video-ads
const fileAsset = await prisma.asset.create({
data: {
name: 'ad_clip.mp4',
type: AssetType.file,
parentId: videoAdsFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const nestedFromLeaf = await assetService.getNestedAgentsMd(fileAsset.id)
expect(nestedFromLeaf).toEqual([
{
path: '/AGENTS.md',
content: '# Root Instructions\nFollow global rules.',
},
{
path: '/marketing/AGENTS.md',
content: '# Marketing Instructions\nTone must be upbeat.',
},
{
path: '/marketing/campaigns/video-ads/AGENTS.md',
content: '# Video Ads Instructions\nInclude resolution tags.',
},
])
const nestedFromMarketing = await assetService.getNestedAgentsMd(marketingFolder.id)
expect(nestedFromMarketing).toEqual([
{
path: '/AGENTS.md',
content: '# Root Instructions\nFollow global rules.',
},
{
path: '/marketing/AGENTS.md',
content: '# Marketing Instructions\nTone must be upbeat.',
},
])
})
it('rejects get/update agentsmd on non-folder assets', async () => {
const team = await prisma.team.create({
data: { name: 'Team_AgentsMd_Type_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_AgentsMd_Type', teamId: team.id },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.root,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const fileAsset = await prisma.asset.create({
data: {
name: 'doc.pdf',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await expect(assetService.getAgentsMd(fileAsset.id)).rejects.toThrow(
'AGENTS.md can only be stored on folders',
)
await expect(assetService.updateAgentsMd(fileAsset.id, '# Nope')).rejects.toThrow(
'AGENTS.md can only be stored on folders',
)
})
})
describe('reparentAssets into version_stack with sharelink symlinks', () => {
it('deduplicates symlinks when both Stack A and File B are in the sharelink and File B is moved into Stack A', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const user = await prisma.user.create({
data: { name: 'Test User', email: `test-${Date.now()}@example.com` },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const shareRoot = await prisma.asset.create({
data: {
name: 'ShareRoot',
type: AssetType.share_root,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 2,
},
})
const fileA1 = await prisma.asset.create({
data: {
name: 'fileA1.txt',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 100,
sortIndex: 'a0',
},
})
const fileA2 = await prisma.asset.create({
data: {
name: 'fileA2.txt',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 100,
sortIndex: 'a1',
},
})
const fileB = await prisma.asset.create({
data: {
name: 'fileB.txt',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 200,
sortIndex: 'a2',
},
})
// Create Stack A from fileA1 and fileA2
const stackA = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 2,
sizeByte: 200,
},
})
await prisma.asset.update({ where: { id: fileA1.id }, data: { parentId: stackA.id } })
await prisma.asset.update({ where: { id: fileA2.id }, data: { parentId: stackA.id } })
// Create symlinks in shareRoot for both Stack A and File B
const symlinkStackA = await prisma.asset.create({
data: {
name: '',
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: stackA.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const symlinkFileB = await prisma.asset.create({
data: {
name: fileB.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileB.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
// Move File B into Stack A
await assetService.reparentAssets({
newParentId: stackA.id,
assetIds: [fileB.id],
creatorId: user.id,
})
// Verify: File B's symlink was deleted, only Stack A's symlink remains
expect(await prisma.asset.findUnique({ where: { id: symlinkFileB.id } })).toBeNull()
const remainingSymlinks = await prisma.asset.findMany({
where: { parentId: shareRoot.id, type: AssetType.symlink },
})
expect(remainingSymlinks).toHaveLength(1)
expect(remainingSymlinks[0].id).toBe(symlinkStackA.id)
expect(remainingSymlinks[0].targetId).toBe(stackA.id)
// ShareRoot fileCount was decremented from 2 to 1
const updatedShareRoot = await prisma.asset.findUnique({ where: { id: shareRoot.id } })
expect(updatedShareRoot?.fileCount).toBe(1)
})
it('repoints symlink to Stack A when only File B is in sharelink and File B is moved into Stack A', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const user = await prisma.user.create({
data: { name: 'Test User', email: `test-${Date.now()}@example.com` },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const shareRoot = await prisma.asset.create({
data: {
name: 'ShareRoot',
type: AssetType.share_root,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 1,
},
})
const fileA1 = await prisma.asset.create({
data: {
name: 'fileA1.txt',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 100,
sortIndex: 'a0',
},
})
const stackA = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 1,
sizeByte: 100,
},
})
await prisma.asset.update({ where: { id: fileA1.id }, data: { parentId: stackA.id } })
const fileB = await prisma.asset.create({
data: {
name: 'fileB.txt',
type: AssetType.file,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 200,
sortIndex: 'a1',
},
})
// Create symlink for File B only
const symlinkFileB = await prisma.asset.create({
data: {
name: fileB.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileB.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
// Move File B into Stack A
await assetService.reparentAssets({
newParentId: stackA.id,
assetIds: [fileB.id],
creatorId: user.id,
})
// Verify: symlinkFileB now points to stackA.id
const updatedSymlink = await prisma.asset.findUnique({ where: { id: symlinkFileB.id } })
expect(updatedSymlink?.targetId).toBe(stackA.id)
// Listing assets for shareRoot returns Stack A with latest version name
const result = await assetService.listChildren({
assetId: shareRoot.id,
assetType: AssetType.file,
})
expect(result.data).toHaveLength(1)
expect(result.data[0].name).toBe(fileB.name) // fileB is the latest version
})
})
describe('updateAssetName', () => {
it('renames the latest version child file and returns updated AssetInfo when given a version stack ID', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 2,
sizeByte: 300,
},
})
const fileV1 = await prisma.asset.create({
data: {
name: 'v1.mp4',
type: AssetType.file,
parentId: stack.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 100,
sortIndex: 'b0',
},
})
const fileV2 = await prisma.asset.create({
data: {
name: 'v2.mp4',
type: AssetType.file,
parentId: stack.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 200,
sortIndex: 'a0', // latest version
},
})
const updated = await assetService.updateAssetName({
id: stack.id,
name: 'v2-renamed.mp4',
})
expect(updated.id).toBe(stack.id)
expect(updated.name).toBe('v2-renamed.mp4')
expect(updated.versionStack?.versions[0]?.name).toBe('v2-renamed.mp4')
const dbFileV2 = await prisma.asset.findUnique({ where: { id: fileV2.id } })
expect(dbFileV2?.name).toBe('v2-renamed.mp4')
const dbFileV1 = await prisma.asset.findUnique({ where: { id: fileV1.id } })
expect(dbFileV1?.name).toBe('v1.mp4')
const dbStack = await prisma.asset.findUnique({ where: { id: stack.id } })
expect(dbStack?.name).toBe('')
})
it('preserves the renamed filename when a version stack dissolves', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const rootFolder = await prisma.asset.create({
data: {
name: 'Root',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: rootFolder.id,
projectId: project.id,
status: AssetStatus.uploaded,
fileCount: 2,
sizeByte: 300,
sortIndex: 's0',
},
})
const fileV1 = await prisma.asset.create({
data: {
name: 'v1.mp4',
type: AssetType.file,
parentId: stack.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 100,
sortIndex: 'b0',
},
})
const fileV2 = await prisma.asset.create({
data: {
name: 'v2.mp4',
type: AssetType.file,
parentId: stack.id,
projectId: project.id,
status: AssetStatus.uploaded,
sizeByte: 200,
sortIndex: 'a0',
},
})
await assetService.updateAssetName({
id: stack.id,
name: 'v2-renamed.mp4',
})
// Remove v1 from stack -> stack dissolves and v2 becomes standalone file
const { versionStackService } = await import('../versionStack/versionStack')
await versionStackService.removeVersionFromStack({
stackId: stack.id,
fileId: fileV1.id,
})
const remainingFile = await prisma.asset.findUnique({ where: { id: fileV2.id } })
expect(remainingFile?.parentId).toBe(rootFolder.id)
expect(remainingFile?.name).toBe('v2-renamed.mp4')
})
it('throws an error if version stack has no active versions to rename', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const emptyStack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
await expect(
assetService.updateAssetName({
id: emptyStack.id,
name: 'new-name.mp4',
}),
).rejects.toThrow('No active version found in stack to rename')
})
it('renames a regular file and folder correctly', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const folder = await prisma.asset.create({
data: {
name: 'Original Folder',
type: AssetType.folder,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const file = await prisma.asset.create({
data: {
name: 'original.png',
type: AssetType.file,
parentId: folder.id,
projectId: project.id,
status: AssetStatus.uploaded,
},
})
const updatedFolder = await assetService.updateAssetName({
id: folder.id,
name: 'Renamed Folder',
})
expect(updatedFolder.name).toBe('Renamed Folder')
const updatedFile = await assetService.updateAssetName({
id: file.id,
name: 'renamed.png',
})
expect(updatedFile.name).toBe('renamed.png')
})
})
})
+218 -22
View File
@@ -22,9 +22,12 @@ import { HTTPException } from 'hono/http-exception'
import { logger } from '@shumai/core/src/logger'
import { PaginatedData, paginateQuery, PaginationParams } from '@shumai/core/src/pagination'
import { s3Service } from '@shumai/core/src/s3/s3'
import { dedupeSymlinksToTarget } from './symlink'
import { watermarkService } from '@shumai/core/src/watermark/watermark'
import { generateKeyBetween } from 'jittered-fractional-indexing'
import { getAvatarUrl } from '@shumai/core/src/user/avatar'
import { getAgentRequiredLevel, getRoleLevel } from '@shumai/core/src/agent/permissions'
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
type AssetWithIncludes = Prisma.AssetGetPayload<{
include: {
@@ -160,6 +163,9 @@ export class AssetService {
const count = await tx.asset.count({ where: { parentId: stack.id } })
if (count === 0) {
await tx.asset.deleteMany({
where: { targetId: stack.id, type: AssetType.symlink },
})
if (stack.parentId) {
await tx.asset.update({
where: { id: stack.parentId },
@@ -174,9 +180,14 @@ export class AssetService {
if (!lastChild) return
if (!stack.parentId) throw new Error('Stack has no parent')
await tx.asset.updateMany({
where: { targetId: stack.id, type: AssetType.symlink },
data: { targetId: lastChild.id, name: lastChild.name },
})
await tx.asset.update({
where: { id: lastChild.id },
data: { parentId: stack.parentId, sortIndex: null },
data: { parentId: stack.parentId, sortIndex: stack.sortIndex },
})
await tx.asset.delete({ where: { id: stack.id } })
}
@@ -273,6 +284,14 @@ export class AssetService {
firstSortIndex = newSortIndex
}
if (newParent.type === AssetType.version_stack) {
await dedupeSymlinksToTarget(tx, {
targetIds: req.assetIds,
newTargetId: newParent.id,
name: '',
})
}
const oldParent = await tx.asset.findUnique({
where: { id: oldParentId },
})
@@ -579,6 +598,12 @@ export class AssetService {
},
})
// Update existing symlinks pointing to destFile or sourceAsset
await dedupeSymlinksToTarget(tx, {
targetIds: [destFile.id, sourceAsset.id],
newTargetId: stack.id,
})
const oldParent = await tx.asset.findUnique({ where: { id: oldParentId } })
if (oldParent) {
await this.dissolveStackIfEmpty(tx, oldParent)
@@ -932,9 +957,42 @@ export class AssetService {
}
async updateAssetName(req: UpdateAssetNameRequest): Promise<AssetInfo> {
const asset = await this.prismaClient.asset.update({
const existing = await this.prismaClient.asset.findUnique({
where: { id: req.id },
include: { target: true },
})
if (!existing) throw new Error('Asset not found')
let targetType = existing.type
let targetId = existing.id
if (existing.type === AssetType.symlink && existing.target) {
targetType = existing.target.type
targetId = existing.target.id
}
if (targetType === AssetType.version_stack) {
const latestChild = await this.prismaClient.asset.findFirst({
where: { parentId: targetId, isDeleted: false },
orderBy: { sortIndex: 'asc' },
select: { id: true },
})
if (!latestChild) {
throw new Error('No active version found in stack to rename')
}
await this.prismaClient.asset.update({
where: { id: latestChild.id },
data: { name: req.name },
})
} else {
await this.prismaClient.asset.update({
where: { id: req.id },
data: { name: req.name },
})
}
const asset = await this.prismaClient.asset.findUnique({
where: { id: req.id },
data: { name: req.name },
include: {
creator: true,
metadataValues: true,
@@ -960,6 +1018,8 @@ export class AssetService {
storageKey: true,
},
})
if (!asset) throw new Error('Asset not found')
const infos = await this.toAssetInfos([asset as unknown as AssetWithIncludes])
return infos[0]
}
@@ -1319,30 +1379,43 @@ export class AssetService {
const mentionedAgentIds = new Set(botMentionMatches.map((match) => match[1]))
const handledAgentIds = new Set<string>()
// Effective role for the project context (project override wins; project-
// scoped members without project access resolve to null and are denied).
const effectiveRole = a.project?.team
? await resolveEffectiveRole(a.project.team.id, a.project.id, req.userId, tx)
: null
const userLevel = getRoleLevel(effectiveRole)
if (parentComment && a.project) {
const rootSessionId = parentComment.sessionId
const isRootAgent = !!rootSessionId || parentComment.creator?.type === 'agent'
const rootAgentId = parentComment.creatorId
if (isRootAgent && rootAgentId && mentionedAgentIds.has(rootAgentId)) {
await tx.workflowTask.create({
data: {
assetId: a.id,
type: 'chat',
status: 'pending',
teamId: a.project.team.id,
projectId: a.project.id,
payload: {
const rootAgent = await tx.agent.findUnique({ where: { id: rootAgentId } })
const requiredLevel = getAgentRequiredLevel(rootAgent?.permission)
if (userLevel >= requiredLevel) {
await tx.workflowTask.create({
data: {
assetId: a.id,
type: 'chat',
status: 'pending',
teamId: a.project.team.id,
projectId: a.project.id,
agent: {
userCommentId: comment.id,
agentId: rootAgentId,
sessionId: rootSessionId || undefined,
userId: req.userId,
payload: {
projectId: a.project.id,
agent: {
userCommentId: comment.id,
agentId: rootAgentId,
sessionId: rootSessionId || undefined,
userId: req.userId,
},
},
},
},
})
})
}
handledAgentIds.add(rootAgentId)
}
}
@@ -1356,7 +1429,12 @@ export class AssetService {
foundAgent = true
} else {
const agent = await tx.agent.findUnique({ where: { id: agentId } })
if (agent) foundAgent = true
if (agent) {
const requiredLevel = getAgentRequiredLevel(agent.permission)
if (userLevel >= requiredLevel) {
foundAgent = true
}
}
}
if (foundAgent && a.project) {
@@ -1592,6 +1670,15 @@ export class AssetService {
}
}
const agentMdRecords =
assets.length > 0
? await this.prismaClient.assetAgentMd.findMany({
where: { assetId: { in: assets.map((a) => a.id) } },
select: { assetId: true },
})
: []
const hasAgentMdSet = new Set(agentMdRecords.map((r) => r.assetId))
const result: AssetInfo[] = []
for (const a of assets) {
let latestVersion:
@@ -1620,6 +1707,7 @@ export class AssetService {
id: v.id,
name: v.name,
previewUrl: preview?.thumbnailUrl || null,
createdAt: v.createdAt.toISOString(),
creator: v.creator
? {
id: v.creator.id,
@@ -1735,9 +1823,12 @@ export class AssetService {
result.push({
id: a.id,
name:
a.type === AssetType.version_stack && (a.name === '' || !a.name)
a.type === AssetType.version_stack ||
(a.type === AssetType.symlink && a.target?.type === AssetType.version_stack)
? latestVersion.name
: a.name,
: a.type === AssetType.symlink
? a.name || latestVersion.name || a.target?.name || ''
: a.name,
sizeByte: Number(latestVersion.sizeByte),
fileCount: latestVersion.fileCount,
type: a.type,
@@ -1753,6 +1844,7 @@ export class AssetService {
creator,
fieldValues,
sortIndex: a.sortIndex,
hasAgentsMd: hasAgentMdSet.has(a.id),
media: media as unknown as AssetInfo['media'],
versionStack,
})
@@ -1766,7 +1858,8 @@ export class AssetService {
version: number
name: string
previewUrl: string | null
creator: { id: string; name: string | null } | null
createdAt: string
creator: { id: string; name: string | null; image?: string | null } | null
}>
> {
const versions = await this.prismaClient.asset.findMany({
@@ -1787,6 +1880,7 @@ export class AssetService {
version: versions.length - i,
name: v.name,
previewUrl: preview?.thumbnailUrl || null,
createdAt: v.createdAt.toISOString(),
creator: v.creator
? {
id: v.creator.id,
@@ -2164,6 +2258,108 @@ export class AssetService {
completionLastChangedBy,
}
}
async getAgentsMd(assetId: string): Promise<string | null> {
const asset = await this.prismaClient.asset.findUnique({
where: { id: assetId },
select: { type: true },
})
if (!asset) throw new Error('Asset not found')
if (asset.type !== AssetType.folder && asset.type !== AssetType.root) {
throw new Error('AGENTS.md can only be stored on folders')
}
const record = await this.prismaClient.assetAgentMd.findUnique({
where: { assetId },
select: { content: true },
})
return record?.content ?? null
}
async updateAgentsMd(assetId: string, content: string): Promise<{ content: string }> {
const asset = await this.prismaClient.asset.findUnique({
where: { id: assetId },
select: { id: true, type: true },
})
if (!asset) throw new Error('Asset not found')
if (asset.type !== AssetType.folder && asset.type !== AssetType.root) {
throw new Error('AGENTS.md can only be stored on folders')
}
const trimmed = content.trim()
if (trimmed.length === 0) {
await this.prismaClient.assetAgentMd.deleteMany({
where: { assetId },
})
return { content: '' }
}
const record = await this.prismaClient.assetAgentMd.upsert({
where: { assetId },
create: { assetId, content },
update: { content },
select: { content: true },
})
return { content: record.content }
}
async getNestedAgentsMd(assetId: string): Promise<Array<{ path: string; content: string }>> {
let currentId: string | null = assetId
const nodes: Array<{
id: string
name: string
type: AssetType
parentId: string | null
}> = []
while (currentId) {
const node: {
id: string
name: string
type: AssetType
parentId: string | null
} | null = await this.prismaClient.asset.findUnique({
where: { id: currentId },
select: { id: true, name: true, type: true, parentId: true },
})
if (!node) break
nodes.unshift(node)
currentId = node.parentId
}
if (nodes.length === 0) return []
const agentMds = await this.prismaClient.assetAgentMd.findMany({
where: { assetId: { in: nodes.map((n) => n.id) } },
select: { assetId: true, content: true },
})
const agentMdMap = new Map(agentMds.map((m) => [m.assetId, m.content]))
const results: Array<{ path: string; content: string }> = []
let currentFolderPath = ''
for (let i = 0; i < nodes.length; i++) {
const node = nodes[i]
let virtualPath: string
if (node.type === AssetType.root || i === 0) {
currentFolderPath = ''
virtualPath = '/AGENTS.md'
} else {
currentFolderPath = currentFolderPath
? `${currentFolderPath}/${node.name}`
: `/${node.name}`
virtualPath = `${currentFolderPath}/AGENTS.md`
}
const content = agentMdMap.get(node.id)
if (content && content.trim().length > 0) {
results.push({
path: virtualPath,
content: content.trim(),
})
}
}
return results
}
}
export const assetService = new AssetService()
+249
View File
@@ -0,0 +1,249 @@
import { describe, it, expect } from 'vitest'
import { prisma } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import { AssetType } from '@shumai/db'
import { dedupeSymlinksToTarget } from './symlink'
async function setupShareFolder(projectId: string, fileCount: number) {
const shareRoot = await prisma.asset.create({
data: {
name: 'share-root',
type: AssetType.share_root,
projectId,
status: 'uploaded',
fileCount,
},
})
return shareRoot
}
describe('dedupeSymlinksToTarget', () => {
setupTestDbHooks()
async function setupProject() {
const team = await prisma.team.create({ data: { name: 'Team ' + Date.now() } })
const project = await prisma.project.create({
data: { name: 'Project ' + Date.now(), teamId: team.id },
})
const root = await prisma.asset.create({
data: {
name: 'root',
type: AssetType.folder,
projectId: project.id,
status: 'uploaded',
},
})
const fileA = await prisma.asset.create({
data: {
name: 'a.txt',
type: AssetType.file,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
sizeByte: 10,
},
})
const fileB = await prisma.asset.create({
data: {
name: 'b.txt',
type: AssetType.file,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
sizeByte: 20,
},
})
return { project, root, fileA, fileB }
}
it('repoints one symlink per parent and deletes duplicates, decrementing fileCount once', async () => {
const { project, root, fileA, fileB } = await setupProject()
const shareRoot = await setupShareFolder(project.id, 2)
const symA = await prisma.asset.create({
data: {
name: fileA.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileA.id,
projectId: project.id,
status: 'uploaded',
},
})
const symB = await prisma.asset.create({
data: {
name: fileB.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileB.id,
projectId: project.id,
status: 'uploaded',
},
})
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
fileCount: 2,
sizeByte: 30,
},
})
await prisma.$transaction((tx) =>
dedupeSymlinksToTarget(tx, { targetIds: [fileA.id, fileB.id], newTargetId: stack.id }),
)
// First symlink repointed to the stack, second deleted
const repointed = await prisma.asset.findUnique({ where: { id: symA.id } })
expect(repointed?.targetId).toBe(stack.id)
expect(await prisma.asset.findUnique({ where: { id: symB.id } })).toBeNull()
// fileCount decremented exactly once (2 -> 1)
const updatedShareRoot = await prisma.asset.findUnique({ where: { id: shareRoot.id } })
expect(updatedShareRoot?.fileCount).toBe(1)
})
it('deletes a file symlink when the parent already shows the stack', async () => {
const { project, root, fileA } = await setupProject()
const shareRoot = await setupShareFolder(project.id, 2)
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
fileCount: 1,
sizeByte: 10,
},
})
// Share already contains a symlink to the stack
const stackSymlink = await prisma.asset.create({
data: {
name: '',
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: stack.id,
projectId: project.id,
status: 'uploaded',
},
})
// And a symlink to the file being moved into the stack
const fileSymlink = await prisma.asset.create({
data: {
name: fileA.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileA.id,
projectId: project.id,
status: 'uploaded',
},
})
await prisma.$transaction((tx) =>
dedupeSymlinksToTarget(tx, { targetIds: [fileA.id], newTargetId: stack.id }),
)
// File symlink deleted, stack symlink untouched
expect(await prisma.asset.findUnique({ where: { id: fileSymlink.id } })).toBeNull()
const updatedStackSymlink = await prisma.asset.findUnique({ where: { id: stackSymlink.id } })
expect(updatedStackSymlink?.targetId).toBe(stack.id)
// fileCount decremented once (2 -> 1)
const updatedShareRoot = await prisma.asset.findUnique({ where: { id: shareRoot.id } })
expect(updatedShareRoot?.fileCount).toBe(1)
})
it('repoints symlinks in different share folders without changing fileCounts', async () => {
const { project, root, fileA, fileB } = await setupProject()
const share1 = await setupShareFolder(project.id, 1)
const share2 = await setupShareFolder(project.id, 1)
const sym1 = await prisma.asset.create({
data: {
name: fileA.name,
type: AssetType.symlink,
parentId: share1.id,
targetId: fileA.id,
projectId: project.id,
status: 'uploaded',
},
})
const sym2 = await prisma.asset.create({
data: {
name: fileB.name,
type: AssetType.symlink,
parentId: share2.id,
targetId: fileB.id,
projectId: project.id,
status: 'uploaded',
},
})
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
fileCount: 2,
sizeByte: 30,
},
})
await prisma.$transaction((tx) =>
dedupeSymlinksToTarget(tx, { targetIds: [fileA.id, fileB.id], newTargetId: stack.id }),
)
expect((await prisma.asset.findUnique({ where: { id: sym1.id } }))?.targetId).toBe(stack.id)
expect((await prisma.asset.findUnique({ where: { id: sym2.id } }))?.targetId).toBe(stack.id)
expect((await prisma.asset.findUnique({ where: { id: share1.id } }))?.fileCount).toBe(1)
expect((await prisma.asset.findUnique({ where: { id: share2.id } }))?.fileCount).toBe(1)
})
it('sets the provided name on repointed symlinks', async () => {
const { project, root, fileA } = await setupProject()
const shareRoot = await setupShareFolder(project.id, 1)
const sym = await prisma.asset.create({
data: {
name: fileA.name,
type: AssetType.symlink,
parentId: shareRoot.id,
targetId: fileA.id,
projectId: project.id,
status: 'uploaded',
},
})
const stack = await prisma.asset.create({
data: {
name: '',
type: AssetType.version_stack,
parentId: root.id,
projectId: project.id,
status: 'uploaded',
fileCount: 1,
sizeByte: 10,
},
})
await prisma.$transaction((tx) =>
dedupeSymlinksToTarget(tx, {
targetIds: [fileA.id],
newTargetId: stack.id,
name: '',
}),
)
const updatedSym = await prisma.asset.findUnique({ where: { id: sym.id } })
expect(updatedSym?.targetId).toBe(stack.id)
expect(updatedSym?.name).toBe('')
})
})
+59
View File
@@ -0,0 +1,59 @@
import { Prisma } from '@shumai/db'
import { AssetType } from '@shumai/db'
interface DedupeSymlinksParams {
/** Files being merged into a version stack — symlinks pointing at them are the candidates. */
targetIds: string[]
/** The version stack the files are moving into. */
newTargetId: string
/** Optional name to set on repointed symlinks ('' for stacks — display name comes from the latest version). */
name?: string
}
/**
* When files are merged into a version stack, symlinks in share folders that
* pointed at those files must either be repointed to the stack (one per parent)
* or deleted as duplicates. Per parent folder: if the parent already shows the
* stack (either before this call or after the first repoint), delete the
* incoming symlink and decrement the parent's fileCount; otherwise repoint the
* first symlink to the stack.
*/
export async function dedupeSymlinksToTarget(
tx: Prisma.TransactionClient,
{ targetIds, newTargetId, name }: DedupeSymlinksParams,
): Promise<void> {
const existingSymlinks = await tx.asset.findMany({
where: { targetId: { in: targetIds }, type: AssetType.symlink },
orderBy: { id: 'asc' },
})
if (existingSymlinks.length === 0) return
// Parents that already display the stack (or will after the first repoint).
const stackSymlinkParents = new Set(
(
await tx.asset.findMany({
where: { targetId: newTargetId, type: AssetType.symlink },
select: { parentId: true },
})
)
.map((s) => s.parentId)
.filter((id): id is string => !!id),
)
for (const symlink of existingSymlinks) {
if (!symlink.parentId) continue
if (stackSymlinkParents.has(symlink.parentId)) {
await tx.asset.delete({ where: { id: symlink.id } })
await tx.asset.update({
where: { id: symlink.parentId },
data: { fileCount: { decrement: 1 } },
})
} else {
stackSymlinkParents.add(symlink.parentId)
await tx.asset.update({
where: { id: symlink.id },
data: { targetId: newTargetId, ...(name !== undefined ? { name } : {}) },
})
}
}
}
+73 -30
View File
@@ -1,4 +1,4 @@
import { prisma } from '@shumai/db'
import { prisma, type TeamMemberRole } from '@shumai/db'
import type { Prisma } from '@shumai/db'
import { HTTPException } from 'hono/http-exception'
@@ -24,6 +24,7 @@ export enum ResourceType {
Invite = 'invite',
Comment = 'comment',
AgentSession = 'agentSession',
QuotaRule = 'quotaRule',
}
export interface AuthzRequest {
@@ -33,13 +34,70 @@ export interface AuthzRequest {
id: string
}
type RoleDb = typeof prisma | Prisma.TransactionClient
/**
* Resolve a user's effective role for a team/project context, mirroring the
* precedence rules enforced by `AuthzService.hasPermission`:
*
* 1. Project membership (`projectMember.role`) takes precedence inside a project.
* 2. Team-scoped members fall back to their team role when no project override exists.
* 3. Project-scoped members without a matching project record (or without a
* project context) are restricted (`null`).
*
* Returns `null` for non-members as well, so callers can fail closed.
*/
export async function resolveEffectiveRole(
teamId: string,
projectId: string | undefined,
userId: string,
db: RoleDb = prisma,
): Promise<TeamMemberRole | null> {
const member = await db.teamMember.findUnique({
where: {
teamIdUserId: {
teamId,
userId,
},
},
})
if (!member) return null
// Project membership takes precedence when operating inside a project.
if (projectId) {
const pm = await db.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId,
teamMemberId: member.id,
},
},
})
if (pm) return pm.role
}
// Team-scoped members fall back to their team role.
if (member.scope === 'team') return member.role
// Project-scoped members without a matching project record are restricted.
return null
}
export class AuthzService {
async hasPermission(req: AuthzRequest): Promise<void> {
if (!req.user) throw new HTTPException(401, { message: 'User is required' })
const { teamId, projectId } = await this.resolveContext(req.type, req.id)
// 1. Check Team Membership
// Resolve the user's effective role using the shared precedence rules
// (project override -> team role for team-scoped members -> restricted).
const role = await resolveEffectiveRole(teamId, projectId, req.user.id)
if (role) {
return this.checkRole(role, req.permission)
}
// No effective role: either not a team member, or a project-scoped member
// without access to the resolved project context.
const member = await prisma.teamMember.findUnique({
where: {
teamIdUserId: {
@@ -48,36 +106,12 @@ export class AuthzService {
},
},
})
if (!member) throw new HTTPException(403, { message: 'User is not a member of the team' })
// 2. Check Project Membership first if project context is available
if (projectId) {
const pm = await prisma.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId: projectId,
teamMemberId: member.id,
},
},
})
if (pm) {
return this.checkRole(pm.role, req.permission)
}
}
// 3. Fall back to Team scope checks
if (member.scope === 'team') {
return this.checkRole(member.role, req.permission)
}
// 4. Scope is Project, and no project-level record exists (or no project context was provided)
if (!projectId) {
// User has project scope but no project context provided (e.g. Team-level resource)
// If it's a team-level resource, project-scoped users can access Read (like ListProjects).
if (req.permission === Permission.Read) {
return
}
// Project-scoped member on a team-level resource (no project context):
// allow Read (e.g. listing), deny Edit/Admin.
if (!projectId && req.permission === Permission.Read) {
return
}
throw new HTTPException(403, { message: 'User has only project scope' })
}
@@ -226,6 +260,15 @@ export class AuthzService {
return { teamId: comment.asset.project.teamId, projectId: comment.asset.projectId! }
}
case ResourceType.QuotaRule: {
const rule = await prisma.quotaRule.findUnique({
where: { id },
select: { teamId: true },
})
if (!rule) throw new HTTPException(404, { message: 'Quota rule not found' })
return { teamId: rule.teamId }
}
default:
throw new HTTPException(403, { message: `Unsupported resource type: ${type}` })
}
@@ -0,0 +1,93 @@
import { setupTestDbHooks } from '@shumai/db/test'
import { describe, expect, it } from 'vitest'
import { prisma } from '@shumai/db'
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
describe('resolveEffectiveRole', () => {
setupTestDbHooks()
async function setupData() {
const team = await prisma.team.create({ data: { name: 'Role Team' } })
const projectA = await prisma.project.create({
data: { name: 'Project A', teamId: team.id },
})
const projectB = await prisma.project.create({
data: { name: 'Project B', teamId: team.id },
})
// Team-scoped owner
const owner = await prisma.user.create({ data: { name: 'Owner', email: 'o@x.com' } })
await prisma.teamMember.create({
data: { teamId: team.id, userId: owner.id, role: 'owner', scope: 'team' },
})
// Team-scoped reviewer, promoted to project owner in Project A
const promoted = await prisma.user.create({ data: { name: 'Promoted', email: 'p@x.com' } })
const promotedTm = await prisma.teamMember.create({
data: { teamId: team.id, userId: promoted.id, role: 'reviewer', scope: 'team' },
})
await prisma.projectMember.create({
data: { projectId: projectA.id, teamMemberId: promotedTm.id, role: 'owner' },
})
// Team-scoped editor, demoted to project reviewer in Project A
const demoted = await prisma.user.create({ data: { name: 'Demoted', email: 'd@x.com' } })
const demotedTm = await prisma.teamMember.create({
data: { teamId: team.id, userId: demoted.id, role: 'editor', scope: 'team' },
})
await prisma.projectMember.create({
data: { projectId: projectA.id, teamMemberId: demotedTm.id, role: 'reviewer' },
})
// Project-scoped member (invited to Project A only, as editor)
const guest = await prisma.user.create({ data: { name: 'Guest', email: 'g@x.com' } })
const guestTm = await prisma.teamMember.create({
data: { teamId: team.id, userId: guest.id, role: 'reviewer', scope: 'project' },
})
await prisma.projectMember.create({
data: { projectId: projectA.id, teamMemberId: guestTm.id, role: 'editor' },
})
// Non-member
const outsider = await prisma.user.create({ data: { name: 'Outsider', email: 'x@x.com' } })
return { team, projectA, projectB, owner, promoted, demoted, guest, outsider }
}
it('returns the team role for team-scoped members without a project override', async () => {
const { team, projectA, owner } = await setupData()
await expect(resolveEffectiveRole(team.id, projectA.id, owner.id)).resolves.toBe('owner')
await expect(resolveEffectiveRole(team.id, undefined, owner.id)).resolves.toBe('owner')
})
it('prefers the project override over the team role', async () => {
const { team, projectA, projectB, promoted, demoted } = await setupData()
// Promoted: team reviewer -> project owner
await expect(resolveEffectiveRole(team.id, projectA.id, promoted.id)).resolves.toBe('owner')
// Outside the overridden project, the team role applies
await expect(resolveEffectiveRole(team.id, projectB.id, promoted.id)).resolves.toBe('reviewer')
// Demoted: team editor -> project reviewer
await expect(resolveEffectiveRole(team.id, projectA.id, demoted.id)).resolves.toBe('reviewer')
await expect(resolveEffectiveRole(team.id, projectB.id, demoted.id)).resolves.toBe('editor')
})
it('resolves the project role for project-scoped members inside their project', async () => {
const { team, projectA, guest } = await setupData()
await expect(resolveEffectiveRole(team.id, projectA.id, guest.id)).resolves.toBe('editor')
})
it('restricts project-scoped members without a matching project record', async () => {
const { team, projectB, guest } = await setupData()
await expect(resolveEffectiveRole(team.id, projectB.id, guest.id)).resolves.toBeNull()
await expect(resolveEffectiveRole(team.id, undefined, guest.id)).resolves.toBeNull()
})
it('returns null for non-members', async () => {
const { team, projectA, outsider } = await setupData()
await expect(resolveEffectiveRole(team.id, projectA.id, outsider.id)).resolves.toBeNull()
await expect(resolveEffectiveRole(team.id, undefined, outsider.id)).resolves.toBeNull()
})
})
+183
View File
@@ -255,6 +255,61 @@ describe('ChatService', () => {
expect(taskPayload?.agent?.imageUrls).toContain('doc_s3_key')
})
it('should enforce agent permissions in startOrContinueChat', async () => {
const { team, project } = await setupBasicData()
// Create an owner-only agent
const ownerAgentUser = await prisma.user.create({
data: {
name: 'Owner Agent User',
email: `owner-agent-${Date.now()}@shumai.ai`,
type: 'agent',
},
})
const ownerAgent = await prisma.agent.create({
data: {
id: ownerAgentUser.id,
teamId: team.id,
type: 'chat',
permission: 'owner',
config: { provider: 'p', model: 'm' },
},
})
// Create an editor user and a reviewer user
const editorUser = await prisma.user.create({
data: { name: 'Editor User', email: `ed-${Date.now()}@shumai.ai`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: editorUser.id, role: 'editor' },
})
const reviewerUser = await prisma.user.create({
data: { name: 'Reviewer User', email: `rev-${Date.now()}@shumai.ai`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: reviewerUser.id, role: 'reviewer' },
})
// Editor trying to chat with owner-only agent should fail
await expect(
chatService.startOrContinueChat(editorUser, team.id, {
agentId: ownerAgent.id,
textPrompt: 'test',
projectId: project.id,
}),
).rejects.toThrow('Permission denied')
// Reviewer trying to chat with owner-only agent should fail
await expect(
chatService.startOrContinueChat(reviewerUser, team.id, {
agentId: ownerAgent.id,
textPrompt: 'test',
projectId: project.id,
}),
).rejects.toThrow('Permission denied')
})
it('should list sessions of a user and only return chat type sessions', async () => {
const { user, team, project } = await setupBasicData()
@@ -688,6 +743,9 @@ describe('ChatService', () => {
const otherUser = await prisma.user.create({
data: { name: 'Other User', email: `other-${Date.now()}@example.com`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: otherUser.id, role: 'reviewer' },
})
const { sessionId } = await chatService.startOrContinueChat(otherUser, team.id, {
agentId: 'test-agent-id',
textPrompt: 'hello',
@@ -718,4 +776,129 @@ describe('ChatService', () => {
)
})
})
describe('project-aware agent permission checks', () => {
async function setupProjectRoles() {
const team = await prisma.team.create({
data: {
name: 'Team Roles',
settings: { transcode: { videoStrategy: 'best_match' }, chatbotAgentId: 'test-agent-id' },
sandbox: { create: {} },
},
})
const project = await prisma.project.create({
data: { name: 'Proj Roles', teamId: team.id },
})
const rootFolder = await prisma.asset.create({
data: { name: 'root', type: 'root', status: 'processed', projectId: project.id },
})
await prisma.project.update({
where: { id: project.id },
data: { rootFolderId: rootFolder.id },
})
const createAgent = async (name: string, permission: 'owner' | 'editor' | 'reviewer') => {
const agentUser = await prisma.user.create({
data: { name, email: `${name}-${Date.now()}@shumai.ai`, type: 'agent' },
})
return prisma.agent.create({
data: {
id: agentUser.id,
teamId: team.id,
type: 'chat',
permission,
config: { provider: 'openai', model: 'gpt-4' },
},
})
}
const editorAgent = await createAgent('Editor Agent', 'editor')
const ownerAgent = await createAgent('Owner Agent', 'owner')
// Team editor demoted to project reviewer
const demoted = await prisma.user.create({
data: { name: 'Demoted', email: `dem-${Date.now()}@x.com`, password: 'pw' },
})
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' },
})
// Project-scoped member invited as editor
const projEditor = await prisma.user.create({
data: { name: 'Proj Editor', email: `pe-${Date.now()}@x.com`, password: 'pw' },
})
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' },
})
// Team reviewer promoted to project owner
const promoted = await prisma.user.create({
data: { name: 'Promoted', email: `pro-${Date.now()}@x.com`, password: 'pw' },
})
const promotedTm = await prisma.teamMember.create({
data: { teamId: team.id, userId: promoted.id, role: 'reviewer', scope: 'team' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: promotedTm.id, role: 'owner' },
})
// Plain team reviewer (no project override)
const reviewer = await prisma.user.create({
data: { name: 'Reviewer', email: `rev-${Date.now()}@x.com`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: reviewer.id, role: 'reviewer', scope: 'team' },
})
return { team, project, editorAgent, ownerAgent, demoted, projEditor, promoted, reviewer }
}
it('denies an editor agent to a team editor demoted to project reviewer', async () => {
const { team, project, editorAgent, demoted } = await setupProjectRoles()
await expect(
chatService.startOrContinueChat(demoted, team.id, {
agentId: editorAgent.id,
textPrompt: 'hello',
projectId: project.id,
}),
).rejects.toThrow(/Insufficient role/)
})
it('allows an editor agent to a project-scoped member invited as editor', async () => {
const { team, project, editorAgent, projEditor } = await setupProjectRoles()
const { sessionId } = await chatService.startOrContinueChat(projEditor, team.id, {
agentId: editorAgent.id,
textPrompt: 'hello',
projectId: project.id,
})
expect(sessionId).toBeDefined()
})
it('allows an owner agent to a team reviewer promoted to project owner', async () => {
const { team, project, ownerAgent, promoted } = await setupProjectRoles()
const { sessionId } = await chatService.startOrContinueChat(promoted, team.id, {
agentId: ownerAgent.id,
textPrompt: 'hello',
projectId: project.id,
})
expect(sessionId).toBeDefined()
})
it('denies an editor agent to a plain team reviewer', async () => {
const { team, project, editorAgent, reviewer } = await setupProjectRoles()
await expect(
chatService.startOrContinueChat(reviewer, team.id, {
agentId: editorAgent.id,
textPrompt: 'hello',
projectId: project.id,
}),
).rejects.toThrow(/Insufficient role/)
})
})
})
+41 -2
View File
@@ -1,11 +1,17 @@
import { prisma } from '@shumai/db'
import type { Prisma } from '@shumai/db'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import {
authzService,
Permission,
ResourceType,
resolveEffectiveRole,
} from '@shumai/core/src/authz/authz'
import { paginateQuery, type PaginatedData } from '@shumai/core/src/pagination'
import type { ChatRequest, ChatSessionInfo, ChatMessage } from '@shumai/dtos'
import type { SessionTreeEntry } from '@earendil-works/pi-agent-core'
import { workflowService } from '@shumai/workflow-core'
import { agentService } from '@shumai/core/src/agent/agent'
import { getAgentRequiredLevel, getRoleLevel } from '@shumai/core/src/agent/permissions'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -281,7 +287,10 @@ export class ChatService {
let activeSessionId = passedSessionId
// Ensure AI agent configuration exists
const agent = await tx.agent.findUnique({ where: { id: agentId } })
const agent = await tx.agent.findUnique({
where: { id: agentId },
include: { user: true },
})
if (!agent) {
throw new Error(`Agent with ID "${agentId}" not found`)
}
@@ -289,6 +298,36 @@ export class ChatService {
throw new Error(`Agent does not belong to the specified team`)
}
// Check user's permission to use this agent, resolving the effective
// role for the project context (projectMember.role takes precedence over
// the team role; project-scoped members without project access are denied).
const member = await tx.teamMember.findUnique({
where: {
teamIdUserId: {
teamId,
userId: user.id,
},
},
})
if (!member) {
throw new Error('User is not a member of the team')
}
const effectiveRole = await resolveEffectiveRole(teamId, projectId, user.id, tx)
if (!effectiveRole) {
throw new Error(
`Permission denied: Insufficient role to use agent "${agent.user.name}". Minimum required role is "${agent.permission}".`,
)
}
const userLevel = getRoleLevel(effectiveRole)
const requiredLevel = getAgentRequiredLevel(agent.permission)
if (userLevel < requiredLevel) {
throw new Error(
`Permission denied: Insufficient role to use agent "${agent.user.name}". Minimum required role is "${agent.permission}".`,
)
}
if (activeSessionId) {
const sessionExists = await tx.agentSession.findUnique({
where: { id: activeSessionId },
+1
View File
@@ -26,3 +26,4 @@ export * from './ai-usage/ai-usage'
export * from './watermark/watermark'
export * from './gotenberg/gotenberg'
export * from './mcp/mcp-service'
export * from './quota/quota-service'
+103
View File
@@ -536,6 +536,109 @@ describe('McpService', () => {
expect(allowed.ok).toBe(true)
})
it('uses the effective project role for MCP permission checks', async () => {
const server = await service.createServer(teamId, {
url: srv.url,
permission: 'editor',
})
const project = await prisma.project.create({
data: { name: 'MCP Proj', teamId },
})
// Team editor demoted to project reviewer: denied inside the project
const demoted = await prisma.user.create({
data: { name: 'Demoted MCP', email: `dem-mcp-${Date.now()}@shumai.ai`, type: 'human' },
})
const demotedTm = await prisma.teamMember.create({
data: { teamId, userId: demoted.id, role: 'editor', scope: 'team' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: demotedTm.id, role: 'reviewer' },
})
const denied = await service.callMcpTool(
server.id,
'echo',
{ text: 'x' },
{ teamId, userId: demoted.id, projectId: project.id },
)
expect(denied.ok).toBe(false)
expect((denied.content[0] as { text?: string }).text).toContain('Permission denied')
// Project-scoped member invited as editor: allowed
const projEditor = await prisma.user.create({
data: { name: 'PE MCP', email: `pe-mcp-${Date.now()}@shumai.ai`, type: 'human' },
})
const peTm = await prisma.teamMember.create({
data: { teamId, userId: projEditor.id, role: 'reviewer', scope: 'project' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: peTm.id, role: 'editor' },
})
const allowed = await service.callMcpTool(
server.id,
'echo',
{ text: 'ok' },
{ teamId, userId: projEditor.id, projectId: project.id },
)
expect(allowed.ok).toBe(true)
})
it('filters assigned MCP servers by the user effective role when building agent tools', async () => {
const agent = await seedAgentAndUser(teamId, 'Filtered MCP Agent')
const project = await prisma.project.create({
data: { name: 'MCP Filter Proj', teamId },
})
const reviewerSrv = await startTestMcpServer({
tools: standardTestTools(),
serverInfo: { name: 'reviewer-only-mcp' },
})
const editorSrv = await startTestMcpServer({
tools: standardTestTools(),
serverInfo: { name: 'editor-only-mcp' },
})
const reviewerServer = await service.createServer(teamId, {
url: reviewerSrv.url,
permission: 'reviewer',
})
const editorServer = await service.createServer(teamId, {
url: editorSrv.url,
permission: 'editor',
})
await service.refreshServer(reviewerServer.id)
await service.refreshServer(editorServer.id)
await prisma.agentMcpServer.create({
data: { agentId: agent.id, mcpServerId: reviewerServer.id },
})
await prisma.agentMcpServer.create({
data: { agentId: agent.id, mcpServerId: editorServer.id },
})
// Project-scoped member invited as reviewer: only the reviewer server's
// tools are attached; the editor server's tools are not even registered.
const reviewer = await prisma.user.create({
data: { name: 'Filter Reviewer', email: `fr-${Date.now()}@shumai.ai`, type: 'human' },
})
const reviewerTm = await prisma.teamMember.create({
data: { teamId, userId: reviewer.id, role: 'reviewer', scope: 'project' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: reviewerTm.id, role: 'reviewer' },
})
const tools = await service.buildAgentTools(agent.id, teamId, reviewer.id, project.id)
const descriptions = tools
.map((t) => (t.description ?? '') + (t.name === 'mcp' ? JSON.stringify(t.parameters) : ''))
.join('\n')
expect(descriptions).toContain('reviewer-only-mcp')
expect(descriptions).not.toContain('editor-only-mcp')
await reviewerSrv.stop()
await editorSrv.stop()
})
// --------------------------------------------------------------------------
// Per-agent assignment (D6)
// --------------------------------------------------------------------------
+100 -41
View File
@@ -4,7 +4,7 @@
import { auth } from '@modelcontextprotocol/client'
import type { AgentTool, AgentToolResult } from '@earendil-works/pi-agent-core'
import { prisma } from '@shumai/db'
import { prisma, type TeamMemberRole } from '@shumai/db'
import '@shumai/db/src/prisma-json-types'
import type {
CreateMcpServerRequest,
@@ -13,6 +13,8 @@ import type {
UpdateMcpServerRequest,
} from '@shumai/dtos'
import { logger } from '@shumai/core/src/logger'
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
import { quotaService } from '@shumai/core/src/quota/quota-service'
import { mcpDbStore, type PendingAuth } from './mcp-db-store'
import { buildDirectTools, isDirectTool } from './mcp-direct-tools'
import { McpOauthProvider, type McpOauthConfig } from './mcp-oauth-provider'
@@ -34,6 +36,7 @@ const ROLE_HIERARCHY: Record<string, number> = {
export interface McpToolCallContext {
teamId: string
userId?: string
projectId?: string
}
export type McpToolCallContent = AgentToolResult<Record<string, unknown>>['content']
@@ -468,16 +471,10 @@ export class McpService {
const requiredLevel = ROLE_HIERARCHY[server.permission] || 1
if (ctx?.userId) {
const member = await prisma.teamMember.findUnique({
where: {
teamIdUserId: {
teamId: server.teamId,
userId: ctx.userId,
},
},
select: { role: true },
})
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 effectiveRole = await resolveEffectiveRole(server.teamId, ctx.projectId, ctx.userId)
const userLevel = effectiveRole ? ROLE_HIERARCHY[effectiveRole] || 0 : 0
if (userLevel < requiredLevel) {
return `Permission denied: Insufficient role to use MCP server "${server.name}". Minimum required role is "${server.permission}".`
}
@@ -533,6 +530,32 @@ export class McpService {
return { ok: false, content: [{ type: 'text', text: denied }] }
}
let role: TeamMemberRole | null | undefined = undefined
if (ctx?.teamId && ctx?.userId) {
role = await resolveEffectiveRole(ctx.teamId, ctx.projectId, ctx.userId)
}
if (ctx?.teamId) {
try {
await quotaService.checkQuota(
{
teamId: ctx.teamId,
userId: ctx.userId,
role,
resource: 'agent_mcp_call_count',
resourceData: { id: serverId, mcpServerId: serverId },
},
1,
)
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err)
return {
ok: false,
content: [{ type: 'text', text: `Quota exceeded: ${message}` }],
}
}
}
const outcome = await this.ensureConnected(serverId)
if (outcome.status === 'needs-auth') {
return {
@@ -559,6 +582,24 @@ export class McpService {
try {
const result = await this.manager.callTool(serverId, toolName, args)
if (ctx?.teamId) {
try {
await quotaService.consumeQuota(
{
teamId: ctx.teamId,
userId: ctx.userId,
role,
resource: 'agent_mcp_call_count',
resourceData: { id: serverId, mcpServerId: serverId },
},
1,
)
} catch (err) {
logger.error({ err }, 'Failed to record quota usage for MCP tool call')
}
}
if (result.isError) {
const text = result.content.map((c) => ('text' in c ? c.text : '[image]')).join('\n')
return {
@@ -791,47 +832,65 @@ export class McpService {
* Build the agent's MCP AgentTools: the single `mcp` proxy tool plus direct
* tools for assigned servers in direct-tools mode. Returns [] when the agent
* has no assigned servers (no proxy tool — don't waste LLM context).
*
* When a user context is provided, servers whose `permission` exceeds the
* user's effective project role are filtered out up front, so the model never
* sees tools it is not allowed to call (call-time checks remain as a backstop).
*/
async buildAgentTools(agentId: string, teamId: string, userId?: string): Promise<AgentTool[]> {
async buildAgentTools(
agentId: string,
teamId: string,
userId?: string,
projectId?: string,
): Promise<AgentTool[]> {
const assignments = await prisma.agentMcpServer.findMany({
where: { agentId },
include: { mcpServer: true },
})
if (assignments.length === 0) return []
let assignedServers = assignments.map((a) => a.mcpServer)
if (userId) {
const effectiveRole = await resolveEffectiveRole(teamId, projectId, userId)
if (!effectiveRole) return []
const userLevel = ROLE_HIERARCHY[effectiveRole] || 0
assignedServers = assignedServers.filter(
(s) => (ROLE_HIERARCHY[s.permission] || 1) <= userLevel,
)
}
if (assignedServers.length === 0) return []
// Per-agent tool registry: built fresh for this agent from the persisted
// discovery cache (McpServer.tools). It only ever contains the agent's
// assigned servers, so unassigned/disabled servers can neither be searched
// nor called — no global mutable state to leak through.
const registry = new McpToolRegistry()
const servers = assignments
.map((a) => a.mcpServer)
.map((s) => {
const storedTools = (s.tools ?? []) as PrismaJson.McpToolInfo[]
if (storedTools.length > 0) {
registry.setTools(
s.id,
s.name,
storedTools.map((t) => ({
name: t.name,
description: t.description ?? '',
...(t.inputSchema !== undefined ? { inputSchema: t.inputSchema } : {}),
})),
{ excludeTools: s.config?.excludeTools },
)
}
return {
id: s.id,
name: s.name,
instructions: s.instructions ?? null,
url: s.url,
transport: s.transport,
authConfig: (s.authConfig ?? {}) as PrismaJson.McpServerAuthConfig,
config: (s.config ?? {}) as PrismaJson.McpServerConfig,
status: s.status,
}
})
const servers = assignedServers.map((s) => {
const storedTools = (s.tools ?? []) as PrismaJson.McpToolInfo[]
if (storedTools.length > 0) {
registry.setTools(
s.id,
s.name,
storedTools.map((t) => ({
name: t.name,
description: t.description ?? '',
...(t.inputSchema !== undefined ? { inputSchema: t.inputSchema } : {}),
})),
{ excludeTools: s.config?.excludeTools },
)
}
return {
id: s.id,
name: s.name,
instructions: s.instructions ?? null,
url: s.url,
transport: s.transport,
authConfig: (s.authConfig ?? {}) as PrismaJson.McpServerAuthConfig,
config: (s.config ?? {}) as PrismaJson.McpServerConfig,
status: s.status,
}
})
const serverNameById = new Map<string, string>()
const serverIdByName = new Map<string, string>()
@@ -880,7 +939,7 @@ export class McpService {
},
ensureConnected: (serverId) => this.ensureConnected(serverId, registry),
callTool: (serverId, toolName, args) =>
this.callMcpTool(serverId, toolName, args, { teamId, userId }),
this.callMcpTool(serverId, toolName, args, { teamId, userId, projectId }),
authStatus: (serverId) => this.getAuthStatus(serverId),
startAuth: (serverId) => this.startAuth(serverId),
getInstructions: (serverId) => this.getServerInstructions(serverId),
@@ -898,7 +957,7 @@ export class McpService {
serverId: server.id,
serverName: server.name,
callTool: (serverId, toolName, args) =>
this.callMcpTool(serverId, toolName, args, { teamId, userId }),
this.callMcpTool(serverId, toolName, args, { teamId, userId, projectId }),
}),
)
}
+295 -7
View File
@@ -87,7 +87,7 @@ describe('MetadataService', () => {
expect(projectFields[2].visible).toBe(false)
})
it('AIAutofillAndDescription', async () => {
it('AutofillSourceAndDescription', async () => {
const team = await prisma.team.create({
data: { name: 'test-team' },
})
@@ -103,24 +103,22 @@ describe('MetadataService', () => {
key: 'teamfield1',
scope: 'TEAM',
team: { connect: { id: team.id } },
config: { name: 'Test Team Field', type: 'text' },
aiAutofill: true,
config: { name: 'Test Team Field', type: 'text', autofillSource: 'CONTENT' },
description: desc,
},
})
const newDesc = 'Updated description'
const updatedTeamField = await metadataService.updateTeamField(team.id, teamField.key, {
config: { name: 'Test Team Field', type: 'text' },
aiAutofill: false,
config: { name: 'Test Team Field', type: 'text', autofillSource: 'NONE' },
description: newDesc,
})
expect(updatedTeamField.aiAutofill).toBe(false)
expect(updatedTeamField.config?.autofillSource).toBe('NONE')
expect(updatedTeamField.description).toBe(newDesc)
// IDOR test
await expect(
metadataService.updateTeamField('wrong-team-id', teamField.key, {
config: { name: 'Hack', type: 'text' },
config: { name: 'Hack', type: 'text', autofillSource: 'NONE' },
}),
).rejects.toThrow('Field does not belong to this team')
})
@@ -261,4 +259,294 @@ describe('MetadataService', () => {
const multiVal = values.find((v) => v.fieldKey === userMultiField.key)
expect(multiVal?.jsonValue).toEqual(multiUserIds)
})
it('should dynamically create new options for select fields and store option id', async () => {
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: 'test-asset',
project: { connect: { id: project.id } },
type: 'file',
status: 'uploaded',
sizeByte: 100,
},
})
const selectField = await prisma.metadataField.create({
data: {
key: 'ai_provider',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'AI Provider',
type: 'select',
select: {
options: [
{ id: 'openai', displayName: 'OpenAI', color: '#f43f5e' },
{ id: 'google', displayName: 'Google', color: '#3b82f6' },
],
},
},
},
})
// 1. Add new option 'Kling AI'
await metadataService.updateAssetMetadata(asset.id, [
{ key: selectField.key, value: { newOption: { value: 'Kling AI' } } },
])
// Verify option added to field config
const updatedField = await prisma.metadataField.findUnique({
where: { key: selectField.key },
})
const options = (updatedField?.config as PrismaJson.FieldConfig)?.select?.options || []
expect(options).toHaveLength(3)
const klingOpt = options.find((o) => o.displayName === 'Kling AI')
expect(klingOpt).toBeDefined()
expect(klingOpt?.id).toBe('kling-ai')
expect(klingOpt?.color).toBeDefined()
// Verify asset metadata value stores the option ID
const val = await prisma.assetMetadataValue.findUnique({
where: {
// eslint-disable-next-line @typescript-eslint/naming-convention
assetId_fieldKey: {
assetId: asset.id,
fieldKey: selectField.key,
},
},
})
expect(val?.stringValue).toBe('kling-ai')
// 2. Deduplication: passing 'kling ai' case-insensitively should reuse existing 'kling-ai'
await metadataService.updateAssetMetadata(asset.id, [
{ key: selectField.key, value: { newOption: { value: 'kling ai' } } },
])
const updatedField2 = await prisma.metadataField.findUnique({
where: { key: selectField.key },
})
const options2 = (updatedField2?.config as PrismaJson.FieldConfig)?.select?.options || []
expect(options2).toHaveLength(3) // Not 4!
})
it('should dynamically create new options for selectMulti fields and store array of option ids', async () => {
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: 'test-asset',
project: { connect: { id: project.id } },
type: 'file',
status: 'uploaded',
sizeByte: 100,
},
})
const selectMultiField = await prisma.metadataField.create({
data: {
key: 'tags',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Tags',
type: 'selectMulti',
selectMulti: {
options: [{ id: 'tag1', displayName: 'Tag 1', color: '#f43f5e' }],
},
},
},
})
// Pass mixed existing and new option
await metadataService.updateAssetMetadata(asset.id, [
{
key: selectMultiField.key,
value: ['tag1', { newOption: { value: 'Tag 2' } }],
},
])
// Verify option added to field config
const updatedField = await prisma.metadataField.findUnique({
where: { key: selectMultiField.key },
})
const options = (updatedField?.config as PrismaJson.FieldConfig)?.selectMulti?.options || []
expect(options).toHaveLength(2)
const tag2Opt = options.find((o) => o.displayName === 'Tag 2')
expect(tag2Opt).toBeDefined()
expect(tag2Opt?.id).toBe('tag-2')
// Verify asset metadata value stores array of IDs
const val = await prisma.assetMetadataValue.findUnique({
where: {
// eslint-disable-next-line @typescript-eslint/naming-convention
assetId_fieldKey: {
assetId: asset.id,
fieldKey: selectMultiField.key,
},
},
})
expect(val?.jsonValue).toEqual(['tag1', 'tag-2'])
})
it('should reject invalid newOption value format', async () => {
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: 'test-asset',
project: { connect: { id: project.id } },
type: 'file',
status: 'uploaded',
sizeByte: 100,
},
})
const selectField = await prisma.metadataField.create({
data: {
key: 'field_opt',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: { name: 'Field Opt', type: 'select' },
},
})
await expect(
metadataService.updateAssetMetadata(asset.id, [
{ key: selectField.key, value: { newOption: { value: ' ' } } },
]),
).rejects.toThrow('value must be a non-empty string')
})
it('should handle ID collisions by appending numeric suffix', async () => {
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: 'test-asset',
project: { connect: { id: project.id } },
type: 'file',
status: 'uploaded',
sizeByte: 100,
},
})
const selectField = await prisma.metadataField.create({
data: {
key: 'collision_test',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Collision Test',
type: 'select',
select: {
options: [
{ id: 'kling-ai', displayName: 'Old Kling AI', color: '#f43f5e' },
{ id: 'kling-ai-1', displayName: 'Old Kling AI Suffix 1', color: '#3b82f6' },
],
},
},
},
})
// Now adding a new option with different displayName whose slug collides with 'kling-ai'
await metadataService.updateAssetMetadata(asset.id, [
{ key: selectField.key, value: { newOption: { value: 'Kling AI Unique' } } },
])
const updatedField = await prisma.metadataField.findUnique({
where: { key: selectField.key },
})
const options = (updatedField?.config as PrismaJson.FieldConfig)?.select?.options || []
const newOpt = options.find((o) => o.displayName === 'Kling AI Unique')
expect(newOpt).toBeDefined()
expect(newOpt?.id).toBe('kling-ai-unique')
// Test when baseId and candidateId-1 exist, next should be candidateId-2
const collisionField = await prisma.metadataField.create({
data: {
key: 'collision_base',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Collision Base',
type: 'select',
select: {
options: [
{ id: 'custom-tool', displayName: 'First Tool', color: '#f43f5e' },
{ id: 'custom-tool-1', displayName: 'Second Tool', color: '#3b82f6' },
],
},
},
},
})
// displayName is 'Custom Tool' which has baseId 'custom-tool' (not matching display names 'First Tool' / 'Second Tool')
await metadataService.updateAssetMetadata(asset.id, [
{ key: collisionField.key, value: { newOption: { value: 'Custom Tool' } } },
])
const updatedCollisionField = await prisma.metadataField.findUnique({
where: { key: collisionField.key },
})
const collisionOpts =
(updatedCollisionField?.config as PrismaJson.FieldConfig)?.select?.options || []
const resolvedNewOpt = collisionOpts.find((o) => o.displayName === 'Custom Tool')
expect(resolvedNewOpt).toBeDefined()
expect(resolvedNewOpt?.id).toBe('custom-tool-2')
})
it('should reject non-string and non-newOption items in selectMulti array', async () => {
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: 'test-asset',
project: { connect: { id: project.id } },
type: 'file',
status: 'uploaded',
sizeByte: 100,
},
})
const selectMultiField = await prisma.metadataField.create({
data: {
key: 'tags_invalid_items',
scope: 'PROJECT',
project: { connect: { id: project.id } },
config: {
name: 'Tags',
type: 'selectMulti',
},
},
})
// Passing invalid items like number or null
await expect(
metadataService.updateAssetMetadata(asset.id, [
// eslint-disable-next-line @typescript-eslint/no-explicit-any
{ key: selectMultiField.key, value: ['tag1', 123 as any] },
]),
).rejects.toThrow('expected string or {newOption}')
})
})
+228 -75
View File
@@ -10,6 +10,36 @@ import { ulid } from 'ulid'
import { assetService } from '../asset/asset'
import { systemFields } from './system_fields'
export const FIELD_COLORS = [
'#f43f5e', // rose
'#ec4899', // pink
'#d946ef', // fuchsia
'#a855f7', // purple
'#8b5cf6', // violet
'#6366f1', // indigo
'#3b82f6', // blue
'#0ea5e9', // sky
'#06b6d4', // cyan
'#14b8a6', // teal
'#10b981', // emerald
'#22c55e', // green
'#84cc16', // lime
'#eab308', // yellow
'#f59e0b', // amber
'#f97316', // orange
'#71717a', // zinc
'#64748b', // slate
]
export function getNextOptionColor(existingOptions: PrismaJson.SelectOption[] = []): string {
const usedColors = new Set(existingOptions.map((o) => o.color))
const available = FIELD_COLORS.filter((c) => !usedColors.has(c))
if (available.length > 0) {
return available[0]
}
return FIELD_COLORS[existingOptions.length % FIELD_COLORS.length]
}
export class MetadataService {
constructor(private client: typeof prisma = prisma) {}
async syncSystemFields(): Promise<void> {
@@ -43,7 +73,6 @@ export class MetadataService {
scope: 'TEAM',
teamId: teamId,
config: req.config,
aiAutofill: req.aiAutofill,
description: req.description,
},
})
@@ -89,7 +118,6 @@ export class MetadataService {
where: { id: field.id },
data: {
config: req.config,
aiAutofill: req.aiAutofill ?? field.aiAutofill,
description: req.description ?? field.description,
},
})
@@ -125,7 +153,6 @@ export class MetadataService {
projectId: projectId,
teamId: p.teamId,
config: req.config,
aiAutofill: req.aiAutofill,
description: req.description,
},
})
@@ -239,7 +266,6 @@ export class MetadataService {
where: { id: field.id },
data: {
config: req.config,
aiAutofill: req.aiAutofill ?? field.aiAutofill,
description: req.description ?? field.description,
},
})
@@ -262,84 +288,211 @@ export class MetadataService {
assetId: string,
reqs: UpdateAssetMetadataRequest[],
allowReadOnly = false,
): Promise<void> {
await this.client.$transaction(async (tx) => {
await this.updateAssetMetadataInternal(tx, assetId, reqs, allowReadOnly)
})
}
/**
* Same as {@link updateAssetMetadata} but runs inside the caller's transaction,
* keeping the metadata write atomic with the surrounding changes.
*/
async updateAssetMetadataInTx(
tx: Prisma.TransactionClient,
assetId: string,
reqs: UpdateAssetMetadataRequest[],
allowReadOnly = false,
): Promise<void> {
await this.updateAssetMetadataInternal(tx, assetId, reqs, allowReadOnly)
}
private async resolveOrCreateOption(
client: Prisma.TransactionClient | typeof prisma,
field: Prisma.MetadataFieldGetPayload<Record<string, never>>,
rawOption: unknown,
): Promise<string> {
if (
typeof rawOption !== 'object' ||
rawOption === null ||
!('newOption' in rawOption) ||
typeof (rawOption as { newOption?: unknown }).newOption !== 'object' ||
(rawOption as { newOption?: unknown }).newOption === null
) {
throw new Error(`Invalid newOption object for field ${field.key}`)
}
const value = (rawOption as { newOption: { value?: unknown } }).newOption.value
if (typeof value !== 'string' || !value.trim()) {
throw new Error(
`Invalid newOption value for field ${field.key}: value must be a non-empty string`,
)
}
const trimmedValue = value.trim()
const config = (field.config ?? {}) as PrismaJson.FieldConfig
const isMulti = config.type === 'selectMulti'
const existingOptions: PrismaJson.SelectOption[] =
(isMulti ? config.selectMulti?.options : config.select?.options) ?? []
// 1. Check for case-insensitive match against existing options (id or displayName)
const existing = existingOptions.find(
(opt) =>
opt.id.toLowerCase() === trimmedValue.toLowerCase() ||
opt.displayName.toLowerCase() === trimmedValue.toLowerCase(),
)
if (existing) {
return existing.id
}
// 2. Generate slug id
let baseId = trimmedValue.toLowerCase().replace(/\s+/g, '-')
if (!baseId) {
baseId = ulid().toLowerCase()
}
let candidateId = baseId
let suffix = 1
while (existingOptions.some((opt) => opt.id === candidateId)) {
candidateId = `${baseId}-${suffix}`
suffix++
}
const newOption: PrismaJson.SelectOption = {
id: candidateId,
displayName: trimmedValue,
color: getNextOptionColor(existingOptions),
}
const updatedOptions = [...existingOptions, newOption]
const updatedConfig: PrismaJson.FieldConfig = {
...config,
name: config.name ?? field.key,
type: config.type ?? (isMulti ? 'selectMulti' : 'select'),
...(isMulti
? { selectMulti: { ...(config.selectMulti ?? {}), options: updatedOptions } }
: { select: { ...(config.select ?? {}), options: updatedOptions } }),
}
await client.metadataField.update({
where: { key: field.key },
data: { config: updatedConfig },
})
// Update in-memory field.config for subsequent iterations in the same transaction
field.config = updatedConfig
return candidateId
}
private async updateAssetMetadataInternal(
client: Prisma.TransactionClient | typeof prisma,
assetId: string,
reqs: UpdateAssetMetadataRequest[],
allowReadOnly: boolean,
): Promise<void> {
const resolvedAssetId = await assetService.resolveLatestVersionId(assetId)
await this.client.$transaction(async (tx) => {
for (const req of reqs) {
const field = await tx.metadataField.findUnique({
where: { key: req.key },
})
if (field?.readOnly && !allowReadOnly) {
throw new Error(`Field ${field.key} is read-only`)
}
const value = req.value
let stringValue: string | null = null
let numberValue: number | null = null
let booleanValue: boolean | null = null
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let jsonValue: any = null
let dateValue: Date | null = null
if (typeof value === 'string') {
// Check if it's a valid ISO date string
const date = new Date(value)
if (!isNaN(date.getTime()) && value.includes('T') && value.includes('-')) {
dateValue = date
} else {
stringValue = value
}
} else if (typeof value === 'number') {
numberValue = value
} else if (typeof value === 'boolean') {
booleanValue = value
} else if (value instanceof Date) {
dateValue = value
} else if (Array.isArray(value)) {
jsonValue = value
} else if (value === null) {
// all null
} else if (typeof value === 'object') {
jsonValue = value
} else {
stringValue = String(value)
}
await tx.assetMetadataValue.upsert({
where: {
// eslint-disable-next-line @typescript-eslint/naming-convention
assetId_fieldKey: {
assetId: resolvedAssetId,
fieldKey: req.key,
},
},
create: {
assetId: resolvedAssetId,
fieldKey: req.key,
stringValue,
numberValue,
booleanValue,
jsonValue,
dateValue,
},
update: {
stringValue,
numberValue,
booleanValue,
jsonValue,
dateValue,
},
})
for (const req of reqs) {
const field = await client.metadataField.findUnique({
where: { key: req.key },
})
if (field?.readOnly && !allowReadOnly) {
throw new Error(`Field ${field.key} is read-only`)
}
// Touch asset
await tx.asset.update({
where: { id: resolvedAssetId },
data: {
updatedAt: new Date(),
let value = req.value
const config = field?.config as PrismaJson.FieldConfig | null
if (
field &&
config?.type === 'select' &&
typeof value === 'object' &&
value !== null &&
'newOption' in value
) {
value = await this.resolveOrCreateOption(client, field, value)
} else if (field && config?.type === 'selectMulti' && Array.isArray(value)) {
const resolvedList: string[] = []
for (const item of value) {
if (typeof item === 'object' && item !== null && 'newOption' in item) {
const resolvedId = await this.resolveOrCreateOption(client, field, item)
resolvedList.push(resolvedId)
} else if (typeof item === 'string') {
resolvedList.push(item)
} else {
throw new Error(
`Invalid option value for field ${field.key}: expected string or {newOption}`,
)
}
}
value = resolvedList
}
let stringValue: string | null = null
let numberValue: number | null = null
let booleanValue: boolean | null = null
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let jsonValue: any = null
let dateValue: Date | null = null
if (typeof value === 'string') {
// Check if it's a valid ISO date string
const date = new Date(value)
if (!isNaN(date.getTime()) && value.includes('T') && value.includes('-')) {
dateValue = date
} else {
stringValue = value
}
} else if (typeof value === 'number') {
numberValue = value
} else if (typeof value === 'boolean') {
booleanValue = value
} else if (value instanceof Date) {
dateValue = value
} else if (Array.isArray(value)) {
jsonValue = value
} else if (value === null) {
// all null
} else if (typeof value === 'object') {
jsonValue = value
} else {
stringValue = String(value)
}
await client.assetMetadataValue.upsert({
where: {
// eslint-disable-next-line @typescript-eslint/naming-convention
assetId_fieldKey: {
assetId: resolvedAssetId,
fieldKey: req.key,
},
},
create: {
assetId: resolvedAssetId,
fieldKey: req.key,
stringValue,
numberValue,
booleanValue,
jsonValue,
dateValue,
},
update: {
stringValue,
numberValue,
booleanValue,
jsonValue,
dateValue,
},
})
}
// Touch asset
await client.asset.update({
where: { id: resolvedAssetId },
data: {
updatedAt: new Date(),
},
})
}
}
+51
View File
@@ -194,6 +194,57 @@ describe('ProjectService', () => {
includeAgents: true,
})
expect(allMembers).toHaveLength(2)
const agentMember = allMembers.find((m) => m.id === bot.id)
const humanMember = allMembers.find((m) => m.id === human.id)
expect(agentMember?.type).toBe('agent')
expect(humanMember?.type).toBe('human')
})
it('filters agent bots by the requester effective project role', async () => {
const team = await prisma.team.create({ data: { name: 'Team Bot Filter' } })
const project = await prisma.project.create({ data: { name: 'P2', teamId: team.id } })
const createChatAgent = async (name: string, permission: 'owner' | 'editor' | 'reviewer') => {
const bot = await prisma.user.create({
data: { name, email: `${name}-${Date.now()}@example.com`, password: 'pw', type: 'agent' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: bot.id, role: 'editor', scope: 'team' },
})
await prisma.agent.create({
data: {
id: bot.id,
teamId: team.id,
type: 'chat',
enabled: true,
permission,
config: { provider: 'google', model: 'gemini' },
},
})
}
await createChatAgent('Reviewer Bot', 'reviewer')
await createChatAgent('Editor Bot', 'editor')
// Project-scoped requester invited as reviewer: sees only reviewer bots
const requester = await prisma.user.create({
data: { name: 'Req', email: `req-${Date.now()}@example.com`, password: 'pw' },
})
const requesterTm = await prisma.teamMember.create({
data: { teamId: team.id, userId: requester.id, role: 'reviewer', scope: 'project' },
})
await prisma.projectMember.create({
data: { projectId: project.id, teamMemberId: requesterTm.id, role: 'reviewer' },
})
const members = await projectService.listProjectMembers({
projectId: project.id,
includeAgents: true,
requesterUserId: requester.id,
})
const agentNames = members.filter((m) => m.id !== requester.id).map((m) => m.name)
expect(agentNames).toContain('Reviewer Bot')
expect(agentNames).not.toContain('Editor Bot')
})
it('should allow upserting custom role override for team-scoped members via updateMemberRole', async () => {
+28 -7
View File
@@ -3,6 +3,8 @@ import { Prisma } from '@shumai/db'
import { s3Service } from '@shumai/core/src/s3/s3'
import { paginateQuery, PaginatedData } from '@shumai/core/src/pagination'
import { getAvatarUrl } from '@shumai/core/src/user/avatar'
import { getAllowedAgentRoles } from '@shumai/core/src/agent/permissions'
import { resolveEffectiveRole } from '@shumai/core/src/authz/authz'
import {
ServiceCreateProjectRequest,
ServiceUpdateProjectRequest,
@@ -226,17 +228,35 @@ export class ProjectService {
})
if (!project) throw new Error('Project not found')
// When agents are requested, only include the chat agents the requester's
// effective project role permits (project override wins; restricted
// requesters see no agents at all). Without a requester context, fall back
// to including all enabled chat agents (legacy behavior).
let agentFilter: Prisma.AgentWhereInput | undefined
if (req.includeAgents) {
if (req.requesterUserId) {
const effectiveRole = await resolveEffectiveRole(
project.teamId,
req.projectId,
req.requesterUserId,
)
if (effectiveRole) {
agentFilter = {
type: 'chat' as const,
enabled: true,
permission: { in: getAllowedAgentRoles(effectiveRole) },
}
}
} else {
agentFilter = { type: 'chat' as const, enabled: true }
}
}
const userTypeFilter = req.includeAgents
? {
OR: [
{ type: 'human' as const },
{
type: 'agent' as const,
agent: {
type: 'chat' as const,
enabled: true,
},
},
...(agentFilter ? [{ type: 'agent' as const, agent: agentFilter }] : []),
],
}
: { type: { not: 'agent' as const } }
@@ -301,6 +321,7 @@ export class ProjectService {
id: m.user.id,
name: m.user.name,
role: m.role as ProjectUserInfo['role'],
type: m.user.type || undefined,
image: await getAvatarUrl(m.user.image),
scope: m.scope,
hasCustomRole: m.hasCustomRole,
@@ -0,0 +1,972 @@
import { describe, it, expect } from 'vitest'
import { prisma } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import { quotaService, QuotaExceededError, wildcardToRegex } from './quota-service'
describe('QuotaRule Wildcard Matchers', () => {
it('correctly matches bash command wildcards', () => {
const starRegex = wildcardToRegex('*')
expect(starRegex.test('npm install')).toBe(true)
expect(starRegex.test('git commit -m "test"')).toBe(true)
const npmRegex = wildcardToRegex('npm *')
expect(npmRegex.test('npm install')).toBe(true)
expect(npmRegex.test('npm test')).toBe(true)
expect(npmRegex.test('git push')).toBe(false)
const exactRegex = wildcardToRegex('rm -rf .pi')
expect(exactRegex.test('rm -rf .pi')).toBe(true)
expect(exactRegex.test('rm -rf /')).toBe(false)
})
it('correctly matches agent tool name wildcards', () => {
const starTool = wildcardToRegex('*')
expect(starTool.test('analyze_image')).toBe(true)
expect(starTool.test('screenshot')).toBe(true)
const exactTool = wildcardToRegex('analyze_image')
expect(exactTool.test('analyze_image')).toBe(true)
expect(exactTool.test('screenshot')).toBe(false)
})
})
describe('QuotaService', () => {
setupTestDbHooks()
it('creates, reads, updates, and deletes quota rules', async () => {
const team = await prisma.team.create({
data: { name: 'Quota Team' },
})
// Create rule
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 100000,
period: '1hour',
enabled: true,
})
expect(rule.id).toBeDefined()
expect(rule.teamId).toBe(team.id)
expect(rule.scopeMode).toBe('all_members')
expect(rule.limit).toBe(100000)
expect(rule.period).toBe('1hour')
// Get rule
const fetched = await quotaService.getRule(team.id, rule.id)
expect(fetched.id).toBe(rule.id)
expect(fetched.limit).toBe(100000)
// List rules
const list = await quotaService.listRules(team.id)
expect(list.total).toBe(1)
expect(list.rules[0].id).toBe(rule.id)
// Update rule
const updated = await quotaService.updateRule(team.id, rule.id, {
limit: 200000,
enabled: false,
})
expect(updated.limit).toBe(200000)
expect(updated.enabled).toBe(false)
// Delete rule
await quotaService.deleteRule(team.id, rule.id)
const afterDelete = await quotaService.listRules(team.id)
expect(afterDelete.total).toBe(0)
})
it('validates selected members on rule creation', async () => {
const team = await prisma.team.create({
data: { name: 'Quota Team' },
})
// Missing user should throw 400
await expect(
quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: ['non-existent-user-id'],
resource: 'agent_cost',
limit: 10,
period: '1day',
}),
).rejects.toThrow()
})
it('uses the latest database rule state for every quota check', async () => {
const team = await prisma.team.create({
data: { name: 'Fresh Quota Rule Team' },
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_cost',
limit: 10,
period: '1hour',
})
const event = {
teamId: team.id,
resource: 'agent_cost' as const,
}
expect((await quotaService.checkQuota(event)).matchedRules).toHaveLength(1)
await prisma.quotaRule.update({
where: { id: rule.id },
data: { enabled: false },
})
expect((await quotaService.checkQuota(event)).matchedRules).toHaveLength(0)
})
it('enforces check and consumes quota for all_members (shared pool)', async () => {
const team = await prisma.team.create({
data: { name: 'Shared Quota Team' },
})
await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
enabled: true,
})
// Check with 0 before consumption
const checkResult = await quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
0,
)
expect(checkResult.allowed).toBe(true)
// Consume 600 tokens
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
600,
)
// Check with 300 tokens (600 + 300 = 900 <= 1000) -> allowed
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
300,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
// Check with 500 tokens (600 + 500 = 1100 > 1000) -> throws QuotaExceededError
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
500,
),
).rejects.toThrow(QuotaExceededError)
// Consume another 400 tokens -> exactly 1000 consumed
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
400,
)
// Now even checkQuota with 1 token should fail
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
1,
),
).rejects.toThrow(QuotaExceededError)
})
it('enforces each_member scope independently for each member', async () => {
const team = await prisma.team.create({
data: { name: 'Each Member Team' },
})
const userAlice = await prisma.user.create({
data: { name: 'Alice', email: 'alice@example.com', password: 'pw' },
})
const userBob = await prisma.user.create({
data: { name: 'Bob', email: 'bob@example.com', password: 'pw' },
})
// Create rule: each member with role editor gets 5 MCP calls per 1hour
await quotaService.createRule(team.id, {
scopeMode: 'each_member',
role: 'editor',
resource: 'agent_mcp_call_count',
resourceData: { id: 'server_1' },
limit: 5,
period: '1hour',
enabled: true,
})
// Alice consumes 5 MCP calls
for (let i = 0; i < 5; i++) {
await quotaService.consumeQuota(
{
teamId: team.id,
userId: userAlice.id,
role: 'editor',
resource: 'agent_mcp_call_count',
resourceData: { id: 'server_1' },
},
1,
)
}
// Alice should be blocked on 6th call
await expect(
quotaService.checkQuota(
{
teamId: team.id,
userId: userAlice.id,
role: 'editor',
resource: 'agent_mcp_call_count',
resourceData: { id: 'server_1' },
},
1,
),
).rejects.toThrow(QuotaExceededError)
// Bob (also an editor) should NOT be blocked (independent tracking)
await expect(
quotaService.checkQuota(
{
teamId: team.id,
userId: userBob.id,
role: 'editor',
resource: 'agent_mcp_call_count',
resourceData: { id: 'server_1' },
},
1,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
// Reviewer should not match editor rule
const reviewerCheck = await quotaService.checkQuota(
{
teamId: team.id,
userId: userBob.id,
role: 'reviewer',
resource: 'agent_mcp_call_count',
resourceData: { id: 'server_1' },
},
1,
)
expect(reviewerCheck.matchedRules).toHaveLength(0)
})
it('enforces selected_members scope correctly', async () => {
const team = await prisma.team.create({
data: { name: 'Selected Members Team' },
})
const userSelected = await prisma.user.create({
data: { name: 'Selected User', email: 'sel@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: userSelected.id, role: 'editor' },
})
const userOther = await prisma.user.create({
data: { name: 'Other User', email: 'other@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: userOther.id, role: 'editor' },
})
await quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: [userSelected.id],
resource: 'agent_cost',
limit: 5,
period: '1day',
enabled: true,
})
// Selected user consumes 5
await quotaService.consumeQuota(
{
teamId: team.id,
userId: userSelected.id,
resource: 'agent_cost',
},
5,
)
// Selected user is blocked
await expect(
quotaService.checkQuota(
{
teamId: team.id,
userId: userSelected.id,
resource: 'agent_cost',
},
1,
),
).rejects.toThrow(QuotaExceededError)
// Other user does not match the rule -> allowed
const otherCheck = await quotaService.checkQuota(
{
teamId: team.id,
userId: userOther.id,
resource: 'agent_cost',
},
10,
)
expect(otherCheck.matchedRules).toHaveLength(0)
})
it('matches bash command wildcard rules', async () => {
const team = await prisma.team.create({
data: { name: 'Bash Quota Team' },
})
await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_bash_call_count',
resourceData: { match: 'npm *' },
limit: 2,
period: '1hour',
enabled: true,
})
// npm test matches -> consume 1
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_bash_call_count',
resourceData: { command: 'npm test' },
},
1,
)
// npm install matches -> consume 1 (total = 2)
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_bash_call_count',
resourceData: { command: 'npm install' },
},
1,
)
// 3rd npm command should be blocked
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_bash_call_count',
resourceData: { command: 'npm run build' },
},
1,
),
).rejects.toThrow(QuotaExceededError)
// git command does not match 'npm *' -> allowed
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_bash_call_count',
resourceData: { command: 'git status' },
},
1,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
})
it('matches agent tool call rules and wildcards', async () => {
const team = await prisma.team.create({
data: { name: 'Tool Quota Team' },
})
await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_tool_call_count',
resourceData: { name: 'analyze_image' },
limit: 1,
period: '1hour',
enabled: true,
})
// First call to analyze_image
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_tool_call_count',
resourceData: { name: 'analyze_image' },
},
1,
)
// 2nd call to analyze_image is blocked
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_tool_call_count',
resourceData: { name: 'analyze_image' },
},
1,
),
).rejects.toThrow(QuotaExceededError)
// Call to create_file does not match -> allowed
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_tool_call_count',
resourceData: { name: 'create_file' },
},
1,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
})
it('handles period window rollover and resets usage in-place with no history tables', async () => {
const team = await prisma.team.create({
data: { name: 'Window Rollover Team' },
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_cost',
limit: 10,
period: '1hour',
enabled: true,
})
// Simulate an expired period by creating a past QuotaRecord
const pastStart = new Date(Date.now() - 2 * 60 * 60 * 1000)
const pastEnd = new Date(Date.now() - 1 * 60 * 60 * 1000)
await prisma.quotaRecord.create({
data: {
ruleId: rule.id,
teamId: team.id,
userId: null,
periodStart: pastStart,
periodEnd: pastEnd,
consumed: 10, // fully consumed in past window
},
})
// Current check should be ALLOWED because the old window expired
await expect(
quotaService.checkQuota(
{
teamId: team.id,
resource: 'agent_cost',
},
5,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
// Consuming now resets the single record in-place
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_cost',
},
5,
)
const records = await prisma.quotaRecord.findMany({
where: { ruleId: rule.id },
})
// No extra history records (exactly 1 record row updated in place)
expect(records).toHaveLength(1)
expect(records[0].consumed).toBe(5)
})
it('lists rule records accurately with lazy reset status', async () => {
const team = await prisma.team.create({
data: { name: 'Records List Team' },
})
const user = await prisma.user.create({
data: { name: 'Alice Member', email: 'alice.member@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: {
teamId: team.id,
userId: user.id,
role: 'editor',
},
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'each_member',
resource: 'agent_total_tokens',
limit: 50000,
period: '1day',
enabled: true,
})
// Before any usage: listRuleRecords returns member with consumed: 0, isWindowActive: false
const initialRecords = await quotaService.listRuleRecords(team.id, rule.id)
expect(initialRecords.total).toBe(1)
expect(initialRecords.records[0].userId).toBe(user.id)
expect(initialRecords.records[0].consumed).toBe(0)
expect(initialRecords.records[0].remaining).toBe(50000)
expect(initialRecords.records[0].isWindowActive).toBe(false)
// Consume 10000 tokens
await quotaService.consumeQuota(
{
teamId: team.id,
userId: user.id,
role: 'editor',
resource: 'agent_total_tokens',
},
10000,
)
// After usage: active window with consumed = 10000
const activeRecords = await quotaService.listRuleRecords(team.id, rule.id)
expect(activeRecords.records[0].consumed).toBe(10000)
expect(activeRecords.records[0].remaining).toBe(40000)
expect(activeRecords.records[0].isWindowActive).toBe(true)
})
it('resets a shared quota record and starts a fresh window', async () => {
const team = await prisma.team.create({
data: { name: 'Reset Shared Quota Team' },
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
})
await quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 500)
const beforeReset = await prisma.quotaRecord.findFirst({ where: { ruleId: rule.id } })
expect(beforeReset?.consumed).toBe(500)
const reset = await quotaService.resetRecord(team.id, rule.id, null)
expect(reset.userId).toBeNull()
expect(reset.consumed).toBe(0)
expect(reset.remaining).toBe(1000)
expect(reset.percent).toBe(0)
expect(reset.isWindowActive).toBe(true)
expect(reset.periodStart).toBeDefined()
expect(reset.periodEnd).toBeDefined()
const afterReset = await prisma.quotaRecord.findFirst({ where: { ruleId: rule.id } })
expect(afterReset?.consumed).toBe(0)
expect(afterReset?.periodStart?.getTime()).toBeGreaterThanOrEqual(
beforeReset?.periodStart?.getTime() ?? 0,
)
})
it('creates and resets a member quota record before any usage exists', async () => {
const team = await prisma.team.create({
data: { name: 'Reset Member Quota Team' },
})
const user = await prisma.user.create({
data: { name: 'Reset Member', email: 'reset-member@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: user.id, role: 'editor' },
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'each_member',
resource: 'agent_total_tokens',
limit: 1000,
period: '1day',
})
const reset = await quotaService.resetRecord(team.id, rule.id, user.id)
expect(reset.userId).toBe(user.id)
expect(reset.consumed).toBe(0)
expect(reset.isWindowActive).toBe(true)
const records = await prisma.quotaRecord.findMany({ where: { ruleId: rule.id } })
expect(records).toHaveLength(1)
expect(records[0]?.userId).toBe(user.id)
expect(records[0]?.consumed).toBe(0)
})
it('rejects reset targets that do not match the quota rule', async () => {
const team = await prisma.team.create({
data: { name: 'Invalid Reset Target Team' },
})
const editor = await prisma.user.create({
data: { name: 'Editor', email: 'invalid-reset-editor@example.com', password: 'pw' },
})
const reviewer = await prisma.user.create({
data: { name: 'Reviewer', email: 'invalid-reset-reviewer@example.com', password: 'pw' },
})
await prisma.teamMember.createMany({
data: [
{ teamId: team.id, userId: editor.id, role: 'editor' },
{ teamId: team.id, userId: reviewer.id, role: 'reviewer' },
],
})
const roleRule = await quotaService.createRule(team.id, {
scopeMode: 'each_member',
role: 'editor',
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
})
await expect(quotaService.resetRecord(team.id, roleRule.id, reviewer.id)).rejects.toThrow(
'does not match the rule role',
)
await expect(quotaService.resetRecord(team.id, roleRule.id, null)).rejects.toThrow(
'require a userId',
)
const selectedRule = await quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: [editor.id],
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
})
await expect(quotaService.resetRecord(team.id, selectedRule.id, reviewer.id)).rejects.toThrow(
'not selected by this rule',
)
})
it('does not allow resetting a quota rule from another team', async () => {
const team = await prisma.team.create({ data: { name: 'Reset Owner Team' } })
const otherTeam = await prisma.team.create({ data: { name: 'Reset Other Team' } })
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
})
await expect(quotaService.resetRecord(otherTeam.id, rule.id, null)).rejects.toThrow(
'Quota rule not found',
)
})
it('enforces multiple matching rules simultaneously', async () => {
const team = await prisma.team.create({
data: { name: 'Multi Rule Team' },
})
const user = await prisma.user.create({
data: { name: 'Charlie', email: 'charlie@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: user.id, role: 'editor' },
})
// Rule 1: Team overall token limit 10,000 (all_members)
await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 10000,
period: '1day',
enabled: true,
})
// Rule 2: User specific token limit 2,000 (selected_members)
await quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: [user.id],
resource: 'agent_total_tokens',
limit: 2000,
period: '1day',
enabled: true,
})
// Consuming 2000 tokens for Charlie
await quotaService.consumeQuota(
{
teamId: team.id,
userId: user.id,
resource: 'agent_total_tokens',
},
2000,
)
// Charlie is blocked by user rule (2000 limit reached)
await expect(
quotaService.checkQuota(
{
teamId: team.id,
userId: user.id,
resource: 'agent_total_tokens',
},
100,
),
).rejects.toThrow(QuotaExceededError)
// Another user in the same team is NOT blocked by Charlie's limit, only by team limit
const userDave = await prisma.user.create({
data: { name: 'Dave', email: 'dave@example.com', password: 'pw' },
})
await expect(
quotaService.checkQuota(
{
teamId: team.id,
userId: userDave.id,
resource: 'agent_total_tokens',
},
1000,
),
).resolves.toEqual(expect.objectContaining({ allowed: true }))
})
it('rejects selected_members if user is not a member of the team on create', async () => {
const team1 = await prisma.team.create({ data: { name: 'Team 1' } })
const team2 = await prisma.team.create({ data: { name: 'Team 2' } })
const userInTeam1 = await prisma.user.create({
data: { name: 'Member 1', email: 'm1@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team1.id, userId: userInTeam1.id, role: 'editor' },
})
const userInTeam2 = await prisma.user.create({
data: { name: 'Member 2', email: 'm2@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team2.id, userId: userInTeam2.id, role: 'editor' },
})
// Creating rule on Team 1 with user from Team 2 should throw 400
await expect(
quotaService.createRule(team1.id, {
scopeMode: 'selected_members',
userIds: [userInTeam2.id],
resource: 'agent_cost',
limit: 10,
period: '1day',
}),
).rejects.toThrow('One or more selected users are not members of the team')
})
it('validates merged rule and rejects invalid partial updates', async () => {
const team = await prisma.team.create({ data: { name: 'Validation Team' } })
const user = await prisma.user.create({
data: { name: 'User 1', email: 'u1@example.com', password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: user.id, role: 'editor' },
})
const rule = await quotaService.createRule(team.id, {
scopeMode: 'each_member',
resource: 'agent_total_tokens',
limit: 10000,
period: '1hour',
})
// Updating resource to agent_mcp_call_count without resourceData.id should fail validation
await expect(
quotaService.updateRule(team.id, rule.id, {
resource: 'agent_mcp_call_count',
}),
).rejects.toThrow()
// Updating scopeMode to selected_members without userIds should fail validation
await expect(
quotaService.updateRule(team.id, rule.id, {
scopeMode: 'selected_members',
}),
).rejects.toThrow()
// Updating userIds with a user from outside the team should fail validation
const otherUser = await prisma.user.create({
data: { name: 'Other User', email: 'other_team@example.com', password: 'pw' },
})
await expect(
quotaService.updateRule(team.id, rule.id, {
scopeMode: 'selected_members',
userIds: [otherUser.id],
}),
).rejects.toThrow('One or more selected users are not members of the team')
})
it('resets existing quota records when accounting dimensions change', async () => {
const team = await prisma.team.create({ data: { name: 'Reset Records Team' } })
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 1000,
period: '1hour',
})
// Consume 500 tokens
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_total_tokens',
},
500,
)
let records = await prisma.quotaRecord.findMany({ where: { ruleId: rule.id } })
expect(records).toHaveLength(1)
expect(records[0].consumed).toBe(500)
// Update resource to agent_cost (limit 10)
await quotaService.updateRule(team.id, rule.id, {
resource: 'agent_cost',
limit: 10,
})
// Records should be reset
records = await prisma.quotaRecord.findMany({ where: { ruleId: rule.id } })
expect(records).toHaveLength(0)
// Consume $2 under the new resource
await quotaService.consumeQuota(
{
teamId: team.id,
resource: 'agent_cost',
},
2,
)
records = await prisma.quotaRecord.findMany({ where: { ruleId: rule.id } })
expect(records).toHaveLength(1)
expect(records[0].consumed).toBe(2)
})
it('handles concurrent first consumption for all_members without creating duplicate records', async () => {
const team = await prisma.team.create({ data: { name: 'Concurrent Quota Team' } })
const rule = await quotaService.createRule(team.id, {
scopeMode: 'all_members',
resource: 'agent_total_tokens',
limit: 10000,
period: '1hour',
})
// Concurrently trigger 5 quota consumption calls for the first time
await Promise.all([
quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 10),
quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 20),
quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 30),
quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 40),
quotaService.consumeQuota({ teamId: team.id, resource: 'agent_total_tokens' }, 50),
])
const records = await prisma.quotaRecord.findMany({ where: { ruleId: rule.id } })
expect(records).toHaveLength(1)
expect(records[0].consumed).toBe(150)
})
it('excludes agents from quota usage records and prevents creating quota rules for agents', async () => {
const team = await prisma.team.create({ data: { name: 'Exclude Agent Team' } })
// Create human user
const humanUser = await prisma.user.create({
data: {
name: 'Human Member',
email: 'human.member@example.com',
type: 'human',
password: 'pw',
},
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: humanUser.id, role: 'reviewer' },
})
// Create agent user and agent
const agentUser = await prisma.user.create({
data: {
name: 'AI Agent Member',
email: 'ai.agent@shumai.ai',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: agentUser.id,
teamId: team.id,
type: 'chat',
config: { provider: 'google', model: 'gemini' },
},
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: agentUser.id, role: 'reviewer' },
})
// 1. Quota rule with each_member
const eachMemberRule = await quotaService.createRule(team.id, {
scopeMode: 'each_member',
resource: 'agent_total_tokens',
limit: 10000,
period: '1hour',
enabled: true,
})
// listRuleRecords should ONLY return human members, NOT agents
const recordsResult = await quotaService.listRuleRecords(team.id, eachMemberRule.id)
expect(recordsResult.total).toBe(1)
expect(recordsResult.records).toHaveLength(1)
expect(recordsResult.records[0].userId).toBe(humanUser.id)
expect(recordsResult.records[0].user?.email).toBe('human.member@example.com')
// 2. Quota rule with selected_members targeting agentUser should be rejected
await expect(
quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: [agentUser.id],
resource: 'agent_total_tokens',
limit: 5000,
period: '1day',
}),
).rejects.toThrow('One or more selected users are not members of the team')
// 3. Updating quota rule with selected_members targeting agentUser should be rejected
const validSelectedRule = await quotaService.createRule(team.id, {
scopeMode: 'selected_members',
userIds: [humanUser.id],
resource: 'agent_total_tokens',
limit: 5000,
period: '1day',
})
await expect(
quotaService.updateRule(team.id, validSelectedRule.id, {
userIds: [agentUser.id],
}),
).rejects.toThrow('One or more selected users are not members of the team')
const selectedRecords = await quotaService.listRuleRecords(team.id, validSelectedRule.id)
expect(selectedRecords.total).toBe(1)
expect(selectedRecords.records[0].userId).toBe(humanUser.id)
})
})
+859
View File
@@ -0,0 +1,859 @@
import {
prisma,
Prisma,
type QuotaPeriod,
type QuotaRecord,
type QuotaResourceType,
type QuotaRule,
type TeamMemberRole,
} from '@shumai/db'
import {
type CreateQuotaRuleRequest,
type ListQuotaRulesResponse,
type QuotaRuleResponse,
type ListQuotaRecordsResponse,
type QuotaRecordResponse,
type UpdateQuotaRuleRequest,
normalizeQuotaPeriod,
formatQuotaPeriod,
mcpResourceDataSchema,
bashResourceDataSchema,
toolResourceDataSchema,
} from '@shumai/dtos'
import { HTTPException } from 'hono/http-exception'
export class QuotaExceededError extends Error {
public readonly policyId: string
public readonly resource: string
public readonly limit: number
public readonly consumed: number
public readonly periodEnd: Date
constructor(params: {
policyId: string
resource: string
limit: number
consumed: number
periodEnd: Date
message?: string
}) {
const msg =
params.message ||
`Quota exceeded for ${params.resource}: limit of ${params.limit} reached (currently consumed: ${params.consumed}). Resets at ${params.periodEnd.toISOString()}.`
super(msg)
this.name = 'QuotaExceededError'
this.policyId = params.policyId
this.resource = params.resource
this.limit = params.limit
this.consumed = params.consumed
this.periodEnd = params.periodEnd
}
}
export interface QuotaEventResourceData {
skillId?: string
mcpServerId?: string
command?: string
name?: string
toolName?: string
[key: string]: unknown
}
export interface QuotaEvent {
teamId: string
userId?: string | null
role?: TeamMemberRole | null
resource: QuotaResourceType
resourceData?: QuotaEventResourceData
}
export function periodToDurationMs(period: QuotaPeriod | string): number {
switch (period) {
case 'one_hour':
case '1hour':
return 60 * 60 * 1000
case 'five_hours':
case '5hour':
return 5 * 60 * 60 * 1000
case 'one_day':
case '1day':
return 24 * 60 * 60 * 1000
case 'seven_days':
case '7day':
return 7 * 24 * 60 * 60 * 1000
default:
return 60 * 60 * 1000
}
}
/**
* Converts a wildcard pattern (with * and ?) into a regular expression.
*/
export function wildcardToRegex(pattern: string): RegExp {
const trimmed = pattern.trim()
if (trimmed === '*' || trimmed === '') {
return /^.*$/s
}
// Escape regex special chars except * and ?
const escaped = trimmed.replace(/[.+^${}()|[\]\\]/g, '\\$&')
const regexStr = '^' + escaped.replace(/\*/g, '.*').replace(/\?/g, '.') + '$'
return new RegExp(regexStr, 's')
}
function matchesQuotaRule(rule: QuotaRule, event: QuotaEvent): boolean {
if (!rule.enabled) return false
if (event.teamId !== rule.teamId) return false
if (event.resource !== rule.resource) return false
// Scope check
if (rule.scopeMode === 'all_members') {
if (rule.role && event.role !== rule.role) return false
} else if (rule.scopeMode === 'each_member') {
if (!event.userId) return false
if (rule.role && event.role !== rule.role) return false
} else if (rule.scopeMode === 'selected_members') {
if (!event.userId) return false
const userIds = Array.isArray(rule.userIds) ? (rule.userIds as string[]) : null
if (!userIds || !userIds.includes(event.userId)) return false
}
const resourceData = (rule.resourceData as Record<string, unknown> | null) ?? null
// Resource data check
if (rule.resource === 'agent_mcp_call_count') {
const targetId = resourceData?.id ?? resourceData?.mcpServerId
const eventMcpId = event.resourceData?.mcpServerId ?? event.resourceData?.id
if (targetId && eventMcpId !== targetId) return false
} else if (rule.resource === 'agent_bash_call_count' && resourceData?.match) {
const bashMatcher = wildcardToRegex(String(resourceData.match))
const command = event.resourceData?.command ?? ''
if (!bashMatcher.test(command)) return false
} else if (
rule.resource === 'agent_tool_call_count' &&
(resourceData?.name || resourceData?.toolName)
) {
const toolMatcher = wildcardToRegex(String(resourceData.name ?? resourceData.toolName))
const toolName = String(event.resourceData?.name ?? event.resourceData?.toolName ?? '')
if (!toolMatcher.test(toolName)) return false
}
return true
}
function getQuotaRuleTargetUserId(rule: QuotaRule, event: QuotaEvent): string | null {
if (rule.scopeMode === 'all_members') {
return null
}
return event.userId ?? null
}
/* eslint-disable @typescript-eslint/naming-convention */
interface RawQuotaRecord {
id: string
rule_id: string
team_id: string
user_id: string | null
period_start: Date | null
period_end: Date | null
consumed: number
}
/* eslint-enable @typescript-eslint/naming-convention */
export class QuotaService {
constructor(private readonly prismaClient: typeof prisma = prisma) {}
private mapRuleToResponse(rule: QuotaRule, recordsCount?: number): QuotaRuleResponse {
const userIds = Array.isArray(rule.userIds) ? (rule.userIds as string[]) : undefined
return {
id: rule.id,
teamId: rule.teamId,
scopeMode: rule.scopeMode,
role: rule.role ?? undefined,
userIds,
resource: rule.resource,
resourceData: (rule.resourceData as Record<string, unknown> | null) ?? undefined,
limit: rule.limit,
period: formatQuotaPeriod(rule.period) as QuotaRuleResponse['period'],
enabled: rule.enabled,
recordsCount,
createdAt: rule.createdAt.toISOString(),
updatedAt: rule.updatedAt.toISOString(),
}
}
async createRule(teamId: string, req: CreateQuotaRuleRequest): Promise<QuotaRuleResponse> {
if (req.scopeMode === 'selected_members') {
if (!req.userIds || req.userIds.length === 0) {
throw new HTTPException(400, {
message: 'userIds must contain at least one user when scopeMode is "selected_members"',
})
}
const members = await this.prismaClient.teamMember.findMany({
where: {
teamId,
userId: { in: req.userIds },
user: { type: 'human' },
},
select: { userId: true },
})
if (members.length !== req.userIds.length) {
throw new HTTPException(400, {
message: 'One or more selected users are not members of the team',
})
}
}
const rule = await this.prismaClient.quotaRule.create({
data: {
teamId,
scopeMode: req.scopeMode,
role: req.scopeMode !== 'selected_members' ? (req.role ?? null) : null,
userIds:
req.scopeMode === 'selected_members' && req.userIds ? req.userIds : Prisma.JsonNull,
resource: req.resource,
resourceData: req.resourceData ?? Prisma.JsonNull,
limit: req.limit,
period: normalizeQuotaPeriod(req.period),
enabled: req.enabled ?? true,
},
})
return this.mapRuleToResponse(rule, 0)
}
async updateRule(
teamId: string,
ruleId: string,
req: UpdateQuotaRuleRequest,
): Promise<QuotaRuleResponse> {
const existing = await this.prismaClient.quotaRule.findUnique({
where: { id: ruleId },
})
if (!existing || existing.teamId !== teamId) {
throw new HTTPException(404, { message: 'Quota rule not found' })
}
const effectiveScopeMode = req.scopeMode ?? existing.scopeMode
const effectiveRole =
effectiveScopeMode === 'selected_members'
? null
: req.role !== undefined
? req.role
: existing.role
const effectiveUserIds =
effectiveScopeMode === 'selected_members'
? req.userIds !== undefined
? req.userIds
: Array.isArray(existing.userIds)
? (existing.userIds as string[])
: []
: null
const effectiveResource = req.resource ?? existing.resource
const effectiveResourceData =
req.resourceData !== undefined
? req.resourceData
: (existing.resourceData as Record<string, unknown> | null)
const effectiveLimit = req.limit ?? existing.limit
const effectivePeriod = req.period ? normalizeQuotaPeriod(req.period) : existing.period
const effectiveEnabled = req.enabled ?? existing.enabled
// Validate effective merged state
if (effectiveScopeMode === 'selected_members') {
if (!effectiveUserIds || effectiveUserIds.length === 0) {
throw new HTTPException(400, {
message: 'userIds must contain at least one user when scopeMode is "selected_members"',
})
}
const members = await this.prismaClient.teamMember.findMany({
where: {
teamId,
userId: { in: effectiveUserIds },
user: { type: 'human' },
},
select: { userId: true },
})
if (members.length !== effectiveUserIds.length) {
throw new HTTPException(400, {
message: 'One or more selected users are not members of the team',
})
}
}
if (effectiveResource === 'agent_mcp_call_count') {
const res = mcpResourceDataSchema.safeParse(effectiveResourceData)
if (!res.success) {
throw new HTTPException(400, {
message: 'resourceData.id is required for agent_mcp_call_count',
})
}
} else if (effectiveResource === 'agent_bash_call_count') {
const res = bashResourceDataSchema.safeParse(effectiveResourceData)
if (!res.success) {
throw new HTTPException(400, {
message: 'resourceData.match is required for agent_bash_call_count',
})
}
} else if (effectiveResource === 'agent_tool_call_count') {
const res = toolResourceDataSchema.safeParse(effectiveResourceData)
if (!res.success) {
throw new HTTPException(400, {
message: 'resourceData.name is required for agent_tool_call_count',
})
}
}
if (effectiveLimit <= 0) {
throw new HTTPException(400, {
message: 'Limit must be greater than 0',
})
}
const isAccountingDimensionChanged =
(req.resource !== undefined && req.resource !== existing.resource) ||
(req.period !== undefined && normalizeQuotaPeriod(req.period) !== existing.period) ||
(req.scopeMode !== undefined && req.scopeMode !== existing.scopeMode) ||
(req.role !== undefined && req.role !== existing.role) ||
(req.resourceData !== undefined &&
JSON.stringify(req.resourceData) !== JSON.stringify(existing.resourceData))
const updated = await this.prismaClient.$transaction(async (tx) => {
if (isAccountingDimensionChanged) {
// Reset all records when accounting dimensions change
await tx.quotaRecord.deleteMany({
where: { ruleId },
})
} else if (effectiveScopeMode === 'selected_members' && req.userIds !== undefined) {
// Clean up records for removed users if updating userIds
if (req.userIds && req.userIds.length > 0) {
await tx.quotaRecord.deleteMany({
where: {
ruleId,
userId: { notIn: req.userIds },
},
})
}
}
const data: Prisma.QuotaRuleUpdateInput = {
scopeMode: effectiveScopeMode,
role: effectiveRole,
userIds:
effectiveScopeMode === 'selected_members' && effectiveUserIds
? effectiveUserIds
: Prisma.JsonNull,
resource: effectiveResource,
resourceData: effectiveResourceData ?? Prisma.JsonNull,
limit: effectiveLimit,
period: effectivePeriod,
enabled: effectiveEnabled,
}
return tx.quotaRule.update({
where: { id: ruleId },
data,
})
})
const recordsCount = await this.prismaClient.quotaRecord.count({
where: { ruleId },
})
return this.mapRuleToResponse(updated, recordsCount)
}
async deleteRule(teamId: string, ruleId: string): Promise<void> {
const existing = await this.prismaClient.quotaRule.findUnique({
where: { id: ruleId },
})
if (!existing || existing.teamId !== teamId) {
throw new HTTPException(404, { message: 'Quota rule not found' })
}
await this.prismaClient.quotaRule.delete({
where: { id: ruleId },
})
}
async getRule(teamId: string, ruleId: string): Promise<QuotaRuleResponse> {
const rule = await this.prismaClient.quotaRule.findUnique({
where: { id: ruleId },
})
if (!rule || rule.teamId !== teamId) {
throw new HTTPException(404, { message: 'Quota rule not found' })
}
const recordsCount = await this.prismaClient.quotaRecord.count({
where: { ruleId },
})
return this.mapRuleToResponse(rule, recordsCount)
}
async listRules(teamId: string): Promise<ListQuotaRulesResponse> {
const rules = await this.prismaClient.quotaRule.findMany({
where: { teamId },
orderBy: { id: 'desc' },
})
const ruleResponses = await Promise.all(
rules.map(async (rule) => {
const recordsCount = await this.prismaClient.quotaRecord.count({
where: { ruleId: rule.id },
})
return this.mapRuleToResponse(rule, recordsCount)
}),
)
return {
rules: ruleResponses,
total: ruleResponses.length,
}
}
async listRuleRecords(teamId: string, ruleId: string): Promise<ListQuotaRecordsResponse> {
const rule = await this.prismaClient.quotaRule.findUnique({
where: { id: ruleId },
})
if (!rule || rule.teamId !== teamId) {
throw new HTTPException(404, { message: 'Quota rule not found' })
}
const now = new Date()
if (rule.scopeMode === 'all_members') {
const record = await this.prismaClient.quotaRecord.findFirst({
where: { ruleId: rule.id, userId: null },
})
const isWindowActive = Boolean(
record?.periodStart &&
record?.periodEnd &&
now >= record.periodStart &&
now < record.periodEnd,
)
const consumed = isWindowActive ? (record?.consumed ?? 0) : 0
const remaining = Math.max(0, rule.limit - consumed)
const percent =
rule.limit > 0 ? Math.min(100, Number(((consumed / rule.limit) * 100).toFixed(2))) : 0
const res: QuotaRecordResponse = {
id: record?.id ?? null,
ruleId: rule.id,
teamId: rule.teamId,
userId: null,
user: null,
periodStart:
isWindowActive && record?.periodStart ? record.periodStart.toISOString() : null,
periodEnd: isWindowActive && record?.periodEnd ? record.periodEnd.toISOString() : null,
consumed,
remaining,
percent,
isWindowActive,
}
return {
records: [res],
total: 1,
}
}
// For each_member or selected_members
type MemberTarget = { id: string; name: string; email: string; image?: string | null }
let targetUsers: MemberTarget[] = []
if (rule.scopeMode === 'selected_members') {
const userIds = Array.isArray(rule.userIds) ? (rule.userIds as string[]) : []
if (userIds.length > 0) {
targetUsers = await this.prismaClient.user.findMany({
where: { id: { in: userIds }, type: 'human' },
select: { id: true, name: true, email: true, image: true },
})
}
} else {
// each_member
const memberWhere: Prisma.TeamMemberWhereInput = {
teamId,
user: { type: 'human' },
}
if (rule.role) {
memberWhere.role = rule.role
}
const members = await this.prismaClient.teamMember.findMany({
where: memberWhere,
include: {
user: {
select: { id: true, name: true, email: true, image: true },
},
},
})
targetUsers = members.map((m) => m.user)
}
const existingRecords = await this.prismaClient.quotaRecord.findMany({
where: {
ruleId: rule.id,
userId: { in: targetUsers.map((u) => u.id) },
},
})
const recordByUserId = new Map<string, QuotaRecord>()
for (const r of existingRecords) {
if (r.userId) recordByUserId.set(r.userId, r)
}
const records: QuotaRecordResponse[] = targetUsers.map((user) => {
const record = recordByUserId.get(user.id)
const isWindowActive = Boolean(
record?.periodStart &&
record?.periodEnd &&
now >= record.periodStart &&
now < record.periodEnd,
)
const consumed = isWindowActive ? (record?.consumed ?? 0) : 0
const remaining = Math.max(0, rule.limit - consumed)
const percent =
rule.limit > 0 ? Math.min(100, Number(((consumed / rule.limit) * 100).toFixed(2))) : 0
return {
id: record?.id ?? null,
ruleId: rule.id,
teamId: rule.teamId,
userId: user.id,
user: {
id: user.id,
name: user.name,
email: user.email,
image: user.image ?? null,
},
periodStart:
isWindowActive && record?.periodStart ? record.periodStart.toISOString() : null,
periodEnd: isWindowActive && record?.periodEnd ? record.periodEnd.toISOString() : null,
consumed,
remaining,
percent,
isWindowActive,
}
})
return {
records,
total: records.length,
}
}
async resetRecord(
teamId: string,
ruleId: string,
userId: string | null,
): Promise<QuotaRecordResponse> {
const rule = await this.prismaClient.quotaRule.findUnique({
where: { id: ruleId },
})
if (!rule || rule.teamId !== teamId) {
throw new HTTPException(404, { message: 'Quota rule not found' })
}
if (rule.scopeMode === 'all_members' && userId !== null) {
throw new HTTPException(400, {
message: 'All-members quota records must use a null userId',
})
}
if (rule.scopeMode !== 'all_members' && userId === null) {
throw new HTTPException(400, {
message: 'Member quota records require a userId',
})
}
if (userId !== null) {
const member = await this.prismaClient.teamMember.findUnique({
where: {
teamIdUserId: {
teamId,
userId,
},
},
select: {
role: true,
user: {
select: { type: true },
},
},
})
if (!member || member.user.type !== 'human') {
throw new HTTPException(400, {
message: 'Quota record user must be a human team member',
})
}
if (rule.scopeMode === 'each_member' && rule.role && member.role !== rule.role) {
throw new HTTPException(400, {
message: 'Quota record user does not match the rule role',
})
}
if (rule.scopeMode === 'selected_members') {
const userIds = Array.isArray(rule.userIds) ? (rule.userIds as string[]) : []
if (!userIds.includes(userId)) {
throw new HTTPException(400, {
message: 'Quota record user is not selected by this rule',
})
}
}
}
await this.prismaClient.$transaction(async (tx) => {
// Lock the rule row so reset and first-use record creation are serialized.
await tx.$queryRaw`SELECT id FROM quota_rules WHERE id = ${rule.id} FOR UPDATE`
const periodStart = new Date()
const periodEnd = new Date(periodStart.getTime() + periodToDurationMs(rule.period))
const existingRecord = userId
? (
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id = ${userId}
FOR UPDATE
`
)[0]
: (
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id IS NULL
FOR UPDATE
`
)[0]
if (existingRecord) {
await tx.quotaRecord.update({
where: { id: existingRecord.id },
data: {
periodStart,
periodEnd,
consumed: 0,
},
})
} else {
await tx.quotaRecord.create({
data: {
ruleId: rule.id,
teamId: rule.teamId,
userId,
periodStart,
periodEnd,
consumed: 0,
},
})
}
})
const records = await this.listRuleRecords(teamId, ruleId)
const mappedRecord = records.records.find((record) => record.userId === userId)
if (!mappedRecord) {
throw new HTTPException(404, { message: 'Quota record not found' })
}
return mappedRecord
}
private async findMatchingRules(event: QuotaEvent): Promise<QuotaRule[]> {
const rules = await this.prismaClient.quotaRule.findMany({
where: {
teamId: event.teamId,
resource: event.resource,
enabled: true,
},
})
return rules.filter((rule) => matchesQuotaRule(rule, event))
}
/**
* Evaluates whether an action is permitted under all active matching quota rules.
* Performs an atomic pre-check with SELECT ... FOR UPDATE.
* Throws QuotaExceededError if any matching rule is exceeded.
*/
async checkQuota(
event: QuotaEvent,
amount: number = 0,
): Promise<{ allowed: boolean; matchedRules: QuotaRule[] }> {
const rules = await this.findMatchingRules(event)
if (rules.length === 0) {
return { allowed: true, matchedRules: [] }
}
const now = new Date()
for (const rule of rules) {
const targetUserId = getQuotaRuleTargetUserId(rule, event)
await this.prismaClient.$transaction(async (tx) => {
if (targetUserId === null) {
// Serialize all_members record checks/creations on the parent rule row
await tx.$queryRaw`SELECT id FROM quota_rules WHERE id = ${rule.id} FOR UPDATE`
}
let rawRecord = targetUserId
? ((
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id = ${targetUserId}
FOR UPDATE
`
)[0] ?? null)
: ((
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id IS NULL
FOR UPDATE
`
)[0] ?? null)
if (!rawRecord && targetUserId !== null) {
// Lock parent rule on first user record check and re-query
await tx.$queryRaw`SELECT id FROM quota_rules WHERE id = ${rule.id} FOR UPDATE`
rawRecord =
(
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id = ${targetUserId}
FOR UPDATE
`
)[0] ?? null
}
const isWindowActive = Boolean(
rawRecord?.period_start &&
rawRecord?.period_end &&
now >= rawRecord.period_start &&
now < rawRecord.period_end,
)
const consumed = isWindowActive ? (rawRecord?.consumed ?? 0) : 0
const periodEnd = isWindowActive
? rawRecord!.period_end!
: new Date(now.getTime() + periodToDurationMs(rule.period))
if (consumed + amount > rule.limit) {
throw new QuotaExceededError({
policyId: rule.id,
resource: rule.resource,
limit: rule.limit,
consumed,
periodEnd,
})
}
})
}
return { allowed: true, matchedRules: rules }
}
/**
* Records consumed usage across all matching quota rules.
* Lazy resets the period window in-place when previous window has expired.
* Uses SELECT ... FOR UPDATE inside transactions for atomic concurrency protection.
*/
async consumeQuota(event: QuotaEvent, amount: number): Promise<void> {
if (amount <= 0) return
const rules = await this.findMatchingRules(event)
if (rules.length === 0) return
const now = new Date()
for (const rule of rules) {
const targetUserId = getQuotaRuleTargetUserId(rule, event)
await this.prismaClient.$transaction(async (tx) => {
if (targetUserId === null) {
// Serialize all_members (shared pool) creations and updates on the parent rule row
await tx.$queryRaw`SELECT id FROM quota_rules WHERE id = ${rule.id} FOR UPDATE`
}
let rawRecord = targetUserId
? ((
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id = ${targetUserId}
FOR UPDATE
`
)[0] ?? null)
: ((
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id IS NULL
FOR UPDATE
`
)[0] ?? null)
if (!rawRecord && targetUserId !== null) {
// Lock parent rule on first user record creation and re-query
await tx.$queryRaw`SELECT id FROM quota_rules WHERE id = ${rule.id} FOR UPDATE`
rawRecord =
(
await tx.$queryRaw<RawQuotaRecord[]>`
SELECT * FROM quota_records
WHERE rule_id = ${rule.id} AND user_id = ${targetUserId}
FOR UPDATE
`
)[0] ?? null
}
const isWindowActive = Boolean(
rawRecord?.period_start &&
rawRecord?.period_end &&
now >= rawRecord.period_start &&
now < rawRecord.period_end,
)
if (isWindowActive && rawRecord) {
await tx.quotaRecord.update({
where: { id: rawRecord.id },
data: {
consumed: { increment: amount },
},
})
} else {
const periodStart = now
const periodEnd = new Date(now.getTime() + periodToDurationMs(rule.period))
if (rawRecord) {
await tx.quotaRecord.update({
where: { id: rawRecord.id },
data: {
periodStart,
periodEnd,
consumed: amount,
},
})
} else {
await tx.quotaRecord.create({
data: {
ruleId: rule.id,
teamId: rule.teamId,
userId: targetUserId,
periodStart,
periodEnd,
consumed: amount,
},
})
}
}
})
}
}
}
export const quotaService = new QuotaService()
+116 -2
View File
@@ -184,6 +184,115 @@ describe('TeamService', () => {
expect(allMembers).toHaveLength(2)
})
it('should filter included agents by agent permission and requester role', async () => {
const owner = await prisma.user.create({
data: { name: 'Owner', email: `owner-${Date.now()}@example.com`, password: 'pw' },
})
const team = await teamService.createTeam(owner, { name: 'Permission Team' })
const editor = await prisma.user.create({
data: { name: 'Editor', email: `editor-${Date.now()}@example.com`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: editor.id, role: 'editor' },
})
const reviewer = await prisma.user.create({
data: { name: 'Reviewer', email: `reviewer-${Date.now()}@example.com`, password: 'pw' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: reviewer.id, role: 'reviewer' },
})
// Create 3 agents with different permissions
const botReviewer = await prisma.user.create({
data: {
name: 'Bot All Users',
email: `bot-rev-${Date.now()}@shumai.ai`,
type: 'agent',
agent: {
create: {
teamId: team.id,
type: 'chat',
permission: 'reviewer',
enabled: true,
config: { provider: 'p', model: 'm' },
},
},
},
})
await teamService.joinTeam({ teamId: team.id, userId: botReviewer.id })
const botEditor = await prisma.user.create({
data: {
name: 'Bot Editor Only',
email: `bot-ed-${Date.now()}@shumai.ai`,
type: 'agent',
agent: {
create: {
teamId: team.id,
type: 'chat',
permission: 'editor',
enabled: true,
config: { provider: 'p', model: 'm' },
},
},
},
})
await teamService.joinTeam({ teamId: team.id, userId: botEditor.id })
const botOwner = await prisma.user.create({
data: {
name: 'Bot Owner Only',
email: `bot-own-${Date.now()}@shumai.ai`,
type: 'agent',
agent: {
create: {
teamId: team.id,
type: 'chat',
permission: 'owner',
enabled: true,
config: { provider: 'p', model: 'm' },
},
},
},
})
await teamService.joinTeam({ teamId: team.id, userId: botOwner.id })
// Reviewer should only see botReviewer among agents
const reviewerMembers = await teamService.getTeamMembers({
teamId: team.id,
userId: reviewer.id,
includeAgents: true,
})
const reviewerAgentIds = reviewerMembers.filter((m) => m.type === 'agent').map((m) => m.id)
expect(reviewerAgentIds).toEqual([botReviewer.id])
// Editor should see botReviewer and botEditor
const editorMembers = await teamService.getTeamMembers({
teamId: team.id,
userId: editor.id,
includeAgents: true,
})
const editorAgentIds = editorMembers.filter((m) => m.type === 'agent').map((m) => m.id)
expect(editorAgentIds).toHaveLength(2)
expect(editorAgentIds).toContain(botReviewer.id)
expect(editorAgentIds).toContain(botEditor.id)
expect(editorAgentIds).not.toContain(botOwner.id)
// Owner should see all 3 agents
const ownerMembers = await teamService.getTeamMembers({
teamId: team.id,
userId: owner.id,
includeAgents: true,
})
const ownerAgentIds = ownerMembers.filter((m) => m.type === 'agent').map((m) => m.id)
expect(ownerAgentIds).toHaveLength(3)
expect(ownerAgentIds).toContain(botReviewer.id)
expect(ownerAgentIds).toContain(botEditor.id)
expect(ownerAgentIds).toContain(botOwner.id)
})
it('should filter members for project-scoped members', async () => {
const owner = await prisma.user.create({
data: { name: 'Owner', email: `owner-${Date.now()}@example.com`, password: 'pw' },
@@ -296,31 +405,36 @@ describe('TeamService', () => {
name: 'Settings Team',
})
// Should have default settings
// Should have default settings (networkSandboxEnabled is false by default for new teams)
const settings = await teamService.getSandboxSettings(team.id)
expect(settings.networkSandboxEnabled).toBe(false)
expect(settings.allowedDomains).toContain('github.com')
expect(settings.pendingDomains).toEqual([])
// Should update settings
const updated = await teamService.updateSandboxSettings(team.id, {
networkSandboxEnabled: true,
allowedDomains: ['example.com'],
pendingDomains: ['pending.com'],
})
expect(updated.networkSandboxEnabled).toBe(true)
expect(updated.allowedDomains).toEqual(['example.com'])
expect(updated.pendingDomains).toEqual(['pending.com'])
// Should persist to DB
const persisted = await teamService.getSandboxSettings(team.id)
expect(persisted.networkSandboxEnabled).toBe(true)
expect(persisted.allowedDomains).toEqual(['example.com'])
expect(persisted.pendingDomains).toEqual(['pending.com'])
})
it('should return empty allowedDomains if sandbox is missing for old team', async () => {
it('should return default settings if sandbox is missing for old team', async () => {
const team = await prisma.team.create({
data: { name: 'Old Team' },
})
const settings = await teamService.getSandboxSettings(team.id)
expect(settings.networkSandboxEnabled).toBe(false)
expect(settings.allowedDomains).toEqual([])
expect(settings.pendingDomains).toEqual([])
})
+23 -5
View File
@@ -5,6 +5,7 @@ import { ProviderService, providerService } from '@shumai/core/src/provider/prov
import { notificationService } from '@shumai/core/src/notification/notification'
import { getAvatarUrl } from '@shumai/core/src/user/avatar'
import { HTTPException } from 'hono/http-exception'
import { getAllowedAgentRoles } from '@shumai/core/src/agent/permissions'
import {
ServiceCreateTeamRequest,
ServiceGetUserTeamsRequest,
@@ -16,6 +17,7 @@ import {
GetMeResponse,
UserInfo,
SandboxSettings,
UpdateSandboxSettingsRequest,
} from '@shumai/dtos'
export class TeamService {
@@ -187,6 +189,8 @@ export class TeamService {
throw new HTTPException(403, { message: 'Requester is not a team member' })
}
const allowedAgentRoles = getAllowedAgentRoles(requester.role)
const members = await prisma.teamMember.findMany({
where: {
teamId: req.teamId,
@@ -200,6 +204,7 @@ export class TeamService {
agent: {
type: 'chat',
enabled: true,
permission: { in: allowedAgentRoles },
},
},
],
@@ -330,25 +335,38 @@ export class TeamService {
where: { teamId },
})
return {
networkSandboxEnabled: sandbox?.networkSandboxEnabled ?? false,
allowedDomains: sandbox?.allowedDomains || [],
pendingDomains: sandbox?.pendingDomains || [],
}
}
async updateSandboxSettings(teamId: string, settings: SandboxSettings): Promise<SandboxSettings> {
async updateSandboxSettings(
teamId: string,
settings: UpdateSandboxSettingsRequest,
): Promise<SandboxSettings> {
const sandbox = await prisma.sandbox.upsert({
where: { teamId },
create: {
teamId,
allowedDomains: settings.allowedDomains,
pendingDomains: settings.pendingDomains,
networkSandboxEnabled: settings.networkSandboxEnabled ?? false,
allowedDomains: settings.allowedDomains ?? [],
pendingDomains: settings.pendingDomains ?? [],
},
update: {
allowedDomains: settings.allowedDomains,
pendingDomains: settings.pendingDomains,
...(settings.networkSandboxEnabled !== undefined && {
networkSandboxEnabled: settings.networkSandboxEnabled,
}),
...(settings.allowedDomains !== undefined && {
allowedDomains: settings.allowedDomains,
}),
...(settings.pendingDomains !== undefined && {
pendingDomains: settings.pendingDomains,
}),
},
})
return {
networkSandboxEnabled: sandbox.networkSandboxEnabled,
allowedDomains: sandbox.allowedDomains,
pendingDomains: sandbox.pendingDomains,
}
@@ -2,6 +2,7 @@ import { describe, it, expect, beforeEach } from 'vitest'
import { prisma } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import { VersionStackService } from './versionStack'
import { assetService } from '../asset/asset'
import { AssetType } from '@shumai/db'
describe('VersionStackService', () => {
@@ -207,4 +208,299 @@ describe('VersionStackService', () => {
expect(children.map((c) => c.id).includes(file3.id)).toBe(true)
})
})
describe('removeVersionFromStack', () => {
it('removes a version from a 3-version stack and turns it into a standalone file adjacent to the stack', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team' } })
const proj = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const user = await prisma.user.create({
data: { name: 'Test User', email: `test-${Date.now()}@example.com` },
})
const root = await prisma.asset.create({
data: {
name: 'root',
type: AssetType.folder,
status: 'uploaded',
projectId: proj.id,
creatorId: user.id,
},
})
const parent = await prisma.asset.create({
data: {
name: 'Parent Folder',
type: AssetType.folder,
projectId: proj.id,
parentId: root.id,
creatorId: user.id,
status: 'uploaded',
fileCount: 3,
},
})
const file1 = await prisma.asset.create({
data: {
name: 'file1.txt',
type: AssetType.file,
parentId: parent.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 100,
sortIndex: 'a0',
},
})
const file2 = await prisma.asset.create({
data: {
name: 'file2.txt',
type: AssetType.file,
parentId: parent.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 200,
},
})
const file3 = await prisma.asset.create({
data: {
name: 'file3.txt',
type: AssetType.file,
parentId: parent.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 300,
},
})
const stack = await service.createVersionStack({
fileIds: [file1.id, file2.id, file3.id],
projectId: proj.id,
creatorId: user.id,
})
// Stack should have 3 versions
expect(stack.fileCount).toBe(3)
expect(Number(stack.sizeByte)).toBe(600)
// Parent fileCount should be 1 (the stack)
const parentBefore = await prisma.asset.findUnique({ where: { id: parent.id } })
expect(parentBefore?.fileCount).toBe(1)
// Remove file2 from stack
await service.removeVersionFromStack({
stackId: stack.id,
fileId: file2.id,
})
// File2 should now be in parent folder
const updatedFile2 = await prisma.asset.findUnique({ where: { id: file2.id } })
expect(updatedFile2?.parentId).toBe(parent.id)
expect(updatedFile2?.sortIndex).toBeDefined()
expect(updatedFile2!.sortIndex! > stack.sortIndex!).toBe(true)
// Parent fileCount should be 2 (stack + file2)
const updatedParent = await prisma.asset.findUnique({ where: { id: parent.id } })
expect(updatedParent?.fileCount).toBe(2)
// Stack should still exist with 2 versions (file1 and file3)
const updatedStack = await prisma.asset.findUnique({ where: { id: stack.id } })
expect(updatedStack).toBeDefined()
expect(updatedStack?.fileCount).toBe(2)
expect(Number(updatedStack?.sizeByte)).toBe(400)
const remainingChildren = await prisma.asset.findMany({
where: { parentId: stack.id },
})
expect(remainingChildren).toHaveLength(2)
expect(remainingChildren.map((c) => c.id).sort()).toEqual([file1.id, file3.id].sort())
})
it('dissolves the version stack when removing down to 1 remaining version', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team' } })
const proj = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const user = await prisma.user.create({
data: { name: 'Test User', email: `test-${Date.now()}@example.com` },
})
const root = await prisma.asset.create({
data: {
name: 'root',
type: AssetType.folder,
status: 'uploaded',
projectId: proj.id,
creatorId: user.id,
},
})
const parent = await prisma.asset.create({
data: {
name: 'Parent Folder',
type: AssetType.folder,
projectId: proj.id,
parentId: root.id,
creatorId: user.id,
status: 'uploaded',
fileCount: 2,
},
})
const file1 = await prisma.asset.create({
data: {
name: 'file1.txt',
type: AssetType.file,
parentId: parent.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 100,
sortIndex: 'a0',
},
})
const file2 = await prisma.asset.create({
data: {
name: 'file2.txt',
type: AssetType.file,
parentId: parent.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 200,
},
})
const stack = await service.createVersionStack({
fileIds: [file1.id, file2.id],
projectId: proj.id,
creatorId: user.id,
})
// Remove file2 from stack
await service.removeVersionFromStack({
stackId: stack.id,
fileId: file2.id,
})
// Stack asset should be deleted
const deletedStack = await prisma.asset.findUnique({ where: { id: stack.id } })
expect(deletedStack).toBeNull()
// File1 should now be in parent folder and inherited stack's sortIndex
const updatedFile1 = await prisma.asset.findUnique({ where: { id: file1.id } })
expect(updatedFile1?.parentId).toBe(parent.id)
expect(updatedFile1?.sortIndex).toBe('a0')
// File2 should also be in parent folder
const updatedFile2 = await prisma.asset.findUnique({ where: { id: file2.id } })
expect(updatedFile2?.parentId).toBe(parent.id)
// Parent fileCount should be 2
const updatedParent = await prisma.asset.findUnique({ where: { id: parent.id } })
expect(updatedParent?.fileCount).toBe(2)
})
it('updates share link symlinks when normal asset becomes version stack and when stack dissolves back to normal asset', async () => {
const team = await prisma.team.create({ data: { name: 'Test Team' } })
const proj = await prisma.project.create({
data: { name: 'Test Project', teamId: team.id },
})
const user = await prisma.user.create({
data: { name: 'Test User', email: `test-${Date.now()}@example.com` },
})
const root = await prisma.asset.create({
data: {
name: 'root',
type: AssetType.folder,
status: 'uploaded',
projectId: proj.id,
creatorId: user.id,
},
})
const shareRoot = await prisma.asset.create({
data: {
name: 'share-root',
type: AssetType.share_root,
status: 'uploaded',
projectId: proj.id,
creatorId: user.id,
fileCount: 0,
},
})
const shareLink = await prisma.shareLink.create({
data: {
name: 'My Share',
projectId: proj.id,
rootFolderId: shareRoot.id,
creatorId: user.id,
},
})
const file1 = await prisma.asset.create({
data: {
name: 'file1.txt',
type: AssetType.file,
parentId: root.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 100,
},
})
const file2 = await prisma.asset.create({
data: {
name: 'file2.txt',
type: AssetType.file,
parentId: root.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
sizeByte: 200,
},
})
// Add file1 to share link (create symlink)
const symlink = await prisma.asset.create({
data: {
name: file1.name,
type: AssetType.symlink,
parentId: shareLink.rootFolderId,
targetId: file1.id,
projectId: proj.id,
creatorId: user.id,
status: 'uploaded',
},
})
// 1. Group file1 and file2 into a version stack
const stack = await service.createVersionStack({
fileIds: [file1.id, file2.id],
projectId: proj.id,
creatorId: user.id,
})
// Symlink in share link should now point to stack.id
const symlinkAfterStack = await prisma.asset.findUnique({ where: { id: symlink.id } })
expect(symlinkAfterStack?.targetId).toBe(stack.id)
// 2. Remove file2 from stack -> stack dissolves -> only file1 remains
await service.removeVersionFromStack({
stackId: stack.id,
fileId: file2.id,
})
// Symlink in share link should now point directly to file1.id and have file1's name
const symlinkAfterDissolve = await prisma.asset.findUnique({ where: { id: symlink.id } })
expect(symlinkAfterDissolve?.targetId).toBe(file1.id)
expect(symlinkAfterDissolve?.name).toBe(file1.name)
// Listing share link files returns file1 with correct name
const shareFiles = await assetService.listChildren({
assetId: shareLink.rootFolderId,
assetType: AssetType.file,
})
expect(shareFiles.data).toHaveLength(1)
expect(shareFiles.data[0].name).toBe(file1.name)
})
})
})
+128 -2
View File
@@ -1,7 +1,12 @@
import { generateKeyBetween } from 'jittered-fractional-indexing'
import { prisma } from '@shumai/db'
import { type Asset, AssetType } from '@shumai/db'
import { ChangeStackFileVersionParams, CreateVersionStackParams } from '@shumai/dtos'
import {
ChangeStackFileVersionParams,
CreateVersionStackParams,
RemoveStackVersionParams,
} from '@shumai/dtos'
import { dedupeSymlinksToTarget } from '../asset/symlink'
function generateSortIndex(previous?: string | null): string {
if (!previous) return generateKeyBetween(null, null)
@@ -95,6 +100,9 @@ export class VersionStackService {
},
})
// Update existing symlinks pointing to any of the stacked files
await dedupeSymlinksToTarget(tx, { targetIds: fileIds, newTargetId: stack.id })
return stack
})
}
@@ -127,7 +135,7 @@ export class VersionStackService {
if (beforeId === '-1') {
const lastFile = await tx.asset.findFirst({
where: { parentId: stackId },
where: { parentId: stackId, id: { not: fileId } },
orderBy: { sortIndex: 'desc' },
})
newSortIndex = generateKeyBetween(lastFile?.sortIndex || null, null)
@@ -145,6 +153,7 @@ export class VersionStackService {
const prevFile = await tx.asset.findFirst({
where: {
parentId: stackId,
id: { not: fileId },
sortIndex: {
lt: beforeFile.sortIndex!,
},
@@ -168,6 +177,123 @@ export class VersionStackService {
})
})
}
async removeVersionFromStack(params: RemoveStackVersionParams): Promise<void> {
const { stackId, fileId } = params
await this.prismaClient.$transaction(async (tx) => {
const stack = await tx.asset.findUnique({
where: { id: stackId },
})
if (!stack) {
throw new Error('stack not found')
}
if (stack.type !== AssetType.version_stack) {
throw new Error('asset is not a version stack')
}
if (!stack.parentId) {
throw new Error('stack has no parent')
}
const fileToRemove = await tx.asset.findUnique({
where: { id: fileId },
})
if (!fileToRemove) {
throw new Error('file not found')
}
if (fileToRemove.parentId !== stackId) {
throw new Error('file is not in the stack')
}
// Find next sibling in parent folder after the stack to insert the removed file adjacent to the stack
const nextSibling = await tx.asset.findFirst({
where: {
parentId: stack.parentId,
id: { not: stack.id },
sortIndex: {
gt: stack.sortIndex || '',
},
},
orderBy: { sortIndex: 'asc' },
})
let newSortIndex: string
try {
newSortIndex = generateKeyBetween(stack.sortIndex || null, nextSibling?.sortIndex || null)
} catch {
newSortIndex = generateKeyBetween(null, null)
}
await tx.asset.update({
where: { id: fileId },
data: {
parentId: stack.parentId,
sortIndex: newSortIndex,
},
})
// Increment parent folder fileCount for the newly standalone file
await tx.asset.update({
where: { id: stack.parentId },
data: {
fileCount: { increment: 1 },
},
})
// Remaining files in stack
const remainingFiles = await tx.asset.findMany({
where: { parentId: stackId, isDeleted: false, id: { not: fileId } },
orderBy: { sortIndex: 'asc' },
})
if (remainingFiles.length > 1) {
let totalSize = 0
for (const f of remainingFiles) {
totalSize += Number(f.sizeByte)
}
await tx.asset.update({
where: { id: stack.id },
data: {
fileCount: remainingFiles.length,
sizeByte: totalSize,
},
})
} else if (remainingFiles.length === 1) {
const lastChild = remainingFiles[0]
// Update symlinks pointing to stack.id to point to the single remaining child
await tx.asset.updateMany({
where: { targetId: stack.id, type: AssetType.symlink },
data: { targetId: lastChild.id, name: lastChild.name },
})
// Reparent the single remaining child to stack.parentId, keeping stack's sortIndex
await tx.asset.update({
where: { id: lastChild.id },
data: {
parentId: stack.parentId,
sortIndex: stack.sortIndex,
},
})
// Delete the stack asset (parent folder file count is unchanged: -1 stack, +1 remaining child)
await tx.asset.delete({
where: { id: stack.id },
})
} else {
await tx.asset.deleteMany({
where: { targetId: stack.id, type: AssetType.symlink },
})
await tx.asset.delete({
where: { id: stack.id },
})
await tx.asset.update({
where: { id: stack.parentId },
data: { fileCount: { decrement: 1 } },
})
}
})
}
}
export const versionStackService = new VersionStackService()
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/db",
"version": "0.3.6",
"version": "0.3.9",
"private": true,
"type": "module",
"main": "./src/index.ts",
@@ -0,0 +1,8 @@
-- Backfill autofillSource in config JSON where ai_autofill is true
UPDATE "metadata_fields"
SET "config" = jsonb_set(COALESCE("config", '{}'::jsonb), '{autofillSource}', '"CONTENT"')
WHERE "ai_autofill" = true;
UPDATE "metadata_fields"
SET "config" = jsonb_set(COALESCE("config", '{}'::jsonb), '{autofillSource}', '"NONE"')
WHERE "ai_autofill" = false OR "ai_autofill" IS NULL;
@@ -0,0 +1,12 @@
/*
Warnings:
- You are about to drop the column `autofill_context` on the `assets` table. All the data in the column will be lost.
- You are about to drop the column `ai_autofill` on the `metadata_fields` table. All the data in the column will be lost.
*/
-- AlterTable
ALTER TABLE "assets" DROP COLUMN "autofill_context";
-- AlterTable
ALTER TABLE "metadata_fields" DROP COLUMN "ai_autofill";
@@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "sandboxes" ADD COLUMN "network_sandbox_enabled" BOOLEAN NOT NULL DEFAULT false;
@@ -0,0 +1,2 @@
-- Data migration: set network_sandbox_enabled to true for existing legacy sandbox records
UPDATE "sandboxes" SET "network_sandbox_enabled" = true;
@@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "assets" ADD COLUMN "agentmd" TEXT;
@@ -0,0 +1,21 @@
/*
Warnings:
- You are about to drop the column `agentmd` on the `assets` table. All the data in the column will be lost.
*/
-- AlterTable
ALTER TABLE "assets" DROP COLUMN "agentmd";
-- CreateTable
CREATE TABLE "asset_agentmd" (
"asset_id" TEXT NOT NULL,
"content" TEXT NOT NULL,
"created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updated_at" TIMESTAMP(3) NOT NULL,
CONSTRAINT "asset_agentmd_pkey" PRIMARY KEY ("asset_id")
);
-- AddForeignKey
ALTER TABLE "asset_agentmd" ADD CONSTRAINT "asset_agentmd_asset_id_fkey" FOREIGN KEY ("asset_id") REFERENCES "assets"("id") ON DELETE CASCADE ON UPDATE CASCADE;
@@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "agents" ADD COLUMN "permission" "TeamMemberRole" NOT NULL DEFAULT 'reviewer';
@@ -0,0 +1,68 @@
-- CreateEnum
CREATE TYPE "QuotaScopeMode" AS ENUM ('all_members', 'each_member', 'selected_members');
-- CreateEnum
CREATE TYPE "QuotaPeriod" AS ENUM ('1hour', '5hour', '1day', '7day');
-- CreateEnum
CREATE TYPE "QuotaResourceType" AS ENUM ('agent_total_tokens', 'agent_cost', 'agent_skill_call_count', 'agent_mcp_call_count', 'agent_bash_call_count', 'agent_tool_call_count');
-- CreateTable
CREATE TABLE "quota_rules" (
"id" TEXT NOT NULL,
"team_id" TEXT NOT NULL,
"scope_mode" "QuotaScopeMode" NOT NULL,
"role" "TeamMemberRole",
"user_ids" JSONB,
"resource" "QuotaResourceType" NOT NULL,
"resource_data" JSONB,
"limit" DOUBLE PRECISION NOT NULL,
"period" "QuotaPeriod" NOT NULL,
"enabled" BOOLEAN NOT NULL DEFAULT true,
"created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updated_at" TIMESTAMP(3) NOT NULL,
CONSTRAINT "quota_rules_pkey" PRIMARY KEY ("id")
);
-- CreateTable
CREATE TABLE "quota_records" (
"id" TEXT NOT NULL,
"rule_id" TEXT NOT NULL,
"team_id" TEXT NOT NULL,
"user_id" TEXT,
"period_start" TIMESTAMP(3),
"period_end" TIMESTAMP(3),
"consumed" DOUBLE PRECISION NOT NULL DEFAULT 0,
"created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updated_at" TIMESTAMP(3) NOT NULL,
CONSTRAINT "quota_records_pkey" PRIMARY KEY ("id")
);
-- CreateIndex
CREATE INDEX "quota_rules_team_id_enabled_idx" ON "quota_rules"("team_id", "enabled");
-- CreateIndex
CREATE INDEX "quota_rules_team_id_resource_idx" ON "quota_rules"("team_id", "resource");
-- CreateIndex
CREATE INDEX "quota_records_team_id_user_id_idx" ON "quota_records"("team_id", "user_id");
-- CreateIndex
CREATE INDEX "quota_records_rule_id_idx" ON "quota_records"("rule_id");
-- CreateIndex
CREATE UNIQUE INDEX "quota_records_rule_id_user_id_key" ON "quota_records"("rule_id", "user_id");
-- AddForeignKey
ALTER TABLE "quota_rules" ADD CONSTRAINT "quota_rules_team_id_fkey" FOREIGN KEY ("team_id") REFERENCES "teams"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "quota_records" ADD CONSTRAINT "quota_records_rule_id_fkey" FOREIGN KEY ("rule_id") REFERENCES "quota_rules"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "quota_records" ADD CONSTRAINT "quota_records_team_id_fkey" FOREIGN KEY ("team_id") REFERENCES "teams"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "quota_records" ADD CONSTRAINT "quota_records_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE CASCADE ON UPDATE CASCADE;
@@ -0,0 +1,14 @@
/*
Warnings:
- The values [agent_skill_call_count] on the enum `QuotaResourceType` will be removed. If these variants are still used in the database, this will fail.
*/
-- AlterEnum
BEGIN;
CREATE TYPE "QuotaResourceType_new" AS ENUM ('agent_total_tokens', 'agent_cost', 'agent_mcp_call_count', 'agent_bash_call_count', 'agent_tool_call_count');
ALTER TABLE "quota_rules" ALTER COLUMN "resource" TYPE "QuotaResourceType_new" USING ("resource"::text::"QuotaResourceType_new");
ALTER TYPE "QuotaResourceType" RENAME TO "QuotaResourceType_old";
ALTER TYPE "QuotaResourceType_new" RENAME TO "QuotaResourceType";
DROP TYPE "public"."QuotaResourceType_old";
COMMIT;
+90 -9
View File
@@ -135,6 +135,27 @@ enum WatermarkFileStatus {
failed
}
enum QuotaScopeMode {
all_members
each_member
selected_members
}
enum QuotaPeriod {
one_hour @map("1hour")
five_hours @map("5hour")
one_day @map("1day")
seven_days @map("7day")
}
enum QuotaResourceType {
agent_total_tokens
agent_cost
agent_mcp_call_count
agent_bash_call_count
agent_tool_call_count
}
// ----------------------------------------------------------------------
// Models
// ----------------------------------------------------------------------
@@ -172,6 +193,7 @@ model User {
apiTokens ApiToken[] @relation("UserToApiToken")
aiUsages AiUsage[] @relation("UserToAiUsage")
auditLogs AuditLog[] @relation("UserToAuditLog")
quotaRecords QuotaRecord[] @relation("UserToQuotaRecord")
@@map("users")
}
@@ -258,16 +280,19 @@ model Team {
aiUsages AiUsage[] @relation("TeamToAiUsage")
auditLogs AuditLog[] @relation("TeamToAuditLog")
watermarkTemplates WatermarkTemplate[] @relation("TeamToWatermarkTemplate")
quotaRules QuotaRule[] @relation("TeamToQuotaRule")
quotaRecords QuotaRecord[] @relation("TeamToQuotaRecord")
@@map("teams")
}
model Sandbox {
id String @id @default(ulid())
allowedDomains String[] @default(["npmjs.org", "*.npmjs.org", "registry.npmjs.org", "registry.yarnpkg.com", "pypi.org", "*.pypi.org", "github.com", "*.github.com", "api.github.com", "raw.githubusercontent.com"])
pendingDomains String[] @default([]) @map("pending_domains")
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @updatedAt @map("updated_at")
id String @id @default(ulid())
networkSandboxEnabled Boolean @default(false) @map("network_sandbox_enabled")
allowedDomains String[] @default(["npmjs.org", "*.npmjs.org", "registry.npmjs.org", "registry.yarnpkg.com", "pypi.org", "*.pypi.org", "github.com", "*.github.com", "api.github.com", "raw.githubusercontent.com"])
pendingDomains String[] @default([]) @map("pending_domains")
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @updatedAt @map("updated_at")
teamId String @unique @map("team_id")
team Team @relation("TeamToSandbox", fields: [teamId], references: [id], onDelete: Cascade)
@@ -450,7 +475,6 @@ model Asset {
transcodeTaskId String? @map("transcode_task_id")
/// [MediaInfo]
media Json?
autofillContext String? @map("autofill_context")
isDeleted Boolean @default(false) @map("is_deleted")
deletedAt DateTime? @map("deleted_at")
sortIndex String? @map("sort_index")
@@ -490,6 +514,7 @@ model Asset {
shareLinkRootFolder ShareLink? @relation("ShareLinkToRootFolder")
agentSessions AgentSession[] @relation("AssetToAgentSession")
watermarkFiles WatermarkFile[] @relation("AssetToWatermarkFile")
agentMd AssetAgentMd? @relation("AssetToAgentMd")
@@map("assets")
@@index([type])
@@ -537,6 +562,17 @@ model AssetMetadataValue {
@@map("asset_metadata_values")
}
model AssetAgentMd {
assetId String @id @map("asset_id")
content String @db.Text
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @updatedAt @map("updated_at")
asset Asset @relation("AssetToAgentMd", fields: [assetId], references: [id], onDelete: Cascade)
@@map("asset_agentmd")
}
model AssetComment {
id String @id @default(ulid())
message String?
@@ -622,9 +658,8 @@ model MetadataField {
scope MetadataFieldScope?
/// [FieldConfig]
config Json?
readOnly Boolean @default(false) @map("read_only")
aiAutofill Boolean @default(false) @map("ai_autofill")
description String @default("")
readOnly Boolean @default(false) @map("read_only")
description String @default("")
teamId String? @map("team_id")
team Team? @relation("TeamToMetadataField", fields: [teamId], references: [id])
@@ -740,6 +775,7 @@ model Agent {
user User @relation(fields: [id], references: [id], onDelete: Cascade)
type AgentType
enabled Boolean @default(true)
permission TeamMemberRole @default(reviewer)
soul String? @db.Text
providerId String? @map("provider_id")
provider Provider? @relation("ProviderToAgent", fields: [providerId], references: [id], onDelete: SetNull)
@@ -1006,4 +1042,49 @@ model AuditLog {
@@map("audit_logs")
}
model QuotaRule {
id String @id @default(ulid())
teamId String @map("team_id")
scopeMode QuotaScopeMode @map("scope_mode")
role TeamMemberRole? @map("role")
/// [QuotaUserIds]
userIds Json? @map("user_ids")
resource QuotaResourceType @map("resource")
/// [QuotaResourceData]
resourceData Json? @map("resource_data")
limit Float @map("limit")
period QuotaPeriod @map("period")
enabled Boolean @default(true) @map("enabled")
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @updatedAt @map("updated_at")
team Team @relation("TeamToQuotaRule", fields: [teamId], references: [id], onDelete: Cascade)
records QuotaRecord[] @relation("QuotaRuleToRecord")
@@index([teamId, enabled])
@@index([teamId, resource])
@@map("quota_rules")
}
model QuotaRecord {
id String @id @default(ulid())
ruleId String @map("rule_id")
teamId String @map("team_id")
userId String? @map("user_id")
periodStart DateTime? @map("period_start")
periodEnd DateTime? @map("period_end")
consumed Float @default(0) @map("consumed")
createdAt DateTime @default(now()) @map("created_at")
updatedAt DateTime @updatedAt @map("updated_at")
rule QuotaRule @relation("QuotaRuleToRecord", fields: [ruleId], references: [id], onDelete: Cascade)
team Team @relation("TeamToQuotaRecord", fields: [teamId], references: [id], onDelete: Cascade)
user User? @relation("UserToQuotaRecord", fields: [userId], references: [id], onDelete: Cascade)
@@unique([ruleId, userId])
@@index([teamId, userId])
@@index([ruleId])
@@map("quota_records")
}
+15
View File
@@ -107,6 +107,11 @@ export type StorageKey = Prisma.StorageKeyModel
*
*/
export type AssetMetadataValue = Prisma.AssetMetadataValueModel
/**
* Model AssetAgentMd
*
*/
export type AssetAgentMd = Prisma.AssetAgentMdModel
/**
* Model AssetComment
*
@@ -222,3 +227,13 @@ export type AiUsage = Prisma.AiUsageModel
*
*/
export type AuditLog = Prisma.AuditLogModel
/**
* Model QuotaRule
*
*/
export type QuotaRule = Prisma.QuotaRuleModel
/**
* Model QuotaRecord
*
*/
export type QuotaRecord = Prisma.QuotaRecordModel

Some files were not shown because too many files have changed in this diff Show More