feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf
This commit is contained in:
fanlv
2025-07-20 17:36:12 +08:00
commit 890153324f
14811 changed files with 1923430 additions and 0 deletions

View File

@@ -0,0 +1,393 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect } from 'vitest';
import { SpaceRoleType, SpaceType } from '@coze-arch/idl/developer_api';
import {
ProjectRoleType,
EProjectPermission,
} from '../../src/project/constants';
import { calcPermission } from '../../src/project/calc-permission';
describe('Project Calc Permission', () => {
describe('个人空间权限', () => {
it('应该为个人空间返回正确的权限', () => {
const params = {
projectRoles: [],
spaceRoles: [],
spaceType: SpaceType.Personal,
};
// 个人空间应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 个人空间应该有编辑信息权限
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(true);
// 个人空间应该有删除权限
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(true);
// 个人空间应该有发布权限
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(true);
// 个人空间应该有创建资源权限
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
true,
);
// 个人空间应该有复制资源权限
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
true,
);
// 个人空间应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 个人空间应该有测试运行插件权限
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
true,
);
// 个人空间应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
});
it('应该为个人空间返回正确的无效权限', () => {
const params = {
projectRoles: [],
spaceRoles: [],
spaceType: SpaceType.Personal,
};
// 个人空间不应该有添加协作者权限
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
false,
);
// 个人空间不应该有删除协作者权限
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
});
describe('团队空间项目角色权限', () => {
it('应该为项目所有者角色返回正确的权限', () => {
const params = {
projectRoles: [ProjectRoleType.Owner],
spaceRoles: [],
spaceType: SpaceType.Team,
};
// 项目所有者应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 项目所有者应该有编辑信息权限
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(true);
// 项目所有者应该有删除权限
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(true);
// 项目所有者应该有发布权限
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(true);
// 项目所有者应该有创建资源权限
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
true,
);
// 项目所有者应该有复制资源权限
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
true,
);
// 项目所有者应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 项目所有者应该有测试运行插件权限
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
true,
);
// 项目所有者应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
// 项目所有者应该有添加协作者权限
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
true,
);
// 项目所有者应该有删除协作者权限
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(true);
});
it('应该为项目编辑者角色返回正确的权限', () => {
const params = {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [],
spaceType: SpaceType.Team,
};
// 项目编辑者应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 项目编辑者应该有编辑信息权限
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(true);
// 项目编辑者应该有创建资源权限
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
true,
);
// 项目编辑者应该有复制资源权限
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
true,
);
// 项目编辑者应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 项目编辑者应该有测试运行插件权限
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
true,
);
// 项目编辑者应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
// 项目编辑者应该有添加协作者权限
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
true,
);
// 项目编辑者不应该有删除权限
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(false);
// 项目编辑者不应该有发布权限
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(false);
// 项目编辑者不应该有删除协作者权限
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
});
describe('团队空间角色权限', () => {
it('应该为空间成员角色返回正确的权限', () => {
const params = {
projectRoles: [],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
};
// 空间成员应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 空间成员应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 空间成员应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
// 空间成员不应该有编辑信息权限
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(false);
// 空间成员不应该有删除权限
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(false);
// 空间成员不应该有发布权限
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(false);
// 空间成员不应该有创建资源权限
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
false,
);
// 空间成员不应该有复制资源权限
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
false,
);
// 空间成员不应该有测试运行插件权限
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
false,
);
// 空间成员不应该有添加协作者权限
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
false,
);
// 空间成员不应该有删除协作者权限
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
it('应该为空间所有者角色返回正确的权限', () => {
const params = {
projectRoles: [],
spaceRoles: [SpaceRoleType.Owner],
spaceType: SpaceType.Team,
};
// 空间所有者应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 空间所有者应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 空间所有者应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
});
it('应该为空间管理员角色返回正确的权限', () => {
const params = {
projectRoles: [],
spaceRoles: [SpaceRoleType.Admin],
spaceType: SpaceType.Team,
};
// 空间管理员应该有查看权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
// 空间管理员应该有复制项目权限
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
// 空间管理员应该有测试运行工作流权限
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
});
it('应该为默认角色返回正确的权限', () => {
const params = {
projectRoles: [],
spaceRoles: [SpaceRoleType.Default],
spaceType: SpaceType.Team,
};
// 默认角色不应该有任何权限
expect(calcPermission(EProjectPermission.View, params)).toBe(false);
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(false);
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(false);
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(false);
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.COPY, params)).toBe(false);
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
false,
);
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
});
describe('混合角色权限', () => {
it('应该在同时拥有项目角色和空间角色时返回正确的权限', () => {
const params = {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
};
// 应该有项目编辑者的所有权限
expect(calcPermission(EProjectPermission.View, params)).toBe(true);
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(true);
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
true,
);
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
true,
);
expect(calcPermission(EProjectPermission.COPY, params)).toBe(true);
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
true,
);
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
true,
);
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
true,
);
// 不应该有项目编辑者没有的权限
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(false);
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(false);
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
it('应该在没有有效角色时返回 false', () => {
const params = {
projectRoles: [],
spaceRoles: [],
spaceType: SpaceType.Team,
};
// 没有角色不应该有任何权限
expect(calcPermission(EProjectPermission.View, params)).toBe(false);
expect(calcPermission(EProjectPermission.EDIT_INFO, params)).toBe(false);
expect(calcPermission(EProjectPermission.DELETE, params)).toBe(false);
expect(calcPermission(EProjectPermission.PUBLISH, params)).toBe(false);
expect(calcPermission(EProjectPermission.CREATE_RESOURCE, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.COPY_RESOURCE, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.COPY, params)).toBe(false);
expect(calcPermission(EProjectPermission.TEST_RUN_PLUGIN, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.TEST_RUN_WORKFLOW, params)).toBe(
false,
);
expect(calcPermission(EProjectPermission.ADD_COLLABORATOR, params)).toBe(
false,
);
expect(
calcPermission(EProjectPermission.DELETE_COLLABORATOR, params),
).toBe(false);
});
});
});

