mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-22 19:17:38 +00:00
* feat(project): add recent viewed files section to project folder tree * feat(webui): disable toolbar buttons and context menu in recents page * test(core): optimize recents cap test execution time * feat(webui): show hint text in recents page top toolbar * feat(webui): rename recents section to Recently Viewed * refactor(core): consolidate recents methods into AssetService * fix(api): forward pagination parameters in folder children endpoint (#349) * fix(project-recents): scope views and disable recents mutations * fix(api): allow recent views in demo mode * fix(api): limit demo recent view exception to post
457 lines
14 KiB
TypeScript
457 lines
14 KiB
TypeScript
import { describe, expect, it, vi, beforeEach } from 'vitest'
|
|
import { Hono, type Context, type Next } from 'hono'
|
|
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 (
|
|
c: Context<{ Variables: { user: { id: string; name: string } } }>,
|
|
next: Next,
|
|
) => {
|
|
c.set('user', { id: 'user1', name: 'Test User' })
|
|
await next()
|
|
},
|
|
}))
|
|
|
|
vi.mock('@shumai/core/src/authz/authz')
|
|
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/core/src/auditLog/auditLog', () => ({
|
|
auditLogService: {
|
|
logAction: vi.fn().mockResolvedValue({}),
|
|
listAuditLogs: vi.fn().mockResolvedValue({ nodes: [], pageInfo: {}, total: 0 }),
|
|
},
|
|
}))
|
|
|
|
describe('project api', () => {
|
|
const app = new Hono<{ Variables: { user: { id: string; name: string } } }>()
|
|
.use('*', async (c, next) => {
|
|
c.set('user', { id: 'user1', name: 'Test User' })
|
|
await next()
|
|
})
|
|
.route('/', projectRoute)
|
|
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks()
|
|
vi.mocked(authzService.hasPermission).mockResolvedValue(undefined)
|
|
})
|
|
|
|
it('GET /teams/:teamId/projects', async () => {
|
|
vi.mocked(projectService.listProjects).mockResolvedValue({
|
|
data: [{ id: 'foo', name: 'foo.png', rootFolder: 'uid' }] as any, // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
pageInfo: { total: 100, cursor: 'abc' },
|
|
})
|
|
|
|
const res = await app.request('/teams/t/projects?page_size=10')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.data).toHaveLength(1)
|
|
expect(json.pageInfo.total).toBe(100)
|
|
expect(json.data[0].id).toBe('foo')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Team,
|
|
id: 't',
|
|
})
|
|
})
|
|
|
|
it('POST /teams/:teamId/projects', async () => {
|
|
vi.mocked(projectService.createProject).mockResolvedValue({
|
|
id: 'foo',
|
|
name: 'foo.png',
|
|
coverImage: 'http://s3/bucket/key',
|
|
} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
|
|
const res = await app.request('/teams/t/projects', {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({ name: 'foo.png', coverImageKey: 'key' }),
|
|
})
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.id).toBe('foo')
|
|
expect(json.name).toBe('foo.png')
|
|
expect(json.coverImage).toBe('http://s3/bucket/key')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Edit,
|
|
type: ResourceType.Team,
|
|
id: 't',
|
|
})
|
|
})
|
|
|
|
it('PUT /projects/:projectId', async () => {
|
|
vi.mocked(projectService.updateProject).mockResolvedValue({
|
|
id: 'foo',
|
|
name: 'updated',
|
|
coverImage: 'http://s3/bucket/key',
|
|
} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
|
|
const res = await app.request('/projects/foo', {
|
|
method: 'PUT',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({ name: 'updated' }),
|
|
})
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.name).toBe('updated')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Edit,
|
|
type: ResourceType.Project,
|
|
id: 'foo',
|
|
})
|
|
})
|
|
|
|
it('GET /projects/:projectId', async () => {
|
|
vi.mocked(projectService.getProject).mockResolvedValue({
|
|
id: 'p',
|
|
name: 'foo.png',
|
|
rootFolder: 'root_folder_id',
|
|
} as any) // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
|
|
const res = await app.request('/projects/p')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.rootFolder).toBe('root_folder_id')
|
|
expect(json.id).toBe('p')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p',
|
|
})
|
|
})
|
|
|
|
it('GET /projects/:projectId/team', async () => {
|
|
vi.mocked(projectService.getProjectTeam).mockResolvedValue('teamId')
|
|
|
|
const res = await app.request('/projects/p/team')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.teamId).toBe('teamId')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p',
|
|
})
|
|
})
|
|
|
|
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', {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({
|
|
newParentId: 'new_parent_id',
|
|
assetIds: ['asset_1', 'asset_2'],
|
|
}),
|
|
})
|
|
|
|
expect(res.status).toBe(204)
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Edit,
|
|
type: ResourceType.Asset,
|
|
id: 'new_parent_id',
|
|
})
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Edit,
|
|
type: ResourceType.Asset,
|
|
id: 'asset_1',
|
|
})
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Edit,
|
|
type: ResourceType.Asset,
|
|
id: 'asset_2',
|
|
})
|
|
expect(assetService.reparentAssets).toHaveBeenCalledWith({
|
|
newParentId: 'new_parent_id',
|
|
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 () => {
|
|
vi.mocked(assetService.emptyTrash).mockResolvedValue(undefined)
|
|
|
|
const res = await app.request('/projects/p1/empty-trash', {
|
|
method: 'POST',
|
|
})
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json).toEqual({ success: true })
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Admin,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(assetService.emptyTrash).toHaveBeenCalledWith('p1')
|
|
})
|
|
|
|
it('GET /projects/:projectId/members', async () => {
|
|
vi.mocked(projectService.listProjectMembers).mockResolvedValue([
|
|
{
|
|
id: 'user1',
|
|
name: 'Test User',
|
|
role: 'editor',
|
|
type: 'human',
|
|
},
|
|
])
|
|
|
|
const res = await app.request('/projects/p1/members')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json).toEqual([
|
|
{
|
|
id: 'user1',
|
|
name: 'Test User',
|
|
role: 'editor',
|
|
type: 'human',
|
|
},
|
|
])
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(projectService.listProjectMembers).toHaveBeenCalledWith({
|
|
projectId: 'p1',
|
|
includeAgents: false,
|
|
requesterUserId: 'user1',
|
|
})
|
|
})
|
|
|
|
it('GET /projects/:projectId/members?includeAgents=true', async () => {
|
|
vi.mocked(projectService.listProjectMembers).mockResolvedValue([
|
|
{
|
|
id: 'user1',
|
|
name: 'Test User',
|
|
role: 'editor',
|
|
type: 'human',
|
|
},
|
|
{
|
|
id: 'agent1',
|
|
name: 'Agent Bot',
|
|
role: 'bot',
|
|
type: 'agent',
|
|
},
|
|
])
|
|
|
|
const res = await app.request('/projects/p1/members?includeAgents=true')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json).toHaveLength(2)
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(projectService.listProjectMembers).toHaveBeenCalledWith({
|
|
projectId: 'p1',
|
|
includeAgents: true,
|
|
requesterUserId: 'user1',
|
|
})
|
|
})
|
|
|
|
it('POST /projects/:projectId/members', async () => {
|
|
vi.mocked(projectService.addProjectMember).mockResolvedValue(undefined)
|
|
|
|
const res = await app.request('/projects/p1/members', {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({ userId: 'user2', role: 'editor' }),
|
|
})
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json).toEqual({ success: true })
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Admin,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(projectService.addProjectMember).toHaveBeenCalledWith({
|
|
projectId: 'p1',
|
|
userId: 'user2',
|
|
role: 'editor',
|
|
})
|
|
})
|
|
|
|
it('GET /projects/:projectId/me', async () => {
|
|
vi.mocked(projectService.getProjectMe).mockResolvedValue({
|
|
id: 'user1',
|
|
name: 'Test User',
|
|
role: 'editor',
|
|
})
|
|
|
|
const res = await app.request('/projects/p1/me')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json).toEqual({
|
|
id: 'user1',
|
|
name: 'Test User',
|
|
role: 'editor',
|
|
})
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(projectService.getProjectMe).toHaveBeenCalledWith('p1', 'user1')
|
|
})
|
|
|
|
it('GET /projects', async () => {
|
|
vi.mocked(projectService.getUserProjects).mockResolvedValue([
|
|
{
|
|
id: 'proj1',
|
|
name: 'My Project',
|
|
teamId: 'team1',
|
|
rootFolder: 'folder1',
|
|
enableNotification: true,
|
|
updatedAt: '2026-06-21T00:00:00.000Z',
|
|
},
|
|
] as unknown as ProjectInfo[])
|
|
|
|
const res = await app.request('/projects?first=10')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.data).toHaveLength(1)
|
|
expect(json.data[0]).toEqual({
|
|
id: 'proj1',
|
|
name: 'My Project',
|
|
teamId: 'team1',
|
|
rootFolder: 'folder1',
|
|
enableNotification: true,
|
|
updatedAt: '2026-06-21T00:00:00.000Z',
|
|
})
|
|
expect(projectService.getUserProjects).toHaveBeenCalledWith('user1', 10)
|
|
})
|
|
|
|
it('GET /projects/:projectId/recents', async () => {
|
|
vi.mocked(assetService.listRecents).mockResolvedValue({
|
|
data: [{ id: 'file1', name: 'video.mp4', type: 'file' }] as any, // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
pageInfo: { total: 1 },
|
|
})
|
|
|
|
const res = await app.request('/projects/p1/recents?first=20')
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.data).toHaveLength(1)
|
|
expect(json.data[0].id).toBe('file1')
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(assetService.listRecents).toHaveBeenCalledWith('user1', 'p1', { first: 20 })
|
|
})
|
|
|
|
it('POST /projects/:projectId/recents/view', async () => {
|
|
vi.mocked(assetService.recordRecentView).mockResolvedValue(undefined)
|
|
|
|
const res = await app.request('/projects/p1/recents/view', {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({ assetId: 'file1' }),
|
|
})
|
|
|
|
expect(res.status).toBe(200)
|
|
const json = await res.json()
|
|
expect(json.success).toBe(true)
|
|
expect(authzService.hasPermission).toHaveBeenCalledWith({
|
|
user: expect.anything(),
|
|
permission: Permission.Read,
|
|
type: ResourceType.Project,
|
|
id: 'p1',
|
|
})
|
|
expect(assetService.recordRecentView).toHaveBeenCalledWith('user1', 'p1', 'file1')
|
|
})
|
|
})
|