diff options
| author | Gal Zahavi <[email protected]> | 2025-08-15 10:27:33 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-08-15 17:27:33 +0000 |
| commit | 1a2906a8ad6e9cf7a68441c956af91d189eff417 (patch) | |
| tree | 599da5522cfa33c30793d57a73fd4ff93ab50daf /packages/core/src/services/shellExecutionService.test.ts | |
| parent | ab1c483cab659ac2ab081e74a0e3bd0fcc48a734 (diff) | |
Revert #6088 (#6328)
Diffstat (limited to 'packages/core/src/services/shellExecutionService.test.ts')
| -rw-r--r-- | packages/core/src/services/shellExecutionService.test.ts | 299 |
1 files changed, 198 insertions, 101 deletions
diff --git a/packages/core/src/services/shellExecutionService.test.ts b/packages/core/src/services/shellExecutionService.test.ts index 06092bd9..2fe51a5e 100644 --- a/packages/core/src/services/shellExecutionService.test.ts +++ b/packages/core/src/services/shellExecutionService.test.ts @@ -5,12 +5,14 @@ */ import { vi, describe, it, expect, beforeEach, type Mock } from 'vitest'; -const mockPtySpawn = vi.hoisted(() => vi.fn()); -vi.mock('@lydell/node-pty', () => ({ - spawn: mockPtySpawn, +const mockSpawn = vi.hoisted(() => vi.fn()); +vi.mock('child_process', () => ({ + spawn: mockSpawn, })); import EventEmitter from 'events'; +import { Readable } from 'stream'; +import { type ChildProcess } from 'child_process'; import { ShellExecutionService, ShellOutputEvent, @@ -29,13 +31,12 @@ vi.mock('os', () => ({ platform: mockPlatform, })); +const mockProcessKill = vi + .spyOn(process, 'kill') + .mockImplementation(() => true); + describe('ShellExecutionService', () => { - let mockPtyProcess: EventEmitter & { - pid: number; - kill: Mock; - onData: Mock; - onExit: Mock; - }; + let mockChildProcess: EventEmitter & Partial<ChildProcess>; let onOutputEventMock: Mock<(event: ShellOutputEvent) => void>; beforeEach(() => { @@ -46,27 +47,26 @@ describe('ShellExecutionService', () => { onOutputEventMock = vi.fn(); - mockPtyProcess = new EventEmitter() as EventEmitter & { - pid: number; - kill: Mock; - onData: Mock; - onExit: Mock; - }; - mockPtyProcess.pid = 12345; - mockPtyProcess.kill = vi.fn(); - mockPtyProcess.onData = vi.fn(); - mockPtyProcess.onExit = vi.fn(); + mockChildProcess = new EventEmitter() as EventEmitter & + Partial<ChildProcess>; + // FIX: Cast simple EventEmitters to the expected stream type. + mockChildProcess.stdout = new EventEmitter() as Readable; + mockChildProcess.stderr = new EventEmitter() as Readable; + mockChildProcess.kill = vi.fn(); - mockPtySpawn.mockReturnValue(mockPtyProcess); + // FIX: Use Object.defineProperty to set the readonly 'pid' property. + Object.defineProperty(mockChildProcess, 'pid', { + value: 12345, + configurable: true, + }); + + mockSpawn.mockReturnValue(mockChildProcess); }); // Helper function to run a standard execution simulation const simulateExecution = async ( command: string, - simulation: ( - ptyProcess: typeof mockPtyProcess, - ac: AbortController, - ) => void, + simulation: (cp: typeof mockChildProcess, ac: AbortController) => void, ) => { const abortController = new AbortController(); const handle = ShellExecutionService.execute( @@ -77,123 +77,215 @@ describe('ShellExecutionService', () => { ); await new Promise((resolve) => setImmediate(resolve)); - simulation(mockPtyProcess, abortController); + simulation(mockChildProcess, abortController); const result = await handle.result; return { result, handle, abortController }; }; describe('Successful Execution', () => { - it('should execute a command and capture output', async () => { - const { result, handle } = await simulateExecution('ls -l', (pty) => { - pty.onData.mock.calls[0][0]('file1.txt\n'); - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + it('should execute a command and capture stdout and stderr', async () => { + const { result, handle } = await simulateExecution('ls -l', (cp) => { + cp.stdout?.emit('data', Buffer.from('file1.txt\n')); + cp.stderr?.emit('data', Buffer.from('a warning')); + cp.emit('exit', 0, null); }); - expect(mockPtySpawn).toHaveBeenCalledWith( - 'bash', - ['-c', 'ls -l'], - expect.any(Object), + expect(mockSpawn).toHaveBeenCalledWith( + 'ls -l', + [], + expect.objectContaining({ shell: 'bash' }), ); expect(result.exitCode).toBe(0); expect(result.signal).toBeNull(); expect(result.error).toBeNull(); expect(result.aborted).toBe(false); - expect(result.output).toBe('file1.txt'); + expect(result.stdout).toBe('file1.txt\n'); + expect(result.stderr).toBe('a warning'); + expect(result.output).toBe('file1.txt\n\na warning'); expect(handle.pid).toBe(12345); expect(onOutputEventMock).toHaveBeenCalledWith({ type: 'data', - chunk: 'file1.txt', + stream: 'stdout', + chunk: 'file1.txt\n', + }); + expect(onOutputEventMock).toHaveBeenCalledWith({ + type: 'data', + stream: 'stderr', + chunk: 'a warning', }); }); it('should strip ANSI codes from output', async () => { - const { result } = await simulateExecution('ls --color=auto', (pty) => { - pty.onData.mock.calls[0][0]('a\u001b[31mred\u001b[0mword'); - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + const { result } = await simulateExecution('ls --color=auto', (cp) => { + cp.stdout?.emit('data', Buffer.from('a\u001b[31mred\u001b[0mword')); + cp.emit('exit', 0, null); }); - expect(result.output).toBe('aredword'); + expect(result.stdout).toBe('aredword'); expect(onOutputEventMock).toHaveBeenCalledWith({ type: 'data', + stream: 'stdout', chunk: 'aredword', }); }); it('should correctly decode multi-byte characters split across chunks', async () => { - const { result } = await simulateExecution('echo "你好"', (pty) => { - const multiByteChar = '你好'; - pty.onData.mock.calls[0][0](multiByteChar.slice(0, 1)); - pty.onData.mock.calls[0][0](multiByteChar.slice(1)); - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + const { result } = await simulateExecution('echo "你好"', (cp) => { + const multiByteChar = Buffer.from('你好', 'utf-8'); + cp.stdout?.emit('data', multiByteChar.slice(0, 2)); + cp.stdout?.emit('data', multiByteChar.slice(2)); + cp.emit('exit', 0, null); }); - expect(result.output).toBe('你好'); + expect(result.stdout).toBe('你好'); }); it('should handle commands with no output', async () => { - const { result } = await simulateExecution('touch file', (pty) => { - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + const { result } = await simulateExecution('touch file', (cp) => { + cp.emit('exit', 0, null); }); + expect(result.stdout).toBe(''); + expect(result.stderr).toBe(''); expect(result.output).toBe(''); expect(onOutputEventMock).not.toHaveBeenCalled(); }); }); describe('Failed Execution', () => { - it('should capture a non-zero exit code', async () => { - const { result } = await simulateExecution('a-bad-command', (pty) => { - pty.onData.mock.calls[0][0]('command not found'); - pty.onExit.mock.calls[0][0]({ exitCode: 127, signal: null }); + it('should capture a non-zero exit code and format output correctly', async () => { + const { result } = await simulateExecution('a-bad-command', (cp) => { + cp.stderr?.emit('data', Buffer.from('command not found')); + cp.emit('exit', 127, null); }); expect(result.exitCode).toBe(127); - expect(result.output).toBe('command not found'); + expect(result.stderr).toBe('command not found'); + expect(result.stdout).toBe(''); + expect(result.output).toBe('\ncommand not found'); expect(result.error).toBeNull(); }); it('should capture a termination signal', async () => { - const { result } = await simulateExecution('long-process', (pty) => { - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: 15 }); + const { result } = await simulateExecution('long-process', (cp) => { + cp.emit('exit', null, 'SIGTERM'); }); - expect(result.exitCode).toBe(0); - expect(result.signal).toBe(15); + expect(result.exitCode).toBeNull(); + expect(result.signal).toBe('SIGTERM'); }); - it('should handle a synchronous spawn error', async () => { - const spawnError = new Error('spawn ENOENT'); - mockPtySpawn.mockImplementation(() => { - throw spawnError; + it('should handle a spawn error', async () => { + const spawnError = new Error('spawn EACCES'); + const { result } = await simulateExecution('protected-cmd', (cp) => { + cp.emit('error', spawnError); + cp.emit('exit', 1, null); }); - const handle = ShellExecutionService.execute( - 'any-command', - '/test/dir', - onOutputEventMock, - new AbortController().signal, - ); - const result = await handle.result; - expect(result.error).toBe(spawnError); expect(result.exitCode).toBe(1); - expect(result.output).toBe(''); - expect(handle.pid).toBeUndefined(); + }); + + it('handles errors that do not fire the exit event', async () => { + const error = new Error('spawn abc ENOENT'); + const { result } = await simulateExecution('touch cat.jpg', (cp) => { + cp.emit('error', error); // No exit event is fired. + }); + + expect(result.error).toBe(error); + expect(result.exitCode).toBe(1); }); }); describe('Aborting Commands', () => { - it('should abort a running process and set the aborted flag', async () => { - const { result } = await simulateExecution( - 'sleep 10', - (pty, abortController) => { - abortController.abort(); - pty.onExit.mock.calls[0][0]({ exitCode: 1, signal: null }); - }, + describe.each([ + { + platform: 'linux', + expectedSignal: 'SIGTERM', + expectedExit: { signal: 'SIGKILL' as const }, + }, + { + platform: 'win32', + expectedCommand: 'taskkill', + expectedExit: { code: 1 }, + }, + ])( + 'on $platform', + ({ platform, expectedSignal, expectedCommand, expectedExit }) => { + it('should abort a running process and set the aborted flag', async () => { + mockPlatform.mockReturnValue(platform); + + const { result } = await simulateExecution( + 'sleep 10', + (cp, abortController) => { + abortController.abort(); + if (expectedExit.signal) + cp.emit('exit', null, expectedExit.signal); + if (typeof expectedExit.code === 'number') + cp.emit('exit', expectedExit.code, null); + }, + ); + + expect(result.aborted).toBe(true); + + if (platform === 'linux') { + expect(mockProcessKill).toHaveBeenCalledWith( + -mockChildProcess.pid!, + expectedSignal, + ); + } else { + expect(mockSpawn).toHaveBeenCalledWith(expectedCommand, [ + '/pid', + String(mockChildProcess.pid), + '/f', + '/t', + ]); + } + }); + }, + ); + + it('should gracefully attempt SIGKILL on linux if SIGTERM fails', async () => { + mockPlatform.mockReturnValue('linux'); + vi.useFakeTimers(); + + // Don't await the result inside the simulation block for this specific test. + // We need to control the timeline manually. + const abortController = new AbortController(); + const handle = ShellExecutionService.execute( + 'unresponsive_process', + '/test/dir', + onOutputEventMock, + abortController.signal, ); + abortController.abort(); + + // Check the first kill signal + expect(mockProcessKill).toHaveBeenCalledWith( + -mockChildProcess.pid!, + 'SIGTERM', + ); + + // Now, advance time past the timeout + await vi.advanceTimersByTimeAsync(250); + + // Check the second kill signal + expect(mockProcessKill).toHaveBeenCalledWith( + -mockChildProcess.pid!, + 'SIGKILL', + ); + + // Finally, simulate the process exiting and await the result + mockChildProcess.emit('exit', null, 'SIGKILL'); + const result = await handle.result; + + vi.useRealTimers(); + expect(result.aborted).toBe(true); - expect(mockPtyProcess.kill).toHaveBeenCalled(); + expect(result.signal).toBe('SIGKILL'); + // The individual kill calls were already asserted above. + expect(mockProcessKill).toHaveBeenCalledTimes(2); }); }); @@ -203,10 +295,10 @@ describe('ShellExecutionService', () => { const binaryChunk1 = Buffer.from([0x89, 0x50, 0x4e, 0x47]); const binaryChunk2 = Buffer.from([0x0d, 0x0a, 0x1a, 0x0a]); - const { result } = await simulateExecution('cat image.png', (pty) => { - pty.onData.mock.calls[0][0](binaryChunk1); - pty.onData.mock.calls[0][0](binaryChunk2); - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + const { result } = await simulateExecution('cat image.png', (cp) => { + cp.stdout?.emit('data', binaryChunk1); + cp.stdout?.emit('data', binaryChunk2); + cp.emit('exit', 0, null); }); expect(result.rawOutput).toEqual( @@ -229,13 +321,14 @@ describe('ShellExecutionService', () => { it('should not emit data events after binary is detected', async () => { mockIsBinary.mockImplementation((buffer) => buffer.includes(0x00)); - await simulateExecution('cat mixed_file', (pty) => { - pty.onData.mock.calls[0][0](Buffer.from('some text')); - pty.onData.mock.calls[0][0](Buffer.from([0x00, 0x01, 0x02])); - pty.onData.mock.calls[0][0](Buffer.from('more text')); - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }); + await simulateExecution('cat mixed_file', (cp) => { + cp.stdout?.emit('data', Buffer.from('some text')); + cp.stdout?.emit('data', Buffer.from([0x00, 0x01, 0x02])); + cp.stdout?.emit('data', Buffer.from('more text')); + cp.emit('exit', 0, null); }); + // FIX: Provide explicit type for the 'call' parameter in the map function. const eventTypes = onOutputEventMock.mock.calls.map( (call: [ShellOutputEvent]) => call[0].type, ); @@ -251,27 +344,31 @@ describe('ShellExecutionService', () => { describe('Platform-Specific Behavior', () => { it('should use cmd.exe on Windows', async () => { mockPlatform.mockReturnValue('win32'); - await simulateExecution('dir "foo bar"', (pty) => - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }), + await simulateExecution('dir "foo bar"', (cp) => + cp.emit('exit', 0, null), ); - expect(mockPtySpawn).toHaveBeenCalledWith( - 'cmd.exe', - ['/c', 'dir "foo bar"'], - expect.any(Object), + expect(mockSpawn).toHaveBeenCalledWith( + 'dir "foo bar"', + [], + expect.objectContaining({ + shell: true, + detached: false, + }), ); }); - it('should use bash on Linux', async () => { + it('should use bash and detached process group on Linux', async () => { mockPlatform.mockReturnValue('linux'); - await simulateExecution('ls "foo bar"', (pty) => - pty.onExit.mock.calls[0][0]({ exitCode: 0, signal: null }), - ); + await simulateExecution('ls "foo bar"', (cp) => cp.emit('exit', 0, null)); - expect(mockPtySpawn).toHaveBeenCalledWith( - 'bash', - ['-c', 'ls "foo bar"'], - expect.any(Object), + expect(mockSpawn).toHaveBeenCalledWith( + 'ls "foo bar"', + [], + expect.objectContaining({ + shell: 'bash', + detached: true, + }), ); }); }); |