View File

@@ -0,0 +1,90 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect } from 'vitest';
import {
ProjectRoleType,
EProjectPermission,
} from '../../src/project/constants';
describe('Project Constants', () => {
describe('ProjectRoleType', () => {
it('应该定义所有必要的角色类型', () => {
// 验证所有角色类型都已定义
expect(ProjectRoleType.Owner).toBeDefined();
expect(ProjectRoleType.Editor).toBeDefined();
// 验证角色类型的值
expect(ProjectRoleType.Owner).toBe('owner');
expect(ProjectRoleType.Editor).toBe('editor');
});
it('应该包含正确数量的角色类型', () => {
// 验证角色类型的数量
const roleTypeCount = Object.keys(ProjectRoleType).filter(key =>
isNaN(Number(key)),
).length;
expect(roleTypeCount).toBe(2); // Owner 和 Editor
});
});
describe('EProjectPermission', () => {
it('应该定义所有必要的权限点', () => {
// 验证所有权限点都已定义
expect(EProjectPermission.View).toBeDefined();
expect(EProjectPermission.EDIT_INFO).toBeDefined();
expect(EProjectPermission.DELETE).toBeDefined();
expect(EProjectPermission.PUBLISH).toBeDefined();
expect(EProjectPermission.CREATE_RESOURCE).toBeDefined();
expect(EProjectPermission.COPY_RESOURCE).toBeDefined();
expect(EProjectPermission.COPY).toBeDefined();
expect(EProjectPermission.TEST_RUN_PLUGIN).toBeDefined();
expect(EProjectPermission.TEST_RUN_WORKFLOW).toBeDefined();
expect(EProjectPermission.ADD_COLLABORATOR).toBeDefined();
expect(EProjectPermission.DELETE_COLLABORATOR).toBeDefined();
});
it('应该为每个权限点分配唯一的值', () => {
// 创建一个集合来存储所有权限点的值
const permissionValues = new Set();
// 获取所有权限点的值
Object.values(EProjectPermission)
.filter(value => typeof value === 'number')
.forEach(value => {
permissionValues.add(value);
});
// 验证权限点的数量与唯一值的数量相同
const numericKeys = Object.keys(EProjectPermission).filter(
key => !isNaN(Number(key)),
).length;
expect(permissionValues.size).toBe(numericKeys);
});
it('应该包含正确数量的权限点', () => {
// 验证权限点的数量
const permissionCount = Object.keys(EProjectPermission).filter(key =>
isNaN(Number(key)),
).length;
expect(permissionCount).toBe(12); // 11个权限点
});
});
});

