@lobehub/lobehub 2.0.0-next.353 → 2.0.0-next.354

package/.agents/skills/testing/references/agent-runtime-e2e.md

@@ -0,0 +1,126 @@
+# Agent Runtime E2E Testing Guide
+
+## Core Principles
+
+### Minimal Mock Principle
+
+Only mock **three external dependencies**:
+
+| Dependency | Mock | Description |
+|------------|------|-------------|
+| Database | PGLite | In-memory database from `@lobechat/database/test-utils` |
+| Redis | InMemoryAgentStateManager | Memory implementation |
+| Redis | InMemoryStreamEventManager | Memory implementation |
+
+**NOT mocked:**
+- `model-bank` - Uses real model config
+- `Mecha` (AgentToolsEngine, ContextEngineering)
+- `AgentRuntimeService`
+- `AgentRuntimeCoordinator`
+
+### Use vi.spyOn, not vi.mock
+
+Different tests need different LLM responses. `vi.spyOn` provides:
+- Flexible return values per test
+- Easy testing of different scenarios
+- Better test isolation
+
+### Default Model: gpt-5
+
+- Always available in `model-bank`
+- Stable across model updates
+
+## Technical Implementation
+
+### Database Setup
+
+```typescript
+import { LobeChatDatabase } from '@lobechat/database';
+import { getTestDB } from '@lobechat/database/test-utils';
+
+let testDB: LobeChatDatabase;
+
+beforeEach(async () => {
+  testDB = await getTestDB();
+});
+```
+
+### OpenAI Stream Response Helper
+
+```typescript
+export const createOpenAIStreamResponse = (options: {
+  content?: string;
+  toolCalls?: Array<{ id: string; name: string; arguments: string }>;
+  finishReason?: 'stop' | 'tool_calls';
+}) => {
+  const { content, toolCalls, finishReason = 'stop' } = options;
+
+  return new Response(
+    new ReadableStream({
+      start(controller) {
+        const encoder = new TextEncoder();
+
+        if (content) {
+          const chunk = {
+            id: 'chatcmpl-mock',
+            object: 'chat.completion.chunk',
+            model: 'gpt-5',
+            choices: [{ index: 0, delta: { content }, finish_reason: null }],
+          };
+          controller.enqueue(encoder.encode(`data: ${JSON.stringify(chunk)}\n\n`));
+        }
+
+        // ... tool_calls handling
+        // ... finish chunk
+        controller.enqueue(encoder.encode('data: [DONE]\n\n'));
+        controller.close();
+      },
+    }),
+    { headers: { 'content-type': 'text/event-stream' } }
+  );
+};
+```
+
+### State Management
+
+```typescript
+import { InMemoryAgentStateManager, InMemoryStreamEventManager } from '@/server/modules/AgentRuntime';
+
+const stateManager = new InMemoryAgentStateManager();
+const streamEventManager = new InMemoryStreamEventManager();
+
+const service = new AgentRuntimeService(serverDB, userId, {
+  coordinatorOptions: { stateManager, streamEventManager },
+  queueService: null,
+  streamEventManager,
+});
+```
+
+### Mock OpenAI API
+
+```typescript
+const fetchSpy = vi.spyOn(globalThis, 'fetch');
+
+it('should handle text response', async () => {
+  fetchSpy.mockResolvedValueOnce(createOpenAIStreamResponse({ content: 'Response text' }));
+  // ... execute test
+});
+
+it('should handle tool calls', async () => {
+  fetchSpy.mockResolvedValueOnce(createOpenAIStreamResponse({
+    toolCalls: [{
+      id: 'call_123',
+      name: 'lobe-web-browsing____search____builtin',
+      arguments: JSON.stringify({ query: 'weather' }),
+    }],
+    finishReason: 'tool_calls',
+  }));
+  // ... execute test
+});
+```
+
+## Notes
+
+1. **Test isolation**: Clean `InMemoryAgentStateManager` and `InMemoryStreamEventManager` after each test
+2. **Timeout**: E2E tests may need longer timeouts
+3. **Debug**: Use `DEBUG=lobe-server:*` for detailed logs

