Skip to content

Avoid timeouts in client integration test fixtures #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
data-douser merged 1 commit into from
Feb 23, 2026
Merged

Avoid timeouts in client integration test fixtures #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 35 additions & 56 deletions client/src/lib/integration-test-runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,27 @@ export class IntegrationTestRunner {
this.options = options;
}

/**
* Call an MCP tool with an appropriate timeout.
*
* All codeql_* tools invoke the CodeQL CLI or language server JVM, which
* can be slow in CI (cold JVM start, network pack downloads, Windows
* runner overhead). A generous 5-minute timeout avoids intermittent
* -32001 RequestTimeout failures.
*/
async callTool(toolName, args) {
const isCodeQLTool = toolName.startsWith("codeql_");
const requestOptions = {
timeout: isCodeQLTool ? 300000 : 60000,
resetTimeoutOnProgress: isCodeQLTool
};
Comment thread
data-douser marked this conversation as resolved.
return await this.client.callTool(
{ name: toolName, arguments: args },
undefined,
requestOptions
);
}

/**
* Run integration tests for a specific tool
*/
Expand Down Expand Up @@ -268,12 +289,9 @@ export class IntegrationTestRunner {
}

// Run the tool
const result = await this.client.callTool({
name: toolName,
arguments: {
"files": files,
"in-place": true
}
const result = await this.callTool(toolName, {
"files": files,
"in-place": true
});

this.logger.log(`Tool ${toolName} result: ${result.content?.[0]?.text || "No output"}`);
Expand Down Expand Up @@ -337,11 +355,8 @@ export class IntegrationTestRunner {
const _afterContent = fs.readFileSync(afterPath, "utf8");

// Run the codeql_lsp_diagnostics tool on the before content
const result = await this.client.callTool({
name: toolName,
arguments: {
ql_code: beforeContent
}
const result = await this.callTool(toolName, {
ql_code: beforeContent
});

this.logger.log(
Expand Down Expand Up @@ -472,10 +487,7 @@ export class IntegrationTestRunner {
resolvePathPlaceholders(testConfig.arguments, this.logger);

// Run the tool with custom arguments
const result = await this.client.callTool({
name: toolName,
arguments: testConfig.arguments
});
const result = await this.callTool(toolName, testConfig.arguments);

this.logger.log(`Tool ${toolName} result: ${result.content?.[0]?.text || "No output"}`);

Expand Down Expand Up @@ -659,10 +671,7 @@ export class IntegrationTestRunner {
// Check if qlpack.yml exists and install dependencies
if (fs.existsSync(path.join(packDir, "codeql-pack.yml"))) {
try {
await this.client.callTool({
name: "codeql_pack_install",
arguments: { packDir: packDir }
});
await this.callTool("codeql_pack_install", { packDir: packDir });
} catch (installError) {
this.logger.log(
` Warning: Could not install pack dependencies: ${installError.message}`
Expand Down Expand Up @@ -708,9 +717,8 @@ export class IntegrationTestRunner {

if (fs.existsSync(absoluteTestSourceDir)) {
this.logger.log(`Database not found, extracting from ${testSourceDir}`);
const extractResult = await this.client.callTool({
name: "codeql_test_extract",
arguments: { tests: [testSourceDir] }
const extractResult = await this.callTool("codeql_test_extract", {
tests: [testSourceDir]
});
if (extractResult.isError) {
const errorText = extractResult.content?.[0]?.text || "Unknown error";
Expand Down Expand Up @@ -739,38 +747,10 @@ export class IntegrationTestRunner {
params = await this.getToolSpecificParams(toolName, testCase);
}

// Call the tool with appropriate parameters
// Set extended timeout for long-running operations
const longRunningTools = [
"codeql_database_analyze",
"codeql_database_create",
"codeql_lsp_completion",
"codeql_lsp_definition",
"codeql_lsp_diagnostics",
"codeql_lsp_references",
"codeql_query_run",
"codeql_test_run"
];

const requestOptions = longRunningTools.includes(toolName)
? {
timeout: 300000, // 5 minutes for long-running tools
resetTimeoutOnProgress: true
}
: {
timeout: 60000 // 60 seconds for other tools
};

this.logger.log(`Calling tool ${toolName} with timeout: ${requestOptions.timeout}ms`);
// Call the tool with appropriate parameters (timeout is handled by this.callTool)
this.logger.log(`Calling tool ${toolName}`);

const result = await this.client.callTool(
{
name: toolName,
arguments: params
},
undefined,
requestOptions
);
const result = await this.callTool(toolName, params);

// For monitoring tests, we primarily check if the tool executed successfully
// Special handling for session management tools that expect sessions to exist
Expand Down Expand Up @@ -979,9 +959,8 @@ export class IntegrationTestRunner {
if (!fs.existsSync(databaseDir) && fs.existsSync(testDir)) {
this.logger.log(`Database not found for query run, extracting first: ${databaseDir}`);
// Call codeql test extract to create the database
const extractResult = await this.client.callTool({
name: "codeql_test_extract",
arguments: { tests: [testDir] }
const extractResult = await this.callTool("codeql_test_extract", {
tests: [testDir]
});
if (extractResult.isError) {
throw new Error(`Failed to extract database: ${extractResult.content[0].text}`);
Expand Down
9 changes: 5 additions & 4 deletions client/src/lib/mcp-test-suite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@ export class MCPTestSuite {
this.logger.log("Testing tool execution...");

// Try to call a simple resolve languages tool
const result = await this.client.callTool({
name: "codeql_resolve_languages",
arguments: {}
});
const result = await this.client.callTool(
{ name: "codeql_resolve_languages", arguments: {} },
undefined,
{ timeout: 300000, resetTimeoutOnProgress: true }
);

this.logger.log(`Tool result: ${JSON.stringify(result, null, 2)}`);

Expand Down
20 changes: 15 additions & 5 deletions client/src/lib/monitoring-integration-test-runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,23 @@ export class MonitoringIntegrationTestRunner {
}

/**
* Helper method to call MCP tools with correct format
* Helper method to call MCP tools with correct format and timeout.
*
* All codeql_* tools invoke the CodeQL CLI or language server JVM, which
* can be slow in CI. A generous 5-minute timeout avoids intermittent
* -32001 RequestTimeout failures.
*/
async callTool(toolName, parameters = {}) {
return await this.client.callTool({
name: toolName,
arguments: parameters
});
const isCodeQLTool = toolName.startsWith("codeql_");
const requestOptions = {
timeout: isCodeQLTool ? 300000 : 60000,
resetTimeoutOnProgress: isCodeQLTool
};
Comment thread
data-douser marked this conversation as resolved.
return await this.client.callTool(
{ name: toolName, arguments: parameters },
undefined,
requestOptions
);
}

/**
Expand Down
21 changes: 9 additions & 12 deletions client/src/ql-mcp-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,17 @@ class CodeQLMCPClient {
* Helper method to call MCP tools with correct format
*/
async callTool(toolName, parameters = {}, options = {}) {
// Set appropriate timeout based on tool type
// Long-running tools like query_run and test_run need extended timeouts
const longRunningTools = [
"codeql_query_run",
"codeql_test_run",
"codeql_database_analyze",
"codeql_database_create"
];
// All codeql_* tools invoke the CodeQL CLI or language server JVM, which
// can be slow in CI (cold JVM start, network pack downloads, Windows
// runner overhead). Use a generous 5-minute timeout for every CodeQL
// tool to avoid intermittent -32001 RequestTimeout failures.
const isCodeQLTool = toolName.startsWith("codeql_");

const defaultOptions = {
// Use 5 minute timeout for long-running tools, 60 seconds for others
timeout: longRunningTools.includes(toolName) ? 300000 : 60000,
// Reset timeout on progress notifications for long-running operations
resetTimeoutOnProgress: longRunningTools.includes(toolName)
// Use 5 minute timeout for CodeQL tools, 60 seconds for others
timeout: isCodeQLTool ? 300000 : 60000,
// Reset timeout on progress notifications for CodeQL operations
resetTimeoutOnProgress: isCodeQLTool
Comment thread
data-douser marked this conversation as resolved.
};

const requestOptions = { ...defaultOptions, ...options };
Expand Down