View File

@@ -0,0 +1,97 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { SpaceRoleType, SpaceType } from '@coze-arch/idl/developer_api';
import {
EProjectPermission,
ProjectRoleType,
} from '../../src/project/constants';
import { calcPermission } from '../../src/project/calc-permission';
describe('calcPermission', () => {
it('should return true for personal space with valid permission', () => {
const result = calcPermission(EProjectPermission.View, {
projectRoles: [],
spaceRoles: [],
spaceType: SpaceType.Personal,
});
expect(result).toBe(true);
});
it('should return false for personal space with invalid permission', () => {
const result = calcPermission(EProjectPermission.ADD_COLLABORATOR, {
projectRoles: [],
spaceRoles: [],
spaceType: SpaceType.Personal,
});
expect(result).toBe(false);
});
it('should return true for team space with project role permission', () => {
const result = calcPermission(EProjectPermission.DELETE, {
projectRoles: [ProjectRoleType.Owner],
spaceRoles: [],
spaceType: SpaceType.Team,
});
expect(result).toBe(true);
});
it('should return false for team space with invalid project role permission', () => {
const result = calcPermission(EProjectPermission.DELETE, {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [],
spaceType: SpaceType.Team,
});
expect(result).toBe(false);
});
it('should return true for team space with space role permission', () => {
const result = calcPermission(EProjectPermission.COPY, {
projectRoles: [],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
});
expect(result).toBe(true);
});
it('should return false for team space with invalid space role permission', () => {
const result = calcPermission(EProjectPermission.DELETE, {
projectRoles: [],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
});
expect(result).toBe(false);
});
it('should return true for team space with both project and space role permissions', () => {
const result = calcPermission(EProjectPermission.PUBLISH, {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
});
expect(result).toBe(false);
});
it('should return false for team space with no valid permissions', () => {
const result = calcPermission(EProjectPermission.DELETE, {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [SpaceRoleType.Default],
spaceType: SpaceType.Team,
});
expect(result).toBe(false);
});
});

View File