package/.agents/skills/testing/references/db-model-test.md

@@ -0,0 +1,124 @@
+# Database Model Testing Guide
+
+Test `packages/database` Model layer.
+
+## Dual Environment Verification (Required)
+
+```bash
+# 1. Client environment (fast)
+cd packages/database && TEST_SERVER_DB=0 bunx vitest run --silent='passed-only' '[file]'
+
+# 2. Server environment (compatibility)
+cd packages/database && TEST_SERVER_DB=1 bunx vitest run --silent='passed-only' '[file]'
+```
+
+## User Permission Check - Security First 🔒
+
+**Critical security requirement**: All user data operations must include permission checks.
+
+```typescript
+// ❌ DANGEROUS: Missing permission check
+update = async (id: string, data: Partial<MyModel>) => {
+  return this.db.update(myTable).set(data)
+    .where(eq(myTable.id, id))  // Only checks ID
+    .returning();
+};
+
+// ✅ SECURE: Permission check included
+update = async (id: string, data: Partial<MyModel>) => {
+  return this.db.update(myTable).set(data)
+    .where(and(
+      eq(myTable.id, id),
+      eq(myTable.userId, this.userId)  // ✅ Permission check
+    ))
+    .returning();
+};
+```
+
+## Test File Structure
+
+```typescript
+// @vitest-environment node
+describe('MyModel', () => {
+  describe('create', () => { /* ... */ });
+  describe('queryAll', () => { /* ... */ });
+  describe('update', () => {
+    it('should update own records');
+    it('should NOT update other users records');  // 🔒 Security
+  });
+  describe('delete', () => {
+    it('should delete own records');
+    it('should NOT delete other users records');  // 🔒 Security
+  });
+  describe('user isolation', () => {
+    it('should enforce user data isolation');  // 🔒 Core security
+  });
+});
+```
+
+## Security Test Example
+
+```typescript
+it('should not update records of other users', async () => {
+  const [otherUserRecord] = await serverDB
+    .insert(myTable)
+    .values({ userId: 'other-user', data: 'original' })
+    .returning();
+
+  const result = await myModel.update(otherUserRecord.id, { data: 'hacked' });
+
+  expect(result).toBeUndefined();
+  const unchanged = await serverDB.query.myTable.findFirst({
+    where: eq(myTable.id, otherUserRecord.id),
+  });
+  expect(unchanged?.data).toBe('original');
+});
+```
+
+## Data Management
+
+```typescript
+const userId = 'test-user';
+const otherUserId = 'other-user';
+
+beforeEach(async () => {
+  await serverDB.delete(users);
+  await serverDB.insert(users).values([{ id: userId }, { id: otherUserId }]);
+});
+
+afterEach(async () => {
+  await serverDB.delete(users);
+});
+```
+
+## Foreign Key Handling
+
+```typescript
+// ❌ Wrong: Invalid foreign key
+const testData = { asyncTaskId: 'invalid-uuid', fileId: 'non-existent' };
+
+// ✅ Correct: Use null
+const testData = { asyncTaskId: null, fileId: null };
+
+// ✅ Or: Create referenced record first
+beforeEach(async () => {
+  const [asyncTask] = await serverDB.insert(asyncTasks)
+    .values({ id: 'valid-id', status: 'pending' }).returning();
+  testData.asyncTaskId = asyncTask.id;
+});
+```
+
+## Predictable Sorting
+
+```typescript
+// ✅ Use explicit timestamps
+const oldDate = new Date('2024-01-01T10:00:00Z');
+const newDate = new Date('2024-01-02T10:00:00Z');
+await serverDB.insert(table).values([
+  { ...data1, createdAt: oldDate },
+  { ...data2, createdAt: newDate },
+]);
+
+// ❌ Don't rely on insert order
+await serverDB.insert(table).values([data1, data2]);  // Unpredictable
+```

package/.agents/skills/testing/references/desktop-controller-test.md

