16194572196

Committed 10 Jul 2025 12:03PM UTC coverage: 74.831% (-0.8%) from 75.613%

Build # 16194572196

Build Type

Pull #343

github

Committed by

web-flow

Commit Message

Merge bf41f0d84 into 5ac06d0fb

Pull Request Pull Request #343: fix: turn atlas-connect-cluster async

Run Details

356 of 564 branches covered (63.12%)

Branch coverage included in aggregate %.

33 of 51 new or added lines in 3 files covered. (64.71%)

2 existing lines in 1 file now uncovered.

863 of 1065 relevant lines covered (81.03%)

56.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

61.74

/src/tools/atlas/metadata/connectCluster.ts

import { z } from "zod";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { AtlasToolBase } from "../atlasTool.js";
import { ToolArgs, OperationType } from "../../tool.js";
import { generateSecurePassword } from "../../../common/atlas/generatePassword.js";
import logger, { LogId } from "../../../logger.js";
import { inspectCluster } from "../../../common/atlas/cluster.js";

const EXPIRY_MS = 1000 * 60 * 60 * 12; // 12 hours

function sleep(ms: number): Promise<void> {
    return new Promise((resolve) => setTimeout(resolve, ms));
}

export class ConnectClusterTool extends AtlasToolBase {
    protected name = "atlas-connect-cluster";
    protected description = "Connect to MongoDB Atlas cluster";
    protected operationType: OperationType = "metadata";
    protected argsShape = {
        projectId: z.string().describe("Atlas project ID"),
        clusterName: z.string().describe("Atlas cluster name"),
    };

    private async queryConnection(
        projectId: string,
        clusterName: string
    ): Promise<"connected" | "disconnected" | "connecting" | "connected-to-other-cluster" | "unknown"> {
        if (!this.session.connectedAtlasCluster) {
            if (this.session.serviceProvider) {
                return "connected-to-other-cluster";
            }
            return "disconnected";
        }

        if (
            this.session.connectedAtlasCluster.projectId !== projectId ||
            this.session.connectedAtlasCluster.clusterName !== clusterName
        ) {
            return "connected-to-other-cluster";
        }

        if (!this.session.serviceProvider) {
            return "connecting";
        }

        try {
            await this.session.serviceProvider.runCommand("admin", {
                ping: 1,
            });

            return "connected";
        } catch (err: unknown) {
            const error = err instanceof Error ? err : new Error(String(err));
            logger.debug(
                LogId.atlasConnectFailure,
                "atlas-connect-cluster",
                `error querying cluster: ${error.message}`
            );
            return "unknown";
        }
    }

    private async prepareClusterConnection(projectId: string, clusterName: string): Promise<string> {
        const cluster = await inspectCluster(this.session.apiClient, projectId, clusterName);

        if (!cluster.connectionString) {
            throw new Error("Connection string not available");
        }

        const username = `mcpUser${Math.floor(Math.random() * 100000)}`;
        const password = await generateSecurePassword();

        const expiryDate = new Date(Date.now() + EXPIRY_MS);

        const readOnly =
            this.config.readOnly ||
            (this.config.disabledTools?.includes("create") &&
                this.config.disabledTools?.includes("update") &&
                this.config.disabledTools?.includes("delete") &&
                !this.config.disabledTools?.includes("read") &&
                !this.config.disabledTools?.includes("metadata"));

        const roleName = readOnly ? "readAnyDatabase" : "readWriteAnyDatabase";

        await this.session.apiClient.createDatabaseUser({
            params: {
                path: {
                    groupId: projectId,
                },
            },
            body: {
                databaseName: "admin",
                groupId: projectId,
                roles: [
                    {
                        roleName,
                        databaseName: "admin",
                    },
                ],
                scopes: [{ type: "CLUSTER", name: clusterName }],
                username,
                password,
                awsIAMType: "NONE",
                ldapAuthType: "NONE",
                oidcAuthType: "NONE",
                x509Type: "NONE",
                deleteAfterDate: expiryDate.toISOString(),
            },
        });

        this.session.connectedAtlasCluster = {
            username,
            projectId,
            clusterName,
            expiryDate,
        };

        const cn = new URL(cluster.connectionString);
        cn.username = username;
        cn.password = password;
        cn.searchParams.set("authSource", "admin");
        return cn.toString();
    }