@@ -0,0 +1,190 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect, beforeEach } from 'vitest';
import { renderHook, act } from '@testing-library/react-hooks';
import { ProjectRoleType } from '../../src/project/constants';
vi.stubGlobal('IS_DEV_MODE', true);
describe('Project Auth Store', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetAllMocks();
});
describe('setRoles', () => {
it('应该正确设置项目角色', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId = 'test-project-1';
const roles = [ProjectRoleType.Owner];
await act(() => {
result.current.setRoles(projectId, roles);
});
expect(result.current.roles[projectId]).toEqual(roles);
});
it('应该能够更新已存在的项目角色', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId = 'test-project-1';
const initialRoles = [ProjectRoleType.Owner];
const updatedRoles = [ProjectRoleType.Editor];
await act(() => {
result.current.setRoles(projectId, initialRoles);
});
expect(result.current.roles[projectId]).toEqual(initialRoles);
await act(() => {
result.current.setRoles(projectId, updatedRoles);
});
expect(result.current.roles[projectId]).toEqual(updatedRoles);
});
it('应该能够同时管理多个项目的角色', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId1 = 'test-project-1';
const projectId2 = 'test-project-2';
const roles1 = [ProjectRoleType.Owner];
const roles2 = [ProjectRoleType.Editor];
await act(() => {
result.current.setRoles(projectId1, roles1);
result.current.setRoles(projectId2, roles2);
});
expect(result.current.roles[projectId1]).toEqual(roles1);
expect(result.current.roles[projectId2]).toEqual(roles2);
});
});
describe('setIsReady', () => {
it('应该正确设置项目准备状态', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId = 'test-project-1';
await act(() => {
result.current.setIsReady(projectId, true);
});
expect(result.current.isReady[projectId]).toBe(true);
});
it('应该能够更新已存在的项目准备状态', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId = 'test-project-1';
await act(() => {
result.current.setIsReady(projectId, true);
});
expect(result.current.isReady[projectId]).toBe(true);
await act(() => {
result.current.setIsReady(projectId, false);
});
expect(result.current.isReady[projectId]).toBe(false);
});
it('应该能够同时管理多个项目的准备状态', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId1 = 'test-project-1';
const projectId2 = 'test-project-2';
await act(() => {
result.current.setIsReady(projectId1, true);
result.current.setIsReady(projectId2, false);
});
expect(result.current.isReady[projectId1]).toBe(true);
expect(result.current.isReady[projectId2]).toBe(false);
});
});
describe('destory', () => {
it('应该正确清除项目数据', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId = 'test-project-1';
const roles = [ProjectRoleType.Owner];
// 设置初始数据
await act(() => {
result.current.setRoles(projectId, roles);
result.current.setIsReady(projectId, true);
});
// 验证数据已设置
expect(result.current.roles[projectId]).toEqual(roles);
expect(result.current.isReady[projectId]).toBe(true);
// 销毁数据
result.current.destory(projectId);
// 验证数据已清除
expect(result.current.roles[projectId]).toEqual([]);
expect(result.current.isReady[projectId]).toBe(false);
});
it('应该只清除指定项目的数据,不影响其他项目', async () => {
const { useProjectAuthStore } = await vi.importActual(
'../../src/project/store',
);
const { result } = renderHook(() => useProjectAuthStore());
const projectId1 = 'test-project-1';
const projectId2 = 'test-project-2';
const roles1 = [ProjectRoleType.Owner];
const roles2 = [ProjectRoleType.Editor];
// 设置初始数据
result.current.setRoles(projectId1, roles1);
result.current.setRoles(projectId2, roles2);
result.current.setIsReady(projectId1, true);
result.current.setIsReady(projectId2, true);
// 销毁项目1的数据
result.current.destory(projectId1);
// 验证项目1的数据已清除项目2的数据保持不变
expect(result.current.roles[projectId1]).toEqual([]);
expect(result.current.isReady[projectId1]).toBe(false);
expect(result.current.roles[projectId2]).toEqual(roles2);
expect(result.current.isReady[projectId2]).toBe(true);
});
});
});

View File

@@ -0,0 +1,135 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { renderHook } from '@testing-library/react-hooks';
// 模拟 React 的 useEffect
const cleanupFns = new Map();
vi.mock('react', () => ({
useEffect: vi.fn((fn, deps) => {
// 执行 effect 函数并获取清理函数
const cleanup = fn();
// 存储清理函数,以便在 unmount 时调用
cleanupFns.set(fn, cleanup);
// 返回清理函数
return cleanup;
}),
}));
import { useDestoryProject } from '../../src/project/use-destory-project';
import { useProjectAuthStore } from '../../src/project/store';
// 模拟 useProjectAuthStore
vi.mock('../../src/project/store', () => {
const destorySpy = vi.fn();
return {
useProjectAuthStore: vi.fn(() => destorySpy),
};
});
// 创建一个包装函数,确保在 unmount 时调用清理函数
function renderHookWithCleanup(callback, options = {}) {
const result = renderHook(callback, options);
const originalUnmount = result.unmount;
result.unmount = () => {
// 调用所有清理函数
cleanupFns.forEach(cleanup => {
if (typeof cleanup === 'function') {
cleanup();
}
});
// 调用原始的 unmount
originalUnmount();
};
return result;
}
describe('useDestoryProject', () => {
beforeEach(() => {
vi.clearAllMocks();
cleanupFns.clear();
});
it('应该在组件卸载时调用 destory 方法', () => {
const projectId = 'test-project-id';
const destorySpy = vi.fn();
// 模拟 useProjectAuthStore 返回 destorySpy
(useProjectAuthStore as any).mockReturnValue(destorySpy);
// 渲染 hook
const { unmount } = renderHookWithCleanup(() =>
useDestoryProject(projectId),
);
// 验证初始状态下 destory 未被调用
expect(destorySpy).not.toHaveBeenCalled();
// 卸载组件
unmount();
// 验证 destory 被调用,且参数正确
expect(destorySpy).toHaveBeenCalledTimes(1);
expect(destorySpy).toHaveBeenCalledWith(projectId);
});
it('应该在组件卸载时清除正确的项目数据', () => {
const projectId1 = 'test-project-id-1';
const destorySpy = vi.fn();
// 模拟 useProjectAuthStore 返回 destorySpy
(useProjectAuthStore as any).mockReturnValue(destorySpy);
// 渲染 hook
const { unmount } = renderHookWithCleanup(() =>
useDestoryProject(projectId1),
);
// 卸载组件
unmount();
// 验证 destory 被调用,且参数为 projectId1
expect(destorySpy).toHaveBeenCalledTimes(1);
expect(destorySpy).toHaveBeenCalledWith(projectId1);
});
it('应该为不同的项目ID调用不同的清理函数', () => {
const projectId2 = 'test-project-id-2';
const destorySpy = vi.fn();
// 清除之前的所有模拟和清理函数
vi.clearAllMocks();
cleanupFns.clear();
// 模拟 useProjectAuthStore 返回 destorySpy
(useProjectAuthStore as any).mockReturnValue(destorySpy);
// 渲染 hook
const { unmount } = renderHookWithCleanup(() =>
useDestoryProject(projectId2),
);
// 卸载组件
unmount();
// 验证 destory 被调用,且参数为 projectId2
expect(destorySpy).toHaveBeenCalledTimes(1);
expect(destorySpy).toHaveBeenCalledWith(projectId2);
});
});