@@ -0,0 +1,124 @@
+# Desktop Controller Unit Testing Guide
+
+## Testing Framework & Directory Structure
+
+LobeChat Desktop uses Vitest as the test framework. Controller unit tests should be placed in the `__tests__` directory adjacent to the controller file, named with the original controller filename plus `.test.ts`.
+
+```plaintext
+apps/desktop/src/main/controllers/
+├── __tests__/
+│   ├── index.test.ts
+│   ├── MenuCtr.test.ts
+│   └── ...
+├── McpCtr.ts
+├── MenuCtr.ts
+└── ...
+```
+
+## Basic Test File Structure
+
+```typescript
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import type { App } from '@/core/App';
+
+import YourController from '../YourControllerName';
+
+// Mock dependencies
+vi.mock('dependency-module', () => ({
+  dependencyFunction: vi.fn(),
+}));
+
+// Mock App instance
+const mockApp = {
+  // Mock necessary App properties and methods as needed
+} as unknown as App;
+
+describe('YourController', () => {
+  let controller: YourController;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    controller = new YourController(mockApp);
+  });
+
+  describe('methodName', () => {
+    it('test scenario description', async () => {
+      // Prepare test data
+
+      // Execute method under test
+      const result = await controller.methodName(params);
+
+      // Verify results
+      expect(result).toMatchObject(expectedResult);
+    });
+  });
+});
+```
+
+## Mocking External Dependencies
+
+### Module Functions
+
+```typescript
+const mockFunction = vi.fn();
+
+vi.mock('module-name', () => ({
+  functionName: mockFunction,
+}));
+```
+
+### Node.js Core Modules
+
+Example: mocking `child_process.exec` and `util.promisify`:
+
+```typescript
+const mockExecImpl = vi.fn();
+
+vi.mock('child_process', () => ({
+  exec: vi.fn((cmd, callback) => {
+    return mockExecImpl(cmd, callback);
+  }),
+}));
+
+vi.mock('util', () => ({
+  promisify: vi.fn((fn) => {
+    return async (cmd: string) => {
+      return new Promise((resolve, reject) => {
+        mockExecImpl(cmd, (error: Error | null, result: any) => {
+          if (error) reject(error);
+          else resolve(result);
+        });
+      });
+    };
+  }),
+}));
+```
+
+## Best Practices
+
+1. **Isolate tests**: Use `beforeEach` to reset mocks and state
+2. **Comprehensive coverage**: Test normal flows, edge cases, and error handling
+3. **Clear naming**: Test names should describe content and expected results
+4. **Avoid implementation details**: Test behavior, not implementation
+5. **Mock external dependencies**: Use `vi.mock()` for all external dependencies
+
+## Example: Testing IPC Event Handler
+
+```typescript
+it('should handle IPC event correctly', async () => {
+  mockSomething.mockReturnValue({ result: 'success' });
+
+  const result = await controller.ipcMethodName({
+    param1: 'value1',
+    param2: 'value2',
+  });
+
+  expect(result).toEqual({
+    success: true,
+    data: { result: 'success' },
+  });
+
+  expect(mockSomething).toHaveBeenCalledWith('value1', 'value2');
+});
+```

package/.agents/skills/testing/references/electron-ipc-test.md