    private async connectToCluster(projectId: string, clusterName: string, connectionString: string): Promise<void> {
        let lastError: Error | undefined = undefined;

        logger.debug(
            LogId.atlasConnectAttempt,
            "atlas-connect-cluster",
            `attempting to connect to cluster: ${this.session.connectedAtlasCluster?.clusterName}`
        );

        // try to connect for about 5 minutes
        for (let i = 0; i < 600; i++) {
            if (
                !this.session.connectedAtlasCluster ||
                this.session.connectedAtlasCluster.projectId != projectId ||
                this.session.connectedAtlasCluster.clusterName != clusterName
            ) {
                throw new Error("Cluster connection aborted");
            }

            try {
                lastError = undefined;

                await this.session.connectToMongoDB(connectionString, this.config.connectOptions);
                break;
            } catch (err: unknown) {
                const error = err instanceof Error ? err : new Error(String(err));

                lastError = error;

                logger.debug(
                    LogId.atlasConnectFailure,
                    "atlas-connect-cluster",
                    `error connecting to cluster: ${error.message}`
                );

                await sleep(500); // wait for 500ms before retrying
            }
        }

        if (lastError) {
            if (
                this.session.connectedAtlasCluster?.projectId == projectId &&
                this.session.connectedAtlasCluster?.clusterName == clusterName &&
                this.session.connectedAtlasCluster?.username
            ) {
                void this.session.apiClient
                    .deleteDatabaseUser({
                        params: {
                            path: {
                                groupId: this.session.connectedAtlasCluster.projectId,
                                username: this.session.connectedAtlasCluster.username,
                                databaseName: "admin",
                            },
                        },
                    })
                    .catch((err: unknown) => {
                        const error = err instanceof Error ? err : new Error(String(err));
                        logger.debug(
                            LogId.atlasConnectFailure,
                            "atlas-connect-cluster",
                            `error deleting database user: ${error.message}`
                        );
                    });
            }
            this.session.connectedAtlasCluster = undefined;
            throw lastError;
        }

        logger.debug(
            LogId.atlasConnectSucceeded,
            "atlas-connect-cluster",
            `connected to cluster: ${this.session.connectedAtlasCluster?.clusterName}`
        );
    }

    protected async execute({ projectId, clusterName }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
        for (let i = 0; i < 60; i++) {
            const state = await this.queryConnection(projectId, clusterName);
            switch (state) {
                case "connected": {
                    return {
                        content: [
                            {
                                type: "text",
                                text: `Connected to cluster "${clusterName}".`,
                            },
                        ],
                    };
                }
                case "connecting": {
                    break;
                }
                case "connected-to-other-cluster":
                case "disconnected":
                case "unknown":
                default: {
                    await this.session.disconnect();
                    const connectionString = await this.prepareClusterConnection(projectId, clusterName);

                    // try to connect for about 5 minutes asynchronously
                    void this.connectToCluster(projectId, clusterName, connectionString).catch((err: unknown) => {
                        const error = err instanceof Error ? err : new Error(String(err));
                        logger.error(
                            LogId.atlasConnectFailure,
                            "atlas-connect-cluster",
                            `error connecting to cluster: ${error.message}`
                        );
                    });
                    break;
                }
            }

            await sleep(500);
        }

        return {
            content: [
                {
                    type: "text" as const,
                    text: `Attempting to connect to cluster "${clusterName}"...`,
                },
                {
                    type: "text" as const,
                    text: `Warning: Provisioning a user and connecting to the cluster may take more time, please check again in a few seconds.`,
                },
                {
                    type: "text" as const,
                    text: `Warning: Make sure your IP address was enabled in the allow list setting of the Atlas cluster.`,
                },
            ],
        };
    }
}

