concevent-ai-agent-sdk 3.10.2 → 3.10.3

package/dist/tests/agent.test.js

@@ -1,8 +1,8 @@
 import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
 import OpenAI from 'openai';
 import { z } from 'zod';
-import { createAgent, createEvent, ENCRYPTED_REASONING_MARKER } from '../src/index.js';
-import { createMockTools, createFailingTool, createParallelTools, createTimedParallelTools, } from './mocks/tools.js';
+import { createAgent, createEvent, ENCRYPTED_REASONING_MARKER, AgentError, formatErrorTrace, isAbortError, formatAIError, AI_ERROR_CATEGORIES, ToolExecutionTimeoutError, } from '../src/index.js';
+import { createMockTools, createFailingTool, createParallelTools, createTimedParallelTools, createLargeResultTool, createBashLikeResultTool, createGrepLikeResultTool, createGlobLikeResultTool, createReadLikeResultTool, } from './mocks/tools.js';
 vi.mock('openai');
 function createMockOpenAIClient() {
     return {
@@ -4009,4 +4009,420 @@ describe('createAgent - image input', () => {
         }
     });
 });
+// ============================================================================
+// 1A. Result storage integration (tool-executor.ts coverage)
+// ============================================================================
+describe('createAgent - result storage integration', () => {
+    let mockClient;
+    beforeEach(() => {
+        mockClient = createMockOpenAIClient();
+        vi.mocked(OpenAI).mockImplementation(() => mockClient);
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should store large tool results and include storage message in history', async () => {
+        const agent = createAgent(createTestConfig({
+            tools: [createLargeResultTool(200)],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        // First call: LLM calls the tool
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-large-1',
+                type: 'function',
+                function: { name: 'largeResultTool', arguments: '{}' },
+            },
+        ]));
+        // Second call: LLM final response
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Here is the result summary'));
+        const result = await agent.chat('Run the tool', createTestContext());
+        expect(result.message).toBe('Here is the result summary');
+        // Check that the conversation history contains the storage message
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of largeResultTool stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('ID:');
+        expect(storageMessage.content).toContain('ReadResult');
+    });
+    it('should include Bash exit code summary in stored result message', async () => {
+        const agent = createAgent(createTestConfig({
+            tools: [createBashLikeResultTool()],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-bash-1',
+                type: 'function',
+                function: { name: 'Bash', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Command completed'));
+        const result = await agent.chat('Run bash', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of Bash stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('Exit code: 0');
+        expect(storageMessage.content).toContain('(success)');
+    });
+    it('should include Grep match count summary in stored result message', async () => {
+        const agent = createAgent(createTestConfig({
+            tools: [createGrepLikeResultTool()],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-grep-1',
+                type: 'function',
+                function: { name: 'Grep', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Found matches'));
+        const result = await agent.chat('Search files', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of Grep stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('Found 5 match(es)');
+        expect(storageMessage.content).toContain('in 3 file(s)');
+    });
+    it('should include Glob count summary in stored result message', async () => {
+        const agent = createAgent(createTestConfig({
+            tools: [createGlobLikeResultTool()],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-glob-1',
+                type: 'function',
+                function: { name: 'Glob', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Found files'));
+        const result = await agent.chat('Find files', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of Glob stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('Found 42 file(s)');
+    });
+    it('should include Read total lines summary in stored result message', async () => {
+        const agent = createAgent(createTestConfig({
+            tools: [createReadLikeResultTool()],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-read-1',
+                type: 'function',
+                function: { name: 'Read', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('File content'));
+        const result = await agent.chat('Read file', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of Read stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('File has 500 total lines');
+    });
+    it('should not store small tool results', async () => {
+        const smallTool = {
+            declaration: {
+                name: 'smallTool',
+                description: 'Returns small result',
+                parametersJsonSchema: { type: 'object', properties: {} },
+            },
+            executor: async () => ({ ok: true }),
+        };
+        const agent = createAgent(createTestConfig({
+            tools: [smallTool],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50000 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-small-1',
+                type: 'function',
+                function: { name: 'smallTool', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Done'));
+        const result = await agent.chat('Do small thing', createTestContext());
+        const history = result.conversationHistory;
+        const resultMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of smallTool'));
+        expect(resultMessage).toBeDefined();
+        // Should be inline, not stored
+        expect(resultMessage.content).not.toContain('stored (ID:');
+        expect(resultMessage.content).toContain('Result of smallTool:');
+    });
+    it('should show large result grep tip for results with 500+ lines', async () => {
+        // Create a tool that returns a very large result (500+ lines worth)
+        const hugeResultTool = {
+            declaration: {
+                name: 'hugeResultTool',
+                description: 'Returns a huge result',
+                parametersJsonSchema: { type: 'object', properties: {} },
+            },
+            executor: async () => {
+                // Return a result that will produce 500+ lines when JSON.stringified
+                return {
+                    lines: Array.from({ length: 600 }, (_, i) => `output line ${i + 1}`),
+                };
+            },
+        };
+        const agent = createAgent(createTestConfig({
+            tools: [hugeResultTool],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-huge-1',
+                type: 'function',
+                function: { name: 'hugeResultTool', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Huge result processed'));
+        const result = await agent.chat('Run huge tool', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of hugeResultTool stored'));
+        expect(storageMessage).toBeDefined();
+        // Should show the grep tip for large results
+        expect(storageMessage.content).toContain('grep=');
+        expect(storageMessage.content).toContain('Large result');
+    });
+    it('should include Bash failed exit code summary', async () => {
+        const failedBashTool = {
+            declaration: {
+                name: 'Bash',
+                description: 'Failed bash',
+                parametersJsonSchema: { type: 'object', properties: {} },
+            },
+            executor: async () => ({
+                exit_code: 1,
+                success: false,
+                stderr: 'x'.repeat(300),
+            }),
+        };
+        const agent = createAgent(createTestConfig({
+            tools: [failedBashTool],
+            resultStorage: { enabled: true, sizeThresholdBytes: 50 },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-bash-fail',
+                type: 'function',
+                function: { name: 'Bash', arguments: '{}' },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Command failed'));
+        const result = await agent.chat('Run bash', createTestContext());
+        const history = result.conversationHistory;
+        const storageMessage = history.find((m) => m.role === 'tool-call-results' && m.content?.includes('Result of Bash stored'));
+        expect(storageMessage).toBeDefined();
+        expect(storageMessage.content).toContain('Exit code: 1');
+        expect(storageMessage.content).toContain('(failed)');
+    });
+    it('should handle result storage disabled', async () => {
+        const agent = createAgent(createTestConfig({
+            resultStorage: { enabled: false },
+            stream: false,
+        }));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse(null, [
+            {
+                id: 'call-1',
+                type: 'function',
+                function: { name: 'getWeather', arguments: JSON.stringify({ city: 'London' }) },
+            },
+        ]));
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Weather is sunny'));
+        const result = await agent.chat('Weather?', createTestContext());
+        expect(result.message).toBe('Weather is sunny');
+        // Tool result should be inline
+        const toolResult = result.conversationHistory.find((m) => m.role === 'tool-call-results');
+        expect(toolResult).toBeDefined();
+        expect(toolResult.content).toContain('Result of getWeather:');
+    });
+});
+// ============================================================================
+// 1C. AgentError.toJSON() (errors.ts coverage)
+// ============================================================================
+describe('AgentError', () => {
+    it('should serialize to JSON with toJSON()', () => {
+        const error = new AgentError('EMPTY_RESPONSE', 'Custom empty message');
+        const json = error.toJSON();
+        expect(json).toEqual({
+            code: 'EMPTY_RESPONSE',
+            message: 'Custom empty message',
+            recoverable: false,
+        });
+    });
+    it('should use default message when no custom message provided', () => {
+        const error = new AgentError('GENERIC_ERROR');
+        expect(error.message).toBe('An internal error occurred, please try again later');
+        const json = error.toJSON();
+        expect(json.code).toBe('GENERIC_ERROR');
+        expect(json.recoverable).toBe(false);
+    });
+    it('should support recoverable flag', () => {
+        const error = new AgentError('MAX_ITERATIONS', undefined, true);
+        const json = error.toJSON();
+        expect(json).toEqual({
+            code: 'MAX_ITERATIONS',
+            message: 'Maximum iterations reached. Please break down your request into smaller parts.',
+            recoverable: true,
+        });
+    });
+    it('should be an instance of Error', () => {
+        const error = new AgentError('API_KEY_REQUIRED');
+        expect(error).toBeInstanceOf(Error);
+        expect(error.name).toBe('AgentError');
+    });
+});
+// ============================================================================
+// 1D. Error utilities (errors.ts coverage)
+// ============================================================================
+describe('Error utilities', () => {
+    describe('formatErrorTrace', () => {
+        it('should wrap error in INTERNAL_ERROR_TRACE tags', () => {
+            const error = new Error('Something went wrong');
+            const trace = formatErrorTrace(error);
+            expect(trace).toContain('<INTERNAL_ERROR_TRACE>');
+            expect(trace).toContain('</INTERNAL_ERROR_TRACE>');
+            expect(trace).toContain('Error: Something went wrong');
+        });
+        it('should include the error name', () => {
+            const error = new TypeError('Invalid type');
+            const trace = formatErrorTrace(error);
+            expect(trace).toContain('TypeError: Invalid type');
+        });
+    });
+    describe('isAbortError', () => {
+        it('should return true for AbortError name', () => {
+            const error = new Error('Operation aborted');
+            error.name = 'AbortError';
+            expect(isAbortError(error)).toBe(true);
+        });
+        it('should return true for abort message', () => {
+            const error = new Error('Request aborted before processing');
+            expect(isAbortError(error)).toBe(true);
+        });
+        it('should return false for non-abort error', () => {
+            const error = new Error('Something else');
+            expect(isAbortError(error)).toBe(false);
+        });
+        it('should return false for non-Error objects', () => {
+            expect(isAbortError('not an error')).toBe(false);
+            expect(isAbortError(null)).toBe(false);
+            expect(isAbortError(undefined)).toBe(false);
+        });
+    });
+    describe('formatAIError', () => {
+        it('should format error with tool name and suggestion', () => {
+            const message = formatAIError(AI_ERROR_CATEGORIES.TOOL_EXECUTION_ERROR, 'File not found', {
+                toolName: 'Read',
+                suggestion: 'Check the file path',
+            });
+            expect(message).toBe('[TOOL_EXECUTION_ERROR] for tool "Read": File not found\n\nSuggestion: Check the file path');
+        });
+        it('should format error without tool name', () => {
+            const message = formatAIError(AI_ERROR_CATEGORIES.RESPONSE_VALIDATION, 'Invalid JSON');
+            expect(message).toBe('[RESPONSE_VALIDATION]: Invalid JSON');
+        });
+        it('should format error without suggestion', () => {
+            const message = formatAIError(AI_ERROR_CATEGORIES.TOOL_NOT_FOUND, 'Tool "xyz" not found', {
+                toolName: 'xyz',
+            });
+            expect(message).toBe('[TOOL_NOT_FOUND] for tool "xyz": Tool "xyz" not found');
+        });
+    });
+    describe('ToolExecutionTimeoutError', () => {
+        it('should contain tool name and timeout', () => {
+            const error = new ToolExecutionTimeoutError('myTool', 5000);
+            expect(error.message).toContain('myTool');
+            expect(error.message).toContain('5000');
+            expect(error.toolName).toBe('myTool');
+            expect(error.timeoutMs).toBe(5000);
+            expect(error).toBeInstanceOf(Error);
+        });
+    });
+});
+// ============================================================================
+// 1E. API key format warning (openrouter-client.ts coverage)
+// ============================================================================
+describe('createAgent - API key format warning', () => {
+    let mockClient;
+    beforeEach(() => {
+        mockClient = createMockOpenAIClient();
+        vi.mocked(OpenAI).mockImplementation(() => mockClient);
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should warn for non-OpenRouter API key format', () => {
+        const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => { });
+        createAgent(createTestConfig({ apiKey: 'some-other-key' }));
+        expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('does not appear to be a valid OpenRouter API key'));
+        consoleSpy.mockRestore();
+    });
+    it('should not warn for valid OpenRouter API key format', () => {
+        const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => { });
+        createAgent(createTestConfig({ apiKey: 'sk-or-v1-test-key-12345' }));
+        expect(consoleSpy).not.toHaveBeenCalled();
+        consoleSpy.mockRestore();
+    });
+});
+// ============================================================================
+// 1F. Session abort lifecycle (session.ts coverage)
+// ============================================================================
+describe('createAgent - session abort lifecycle', () => {
+    let mockClient;
+    beforeEach(() => {
+        mockClient = createMockOpenAIClient();
+        vi.mocked(OpenAI).mockImplementation(() => mockClient);
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should allow chat after aborting when no active chat', async () => {
+        const agent = createAgent(createTestConfig());
+        // Abort before any chat (no active AbortController)
+        agent.abort();
+        // Subsequent chat should still work
+        mockClient.chat.completions.create.mockResolvedValueOnce(createMockResponse('Hello after abort'));
+        const result = await agent.chat('Hello', createTestContext());
+        expect(result.message).toBe('Hello after abort');
+    });
+    it('should fire onAborted callback during active chat abort', async () => {
+        // Use real timers for this test
+        vi.useRealTimers();
+        const agent = createAgent(createTestConfig());
+        // Make the API call hang long enough for us to abort
+        mockClient.chat.completions.create.mockImplementation(() => new Promise((_, reject) => {
+            setTimeout(() => {
+                const error = new Error('Request aborted before processing');
+                error.name = 'AbortError';
+                reject(error);
+            }, 50);
+        }));
+        const onAborted = vi.fn();
+        // Start chat and abort after a short delay
+        const chatPromise = agent.chat('Hello', createTestContext(), { onAborted });
+        // Abort mid-execution
+        setTimeout(() => agent.abort(), 10);
+        try {
+            await chatPromise;
+        }
+        catch {
+            // Expected to throw
+        }
+        expect(onAborted).toHaveBeenCalled();
+        // Restore fake timers for other tests
+        vi.useFakeTimers();
+    });
+});
 //# sourceMappingURL=agent.test.js.map