fix: preserve call error exit behavior

This commit is contained in:
Peter Steinberger 2026-05-04 05:05:06 +01:00
parent 6308557885
commit e1a35f8d91
No known key found for this signature in database
5 changed files with 197 additions and 10 deletions

View File

@ -27,6 +27,8 @@ export { handleInspectCli } from './cli/inspect-cli-command.js';
export { extractListFlags, handleList } from './cli/list-command.js';
export { resolveCallTimeout } from './cli/timeouts.js';
const FORCE_EXIT_GRACE_MS = 50;
export async function runCli(argv: string[]): Promise<void> {
const args = [...argv];
if (args.length === 0) {
@ -187,18 +189,19 @@ export async function runCli(argv: string[]): Promise<void> {
// By default we force an exit after cleanup so Node doesn't hang on lingering stdio handles
// (see typescript-sdk#579/#780/#1049). Opt out by exporting MCPORTER_NO_FORCE_EXIT=1.
const disableForceExit = process.env.MCPORTER_NO_FORCE_EXIT === '1';
const shouldForceExit = !disableForceExit || process.env.MCPORTER_FORCE_EXIT === '1';
const scheduleForcedExit = () => {
if (shouldForceExit) {
setTimeout(() => {
process.exit(process.exitCode ?? 0);
}, FORCE_EXIT_GRACE_MS);
}
};
if (DEBUG_HANG) {
dumpActiveHandles('after terminateChildProcesses');
if (!disableForceExit || process.env.MCPORTER_FORCE_EXIT === '1') {
process.exit(0);
}
scheduleForcedExit();
} else {
const scheduleExit = () => {
if (!disableForceExit || process.env.MCPORTER_FORCE_EXIT === '1') {
process.exit(0);
}
};
setImmediate(scheduleExit);
setImmediate(scheduleForcedExit);
}
}
}

View File

@ -167,12 +167,19 @@ async function invokePreparedCall(
function renderCallResult(result: unknown, parsed: CallArgsParseResult): void {
const { callResult: wrapped } = wrapCallResult(result);
if (isErrorCallResult(result)) {
process.exitCode = 1;
}
printCallOutput(wrapped, result, parsed.output);
saveCallImagesIfRequested(wrapped, parsed.saveImagesDir);
tailLogIfRequested(result, parsed.tailLog);
dumpActiveHandles('after call (formatted result)');
}
function isErrorCallResult(result: unknown): boolean {
return !!result && typeof result === 'object' && (result as { isError?: unknown }).isError === true;
}
export function printCallHelp(): void {
const lines = [
'Usage: mcporter call <server.tool | url> [arguments] [flags]',

View File

@ -110,6 +110,26 @@ describe('CLI call execution behavior', () => {
logSpy.mockRestore();
});
it('marks MCP isError tool results as process failures', async () => {
const previousExitCode = process.exitCode;
process.exitCode = undefined;
try {
const { handleCall } = await cliModulePromise;
const { runtime, callTool } = createRuntimeStub({
linear: [{ name: 'explode', inputSchema: { type: 'object', properties: {} } }],
});
callTool.mockResolvedValueOnce({ content: [{ type: 'text', text: 'Unknown resource' }], isError: true });
const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
await handleCall(runtime, ['linear.explode']);
expect(process.exitCode).toBe(1);
logSpy.mockRestore();
} finally {
process.exitCode = previousExitCode;
}
});
it('still requires an explicit tool when multiple are available', async () => {
const { handleCall } = await cliModulePromise;
const { runtime, callTool } = createRuntimeStub(

View File

@ -0,0 +1,154 @@
import { execFile } from 'node:child_process';
import fs from 'node:fs/promises';
import { createRequire } from 'node:module';
import os from 'node:os';
import path from 'node:path';
import process from 'node:process';
import { fileURLToPath, pathToFileURL } from 'node:url';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
const CLI_ENTRY = fileURLToPath(new URL('../dist/cli.js', import.meta.url));
const PNPM_COMMAND = process.platform === 'win32' ? 'cmd.exe' : 'pnpm';
const PNPM_ARGS_PREFIX = process.platform === 'win32' ? ['/d', '/s', '/c', 'pnpm'] : [];
const testRequire = createRequire(import.meta.url);
const MCP_SERVER_MODULE = pathToFileURL(testRequire.resolve('@modelcontextprotocol/sdk/server/mcp.js')).href;
const STDIO_SERVER_MODULE = pathToFileURL(testRequire.resolve('@modelcontextprotocol/sdk/server/stdio.js')).href;
const ZOD_MODULE = pathToFileURL(path.join(process.cwd(), 'node_modules', 'zod', 'index.js')).href;
function pnpmArgs(args: string[]): string[] {
return [...PNPM_ARGS_PREFIX, ...args];
}
async function ensureDistBuilt(): Promise<void> {
try {
await fs.access(CLI_ENTRY);
} catch {
await new Promise<void>((resolve, reject) => {
execFile(PNPM_COMMAND, pnpmArgs(['build']), { cwd: process.cwd(), env: process.env }, (error) => {
if (error) {
reject(error);
return;
}
resolve();
});
});
}
}
function runCli(args: string[], configPath: string): Promise<{ stdout: string; stderr: string; code: number }> {
return new Promise((resolve) => {
execFile(
process.execPath,
[CLI_ENTRY, '--config', configPath, ...args],
{
cwd: process.cwd(),
env: process.env,
maxBuffer: 1024 * 1024,
},
(error, stdout, stderr) => {
const code = typeof error?.code === 'number' ? error.code : 0;
resolve({ stdout, stderr, code });
}
);
});
}
describe('mcporter forced exit behavior', () => {
let tempDir: string;
let configPath: string;
beforeAll(async () => {
await ensureDistBuilt();
tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'mcporter-force-exit-'));
const serverScriptPath = path.join(tempDir, 'force-exit-server.mjs');
configPath = path.join(tempDir, 'config.json');
const longDescription = 'Large schema tool description. '.repeat(30);
await fs.writeFile(
serverScriptPath,
`import { McpServer } from ${JSON.stringify(MCP_SERVER_MODULE)};
import { StdioServerTransport } from ${JSON.stringify(STDIO_SERVER_MODULE)};
import { z } from ${JSON.stringify(ZOD_MODULE)};
const server = new McpServer({ name: 'force-exit', version: '1.0.0' });
server.registerTool(
'fail',
{
title: 'Fail',
description: 'Return an MCP tool error result',
inputSchema: {},
},
async () => ({
content: [{ type: 'text', text: 'expected failure' }],
isError: true,
})
);
for (let index = 0; index < 64; index += 1) {
server.registerTool(
\`tool_\${index}\`,
{
title: \`Tool \${index}\`,
description: ${JSON.stringify(longDescription)} + index,
inputSchema: {
alpha: z.string().describe(${JSON.stringify(longDescription)}),
beta: z.string().optional().describe(${JSON.stringify(longDescription)}),
},
outputSchema: {
ok: z.boolean(),
},
},
async () => ({
content: [{ type: 'text', text: 'ok' }],
structuredContent: { ok: true },
})
);
}
const transport = new StdioServerTransport();
await server.connect(transport);
`,
'utf8'
);
await fs.writeFile(
configPath,
JSON.stringify(
{
mcpServers: {
'force-exit': {
command: process.execPath,
args: [serverScriptPath],
},
},
},
null,
2
),
'utf8'
);
});
afterAll(async () => {
await fs.rm(tempDir, { recursive: true, force: true }).catch(() => {});
});
it('preserves non-zero exit codes for MCP isError tool results', async () => {
const result = await runCli(['call', 'force-exit.fail'], configPath);
expect(result.code).toBe(1);
expect(result.stdout).toContain('expected failure');
expect(result.stderr).toBe('');
}, 20000);
it('does not truncate large JSON output when force exit is enabled', async () => {
const result = await runCli(['list', 'force-exit', '--schema', '--output', 'json'], configPath);
expect(result.code).toBe(0);
expect(result.stderr).toBe('');
expect(Buffer.byteLength(result.stdout)).toBeGreaterThan(8192);
const payload = JSON.parse(result.stdout) as { tools: Array<{ name: string }> };
expect(payload.tools).toHaveLength(65);
expect(payload.tools.at(-1)?.name).toBe('tool_63');
}, 20000);
});

View File

@ -54,7 +54,10 @@ describe.skipIf(Boolean(skipReason()))('deepwiki live', () => {
'repoName:facebook/react',
'--output',
'json',
]);
]).catch((error: unknown) => {
const failure = error as { stdout?: string; stderr?: string };
return { stdout: failure.stdout ?? '', stderr: failure.stderr ?? '' };
});
const normalized = stdout.trim() || stderr.trim();
expect(normalized).toContain('"statusCode": 410');
expect(normalized).toContain('"kind": "http"');