@@ -0,0 +1,63 @@
+# Electron IPC Testing Strategy
+
+For Electron IPC tests, use **Mock return values** instead of real Electron environment.
+
+## Basic Mock Setup
+
+```typescript
+import { vi } from 'vitest';
+import { electronIpcClient } from '@/server/modules/ElectronIPCClient';
+
+vi.mock('@/server/modules/ElectronIPCClient', () => ({
+  electronIpcClient: {
+    getFilePathById: vi.fn(),
+    deleteFiles: vi.fn(),
+  },
+}));
+```
+
+## Setting Mock Behavior
+
+```typescript
+beforeEach(() => {
+  vi.resetAllMocks();
+  vi.mocked(electronIpcClient.getFilePathById).mockResolvedValue('/path/to/file.txt');
+  vi.mocked(electronIpcClient.deleteFiles).mockResolvedValue({ success: true });
+});
+```
+
+## Testing Different Scenarios
+
+```typescript
+it('should handle successful file deletion', async () => {
+  vi.mocked(electronIpcClient.deleteFiles).mockResolvedValue({ success: true });
+
+  const result = await service.deleteFiles(['desktop://file1.txt']);
+
+  expect(electronIpcClient.deleteFiles).toHaveBeenCalledWith(['desktop://file1.txt']);
+  expect(result.success).toBe(true);
+});
+
+it('should handle file deletion failure', async () => {
+  vi.mocked(electronIpcClient.deleteFiles).mockRejectedValue(new Error('Delete failed'));
+
+  const result = await service.deleteFiles(['desktop://file1.txt']);
+
+  expect(result.success).toBe(false);
+  expect(result.errors).toBeDefined();
+});
+```
+
+## Advantages
+
+1. **Environment simplification**: No complex Electron setup
+2. **Controlled testing**: Precise control over IPC return values
+3. **Scenario coverage**: Easy to test success/failure cases
+4. **Speed**: Mock calls are faster than real IPC
+
+## Notes
+
+- Ensure mock behavior matches real IPC interface
+- Use `vi.mocked()` for type safety
+- Reset mocks in `beforeEach` to avoid test interference
+- Verify both return values and that IPC methods were called correctly

package/.agents/skills/testing/references/zustand-store-action-test.md

@@ -0,0 +1,150 @@
+# Zustand Store Action Testing Guide
+
+## Basic Structure
+
+```typescript
+import { act, renderHook } from '@testing-library/react';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { useChatStore } from '../../store';
+
+vi.mock('zustand/traditional');
+
+beforeEach(() => {
+  vi.clearAllMocks();
+  useChatStore.setState({
+    activeId: 'test-session-id',
+    messagesMap: {},
+    loadingIds: [],
+  }, false);
+
+  vi.spyOn(messageService, 'createMessage').mockResolvedValue('new-message-id');
+
+  act(() => {
+    useChatStore.setState({
+      refreshMessages: vi.fn(),
+      internal_coreProcessMessage: vi.fn(),
+    });
+  });
+});
+
+afterEach(() => {
+  vi.restoreAllMocks();
+});
+```
+
+## Key Principles
+
+### 1. Spy Direct Dependencies Only
+
+```typescript
+// ✅ Good: Spy on direct dependency
+const fetchAIChatSpy = vi.spyOn(result.current, 'internal_fetchAIChatMessage')
+  .mockResolvedValue({ isFunctionCall: false, content: 'AI response' });
+
+// ❌ Bad: Spy on lower-level implementation
+const streamSpy = vi.spyOn(chatService, 'createAssistantMessageStream')
+  .mockImplementation(...);
+```
+
+### 2. Minimize Global Spies
+
+```typescript
+// ✅ Spy only when needed
+it('should process message', async () => {
+  const streamSpy = vi.spyOn(chatService, 'createAssistantMessageStream')
+    .mockImplementation(...);
+  // test logic
+  streamSpy.mockRestore();
+});
+
+// ❌ Don't setup all spies globally
+beforeEach(() => {
+  vi.spyOn(chatService, 'createAssistantMessageStream').mockResolvedValue({});
+  vi.spyOn(fileService, 'uploadFile').mockResolvedValue({});
+});
+```
+
+### 3. Use act() for Async Operations
+
+```typescript
+it('should send message', async () => {
+  const { result } = renderHook(() => useChatStore());
+
+  await act(async () => {
+    await result.current.sendMessage({ message: 'Hello' });
+  });
+
+  expect(messageService.createMessage).toHaveBeenCalled();
+});
+```
+
+### 4. Test Organization
+
+```typescript
+describe('sendMessage', () => {
+  describe('validation', () => {
+    it('should not send when session is inactive');
+    it('should not send when message is empty');
+  });
+  describe('message creation', () => {
+    it('should create user message and trigger AI processing');
+  });
+  describe('error handling', () => {
+    it('should handle message creation errors gracefully');
+  });
+});
+```
+
+## Streaming Response Mock
+
+```typescript
+it('should handle streaming chunks', async () => {
+  const { result } = renderHook(() => useChatStore());
+
+  const streamSpy = vi.spyOn(chatService, 'createAssistantMessageStream')
+    .mockImplementation(async ({ onMessageHandle, onFinish }) => {
+      await onMessageHandle?.({ type: 'text', text: 'Hello' } as any);
+      await onMessageHandle?.({ type: 'text', text: ' World' } as any);
+      await onFinish?.('Hello World', {});
+    });
+
+  await act(async () => {
+    await result.current.internal_fetchAIChatMessage({...});
+  });
+
+  streamSpy.mockRestore();
+});
+```
+
+## SWR Hook Testing
+
+```typescript
+it('should fetch data', async () => {
+  const mockData = [{ id: '1', name: 'Item 1' }];
+  vi.spyOn(discoverService, 'getPluginCategories').mockResolvedValue(mockData);
+
+  const { result } = renderHook(() => useStore.getState().usePluginCategories(params));
+
+  await waitFor(() => {
+    expect(result.current.data).toEqual(mockData);
+  });
+});
+```
+
+**Key points for SWR:**
+- DO NOT mock useSWR - let it use real implementation
+- Only mock service methods (fetchers)
+- Use `waitFor` for async operations
+
+## Anti-Patterns
+
+```typescript
+// ❌ Don't mock entire store
+vi.mock('../../store', () => ({ useChatStore: vi.fn(() => ({...})) }));
+
+// ❌ Don't test internal state structure
+expect(result.current.messagesMap).toHaveProperty('test-session');
+
+// ✅ Test behavior instead
+expect(result.current.refreshMessages).toHaveBeenCalled();
+```