View File

@@ -0,0 +1,148 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { renderHook } from '@testing-library/react-hooks';
import { SpaceType } from '@coze-arch/idl/developer_api';
import { useSpace } from '@coze-arch/foundation-sdk';
import { useSpaceRole } from '../../src/space/use-space-role';
import { SpaceRoleType } from '../../src/space/constants';
import { useProjectRole } from '../../src/project/use-project-role';
import { useProjectAuth } from '../../src/project/use-project-auth';
import {
EProjectPermission,
ProjectRoleType,
} from '../../src/project/constants';
import { calcPermission } from '../../src/project/calc-permission';
// 模拟依赖
vi.mock('@coze-arch/foundation-sdk', () => ({
useSpace: vi.fn(),
}));
vi.mock('../../src/space/use-space-role', () => ({
useSpaceRole: vi.fn(),
}));
vi.mock('../../src/project/use-project-role', () => ({
useProjectRole: vi.fn(),
}));
vi.mock('../../src/project/calc-permission', () => ({
calcPermission: vi.fn(),
}));
describe('useProjectAuth', () => {
const projectId = 'test-project-id';
const spaceId = 'test-space-id';
const permissionKey = EProjectPermission.View;
beforeEach(() => {
vi.clearAllMocks();
// 模拟 useSpace 返回空间信息
(useSpace as any).mockReturnValue({
space_type: SpaceType.Team,
});
// 模拟 useSpaceRole 返回空间角色
(useSpaceRole as any).mockReturnValue([SpaceRoleType.Member]);
// 模拟 useProjectRole 返回项目角色
(useProjectRole as any).mockReturnValue([ProjectRoleType.Editor]);
// 模拟 calcPermission 返回权限结果
(calcPermission as any).mockReturnValue(true);
});
it('应该调用 calcPermission 并返回正确的权限结果', () => {
// 渲染 hook
const { result } = renderHook(() =>
useProjectAuth(permissionKey, projectId, spaceId),
);
// 验证 useSpace 被调用
expect(useSpace).toHaveBeenCalledWith(spaceId);
// 验证 useSpaceRole 被调用
expect(useSpaceRole).toHaveBeenCalledWith(spaceId);
// 验证 useProjectRole 被调用
expect(useProjectRole).toHaveBeenCalledWith(projectId);
// 验证 calcPermission 被调用,且参数正确
expect(calcPermission).toHaveBeenCalledWith(permissionKey, {
projectRoles: [ProjectRoleType.Editor],
spaceRoles: [SpaceRoleType.Member],
spaceType: SpaceType.Team,
});
// 验证返回值
expect(result.current).toBe(true);
});
it('应该在 calcPermission 返回 false 时返回 false', () => {
// 模拟 calcPermission 返回 false
(calcPermission as any).mockReturnValue(false);
// 渲染 hook
const { result } = renderHook(() =>
useProjectAuth(permissionKey, projectId, spaceId),
);
// 验证返回值
expect(result.current).toBe(false);
});
it('应该在空间类型不存在时抛出错误', () => {
// 模拟 useSpace 返回没有 space_type 的对象
(useSpace as any).mockReturnValue({});
// 使用 vi.spyOn 监听 console.error 以防止测试输出错误信息
vi.spyOn(console, 'error').mockImplementation(() => {
// 空实现,防止错误输出
});
// 验证抛出错误
expect(() => {
const { result } = renderHook(() =>
useProjectAuth(permissionKey, projectId, spaceId),
);
// 强制访问 result.current 触发错误
console.log(result.current);
}).toThrow('useSpaceAuth must be used after space list has been pulled.');
});
it('应该在空间为 null 时抛出错误', () => {
// 模拟 useSpace 返回 null
(useSpace as any).mockReturnValue(null);
// 使用 vi.spyOn 监听 console.error 以防止测试输出错误信息
vi.spyOn(console, 'error').mockImplementation(() => {
// 空实现,防止错误输出
});
// 验证抛出错误
expect(() => {
const { result } = renderHook(() =>
useProjectAuth(permissionKey, projectId, spaceId),
);
// 强制访问 result.current 触发错误
console.log(result.current);
}).toThrow('useSpaceAuth must be used after space list has been pulled.');
});
});