1	import { z } from "zod";
2	import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
3	import { AtlasToolBase } from "../atlasTool.js";
4	import { ToolArgs, OperationType } from "../../tool.js";
5	import { generateSecurePassword } from "../../../common/atlas/generatePassword.js";
6	import logger, { LogId } from "../../../logger.js";
7	import { inspectCluster } from "../../../common/atlas/cluster.js";
8
9	const EXPIRY_MS = 1000 * 60 * 60 * 12; // 12 hours	34✔
10
11	function sleep(ms: number): Promise<void> {
12	return new Promise((resolve) => setTimeout(resolve, ms));	8✔
13	}
14
15	export class ConnectClusterTool extends AtlasToolBase {
16	protected name = "atlas-connect-cluster";	33✔
17	protected description = "Connect to MongoDB Atlas cluster";	33✔
18	protected operationType: OperationType = "metadata";	33✔
19	protected argsShape = {	33✔
20	projectId: z.string().describe("Atlas project ID"),
21	clusterName: z.string().describe("Atlas cluster name"),
22	};
23
24	private async queryConnection(
25	projectId: string,
26	clusterName: string
27	): Promise<"connected" \| "disconnected" \| "connecting" \| "connected-to-other-cluster" \| "unknown"> {
28	if (!this.session.connectedAtlasCluster) {	9✔
29	if (this.session.serviceProvider) {	1!
NEW 30	return "connected-to-other-cluster";	×
31	}
32	return "disconnected";	1✔
33	}
34
35	if (	8!
36	this.session.connectedAtlasCluster.projectId !== projectId \|\|	16✔
37	this.session.connectedAtlasCluster.clusterName !== clusterName
38	) {
NEW 39	return "connected-to-other-cluster";	×
40	}
41
42	if (!this.session.serviceProvider) {	8✔
43	return "connecting";	7✔
44	}
45
46	try {	1✔
47	await this.session.serviceProvider.runCommand("admin", {	1✔
48	ping: 1,
49	});
50
51	return "connected";	1✔
52	} catch (err: unknown) {
NEW 53	const error = err instanceof Error ? err : new Error(String(err));	×
NEW 54	logger.debug(	×
55	LogId.atlasConnectFailure,
56	"atlas-connect-cluster",
57	`error querying cluster: ${error.message}`
58	);
NEW 59	return "unknown";	×
60	}
61	}
62
63	private async prepareClusterConnection(projectId: string, clusterName: string): Promise<string> {
64	const cluster = await inspectCluster(this.session.apiClient, projectId, clusterName);	1✔
65
66	if (!cluster.connectionString) {	1!
67	throw new Error("Connection string not available");	×
68	}
69
70	const username = `mcpUser${Math.floor(Math.random() * 100000)}`;	1✔
71	const password = await generateSecurePassword();	1✔
72
73	const expiryDate = new Date(Date.now() + EXPIRY_MS);	1✔
74
75	const readOnly =
76	this.config.readOnly \|\|	1!
77	(this.config.disabledTools?.includes("create") &&
78	this.config.disabledTools?.includes("update") &&
79	this.config.disabledTools?.includes("delete") &&
80	!this.config.disabledTools?.includes("read") &&
81	!this.config.disabledTools?.includes("metadata"));
82
83	const roleName = readOnly ? "readAnyDatabase" : "readWriteAnyDatabase";	1!
84
85	await this.session.apiClient.createDatabaseUser({	1✔
86	params: {
87	path: {
88	groupId: projectId,
89	},
90	},
91	body: {
92	databaseName: "admin",
93	groupId: projectId,
94	roles: [
95	{
96	roleName,
97	databaseName: "admin",
98	},
99	],
100	scopes: [{ type: "CLUSTER", name: clusterName }],
101	username,
102	password,
103	awsIAMType: "NONE",
104	ldapAuthType: "NONE",
105	oidcAuthType: "NONE",
106	x509Type: "NONE",
107	deleteAfterDate: expiryDate.toISOString(),
108	},
109	});
110
111	this.session.connectedAtlasCluster = {	1✔
112	username,
113	projectId,
114	clusterName,
115	expiryDate,
116	};
117
118	const cn = new URL(cluster.connectionString);	1✔
119	cn.username = username;	1✔
120	cn.password = password;	1✔
121	cn.searchParams.set("authSource", "admin");	1✔
122	return cn.toString();	1✔
123	}
124
125	private async connectToCluster(projectId: string, clusterName: string, connectionString: string): Promise<void> {
126	let lastError: Error \| undefined = undefined;	1✔
127
128	logger.debug(	1✔
129	LogId.atlasConnectAttempt,
130	"atlas-connect-cluster",
131	`attempting to connect to cluster: ${this.session.connectedAtlasCluster?.clusterName}`
132	);
133
134	// try to connect for about 5 minutes
135	for (let i = 0; i < 600; i++) {	1✔
136	if (	1!
137	!this.session.connectedAtlasCluster \|\|	3✔
138	this.session.connectedAtlasCluster.projectId != projectId \|\|
139	this.session.connectedAtlasCluster.clusterName != clusterName
140	) {
NEW 141	throw new Error("Cluster connection aborted");	×
142	}
143
144	try {	1✔
145	lastError = undefined;	1✔
146
147	await this.session.connectToMongoDB(connectionString, this.config.connectOptions);	1✔
148	break;	1✔
149	} catch (err: unknown) {
150	const error = err instanceof Error ? err : new Error(String(err));	×
151
152	lastError = error;	×
153
154	logger.debug(	×
155	LogId.atlasConnectFailure,
156	"atlas-connect-cluster",
157	`error connecting to cluster: ${error.message}`
158	);
159
160	await sleep(500); // wait for 500ms before retrying	×
161	}
162	}
163
164	if (lastError) {	1!
NEW 165	if (	×
166	this.session.connectedAtlasCluster?.projectId == projectId &&	×
167	this.session.connectedAtlasCluster?.clusterName == clusterName &&
168	this.session.connectedAtlasCluster?.username
169	) {
NEW 170	void this.session.apiClient	×
171	.deleteDatabaseUser({
172	params: {
173	path: {
174	groupId: this.session.connectedAtlasCluster.projectId,
175	username: this.session.connectedAtlasCluster.username,
176	databaseName: "admin",
177	},
178	},
179	})
180	.catch((err: unknown) => {
NEW 181	const error = err instanceof Error ? err : new Error(String(err));	×
NEW 182	logger.debug(	×
183	LogId.atlasConnectFailure,
184	"atlas-connect-cluster",
185	`error deleting database user: ${error.message}`
186	);
187	});
188	}
NEW 189	this.session.connectedAtlasCluster = undefined;	×
UNCOV 190	throw lastError;	×
191	}
192
193	logger.debug(	1✔
194	LogId.atlasConnectSucceeded,
195	"atlas-connect-cluster",
196	`connected to cluster: ${this.session.connectedAtlasCluster?.clusterName}`
197	);
198	}
199
200	protected async execute({ projectId, clusterName }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
201	for (let i = 0; i < 60; i++) {	1✔
202	const state = await this.queryConnection(projectId, clusterName);	9✔
203	switch (state) {	9!
204	case "connected": {
205	return {	1✔
206	content: [
207	{
208	type: "text",
209	text: `Connected to cluster "${clusterName}".`,
210	},
211	],
212	};
213	}
214	case "connecting": {
215	break;	7✔
216	}
217	case "connected-to-other-cluster":
218	case "disconnected":
219	case "unknown":
220	default: {
221	await this.session.disconnect();	1✔
222	const connectionString = await this.prepareClusterConnection(projectId, clusterName);	1✔
223
224	// try to connect for about 5 minutes asynchronously
225	void this.connectToCluster(projectId, clusterName, connectionString).catch((err: unknown) => {	1✔
NEW 226	const error = err instanceof Error ? err : new Error(String(err));	×
NEW 227	logger.error(	×
228	LogId.atlasConnectFailure,
229	"atlas-connect-cluster",
230	`error connecting to cluster: ${error.message}`
231	);
232	});
233	break;	1✔
234	}
235	}
236
237	await sleep(500);	8✔
238	}
239
UNCOV 240	return {	×
241	content: [
242	{
243	type: "text" as const,
244	text: `Attempting to connect to cluster "${clusterName}"...`,
245	},
246	{
247	type: "text" as const,
248	text: `Warning: Provisioning a user and connecting to the cluster may take more time, please check again in a few seconds.`,
249	},
250	{
251	type: "text" as const,
252	text: `Warning: Make sure your IP address was enabled in the allow list setting of the Atlas cluster.`,
253	},
254	],
255	};
256	}
257	}

mongodb-js / mongodb-mcp-server / 16194572196

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous