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,459 @@
/*
* 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, afterEach } from 'vitest';
import { renderHook, act } from '@testing-library/react';
import { ResourceType } from '@coze-arch/bot-api/permission_authz';
import {
PlaygroundApi,
patPermissionApi,
workflowApi,
intelligenceApi,
} from '@coze-arch/bot-api';
import { useAuthStore } from '../../src/auth';
// 模拟全局变量
vi.stubGlobal('IS_DEV_MODE', false);
// 模拟依赖
vi.mock('@coze-arch/bot-api', () => ({
PlaygroundApi: {
DraftBotCollaboration: vi.fn().mockResolvedValue({
data: {
creator: { id: 'creator-id', name: 'Creator' },
collaboration_list: [{ id: 'collab-id', name: 'Collaborator' }],
collaborator_roles: { 'collab-id': ['editor'] },
},
}),
GetCollaborators: vi.fn(),
},
patPermissionApi: {
AddCollaborator: vi.fn().mockResolvedValue({ code: 0 }),
RemoveCollaborator: vi.fn().mockResolvedValue({ code: 0 }),
BatchAddCollaborator: vi.fn().mockResolvedValue({ code: 0 }),
},
workflowApi: {
ListCollaborators: vi.fn().mockResolvedValue({
data: [
{ owner: true, user: { id: 'creator-id', name: 'Creator' } },
{ owner: false, user: { id: 'collab-id', name: 'Collaborator' } },
],
}),
GetWorkflowCollaborators: vi.fn(),
AddWorkflowCollaborator: vi.fn(),
},
intelligenceApi: {
ListCollaborators: vi.fn().mockResolvedValue({
data: [
{ owner: true, user: { id: 'creator-id', name: 'Creator' } },
{ owner: false, user: { id: 'collab-id', name: 'Collaborator' } },
],
}),
GetIntelligenceCollaborators: vi.fn(),
},
ResourceType: {
Bot: 'Bot',
Workflow: 'Workflow',
Intelligence: 'Intelligence',
} as any,
PrincipalType: {
User: 1,
},
}));
// 模拟 logger
vi.mock('@coze-arch/logger', () => ({
reporter: {
error: vi.fn(),
},
logger: {
createLoggerWith: vi.fn(),
},
}));
// 模拟 CustomError
vi.mock('@coze-arch/bot-error', () => ({
CustomError: vi.fn(),
}));
describe('auth', () => {
const mockSpaceId = 'test-space-id';
const mockBotId = 'test-bot-id';
const mockWorkflowId = 'test-workflow-id';
const mockIntelligenceId = 'test-intelligence-id';
const mockCreator = {
user_id: 'test-user-id',
name: 'Test User',
avatar: 'test-avatar-url',
};
const mockCreators = [mockCreator];
beforeEach(() => {
vi.clearAllMocks();
// 重置 store 状态
act(() => {
useAuthStore.setState({
collaboratorsMap: {
[ResourceType.Bot]: {},
[ResourceType.Workflow]: {},
[ResourceType.Intelligence]: {},
} as any,
// 确保 getCachedCollaborators 方法返回一个空数组
getCachedCollaborators: vi.fn().mockReturnValue([]),
});
});
// 模拟 API 响应
(PlaygroundApi.DraftBotCollaboration as any).mockResolvedValue({
data: mockCreators,
});
(workflowApi.ListCollaborators as any).mockResolvedValue({
data: mockCreators,
});
(intelligenceApi.ListCollaborators as any).mockResolvedValue({
data: mockCreators,
});
});
afterEach(() => {
vi.resetAllMocks();
});
describe('useAuthStore', () => {
it('应该初始化为空的协作者映射', () => {
const { result } = renderHook(() => useAuthStore());
expect(result.current.collaboratorsMap).toBeDefined();
});
describe('getCachedCollaborators', () => {
it('当缓存中有协作者时应该返回缓存的协作者', () => {
const { result } = renderHook(() => useAuthStore());
// 先设置缓存
act(() => {
useAuthStore.setState({
collaboratorsMap: {
[ResourceType.Bot]: {
[mockBotId]: mockCreators,
},
[ResourceType.Workflow]: {},
[ResourceType.Intelligence]: {},
} as any,
getCachedCollaborators: vi
.fn()
.mockImplementation(({ type, id }) => {
if (type === ResourceType.Bot && id === mockBotId) {
return mockCreators;
}
return [];
}),
});
});
const cachedCollaborators = result.current.getCachedCollaborators({
type: ResourceType.Bot,
id: mockBotId,
});
expect(cachedCollaborators).toEqual(mockCreators);
});
it('当缓存中没有协作者时应该返回空数组', () => {
const { result } = renderHook(() => useAuthStore());
const cachedCollaborators = result.current.getCachedCollaborators({
type: ResourceType.Bot,
id: mockBotId,
});
expect(cachedCollaborators).toEqual([]);
});
});
describe('fetchCollaborators', () => {
it('当资源类型为 Bot 时应该调用 PlaygroundApi.DraftBotCollaboration', async () => {
const { result } = renderHook(() => useAuthStore());
await act(async () => {
await result.current.fetchCollaborators({
spaceId: mockSpaceId,
resource: {
type: ResourceType.Bot,
id: mockBotId,
},
});
});
expect(PlaygroundApi.DraftBotCollaboration).toHaveBeenCalledWith({
space_id: mockSpaceId,
bot_id: mockBotId,
});
});
it('当资源类型为 Workflow 时应该调用 workflowApi.ListCollaborators', async () => {
const { result } = renderHook(() => useAuthStore());
await act(async () => {
await result.current.fetchCollaborators({
spaceId: mockSpaceId,
resource: {
type: ResourceType.Workflow,
id: mockWorkflowId,
},
});
});
expect(workflowApi.ListCollaborators).toHaveBeenCalledWith({
space_id: mockSpaceId,
workflow_id: mockWorkflowId,
});
});
it('当资源类型为 Intelligence 时应该调用 intelligenceApi.ListCollaborators', async () => {
const { result } = renderHook(() => useAuthStore());
await act(async () => {
await result.current.fetchCollaborators({
spaceId: mockSpaceId,
resource: {
type: ResourceType.Workflow as any,
id: mockIntelligenceId,
},
});
});
expect(workflowApi.ListCollaborators as any).toHaveBeenCalledWith({
space_id: mockSpaceId,
workflow_id: mockIntelligenceId,
});
});
it('当资源类型不支持时应该抛出错误', async () => {
const { result } = renderHook(() => useAuthStore());
await expect(
result.current.fetchCollaborators({
spaceId: mockSpaceId,
resource: {
type: 'UnsupportedType' as any,
id: 'test-id',
},
}),
).rejects.toThrow();
});
});
describe('addCollaborator', () => {
it('当资源类型为 Bot 时应该调用 patPermissionApi.AddCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
// 确保 getCachedCollaborators 返回一个空数组
vi.spyOn(result.current, 'getCachedCollaborators').mockReturnValue([]);
(patPermissionApi.AddCollaborator as any).mockResolvedValue({});
await act(async () => {
await result.current.addCollaborator({
resource: {
type: ResourceType.Bot,
id: mockBotId,
},
user: mockCreator,
roles: ['editor'] as any,
});
});
console.log(patPermissionApi.AddCollaborator.mock.calls[0][0]);
expect(patPermissionApi.AddCollaborator.mock.calls[0][0]).toMatchObject(
{
resource: { type: 4, id: 'test-bot-id' },
principal: { id: '', type: 1 },
collaborator_types: ['editor'],
},
);
});
it('当资源类型为 Workflow 时应该调用 workflowApi.AddWorkflowCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
(workflowApi.AddWorkflowCollaborator as any).mockResolvedValue({});
patPermissionApi.AddCollaborator.mockResolvedValue({});
await act(async () => {
await result.current.addCollaborator({
resource: {
type: ResourceType.Workflow,
id: mockWorkflowId,
},
user: mockCreator,
roles: ['editor'] as any,
});
});
expect(patPermissionApi.AddCollaborator as any).toHaveBeenCalledWith(
{
resource: { type: ResourceType.Workflow, id: 'test-workflow-id' },
principal: { id: '', type: 1 },
collaborator_types: ['editor'],
},
undefined,
);
});
});
describe('removeCollaborators', () => {
it('当资源类型为 Bot 时应该调用 patPermissionApi.RemoveCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
(patPermissionApi.RemoveCollaborator as any).mockResolvedValue({});
await act(async () => {
await result.current.removeCollaborators(
{
type: ResourceType.Bot,
id: mockBotId,
},
mockCreator.user_id,
);
});
expect(patPermissionApi.RemoveCollaborator).toHaveBeenCalledWith(
{
resource: { type: 4, id: 'test-bot-id' },
principal: { id: 'test-user-id', type: 1 },
},
undefined,
);
});
});
describe('batchRemoveCollaborators', () => {
it('应该调用 patPermissionApi.RemoveCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
const mockUserIds = ['user1', 'user2'];
const mockSuccessIds = ['user1'];
const mockFailedIds = ['user2'];
(patPermissionApi.RemoveCollaborator as any).mockResolvedValueOnce({});
(patPermissionApi.RemoveCollaborator as any).mockRejectedValueOnce({});
await act(async () => {
const [successIds, failedIds] =
await result.current.batchRemoveCollaborators(
{
type: ResourceType.Bot,
id: mockBotId,
},
mockUserIds,
);
expect(successIds).toEqual(mockSuccessIds);
expect(failedIds).toEqual(mockFailedIds);
});
expect(patPermissionApi.RemoveCollaborator).toHaveBeenCalledTimes(2);
});
});
describe('batchAddCollaborators', () => {
it('当资源类型为 Bot 时应该调用 patPermissionApi.AddCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
// 确保 getCachedCollaborators 返回一个空数组
vi.spyOn(result.current, 'getCachedCollaborators').mockReturnValue([]);
const mockUsers = [
mockCreator,
{
user_id: 'test-user-id2',
name: 'Test User2',
avatar: 'test-avatar-url2',
},
];
const mockSuccessUsers = mockUsers;
const mockFailedUsers: any[] = [];
(patPermissionApi.AddCollaborator as any).mockResolvedValue({
data: {
success_users: mockSuccessUsers,
failed_users: mockFailedUsers,
},
});
await act(async () => {
const [successUsers, failedUsers, errorCode] =
await result.current.batchAddCollaborators({
resource: {
type: ResourceType.Bot,
id: mockBotId,
},
users: mockUsers,
roles: ['editor'] as any,
});
expect(successUsers).toEqual(mockSuccessUsers);
expect(failedUsers).toEqual(mockFailedUsers);
expect(errorCode).toBe(0);
});
expect(patPermissionApi.AddCollaborator).toHaveBeenCalledTimes(2);
});
});
describe('batchAddCollaboratorsServer', () => {
it('应该调用 patPermissionApi.BatchAddCollaborator', async () => {
const { result } = renderHook(() => useAuthStore());
(patPermissionApi.BatchAddCollaborator as any).mockResolvedValue({
code: 0,
data: {
success: true,
},
});
await act(async () => {
const success = await result.current.batchAddCollaboratorsServer({
resource: {
type: ResourceType.Bot,
id: mockBotId,
},
users: [{ id: 'test-user-id' }],
roles: ['editor'] as any,
});
expect(success).toBe(true);
});
expect(patPermissionApi.BatchAddCollaborator).toHaveBeenCalledWith(
{
principal_ids: ['test-user-id'],
principal_type: 1,
resource: { type: 4, id: 'test-bot-id' },
},
undefined,
);
});
});
});
});

View File

@@ -0,0 +1,233 @@
/*
* 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, afterEach } from 'vitest';
import { renderHook, act } from '@testing-library/react';
import { reporter } from '@coze-arch/logger';
import { workflowApi } from '@coze-arch/bot-api';
import { useSpaceGrayStore, TccKey } from '../../src/space-gray';
// 模拟全局变量
vi.stubGlobal('IS_DEV_MODE', false);
vi.stubGlobal('IS_BOT_OP', false);
// 模拟依赖
vi.mock('@coze-arch/logger', () => ({
reporter: {
error: vi.fn(),
},
}));
vi.mock('@coze-arch/bot-api', () => ({
workflowApi: {
GetWorkflowGrayFeature: vi.fn(),
OPGetWorkflowGrayFeature: vi.fn(),
},
}));
describe('space-gray', () => {
const mockSpaceId = 'test-space-id';
const mockFeatureItems = [
{
feature: TccKey.ImageGenerateConverter,
in_gray: true,
},
];
beforeEach(() => {
vi.clearAllMocks();
// 重置 store 状态
act(() => {
useSpaceGrayStore.setState({
spaceId: '',
grayFeatureItems: [],
});
});
// 模拟 API 响应
(workflowApi.GetWorkflowGrayFeature as any).mockResolvedValue({
data: mockFeatureItems,
});
(workflowApi.OPGetWorkflowGrayFeature as any).mockResolvedValue({
data: mockFeatureItems,
});
});
afterEach(() => {
vi.resetAllMocks();
});
describe('TccKey', () => {
it('应该定义 ImageGenerateConverter 常量', () => {
expect(TccKey.ImageGenerateConverter).toBe('ImageGenerateConverter');
});
});
describe('useSpaceGrayStore', () => {
it('应该初始化为空状态', () => {
const { result } = renderHook(() => useSpaceGrayStore());
expect(result.current.spaceId).toBe('');
expect(result.current.grayFeatureItems).toEqual([]);
});
describe('load', () => {
it('应该调用 GetWorkflowGrayFeature API 并更新状态', async () => {
const { result } = renderHook(() => useSpaceGrayStore());
await act(async () => {
await result.current.load(mockSpaceId);
});
expect(workflowApi.GetWorkflowGrayFeature).toHaveBeenCalledWith({
space_id: mockSpaceId,
});
expect(result.current.spaceId).toBe(mockSpaceId);
expect(result.current.grayFeatureItems).toEqual(mockFeatureItems);
});
it('当 IS_BOT_OP 为 true 时应该调用 OPGetWorkflowGrayFeature API', async () => {
// 设置 IS_BOT_OP 为 true
vi.stubGlobal('IS_BOT_OP', true);
const { result } = renderHook(() => useSpaceGrayStore());
await act(async () => {
await result.current.load(mockSpaceId);
});
expect(workflowApi.OPGetWorkflowGrayFeature).toHaveBeenCalledWith({
space_id: mockSpaceId,
});
expect(result.current.spaceId).toBe(mockSpaceId);
expect(result.current.grayFeatureItems).toEqual(mockFeatureItems);
// 恢复 IS_BOT_OP 为 false
vi.stubGlobal('IS_BOT_OP', false);
});
it('当 spaceId 与缓存的相同时不应该调用 API', async () => {
const { result } = renderHook(() => useSpaceGrayStore());
// 先加载一次
await act(async () => {
await result.current.load(mockSpaceId);
});
// 清除之前的调用记录
vi.clearAllMocks();
// 再次加载相同的 spaceId
await act(async () => {
await result.current.load(mockSpaceId);
});
expect(workflowApi.GetWorkflowGrayFeature).not.toHaveBeenCalled();
});
it('当 API 调用失败时应该记录错误', async () => {
const mockError = new Error('API error');
(workflowApi.GetWorkflowGrayFeature as any).mockRejectedValue(
mockError,
);
const { result } = renderHook(() => useSpaceGrayStore());
await act(async () => {
await result.current.load(mockSpaceId);
});
expect(reporter.error).toHaveBeenCalledWith({
message: 'workflow_prefetch_tcc_fail',
namespace: 'workflow',
error: mockError,
});
});
});
describe('isHitSpaceGray', () => {
it('当特性在灰度列表中且 in_gray 为 true 时应该返回 true', async () => {
const { result } = renderHook(() => useSpaceGrayStore());
// 先加载灰度特性
await act(async () => {
await result.current.load(mockSpaceId);
});
const isHit = result.current.isHitSpaceGray(
TccKey.ImageGenerateConverter,
);
expect(isHit).toBe(true);
});
it('当特性在灰度列表中但 in_gray 为 false 时应该返回 false', async () => {
const mockFeatureItemsWithFalse = [
{
feature: TccKey.ImageGenerateConverter,
in_gray: false,
},
];
(workflowApi.GetWorkflowGrayFeature as any).mockResolvedValue({
data: mockFeatureItemsWithFalse,
});
const { result } = renderHook(() => useSpaceGrayStore());
// 先加载灰度特性
await act(async () => {
await result.current.load(mockSpaceId);
});
const isHit = result.current.isHitSpaceGray(
TccKey.ImageGenerateConverter,
);
expect(isHit).toBe(false);
});
it('当特性不在灰度列表中时应该返回 false', async () => {
const { result } = renderHook(() => useSpaceGrayStore());
// 先加载灰度特性
await act(async () => {
await result.current.load(mockSpaceId);
});
// 使用一个不存在的 key
const isHit = result.current.isHitSpaceGray('NonExistentKey' as TccKey);
expect(isHit).toBe(false);
});
it('当灰度列表为空时应该返回 false', () => {
const { result } = renderHook(() => useSpaceGrayStore());
const isHit = result.current.isHitSpaceGray(
TccKey.ImageGenerateConverter,
);
expect(isHit).toBe(false);
});
});
});
});

View File

@@ -0,0 +1,80 @@
/*
* 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 localForage from 'localforage';
import { getStorage, clearStorage } from '../../src/utils/get-storage';
vi.mock('localforage', () => ({
default: {
createInstance: vi.fn().mockImplementation(
(() => {
const cache = {
getItem: vi.fn(),
setItem: vi.fn(),
removeItem: vi.fn(),
clear: vi.fn(),
};
return () => cache;
})(),
),
},
}));
describe('get-storage', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('should return an object with getItem, setItem, and removeItem methods', () => {
const storage = getStorage();
expect(storage).toHaveProperty('getItem');
expect(storage).toHaveProperty('setItem');
expect(storage).toHaveProperty('removeItem');
});
it('getItem should call localforage.getItem with the correct key', async () => {
const instance = localForage.createInstance();
instance.getItem.mockResolvedValue('value');
const storage = getStorage();
const result = await storage.getItem('key');
expect(instance.getItem).toHaveBeenCalledWith('key');
expect(result).toBe('value');
});
it('setItem should call localforage.setItem with the correct key and value', async () => {
const storage = getStorage();
const instance = localForage.createInstance();
await storage.setItem('key', 'value');
expect(instance.setItem).toHaveBeenCalledWith('key', 'value');
});
it('removeItem should call localforage.removeItem with the correct key', async () => {
const storage = getStorage();
await storage.removeItem('key');
const instance = localForage.createInstance();
expect(instance.removeItem).toHaveBeenCalledWith('key');
});
it('clearStorage should call localforage.clear', async () => {
await clearStorage();
const instance = localForage.createInstance();
expect(instance.clear).toHaveBeenCalled();
});
});