Compare commits

...
74 Commits
Author SHA1 Message Date
yiling 0a31659588 Release v0.3.3 2026-08-05 19:41:02 +08:00
Yiling-J 39a66dc569 Merge pull request #269 from shumaiOne/disable-project-member-team-role-dropdown
feat(webui): disable role dropdown for project-scoped members in team view
2026-08-05 19:06:28 +08:00
yiling 2a27e19b15 style(webui): expand members dialog max width to sm:max-w-xl 2026-08-05 18:54:51 +08:00
yiling f306229b21 style(webui): increase members dialog max width 2026-08-05 18:53:58 +08:00
yiling f5786f742b feat(webui): disable role dropdown for project-scoped members in team view 2026-08-05 18:50:55 +08:00
Yiling-J fe7e541585 Merge pull request #268 from shumaiOne/feat/e2e-member-permissions
test(e2e): add member permission change tests
2026-08-05 18:39:09 +08:00
yiling 47ecbdff6a fix(e2e): resolve lint rule for Playwright baseURL option 2026-08-05 18:33:10 +08:00
yiling 2dc0f08725 chore(e2e): default to chromium locally, run all browsers on CI 2026-08-05 18:28:46 +08:00
yiling e76ed19013 test(e2e): add member permission change tests 2026-08-05 17:51:27 +08:00
Yiling-J b7d3e32fb9 Merge pull request #267 from shumaiOne/feat/project-members-team-scope
feat(project): include team-scoped members in project member list and add 3-section dialog layout
2026-08-05 17:23:09 +08:00
yiling 94bda76c56 refactor(project): remove unnecessary explicit any cast in updateMemberRole 2026-08-05 17:14:00 +08:00
yiling 7586b8a44a feat(project): display flat member list for non-owners in members dialog 2026-08-05 16:52:16 +08:00
yiling d9a6734527 feat(project): include team-scoped members in project member list and add 3-section dialog layout 2026-08-05 16:39:19 +08:00
yiling 72aad56560 feat(project): include team-scoped members in project member list and refine dialog copy 2026-08-05 16:15:27 +08:00
Yiling-J ffeccaa514 Merge pull request #266 from shumaiOne/fix/field-reorder-dnd-kit
fix(webui): persist field order on drag and drop
2026-08-05 16:01:55 +08:00
yiling d73f7f81a1 fix(webui): persist field order on drag and drop
The handleDragEnd handlers in the Manage Fields dialog and Fields
dropdown guarded reordering on source.id !== target.id. With dnd-kit
react's OptimisticSortingPlugin (enabled by default), the drop target
always resolves to the dragged item itself, so the guard was never true
and the order API was never called.

Detect moves via the sortable-specific index/initialIndex properties on
the source instead, and reorder the rendered (grouped/search-filtered)
subset before merging back into the full field list. All field groups are
now reorderable in the dialog.
2026-08-05 15:52:58 +08:00
Yiling-J 1104ec36cc Merge pull request #265 from shumaiOne/fix/custom-field-options-and-placeholder
feat(webui): render select options in field creation mode and pick random option color
2026-08-05 15:28:56 +08:00
yiling ac5970c03e docs(webui): update field description placeholder text 2026-08-05 14:50:52 +08:00
yiling b568eac77d feat(webui): render select options in field creation mode and pick random option color 2026-08-05 14:44:30 +08:00
yiling bb9c53adad feat(agent): clarify create_file tool usage and context hint instructions 2026-08-05 12:01:04 +08:00
Yiling-J 29161f3a1a Merge pull request #264 from shumaiOne/feat/autofill-context
feat(agent): propagate autofill context from chat to autofill workflow
2026-08-05 11:25:04 +08:00
yiling b806b0e2ba refactor(agent): drop field/option ids from list_autofill_fields results 2026-08-05 11:02:25 +08:00
yiling 033652cde3 feat(agent): propagate autofill context from chat to autofill workflow
Add an optional 'context' parameter to the create_file and create_version
agent tools so the chat agent can pass generation/source context (e.g.
'Generated using gemini') to the AI metadata autofill workflow.

- Add Asset.autofillContext column, persisted in the same transaction as
  asset creation when context is provided
- Add new list_autofill_fields agent tool exposing autofillable metadata
  fields (name, type, description, options) per project
- Autofill workflow reads the stored context and includes it in the
  autofill AI prompt
- Add short chat system-prompt guidance to use list_autofill_fields and
  pass <=50 word context when creating files/versions
2026-08-05 10:33:02 +08:00
Yiling-J 30021b07d0 Merge pull request #263 from shumaiOne/feat/agent-create-file-from-content
feat(agent): allow create_file tool to create files directly from content
2026-08-04 21:50:19 +08:00
yiling 07ad0d2f65 feat(agent): allow create_file tool to create files directly from content
Add an optional 'data' field ({name, content}) to the create_file agent tool
so agents can create files without a local file (e.g. when bash is not
available). The existing 'path' upload mode is preserved; exactly one of
'path' or 'data' must be provided.

Extract mime detection helpers (getFileMimeType, readFileMimeType) into a
new file-mime module, keeping utils/mime.ts free of fs/path imports so it
stays compatible with the Temporal workflow bundle (agent-autofill imports
getProxyType from it). Refactor create_version to reuse the extracted
helpers.

Content uploads reuse s3Service.putObject; mime type is derived from the
filename extension with a text/plain fallback, and the name is sanitized
for the S3 key.
2026-08-04 21:16:33 +08:00
Yiling-J 5ef763fbae Merge pull request #262 from shumaiOne/feat/agent-bash-restriction-for-non-owners
feat(agent): restrict bash access for non-owner users
2026-08-04 18:21:22 +08:00
yiling e6fde25446 fix(agent): activate bash tool after skill load and fix chat stream
Two bugs found while testing skill loading as a non-owner:

1. The injected bash tool was never actually usable: AgentHarness.setTools
   only updates the tool registry unless activeToolNames is passed, so bash
   was missing from the active tool set sent to the model on the next turn.
   Pass the full post-update tool list as activeToolNames.

2. The active_tools_change session entry (written by setTools) has no chat
   representation, so mapEntryToMessage fell back to fabricating an empty
   user message that appeared as a stray empty bubble in the chat stream.
   Render active_tools_change as a typed custom message and skip entry
   types that have no chat representation instead of emitting empty text.
2026-08-04 17:01:47 +08:00
yiling dd2f8e68d9 fix(agent): fail closed when user role cannot be resolved
A userId that is not a team member previously resolved to isOwner=true
(role === undefined || role === 'owner'), bypassing bash restrictions.
Treat only flows without a user context (autofill etc.) and explicit
owner memberships as unrestricted; unknown users are now restricted.
2026-08-04 16:26:16 +08:00
yiling c938e84ccc feat(agent): restrict bash access for non-owner users
Editor/reviewer users can no longer ask the agent to run arbitrary bash
commands. Bash execution for them is gated behind approved team skills:

- Add required source param (enum user/skill) to the bash tool; commands
  with source=user are blocked when the user is not a team owner.
- Append a Restricted User Context instruction to the system prompt for
  non-owner users: never run user-requested bash, only skill-required
  commands with source=skill.
- Delay bash tool injection for editor/reviewer: it is only added after
  a skill is successfully loaded via read_skill (or restored when a
  skill was loaded earlier in the session). Team owners are unaffected.
2026-08-04 16:08:04 +08:00
Yiling-J 9745985f57 Merge pull request #261 from shumaiOne/feat/e2e-search-file-list
test(e2e): add search in file list and save-search-as-collection cases
2026-08-04 15:11:37 +08:00
yiling b645a29608 test(e2e): add search in file list and save-search-as-collection cases 2026-08-04 14:52:24 +08:00
Yiling-J deeb02351f Merge pull request #260 from shumaiOne/feat/e2e-file-domain-comments
feat(e2e): add file domain comment and draw tests
2026-08-04 11:25:01 +08:00
yiling c53919b891 ci: add system dependencies installation to app E2E CI job 2026-08-04 11:17:16 +08:00
yiling edf1f6a327 feat(e2e): add file domain comment and draw tests 2026-08-04 10:59:31 +08:00
Yiling-J 1afdbb671b Merge pull request #259 from shumaiOne/feat/project-e2e-tests
test(e2e): add project-level invite and file-move e2e tests
2026-08-03 18:33:48 +08:00
yiling 134d19d907 test(e2e): add project-level invite and file-move e2e tests
Add four project-level webapp e2e tests:
- invite a member to a project; the invitee only sees the invited project
- drag a file into a folder and a folder into another folder
- drag a file onto a file to create a version stack
- drag a file onto a version stack to add a new version

Supporting changes:
- expose rootFolderId on the project fixture
- add seedFolder/seedFile helpers and a cross-browser dragCard helper
  (WebKit requires pointer moves in awaited batches for dnd-kit activation)
- add project-members-trigger testid to the file-browser toolbar
- document the new test cases in the e2e README
2026-08-03 18:04:19 +08:00
yiling 043cde9fcc update agentsmd 2026-08-03 17:09:46 +08:00
Yiling-J 472ffddc99 Merge pull request #258 from shumaiOne/feat/web-e2e-file-share-collection
test(e2e): add file, share, and collection web app e2e tests
2026-08-03 17:07:08 +08:00
yiling 78eb840bf5 test(e2e): upload a 5px png instead of txt to avoid slow transcode 2026-08-03 16:45:38 +08:00
yiling 077536de98 test(e2e): move invite-member spec to the team domain 2026-08-03 16:39:51 +08:00
yiling 3789366d35 test(e2e): add file, share, and collection web app e2e tests
Add six domain-level web app e2e tests covering team member removal,
file upload/delete/restore, share link creation and password protection,
and collection creation. Introduce a parametrized 'file' fixture with
configurable media types (text/binary/image/video/pdf) for future
type-scoped tests, plus helpers for share APIs and team member seeding.

Also document all web app e2e test cases in apps/web/e2e/README.md and
require this documentation in AGENTS.md.
2026-08-03 16:34:37 +08:00
Yiling-J 5647231d7f Merge pull request #257 from shumaiOne/feat/e2e-domain-tests
test(e2e): add domain-based auth and project web app e2e tests
2026-08-03 15:42:32 +08:00
yiling b2a11c5ce9 docs: add Web App E2E Tests section to developer guide 2026-08-03 15:32:38 +08:00
yiling 4532deb753 test(e2e): add domain-based auth and project web app e2e tests 2026-08-03 15:24:21 +08:00
Yiling-J 6efa634f54 Merge pull request #256 from shumaiOne/fix/mention-popup-avatar-and-scroll
fix(webui): mention popup avatars, keyboard auto-scroll, and non-sticky section headers
2026-08-03 14:56:20 +08:00
yiling d696c39622 fix(webui): stop mention popup section headers from sticking and overlapping
Both Agents and Members header buttons had 'sticky top-0', so while
scrolling the 256px mention list the Agents header stayed pinned and the
Members header snapped to the same top position, covering it exactly.
Remove 'sticky top-0' so headers scroll away naturally with their
sections.
2026-08-03 14:47:43 +08:00
yiling 83d22d47a2 fix(webui): show member avatars and auto-scroll in mention popup
- Render real avatar images (with initials fallback) for users in the
  @-mention popup instead of a colored letter circle; bots keep the
  colored fallback since BotInfo has no image field.
- Auto-scroll the highlighted mention row into view when navigating
  the list with ArrowUp/ArrowDown keys.
2026-08-03 14:38:40 +08:00
Yiling-J 4436c3304d Merge pull request #255 from shumaiOne/refactor/use-pi-builtin-providers
refactor(core): replace generated provider files with pi-ai dynamic methods
2026-08-03 11:43:38 +08:00
yiling 2fee708863 feat(agent): implement DatabaseSessionStorage getSessionName and getSessionStats methods 2026-08-03 10:40:33 +08:00
yiling dbe3420b6c feat(agent): update pi packages to 0.82.1 and implement new SessionStorage interface methods 2026-08-03 10:25:10 +08:00
yiling 16d136b45a refactor(core): replace generated provider files with pi-ai dynamic methods 2026-08-03 10:00:21 +08:00
Yiling-J 2656a42c86 Merge pull request #254 from shumaiOne/feat/agent-preference-localstorage
feat(webui): persist agent preference in localStorage
2026-08-02 15:31:00 +08:00
yiling 15910a0bf4 feat(webui): persist agent preference in localStorage 2026-08-02 15:06:51 +08:00
Yiling-J 5458189c1f Merge pull request #253 from shumaiOne/refactor/replace-deprecated-get-model
refactor(agent): load models directly from database without pi fallback
2026-08-02 14:36:54 +08:00
yiling d3aef5f0c1 fix(agent): add required api field to test mock provider config 2026-08-02 14:30:28 +08:00
yiling 5946a679ea refactor(agent): load models directly from database without pi fallback 2026-08-02 14:26:03 +08:00
yiling a54c04e15a update providers 2026-08-01 21:38:42 +08:00
Yiling-J 0bccd13399 Merge pull request #252 from shumaiOne/test/add-missing-core-service-tests
test(core): add missing tests for methods introduced in 97069042
2026-08-01 20:58:15 +08:00
yiling 3b86d9b6d8 test(core): add missing tests for methods introduced in 97069042
Add comprehensive test coverage for 5 core service methods that were
added in the layered architecture refactor but lacked tests:

- AgentService.getAgent: found/not-found cases
- ProjectService.getUserProjects: team scope, project scope,
  multi-team aggregation, limit, and empty result cases
- SkillService.getSkill: full field mapping and not-found cases
- TeamService.hasWritableRoleInAnyTeam: owner, editor, reviewer,
  and no-membership cases
- UserService (new file): getUserById and createGuestUser
2026-08-01 20:44:34 +08:00
Yiling-J 1600949e4a Merge pull request #251 from shumaiOne/feat/audit-log-support
feat(audit): add audit log support for APIs and WebUI dashboard
2026-08-01 19:19:20 +08:00
yiling 2f5b968935 fix(api): fix eslint any type assertion in file.test.ts 2026-08-01 16:35:57 +08:00
yiling 97069042b2 refactor(api): enforce layered architecture by moving db queries to core services 2026-08-01 16:25:01 +08:00
yiling fb66166b49 feat(core): wrap audit log creation in try catch to prevent blocking APIs 2026-08-01 15:50:35 +08:00
yiling b0d8ecb589 refactor(dtos): define AuditAction enum in dtos package to decouple from db 2026-08-01 15:28:23 +08:00
yiling 2d61fae699 refactor(db): consolidate audit log migration into single add_audit_log migration 2026-08-01 15:19:53 +08:00
yiling 5ef7716c9c feat(audit): change audit log action to string at db level and split file/folder actions 2026-08-01 14:49:08 +08:00
yiling 6d80f06c22 refactor(core): update getAssetContext to throw error on missing asset 2026-08-01 11:21:56 +08:00
yiling 0324b95c7e feat(api): add missing audit log calls to API endpoints 2026-08-01 11:03:50 +08:00
yiling 7dfb2c7f2f refactor(dtos): use @shumai/db/enums across DTO definitions 2026-08-01 10:47:41 +08:00
yiling 11fc76e56b refactor(dtos): import AuditAction from @shumai/db/enums subpath 2026-08-01 10:45:10 +08:00
yiling 52f85fcd15 fix(dtos): decouple AuditAction from @shumai/db to prevent leaking DB dependencies to WebUI 2026-08-01 10:41:57 +08:00
yiling 118107ebc9 feat(audit): add audit log support for APIs and WebUI dashboard 2026-08-01 10:39:31 +08:00
Yiling-J 7a83f7d406 Merge pull request #250 from shumaiOne/feat/agent-harness-retry
feat(agent): enable LLM API call retries in AgentHarness
2026-08-01 09:57:22 +08:00
yiling c2d25bd2f1 feat(agent): enable LLM API call retries in AgentHarness 2026-08-01 09:49:43 +08:00
254 changed files with 10834 additions and 20492 deletions
+7 -2
View File
@@ -89,7 +89,7 @@ jobs:
- name: Run video player harness tests
env:
E2E_SKIP_APP_SERVER: true
run: bun run test:e2e --project=harness-${{ matrix.project }}
run: bunx playwright test --project=harness-${{ matrix.project }}
- name: Upload Playwright report
if: ${{ !cancelled() }}
@@ -125,11 +125,16 @@ jobs:
- name: Install dependencies
run: bun install
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
- name: Install Playwright browser (${{ matrix.project }})
run: bunx playwright install --with-deps ${{ matrix.project }}
- name: Run app E2E tests
run: bun run test:e2e --project=app-${{ matrix.project }} --no-deps
run: bunx playwright test --project=app-${{ matrix.project }} --no-deps
- name: Upload Playwright report
if: ${{ !cancelled() }}
+1
View File
@@ -3,6 +3,7 @@ dist
.bun
src/generated
packages/db/src/generated
packages/core/src/generated
src/ui/components/ui
packages/webui/paraglide
*.md
+7
View File
@@ -282,6 +282,13 @@ describe('Team API', () => {
- **Mocking**: Mock ONLY AI API calls. Do not mock S3, databases, or media/transcode extraction services.
- Mock the AI response by spying on `AgentHarness.prototype.prompt`:
### Web App E2E Tests
- Located in `apps/web/e2e/**/*.spec.ts`, organized by domain under `tests/<domain>/` (e.g. `auth`, `project`).
- Run via `bun run test:e2e`.
- **Fixtures**: Use the `owner`, `project`, and `file` fixtures for setup — they seed data through API calls/DB (no slow UI setup). You can add more fixtures if necessary.
- **Documentation**: Every test case MUST be documented in [`apps/web/e2e/README.md`](apps/web/e2e/README.md). Add or update the corresponding entry in the README whenever you add, rename, or remove a spec.
## Prisma Configuration & Migrations
- Schema: `packages/db/prisma/schema.prisma`
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent-app",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/cli",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/transcode-app",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"bin": {
+104
View File
@@ -0,0 +1,104 @@
# Web App E2E Tests
Fullstack end-to-end tests for the Shumai web app. They run against a real backend
(pgvector container + local S3 storage) served on `http://localhost:5200` and are
executed with Playwright via `bun run test:e2e`.
## Structure
```
apps/web/e2e/
├── fixtures.ts # prisma / owner / project / file fixtures
├── serve.ts # starts the test DB container + web app
├── global-teardown.ts # stops the container and cleans up storage
├── helpers/
│ ├── auth.ts # signup / auth-state injection helpers
│ ├── project.ts # project creation helpers
│ ├── files.ts # share link API helpers
│ ├── team.ts # team member seeding helpers
│ └── ui.ts # common UI flows (signup, login, members dialog)
└── tests/<domain>/ # domain-scoped specs (auth, team, project)
```
## Fixtures
- `prisma` — auto fixture that truncates all tables before each test. Also the
direct way to read/write DB state for assertions and seeding.
- `owner` — an authenticated team owner (seeded through the API), with the session
cookie and auth state injected into the browser context, opened on the team page.
- `project` — `owner` plus a project created through the API (`projectId`,
`projectName`).
- `file` — `project` plus a seeded processed file asset in the project root
(`fileId`, `fileName`). The media kind is configurable per test via
`fileOptions` (default `binary`):
```ts
// default binary file (no extension, no proxy)
test('...', async ({ file }) => {})
// type-scoped file for future viewer/transcode tests
test('...', { fileOptions: { mediaType: 'image' } }, async ({ file }) => {})
```
| mediaType | filename | notes |
|---|---|---|
| `binary` (default) | `test-file-<ts>` | never transcoded, no proxy |
| `text` | `test-file-<ts>.txt` | gets a PDF proxy in real usage |
| `image` | `test-file-<ts>.png` | |
| `video` | `test-file-<ts>.mp4` | |
| `pdf` | `test-file-<ts>.pdf` | |
| `audio` | `test-file-<ts>.wav` | |
## Test Cases
### auth
| Test | File |
|---|---|
| Sign up as the first user and become the team owner | `tests/auth/signup.spec.ts` |
| Log in with existing credentials | `tests/auth/login.spec.ts` |
### team
| Test | File |
|---|---|
| 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` |
### project
| Test | File |
|---|---|
| Owner creates a project with a cover image | `tests/project/create-project.spec.ts` |
| Owner uploads a file via the "Upload File" context menu action | `tests/project/upload-file.spec.ts` |
| Owner deletes a file, finds it in recently deleted, and restores it | `tests/project/delete-restore.spec.ts` |
| Owner creates a share link from a file context menu and lands on the share page | `tests/project/create-share-link.spec.ts` |
| Owner protects a share with a password; guests must enter it to view | `tests/project/share-password.spec.ts` |
| Owner creates a collection from the sidebar; the collection shows project files | `tests/project/create-collection.spec.ts` |
| Owner invites a member to a project; the member only sees the invited project | `tests/project/invite-member.spec.ts` |
| Owner changes a project member role in the members dialog and permissions update | `tests/project/change-member-role.spec.ts` |
| Owner adds team member to project with role override and permissions enforce project role | `tests/project/role-override.spec.ts` |
| Owner deletes a member from project via the members dialog and project access is revoked | `tests/project/remove-member.spec.ts` |
| 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 searches the file list by an English name keyword | `tests/project/search-file-list.spec.ts` |
| Owner searches the file list by Chinese, Japanese, and Korean name keywords | `tests/project/search-file-list.spec.ts` |
| Owner searches the file list with a keyword and a filter condition | `tests/project/search-file-list.spec.ts` |
| Owner saves a search result as a collection | `tests/project/save-search-collection.spec.ts` |
### file
| Test | File |
|---|---|
| Create a comment on a binary file | `tests/file/binary-comment.spec.ts` |
| Upload a txt file, wait for transcode, and create a comment with draw | `tests/file/txt-draw-comment.spec.ts` |
| Upload an image file, wait for transcode, and create a comment with draw | `tests/file/image-draw-comment.spec.ts` |
| Upload a video file, wait for transcode, and create a comment with draw at a non-zero timestamp | `tests/file/video-draw-comment.spec.ts` |
| Upload an audio file, wait for transcode, and create a comment at a non-zero timestamp | `tests/file/audio-timestamp-comment.spec.ts` |
## Conventions
- Seed data via fixtures/API/DB; use the UI only for the flow under test.
- Each test truncates all tables via the auto `prisma` fixture, so fixtures must
create their data per-test.
- App projects run with `workers: 1` because all tests share a single database.
- Every new test case MUST be documented in this README.
+137 -1
View File
@@ -1,13 +1,25 @@
import { test as base } from '@playwright/test'
import type { BrowserContext, Page } from '@playwright/test'
import { PrismaClient } from '../../../packages/db/src/generated/prisma/client'
import { PrismaPg } from '@prisma/adapter-pg'
import { Pool } from 'pg'
import * as fs from 'fs'
import * as path from 'path'
import { fileURLToPath } from 'url'
import {
E2E_APP_URL,
E2E_PASSWORD,
apiSignup,
injectAuthState,
resolveTeamId,
uniqueEmail,
} from './helpers/auth'
import { apiCreateProject, uniqueProjectName } from './helpers/project'
import { apiUploadFile } from './helpers/files'
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)) {
@@ -22,7 +34,73 @@ if (fs.existsSync(envPath)) {
})
}
export const test = base.extend<{ prisma: PrismaClient }>({
export interface OwnerFixture {
/** Page opened in a browser context logged in as the team owner. */
page: Page
context: BrowserContext
teamId: string
email: string
password: string
}
export interface ProjectFixture extends OwnerFixture {
projectId: string
projectName: string
/** The project's root folder asset id. */
rootFolderId: string
}
/** The media kind of a seeded test file. */
export type FileMediaType = 'text' | 'binary' | 'image' | 'video' | 'pdf' | 'audio'
export interface FileFixtureOptions {
/** Defaults to `binary` (no extension, never transcoded, no proxy). */
mediaType?: FileMediaType
}
export interface FileFixture extends ProjectFixture {
fileId: string
fileName: string
fileMediaType: FileMediaType
}
const FILE_TYPE_MAP: Record<FileMediaType, { ext: string; mime: string }> = {
text: { ext: 'txt', mime: 'text/plain' },
binary: { ext: '', mime: 'application/octet-stream' },
image: { ext: 'png', mime: 'image/png' },
video: { ext: 'mp4', mime: 'video/mp4' },
pdf: { ext: 'pdf', mime: 'application/pdf' },
audio: { ext: 'wav', mime: 'audio/wav' },
}
function getFileBuffer(mediaType: FileMediaType): Buffer {
switch (mediaType) {
case 'image':
return fs.readFileSync(path.join(fixturesDir, 'small.png'))
case 'video':
return fs.readFileSync(path.join(fixturesDir, 'small.mp4'))
case 'audio':
return fs.readFileSync(path.join(fixturesDir, 'small.wav'))
case 'pdf':
return fs.readFileSync(path.join(fixturesDir, 'test.pdf'))
case 'text':
return Buffer.from(
'Sample text content for PDF proxy transcode test.\nSecond line of text content.',
)
case 'binary':
default:
return Buffer.from('binary-file-content-sample')
}
}
export const test = base.extend<{
prisma: PrismaClient
owner: OwnerFixture
project: ProjectFixture
fileOptions: FileFixtureOptions
file: FileFixture
}>({
fileOptions: [{ mediaType: 'binary' }, { option: true }],
prisma: [
// eslint-disable-next-line no-empty-pattern
async ({}, use) => {
@@ -51,6 +129,64 @@ export const test = base.extend<{ prisma: PrismaClient }>({
},
{ auto: true },
],
/**
* Sets up an authenticated team owner through the API (fast, no UI): creates
* the user, stores the session cookie in the browser context, injects the
* persisted auth state, and opens the team page.
*/
owner: async ({ browser }, use) => {
const context = await browser.newContext({
// eslint-disable-next-line @typescript-eslint/naming-convention
baseURL: E2E_APP_URL,
})
const email = uniqueEmail('owner')
const password = E2E_PASSWORD
try {
// Create the owner via the API so the session cookie lands in the context
const user = await apiSignup(context.request, email, password)
await injectAuthState(context, user)
const teamId = await resolveTeamId(context.request)
// Open the app already logged in on the team page
const page = await context.newPage()
await page.goto(`/teams/${teamId}`)
await use({ page, context, teamId, email, password })
} finally {
await context.close()
}
},
/** Sets up an authenticated team owner plus a project created via the API. */
project: async ({ owner, prisma }, use) => {
const name = uniqueProjectName()
const project = await apiCreateProject(owner.context.request, owner.teamId, name)
const projectRow = await prisma.project.findUnique({ where: { id: project.id } })
const rootFolderId = projectRow?.rootFolderId
if (!rootFolderId) throw new Error('Project has no root folder')
await use({ ...owner, projectId: project.id, projectName: name, rootFolderId })
},
/**
* Sets up an owner + project with an uploaded file asset under the
* project root folder via the API upload task endpoints. The media type is configurable per test via
* `fileOptions` (defaults to `binary`).
*/
file: async ({ project, fileOptions }, use) => {
const mediaType: FileMediaType = fileOptions.mediaType ?? 'binary'
const { ext, mime } = FILE_TYPE_MAP[mediaType]
const fileName = `test-file-${Date.now()}${ext ? `.${ext}` : ''}`
const buffer = getFileBuffer(mediaType)
const uploaded = await apiUploadFile(
project.context.request,
project.teamId,
project.rootFolderId,
fileName,
mime,
buffer,
)
await use({ ...project, fileId: uploaded.fileId, fileName, fileMediaType: mediaType })
},
})
export { expect } from '@playwright/test'
+31
View File
@@ -0,0 +1,31 @@
import type { PrismaClient } from '../../../../packages/db/src/generated/prisma/client'
/**
* Seeds a folder asset directly through the database (fast, no UI). The folder
* is placed under `parentId` (usually a project's root folder).
*/
export async function seedFolder(
prisma: PrismaClient,
projectId: string,
parentId: string,
name: string,
) {
return prisma.asset.create({
data: { name, type: 'folder', status: 'processed', projectId, parentId },
})
}
/**
* Seeds a processed file asset directly through the database (fast, no UI).
* The file is placed under `parentId` (a folder or a version stack).
*/
export async function seedFile(
prisma: PrismaClient,
projectId: string,
parentId: string,
name: string,
) {
return prisma.asset.create({
data: { name, type: 'file', status: 'processed', sizeByte: 10, projectId, parentId },
})
}
+76
View File
@@ -0,0 +1,76 @@
import type { APIRequestContext, BrowserContext } from '@playwright/test'
/** Base URL of the fullstack app under test (must match playwright.config.ts). */
export const E2E_APP_URL = process.env.E2E_APP_URL || 'http://localhost:5200'
export const E2E_PASSWORD = 'Password123!'
export function uniqueEmail(prefix = 'user'): string {
return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 8)}@shumai.local`
}
export interface AuthUser {
id: string
email: string
name: string
}
interface SignupResponse {
token?: string | null
user?: AuthUser
error?: { message?: string } | null
}
/**
* Creates a user through the better-auth API.
* When passed a `context.request`, the session cookie is stored in the browser
* context and the user is logged in.
*/
export async function apiSignup(
request: APIRequestContext,
email: string,
password: string,
options: { inviteCode?: string } = {},
): Promise<AuthUser> {
const res = await request.post('/api/auth/sign-up/email', {
data: {
name: email,
email,
password,
...(options.inviteCode ? { inviteCode: options.inviteCode } : {}),
},
})
if (!res.ok()) {
throw new Error(`Signup API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as SignupResponse
if (!body.user) {
throw new Error(`Signup API returned no user: ${JSON.stringify(body)}`)
}
return body.user
}
/**
* Injects the persisted auth state (zustand `auth-storage`) so the app
* considers the session logged in. The session cookie must already be present
* in the context (created via `context.request`).
*/
export async function injectAuthState(context: BrowserContext, user: AuthUser): Promise<void> {
await context.addInitScript((u) => {
localStorage.setItem('auth-storage', JSON.stringify({ state: { user: u }, version: 0 }))
}, user)
}
/** Resolves the id of the first team for the authenticated request context. */
export async function resolveTeamId(request: APIRequestContext): Promise<string> {
const res = await request.get('/api/teams')
if (!res.ok()) {
throw new Error(`GET /api/teams failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as { data: { id: string }[] }
const teamId = body.data?.[0]?.id
if (!teamId) {
throw new Error(`No team found in /api/teams response: ${JSON.stringify(body)}`)
}
return teamId
}
+37
View File
@@ -0,0 +1,37 @@
import type { Locator, Page } from '@playwright/test'
/**
* Performs a pointer drag from one card to another. dnd-kit v6 uses a
* `PointerSensor` with a 10px distance activation constraint, and WebKit only
* reliably starts the drag when pointer moves are delivered in separate,
* awaited batches (a single fast `mouse.move(steps)` can be coalesced before
* the drag activates, losing the drop). Moves are therefore chunked with
* intermediate waits so the activation and drag move handlers run between
* batches on every browser.
*/
export async function dragCard(page: Page, source: Locator, target: Locator): Promise<void> {
const sourceBox = (await source.boundingBox())!
const targetBox = (await target.boundingBox())!
if (!sourceBox || !targetBox) {
throw new Error('Drag source or target has no bounding box')
}
const fromX = sourceBox.x + sourceBox.width / 2
const fromY = sourceBox.y + sourceBox.height / 2
const toX = targetBox.x + targetBox.width / 2
const toY = targetBox.y + targetBox.height / 2
await page.mouse.move(fromX, fromY)
await page.mouse.down()
// Move in several chunks so the dnd-kit sensor activates mid-drag
const chunks = 8
for (let i = 1; i <= chunks; i++) {
const x = fromX + ((toX - fromX) * i) / chunks
const y = fromY + ((toY - fromY) * i) / chunks
await page.mouse.move(x, y)
await page.waitForTimeout(15)
}
await page.mouse.up()
}
+121
View File
@@ -0,0 +1,121 @@
import type { APIRequestContext, Locator, Page } from '@playwright/test'
interface CreateShareResponse {
id?: string
name?: string
}
/**
* Locates a file/folder card by its name. File names are rendered as
* `EditableText` inputs (not text nodes), so `getByText` does not match them.
* The returned locator points at the card wrapper div (right-clickable to open
* the card context menu).
*/
export function fileCard(page: Page, name: string): Locator {
return page
.locator('div.group')
.filter({ has: page.locator(`input[value="${name}"]`) })
.first()
}
/** Creates a share link through the API for the authenticated request context. */
export async function apiCreateShare(
request: APIRequestContext,
projectId: string,
name: string,
): Promise<{ id: string; name: string }> {
const res = await request.post(`/api/projects/${projectId}/shares`, {
data: { name },
})
if (!res.ok()) {
throw new Error(`Create share API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as CreateShareResponse
if (!body.id || !body.name) {
throw new Error(`Create share returned an unexpected response: ${JSON.stringify(body)}`)
}
return { id: body.id, name: body.name }
}
/** Adds assets to a share link through the API. */
export async function apiAddAssetsToShare(
request: APIRequestContext,
shareId: string,
assetIds: string[],
): Promise<void> {
const res = await request.post(`/api/shares/${shareId}/assets`, {
data: { assetIds },
})
if (!res.ok()) {
throw new Error(`Add assets to share API failed (${res.status()}): ${await res.text()}`)
}
}
/** Uploads a file asset through the official API upload task endpoints. */
export async function apiUploadFile(
request: APIRequestContext,
teamId: string,
parentId: string,
fileName: string,
mimeType: string,
buffer: Buffer,
): Promise<{ fileId: string; fileName: string }> {
const tempId = `temp-${Date.now()}`
const createRes = await request.post(`/api/teams/${teamId}/upload/tasks`, {
data: {
parentId,
files: [
{
id: tempId,
name: fileName,
type: 'file',
size: buffer.length,
mediaType: mimeType,
children: [],
},
],
},
})
if (!createRes.ok()) {
throw new Error(`Create upload task failed (${createRes.status()}): ${await createRes.text()}`)
}
const taskData = (await createRes.json()) as {
taskId: string
presignedUrls: Array<{ id: string; fileId: string; url: string }>
createdAssets?: Array<{ tempId: string; assetId: string }>
}
const presigned = taskData.presignedUrls.find((p) => p.id === tempId)
const createdAssetId =
taskData.createdAssets?.find((c) => c.tempId === tempId)?.assetId || presigned?.fileId
if (!presigned || !createdAssetId) {
throw new Error('Create upload task did not return presigned URL or asset ID')
}
// Upload file buffer to presigned URL
const uploadRes = await request.put(presigned.url, {
headers: {
'Content-Type': mimeType,
},
data: buffer,
})
if (!uploadRes.ok()) {
throw new Error(
`Upload to S3 presigned URL failed (${uploadRes.status()}): ${await uploadRes.text()}`,
)
}
// Confirm upload task
const confirmRes = await request.patch(`/api/teams/${teamId}/upload/tasks/${taskData.taskId}`, {
data: {
fileId: createdAssetId,
status: 'success',
},
})
if (!confirmRes.ok()) {
throw new Error(
`Confirm upload task failed (${confirmRes.status()}): ${await confirmRes.text()}`,
)
}
return { fileId: createdAssetId, fileName }
}
+29
View File
@@ -0,0 +1,29 @@
import type { APIRequestContext } from '@playwright/test'
export function uniqueProjectName(): string {
return `Project ${Date.now()}-${Math.random().toString(36).slice(2, 6)}`
}
interface CreateProjectResponse {
id?: string
name?: string
}
/** Creates a project through the API for the authenticated request context. */
export async function apiCreateProject(
request: APIRequestContext,
teamId: string,
name: string,
): Promise<{ id: string; name: string }> {
const res = await request.post(`/api/teams/${teamId}/projects`, {
data: { name },
})
if (!res.ok()) {
throw new Error(`Create project API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as CreateProjectResponse
if (!body.id || !body.name) {
throw new Error(`Create project returned an unexpected response: ${JSON.stringify(body)}`)
}
return { id: body.id, name: body.name }
}
+121
View File
@@ -0,0 +1,121 @@
import type { Browser, BrowserContext } from '@playwright/test'
import type { PrismaClient } from '../../../../packages/db/src/generated/prisma/client'
import { E2E_APP_URL, E2E_PASSWORD, apiSignup, injectAuthState, uniqueEmail } from './auth'
export interface SeededMember {
userId: string
email: string
teamMemberId: string
context?: BrowserContext
}
/**
* Seeds a new user with a team membership of the given role.
* If `browser` and `ownerContext` are provided, generates an invite code via the owner's request context
* so `apiSignup` succeeds and session cookies/auth state are initialized.
*/
export async function seedTeamMember(
prisma: PrismaClient,
teamId: string,
role: 'owner' | 'editor' | 'reviewer',
browser?: Browser,
ownerContext?: BrowserContext,
): Promise<SeededMember> {
if (browser && ownerContext) {
const inviteRes = await ownerContext.request.post(`/api/teams/${teamId}/invite`, {
data: { role: role === 'owner' ? 'editor' : role },
})
if (!inviteRes.ok()) {
throw new Error(`Failed to generate team invite code: ${await inviteRes.text()}`)
}
const inviteBody = (await inviteRes.json()) as { code: string }
// eslint-disable-next-line @typescript-eslint/naming-convention
const context = await browser.newContext({ baseURL: E2E_APP_URL })
const email = uniqueEmail(`member-${role}`)
const user = await apiSignup(context.request, email, E2E_PASSWORD, {
inviteCode: inviteBody.code,
})
await injectAuthState(context, user)
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user.id } },
})
if (tm && tm.role !== role) {
await prisma.teamMember.update({
where: { id: tm.id },
data: { role, scope: 'team' },
})
}
return { userId: user.id, email, teamMemberId: tm!.id, context }
}
const email = uniqueEmail(`member-${role}`)
const user = await prisma.user.create({
data: { name: email, email, password: 'Password123!' },
})
const tm = await prisma.teamMember.create({
data: { teamId, userId: user.id, role, scope: 'team' },
})
return { userId: user.id, email, teamMemberId: tm.id }
}
/**
* Seeds a new user with a project membership of the given role.
* If `browser` and `ownerContext` are provided, generates an invite code via the owner's request context
* so `apiSignup` succeeds and session cookies/auth state are initialized.
*/
export async function seedProjectMember(
prisma: PrismaClient,
teamId: string,
projectId: string,
role: 'editor' | 'reviewer',
scope: 'team' | 'project' = 'project',
browser?: Browser,
ownerContext?: BrowserContext,
): Promise<SeededMember & { projectMemberId: string }> {
if (browser && ownerContext) {
const inviteRes = await ownerContext.request.post(`/api/projects/${projectId}/invite`, {
data: { role },
})
if (!inviteRes.ok()) {
throw new Error(`Failed to generate project invite code: ${await inviteRes.text()}`)
}
const inviteBody = (await inviteRes.json()) as { code: string }
// eslint-disable-next-line @typescript-eslint/naming-convention
const context = await browser.newContext({ baseURL: E2E_APP_URL })
const email = uniqueEmail(`proj-member-${role}`)
const user = await apiSignup(context.request, email, E2E_PASSWORD, {
inviteCode: inviteBody.code,
})
await injectAuthState(context, user)
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user.id } },
})
const pm = await prisma.projectMember.findFirst({
where: { projectId, teamMemberId: tm!.id },
})
if (pm && pm.role !== role) {
await prisma.projectMember.update({
where: { id: pm.id },
data: { role },
})
}
return { userId: user.id, email, teamMemberId: tm!.id, projectMemberId: pm!.id, context }
}
const email = uniqueEmail(`proj-member-${role}`)
const user = await prisma.user.create({
data: { name: email, email, password: 'Password123!' },
})
const tm = await prisma.teamMember.create({
data: { teamId, userId: user.id, role: scope === 'team' ? 'editor' : 'reviewer', scope },
})
const pm = await prisma.projectMember.create({
data: { projectId, teamMemberId: tm.id, role },
})
return { userId: user.id, email, teamMemberId: tm.id, projectMemberId: pm.id }
}
+55
View File
@@ -0,0 +1,55 @@
import { expect, type Locator, type Page } from '@playwright/test'
export function parseTeamIdFromUrl(url: string): string {
const match = url.match(/\/teams\/([^/]+)/)
if (!match) throw new Error(`Could not parse teamId from URL: ${url}`)
return match[1]
}
/** Performs the signup UI flow and waits for the redirect to the team page. */
export async function signupViaUi(page: Page, email: string, password: string): Promise<string> {
await page.goto('/signup')
await page.fill('#email', email)
await page.fill('#password', password)
await page.click('button[type="submit"]')
await page.waitForURL(/\/teams\/[^/]+/)
return parseTeamIdFromUrl(page.url())
}
/** Performs the login UI flow and waits for the redirect to the team page. */
export async function loginViaUi(page: Page, email: string, password: string): Promise<string> {
await page.goto('/login')
await page.fill('#email', email)
await page.fill('#password', password)
await page.click('button[type="submit"]')
await page.waitForURL(/\/teams\/[^/]+/)
return parseTeamIdFromUrl(page.url())
}
/** Opens the team members dialog from the team page header. */
export async function openMembersDialog(page: Page): Promise<Locator> {
await page.getByTestId('team-members-trigger').click()
const dialog = page.locator('[role="dialog"]')
await expect(dialog).toBeVisible()
return dialog
}
/** Opens the project members dialog from the project file-browser toolbar. */
export async function openProjectMembersDialog(page: Page): Promise<Locator> {
await page.getByTestId('project-members-trigger').click()
const dialog = page.locator('[role="dialog"]')
await expect(dialog).toBeVisible()
return dialog
}
/** Clicks "Generate Link" in the members dialog and returns the invite link. */
export async function generateInviteLink(dialog: Locator): Promise<string> {
await dialog.getByRole('button', { name: 'Generate Link' }).click()
const inviteInput = dialog.locator('input[readonly]')
await expect(inviteInput).toBeVisible()
const inviteLink = await inviteInput.inputValue()
if (!inviteLink.includes('inviteCode=')) {
throw new Error(`Unexpected invite link: ${inviteLink}`)
}
return inviteLink
}
+18
View File
@@ -0,0 +1,18 @@
import { expect, test } from '../../fixtures'
import { apiSignup, E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { loginViaUi } from '../../helpers/ui'
test('should log in with existing credentials', async ({ page, request }) => {
const email = uniqueEmail('login')
const password = E2E_PASSWORD
// Seed an existing user through the API (setup, not the flow under test)
await apiSignup(request, email, password)
// The default page context is a fresh, logged-out session
await loginViaUi(page, email, password)
// The logged-in user lands on their team page
await expect(page).toHaveURL(/\/teams\/[^/]+/)
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
})
+24
View File
@@ -0,0 +1,24 @@
import { expect, test } from '../../fixtures'
import { E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { signupViaUi } from '../../helpers/ui'
test('should sign up as the first user and become the team owner', async ({ page, prisma }) => {
const email = uniqueEmail('signup')
const password = E2E_PASSWORD
const teamId = await signupViaUi(page, email, password)
// The first user is redirected to their single team
await expect(page).toHaveURL(/\/teams\/[^/]+/)
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
// The new user exists and is the owner of the team
const user = await prisma.user.findUnique({ where: { email } })
expect(user).not.toBeNull()
const membership = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user!.id } },
})
expect(membership?.role).toBe('owner')
expect(membership?.scope).toBe('team')
})
@@ -0,0 +1,68 @@
import { expect, test } from '../../fixtures'
test.use({ fileOptions: { mediaType: 'audio' } })
test('upload an audio file, create a comment at a non-zero timestamp', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Audio timestamp comment ${Date.now()}`
// Wait for audio transcode completion
await expect
.poll(
async () => {
const asset = await prisma.asset.findUnique({ where: { id: fileId } })
return asset?.status
},
{ timeout: 30_000 },
)
.toBe('processed')
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Wait for audio/video media element to be visible
const mediaEl = page.locator('audio, video').first()
await expect(mediaEl).toBeVisible({ timeout: 30_000 })
// Seek media element to non-zero timestamp (e.g. 1 second)
await page.evaluate(() => {
const el = document.querySelector('audio, video') as HTMLMediaElement | null
if (el) el.currentTime = 1
})
await page.waitForTimeout(500)
// Type comment text and send
const input = page.locator('[contenteditable="true"]').first()
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Ensure comment is persisted in DB before page reload
await expect
.poll(async () => {
return prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
})
.not.toBeNull()
// Reload page
await page.reload()
// Click the comment in right sidebar
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// Verify media element jumped to timestamp
await expect
.poll(async () => {
return page.evaluate(() => {
const el = document.querySelector('audio, video') as HTMLMediaElement | null
return el ? el.currentTime : 0
})
})
.toBeGreaterThan(0)
})
@@ -0,0 +1,32 @@
import { expect, test } from '../../fixtures'
test('create a comment on a binary file', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Binary comment ${Date.now()}`
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Wait for file page & comments sidebar to load
const input = page.locator('[contenteditable="true"]').first()
await expect(input).toBeVisible()
// Type comment text and send
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Refresh page and click the comment
await page.reload()
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// DB verification
const commentInDb = await prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
expect(commentInDb).not.toBeNull()
})
@@ -0,0 +1,71 @@
import { expect, test } from '../../fixtures'
test.use({ fileOptions: { mediaType: 'image' } })
test('upload an image file, create a comment with draw', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Image draw comment ${Date.now()}`
// Wait for transcode completion
await expect
.poll(
async () => {
const asset = await prisma.asset.findUnique({ where: { id: fileId } })
return asset?.status
},
{ timeout: 30_000 },
)
.toBe('processed')
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Verify image is visible
await expect(page.locator('img').first()).toBeVisible({ timeout: 30_000 })
// Toggle drawing mode
const drawToggleBtn = page.getByTitle('Toggle Annotation')
await expect(drawToggleBtn).toBeVisible()
await drawToggleBtn.click()
// Perform drawing gesture on canvas overlay
const canvas = page.locator('.konvajs-content canvas').first()
await expect(canvas).toBeVisible()
const box = await canvas.boundingBox()
if (box) {
const startX = box.x + box.width * 0.3
const startY = box.y + box.height * 0.3
const endX = box.x + box.width * 0.6
const endY = box.y + box.height * 0.6
await page.mouse.move(startX, startY)
await page.mouse.down()
await page.mouse.move(endX, endY, { steps: 5 })
await page.mouse.up()
}
// Type comment text and send
const input = page.locator('[contenteditable="true"]').first()
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Ensure comment is persisted in DB before page reload
await expect
.poll(async () => {
return prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
})
.not.toBeNull()
// Reload page and click comment in right sidebar
await page.reload()
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// Verify draw annotation is rendered on canvas
await expect(page.locator('.konvajs-content canvas').first()).toBeVisible()
})
@@ -0,0 +1,75 @@
import { expect, test } from '../../fixtures'
test.use({ fileOptions: { mediaType: 'text' } })
test('upload a txt file, create a comment with draw', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Txt draw comment ${Date.now()}`
// Wait for background transcode worker to complete (txt -> pdf proxy)
await expect
.poll(
async () => {
const asset = await prisma.asset.findUnique({ where: { id: fileId } })
return asset?.status
},
{ timeout: 60_000 },
)
.toBe('processed')
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Verify PDF viewer container or page is loaded
await expect(page.locator('.pdf-viewer, canvas, [data-testid="pdf-viewer"]').first()).toBeVisible(
{
timeout: 30_000,
},
)
// Toggle drawing mode
const drawToggleBtn = page.getByTitle('Toggle Annotation')
await expect(drawToggleBtn).toBeVisible()
await drawToggleBtn.click()
// Perform drawing gesture on canvas overlay
const canvas = page.locator('.konvajs-content canvas').first()
await expect(canvas).toBeVisible()
const box = await canvas.boundingBox()
if (box) {
const startX = box.x + box.width * 0.3
const startY = box.y + box.height * 0.3
const endX = box.x + box.width * 0.6
const endY = box.y + box.height * 0.6
await page.mouse.move(startX, startY)
await page.mouse.down()
await page.mouse.move(endX, endY, { steps: 5 })
await page.mouse.up()
}
// Type comment text and send
const input = page.locator('[contenteditable="true"]').first()
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Ensure comment is persisted in DB before page reload
await expect
.poll(async () => {
return prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
})
.not.toBeNull()
// Reload page and click comment in right sidebar
await page.reload()
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// Verify draw annotation is rendered on canvas
await expect(page.locator('.konvajs-content canvas').first()).toBeVisible()
})
@@ -0,0 +1,93 @@
import { expect, test } from '../../fixtures'
test.use({ fileOptions: { mediaType: 'video' } })
test('upload a video file, create a comment with draw at a non-zero timestamp', async ({
file,
prisma,
}) => {
const { page, projectId, fileId } = file
const commentText = `Video draw comment ${Date.now()}`
// Wait for video transcode completion
await expect
.poll(
async () => {
const asset = await prisma.asset.findUnique({ where: { id: fileId } })
return asset?.status
},
{ timeout: 60_000 },
)
.toBe('processed')
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Wait for video element to be visible
const video = page.locator('video').first()
await expect(video).toBeVisible({ timeout: 30_000 })
// Seek video to non-zero timestamp (e.g. 1 second)
await page.evaluate(() => {
const v = document.querySelector('video')
if (v) v.currentTime = 1
})
await page.waitForTimeout(500)
// Toggle drawing mode
const drawToggleBtn = page.getByTitle('Toggle Annotation')
await expect(drawToggleBtn).toBeVisible()
await drawToggleBtn.click()
// Perform drawing gesture on canvas overlay
const canvas = page.locator('.konvajs-content canvas').first()
await expect(canvas).toBeVisible()
const box = await canvas.boundingBox()
if (box) {
const startX = box.x + box.width * 0.3
const startY = box.y + box.height * 0.3
const endX = box.x + box.width * 0.6
const endY = box.y + box.height * 0.6
await page.mouse.move(startX, startY)
await page.mouse.down()
await page.mouse.move(endX, endY, { steps: 5 })
await page.mouse.up()
}
// Type comment text and send
const input = page.locator('[contenteditable="true"]').first()
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Ensure comment is persisted in DB before page reload
await expect
.poll(async () => {
return prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
})
.not.toBeNull()
// Reload page
await page.reload()
// Click the comment in right sidebar
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// Verify video jumped to timestamp and draw annotation is shown on canvas
await expect
.poll(async () => {
return page.evaluate(() => {
const v = document.querySelector('video')
return v ? v.currentTime : 0
})
})
.toBeGreaterThan(0)
await expect(page.locator('.konvajs-content canvas').first()).toBeVisible()
})
@@ -0,0 +1,64 @@
import { expect, test } from '../../fixtures'
import { openProjectMembersDialog } from '../../helpers/ui'
import { seedProjectMember } from '../../helpers/team'
test('owner changes a project member role in the members dialog and permissions update', async ({
project,
browser,
prisma,
}) => {
const { page, teamId, projectId, context } = project
const member = await seedProjectMember(
prisma,
teamId,
projectId,
'reviewer',
'project',
browser,
context,
)
// Open the project detail page and open the project members dialog
await page.goto(`/projects/${projectId}`)
const dialog = await openProjectMembersDialog(page)
const memberRow = dialog
.locator('div.flex.items-center.justify-between')
.filter({ hasText: member.email })
await expect(memberRow).toBeVisible()
// Click role dropdown trigger for this member (currently Reviewer)
await memberRow.getByRole('button', { name: /Reviewer/i }).click()
// Select "Editor" from the dropdown menu
await page.getByRole('menuitemradio', { name: 'Editor' }).click()
// Verify UI displays updated role "Editor"
await expect(memberRow.getByRole('button', { name: /Editor/i })).toBeVisible()
// DB verification: projectMember role is updated to editor
const pm = await prisma.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId,
teamMemberId: member.teamMemberId,
},
},
})
expect(pm?.role).toBe('editor')
// Functional verification: project member can now perform edit API operations on the project
const memberContext = member.context!
const memberPage = await memberContext.newPage()
try {
await memberPage.goto(`/teams/${teamId}`)
// Verify edit permission on project via API (PUT /api/projects/:projectId requires Edit permission)
const res = await memberContext.request.put(`/api/projects/${projectId}`, {
data: { enableNotification: true },
})
expect(res.status()).toBe(200)
} finally {
await memberContext.close()
}
})
@@ -0,0 +1,31 @@
import { expect, test } from '../../fixtures'
import { fileCard } from '../../helpers/files'
test('owner creates a collection from the sidebar and the collection shows project files', async ({
file,
prisma,
}) => {
const { page, projectId, fileName } = file
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, fileName)).toBeVisible()
// Create a collection via the sidebar "+" button
await page.getByTestId('create-collection').click()
await expect(page).toHaveURL(/\/collections\/[^/]+/)
await expect(page.getByText('Collection created')).toBeVisible()
// The collection page is a recursive files-only view of the project
await expect(fileCard(page, fileName)).toBeVisible()
const collection = await prisma.collection.findFirst({ where: { projectId } })
expect(collection).not.toBeNull()
expect(collection?.name).toBe('Untitled Collection')
const project = await prisma.project.findUnique({ where: { id: projectId } })
expect(collection?.filter).toMatchObject({
sourceFolderId: project?.rootFolderId,
searchFilter: { conditions: [], recursively: true },
})
})
@@ -1,4 +1,4 @@
import { expect, test } from './fixtures'
import { expect, test } from '../../fixtures'
import * as fs from 'fs'
import * as path from 'path'
import { fileURLToPath } from 'url'
@@ -19,57 +19,34 @@ test.afterAll(async () => {
}
})
test('should sign up and create a project with a cover image', async ({ page }) => {
const email = `test-${Date.now()}@shumai.local`
const password = 'Password123!'
// 1. Sign Up Flow
await page.goto('/signup')
await expect(page).toHaveURL(/\/signup/)
// Fill credentials
await page.fill('#email', email)
await page.fill('#password', password)
// Submit sign up
await page.click('button[type="submit"]')
// Wait for the automatic redirect to the team page (since only one team exists)
await expect(page).toHaveURL(/\/teams\/[^/]+/)
// 2. Create Project Flow
// Click the "Create Project" button on the dashboard
await page.click('button:has-text("Create Project")')
test('owner should create a project with a cover image', async ({ owner, prisma }) => {
const { page, teamId } = owner
const projectName = `My Project ${Date.now()}`
// Open the create project dialog
await page.getByRole('button', { name: 'Create Project' }).click()
const dialog = page.locator('[role="dialog"]')
await expect(dialog).toBeVisible()
// Fill project name
const projectName = `My Project ${Date.now()}`
// Fill in project details and upload a cover image
await dialog.locator('#name').fill(projectName)
// Set cover image
await dialog.locator('input[type="file"]').setInputFiles(tempImgPath)
// Wait for image upload completion and preview
await expect(dialog.locator('img[alt="Cover Preview"]')).toBeVisible({ timeout: 15_000 })
// Click submit in dialog
// Submit and land on the project page
await dialog.locator('button[type="submit"]').click()
// Wait for navigation to the project page
await expect(page).toHaveURL(/\/projects\/[^/]+/)
// Verify project name appears in the project view
await expect(page.locator(`text=${projectName}`).first()).toBeVisible()
// 3. Verification on Dashboard
// Navigate back to the dashboard via sidebar
// Back on the dashboard the new project card is visible with its cover
await page.click('button[aria-label="Dashboard"]')
// Wait for dashboard URL
await expect(page).toHaveURL(/\/teams\/[^/]+/)
// Verify the project card is visible and displays the cover image with project name alt text
await expect(page.locator(`img[alt="${projectName}"]`)).toBeVisible()
// The project was persisted for the owner's team
const project = await prisma.project.findFirst({ where: { name: projectName } })
expect(project).not.toBeNull()
expect(project?.teamId).toBe(teamId)
})
@@ -0,0 +1,36 @@
import { expect, test } from '../../fixtures'
import { fileCard } from '../../helpers/files'
test('owner creates a share link from a file context menu and lands on the share page', async ({
file,
prisma,
}) => {
const { page, projectId, fileName, fileId } = file
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, fileName)).toBeVisible()
// Create a share link for the file through the context menu
await fileCard(page, fileName).click({ button: 'right' })
await page.getByRole('menuitem', { name: 'Create Share Link' }).click()
// The toast offers a "View" action that navigates to the share page
const toast = page.locator('[data-sonner-toast]').filter({ hasText: 'Share link created' })
await expect(toast).toBeVisible()
await toast.getByRole('button', { name: 'View' }).click()
await expect(page).toHaveURL(/\/projects\/[^/]+\/shares\/[^/]+/)
// The shared file is listed in the share contents
await expect(fileCard(page, fileName)).toBeVisible()
// DB: the share exists and the file is symlinked under the share root
const share = await prisma.shareLink.findFirst({ where: { projectId } })
expect(share).not.toBeNull()
const symlink = await prisma.asset.findFirst({
where: { parentId: share?.rootFolderId, targetId: fileId },
})
expect(symlink).not.toBeNull()
expect(symlink?.type).toBe('symlink')
})
@@ -0,0 +1,45 @@
import { expect, test } from '../../fixtures'
import { fileCard } from '../../helpers/files'
test('owner deletes a file, finds it in recently deleted, and restores it', async ({
file,
prisma,
}) => {
const { page, projectId, fileName, fileId } = file
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, fileName)).toBeVisible()
// Delete through the context menu + confirmation dialog
await fileCard(page, fileName).click({ button: 'right' })
await page.getByRole('menuitem', { name: 'Delete' }).click()
const deleteDialog = page.getByRole('alertdialog')
await expect(deleteDialog.getByText('Delete Asset?')).toBeVisible()
await deleteDialog.getByRole('button', { name: 'Delete' }).click()
await expect(fileCard(page, fileName)).not.toBeVisible()
let asset = await prisma.asset.findUnique({ where: { id: fileId } })
expect(asset?.isDeleted).toBe(true)
expect(asset?.deletedAt).not.toBeNull()
// Navigate to the Recently Deleted view
await page.getByText('Recently Deleted').click()
await expect(page).toHaveURL(/\/recently-deleted/)
await expect(fileCard(page, fileName)).toBeVisible()
// Restore through the context menu
await fileCard(page, fileName).click({ button: 'right' })
await page.getByRole('menuitem', { name: 'Restore' }).click()
await expect(fileCard(page, fileName)).not.toBeVisible()
asset = await prisma.asset.findUnique({ where: { id: fileId } })
expect(asset?.isDeleted).toBe(false)
expect(asset?.deletedAt).toBeNull()
// Back at the project root the file is visible again
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, fileName)).toBeVisible()
})
@@ -0,0 +1,79 @@
import { expect, test } from '../../fixtures'
import { E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { apiCreateProject, uniqueProjectName } from '../../helpers/project'
import { generateInviteLink, openProjectMembersDialog } from '../../helpers/ui'
test('owner invites a member to a project; the member only sees the invited project', async ({
project,
browser,
prisma,
}) => {
const { page, context, teamId, projectId, projectName } = project
// A second project the invitee must NOT see
const secondProject = await apiCreateProject(context.request, teamId, uniqueProjectName())
// 1. Owner opens the project members dialog and generates an invite link
await page.goto(`/projects/${projectId}`)
await expect(page.getByTestId('project-members-trigger')).toBeVisible()
const dialog = await openProjectMembersDialog(page)
const inviteLink = await generateInviteLink(dialog)
const inviteCode = new URL(inviteLink).searchParams.get('inviteCode')
if (!inviteCode) {
throw new Error(`Invite link is missing the inviteCode param: ${inviteLink}`)
}
const origin = new URL(page.url()).origin
expect(inviteLink.startsWith(`${origin}/signup?inviteCode=`)).toBe(true)
// 2. The invitee signs up through the invite link in a brand-new session
const inviteeContext = await browser.newContext()
const inviteePage = await inviteeContext.newPage()
const inviteeEmail = uniqueEmail('project-invitee')
try {
await inviteePage.goto(inviteLink)
// The invite context banner is shown on the signup page
await expect(inviteePage.getByText(/invited you to join/)).toBeVisible()
await inviteePage.fill('#email', inviteeEmail)
await inviteePage.fill('#password', E2E_PASSWORD)
await inviteePage.click('button[type="submit"]')
// The invitee is redirected to the shared team page
await expect(inviteePage).toHaveURL(/\/teams\/[^/]+/)
// 3. The invitee only sees the invited project, not the second one
await expect(inviteePage.getByText(projectName, { exact: true })).toBeVisible()
await expect(inviteePage.getByText(secondProject.name, { exact: true })).not.toBeVisible()
// 4. Direct access to the other project is denied (API returns 403)
const res = await inviteeContext.request.get(`/api/projects/${secondProject.id}`)
expect(res.status()).toBe(403)
// 5. Opening the other project URL renders the router error boundary
await inviteePage.goto(`/projects/${secondProject.id}`)
await expect(inviteePage.getByText('Something went wrong!')).toBeVisible()
} finally {
await inviteeContext.close()
}
// 6. DB: the invitee is a project-scoped team member of exactly the invited project
const inviteeUser = await prisma.user.findUnique({ where: { email: inviteeEmail } })
expect(inviteeUser).not.toBeNull()
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: inviteeUser!.id } },
})
expect(tm?.scope).toBe('project')
const projectMemberships = await prisma.projectMember.findMany({
where: { teamMemberId: tm!.id },
})
expect(projectMemberships).toHaveLength(1)
expect(projectMemberships[0].projectId).toBe(projectId)
const invite = await prisma.invite.findUnique({ where: { code: inviteCode } })
expect(invite?.used).toBe(true)
expect(invite?.projectId).toBe(projectId)
})
@@ -0,0 +1,66 @@
import { expect, test } from '../../fixtures'
import { seedFile, seedFolder } from '../../helpers/assets'
import { dragCard } from '../../helpers/dnd'
import { fileCard } from '../../helpers/files'
test('owner moves a file into a folder and a folder into another folder', async ({
project,
prisma,
}) => {
const { page, projectId, rootFolderId } = project
const folderA = await seedFolder(prisma, projectId, rootFolderId, `e2e-folder-a-${Date.now()}`)
const folderB = await seedFolder(prisma, projectId, rootFolderId, `e2e-folder-b-${Date.now()}`)
const file1 = await seedFile(prisma, projectId, rootFolderId, `e2e-move-file-${Date.now()}`)
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, file1.name)).toBeVisible()
await expect(fileCard(page, folderA.name)).toBeVisible()
await expect(fileCard(page, folderB.name)).toBeVisible()
// 1. Drag the file onto folder A -> the file moves into folder A
await dragCard(page, fileCard(page, file1.name), fileCard(page, folderA.name))
await expect
.poll(async () => {
const asset = await prisma.asset.findUnique({ where: { id: file1.id } })
return asset?.parentId
})
.toBe(folderA.id)
// The file is no longer in the project root
await expect(fileCard(page, file1.name)).not.toBeVisible()
// Opening folder A shows the moved file
await fileCard(page, folderA.name).dblclick()
await expect(page).toHaveURL(new RegExp(`/projects/${projectId}/folders/${folderA.id}`))
await expect(fileCard(page, file1.name)).toBeVisible()
// 2. Back at the root, drag folder A onto folder B -> folder A moves into folder B
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, folderA.name)).toBeVisible()
await expect(fileCard(page, folderB.name)).toBeVisible()
await dragCard(page, fileCard(page, folderA.name), fileCard(page, folderB.name))
await expect
.poll(async () => {
const asset = await prisma.asset.findUnique({ where: { id: folderA.id } })
return asset?.parentId
})
.toBe(folderB.id)
// Folder A is no longer in the project root
await expect(fileCard(page, folderA.name)).not.toBeVisible()
// Opening folder B shows folder A inside it
await fileCard(page, folderB.name).dblclick()
await expect(page).toHaveURL(new RegExp(`/projects/${projectId}/folders/${folderB.id}`))
await expect(fileCard(page, folderA.name)).toBeVisible()
// 3. DB: folder/file counters are kept in sync on the moved folders
const movedFolderA = await prisma.asset.findUnique({ where: { id: folderA.id } })
expect(movedFolderA?.fileCount).toBe(1) // file1 moved in
const movedFolderB = await prisma.asset.findUnique({ where: { id: folderB.id } })
expect(movedFolderB?.fileCount).toBe(1) // folderA moved in
})
@@ -0,0 +1,69 @@
import { expect, test } from '../../fixtures'
import { openProjectMembersDialog } from '../../helpers/ui'
import { seedProjectMember } from '../../helpers/team'
test('owner deletes a member from project via the members dialog and project access is revoked', async ({
project,
browser,
prisma,
}) => {
const { page, teamId, projectId, context } = project
const member = await seedProjectMember(
prisma,
teamId,
projectId,
'editor',
'project',
browser,
context,
)
// Open project detail page and project members dialog
await page.goto(`/projects/${projectId}`)
const dialog = await openProjectMembersDialog(page)
const memberRow = dialog
.locator('div.flex.items-center.justify-between')
.filter({ hasText: member.email })
await expect(memberRow).toBeVisible()
// Click the remove (trash) button for this member
await memberRow.getByRole('button').last().click()
// Confirm removal in the alert dialog
const removeDialog = page.getByRole('alertdialog')
await expect(removeDialog).toBeVisible()
await expect(removeDialog.getByRole('heading', { name: 'Remove Member' })).toBeVisible()
await removeDialog.getByRole('button', { name: 'Remove' }).click()
// The member is removed from project members and now appears under "Add members from other projects"
await expect(memberRow.getByRole('button', { name: 'Add to Project' })).toBeVisible()
// DB verification: projectMember record is deleted
const pm = await prisma.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId,
teamMemberId: member.teamMemberId,
},
},
})
expect(pm).toBeNull()
// Functional verification: removed member can no longer access the project
const memberContext = member.context!
const memberPage = await memberContext.newPage()
try {
await memberPage.goto(`/teams/${teamId}`)
// API request to project returns 403 Forbidden
const res = await memberContext.request.get(`/api/projects/${projectId}`)
expect(res.status()).toBe(403)
// Direct navigation renders error boundary
await memberPage.goto(`/projects/${projectId}`)
await expect(memberPage.getByText('Something went wrong!')).toBeVisible()
} finally {
await memberContext.close()
}
})
@@ -0,0 +1,72 @@
import { expect, test } from '../../fixtures'
import { openProjectMembersDialog } from '../../helpers/ui'
import { seedTeamMember } from '../../helpers/team'
test('owner adds team member to project with role override and permissions enforce project role', async ({
project,
browser,
prisma,
}) => {
const { page, teamId, projectId, context } = project
// Seed a team-scoped member with role 'editor'
const member = await seedTeamMember(prisma, teamId, 'editor', browser, context)
// Open the project page and project members dialog
await page.goto(`/projects/${projectId}`)
const dialog = await openProjectMembersDialog(page)
// Find the team member in the "Add team member to project" section
const teamMemberSectionRow = dialog
.locator('div.flex.items-center.justify-between')
.filter({ hasText: member.email })
await expect(teamMemberSectionRow).toBeVisible()
// Select "Reviewer" role override from the dropdown in that row (initially "Editor")
await teamMemberSectionRow.getByRole('button', { name: /Editor/i }).click()
await page.getByRole('menuitemradio', { name: 'Reviewer' }).click()
// Click "Set Role" button to save the project role override
await teamMemberSectionRow.getByRole('button', { name: 'Set Role' }).click()
// DB verification: projectMember record exists with role 'reviewer'
await expect
.poll(
async () =>
prisma.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId,
teamMemberId: member.teamMemberId,
},
},
}),
{ timeout: 10000 },
)
.not.toBeNull()
const pm = await prisma.projectMember.findUnique({
where: {
projectIdTeamMemberId: {
projectId,
teamMemberId: member.teamMemberId,
},
},
})
expect(pm?.role).toBe('reviewer')
// Functional verification: team editor's permissions in this project are overridden to reviewer (edit returns 403)
const memberContext = member.context!
const memberPage = await memberContext.newPage()
try {
await memberPage.goto(`/teams/${teamId}`)
// Project edit action is rejected with 403 because the project role override is 'reviewer'
const res = await memberContext.request.put(`/api/projects/${projectId}`, {
data: { enableNotification: true },
})
expect(res.status()).toBe(403)
} finally {
await memberContext.close()
}
})
@@ -0,0 +1,59 @@
import { expect, test } from '../../fixtures'
import { apiUploadFile, fileCard } from '../../helpers/files'
test('owner saves a search result as a collection', async ({ project, prisma }) => {
const { page, context, teamId, rootFolderId, projectId } = project
const matching = 'quarterly-report-2024'
const other = 'annual-budget-2024'
for (const name of [matching, other]) {
await apiUploadFile(
context.request,
teamId,
rootFolderId,
name,
'application/octet-stream',
Buffer.alloc(0),
)
}
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, matching)).toBeVisible()
await expect(fileCard(page, other)).toBeVisible()
// Run a keyword search
await page.getByRole('button', { name: 'Search' }).click()
const dialog = page.getByRole('dialog')
await expect(dialog).toBeVisible()
await dialog.getByPlaceholder('Search records by name...').fill('report')
await dialog.getByRole('button', { name: 'Search' }).click()
await expect(dialog.getByText(matching, { exact: true })).toBeVisible()
await expect(dialog.getByText(other, { exact: true })).not.toBeVisible()
// Save the search result as a collection; the dialog closes and navigates
// to the new collection page
await dialog.getByRole('button', { name: 'Save as collection' }).click()
await expect(page).toHaveURL(new RegExp(`/projects/${projectId}/collections/[^/]+`))
await expect(page.getByText('Collection saved')).toBeVisible()
// The collection page is a files-only view of the saved search
await expect(fileCard(page, matching)).toBeVisible()
await expect(fileCard(page, other)).not.toBeVisible()
// DB: the collection stores the keyword search as its filter
const collection = await prisma.collection.findFirst({ where: { projectId } })
expect(collection).not.toBeNull()
expect(collection?.name).toBe('report')
expect(collection?.filter).toMatchObject({
sourceFolderId: rootFolderId,
searchFilter: {
conditions: [{ field: 'name', operator: 'contains', value: 'report' }],
recursively: true,
query: 'report',
isSemantic: false,
},
})
})
@@ -0,0 +1,162 @@
import type { APIRequestContext } from '@playwright/test'
import { expect, test } from '../../fixtures'
import { apiUploadFile, fileCard } from '../../helpers/files'
const BINARY_MIME = 'application/octet-stream'
/** Uploads an empty binary file into the project root through the API. */
async function uploadBinaryFile(
request: APIRequestContext,
teamId: string,
rootFolderId: string,
name: string,
size = 0,
): Promise<void> {
await apiUploadFile(request, teamId, rootFolderId, name, BINARY_MIME, Buffer.alloc(size))
}
test('owner searches the file list by an English name keyword', async ({ project }) => {
const { page, projectId } = project
const report2024 = 'quarterly-report-2024'
const report2025 = 'quarterly-report-2025'
const budget2024 = 'annual-budget-2024'
for (const name of [report2024, report2025, budget2024]) {
await uploadBinaryFile(project.context.request, project.teamId, project.rootFolderId, name)
}
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, report2024)).toBeVisible()
await expect(fileCard(page, report2025)).toBeVisible()
await expect(fileCard(page, budget2024)).toBeVisible()
// Open the search dialog from the toolbar
await page.getByRole('button', { name: 'Search' }).click()
const dialog = page.getByRole('dialog')
await expect(dialog).toBeVisible()
// Keyword-only search (no filter conditions)
await dialog.getByPlaceholder('Search records by name...').fill('report')
await dialog.getByRole('button', { name: 'Search' }).click()
await expect(dialog.getByText(report2024, { exact: true })).toBeVisible()
await expect(dialog.getByText(report2025, { exact: true })).toBeVisible()
await expect(dialog.getByText(budget2024, { exact: true })).not.toBeVisible()
// Apply the search to the file list
await dialog.getByRole('button', { name: 'Apply and Close' }).click()
await expect(dialog).not.toBeVisible()
await expect(fileCard(page, report2024)).toBeVisible()
await expect(fileCard(page, report2025)).toBeVisible()
await expect(fileCard(page, budget2024)).not.toBeVisible()
})
test('owner searches the file list by Chinese, Japanese, and Korean name keywords', async ({
project,
}) => {
const { page, projectId } = project
const zhDoc = '产品需求文档-2024'
const zhDesign = '产品设计文档-2025'
const jaDoc = '日本語ドキュメント'
const koDoc = '한국어문서'
for (const name of [zhDoc, zhDesign, jaDoc, koDoc]) {
await uploadBinaryFile(project.context.request, project.teamId, project.rootFolderId, name)
}
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, zhDoc)).toBeVisible()
const searchByName = async (keyword: string, visible: string[], hidden: string[]) => {
await page.getByRole('button', { name: 'Search' }).click()
const dialog = page.getByRole('dialog')
await expect(dialog).toBeVisible()
await dialog.getByPlaceholder('Search records by name...').fill(keyword)
await dialog.getByRole('button', { name: 'Search' }).click()
for (const name of visible) {
await expect(dialog.getByText(name, { exact: true })).toBeVisible()
}
for (const name of hidden) {
await expect(dialog.getByText(name, { exact: true })).not.toBeVisible()
}
await dialog.getByRole('button', { name: 'Apply and Close' }).click()
await expect(dialog).not.toBeVisible()
}
// Chinese keyword
await searchByName('需求', [zhDoc], [zhDesign, jaDoc, koDoc])
await expect(fileCard(page, zhDoc)).toBeVisible()
await expect(fileCard(page, zhDesign)).not.toBeVisible()
// Japanese keyword
await searchByName('ドキュメント', [jaDoc], [zhDoc, zhDesign, koDoc])
await expect(fileCard(page, jaDoc)).toBeVisible()
await expect(fileCard(page, zhDoc)).not.toBeVisible()
// Korean keyword
await searchByName('한국어', [koDoc], [zhDoc, zhDesign, jaDoc])
await expect(fileCard(page, koDoc)).toBeVisible()
await expect(fileCard(page, jaDoc)).not.toBeVisible()
})
test('owner searches the file list with a keyword and a filter condition', async ({ project }) => {
const { page, projectId } = project
const bigReport = 'quarterly-report-2024'
const smallReport = 'quarterly-report-2025'
await uploadBinaryFile(
project.context.request,
project.teamId,
project.rootFolderId,
bigReport,
1000,
)
await uploadBinaryFile(
project.context.request,
project.teamId,
project.rootFolderId,
smallReport,
10,
)
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, bigReport)).toBeVisible()
await expect(fileCard(page, smallReport)).toBeVisible()
// Open the search dialog from the toolbar
await page.getByRole('button', { name: 'Search' }).click()
const dialog = page.getByRole('dialog')
await expect(dialog).toBeVisible()
await dialog.getByPlaceholder('Search records by name...').fill('report')
// Add a "Size > 100" filter condition on top of the keyword
await dialog.getByRole('button', { name: '+ Add condition' }).click()
const comboboxes = dialog.getByRole('combobox')
await comboboxes.first().click()
await page.getByRole('option', { name: 'Size', exact: true }).click()
await comboboxes.nth(1).click()
await page.getByRole('option', { name: '>', exact: true }).click()
await dialog.locator('input[type="number"]').fill('100')
// The condition value is applied after the debounced input; the badge
// confirms the filter became active before we run the search.
await expect(dialog.getByText('1 active')).toBeVisible()
await dialog.getByRole('button', { name: 'Search' }).click()
await expect(dialog.getByText(bigReport, { exact: true })).toBeVisible()
await expect(dialog.getByText(smallReport, { exact: true })).not.toBeVisible()
// Apply the keyword + filter to the file list
await dialog.getByRole('button', { name: 'Apply and Close' }).click()
await expect(dialog).not.toBeVisible()
await expect(fileCard(page, bigReport)).toBeVisible()
await expect(fileCard(page, smallReport)).not.toBeVisible()
})
@@ -0,0 +1,51 @@
import { expect, test } from '../../fixtures'
import { apiAddAssetsToShare, apiCreateShare, fileCard } from '../../helpers/files'
test('owner protects a share with a password and guests must enter it to view', async ({
file,
browser,
prisma,
}) => {
const { context, page, projectId, fileName, fileId } = file
// Seed the share with the file through the API (setup, not the flow under test)
const share = await apiCreateShare(context.request, projectId, 'Shared Doc')
await apiAddAssetsToShare(context.request, share.id, [fileId])
await page.goto(`/projects/${projectId}/shares/${share.id}`)
await expect(fileCard(page, fileName)).toBeVisible()
// Open the Security accordion and enable a password
await page.getByRole('button', { name: 'Security' }).click()
const passwordRow = page.getByText('Password').locator('..')
await passwordRow.getByRole('switch').click()
const passwordInput = page.getByPlaceholder('Enter password')
await expect(passwordInput).toBeVisible()
await passwordInput.fill('secret123')
await page.getByRole('button', { name: 'Save' }).click()
await expect(page.getByText('Settings updated')).toBeVisible()
const saved = await prisma.shareLink.findUnique({ where: { id: share.id } })
expect(saved?.password).toBe('secret123')
// A guest visiting the public link hits the password gate
const guestContext = await browser.newContext()
const guestPage = await guestContext.newPage()
try {
await guestPage.goto(`/share/${share.id}`)
await expect(guestPage.getByText('Password Protected')).toBeVisible()
// Wrong password keeps the gate open with an error
await guestPage.getByPlaceholder('Enter password').fill('wrong-password')
await guestPage.getByRole('button', { name: 'Access Share' }).click()
await expect(guestPage.getByText('Incorrect password. Please try again.')).toBeVisible()
// Correct password grants access to the shared file
await guestPage.getByPlaceholder('Enter password').fill('secret123')
await guestPage.getByRole('button', { name: 'Access Share' }).click()
await expect(fileCard(guestPage, fileName)).toBeVisible()
} finally {
await guestContext.close()
}
})
@@ -0,0 +1,49 @@
import { expect, test } from '../../fixtures'
import { fileCard } from '../../helpers/files'
test('owner uploads a file via the "Upload File" context menu action', async ({
project,
prisma,
}) => {
const { page, projectId } = project
const fileName = `e2e-upload-${Date.now()}.png`
// 5x5 PNG (uploading an image avoids the slow txt->pdf transcode path)
const pngBase64 =
'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAAEElEQVR4nGNgmHkGBVHIBwBfNyLesMZaCgAAAABJRU5ErkJggg=='
await page.goto(`/projects/${projectId}`)
await expect(page.getByText('This folder is empty')).toBeVisible()
// Open the empty-area context menu and trigger the file picker
await page.getByText('This folder is empty').click({ button: 'right' })
const [fileChooser] = await Promise.all([
page.waitForEvent('filechooser'),
page.getByRole('menuitem', { name: 'Upload File' }).click(),
])
await fileChooser.setFiles({
name: fileName,
mimeType: 'image/png',
buffer: Buffer.from(pngBase64, 'base64'),
})
// The file card appears immediately (optimistic) and then gets processed
await expect(fileCard(page, fileName)).toBeVisible()
await expect
.poll(
async () => {
const asset = await prisma.asset.findFirst({ where: { name: fileName } })
return asset?.status
},
{ timeout: 30_000 },
)
.toBe('processed')
// DB: the file is stored in the project root folder
const asset = await prisma.asset.findFirst({ where: { name: fileName } })
expect(asset).not.toBeNull()
expect(asset!.type).toBe('file')
expect(asset!.projectId).toBe(projectId)
const projectRow = await prisma.project.findUnique({ where: { id: projectId } })
expect(asset!.parentId).toBe(projectRow?.rootFolderId)
})
@@ -0,0 +1,70 @@
import { expect, test } from '../../fixtures'
import { seedFile } from '../../helpers/assets'
import { dragCard } from '../../helpers/dnd'
import { fileCard } from '../../helpers/files'
test('owner moves a file onto a version stack to create a new version', async ({
project,
prisma,
}) => {
const { page, projectId, rootFolderId } = project
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-ver-a-${Date.now()}`)
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-ver-b-${Date.now()}`)
const fileC = await seedFile(prisma, projectId, rootFolderId, `e2e-ver-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. First create a version stack by dropping file B onto file A
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
await expect(page.getByText('v2', { exact: true })).toBeVisible()
await expect
.poll(async () => {
return prisma.asset.count({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
})
.toBe(1)
let stack = await prisma.asset.findFirstOrThrow({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
expect(stack.fileCount).toBe(2)
// 2. Drop file C onto the stack card -> a new version is added to the stack
// (the stack card currently displays the latest version's name, file B)
await dragCard(page, fileCard(page, fileC.name), fileCard(page, fileB.name))
// The newly added file becomes the latest version: the stack card shows file C
// with a v3 badge and file B's card disappears from the folder
await expect(page.getByText('v3', { exact: true })).toBeVisible()
await expect(fileCard(page, fileC.name)).toBeVisible()
await expect(fileCard(page, fileB.name)).not.toBeVisible()
// DB: the stack now has 3 versions, including file C
await expect
.poll(async () => {
const s = await prisma.asset.findFirst({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
return s?.fileCount
})
.toBe(3)
stack = await prisma.asset.findFirstOrThrow({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
const versions = await prisma.asset.findMany({
where: { parentId: stack.id, type: 'file' },
orderBy: { sortIndex: 'asc' },
})
expect(versions).toHaveLength(3)
expect(new Set(versions.map((v) => v.id))).toEqual(new Set([fileA.id, fileB.id, fileC.id]))
const movedFileC = await prisma.asset.findUnique({ where: { id: fileC.id } })
expect(movedFileC?.parentId).toBe(stack.id)
})
@@ -0,0 +1,48 @@
import { expect, test } from '../../fixtures'
import { seedFile } from '../../helpers/assets'
import { dragCard } from '../../helpers/dnd'
import { fileCard } from '../../helpers/files'
test('owner moves a file onto another file to create a version stack', async ({
project,
prisma,
}) => {
const { page, projectId, rootFolderId } = project
const fileA = await seedFile(prisma, projectId, rootFolderId, `e2e-stack-a-${Date.now()}`)
const fileB = await seedFile(prisma, projectId, rootFolderId, `e2e-stack-b-${Date.now()}`)
await page.goto(`/projects/${projectId}`)
await expect(fileCard(page, fileA.name)).toBeVisible()
await expect(fileCard(page, fileB.name)).toBeVisible()
// Drag file B onto file A -> a version stack is created with both files
await dragCard(page, fileCard(page, fileB.name), fileCard(page, fileA.name))
// The stack card shows the latest version's name (the dragged file) and a v2 badge;
// the original two file cards are gone from the folder
await expect(fileCard(page, fileB.name)).toBeVisible()
await expect(page.getByText('v2', { exact: true })).toBeVisible()
await expect(fileCard(page, fileA.name)).not.toBeVisible()
// DB: exactly one version stack in the project root with both files as versions
await expect
.poll(async () => {
return prisma.asset.count({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
})
.toBe(1)
const stack = await prisma.asset.findFirstOrThrow({
where: { projectId, parentId: rootFolderId, type: 'version_stack' },
})
expect(stack.fileCount).toBe(2)
const versions = await prisma.asset.findMany({
where: { parentId: stack.id, type: 'file' },
orderBy: { sortIndex: 'asc' },
})
expect(versions).toHaveLength(2)
expect(new Set(versions.map((v) => v.id))).toEqual(new Set([fileA.id, fileB.id]))
})
@@ -0,0 +1,54 @@
import { expect, test } from '../../fixtures'
import { openMembersDialog } from '../../helpers/ui'
import { seedTeamMember } from '../../helpers/team'
test('owner changes a team member role in the members dialog and permissions update', async ({
owner,
browser,
prisma,
}) => {
const { page, teamId, context } = owner
const member = await seedTeamMember(prisma, teamId, 'reviewer', browser, context)
// Reload so the members dialog fetches the newly seeded member
await page.reload()
const dialog = await openMembersDialog(page)
const memberRow = dialog
.locator('div.flex.items-center.justify-between')
.filter({ hasText: member.email })
await expect(memberRow).toBeVisible()
// Click role dropdown trigger for this member (currently Reviewer)
await memberRow.getByRole('button', { name: /Reviewer/i }).click()
// Select "Editor" from the dropdown menu
await page.getByRole('menuitemradio', { name: 'Editor' }).click()
// Verify UI displays updated role "Editor"
await expect(memberRow.getByRole('button', { name: /Editor/i })).toBeVisible()
// DB verification: teamMember role is updated to editor
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: member.userId } },
})
expect(tm?.role).toBe('editor')
// Functional verification: member can now create projects in their pre-authenticated session
const memberContext = member.context!
const memberPage = await memberContext.newPage()
try {
await memberPage.goto(`/teams/${teamId}`)
// Verify "Create Project" button is visible for editor
await expect(memberPage.getByRole('button', { name: 'Create Project' })).toBeVisible()
// Verify project creation API succeeds for editor
const res = await memberContext.request.post(`/api/teams/${teamId}/projects`, {
data: { name: `Editor Project ${Date.now()}` },
})
expect(res.status()).toBe(200)
} finally {
await memberContext.close()
}
})
@@ -0,0 +1,58 @@
import { expect, test } from '../../fixtures'
import { E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { generateInviteLink, openMembersDialog } from '../../helpers/ui'
test('owner invites a member via invite link and the invitee joins', async ({
owner,
browser,
prisma,
}) => {
const { page, teamId } = owner
// 1. Open the team members dialog and generate an invite link
const dialog = await openMembersDialog(page)
const inviteLink = await generateInviteLink(dialog)
const inviteCode = new URL(inviteLink).searchParams.get('inviteCode')
if (!inviteCode) {
throw new Error(`Invite link is missing the inviteCode param: ${inviteLink}`)
}
const origin = new URL(page.url()).origin
expect(inviteLink.startsWith(`${origin}/signup?inviteCode=`)).toBe(true)
// 2. The invitee opens the link in a brand-new session (no cookies)
const inviteeContext = await browser.newContext()
const inviteePage = await inviteeContext.newPage()
const inviteeEmail = uniqueEmail('invitee')
try {
await inviteePage.goto(inviteLink)
// The invite context banner is shown on the signup page
await expect(inviteePage.getByText(/invited you to join/)).toBeVisible()
// 3. The invitee signs up through the invite flow
await inviteePage.fill('#email', inviteeEmail)
await inviteePage.fill('#password', E2E_PASSWORD)
await inviteePage.click('button[type="submit"]')
// The invitee is redirected to the shared team
await expect(inviteePage).toHaveURL(/\/teams\/[^/]+/)
} finally {
await inviteeContext.close()
}
// 4. The owner reloads and sees the new member in the members dialog
await page.reload()
const membersDialog = await openMembersDialog(page)
await expect(membersDialog).toContainText(inviteeEmail)
// 5. DB: the invitee is a team member and the invite was consumed
const membershipCount = await prisma.teamMember.count({ where: { teamId } })
expect(membershipCount).toBe(2)
const invite = await prisma.invite.findUnique({ where: { code: inviteCode } })
expect(invite?.used).toBe(true)
const inviteeUser = await prisma.user.findUnique({ where: { email: inviteeEmail } })
expect(inviteeUser).not.toBeNull()
})
@@ -0,0 +1,38 @@
import { expect, test } from '../../fixtures'
import { openMembersDialog } from '../../helpers/ui'
import { seedTeamMember } from '../../helpers/team'
test('owner removes a member via the members dialog and the membership is deleted', async ({
owner,
prisma,
}) => {
const { page, teamId } = owner
const member = await seedTeamMember(prisma, teamId, 'reviewer')
// Reload so the members dialog fetches the newly seeded member
await page.reload()
const dialog = await openMembersDialog(page)
const memberRow = dialog
.locator('div.flex.items-center.justify-between')
.filter({ hasText: member.email })
await expect(memberRow).toBeVisible()
// The last button in the row is the remove (trash) button
await memberRow.getByRole('button').last().click()
const removeDialog = page.getByRole('alertdialog')
await expect(removeDialog).toBeVisible()
await expect(removeDialog.getByRole('heading', { name: 'Remove Member' })).toBeVisible()
await removeDialog.getByRole('button', { name: 'Remove' }).click()
// The member row disappears from the dialog
await expect(memberRow).not.toBeVisible()
// DB: the owner is the only remaining team member, but the user still exists
const remainingMembers = await prisma.teamMember.count({ where: { teamId } })
expect(remainingMembers).toBe(1)
const user = await prisma.user.findUnique({ where: { id: member.userId } })
expect(user).not.toBeNull()
})
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/web-app",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"dependencies": {
+23 -26
View File
@@ -33,7 +33,7 @@
},
"apps/agent": {
"name": "@shumai/agent-app",
"version": "0.2.3",
"version": "0.3.2",
"bin": {
"shumai-agent": "./src/index.ts",
},
@@ -45,7 +45,7 @@
},
"apps/cli": {
"name": "@shumai/cli",
"version": "0.2.3",
"version": "0.3.2",
"bin": {
"shumai-cli": "./src/index.ts",
},
@@ -60,7 +60,7 @@
},
"apps/transcode": {
"name": "@shumai/transcode-app",
"version": "0.2.3",
"version": "0.3.2",
"bin": {
"shumai-transcode": "./src/index.ts",
},
@@ -72,7 +72,7 @@
},
"apps/web": {
"name": "@shumai/web-app",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@shumai/agent": "workspace:*",
"@shumai/api": "workspace:*",
@@ -92,11 +92,11 @@
},
"packages/agent": {
"name": "@shumai/agent",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@anthropic-ai/sandbox-runtime": "0.0.66",
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-ai": "0.80.7",
"@earendil-works/pi-agent-core": "0.82.1",
"@earendil-works/pi-ai": "0.82.1",
"@google/genai": "1.52.0",
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -117,7 +117,7 @@
},
"packages/api": {
"name": "@shumai/api",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@hono/zod-validator": "0.7.6",
"@shumai/core": "workspace:*",
@@ -131,9 +131,10 @@
},
"packages/core": {
"name": "@shumai/core",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-agent-core": "0.82.1",
"@earendil-works/pi-ai": "0.82.1",
"@shumai/db": "workspace:*",
"@shumai/dtos": "workspace:*",
"@sinclair/typebox": "0.34.49",
@@ -162,9 +163,9 @@
},
"packages/db": {
"name": "@shumai/db",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-agent-core": "0.82.1",
"@prisma/adapter-pg": "7.8.0",
"@prisma/client": "7.8.0",
"pg": "8.21.0",
@@ -178,17 +179,17 @@
},
"packages/dtos": {
"name": "@shumai/dtos",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-agent-core": "0.82.1",
"zod": "4.4.3",
},
},
"packages/e2e": {
"name": "@shumai/e2e",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-agent-core": "0.82.1",
"@google/genai": "1.52.0",
"@shumai/agent": "workspace:*",
"@shumai/core": "workspace:*",
@@ -201,11 +202,11 @@
},
"packages/tableprinter": {
"name": "@shumai/tableprinter",
"version": "0.2.3",
"version": "0.3.2",
},
"packages/transcode": {
"name": "@shumai/transcode",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -219,7 +220,7 @@
},
"packages/webui": {
"name": "@shumai/webui",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@base-ui/react": "1.5.0",
"@dnd-kit/abstract": "0.4.0",
@@ -317,7 +318,7 @@
},
"packages/workflow-core": {
"name": "@shumai/workflow-core",
"version": "0.2.3",
"version": "0.3.2",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -464,9 +465,9 @@
"@dnd-kit/state": ["@dnd-kit/state@0.4.0", "", { "dependencies": { "@preact/signals-core": "^1.10.0", "tslib": "^2.6.2" } }, "sha512-vVdwOY9VsYdMNa7Z0xQhTXlzHqCcCugGuoM1kzvZhnZ0tYVPRdmIhWfeO6Y2ZoN92JwYAyJRRNl4ICkEe2mneg=="],
"@earendil-works/pi-agent-core": ["@earendil-works/pi-agent-core@0.78.0", "", { "dependencies": { "@earendil-works/pi-ai": "^0.78.0", "ignore": "7.0.5", "typebox": "1.1.38", "yaml": "2.9.0" } }, "sha512-xhWd59Qzd8yO88gYQw2S4dEQstJJEiUtxRP01//YzVJ61jCtUASMfcyAmYhgGYR4Onp7GmwEAbBBGOiV6Iwk9g=="],
"@earendil-works/pi-agent-core": ["@earendil-works/pi-agent-core@0.82.1", "", { "dependencies": { "@earendil-works/pi-ai": "^0.82.1", "diff": "8.0.4", "ignore": "7.0.5", "typebox": "1.1.38", "yaml": "2.9.0" } }, "sha512-Z3kloziJIE2dmrisRckZX8zDca/gIv9/YdFAzeoqpHiLV2wsni6bL4hInNSjVKLbqT+4kqLIkph2JQLKvSepjg=="],
"@earendil-works/pi-ai": ["@earendil-works/pi-ai@0.80.7", "", { "dependencies": { "@anthropic-ai/sdk": "0.91.1", "@aws-sdk/client-bedrock-runtime": "3.1048.0", "@google/genai": "1.52.0", "@mistralai/mistralai": "2.2.6", "@opentelemetry/api": "1.9.0", "@smithy/node-http-handler": "4.7.3", "http-proxy-agent": "7.0.2", "https-proxy-agent": "7.0.6", "openai": "6.26.0", "partial-json": "0.1.7", "typebox": "1.1.38" }, "bin": { "pi-ai": "dist/cli.js" } }, "sha512-8RLKLwe5TFM9kKFMNu/lTzveduq4GxZbnlG6ba8FAhLeb5wJP4zbj1eBumKBRvggpFQnW5R/Vo2a8zTlHsV9SQ=="],
"@earendil-works/pi-ai": ["@earendil-works/pi-ai@0.82.1", "", { "dependencies": { "@anthropic-ai/sdk": "0.91.1", "@aws-sdk/client-bedrock-runtime": "3.1048.0", "@google/genai": "1.52.0", "@mistralai/mistralai": "2.2.6", "@opentelemetry/api": "1.9.0", "@smithy/node-http-handler": "4.7.3", "http-proxy-agent": "7.0.2", "https-proxy-agent": "7.0.6", "openai": "6.26.0", "partial-json": "0.1.7", "typebox": "1.1.38" }, "bin": { "pi-ai": "dist/cli.js" } }, "sha512-3WFYRhEp3lQB3444EhPMBcM7zSaEUE3eJgHOR7s4081NLqbw/FsWilIKWXSua0Gv3sRr7m9xMidR3pPDE7jI/A=="],
"@electric-sql/pglite": ["@electric-sql/pglite@0.4.1", "", {}, "sha512-mZ9NzzUSYPOCnxHH1oAHPRzoMFJHY472raDKwXl/+6oPbpdJ7g8LsCN4FSaIIfkiCKHhb3iF/Zqo3NYxaIhU7Q=="],
@@ -2820,8 +2821,6 @@
"@aws-sdk/nested-clients/@smithy/node-http-handler": ["@smithy/node-http-handler@4.7.6", "", { "dependencies": { "@smithy/core": "^3.24.6", "@smithy/types": "^4.14.3", "tslib": "^2.6.2" } }, "sha512-3fya8i7GrJilQouk4cZJKdy5k8MWQBpjfXrRNaXDedH8r779tr0jcxyH3+yoTmsluc2+vF4S343yFbnvu8ExDQ=="],
"@earendil-works/pi-agent-core/@earendil-works/pi-ai": ["@earendil-works/pi-ai@0.78.0", "", { "dependencies": { "@anthropic-ai/sdk": "0.91.1", "@aws-sdk/client-bedrock-runtime": "3.1048.0", "@google/genai": "1.52.0", "@mistralai/mistralai": "2.2.1", "@smithy/node-http-handler": "4.7.3", "http-proxy-agent": "7.0.2", "https-proxy-agent": "7.0.6", "openai": "6.26.0", "partial-json": "0.1.7", "typebox": "1.1.38" }, "bin": { "pi-ai": "dist/cli.js" } }, "sha512-q0hUrvT6ngT6cgBX0oIbzfQfmzztgdkZobP8OTL+sCOOBlnG6+1YRt8g7zO9CC/4NdeYEqa7uGqWdQhH0fjCLA=="],
"@earendil-works/pi-agent-core/ignore": ["ignore@7.0.5", "", {}, "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg=="],
"@eslint-community/eslint-utils/eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="],
@@ -3246,8 +3245,6 @@
"yauzl/buffer-crc32": ["buffer-crc32@0.2.13", "", {}, "sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ=="],
"@earendil-works/pi-agent-core/@earendil-works/pi-ai/@mistralai/mistralai": ["@mistralai/mistralai@2.2.1", "", { "dependencies": { "ws": "^8.18.0", "zod": "^3.25.0 || ^4.0.0", "zod-to-json-schema": "^3.25.0" } }, "sha512-uKU8CZmL2RzYKmplsU01hii4p3pe4HqJefpWNRWXm1Tcm0Sm4xXfwSLIy4k7ZCPlbETCGcp69E7hZs+WOJ5itQ=="],
"@isaacs/cliui/string-width/emoji-regex": ["emoji-regex@9.2.2", "", {}, "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg=="],
"@isaacs/cliui/strip-ansi/ansi-regex": ["ansi-regex@6.2.2", "", {}, "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg=="],
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "shumai",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"repository": {
@@ -18,9 +18,10 @@
"typecheck": "tsc --noEmit",
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"test": "bun --bun vitest run",
"test:e2e": "playwright test",
"test:e2e": "playwright test --project=harness-chromium --project=app-chromium",
"test:e2e:all": "playwright test",
"test:e2e:workflow": "bun --bun vitest run -c packages/e2e/vitest.config.ts",
"test:e2e:ui": "playwright test --ui",
"test:e2e:ui": "playwright test --ui --project=harness-chromium --project=app-chromium",
"test:e2e:report": "playwright show-report",
"test:e2e:install": "playwright install --with-deps",
"harness:dev": "bun run packages/webui/e2e/harness/serve.ts",
@@ -28,7 +29,6 @@
"db:migrate": "bun run prisma migrate dev",
"db:deploy": "bun run prisma migrate deploy",
"db:generate": "cd packages/db && bunx prisma generate",
"generate-providers": "bun run scripts/generate-builtin-providers.ts",
"worker:agent": "bun apps/agent/src/index.ts",
"worker:transcode": "bun apps/transcode/src/index.ts",
"build": "bun run build.ts",
+3 -3
View File
@@ -1,14 +1,14 @@
{
"name": "@shumai/agent",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"main": "./src/index.ts",
"types": "./src/index.ts",
"dependencies": {
"@anthropic-ai/sandbox-runtime": "0.0.66",
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-ai": "0.80.7",
"@earendil-works/pi-agent-core": "0.82.1",
"@earendil-works/pi-ai": "0.82.1",
"@google/genai": "1.52.0",
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
+418 -8
View File
@@ -9,6 +9,7 @@ import {
updateCommentActivity,
getAgentChatContextActivity,
getAgentAutofillContextActivity,
getAssetAutofillContextActivity,
getAssetActivity,
getCommentActivity,
getProjectAutofillFieldsActivity,
@@ -70,7 +71,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -137,7 +139,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -198,7 +201,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -266,7 +270,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -331,7 +336,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -371,7 +377,8 @@ describe('Agent Activities', () => {
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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 = {
@@ -430,7 +437,8 @@ describe('Agent Activities', () => {
}
return {
session: mockSession as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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>,
}
})
@@ -451,6 +459,106 @@ describe('Agent Activities', () => {
expect(res.text).toBe('{"f1":"val"}')
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 () => {
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,
})
const capturedPrompt = mockHarness.prompt.mock.calls[0]?.[0] ?? ''
expect(capturedPrompt).not.toContain('<context>')
})
})
describe('Agent Database Activities Integration', () => {
@@ -1156,6 +1264,37 @@ 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()
@@ -1266,6 +1405,65 @@ describe('Agent Database Activities Integration', () => {
expect(Number(parentFolder?.sizeByte)).toBe(500)
expect(uploadService.triggerPostUploadWorkflows).toHaveBeenCalled()
})
it('should persist autofillContext on the created file when context is provided', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
fileCount: 0,
sizeByte: 0,
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'create_file',
args: {
parent: folder.id,
s3Key: 'uploads/ctx.txt',
name: 'ctx.txt',
size: 100,
contentType: 'text/plain',
context: 'Generated using gemini',
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBe('Generated using gemini')
})
it('should not set autofillContext when context is not provided', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
fileCount: 0,
sizeByte: 0,
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'create_file',
args: {
parent: folder.id,
s3Key: 'uploads/plain.txt',
name: 'plain.txt',
size: 100,
contentType: 'text/plain',
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBeNull()
})
})
describe('create_version', () => {
@@ -1374,6 +1572,217 @@ describe('Agent Database Activities Integration', () => {
expect(updatedStack?.fileCount).toBe(2)
expect(Number(updatedStack?.sizeByte)).toBe(350)
})
it('should persist autofillContext when creating a new version stack', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
fileCount: 1,
sizeByte: 200,
},
})
const fileAsset = await prisma.asset.create({
data: {
name: 'v1.txt',
type: AssetType.file,
status: AssetStatus.uploaded,
projectId: project.id,
parentId: folder.id,
sizeByte: 200,
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'create_version',
args: {
parent: fileAsset.id,
s3Key: 'uploads/v2.txt',
name: 'v2.txt',
size: 300,
contentType: 'text/plain',
context: 'Generated using seedance',
},
userId: user.id,
})
const created = await prisma.asset.findUnique({ where: { id: res.id } })
expect(created?.autofillContext).toBe('Generated using seedance')
})
it('should persist autofillContext when adding to an existing version stack', async () => {
const folder = await prisma.asset.create({
data: {
name: 'WorkspaceFolder',
type: AssetType.folder,
status: AssetStatus.uploaded,
projectId: project.id,
},
})
const stack = await prisma.asset.create({
data: {
name: 'VersionStack',
type: AssetType.version_stack,
status: AssetStatus.uploaded,
projectId: project.id,
parentId: folder.id,
fileCount: 1,
sizeByte: 100,
},
})
const existingFileVersion = await prisma.asset.create({
data: {
name: 'v1.txt',
type: AssetType.file,
status: AssetStatus.uploaded,
projectId: project.id,
parentId: stack.id,
sizeByte: 100,
},
})
const res = await executeAgentToolActivity({
taskId: 'task-1',
toolName: 'create_version',
args: {
parent: existingFileVersion.id,
s3Key: 'uploads/v2.txt',
name: 'v2.txt',
size: 250,
contentType: 'text/plain',
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' },
],
},
},
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 subFolder = await prisma.asset.create({
data: {
name: 'Sub',
type: AssetType.folder,
status: AssetStatus.uploaded,
parentId: rootFolder.id,
},
})
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')
})
})
})
@@ -1420,7 +1829,8 @@ describe('Agent Database Activities Integration', () => {
}
vi.mocked(piAgent.createAgentSession).mockResolvedValue({
session: {} as unknown as Session<DatabaseSessionMetadata>,
harness: mockHarness as unknown as AgentHarness,
// 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>,
})
await generateSessionNameActivity({
+101 -2
View File
@@ -94,7 +94,9 @@ shumai is a professional creative collaboration platform similar to frame.io, wh
shumai has its own cloud file system. If a user asks you to perform file system operations (for example: creating a folder, creating a file, stacking a version, or listing assets), you MUST use the corresponding agent system tools (e.g., 'create_folder', 'create_file', 'create_version', 'list_assets'). Before calling 'create_folder', first check if the folder exists using 'list_assets'. Do NOT use local bash commands or the local bash tool to perform these operations locally on the host environment; all operations must be executed through the platform's cloud file system tools so they are correctly registered and visible within the platform.
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.`
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 tool used to generate it), include a brief context hint (maximum 50 words) in the 'context' field of 'create_file' or 'create_version' tool.`
if (agent.soul) {
systemPrompt = `${systemPrompt}\n\nAgent Personality and Core Instructions:\n${agent.soul}`
@@ -404,10 +406,17 @@ export interface AutofillAiParams {
images: string[]
fields: AutofillField[]
context: AgentExecutionContext
agentContext?: string
}
export async function autofillAiActivity(params: AutofillAiParams) {
const prompt = 'Analyze the provided images and extract metadata.'
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 toolSchema = fieldsToTypeBoxSchema(params.fields)
let capturedData: Record<string, unknown> | null = null
@@ -997,6 +1006,14 @@ export async function getProjectAutofillFieldsActivity(projectId: string) {
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
}
export async function updateAssetMetadataActivity(params: {
assetId: string
metadata: UpdateAssetMetadataRequest[]
@@ -1170,6 +1187,7 @@ 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
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
throw ApplicationFailure.create({
message: 'parent, s3Key, name, size, and contentType parameters are required',
@@ -1219,6 +1237,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 },
})
}
// Trigger post-upload transcode and AI workflows
await uploadService.triggerPostUploadWorkflows(
tx,
@@ -1242,6 +1268,7 @@ 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
if (!parent || !s3Key || !name || fileSize === undefined || !mimeType) {
throw ApplicationFailure.create({
message: 'parent, s3Key, name, size, and contentType parameters are required',
@@ -1306,6 +1333,13 @@ 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 },
})
}
// Increment stack's size (fileCount is incremented by createAsset already)
const updatedStack = await tx.asset.update({
where: { id: stackId },
@@ -1364,6 +1398,13 @@ 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 },
})
}
// Update ancestors' size (add size of the new file version)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await assetService.updateAncestorsSize(tx as any, folderParentId!, fileSize)
@@ -1386,6 +1427,49 @@ 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}`,
@@ -1394,6 +1478,21 @@ 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
@@ -5,7 +5,7 @@ import { type SessionTreeEntry } from '@earendil-works/pi-agent-core'
import { describe, expect, it, vi, afterEach } from 'vitest'
import { DatabaseSessionStorage } from './database-session-storage'
import { agentService } from '@shumai/core/src/agent/agent'
import { createAgentSession } from './index'
import { createAgentSession, type DbProviderInfo } from './index'
import * as sandboxedBashModule from './tools/sandboxed-bash'
import * as analyzeImageModule from './tools/analyze-image'
import * as screenshotModule from './tools/screenshot'
@@ -25,6 +25,20 @@ describe('DatabaseSessionStorage', () => {
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
}
const mockProviders: DbProviderInfo[] = [
{
name: 'test-provider',
config: { api: 'openai-responses', apiKey: 'TEST_KEY' },
models: [
{
modelId: 'test-model',
name: 'Test Model',
config: mockModelConfig,
},
],
},
]
const setupTestData = async () => {
const team = await prisma.team.create({ data: { name: 'Test Team' } })
const provider = await prisma.provider.create({
@@ -340,7 +354,7 @@ describe('DatabaseSessionStorage', () => {
allowedDomains: [],
sessionId: sessionId,
userId: user.id,
providers: [],
providers: mockProviders,
})
// 7. Verify skill environment variables are restored.
@@ -453,7 +467,7 @@ describe('DatabaseSessionStorage', () => {
sessionId: sessionId,
userId: user.id,
userCommentId: 'new-comment-456',
providers: [],
providers: mockProviders,
})
// 4. Assert that the tools were instantiated using the new comment ID and user ID
@@ -507,7 +521,7 @@ describe('DatabaseSessionStorage', () => {
sessionId: sessionId,
userId: user.id,
userCommentId: 'new-comment-456',
providers: [],
providers: mockProviders,
})
// 4. Assert that the tools were instantiated using the new comment ID and user ID
@@ -583,5 +597,70 @@ describe('DatabaseSessionStorage', () => {
updateSpy.mockRestore()
})
it('should return session name from agentSession record', async () => {
const { agent } = await setupTestData()
const storage = await DatabaseSessionStorage.create({ agentId: agent.id })
expect(await storage.getSessionName()).toBeUndefined()
await prisma.agentSession.update({
where: { id: storage.sessionId },
data: { name: 'My Chat Session' },
})
expect(await storage.getSessionName()).toBe('My Chat Session')
})
it('should aggregate session stats correctly', async () => {
const { agent } = await setupTestData()
const storage = await DatabaseSessionStorage.create({ agentId: agent.id })
const msg1: SessionTreeEntry = {
type: 'message',
id: 'stats-msg-1',
parentId: null,
timestamp: new Date().toISOString(),
message: {
role: 'user',
content: [{ type: 'text', text: 'Hello' }],
timestamp: Date.now(),
},
}
const msg2: SessionTreeEntry = {
type: 'message',
id: 'stats-msg-2',
parentId: 'stats-msg-1',
timestamp: new Date().toISOString(),
message: {
role: 'assistant',
content: [{ type: 'text', text: 'Hi there!' }],
api: 'openai-responses',
provider: 'test-provider',
model: 'test-model',
stopReason: 'stop',
timestamp: Date.now(),
usage: {
input: 100,
output: 50,
cacheRead: 20,
cacheWrite: 0,
totalTokens: 170,
cost: { input: 0.01, output: 0.02, cacheRead: 0.002, cacheWrite: 0, total: 0.032 },
},
},
}
await storage.appendEntry(msg1)
await storage.appendEntry(msg2)
const stats = await storage.getSessionStats()
expect(stats.messageCount).toBe(2)
expect(stats.cachedTokens).toBe(20)
expect(stats.uncachedTokens).toBe(150)
expect(stats.totalTokens).toBe(170)
expect(stats.costTotal).toBeCloseTo(0.032)
})
})
})
@@ -212,6 +212,72 @@ export class DatabaseSessionStorage implements SessionStorage<DatabaseSessionMet
return (entry as { label?: string } | undefined)?.label
}
async getSessionName(): Promise<string | undefined> {
const session = await prisma.agentSession.findUnique({
where: { id: this.sessionId },
select: { name: true },
})
return session?.name || undefined
}
async getSessionStats(): Promise<{
messageCount: number
cachedTokens: number
uncachedTokens: number
totalTokens: number
costTotal: number
}> {
const entries = await this.getEntries()
let messageCount = 0
let cachedTokens = 0
let uncachedTokens = 0
let totalTokens = 0
let costTotal = 0
for (const entry of entries) {
if (entry.type === 'message') {
const msg = entry.message
if (msg.role === 'user' || msg.role === 'assistant') {
messageCount++
}
if (msg.role === 'assistant' && msg.usage) {
cachedTokens += msg.usage.cacheRead || 0
uncachedTokens += (msg.usage.input || 0) + (msg.usage.output || 0)
totalTokens +=
msg.usage.totalTokens ||
(msg.usage.input || 0) + (msg.usage.output || 0) + (msg.usage.cacheRead || 0)
if (msg.usage.cost) {
costTotal += msg.usage.cost.total || 0
}
}
} else if (entry.type === 'compaction' || entry.type === 'branch_summary') {
const usage = entry.usage
if (usage) {
cachedTokens += usage.cacheRead || 0
uncachedTokens += (usage.input || 0) + (usage.output || 0)
totalTokens +=
usage.totalTokens || (usage.input || 0) + (usage.output || 0) + (usage.cacheRead || 0)
if (usage.cost) {
costTotal += usage.cost.total || 0
}
}
}
}
return {
messageCount,
cachedTokens,
uncachedTokens,
totalTokens,
costTotal,
}
}
async getPathToRootOrCompaction(leafId: string | null): Promise<SessionTreeEntry[]> {
return this.getPathToRoot(leafId)
}
async getPathToRoot(leafId: string | null): Promise<SessionTreeEntry[]> {
if (!leafId) return []
+337 -10
View File
@@ -1,8 +1,9 @@
import { describe, it, expect, vi } from 'vitest'
import { describe, it, expect, vi, afterEach } from 'vitest'
import {
formatSkillsForPrompt,
createAgentSession,
getModelFromDb,
buildRestrictedUserInstructions,
type DbProviderInfo,
} from './index'
import { createSandboxedBashTool } from './tools/sandboxed-bash'
@@ -11,6 +12,7 @@ import { prisma } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import * as path from 'path'
import * as childProcess from 'node:child_process'
import * as fs from 'fs'
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let mockSpawn: any = null
@@ -28,6 +30,30 @@ vi.mock('node:child_process', async () => {
}
})
// Mock fs so tests can stub skill content loading (matching read-skill.test.ts)
vi.mock('fs')
const mockProviders: DbProviderInfo[] = [
{
name: 'google',
config: { api: 'google-generative-ai', apiKey: 'GOOGLE_API_KEY' },
models: [
{
modelId: 'gemini',
name: 'Gemini',
config: {
api: 'google-generative-ai',
reasoning: false,
input: ['text'],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
},
],
},
]
describe('formatSkillsForPrompt', () => {
it('should return empty string if skills array is empty', () => {
expect(formatSkillsForPrompt([])).toBe('')
@@ -104,7 +130,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
// 4. Verify SandboxManager.initialize was called and extract the callback
@@ -151,7 +177,7 @@ describe('Sandbox Network isolation integration', () => {
return mockChild
}
const bashPromise = bashTool.execute('1', { command: 'curl blocked-api.com' })
const bashPromise = bashTool.execute('1', { command: 'curl blocked-api.com', source: 'user' })
try {
await expect(bashPromise).rejects.toThrow(
@@ -232,7 +258,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
// 3. Call createAgentSession for Session 2
@@ -244,7 +270,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
expect(registeredCallback).toBeDefined()
@@ -314,7 +340,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
thinkingLevel: 'high',
})
expect(harnessHigh.getThinkingLevel()).toBe('high')
@@ -328,7 +354,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
expect(harnessDefault.getThinkingLevel()).toBe('off')
} finally {
@@ -336,6 +362,49 @@ describe('Sandbox Network isolation integration', () => {
}
})
it('should pass retry configuration to AgentHarness', async () => {
const team = await prisma.team.create({
data: { name: 'Test Team Retry' },
})
await prisma.user.create({
data: {
id: 'test-agent-retry',
name: 'Agent Retry',
email: 'agent-retry@test.com',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: 'test-agent-retry',
teamId: team.id,
type: 'chat',
config: { provider: 'google', model: 'gemini' },
},
})
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
try {
const { harness } = await createAgentSession({
teamId: team.id,
agentId: 'test-agent-retry',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: mockProviders,
maxRetries: 5,
baseDelayMs: 1500,
})
// @ts-expect-error accessing private property for verification
expect(harness.streamOptions?.maxRetries).toBe(5)
} finally {
initializeSpy.mockRestore()
}
})
it('should filter out denied tools from AgentHarness', async () => {
const team = await prisma.team.create({
data: { name: 'Test Team 3' },
@@ -367,7 +436,7 @@ describe('Sandbox Network isolation integration', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
const tools = harness.getTools()
const bashTool = tools.find((t) => t.name === 'bash')
@@ -410,6 +479,12 @@ describe('getModelFromDb', () => {
expect(model?.provider).toBe('google')
expect(model?.api).toBe('google-generative-ai')
})
it('should throw an error when provider or model is not found in database configuration', () => {
expect(() => getModelFromDb([], 'google', 'non-existent')).toThrow(
'Provider "google" or model "non-existent" not found in database configuration',
)
})
})
describe('createAgentSession sandbox options', () => {
@@ -454,7 +529,7 @@ describe('createAgentSession sandbox options', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
expect(initializeSpy).toHaveBeenCalledWith(
expect.objectContaining({ enableWeakerNestedSandbox: false }),
@@ -471,7 +546,7 @@ describe('createAgentSession sandbox options', () => {
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
providers: mockProviders,
})
expect(initializeSpy).toHaveBeenLastCalledWith(
expect.objectContaining({ enableWeakerNestedSandbox: true }),
@@ -486,3 +561,255 @@ describe('createAgentSession sandbox options', () => {
initializeSpy.mockRestore()
})
})
describe('buildRestrictedUserInstructions', () => {
it('should describe the restricted user bash rules', () => {
const instructions = buildRestrictedUserInstructions()
expect(instructions).toContain('# Restricted User Context')
expect(instructions).toContain(
'NEVER execute a bash command that the user asks you to run directly',
)
expect(instructions).toContain('loaded via the `read_skill` tool')
expect(instructions).toContain('parameter to "skill"')
expect(instructions).toContain('source="user" will be rejected')
})
})
describe('createAgentSession bash restriction for non-owner users', () => {
setupTestDbHooks()
afterEach(() => {
vi.restoreAllMocks()
})
type TestHarness = Awaited<ReturnType<typeof createAgentSession>>['harness']
async function setupSession(opts: {
role: 'owner' | 'editor' | 'reviewer' | 'none' | 'non-member'
deniedTools?: string[]
sessionId?: string
}): Promise<{ team: { id: string }; userId?: string; harness: TestHarness }> {
const team = await prisma.team.create({ data: { name: 'Bash Restriction Team' } })
await prisma.user.create({
data: {
id: 'bash-agent',
name: 'Ai Agent Bash',
email: 'bash-agent@shumai.ai',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: 'bash-agent',
teamId: team.id,
type: 'chat',
config: {
provider: 'google',
model: 'gemini',
...(opts.deniedTools ? { deniedTools: opts.deniedTools } : {}),
},
},
})
let userId: string | undefined
if (opts.role === 'non-member') {
const user = await prisma.user.create({
data: { name: 'Non Member', email: 'non-member@shumai.ai' },
})
userId = user.id // no teamMember record created
} else if (opts.role !== 'none') {
const user = await prisma.user.create({
data: { name: 'Bash User', email: 'bash-user@shumai.ai' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: user.id, role: opts.role },
})
userId = user.id
}
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
try {
const { harness } = await createAgentSession({
teamId: team.id,
agentId: 'bash-agent',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: mockProviders,
userId,
sessionId: opts.sessionId,
})
return { team, userId, harness }
} finally {
initializeSpy.mockRestore()
}
}
it('should include the bash tool from the start for team owners', async () => {
const { harness } = await setupSession({ role: 'owner' })
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(true)
})
it('should include the bash tool from the start when there is no user context', async () => {
const { harness } = await setupSession({ role: 'none' })
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(true)
})
it('should treat a user who is not a team member as restricted (fail-closed)', async () => {
const { harness } = await setupSession({ role: 'non-member' })
const tools = harness.getTools()
expect(tools.some((t) => t.name === 'bash')).toBe(false)
expect(tools.some((t) => t.name === 'read_skill')).toBe(true)
// @ts-expect-error accessing private property for verification
const prompt = await harness.systemPrompt()
expect(prompt).toContain('# Restricted User Context')
})
it.each(['editor', 'reviewer'] as const)(
'should exclude the bash tool initially for %s users',
async (role) => {
const { harness } = await setupSession({ role })
const tools = harness.getTools()
expect(tools.some((t) => t.name === 'bash')).toBe(false)
expect(tools.some((t) => t.name === 'read_skill')).toBe(true)
},
)
it('should include the bash tool from the start when a skill was already loaded earlier in the session', async () => {
const team = await prisma.team.create({ data: { name: 'Restore Team' } })
const user = await prisma.user.create({
data: { name: 'Restore User', email: 'restore@shumai.ai' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: user.id, role: 'reviewer' },
})
await prisma.user.create({
data: {
id: 'bash-agent-restore',
name: 'Ai Agent Restore',
email: 'bash-agent-restore@shumai.ai',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: 'bash-agent-restore',
teamId: team.id,
type: 'chat',
config: { provider: 'google', model: 'gemini' },
},
})
const session = await prisma.agentSession.create({
data: {
agentId: 'bash-agent-restore',
userId: user.id,
cwd: process.cwd(),
type: 'chat',
},
})
await prisma.agentSessionEntry.create({
data: {
id: 'restore-entry-1',
sessionId: session.id,
type: 'message',
data: {
message: {
role: 'toolResult',
content: [{ type: 'text', text: 'skill content restored' }],
toolName: 'read_skill',
isError: false,
details: { skillId: 'previously-loaded-skill' },
timestamp: Date.now(),
},
},
},
})
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
try {
const { harness } = await createAgentSession({
teamId: team.id,
agentId: 'bash-agent-restore',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: mockProviders,
userId: user.id,
sessionId: session.id,
})
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(true)
} finally {
initializeSpy.mockRestore()
}
})
it('should inject the bash tool after a skill is loaded via read_skill for restricted users', async () => {
const { team, harness } = await setupSession({ role: 'reviewer' })
const skill = await prisma.skill.create({
data: { name: 'Inject Skill', assetId: 'asset1', hash: 'inject-hash', teamId: team.id },
})
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mocking node fs readFileSync which has complex overloaded signatures
vi.spyOn(fs, 'readFileSync').mockImplementation((p: any) => {
if (p.toString().endsWith('.hash')) return 'inject-hash'
if (p.toString().endsWith('SKILL.md')) return '# Inject Skill'
return ''
})
const readSkillTool = harness.getTools().find((t) => t.name === 'read_skill')
expect(readSkillTool).toBeDefined()
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(false)
expect(harness.getActiveTools().some((t) => t.name === 'bash')).toBe(false)
await readSkillTool!.execute('1', { skillId: skill.id }, undefined, undefined, undefined)
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(true)
// bash must be part of the ACTIVE tool set, not just the registry, or the model
// would never receive it on the next turn
expect(harness.getActiveTools().some((t) => t.name === 'bash')).toBe(true)
})
it('should not inject the bash tool for restricted users when bash is in deniedTools', async () => {
const { team, harness } = await setupSession({ role: 'editor', deniedTools: ['bash'] })
const skill = await prisma.skill.create({
data: { name: 'Denied Skill', assetId: 'asset1', hash: 'denied-hash', teamId: team.id },
})
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mocking node fs readFileSync which has complex overloaded signatures
vi.spyOn(fs, 'readFileSync').mockImplementation((p: any) => {
if (p.toString().endsWith('.hash')) return 'denied-hash'
if (p.toString().endsWith('SKILL.md')) return '# Denied Skill'
return ''
})
const readSkillTool = harness.getTools().find((t) => t.name === 'read_skill')
expect(readSkillTool).toBeDefined()
await readSkillTool!.execute('1', { skillId: skill.id }, undefined, undefined, undefined)
expect(harness.getTools().some((t) => t.name === 'bash')).toBe(false)
})
it('should include restricted user instructions in the system prompt for non-owners', async () => {
const { harness } = await setupSession({ role: 'editor' })
// @ts-expect-error accessing private property for verification
const prompt = await harness.systemPrompt()
expect(prompt).toContain('# Restricted User Context')
expect(prompt).toContain('source="user" will be rejected')
})
it('should not include restricted user instructions in the system prompt for owners', async () => {
const { harness } = await setupSession({ role: 'owner' })
// @ts-expect-error accessing private property for verification
const prompt = await harness.systemPrompt()
expect(prompt).not.toContain('# Restricted User Context')
})
})
+116 -45
View File
@@ -5,10 +5,11 @@ import {
type AgentTool,
type ThinkingLevel,
} from '@earendil-works/pi-agent-core'
import { NodeExecutionEnv } from '@earendil-works/pi-agent-core/node'
import { getModel } from '@earendil-works/pi-ai/compat'
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 } from '@shumai/db'
import { prisma, type TeamMemberRole } from '@shumai/db'
import { Type, type TSchema } from '@sinclair/typebox'
import * as fs from 'fs'
import * as os from 'os'
@@ -16,6 +17,7 @@ import * as path from 'path'
import { DatabaseSessionStorage } from './database-session-storage'
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'
@@ -42,33 +44,23 @@ export function getModelFromDb(providers: DbProviderInfo[], providerName: string
const dbProvider = providers.find((p) => p.name === providerName)
const dbModel = dbProvider?.models.find((m) => m.modelId === modelId)
if (!dbProvider || !dbModel) return undefined
if (!dbProvider || !dbModel) {
throw new Error(
`Provider "${providerName}" or model "${modelId}" not found in database configuration`,
)
}
// Model contains complex internal types from pi-ai
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let m: any
try {
// Try to get built-in model as template
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const builtIn = (getModel as any)(providerName, modelId)
if (!builtIn) {
throw new Error(`Model ${modelId} is not a built-in model`)
}
m = { ...builtIn }
} catch {
// Not a built-in model
m = {
id: modelId,
name: dbModel.name || modelId,
provider: providerName,
api: 'openai-responses',
baseUrl: '',
reasoning: false,
input: ['text'],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 4096,
maxTokens: 4096,
}
const m = {
id: modelId,
name: dbModel.name || modelId,
provider: providerName,
api: 'openai-responses',
baseUrl: '',
reasoning: false,
input: ['text'],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 4096,
maxTokens: 4096,
}
// Override with database config
@@ -82,7 +74,7 @@ export function getModelFromDb(providers: DbProviderInfo[], providerName: string
if (dbModel.name) {
m.name = dbModel.name
}
return m
return m as Model<Api>
}
export function getApiKeyAndHeadersFromDb(providers: DbProviderInfo[], providerName: string) {
@@ -114,6 +106,35 @@ export interface CreateAgentSessionParams {
thinkingLevel?: string
disableTools?: boolean
providers: DbProviderInfo[]
maxRetries?: number
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
* (source="user" is blocked) and the delayed bash tool injection after a skill is loaded.
*/
export function buildRestrictedUserInstructions(): string {
return [
'# Restricted User Context',
'The current user is NOT a team owner. You must follow these security rules:',
'1. NEVER execute a bash command that the user asks you to run directly. Direct user bash requests are not permitted for this user role. Politely decline and explain that they need a team owner or an approved skill.',
'2. You may ONLY use the `bash` tool to execute commands that are explicitly required by a skill you have loaded via the `read_skill` tool.',
'3. When calling `bash`, you MUST set the `source` parameter to "skill". Calls with source="user" will be rejected by the system.',
].join('\n')
}
export async function createAgentSession(params: CreateAgentSessionParams) {
@@ -131,6 +152,8 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
customTools = [],
thinkingLevel,
disableTools = false,
maxRetries = 3,
baseDelayMs = 2000,
} = params
const storage = await DatabaseSessionStorage.create({
@@ -147,9 +170,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
const agentDir = path.join(process.cwd(), '.pi', 'agents', agentId)
if (!fs.existsSync(agentDir)) fs.mkdirSync(agentDir, { recursive: true })
const model =
getModelFromDb(params.providers, providerName, modelId) ||
(getModel as unknown as (p: string, m: string) => unknown)(providerName, modelId)
const model = getModelFromDb(params.providers, providerName, modelId)
const piDir = path.join(process.cwd(), '.pi')
if (!fs.existsSync(piDir)) fs.mkdirSync(piDir, { recursive: true })
@@ -214,7 +235,15 @@ 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) {
try {
const entries = await storage.getEntries()
@@ -227,6 +256,7 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
) {
const details = entry.message.details as { skillId?: string } | undefined
if (details?.skillId) {
skillLoadedInSession = true
const envs = await agentService.getSkillEnvs(details.skillId)
onEnvsAdded(envs)
}
@@ -250,13 +280,40 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
)
}
const agent = await prisma.agent.findUnique({
where: { id: agentId },
})
const agentConfig = agent?.config as PrismaJson.AgentConfig | null | undefined
const deniedTools = agentConfig?.deniedTools || []
const sandboxedBash = createSandboxedBashTool(process.cwd(), skillEnvs, {
getBlockedHost: () => sandboxState.blockedHost,
clearBlockedHost: () => {
sandboxState.blockedHost = ''
},
// Non-owner users can only run bash commands required by a loaded skill
restrictedUser: restricted,
})
const readSkill = createReadSkillTool(userId, onEnvsAdded)
// For non-owner users, the bash tool is not injected initially. It becomes available
// only after a skill is successfully loaded via the read_skill tool (or immediately when
// a skill was already loaded earlier in this session).
let harness: AgentHarness | undefined = undefined
const bashIncludedFromStart = isOwner || skillLoadedInSession
let bashInjected = bashIncludedFromStart
const onSkillLoaded = async () => {
if (!harness || bashInjected || deniedTools.includes('bash')) return
if (harness.getTools().some((t) => t.name === 'bash')) return
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]
await harness.setTools(
next,
next.map((t) => t.name),
)
}
const readSkill = createReadSkillTool(userId, onEnvsAdded, restricted ? onSkillLoaded : undefined)
const systemTools: AgentTool[] = []
if (userId) {
@@ -266,20 +323,16 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
createCreateFileTool(userId),
createCreateVersionTool(userId),
createDownloadAssetTool(userId),
createListAutofillFieldsTool(userId),
)
}
const agent = await prisma.agent.findUnique({
where: { id: agentId },
})
const agentConfig = agent?.config as PrismaJson.AgentConfig | null | undefined
const deniedTools = agentConfig?.deniedTools || []
const readThread = createReadThreadTool()
const allTools = [
...mediaTools,
readSkill,
readThread,
sandboxedBash,
...(bashIncludedFromStart ? [sandboxedBash] : []),
...systemTools,
...customTools,
]
@@ -287,11 +340,28 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
? []
: allTools.filter((tool) => !deniedTools.includes(tool.name))
const harness = new AgentHarness({
env: new NodeExecutionEnv({ cwd: process.cwd() }),
const credentials = new InMemoryCredentialStore()
const resolveKey = (key: string | undefined) => (key ? process.env[key] || key : undefined)
for (const p of params.providers) {
const apiKey = resolveKey(p.config?.apiKey)
if (apiKey) {
await credentials.modify(p.name, async () => ({ type: 'api_key' as const, key: apiKey }))
}
}
const modelsStore = createModels({ credentials })
for (const provider of builtinProviders()) {
modelsStore.setProvider(provider)
}
harness = new AgentHarness({
session,
models: modelsStore,
model,
thinkingLevel: (thinkingLevel || 'off') as ThinkingLevel,
streamOptions: {
maxRetries,
maxRetryDelayMs: baseDelayMs,
},
systemPrompt: async () => {
let prompt = systemPrompt
@@ -299,6 +369,10 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
return prompt
}
if (restricted) {
prompt += `\n\n${buildRestrictedUserInstructions()}`
}
// Sandbox environment restrictions
prompt +=
'\n\n' +
@@ -316,9 +390,6 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
}
return prompt
},
getApiKeyAndHeaders: async (targetModel) => {
return getApiKeyAndHeadersFromDb(params.providers, targetModel.provider)
},
tools: enabledTools,
})
@@ -0,0 +1,204 @@
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { createCreateFileTool } from './create-file'
import { s3Service } from '@shumai/core/src/s3/s3'
import { executeAgentToolWorkflow } from './utils'
import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
vi.mock('@shumai/core/src/s3/s3', () => ({
s3Service: {
uploadFileToKey: vi.fn(),
putObject: vi.fn(),
},
}))
vi.mock('./utils', () => ({
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'test', type: 'file' }),
}))
describe('createCreateFileTool', () => {
const createdFiles: string[] = []
beforeEach(() => {
vi.clearAllMocks()
})
afterEach(() => {
for (const f of createdFiles) {
if (fs.existsSync(f)) {
fs.unlinkSync(f)
}
}
createdFiles.length = 0
})
const createTempFile = (content: string | Buffer, filename: string): string => {
const filePath = path.join(os.tmpdir(), filename)
fs.writeFileSync(filePath, content)
createdFiles.push(filePath)
return filePath
}
it('should upload a local file when "path" is provided', async () => {
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 })
expect(s3Service.uploadFileToKey).toHaveBeenCalledTimes(1)
expect(s3Service.putObject).not.toHaveBeenCalled()
const uploadArgs = vi.mocked(s3Service.uploadFileToKey).mock.calls[0]
const s3Key = uploadArgs[1]
expect(s3Key).toMatch(/^files\/.+\.md$/)
expect(uploadArgs[2]).toBe('text/markdown')
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
toolName: 'create_file',
args: {
parent: 'folder-1',
s3Key,
name: 'create-file-test.md',
size: Buffer.byteLength('# Hello from disk', 'utf-8'),
contentType: 'text/markdown',
},
userId: 'user-1',
assetId: 'folder-1',
})
expect(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')
const tool = createCreateFileTool('user-1')
await tool.execute('call-1', {
parent: 'folder-1',
path: filePath,
context: 'Generated using gemini',
})
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
expect.objectContaining({
args: expect.objectContaining({ context: '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')
const tool = createCreateFileTool('user-1')
await tool.execute('call-1', { parent: 'folder-1', path: filePath })
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
expect(callArgs).not.toHaveProperty('context')
})
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' }),
).rejects.toThrow('Local file not found at path: /nonexistent/file.md')
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
})
it('should create a file directly from name and content', async () => {
const tool = createCreateFileTool('user-1')
const result = await tool.execute('call-1', {
parent: 'folder-1',
data: { name: 'notes.md', content: '# Notes\n\nHello' },
})
expect(s3Service.putObject).toHaveBeenCalledTimes(1)
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
const [bucket, s3Key, body, size, contentType] = vi.mocked(s3Service.putObject).mock
.calls[0] as unknown as [string, string, Buffer, number, string]
expect(bucket).toBe(process.env.S3_BUCKET || 'shumai')
expect(s3Key).toMatch(/^files\/.+notes\.md$/)
expect(body.toString('utf-8')).toBe('# Notes\n\nHello')
expect(size).toBe(Buffer.byteLength('# Notes\n\nHello', 'utf-8'))
expect(contentType).toBe('text/markdown')
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
toolName: 'create_file',
args: {
parent: 'folder-1',
s3Key,
name: 'notes.md',
size: Buffer.byteLength('# Notes\n\nHello', 'utf-8'),
contentType: 'text/markdown',
},
userId: 'user-1',
assetId: 'folder-1',
})
expect(result.details).toEqual({ id: 'file-1', name: 'test', type: 'file' })
})
it('should default unknown extensions to text/plain when creating from content', async () => {
const tool = createCreateFileTool('user-1')
await tool.execute('call-1', {
parent: 'folder-1',
data: { name: 'script.ts', content: 'const x = 1' },
})
const [, , , , contentType] = vi.mocked(s3Service.putObject).mock.calls[0] as unknown as [
string,
string,
Buffer,
number,
string,
]
expect(contentType).toBe('text/plain')
})
it('should sanitize the name when creating from content', async () => {
const tool = createCreateFileTool('user-1')
await tool.execute('call-1', {
parent: 'folder-1',
data: { name: 'my/notes.md', content: 'hello' },
})
const [, s3Key] = vi.mocked(s3Service.putObject).mock.calls[0] as unknown as [
string,
string,
Buffer,
number,
string,
]
expect(s3Key).toContain('my_notes.md')
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
expect.objectContaining({
args: expect.objectContaining({ name: 'my_notes.md' }),
}),
)
})
it('should throw when neither "path" nor "data" is provided', async () => {
const tool = createCreateFileTool('user-1')
await expect(tool.execute('call-1', { parent: 'folder-1' })).rejects.toThrow(
'Provide exactly one of "path" (a local file) or "data" (name and content).',
)
})
it('should throw when both "path" and "data" are provided', async () => {
const tool = createCreateFileTool('user-1')
await expect(
tool.execute('call-1', {
parent: 'folder-1',
path: '/some/file.md',
data: { name: 'notes.md', content: 'hello' },
}),
).rejects.toThrow('Provide exactly one of "path" (a local file) or "data" (name and content).')
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
expect(s3Service.putObject).not.toHaveBeenCalled()
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
})
})
+81 -55
View File
@@ -1,83 +1,109 @@
import { Type } from '@sinclair/typebox'
import { type AgentTool } from '@earendil-works/pi-agent-core'
import { executeAgentToolWorkflow } from './utils'
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 * as fs from 'fs'
import * as path from 'path'
import { s3Service } from '@shumai/core/src/s3/s3'
import { detectSupportedMimeType } from '@shumai/core/src/utils/mime'
import { ulid } from 'ulid'
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
function getMimeType(filePath: string): string {
try {
const fd = fs.openSync(filePath, 'r')
try {
const buffer = Buffer.alloc(4100)
const bytesRead = fs.readSync(fd, buffer, 0, 4100, 0)
const detected = detectSupportedMimeType(new Uint8Array(buffer.subarray(0, bytesRead)))
if (detected) return detected
} finally {
fs.closeSync(fd)
}
} catch {
/* Ignore detection errors and fallback to extension mapping */
}
const ext = path.extname(filePath).toLowerCase()
const mimeTypes: Record<string, string> = {
'.png': 'image/png',
'.jpg': 'image/jpeg',
'.jpeg': 'image/jpeg',
'.gif': 'image/gif',
'.webp': 'image/webp',
'.svg': 'image/svg+xml',
'.mp4': 'video/mp4',
'.mov': 'video/quicktime',
'.pdf': 'application/pdf',
'.txt': 'text/plain',
'.md': 'text/markdown',
'.markdown': 'text/markdown',
}
return mimeTypes[ext] || 'application/octet-stream'
}
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.String({
description:
'The absolute or relative local path to the file on disk. 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 short context about this file and how it was generated (max 50 words, e.g. "Generated using gemini"). ' +
'Passed to the AI metadata autofill workflow to fill fields that cannot be determined from file content alone. ' +
'Check autofillable fields with list_autofill_fields first.',
}),
),
})
function assertExactlyOneSource(params: {
path?: string
data?: { name: string; content: string }
}) {
const hasPath = params.path !== undefined
const hasData = params.data !== undefined
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 {
name: 'create_file',
label: 'Create File',
description: 'Create a new file in a specified parent folder from a local file path.',
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.',
parameters: createFileSchema,
execute: async (_toolCallId, params) => {
const absolutePath = path.resolve(process.cwd(), params.path)
if (!fs.existsSync(absolutePath)) {
throw new Error(`Local file not found at path: ${params.path}`)
const source = assertExactlyOneSource(params)
let name: string
let size: number
let mimeType: string
let s3Key: string
if (typeof source === 'string') {
// Branch A: upload an existing local file
const absolutePath = path.resolve(process.cwd(), source)
if (!fs.existsSync(absolutePath)) {
throw new Error(`Local file not found at path: ${source}`)
}
name = path.basename(absolutePath)
size = fs.statSync(absolutePath).size
mimeType = readFileMimeType(absolutePath)
// Generate compliant S3 key matching normal file upload format
s3Key = `files/${ulid()}/${sanitizeFilename(name)}`
await s3Service.uploadFileToKey(absolutePath, s3Key, mimeType)
} else {
// Branch B: create the file directly from provided name and content
name = sanitizeFilename(source.name)
const content = Buffer.from(source.content, 'utf-8')
size = content.byteLength
mimeType = getFileMimeType(null, source.name, 'text/plain')
s3Key = `files/${ulid()}/${name}`
await s3Service.putObject(process.env.S3_BUCKET || 'shumai', s3Key, content, size, mimeType)
}
const fileSize = fs.statSync(absolutePath).size
const mimeType = getMimeType(absolutePath)
// Generate compliant S3 key matching normal file upload format
const s3Key = `files/${ulid()}/${sanitizeFilename(path.basename(absolutePath))}`
await s3Service.uploadFileToKey(absolutePath, s3Key, mimeType)
const result = await executeAgentToolWorkflow({
toolName: 'create_file',
args: {
parent: params.parent,
s3Key,
name: path.basename(absolutePath),
size: fileSize,
name,
size,
contentType: mimeType,
...(params.context ? { context: params.context } : {}),
},
userId,
assetId: params.parent,
@@ -0,0 +1,105 @@
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { createCreateVersionTool } from './create-version'
import { s3Service } from '@shumai/core/src/s3/s3'
import { executeAgentToolWorkflow } from './utils'
import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
vi.mock('@shumai/core/src/s3/s3', () => ({
s3Service: {
uploadFileToKey: vi.fn(),
},
}))
vi.mock('./utils', () => ({
executeAgentToolWorkflow: vi.fn().mockResolvedValue({ id: 'file-1', name: 'v2', type: 'file' }),
}))
describe('createCreateVersionTool', () => {
const createdFiles: string[] = []
beforeEach(() => {
vi.clearAllMocks()
})
afterEach(() => {
for (const f of createdFiles) {
if (fs.existsSync(f)) {
fs.unlinkSync(f)
}
}
createdFiles.length = 0
})
const createTempFile = (content: string | Buffer, filename: string): string => {
const filePath = path.join(os.tmpdir(), filename)
fs.writeFileSync(filePath, content)
createdFiles.push(filePath)
return filePath
}
it('should upload a local file and create a version via the agent tool workflow', async () => {
const filePath = createTempFile('# Hello from disk', 'create-version-test.md')
const tool = createCreateVersionTool('user-1')
const result = await tool.execute('call-1', { parent: 'file-1', path: filePath })
expect(s3Service.uploadFileToKey).toHaveBeenCalledTimes(1)
const uploadArgs = vi.mocked(s3Service.uploadFileToKey).mock.calls[0]
const s3Key = uploadArgs[1]
expect(s3Key).toMatch(/^files\/.+\.md$/)
expect(uploadArgs[2]).toBe('text/markdown')
expect(executeAgentToolWorkflow).toHaveBeenCalledWith({
toolName: 'create_version',
args: {
parent: 'file-1',
s3Key,
name: 'create-version-test.md',
size: Buffer.byteLength('# Hello from disk', 'utf-8'),
contentType: 'text/markdown',
},
userId: 'user-1',
assetId: 'file-1',
})
expect(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')
const tool = createCreateVersionTool('user-1')
await tool.execute('call-1', {
parent: 'file-1',
path: filePath,
context: 'Generated using gemini',
})
expect(executeAgentToolWorkflow).toHaveBeenCalledWith(
expect.objectContaining({
args: expect.objectContaining({ context: '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')
const tool = createCreateVersionTool('user-1')
await tool.execute('call-1', { parent: 'file-1', path: filePath })
const callArgs = vi.mocked(executeAgentToolWorkflow).mock.calls[0][0].args
expect(callArgs).not.toHaveProperty('context')
})
it('should throw when the local file does not exist', async () => {
const tool = createCreateVersionTool('user-1')
await expect(
tool.execute('call-1', { parent: 'file-1', path: '/nonexistent/file.md' }),
).rejects.toThrow('Local file not found at path: /nonexistent/file.md')
expect(s3Service.uploadFileToKey).not.toHaveBeenCalled()
expect(executeAgentToolWorkflow).not.toHaveBeenCalled()
})
})
+11 -35
View File
@@ -4,43 +4,10 @@ import { executeAgentToolWorkflow } from './utils'
import * as fs from 'fs'
import * as path from 'path'
import { s3Service } from '@shumai/core/src/s3/s3'
import { detectSupportedMimeType } from '@shumai/core/src/utils/mime'
import { readFileMimeType } from '@shumai/core/src/utils/file-mime'
import { ulid } from 'ulid'
import { sanitizeFilename } from '@shumai/core/src/utils/filename'
function getMimeType(filePath: string): string {
try {
const fd = fs.openSync(filePath, 'r')
try {
const buffer = Buffer.alloc(4100)
const bytesRead = fs.readSync(fd, buffer, 0, 4100, 0)
const detected = detectSupportedMimeType(new Uint8Array(buffer.subarray(0, bytesRead)))
if (detected) return detected
} finally {
fs.closeSync(fd)
}
} catch {
/* Ignore detection errors and fallback to extension mapping */
}
const ext = path.extname(filePath).toLowerCase()
const mimeTypes: Record<string, string> = {
'.png': 'image/png',
'.jpg': 'image/jpeg',
'.jpeg': 'image/jpeg',
'.gif': 'image/gif',
'.webp': 'image/webp',
'.svg': 'image/svg+xml',
'.mp4': 'video/mp4',
'.mov': 'video/quicktime',
'.pdf': 'application/pdf',
'.txt': 'text/plain',
'.md': 'text/markdown',
'.markdown': 'text/markdown',
}
return mimeTypes[ext] || 'application/octet-stream'
}
const createVersionSchema = Type.Object({
parent: Type.String({
description:
@@ -50,6 +17,14 @@ const createVersionSchema = Type.Object({
description:
'The absolute or relative local path to the file on disk. This parameter is required.',
}),
context: Type.Optional(
Type.String({
description:
'Optional short context about this version and how it was generated (max 50 words, e.g. "Generated using gemini"). ' +
'Passed to the AI metadata autofill workflow to fill fields that cannot be determined from file content alone. ' +
'Check autofillable fields with list_autofill_fields first.',
}),
),
})
export function createCreateVersionTool(userId: string): AgentTool<typeof createVersionSchema> {
@@ -65,7 +40,7 @@ export function createCreateVersionTool(userId: string): AgentTool<typeof create
}
const fileSize = fs.statSync(absolutePath).size
const mimeType = getMimeType(absolutePath)
const mimeType = readFileMimeType(absolutePath)
// Generate compliant S3 key matching normal file upload format
const s3Key = `files/${ulid()}/${sanitizeFilename(path.basename(absolutePath))}`
@@ -79,6 +54,7 @@ export function createCreateVersionTool(userId: string): AgentTool<typeof create
name: path.basename(absolutePath),
size: fileSize,
contentType: mimeType,
...(params.context ? { context: params.context } : {}),
},
userId,
assetId: params.parent,
@@ -0,0 +1,31 @@
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' }] }],
})
})
})
@@ -0,0 +1,35 @@
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. generation source) 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,
}
},
}
}
@@ -308,4 +308,59 @@ describe('readSkillTool', () => {
).rejects.toThrow('Permission denied')
})
})
describe('onSkillLoaded callback', () => {
it('should invoke onSkillLoaded after a successful skill load', async () => {
const team = await prisma.team.create({ data: { name: 'Callback Team' } })
const skill = await prisma.skill.create({
data: {
name: 'Callback Skill',
assetId: 'asset1',
hash: 'cb-hash',
teamId: team.id,
},
})
vi.spyOn(fs, 'existsSync').mockReturnValue(true)
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- mocking node fs readFileSync which has complex overloaded signatures
vi.spyOn(fs, 'readFileSync').mockImplementation((path: any) => {
if (path.toString().endsWith('.hash')) return 'cb-hash'
if (path.toString().endsWith('SKILL.md')) return '# Callback Skill'
return ''
})
const onSkillLoaded = vi.fn()
const readSkillTool = createReadSkillTool(undefined, () => {}, onSkillLoaded)
await readSkillTool.execute('1', { skillId: skill.id }, undefined, undefined)
expect(onSkillLoaded).toHaveBeenCalledTimes(1)
})
it('should not invoke onSkillLoaded when loading is denied', async () => {
const team = await prisma.team.create({ data: { name: 'Callback Deny Team' } })
const reviewerUser = await prisma.user.create({
data: { name: 'Reviewer Callback', email: 'callback-reviewer@test.com' },
})
await prisma.teamMember.create({
data: { teamId: team.id, userId: reviewerUser.id, role: 'reviewer' },
})
const ownerSkill = await prisma.skill.create({
data: {
name: 'Owner Callback Skill',
assetId: 'asset1',
hash: 'cb-owner-hash',
teamId: team.id,
permission: 'owner',
},
})
const onSkillLoaded = vi.fn()
const reviewerTool = createReadSkillTool(reviewerUser.id, () => {}, onSkillLoaded)
await expect(
reviewerTool.execute('1', { skillId: ownerSkill.id }, undefined, undefined),
).rejects.toThrow('Permission denied')
expect(onSkillLoaded).not.toHaveBeenCalled()
})
})
})
+4
View File
@@ -16,6 +16,7 @@ const ROLE_HIERARCHY: Record<string, number> = {
export const createReadSkillTool = (
userId: string | undefined,
onEnvsAdded: (envs: Record<string, string>) => void,
onSkillLoaded?: () => Promise<void> | void,
): AgentTool<typeof readSkillSchema, { skillId: string }> => ({
name: 'read_skill',
label: 'Read Agent Skill',
@@ -60,6 +61,9 @@ export const createReadSkillTool = (
// Retrieve skill content using agentService
const skillMdContent = await agentService.getSkillContent(params.skillId)
// Notify that a skill was successfully loaded (e.g. to enable restricted tools)
await onSkillLoaded?.()
return {
content: [{ type: 'text', text: skillMdContent }],
details: { skillId: params.skillId },
@@ -57,7 +57,12 @@ describe('createSandboxedBashTool', () => {
const signal = createMockSignal()
// pi-coding-agent AgentTool.execute signature: (toolCallId, params, signal?, onUpdate?)
const executePromise = tool.execute('1', { command: 'echo hello' }, signal, onUpdate)
const executePromise = tool.execute(
'1',
{ command: 'echo hello', source: 'user' },
signal,
onUpdate,
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
@@ -81,6 +86,46 @@ describe('createSandboxedBashTool', () => {
expect((result as any).content[0].text).toContain('hello output')
})
it('should block user-requested commands when restrictedUser is enabled', async () => {
const tool = createSandboxedBashTool(mockCwd, {}, { restrictedUser: true })
const signal = createMockSignal()
await expect(
tool.execute('1', { command: 'echo hack', source: 'user' }, signal, createMockOnUpdate()),
).rejects.toThrow(/not permitted for your role/)
expect(spawn).not.toHaveBeenCalled()
expect(SandboxManager.wrapWithSandbox).not.toHaveBeenCalled()
})
it('should allow skill-requested commands when restrictedUser is enabled', async () => {
const tool = createSandboxedBashTool(mockCwd, {}, { restrictedUser: true })
const mockStdout = new EventEmitter()
const mockStderr = new EventEmitter()
const mockChild = Object.assign(new EventEmitter(), {
stdout: mockStdout,
stderr: mockStderr,
pid: 124,
kill: vi.fn(),
})
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- spawn is mocked to return a partial ChildProcess
;(spawn as any).mockReturnValue(mockChild)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'echo skill', source: 'skill' }, signal)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
expect(SandboxManager.wrapWithSandbox).toHaveBeenCalledWith('echo skill')
mockStdout.emit('data', Buffer.from('skill output'))
mockChild.emit('close', 0)
const result = await executePromise
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- ToolResponse content is an array of content blocks
expect((result as any).content[0].text).toContain('skill output')
})
it('should handle process errors', async () => {
const tool = createSandboxedBashTool(mockCwd, mockSessionManager.getSkillEnvs())
const mockChild = new EventEmitter()
@@ -88,7 +133,12 @@ describe('createSandboxedBashTool', () => {
;(spawn as any).mockReturnValue(mockChild)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'fail' }, signal, createMockOnUpdate())
const executePromise = tool.execute(
'1',
{ command: 'fail', source: 'user' },
signal,
createMockOnUpdate(),
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
mockChild.emit('error', new Error('spawn failed'))
@@ -107,7 +157,12 @@ describe('createSandboxedBashTool', () => {
;(spawn as any).mockReturnValue(mockChild)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'exit 1' }, signal, createMockOnUpdate())
const executePromise = tool.execute(
'1',
{ command: 'exit 1', source: 'user' },
signal,
createMockOnUpdate(),
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
mockChild.emit('close', 1)
@@ -133,7 +188,7 @@ describe('createSandboxedBashTool', () => {
const signal = createMockSignal()
const executePromise = tool.execute(
'1',
{ command: 'sleep 10', timeout: 2 },
{ command: 'sleep 10', timeout: 2, source: 'user' },
signal,
createMockOnUpdate(),
)
@@ -165,7 +220,12 @@ describe('createSandboxedBashTool', () => {
const killSpy = vi.spyOn(process, 'kill').mockImplementation(() => true as any)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'long-run' }, signal, createMockOnUpdate())
const executePromise = tool.execute(
'1',
{ command: 'long-run', source: 'user' },
signal,
createMockOnUpdate(),
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
@@ -194,7 +254,7 @@ describe('createSandboxedBashTool', () => {
;(spawn as any).mockReturnValue(mockChild)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'generate lines' }, signal)
const executePromise = tool.execute('1', { command: 'generate lines', source: 'user' }, signal)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
@@ -236,7 +296,11 @@ describe('createSandboxedBashTool', () => {
;(spawn as any).mockReturnValue(mockChild)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'long single line' }, signal)
const executePromise = tool.execute(
'1',
{ command: 'long single line', source: 'user' },
signal,
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
@@ -266,7 +330,11 @@ describe('createSandboxedBashTool', () => {
const killSpy = vi.spyOn(process, 'kill').mockImplementation(() => true as any)
const signal = createMockSignal()
const executePromise = tool.execute('1', { command: 'slow', timeout: 1 }, signal)
const executePromise = tool.execute(
'1',
{ command: 'slow', timeout: 1, source: 'user' },
signal,
)
await vi.waitFor(() => expect(spawn).toHaveBeenCalled())
+23 -2
View File
@@ -11,9 +11,19 @@ import {
type TruncationResult,
} from '../utils/truncate'
const BashSource = Type.String({
enum: ['user', 'skill'],
description:
'Indicates who requested this bash command. Set to "user" when the end user directly ' +
'requested the command. Set to "skill" when the command is required by a skill you loaded ' +
'via the read_skill tool. Users without the owner role can only execute commands with ' +
'source="skill"; source="user" will be blocked.',
})
const BashParameters = Type.Object({
command: Type.String({ description: 'The bash command to execute.' }),
timeout: Type.Optional(Type.Number({ description: 'Maximum execution time in seconds.' })),
source: BashSource,
})
export interface BashDetails {
@@ -25,6 +35,11 @@ export interface BashDetails {
export interface SandboxedBashOptions {
getBlockedHost?: () => string
clearBlockedHost?: () => void
/**
* When true, the tool only allows commands requested by a loaded skill (source="skill").
* Commands requested directly by the end user (source="user") are blocked.
*/
restrictedUser?: boolean
}
const BASH_UPDATE_THROTTLE_MS = 100
@@ -36,15 +51,21 @@ export const createSandboxedBashTool = (
): AgentTool<typeof BashParameters, BashDetails> => {
return {
name: 'bash',
description: `Execute a bash command in a sandboxed environment. Returns stdout and stderr. Output is truncated to last ${DEFAULT_MAX_LINES} lines or ${DEFAULT_MAX_BYTES / 1024}KB (whichever is hit first). If truncated, full output is saved to a temp file. Optionally provide a timeout in seconds.`,
description: `Execute a bash command in a sandboxed environment. Returns stdout and stderr. Output is truncated to last ${DEFAULT_MAX_LINES} lines or ${DEFAULT_MAX_BYTES / 1024}KB (whichever is hit first). If truncated, full output is saved to a temp file. Optionally provide a timeout in seconds. When in a restricted (non-owner) user context, only commands required by a skill loaded via the read_skill tool are allowed, and you must set source="skill".`,
label: 'Executing bash command',
parameters: BashParameters,
execute: async (
toolCallId,
{ command, timeout },
{ command, timeout, source },
signal,
onUpdate,
): Promise<AgentToolResult<BashDetails>> => {
if (options?.restrictedUser && source !== 'skill') {
throw new Error(
'Bash commands requested directly by the user (source="user") are not permitted for your role. ' +
'Only commands required by a loaded skill (source="skill") can be executed.',
)
}
options?.clearBlockedHost?.()
const wrappedCommand = await SandboxManager.wrapWithSandbox(command)
@@ -36,6 +36,9 @@ describe('Agent Autofill Workflow', () => {
getAgentAutofillContextActivity: Object.assign(vi.fn(), {
_activityName: 'getAgentAutofillContextActivity',
}),
getAssetAutofillContextActivity: Object.assign(vi.fn(), {
_activityName: 'getAssetAutofillContextActivity',
}),
autofillAiActivity: Object.assign(vi.fn(), { _activityName: 'autofillAiActivity' }),
updateTaskUsageActivity: Object.assign(vi.fn(), { _activityName: 'updateTaskUsageActivity' }),
updateAssetMetadataActivity: Object.assign(vi.fn(), {
@@ -75,6 +78,7 @@ 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',
@@ -136,6 +140,7 @@ 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({
@@ -149,6 +154,7 @@ describe('Agent Autofill Workflow', () => {
},
],
context: { agent: { id: 'b1' } },
agentContext: 'Generated using gemini',
})
// Verify task usage update
@@ -189,6 +195,42 @@ 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([])
@@ -15,6 +15,7 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
extractAiMetadataActivity,
getProjectAutofillFieldsActivity,
getAgentAutofillContextActivity,
getAssetAutofillContextActivity,
autofillAiActivity,
updateTaskUsageActivity,
updateAssetMetadataActivity,
@@ -131,6 +132,13 @@ 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,
@@ -143,6 +151,7 @@ export async function agentAutofillMedia(task: WorkflowTask): Promise<void> {
}),
),
context,
...(agentContext ? { agentContext } : {}),
})
if (aiResult.usage) {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/api",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"main": "./src/index.ts",
+29
View File
@@ -1,15 +1,25 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
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 app from './agent'
vi.mock('@shumai/core/src/agent/agent')
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
describe('Agent API', () => {
beforeEach(() => {
vi.clearAllMocks()
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
vi.mocked(agentService.getAgent).mockResolvedValue({
id: 'agent1',
teamId: 'team1',
} as unknown as Awaited<ReturnType<typeof agentService.getAgent>>)
})
describe('GET /teams/:teamId/agents', () => {
@@ -90,6 +100,12 @@ describe('Agent API', () => {
expect(data.name).toBe('New Agent')
expect(data.soul).toBe('New Soul')
expect(data.deniedTools).toEqual(['bash'])
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'agent_create',
teamId: 'team1',
userId: undefined,
itemId: 'agent2',
})
})
it('validates request', async () => {
@@ -110,6 +126,7 @@ describe('Agent API', () => {
it('updates an agent', async () => {
const mockAgent = {
id: 'agent1',
teamId: 'team1',
user: { name: 'Updated Agent', image: 'avatar1' },
type: 'autofill',
providerId: 'prov1',
@@ -140,6 +157,12 @@ describe('Agent API', () => {
expect(data.name).toBe('Updated Agent')
expect(data.soul).toBe('Updated Soul')
expect(data.deniedTools).toEqual(['bash'])
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'agent_update',
teamId: 'team1',
userId: undefined,
itemId: 'agent1',
})
})
})
@@ -151,6 +174,12 @@ describe('Agent API', () => {
expect(res.status).toBe(204)
expect(agentService.deleteAgent).toHaveBeenCalledWith({ agentId: 'agent1' })
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'agent_delete',
teamId: 'team1',
userId: undefined,
itemId: 'agent1',
})
})
})
+27
View File
@@ -9,9 +9,11 @@ import {
paginationParamsSchema,
AgentInfo,
AgentType,
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>>
@@ -94,6 +96,13 @@ const route = new Hono<{ Variables: { user: User } }>()
deniedTools: config.deniedTools || [],
}
await auditLogService.logAction({
action: AuditAction.agent_create,
teamId,
userId: userReq?.id,
itemId: agent.id,
})
return c.json(info, 200)
})
.put('/agents/:agentId', zValidator('json', updateAgentRequestSchema), async (c) => {
@@ -113,6 +122,13 @@ const route = new Hono<{ Variables: { user: User } }>()
...req,
})
await auditLogService.logAction({
action: AuditAction.agent_update,
teamId: agent.teamId,
userId: userReq?.id,
itemId: agent.id,
})
const config = agent.config as unknown as PrismaJson.AgentConfig
const info: AgentInfo = {
id: agent.id,
@@ -146,10 +162,21 @@ const route = new Hono<{ Variables: { user: User } }>()
id: agentId,
})
const existingAgent = await agentService.getAgent({ agentId })
await agentService.deleteAgent({
agentId,
})
if (existingAgent) {
await auditLogService.logAction({
action: AuditAction.agent_delete,
teamId: existingAgent.teamId,
userId: userReq?.id,
itemId: agentId,
})
}
return new Response(null, { status: 204 })
})
.get('/agent-sessions/:sessionId/entries', async (c) => {
+18
View File
@@ -5,6 +5,7 @@ import { assetService } from '@shumai/core/src/asset/asset'
import { AssetType } from '@shumai/db'
import { authMiddleware } from './middleware/auth'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('./middleware/auth', () => ({
// any is used here because Hono's Context and Next types are complex to mock in vitest.mock
@@ -18,6 +19,16 @@ vi.mock('./middleware/auth', () => ({
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/asset/asset')
vi.mock('@shumai/core/src/project/project', () => ({
projectService: {
getProjectTeam: vi.fn().mockResolvedValue('t1'),
},
}))
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('@shumai/core/src/s3/s3', () => ({
s3Service: {
@@ -65,5 +76,12 @@ describe('Attachment API', () => {
projectId: 'project1',
}),
)
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'file_create',
teamId: 't1',
userId: 'user1',
projectId: 'project1',
itemId: 'asset1',
})
})
})
+14 -1
View File
@@ -1,8 +1,10 @@
import { Hono } from 'hono'
import { zValidator } from '@hono/zod-validator'
import { postAttachmentRequestSchema } from '@shumai/dtos'
import { postAttachmentRequestSchema, AuditAction } from '@shumai/dtos'
import { assetService } from '@shumai/core/src/asset/asset'
import { s3Service } from '@shumai/core/src/s3/s3'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import { projectService } from '@shumai/core/src/project/project'
import { AssetType } from '@shumai/db'
import { ulid } from 'ulid'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
@@ -37,6 +39,17 @@ const route = new Hono<{ Variables: { user: User } }>().post(
creatorId: user.id,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.file_create,
teamId,
userId: user.id,
projectId,
itemId: assetInfo.id,
})
}
const uploadUrl = await s3Service.presign(process.env.S3_BUCKET || 'shumai', key, 'PUT')
return c.json({
+5 -8
View File
@@ -1,9 +1,9 @@
import { Hono } from 'hono'
import { teamService } from '@shumai/core/src/team/team'
import { userService } from '@shumai/core/src/user/user'
import { auth } from '@shumai/core/src/auth/auth'
import { z } from 'zod'
import { zValidator } from '@hono/zod-validator'
import { prisma } from '@shumai/db'
import { ulid } from 'ulid'
const app = new Hono()
@@ -31,13 +31,10 @@ const route = app
const { username, email } = c.req.valid('json')
const dummyEmail = `guest_${ulid()}@guest.local`
const user = await prisma.user.create({
data: {
name: username,
email: dummyEmail,
guestEmail: email,
type: 'human',
},
const user = await userService.createGuestUser({
name: username,
email: dummyEmail,
guestEmail: email,
})
return c.json({ id: user.id })
+36 -5
View File
@@ -1,6 +1,5 @@
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest'
import { Hono, type Context, type Next } from 'hono'
import { prisma } from '@shumai/db'
import fileRoute from './file'
import { assetService } from '@shumai/core/src/asset/asset'
import { metadataService } from '@shumai/core/src/metadata/metadata'
@@ -40,6 +39,14 @@ vi.mock('@shumai/core/src/authz/authz', () => ({
},
}))
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('./middleware/auth', () => ({
authMiddleware: async (c: Context, next: Next) => {
c.set('user', { id: 'user1', name: 'Test User' })
@@ -58,6 +65,10 @@ describe('file api', () => {
vi.spyOn(assetService, 'createComment').mockImplementation(vi.fn())
vi.spyOn(assetService, 'completeComment').mockImplementation(vi.fn())
vi.spyOn(assetService, 'deleteComment').mockImplementation(vi.fn())
vi.spyOn(assetService, 'getComment').mockResolvedValue({
id: 'comment1',
assetId: 'file1',
} as unknown as Awaited<ReturnType<typeof assetService.getComment>>)
vi.spyOn(assetService, 'listComments').mockImplementation(vi.fn())
vi.spyOn(assetService, 'restoreAssets').mockImplementation(vi.fn())
vi.spyOn(metadataService, 'updateAssetMetadata').mockImplementation(vi.fn())
@@ -129,6 +140,13 @@ describe('file api', () => {
type: ResourceType.Asset,
id: 'test-id',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'file_update',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'test-id',
})
})
it('DELETE /files', async () => {
@@ -150,6 +168,13 @@ describe('file api', () => {
id: 'test-id',
})
expect(assetService.deleteAssets).toHaveBeenCalledWith(['test-id'])
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'file_delete',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'test-id',
})
})
it('POST /files/restore', async () => {
@@ -208,6 +233,14 @@ describe('file api', () => {
const json = await res.json()
expect(json.message).toBe('hello')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'comment_create',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'comment-id',
})
expect(authzService.hasPermission).toHaveBeenCalledWith({
user: { id: 'user1', name: 'Test User' },
permission: Permission.Read,
@@ -248,9 +281,9 @@ describe('file api', () => {
project: { teamId: 'test-team' },
} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
const mockFindUnique = vi.spyOn(prisma.assetComment, 'findUnique').mockResolvedValue({
vi.mocked(assetService.getComment).mockResolvedValue({
id: 'parent-comment-id',
creatorId: 'parent-comment-creator-id',
creator: { id: 'parent-comment-creator-id' },
} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
const app = new Hono().use('*', authMiddleware).route('/', fileRoute)
@@ -276,8 +309,6 @@ describe('file api', () => {
userId: 'parent-comment-creator-id',
commentMessage: 'hello reply',
})
mockFindUnique.mockRestore()
})
it('GET /files/:fileId/comments', async () => {
+81 -27
View File
@@ -5,7 +5,7 @@ import { metadataService } from '@shumai/core/src/metadata/metadata'
import { notificationService } from '@shumai/core/src/notification/notification'
import { s3Service } from '@shumai/core/src/s3/s3'
import type { Prisma } from '@shumai/db'
import { prisma } from '@shumai/db'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import {
createCommentRequestSchema,
deleteFilesRequestSchema,
@@ -17,6 +17,7 @@ import {
uploadFileRequestSchema,
getDownloadLinksRequestSchema,
completeCommentRequestSchema,
AuditAction,
} from '@shumai/dtos'
import { transcodeService } from '@shumai/core'
import fs from 'fs'
@@ -75,6 +76,15 @@ const route = new Hono<{ Variables: { user: User } }>()
name: req.name,
})
const context = await assetService.getAssetContext(fileId)
await auditLogService.logAction({
action: AuditAction.file_update,
teamId: context.teamId,
userId: user.id,
projectId: context.projectId,
itemId: fileId,
})
return c.json(updatedAsset)
})
.delete('/files', zValidator('json', deleteFilesRequestSchema), async (c) => {
@@ -90,7 +100,21 @@ const route = new Hono<{ Variables: { user: User } }>()
})
}
const contexts = await Promise.all(req.ids.map((id) => assetService.getAssetContext(id)))
await assetService.deleteAssets(req.ids)
for (let i = 0; i < req.ids.length; i++) {
const ctx = contexts[i]
await auditLogService.logAction({
action: AuditAction.file_delete,
teamId: ctx.teamId,
userId: user.id,
projectId: ctx.projectId,
itemId: req.ids[i],
})
}
return c.body(null, 204)
})
.patch(
@@ -120,14 +144,12 @@ const route = new Hono<{ Variables: { user: User } }>()
const hasStatus = req.some((m) => m.key === 'status')
if (hasStatus) {
const context = await assetService.getAssetContext(fileId)
if (context?.teamId) {
notificationService.create({
type: 'metadata_field_updated_status',
teamId: context.teamId,
creatorId: user.id,
assetId: fileId,
})
}
notificationService.create({
type: 'metadata_field_updated_status',
teamId: context.teamId,
creatorId: user.id,
assetId: fileId,
})
}
return c.json('')
@@ -162,27 +184,31 @@ const route = new Hono<{ Variables: { user: User } }>()
const context = await assetService.getAssetContext(fileId)
if (context?.teamId) {
let targetUserId: string | undefined
if (req.replyToId) {
const parentComment = await prisma.assetComment.findUnique({
where: { id: req.replyToId },
})
if (parentComment?.creatorId) {
targetUserId = parentComment.creatorId
}
let targetUserId: string | undefined
if (req.replyToId) {
const parentComment = await assetService.getComment(req.replyToId).catch(() => null)
if (parentComment?.creator?.id) {
targetUserId = parentComment.creator.id
}
notificationService.create({
type: notifType,
teamId: context.teamId,
creatorId: user.id,
assetId: fileId,
userId: targetUserId,
commentMessage: req.message,
})
}
notificationService.create({
type: notifType,
teamId: context.teamId,
creatorId: user.id,
assetId: fileId,
userId: targetUserId,
commentMessage: req.message,
})
await auditLogService.logAction({
action: AuditAction.comment_create,
teamId: context.teamId,
userId: user.id,
projectId: context.projectId,
itemId: comment.id,
})
return c.json(comment, 201)
},
)
@@ -216,7 +242,21 @@ const route = new Hono<{ Variables: { user: User } }>()
id: commentId,
})
const commentData = await assetService.getComment(commentId).catch(() => null)
const updated = await assetService.completeComment(commentId, req.isCompleted, user.id)
if (commentData?.assetId) {
const context = await assetService.getAssetContext(commentData.assetId)
await auditLogService.logAction({
action: AuditAction.comment_complete,
teamId: context.teamId,
userId: user.id,
projectId: context.projectId,
itemId: commentId,
})
}
return c.json(updated)
},
)
@@ -231,7 +271,21 @@ const route = new Hono<{ Variables: { user: User } }>()
id: commentId,
})
const commentData = await assetService.getComment(commentId).catch(() => null)
await assetService.deleteComment({ commentId, userId: user.id })
if (commentData?.assetId) {
const context = await assetService.getAssetContext(commentData.assetId)
await auditLogService.logAction({
action: AuditAction.comment_delete,
teamId: context.teamId,
userId: user.id,
projectId: context.projectId,
itemId: commentId,
})
}
return c.json({ success: true })
})
.post('/files/restore', zValidator('json', restoreFilesRequestSchema), async (c) => {
+30
View File
@@ -6,6 +6,14 @@ import { searchService } from '@shumai/core/src/search/search'
import { authzService, ResourceType, Permission } from '@shumai/core/src/authz/authz'
import { authMiddleware } from './middleware/auth'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('@shumai/core/src/authz/authz', () => ({
authzService: {
hasPermission: vi.fn().mockResolvedValue(undefined),
@@ -33,6 +41,7 @@ describe('folder api', () => {
vi.mocked(authzService.hasPermission).mockClear()
vi.spyOn(assetService, 'getAsset').mockImplementation(vi.fn())
vi.spyOn(assetService, 'getAssetContext').mockResolvedValue({ teamId: 'test-team' })
vi.spyOn(assetService, 'createAsset').mockImplementation(vi.fn())
vi.spyOn(assetService, 'updateAssetName').mockImplementation(vi.fn())
vi.spyOn(assetService, 'deleteAssets').mockImplementation(vi.fn())
@@ -101,6 +110,13 @@ describe('folder api', () => {
type: ResourceType.Asset,
id: 'test-id',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'folder_update',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'test-id',
})
})
it('POST /folders', async () => {
@@ -132,6 +148,13 @@ describe('folder api', () => {
type: ResourceType.Asset,
id: 'parent-id',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'folder_create',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'new-id',
})
})
it('GET /folders/:folderId/children', async () => {
@@ -186,6 +209,13 @@ describe('folder api', () => {
id: 'test-id',
})
expect(assetService.deleteAssets).toHaveBeenCalledWith(['test-id'])
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'folder_delete',
teamId: 'test-team',
userId: 'user1',
projectId: undefined,
itemId: 'test-id',
})
})
it('POST /folders/restore', async () => {
+34 -1
View File
@@ -9,9 +9,10 @@ import {
deleteFoldersRequestSchema,
restoreFoldersRequestSchema,
} from '@shumai/dtos'
import { listChildrenRequestSchema, updateAssetOrderRequestSchema } from '@shumai/dtos'
import { listChildrenRequestSchema, updateAssetOrderRequestSchema, AuditAction } from '@shumai/dtos'
import { searchRequestSchema } from '@shumai/dtos'
import type { Prisma } from '@shumai/db'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -33,6 +34,15 @@ const route = new Hono<{ Variables: { user: User } }>()
type: 'folder',
})
const parentCtx = await assetService.getAssetContext(req.parentId)
await auditLogService.logAction({
action: AuditAction.folder_create,
teamId: parentCtx.teamId,
userId: user.id,
projectId: parentCtx.projectId,
itemId: newAsset.id,
})
return c.json(newAsset)
})
.patch(
@@ -71,6 +81,15 @@ const route = new Hono<{ Variables: { user: User } }>()
name: req.name,
})
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(updatedAsset)
})
.get('/folders/:folderId', async (c) => {
@@ -122,7 +141,21 @@ const route = new Hono<{ Variables: { user: User } }>()
})
}
const contexts = await Promise.all(req.ids.map((id) => assetService.getAssetContext(id)))
await assetService.deleteAssets(req.ids)
for (let i = 0; i < req.ids.length; i++) {
const ctx = contexts[i]
await auditLogService.logAction({
action: AuditAction.folder_delete,
teamId: ctx.teamId,
userId: user.id,
projectId: ctx.projectId,
itemId: req.ids[i],
})
}
return c.body(null, 204)
})
.post('/folders/restore', zValidator('json', restoreFoldersRequestSchema), async (c) => {
+22
View File
@@ -6,9 +6,16 @@ import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/a
import { inviteService } from '@shumai/core/src/invite/invite'
import { notificationService } from '@shumai/core/src/notification/notification'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('@shumai/core/src/invite/invite')
vi.mock('@shumai/core/src/notification/notification')
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('./middleware/auth', () => ({
authMiddleware: async (
@@ -67,6 +74,7 @@ describe('Invite API', () => {
// Using any here because mocking complex service return types or Hono context is overly verbose for this test.
vi.mocked(inviteService.createTeamInvite).mockResolvedValue({
id: 'inv1',
code: 'test-code',
role: 'editor',
teamId: 't1',
@@ -104,6 +112,12 @@ describe('Invite API', () => {
role: 'editor',
inviterId: 'u1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'invite_create',
teamId: 't1',
userId: 'u1',
itemId: 'inv1',
})
})
it('POST /projects/:projectId/invite', async () => {
@@ -111,6 +125,7 @@ describe('Invite API', () => {
// Using any here because mocking complex service return types or Hono context is overly verbose for this test.
vi.mocked(inviteService.createProjectInvite).mockResolvedValue({
id: 'inv2',
code: 'proj-code',
role: 'reviewer',
teamId: 't1',
@@ -151,6 +166,13 @@ describe('Invite API', () => {
role: 'reviewer',
inviterId: 'u1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'invite_create',
teamId: 't1',
userId: 'u1',
projectId: 'p1',
itemId: 'inv2',
})
})
it('POST /join (Team)', async () => {
+17
View File
@@ -5,12 +5,14 @@ import {
createTeamInviteRequestSchema,
joinRequestSchema,
InviteInfo,
AuditAction,
} from '@shumai/dtos'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { inviteService } from '@shumai/core/src/invite/invite'
import { notificationService } from '@shumai/core/src/notification/notification'
import { NotificationType } from '@shumai/db'
import type { Prisma } from '@shumai/db'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -53,6 +55,13 @@ const route = new Hono<{ Variables: { user: User } }>()
inviterId: user.id,
})
await auditLogService.logAction({
action: AuditAction.invite_create,
teamId,
userId: user.id,
itemId: inv.id,
})
return c.json(mapToInviteInfo(inv))
})
.post(
@@ -77,6 +86,14 @@ const route = new Hono<{ Variables: { user: User } }>()
inviterId: user.id,
})
await auditLogService.logAction({
action: AuditAction.invite_create,
teamId: inv.teamId,
userId: user.id,
projectId,
itemId: inv.id,
})
return c.json(mapToInviteInfo(inv))
},
)
+32
View File
@@ -4,6 +4,8 @@ import metadataRoute from './metadata'
import { metadataService } from '@shumai/core/src/metadata/metadata'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('./middleware/auth', () => ({
authMiddleware: async (
c: Context<{ Variables: { user: { id: string; name: string } } }>,
@@ -16,6 +18,16 @@ vi.mock('./middleware/auth', () => ({
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/metadata/metadata')
vi.mock('@shumai/core/src/project/project', () => ({
projectService: {
getProjectTeam: vi.fn().mockResolvedValue('t1'),
},
}))
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
describe('metadata api', () => {
const app = new Hono<{ Variables: { user: { id: string; name: string } } }>()
@@ -91,6 +103,12 @@ describe('metadata api', () => {
type: ResourceType.Team,
id: 't1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'metadata_field_create',
teamId: 't1',
userId: 'user1',
itemId: 'newfield',
})
})
it('GET /projects/:projectId/fields', async () => {
@@ -167,6 +185,13 @@ describe('metadata api', () => {
type: ResourceType.MetadataField,
id: 'f1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'metadata_field_delete',
teamId: 't1',
userId: 'user1',
projectId: undefined,
itemId: 'f1',
})
})
it('PUT /fields/:fieldId', async () => {
@@ -204,5 +229,12 @@ describe('metadata api', () => {
type: ResourceType.MetadataField,
id: 'f1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'metadata_field_update',
teamId: 't1',
userId: 'user1',
projectId: undefined,
itemId: 'f1',
})
})
})
+54
View File
@@ -1,14 +1,17 @@
import { zValidator } from '@hono/zod-validator'
import { Hono } from 'hono'
import { metadataService } from '@shumai/core/src/metadata/metadata'
import { projectService } from '@shumai/core/src/project/project'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import {
createFieldRequestSchema,
updateFieldRequestSchema,
updateProjectFieldsOrderRequestSchema,
FieldInfo,
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>>
@@ -42,6 +45,14 @@ const route = new Hono<{ Variables: { user: User } }>()
})
const field = await metadataService.createTeamField(teamId, req)
await auditLogService.logAction({
action: AuditAction.metadata_field_create,
teamId,
userId: user.id,
itemId: field.key,
})
return c.json(toFieldInfo(field))
})
.get('/teams/:teamId/fields', async (c) => {
@@ -85,6 +96,21 @@ const route = new Hono<{ Variables: { user: User } }>()
throw new Error('Field has no context')
}
let teamId = field.teamId
if (field.projectId && !teamId) {
teamId = await projectService.getProjectTeam(field.projectId).catch(() => null)
}
if (teamId) {
await auditLogService.logAction({
action: AuditAction.metadata_field_update,
teamId,
userId: user.id,
projectId: field.projectId || undefined,
itemId: fieldId,
})
}
return c.json(toFieldInfo(updated))
})
.delete('/fields/:fieldId', async (c) => {
@@ -109,6 +135,21 @@ const route = new Hono<{ Variables: { user: User } }>()
throw new Error('Field has no context')
}
let teamId = field.teamId
if (field.projectId && !teamId) {
teamId = await projectService.getProjectTeam(field.projectId).catch(() => null)
}
if (teamId) {
await auditLogService.logAction({
action: AuditAction.metadata_field_delete,
teamId,
userId: user.id,
projectId: field.projectId || undefined,
itemId: fieldId,
})
}
return new Response(null, { status: 204 })
})
.post('/projects/:projectId/fields', zValidator('json', createFieldRequestSchema), async (c) => {
@@ -124,6 +165,19 @@ const route = new Hono<{ Variables: { user: User } }>()
})
const field = await metadataService.createProjectField(projectId, req)
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.metadata_field_create,
teamId,
userId: user.id,
projectId,
itemId: field.key,
})
}
return c.json(toFieldInfo(field))
})
.get('/projects/:projectId/fields', async (c) => {
+20 -26
View File
@@ -2,7 +2,8 @@ import { describe, expect, it, vi, beforeEach } from 'vitest'
import { Hono } from 'hono'
import { authMiddleware } from './auth'
import { auth } from '@shumai/core/src/auth/auth'
import { prisma } from '@shumai/db'
import { userService } from '@shumai/core/src/user/user'
import { teamService } from '@shumai/core/src/team/team'
vi.mock('@shumai/core/src/auth/auth', () => ({
auth: {
@@ -12,14 +13,15 @@ vi.mock('@shumai/core/src/auth/auth', () => ({
},
}))
vi.mock('@shumai/db', () => ({
prisma: {
user: {
findUnique: vi.fn(),
},
teamMember: {
findFirst: vi.fn(),
},
vi.mock('@shumai/core/src/user/user', () => ({
userService: {
getUserById: vi.fn(),
},
}))
vi.mock('@shumai/core/src/team/team', () => ({
teamService: {
hasWritableRoleInAnyTeam: vi.fn(),
},
}))
@@ -39,7 +41,7 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
const res = await app.request('/test')
expect(res.status).toBe(200)
@@ -61,7 +63,7 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
const res = await app.request('/test')
expect(res.status).toBe(200)
@@ -71,8 +73,8 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(prisma.teamMember.findFirst).mockResolvedValue(null) // No owner/editor role
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(teamService.hasWritableRoleInAnyTeam).mockResolvedValue(false) // No owner/editor role
const res = await app.request('/test', { method: 'POST' })
expect(res.status).toBe(403)
@@ -83,7 +85,7 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
const res = await app.request('/test/search', { method: 'POST' })
expect(res.status).toBe(200)
@@ -93,12 +95,8 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(prisma.teamMember.findFirst).mockResolvedValue({
id: 'member1',
role: 'owner',
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(teamService.hasWritableRoleInAnyTeam).mockResolvedValue(true)
const res = await app.request('/test', { method: 'POST' })
expect(res.status).toBe(200)
@@ -108,12 +106,8 @@ describe('authMiddleware', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(auth.api.getSession).mockResolvedValue({ user: { id: 'user1' } } as any)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(prisma.user.findUnique).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(prisma.teamMember.findFirst).mockResolvedValue({
id: 'member1',
role: 'editor',
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
vi.mocked(userService.getUserById).mockResolvedValue({ id: 'user1' } as any)
vi.mocked(teamService.hasWritableRoleInAnyTeam).mockResolvedValue(true)
const res = await app.request('/test', { method: 'POST' })
expect(res.status).toBe(200)
+5 -11
View File
@@ -1,6 +1,7 @@
import type { Prisma } from '@shumai/db'
import { auth } from '@shumai/core/src/auth/auth'
import { prisma } from '@shumai/db'
import { userService } from '@shumai/core/src/user/user'
import { teamService } from '@shumai/core/src/team/team'
import { createMiddleware } from 'hono/factory'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -24,9 +25,7 @@ export const authMiddleware = createMiddleware<{
}
try {
const user = await prisma.user.findUnique({
where: { id: session.user.id },
})
const user = await userService.getUserById(session.user.id)
if (!user) {
return c.json({ error: 'User not found' }, 401)
@@ -38,14 +37,9 @@ export const authMiddleware = createMiddleware<{
const method = c.req.method.toUpperCase()
const path = c.req.path
if (['POST', 'PUT', 'PATCH', 'DELETE'].includes(method) && !path.endsWith('/search')) {
const member = await prisma.teamMember.findFirst({
where: {
userId: user.id,
role: { in: ['owner', 'editor'] },
},
})
const hasWritable = await teamService.hasWritableRoleInAnyTeam(user.id)
if (!member) {
if (!hasWritable) {
return c.json({ error: 'System is in read-only mode' }, 403)
}
}
+17 -41
View File
@@ -1,13 +1,12 @@
import { describe, expect, it, vi, beforeEach } from 'vitest'
import { Hono } from 'hono'
import { tokenAuthMiddleware } from './tokenAuth'
import { prisma } from '@shumai/db'
import { apiTokenService } from '@shumai/core/src/user/api-token'
import type { Prisma } from '@shumai/db'
vi.mock('@shumai/db', () => ({
prisma: {
apiToken: {
findUnique: vi.fn(),
},
vi.mock('@shumai/core/src/user/api-token', () => ({
apiTokenService: {
validateToken: vi.fn(),
},
}))
@@ -31,21 +30,11 @@ describe('tokenAuthMiddleware', () => {
})
it('sets user when valid Authorization Bearer token is provided', async () => {
vi.mocked(prisma.apiToken.findUnique).mockResolvedValue({
id: 'token1',
token: 'ulid_token_123',
name: 'cli-key',
userId: 'user123',
createdAt: new Date(),
updatedAt: new Date(),
user: {
id: 'user123',
name: 'John Doe',
email: 'john@example.com',
},
// Mocking the complex PrismaPromise return type of findUnique is not feasible without any here.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
vi.mocked(apiTokenService.validateToken).mockResolvedValue({
id: 'user123',
name: 'John Doe',
email: 'john@example.com',
} as unknown as Prisma.UserGetPayload<Record<string, never>>)
const res = await app.request('/test', {
headers: {
@@ -54,28 +43,15 @@ describe('tokenAuthMiddleware', () => {
})
expect(res.status).toBe(200)
expect(await res.text()).toBe('user:user123')
expect(prisma.apiToken.findUnique).toHaveBeenCalledWith({
where: { token: 'ulid_token_123' },
include: { user: true },
})
expect(apiTokenService.validateToken).toHaveBeenCalledWith('ulid_token_123')
})
it('sets user when valid x-api-key header is provided', async () => {
vi.mocked(prisma.apiToken.findUnique).mockResolvedValue({
id: 'token1',
token: 'ulid_token_123',
name: 'cli-key',
userId: 'user123',
createdAt: new Date(),
updatedAt: new Date(),
user: {
id: 'user123',
name: 'John Doe',
email: 'john@example.com',
},
// Mocking the complex PrismaPromise return type of findUnique is not feasible without any here.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
vi.mocked(apiTokenService.validateToken).mockResolvedValue({
id: 'user123',
name: 'John Doe',
email: 'john@example.com',
} as unknown as Prisma.UserGetPayload<Record<string, never>>)
const res = await app.request('/test', {
headers: {
@@ -87,7 +63,7 @@ describe('tokenAuthMiddleware', () => {
})
it('returns 401 when invalid token is provided', async () => {
vi.mocked(prisma.apiToken.findUnique).mockResolvedValue(null)
vi.mocked(apiTokenService.validateToken).mockResolvedValue(null)
const res = await app.request('/test', {
headers: {
+4 -7
View File
@@ -1,5 +1,5 @@
import type { Prisma } from '@shumai/db'
import { prisma } from '@shumai/db'
import { apiTokenService } from '@shumai/core/src/user/api-token'
import { createMiddleware } from 'hono/factory'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -16,16 +16,13 @@ export const tokenAuthMiddleware = createMiddleware<{
: c.req.header('x-api-key') || null
if (token) {
const apiToken = await prisma.apiToken.findUnique({
where: { token },
include: { user: true },
})
const user = await apiTokenService.validateToken(token)
if (!apiToken) {
if (!user) {
return c.json({ error: 'Unauthorized: Invalid API Key' }, 401)
}
c.set('user', apiToken.user)
c.set('user', user)
}
await next()
+71 -29
View File
@@ -4,6 +4,8 @@ import projectRoute from './project'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { projectService } from '@shumai/core/src/project/project'
import { assetService } from '@shumai/core/src/asset/asset'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import type { ProjectInfo } from '@shumai/dtos'
vi.mock('./middleware/auth', () => ({
authMiddleware: async (
@@ -16,16 +18,27 @@ vi.mock('./middleware/auth', () => ({
}))
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/project/project')
vi.mock('@shumai/core/src/project/project', () => ({
projectService: {
createProject: vi.fn(),
updateProject: vi.fn(),
getProject: vi.fn(),
getProjectTeam: vi.fn().mockResolvedValue('t1'),
deleteProject: vi.fn(),
listProjects: vi.fn(),
getUserProjects: vi.fn(),
listProjectMembers: vi.fn(),
addProjectMember: vi.fn(),
updateMemberRole: vi.fn(),
removeMember: vi.fn(),
getProjectMe: vi.fn(),
},
}))
vi.mock('@shumai/core/src/asset/asset')
vi.mock('@shumai/db', () => ({
prisma: {
teamMember: {
findMany: vi.fn(),
},
project: {
findMany: vi.fn(),
},
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
listAuditLogs: vi.fn().mockResolvedValue({ nodes: [], pageInfo: {}, total: 0 }),
},
}))
@@ -151,6 +164,7 @@ describe('project api', () => {
})
it('POST /projects/:projectId/reparent', async () => {
vi.mocked(projectService.getProjectTeam).mockResolvedValue('t1')
vi.mocked(assetService.reparentAssets).mockResolvedValue(undefined)
const res = await app.request('/projects/p/reparent', {
@@ -186,6 +200,49 @@ describe('project api', () => {
assetIds: ['asset_1', 'asset_2'],
creatorId: 'user1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'asset_reparent',
teamId: 't1',
userId: 'user1',
projectId: 'p',
itemId: 'asset_1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'asset_reparent',
teamId: 't1',
userId: 'user1',
projectId: 'p',
itemId: 'asset_2',
})
})
it('POST /projects/:projectId/copy', async () => {
vi.mocked(projectService.getProjectTeam).mockResolvedValue('t1')
vi.mocked(assetService.copyAssets).mockResolvedValue(undefined)
const res = await app.request('/projects/p/copy', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
newParentId: 'new_parent_id',
assetIds: ['asset_1'],
}),
})
expect(res.status).toBe(204)
expect(assetService.copyAssets).toHaveBeenCalledWith({
newParentId: 'new_parent_id',
assetIds: ['asset_1'],
withComments: false,
creatorId: 'user1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'asset_copy',
teamId: 't1',
userId: 'user1',
projectId: 'p',
itemId: 'asset_1',
})
})
it('POST /projects/:projectId/empty-trash', async () => {
@@ -258,24 +315,16 @@ describe('project api', () => {
})
it('GET /projects', async () => {
const { prisma } = await import('@shumai/db')
vi.mocked(prisma.teamMember.findMany).mockResolvedValue([
{ id: 'tm1', teamId: 'team1', userId: 'user1', scope: 'team' },
// Mocking complex Prisma client returns requires any here
// eslint-disable-next-line @typescript-eslint/no-explicit-any
] as any)
vi.mocked(prisma.project.findMany).mockResolvedValue([
vi.mocked(projectService.getUserProjects).mockResolvedValue([
{
id: 'proj1',
name: 'My Project',
teamId: 'team1',
rootFolderId: 'folder1',
rootFolder: 'folder1',
enableNotification: true,
updatedAt: new Date('2026-06-21T00:00:00.000Z'),
updatedAt: '2026-06-21T00:00:00.000Z',
},
// Mocking complex Prisma client returns requires any here
// eslint-disable-next-line @typescript-eslint/no-explicit-any
] as any)
] as unknown as ProjectInfo[])
const res = await app.request('/projects?first=10')
@@ -290,13 +339,6 @@ describe('project api', () => {
enableNotification: true,
updatedAt: '2026-06-21T00:00:00.000Z',
})
expect(prisma.teamMember.findMany).toHaveBeenCalledWith({
where: { userId: 'user1' },
})
expect(prisma.project.findMany).toHaveBeenCalledWith({
where: { teamId: 'team1' },
orderBy: { id: 'desc' },
take: 10,
})
expect(projectService.getUserProjects).toHaveBeenCalledWith('user1', 10)
})
})
+107 -30
View File
@@ -12,9 +12,9 @@ import {
updateProjectMemberRoleRequestSchema,
addProjectMemberRequestSchema,
} from '@shumai/dtos'
import { listMembersQuerySchema, paginationParamsSchema } from '@shumai/dtos'
import { listMembersQuerySchema, paginationParamsSchema, AuditAction } from '@shumai/dtos'
import type { Prisma } from '@shumai/db'
import { prisma } from '@shumai/db'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -24,41 +24,16 @@ const route = new Hono<{ Variables: { user: User } }>()
const req = c.req.valid('query')
const limit = req.first ? Math.min(req.first, 200) : 200
const teamMembers = await prisma.teamMember.findMany({
where: { userId: user.id },
})
type ProjectType = Prisma.ProjectGetPayload<Record<string, never>>
const allProjects: ProjectType[] = []
for (const member of teamMembers) {
const where: Prisma.ProjectWhereInput = {
teamId: member.teamId,
}
if (member.scope === 'project') {
where.members = {
some: { teamMemberId: member.id },
}
}
const teamProjects = await prisma.project.findMany({
where,
orderBy: { id: 'desc' },
take: limit - allProjects.length,
})
allProjects.push(...teamProjects)
if (allProjects.length >= limit) {
break
}
}
const allProjects = await projectService.getUserProjects(user.id, limit)
return c.json({
data: allProjects.map((p) => ({
id: p.id,
name: p.name,
teamId: p.teamId,
rootFolder: p.rootFolderId || undefined,
rootFolder: p.rootFolder,
enableNotification: p.enableNotification,
updatedAt: p.updatedAt.toISOString(),
updatedAt: p.updatedAt,
})),
})
})
@@ -79,6 +54,14 @@ const route = new Hono<{ Variables: { user: User } }>()
...req,
})
await auditLogService.logAction({
action: AuditAction.project_create,
teamId,
userId: user.id,
projectId: newProject.id,
itemId: newProject.id,
})
return c.json(newProject)
})
.put('/projects/:projectId', zValidator('json', updateProjectRequestSchema), async (c) => {
@@ -98,6 +81,16 @@ const route = new Hono<{ Variables: { user: User } }>()
...req,
})
if (updatedProject) {
await auditLogService.logAction({
action: AuditAction.project_update,
teamId: updatedProject.teamId,
userId: user.id,
projectId,
itemId: projectId,
})
}
return c.json(updatedProject)
})
.get(
@@ -138,6 +131,17 @@ const route = new Hono<{ Variables: { user: User } }>()
await assetService.emptyTrash(projectId)
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.project_empty_trash,
teamId,
userId: user.id,
projectId,
itemId: projectId,
})
}
return c.json({ success: true })
})
.get('/teams/:teamId/projects', zValidator('query', listProjectsRequestSchema), async (c) => {
@@ -193,7 +197,19 @@ const route = new Hono<{ Variables: { user: User } }>()
id: projectId,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
await projectService.deleteProject(projectId)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.project_delete,
teamId,
userId: user.id,
projectId,
itemId: projectId,
})
}
return c.json({ success: true })
})
.get('/projects/:projectId/team', async (c) => {
@@ -247,6 +263,7 @@ const route = new Hono<{ Variables: { user: User } }>()
'/projects/:projectId/reparent',
zValidator('json', reparentAssetsRequestSchema),
async (c) => {
const projectId = c.req.param('projectId')
const user = c.get('user')
const req = c.req.valid('json')
@@ -273,10 +290,24 @@ const route = new Hono<{ Variables: { user: User } }>()
creatorId: user.id,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
for (const assetId of req.assetIds) {
await auditLogService.logAction({
action: AuditAction.asset_reparent,
teamId,
userId: user.id,
projectId,
itemId: assetId,
})
}
}
return c.body(null, 204)
},
)
.post('/projects/:projectId/copy', zValidator('json', copyAssetsRequestSchema), async (c) => {
const projectId = c.req.param('projectId')
const user = c.get('user')
const req = c.req.valid('json')
@@ -303,6 +334,19 @@ const route = new Hono<{ Variables: { user: User } }>()
creatorId: user.id,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
for (const assetId of req.assetIds) {
await auditLogService.logAction({
action: AuditAction.asset_copy,
teamId,
userId: user.id,
projectId,
itemId: assetId,
})
}
}
return c.body(null, 204)
})
.patch(
@@ -327,6 +371,17 @@ const route = new Hono<{ Variables: { user: User } }>()
role: req.role,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.project_member_update,
teamId,
userId: user.id,
projectId,
itemId: userId,
})
}
return c.json({ success: true })
},
)
@@ -342,8 +397,19 @@ const route = new Hono<{ Variables: { user: User } }>()
id: projectId,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
await projectService.removeMember(projectId, userId)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.project_member_remove,
teamId,
userId: user.id,
projectId,
itemId: userId,
})
}
return c.json({ success: true })
})
.post(
@@ -367,6 +433,17 @@ const route = new Hono<{ Variables: { user: User } }>()
role: req.role,
})
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.project_member_add,
teamId,
userId: user.id,
projectId,
itemId: req.userId,
})
}
return c.json({ success: true })
},
)
+25
View File
@@ -4,6 +4,8 @@ import providerRoute from './provider'
import { providerService } from '@shumai/core/src/provider/provider'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('./middleware/auth', () => ({
authMiddleware: async (
c: Context<{ Variables: { user: { id: string; name: string } } }>,
@@ -16,6 +18,11 @@ vi.mock('./middleware/auth', () => ({
vi.mock('@shumai/core/src/authz/authz')
vi.mock('@shumai/core/src/provider/provider')
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
describe('provider api', () => {
const app = new Hono<{ Variables: { user: { id: string; name: string } } }>()
@@ -115,6 +122,12 @@ describe('provider api', () => {
type: ResourceType.Team,
id: 't1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'provider_create',
teamId: 't1',
userId: 'user1',
itemId: 'p1',
})
})
it('PUT /providers/:id updates provider', async () => {
@@ -163,6 +176,12 @@ describe('provider api', () => {
type: ResourceType.Provider,
id: 'p1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'provider_update',
teamId: 't1',
userId: 'user1',
itemId: 'p1',
})
})
it('DELETE /providers/:id deletes provider', async () => {
@@ -188,5 +207,11 @@ describe('provider api', () => {
type: ResourceType.Provider,
id: 'p1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'provider_delete',
teamId: 't1',
userId: 'user1',
itemId: 'p1',
})
})
})
+20 -1
View File
@@ -2,8 +2,9 @@ import { zValidator } from '@hono/zod-validator'
import { Hono } from 'hono'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { providerService } from '@shumai/core/src/provider/provider'
import { createProviderRequestSchema, updateProviderRequestSchema } from '@shumai/dtos'
import { createProviderRequestSchema, updateProviderRequestSchema, 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>>
@@ -54,6 +55,12 @@ const route = new Hono<{ Variables: { user: User } }>()
})
const provider = await providerService.create(teamId, name, config, models)
await auditLogService.logAction({
action: AuditAction.provider_create,
teamId,
userId: user?.id,
itemId: provider.id,
})
return c.json(provider)
})
@@ -73,6 +80,12 @@ const route = new Hono<{ Variables: { user: User } }>()
if (!providerBefore) throw new Error('Provider not found')
const provider = await providerService.update(providerBefore.teamId, id, config, models)
await auditLogService.logAction({
action: AuditAction.provider_update,
teamId: providerBefore.teamId,
userId: user?.id,
itemId: id,
})
return c.json(provider)
})
@@ -91,6 +104,12 @@ const route = new Hono<{ Variables: { user: User } }>()
if (!providerBefore) throw new Error('Provider not found')
await providerService.delete(providerBefore.teamId, id)
await auditLogService.logAction({
action: AuditAction.provider_delete,
teamId: providerBefore.teamId,
userId: user?.id,
itemId: id,
})
return c.json({ success: true })
})
+5 -13
View File
@@ -8,8 +8,9 @@ import { z } from 'zod'
import { metadataService } from '@shumai/core/src/metadata/metadata'
import { FieldInfo } from '@shumai/dtos'
import type { Prisma as PrismaType } from '@shumai/db'
import { projectService } from '@shumai/core/src/project/project'
import { userService } from '@shumai/core/src/user/user'
import { auth } from '@shumai/core/src/auth/auth'
import { prisma } from '@shumai/db'
import { createCommentRequestSchema } from '@shumai/dtos'
import { notificationService } from '@shumai/core/src/notification/notification'
import {
@@ -204,14 +205,7 @@ const route = app
const targetFileId = await assetService.resolveTargetAssetId(fileId)
const project = await prisma.project.findUnique({
where: { id: shareLink.projectId },
select: { teamId: true },
})
if (!project) {
throw new Error('Project not found')
}
const teamId = await projectService.getProjectTeam(shareLink.projectId)
// Identify user
let userId: string | null = null
@@ -222,9 +216,7 @@ const route = app
if (session?.user) {
userId = session.user.id
} else if (guestUserId) {
const guestUser = await prisma.user.findUnique({
where: { id: guestUserId },
})
const guestUser = await userService.getUserById(guestUserId)
if (guestUser) {
userId = guestUser.id
}
@@ -248,7 +240,7 @@ const route = app
notificationService.create({
type: notifType,
teamId: project.teamId,
teamId: teamId,
creatorId: userId,
assetId: targetFileId,
commentMessage: req.message,
+21
View File
@@ -8,6 +8,8 @@ import { assetService } from '@shumai/core/src/asset/asset'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { ShareLinkPasswordInvalidError, ShareLinkExpiredError } from '@shumai/core/src/share/errors'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('./middleware/auth', () => ({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
authMiddleware: async (c: any, next: any) => {
@@ -33,6 +35,18 @@ vi.mock('@shumai/core/src/authz/authz', () => ({
},
}))
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('@shumai/core/src/project/project', () => ({
projectService: {
getProjectTeam: vi.fn().mockResolvedValue('t1'),
},
}))
describe('Share API', () => {
const app = new Hono()
.route('/', publicShareRoute)
@@ -204,6 +218,13 @@ describe('Share API', () => {
{ name: 'My Share' },
'user1',
)
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'share_create',
teamId: 't1',
userId: 'user1',
projectId: 'project1',
itemId: 'share1',
})
})
})
+45
View File
@@ -2,13 +2,16 @@ import { Hono } from 'hono'
import { zValidator } from '@hono/zod-validator'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { shareService } from '@shumai/core/src/share/share'
import { projectService } from '@shumai/core/src/project/project'
import {
createShareLinkRequestSchema,
updateShareLinkRequestSchema,
listShareLinksRequestSchema,
addAssetToShareRequestSchema,
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>>
@@ -29,6 +32,18 @@ const route = new Hono<{ Variables: { user: User } }>()
})
const shareLink = await shareService.createShareLink(projectId, req, user.id)
const teamId = await projectService.getProjectTeam(projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.share_create,
teamId,
userId: user.id,
projectId,
itemId: shareLink.id,
})
}
return c.json(shareLink)
},
)
@@ -81,7 +96,22 @@ const route = new Hono<{ Variables: { user: User } }>()
id: shareId,
})
const existingShare = await shareService.getShareLink(shareId)
const updated = await shareService.updateShareLink(shareId, req)
if (existingShare) {
const teamId = await projectService.getProjectTeam(existingShare.projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.share_update,
teamId,
userId: user.id,
projectId: existingShare.projectId,
itemId: shareId,
})
}
}
return c.json(updated)
})
.delete('/shares/:shareId', async (c) => {
@@ -95,7 +125,22 @@ const route = new Hono<{ Variables: { user: User } }>()
id: shareId,
})
const existingShare = await shareService.getShareLink(shareId)
await shareService.deleteShareLink(shareId)
if (existingShare) {
const teamId = await projectService.getProjectTeam(existingShare.projectId).catch(() => null)
if (teamId) {
await auditLogService.logAction({
action: AuditAction.share_delete,
teamId,
userId: user.id,
projectId: existingShare.projectId,
itemId: shareId,
})
}
}
return c.body(null, 204)
})
.post('/shares/:shareId/assets', zValidator('json', addAssetToShareRequestSchema), async (c) => {
+53
View File
@@ -5,6 +5,25 @@ import { skillService } from '@shumai/core/src/skill/skill'
import { authMiddleware } from './middleware/auth'
import { authzService, ResourceType, Permission } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('@shumai/core/src/skill/skill', () => ({
skillService: {
listSkills: vi.fn(),
upsertSkill: vi.fn(),
deleteSkill: vi.fn(),
updateSkillConfig: vi.fn(),
updateSkillPermission: vi.fn(),
getSkill: vi.fn().mockResolvedValue({ id: 'skill1', teamId: 'team1' }),
},
}))
vi.mock('./middleware/auth', () => ({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
authMiddleware: async (c: any, next: any) => {
@@ -35,6 +54,10 @@ describe('Skill API', () => {
beforeEach(() => {
vi.restoreAllMocks()
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
vi.mocked(skillService.getSkill).mockResolvedValue({
id: 'skill1',
teamId: 'team1',
} as unknown as Awaited<ReturnType<typeof skillService.getSkill>>)
})
describe('GET /teams/:teamId/skills', () => {
@@ -102,6 +125,12 @@ describe('Skill API', () => {
}),
)
expect(skillService.upsertSkill).toHaveBeenCalledWith('team1', { assetId: 'asset1' })
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'skill_create',
teamId: 'team1',
userId: 'user1',
itemId: 'skill1',
})
})
test('Success with githubUrl', async () => {
@@ -129,6 +158,12 @@ describe('Skill API', () => {
expect(skillService.upsertSkill).toHaveBeenCalledWith('team1', {
githubUrl: 'https://github.com/test/repo',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'skill_create',
teamId: 'team1',
userId: 'user1',
itemId: 'skill1',
})
})
test('Forbidden without Admin permission', async () => {
@@ -162,6 +197,12 @@ describe('Skill API', () => {
}),
)
expect(skillService.deleteSkill).toHaveBeenCalledWith('skill1')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'skill_delete',
teamId: 'team1',
userId: 'user1',
itemId: 'skill1',
})
})
})
@@ -199,6 +240,12 @@ describe('Skill API', () => {
}),
)
expect(skillService.updateSkillConfig).toHaveBeenCalledWith('skill1', mockConfig)
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'skill_update',
teamId: 'team1',
userId: 'user1',
itemId: 'skill1',
})
})
})
@@ -233,6 +280,12 @@ describe('Skill API', () => {
}),
)
expect(skillService.updateSkillPermission).toHaveBeenCalledWith('skill1', 'owner')
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'skill_update',
teamId: 'team1',
userId: 'user1',
itemId: 'skill1',
})
})
})
})
+44
View File
@@ -6,8 +6,10 @@ import {
upsertSkillRequestSchema,
updateSkillConfigRequestSchema,
updateSkillPermissionRequestSchema,
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>>
@@ -40,6 +42,12 @@ const route = new Hono<{ Variables: { user: User } }>()
try {
const skill = await skillService.upsertSkill(teamId, req)
await auditLogService.logAction({
action: AuditAction.skill_create,
teamId,
userId: user?.id,
itemId: skill.id,
})
return c.json(skill)
} catch (err: unknown) {
if (err instanceof Error && err.name === 'ConflictError') {
@@ -59,7 +67,19 @@ const route = new Hono<{ Variables: { user: User } }>()
id,
})
const existingSkill = await skillService.getSkill(id)
await skillService.deleteSkill(id)
if (existingSkill) {
await auditLogService.logAction({
action: AuditAction.skill_delete,
teamId: existingSkill.teamId,
userId: user?.id,
itemId: id,
})
}
return new Response(null, { status: 204 })
})
.patch('/skills/:id/config', zValidator('json', updateSkillConfigRequestSchema), async (c) => {
@@ -74,7 +94,19 @@ const route = new Hono<{ Variables: { user: User } }>()
id,
})
const existingSkill = await skillService.getSkill(id)
const skill = await skillService.updateSkillConfig(id, req.config)
if (existingSkill) {
await auditLogService.logAction({
action: AuditAction.skill_update,
teamId: existingSkill.teamId,
userId: user?.id,
itemId: id,
})
}
return c.json(skill)
})
.patch(
@@ -92,7 +124,19 @@ const route = new Hono<{ Variables: { user: User } }>()
id,
})
const existingSkill = await skillService.getSkill(id)
const skill = await skillService.updateSkillPermission(id, req.permission)
if (existingSkill) {
await auditLogService.logAction({
action: AuditAction.skill_update,
teamId: existingSkill.teamId,
userId: user?.id,
itemId: id,
})
}
return c.json(skill)
},
)
+44
View File
@@ -1,5 +1,6 @@
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest'
import { Hono } from 'hono'
import { AuditAction } from '@shumai/dtos'
import teamRoute from './team'
import { authMiddleware } from './middleware/auth'
import { teamService } from '@shumai/core/src/team/team'
@@ -44,6 +45,13 @@ vi.mock('@shumai/core/src/ai-usage/ai-usage', () => ({
},
}))
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn(),
listAuditLogs: vi.fn(),
},
}))
describe('team api', () => {
const app = new Hono().use('*', authMiddleware).route('/', teamRoute)
let mockCreateTeam: any // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -471,5 +479,41 @@ describe('team api', () => {
userId: 'user1',
})
})
it('GET /teams/:teamId/audit-logs returns list of audit logs for team owner', async () => {
const { auditLogService } = await import('@shumai/core/src/auditLog/auditLog')
vi.mocked(auditLogService.listAuditLogs).mockResolvedValue({
nodes: [
{
id: 'log1',
action: AuditAction.project_create,
teamId: 't1',
userId: 'user1',
projectId: 'p1',
itemId: 'p1',
createdAt: new Date().toISOString(),
},
],
pageInfo: {
hasNextPage: false,
endCursor: null,
},
total: 1,
})
const res = await app.request('/teams/t1/audit-logs')
expect(res.status).toBe(200)
const data = await res.json()
expect(data.nodes).toHaveLength(1)
expect(data.nodes[0].id).toBe('log1')
expect(authzService.hasPermission).toHaveBeenCalledWith(
expect.objectContaining({
permission: Permission.Admin,
type: ResourceType.Team,
id: 't1',
}),
)
})
})
})
+66 -2
View File
@@ -4,7 +4,6 @@ import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/a
import { teamService } from '@shumai/core/src/team/team'
import { userMetadataService } from '@shumai/core/src/user-metadata/user-metadata'
import { notificationService } from '@shumai/core/src/notification/notification'
import { NotificationType } from '@shumai/db'
import {
createTeamRequestSchema,
getUserTeamsRequestSchema,
@@ -14,10 +13,17 @@ import {
updateMeRequestSchema,
updateTeamMemberRoleRequestSchema,
createApiTokenRequestSchema,
listAuditLogsQuerySchema,
} from '@shumai/dtos'
import {
updateUserMetadataRequestSchema,
getTeamAiUsageQuerySchema,
AuditAction,
} from '@shumai/dtos'
import { updateUserMetadataRequestSchema, getTeamAiUsageQuerySchema } from '@shumai/dtos'
import { apiTokenService } from '@shumai/core/src/user/api-token'
import { aiUsageService } from '@shumai/core/src/ai-usage/ai-usage'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import { NotificationType } from '@shumai/db'
import type { Prisma } from '@shumai/db'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -28,6 +34,12 @@ const route = new Hono<{ Variables: { user: User } }>()
const req = c.req.valid('json')
const newTeam = await teamService.createTeam(user, req)
await auditLogService.logAction({
action: AuditAction.team_create,
teamId: newTeam.id,
userId: user.id,
itemId: newTeam.id,
})
return c.json(newTeam)
})
.get('/teams', zValidator('query', getUserTeamsRequestSchema), async (c) => {
@@ -62,6 +74,13 @@ const route = new Hono<{ Variables: { user: User } }>()
userId: user.id,
})
await auditLogService.logAction({
action: AuditAction.team_member_add,
teamId,
userId: user.id,
itemId: user.id,
})
return new Response(null, { status: 204 })
})
.get('/teams/:teamId/me', async (c) => {
@@ -139,6 +158,13 @@ const route = new Hono<{ Variables: { user: User } }>()
role: req.role,
})
await auditLogService.logAction({
action: AuditAction.team_member_update,
teamId,
userId: user.id,
itemId: userId,
})
return c.json({ success: true })
},
)
@@ -156,6 +182,13 @@ const route = new Hono<{ Variables: { user: User } }>()
await teamService.removeMember(teamId, userId)
await auditLogService.logAction({
action: AuditAction.team_member_remove,
teamId,
userId: user.id,
itemId: userId,
})
return c.json({ success: true })
})
.get('/teams/:teamId/settings', async (c) => {
@@ -188,6 +221,14 @@ const route = new Hono<{ Variables: { user: User } }>()
})
const settings = await teamService.updateSettings(teamId, req.key, req.value)
await auditLogService.logAction({
action: AuditAction.team_update,
teamId,
userId: user.id,
itemId: teamId,
})
return c.json(settings)
},
)
@@ -334,5 +375,28 @@ const route = new Hono<{ Variables: { user: User } }>()
return c.json(stats)
})
.get('/teams/:teamId/audit-logs', zValidator('query', listAuditLogsQuerySchema), async (c) => {
const user = c.get('user')
const teamId = c.req.param('teamId')
const query = c.req.valid('query')
await authzService.hasPermission({
user,
permission: Permission.Admin,
type: ResourceType.Team,
id: teamId,
})
const logs = await auditLogService.listAuditLogs({
teamId,
actions: query.actions,
userIds: query.userIds,
itemId: query.itemId,
first: query.first,
after: query.after,
})
return c.json(logs)
})
export default route
+20
View File
@@ -7,6 +7,15 @@ import type { CreateUploadTaskResponse, TaskInfo } from '@shumai/dtos'
import type { PaginatedData } from '@shumai/core/src/pagination'
import { authzService, ResourceType, Permission } from '@shumai/core/src/authz/authz'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import { assetService } from '@shumai/core/src/asset/asset'
vi.mock('@shumai/core/src/auditLog/auditLog', () => ({
auditLogService: {
logAction: vi.fn().mockResolvedValue({}),
},
}))
vi.mock('./middleware/auth', () => ({
// We use any here because mocking Hono context and middleware
// with full type safety is overly complex for these unit tests.
@@ -98,6 +107,10 @@ describe('Upload API', () => {
it('PATCH /teams/:teamId/upload/tasks/:taskId', async () => {
vi.spyOn(uploadService, 'confirmFileUpload').mockResolvedValue(undefined)
vi.spyOn(assetService, 'getAssetContext').mockResolvedValue({
teamId: 'team1',
projectId: 'p1',
})
const res = await app.request('/teams/team1/upload/tasks/task1', {
method: 'PATCH',
@@ -118,5 +131,12 @@ describe('Upload API', () => {
expect(uploadService.confirmFileUpload).toHaveBeenCalledWith('user1', 'task1', {
fileId: 'file1',
})
expect(auditLogService.logAction).toHaveBeenCalledWith({
action: 'file_create',
teamId: 'team1',
userId: 'user1',
projectId: 'p1',
itemId: 'file1',
})
})
})
+12 -1
View File
@@ -6,9 +6,11 @@ import {
createUploadTaskRequestSchema,
localUploadQuerySchema,
} from '@shumai/dtos'
import { paginationParamsSchema } from '@shumai/dtos'
import { paginationParamsSchema, AuditAction } from '@shumai/dtos'
import { authzService, Permission, ResourceType } from '@shumai/core/src/authz/authz'
import { notificationService } from '@shumai/core/src/notification/notification'
import { auditLogService } from '@shumai/core/src/auditLog/auditLog'
import { assetService } from '@shumai/core/src/asset/asset'
import { NotificationType } from '@shumai/db'
import { s3Service, verifyLocalUrlSignature } from '@shumai/core/src/s3/s3'
import type { Prisma } from '@shumai/db'
@@ -108,6 +110,15 @@ const route = new Hono<{ Variables: { user: User } }>()
assetId: req.fileId,
taskId: taskId,
})
const context = await assetService.getAssetContext(req.fileId)
await auditLogService.logAction({
action: AuditAction.file_create,
teamId: teamId,
userId: user.id,
projectId: context.projectId,
itemId: req.fileId,
})
}
return c.json({ success: true })
+3 -2
View File
@@ -1,12 +1,13 @@
{
"name": "@shumai/core",
"version": "0.3.2",
"version": "0.3.3",
"private": true,
"type": "module",
"main": "./src/index.ts",
"types": "./src/index.ts",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@earendil-works/pi-agent-core": "0.82.1",
"@earendil-works/pi-ai": "0.82.1",
"@shumai/db": "workspace:*",
"@shumai/dtos": "workspace:*",
"@sinclair/typebox": "0.34.49",
+22
View File
@@ -399,4 +399,26 @@ describe('AgentService', () => {
expect(found?.creator?.name).toBe('Regular User')
})
})
describe('getAgent', () => {
test('returns agent when it exists', async () => {
const db = prisma
const svc = new AgentService()
const { agent } = await setupTestData(db)
const result = await svc.getAgent({ agentId: agent.id })
expect(result).not.toBeNull()
expect(result?.id).toBe(agent.id)
expect(result?.type).toBe('chat')
})
test('returns null for non-existent ID', async () => {
const svc = new AgentService()
const result = await svc.getAgent({ agentId: 'nonexistent-id' })
expect(result).toBeNull()
})
})
})
+6
View File
@@ -300,6 +300,12 @@ export class AgentService {
})
}
async getAgent(params: { agentId: string }) {
return this.prismaClient.agent.findUnique({
where: { id: params.agentId },
})
}
async deleteAgent(params: DeleteAgentParams) {
const { agentId } = params
+33
View File
@@ -2721,4 +2721,37 @@ describe('AssetService — natural sort by name', () => {
expect(info.sizeByte).toBe(largeSize)
})
})
describe('getAssetContext', () => {
it('returns context for project asset', async () => {
const user = await prisma.user.create({
data: { name: 'User_Ctx_' + Date.now(), email: `test-ctx-${Date.now()}@example.com` },
})
const team = await prisma.team.create({
data: { name: 'Team_Ctx_' + Date.now() },
})
const project = await prisma.project.create({
data: { name: 'Project_Ctx', teamId: team.id },
})
const asset = await prisma.asset.create({
data: {
name: 'Asset_Ctx',
type: AssetType.folder,
projectId: project.id,
creatorId: user.id,
status: AssetStatus.uploaded,
},
})
const context = await assetService.getAssetContext(asset.id)
expect(context.projectId).toBe(project.id)
expect(context.teamId).toBe(team.id)
})
it('throws error when asset is not found', async () => {
await expect(assetService.getAssetContext('non-existent-id')).rejects.toThrow(
'Asset not found: non-existent-id',
)
})
})
})
+5 -3
View File
@@ -864,7 +864,7 @@ export class AssetService {
return info
}
async getAssetContext(assetId: string): Promise<{ teamId: string; projectId?: string } | null> {
async getAssetContext(assetId: string): Promise<{ teamId: string; projectId?: string }> {
const asset = await this.prismaClient.asset.findUnique({
where: { id: assetId },
select: {
@@ -874,7 +874,9 @@ export class AssetService {
},
})
if (!asset) return null
if (!asset) {
throw new Error(`Asset not found: ${assetId}`)
}
if (asset.project) {
return { teamId: asset.project.teamId, projectId: asset.projectId ?? undefined }
@@ -884,7 +886,7 @@ export class AssetService {
return { teamId: asset.teamRootFolder.id }
}
return null
throw new Error(`Asset has no team context: ${assetId}`)
}
async resolveTargetAssetId(assetId: string): Promise<string> {
@@ -0,0 +1,87 @@
import { describe, it, expect } from 'vitest'
import { prisma } from '@shumai/db'
import { AuditAction } from '@shumai/dtos'
import { setupTestDbHooks } from '@shumai/db/test'
import { auditLogService } from './auditLog'
describe('AuditLogService', () => {
setupTestDbHooks()
it('creates and lists audit logs with pagination and filters', async () => {
const user = await prisma.user.create({
data: { name: 'Audit Test User', email: 'audit@example.com', password: 'password' },
})
const team = await prisma.team.create({
data: { name: 'Audit Test Team' },
})
const project = await prisma.project.create({
data: { name: 'Audit Test Project', teamId: team.id },
})
// Create action logs
const log1 = await auditLogService.logAction({
action: AuditAction.project_create,
teamId: team.id,
userId: user.id,
projectId: project.id,
itemId: project.id,
})
const log2 = await auditLogService.logAction({
action: AuditAction.project_update,
teamId: team.id,
userId: user.id,
projectId: project.id,
itemId: project.id,
})
expect(log1).toBeDefined()
expect(log2).toBeDefined()
// Test list all audit logs for team
const resultAll = await auditLogService.listAuditLogs({
teamId: team.id,
})
expect(resultAll.total).toBe(2)
expect(resultAll.nodes).toHaveLength(2)
expect(resultAll.nodes[0].action).toBe(AuditAction.project_update)
expect(resultAll.nodes[1].action).toBe(AuditAction.project_create)
// Test filtering by action
const resultAction = await auditLogService.listAuditLogs({
teamId: team.id,
actions: [AuditAction.project_create],
})
expect(resultAction.total).toBe(1)
expect(resultAction.nodes[0].action).toBe(AuditAction.project_create)
// Test filtering by user ID
const resultUser = await auditLogService.listAuditLogs({
teamId: team.id,
userIds: [user.id],
})
expect(resultUser.total).toBe(2)
// Test filtering by item ID
const resultItem = await auditLogService.listAuditLogs({
teamId: team.id,
itemId: project.id,
})
expect(resultItem.total).toBe(2)
})
it('handles database errors gracefully and logs error without throwing', async () => {
const result = await auditLogService.logAction({
action: AuditAction.project_create,
teamId: 'invalid-non-existent-team-id',
})
expect(result).toBeNull()
})
})
+90
View File
@@ -0,0 +1,90 @@
import { prisma } from '@shumai/db'
import type { Prisma } from '@shumai/db'
import type { AuditAction } from '@shumai/dtos'
import { paginateQuery } from '@shumai/core/src/pagination'
import { logger } from '@shumai/core/src/logger'
export interface LogActionParams {
action: AuditAction
teamId: string
userId?: string
projectId?: string
itemId?: string
}
export interface ListAuditLogsParams {
teamId: string
actions?: AuditAction[]
userIds?: string[]
itemId?: string
first?: number
after?: string
}
export class AuditLogService {
async logAction(params: LogActionParams) {
try {
return await prisma.auditLog.create({
data: {
action: params.action,
teamId: params.teamId,
userId: params.userId,
projectId: params.projectId,
itemId: params.itemId,
},
})
} catch (err) {
logger.error({ err, params }, 'Failed to create audit log')
return null
}
}
async listAuditLogs(params: ListAuditLogsParams) {
const where: Prisma.AuditLogWhereInput = {
teamId: params.teamId,
}
if (params.actions && params.actions.length > 0) {
where.action = { in: params.actions }
}
if (params.userIds && params.userIds.length > 0) {
where.userId = { in: params.userIds }
}
if (params.itemId && params.itemId.trim() !== '') {
where.itemId = { contains: params.itemId.trim(), mode: 'insensitive' }
}
const result = await paginateQuery(
(skip, take) =>
prisma.auditLog.findMany({
where,
orderBy: { id: 'desc' },
skip,
take,
}),
() => prisma.auditLog.count({ where }),
{ first: params.first, after: params.after },
)
return {
nodes: result.data.map((item) => ({
id: item.id,
action: item.action,
teamId: item.teamId,
userId: item.userId,
projectId: item.projectId,
itemId: item.itemId,
createdAt: item.createdAt.toISOString(),
})),
pageInfo: {
hasNextPage: !!result.pageInfo.cursor,
endCursor: result.pageInfo.cursor || null,
},
total: result.pageInfo.total ?? 0,
}
}
}
export const auditLogService = new AuditLogService()

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