package/.agents/skills/typescript/SKILL.md

@@ -0,0 +1,52 @@
+---
+name: typescript
+description: TypeScript code style and optimization guidelines. Use when writing TypeScript code (.ts, .tsx, .mts files), reviewing code quality, or implementing type-safe patterns. Triggers on TypeScript development, type safety questions, or code style discussions.
+---
+
+# TypeScript Code Style Guide
+
+## Types and Type Safety
+
+- Avoid explicit type annotations when TypeScript can infer
+- Avoid implicitly `any`; explicitly type when necessary
+- Use accurate types: prefer `Record<PropertyKey, unknown>` over `object` or `any`
+- Prefer `interface` for object shapes (e.g., React props); use `type` for unions/intersections
+- Prefer `as const satisfies XyzInterface` over plain `as const`
+- Prefer `@ts-expect-error` over `@ts-ignore` over `as any`
+- Avoid meaningless null/undefined parameters; design strict function contracts
+
+## Async Patterns
+
+- Prefer `async`/`await` over callbacks or `.then()` chains
+- Prefer async APIs over sync ones (avoid `*Sync`)
+- Use promise-based variants: `import { readFile } from 'fs/promises'`
+- Use `Promise.all`, `Promise.race` for concurrent operations where safe
+
+## Code Structure
+
+- Prefer object destructuring
+- Use consistent, descriptive naming; avoid obscure abbreviations
+- Replace magic numbers/strings with well-named constants
+- Defer formatting to tooling
+
+## UI and Theming
+
+- Use `@lobehub/ui`, Ant Design components instead of raw HTML tags
+- Design for dark mode and mobile responsiveness
+- Use `antd-style` token system instead of hard-coded colors
+
+## Performance
+
+- Prefer `for…of` loops over index-based `for` loops
+- Reuse existing utils in `packages/utils` or installed npm packages
+- Query only required columns from database
+
+## Time Consistency
+
+- Assign `Date.now()` to a constant once and reuse for consistency
+
+## Logging
+
+- Never log user private information (API keys, etc.)
+- Don't use `import { log } from 'debug'` directly (logs to console)
+- Use `console.error` in catch blocks instead of debug package