View File

@@ -0,0 +1,106 @@
/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { renderHook } from '@testing-library/react-hooks';
import { useProjectRole } from '../../src/project/use-project-role';
import { useProjectAuthStore } from '../../src/project/store';
import { ProjectRoleType } from '../../src/project/constants';
// 模拟依赖
vi.mock('../../src/project/store', () => ({
useProjectAuthStore: vi.fn(),
}));
describe('useProjectRole', () => {
const projectId = 'test-project-id';
beforeEach(() => {
vi.clearAllMocks();
});
it('应该返回正确的项目角色', () => {
const expectedRoles = [ProjectRoleType.Owner];
// 模拟 useProjectAuthStore 返回项目角色和 ready 状态
(useProjectAuthStore as any).mockReturnValue({
isReady: true,
role: expectedRoles,
});
// 渲染 hook
const { result } = renderHook(() => useProjectRole(projectId));
// 验证 useProjectAuthStore 被调用
expect(useProjectAuthStore).toHaveBeenCalled();
// 验证返回值
expect(result.current).toEqual(expectedRoles);
});
it('应该在项目未准备好时抛出错误', () => {
// 模拟 useProjectAuthStore 返回未准备好的状态
(useProjectAuthStore as any).mockReturnValue({
isReady: false,
role: [],
});
// 使用 vi.spyOn 监听 console.error 以防止测试输出错误信息
vi.spyOn(console, 'error').mockImplementation(() => {
// 空实现,防止错误输出
});
// 验证抛出错误
expect(() => {
const { result } = renderHook(() => useProjectRole(projectId));
// 强制访问 result.current 触发错误
console.log(result.current);
}).toThrow(
'useProjectAuth must be used after useInitProjectRole has been completed.',
);
});
it('应该在角色为 undefined 时返回空数组', () => {
// 模拟 useProjectAuthStore 返回 undefined 角色
(useProjectAuthStore as any).mockReturnValue({
isReady: true,
role: undefined,
});
// 渲染 hook
const { result } = renderHook(() => useProjectRole(projectId));
// 验证返回值为空数组
expect(result.current).toEqual([]);
});
it('应该处理多种角色类型', () => {
const expectedRoles = [ProjectRoleType.Owner, ProjectRoleType.Editor];
// 模拟 useProjectAuthStore 返回多种角色
(useProjectAuthStore as any).mockReturnValue({
isReady: true,
role: expectedRoles,
});
// 渲染 hook
const { result } = renderHook(() => useProjectRole(projectId));
// 验证返回值
expect(result.current).toEqual(expectedRoles);
});
});