14624246692

Committed 23 Apr 2025 05:23PM UTC coverage: 75.368% (-3.1%) from 78.42%

Build # 14624246692

Build Type

push

github

Committed by

web-flow

Commit Message

feat: core telemetry functionality (#87)

Co-authored-by: Filipe Constantinov Menezes <filipe.menezes@mongodb.com>

Run Details

102 of 187 branches covered (54.55%)

Branch coverage included in aggregate %.

52 of 91 new or added lines in 7 files covered. (57.14%)

26 existing lines in 6 files now uncovered.

614 of 763 relevant lines covered (80.47%)

33.99 hits per line

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

73.27

/src/common/atlas/apiClient.ts

import createClient, { Client, Middleware } from "openapi-fetch";
import type { FetchOptions } from "openapi-fetch";
import { AccessToken, ClientCredentials } from "simple-oauth2";
import { ApiClientError } from "./apiClientError.js";
import { paths, operations } from "./openapi.js";
import { BaseEvent } from "../../telemetry/types.js";
import { mongoLogId } from "mongodb-log-writer";
import logger from "../../logger.js";
import { packageInfo } from "../../packageInfo.js";

const ATLAS_API_VERSION = "2025-03-12";

export interface ApiClientCredentials {
    clientId: string;
    clientSecret: string;
}

export interface ApiClientOptions {
    credentials?: ApiClientCredentials;
    baseUrl?: string;
    userAgent?: string;
}

export class ApiClient {
    private options: {
        baseUrl: string;
        userAgent: string;
        credentials?: {
            clientId: string;
            clientSecret: string;
        };
    };
    private client: Client<paths>;
    private oauth2Client?: ClientCredentials;
    private accessToken?: AccessToken;

    private getAccessToken = async () => {
        if (this.oauth2Client && (!this.accessToken || this.accessToken.expired())) {
            this.accessToken = await this.oauth2Client.getToken({});
        }
        return this.accessToken?.token.access_token as string | undefined;
    };

    private authMiddleware: Middleware = {
        onRequest: async ({ request, schemaPath }) => {
            if (schemaPath.startsWith("/api/private/unauth") || schemaPath.startsWith("/api/oauth")) {
                return undefined;
            }

            try {
                const accessToken = await this.getAccessToken();
                request.headers.set("Authorization", `Bearer ${accessToken}`);
                return request;
            } catch {
                // ignore not availble tokens, API will return 401
            }
        },
    };

    private readonly errorMiddleware: Middleware = {
        async onResponse({ response }) {
            if (!response.ok) {
                throw await ApiClientError.fromResponse(response);
            }
        },
    };

    constructor(options?: ApiClientOptions) {
        this.options = {
            ...options,
            baseUrl: options?.baseUrl || "https://cloud.mongodb.com/",
            userAgent:
                options?.userAgent ||
                `AtlasMCP/${packageInfo.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME || "unknown"})`,
        };

        this.client = createClient<paths>({
            baseUrl: this.options.baseUrl,
            headers: {
                "User-Agent": this.options.userAgent,
                Accept: `application/vnd.atlas.${ATLAS_API_VERSION}+json`,
            },
        });
        if (this.options.credentials?.clientId && this.options.credentials?.clientSecret) {
            this.oauth2Client = new ClientCredentials({
                client: {
                    id: this.options.credentials.clientId,
                    secret: this.options.credentials.clientSecret,
                },
                auth: {
                    tokenHost: this.options.baseUrl,
                    tokenPath: "/api/oauth/token",
                },
            });
            this.client.use(this.authMiddleware);
        }
        this.client.use(this.errorMiddleware);
    }

    public hasCredentials(): boolean {
        logger.info(
            mongoLogId(1_000_000),
            "api-client",
            `Checking if API client has credentials: ${!!(this.oauth2Client && this.accessToken)}`
        );
        return !!(this.oauth2Client && this.accessToken);
    }

    public async getIpInfo(): Promise<{
        currentIpv4Address: string;
    }> {
        const accessToken = await this.getAccessToken();

        const endpoint = "api/private/ipinfo";
        const url = new URL(endpoint, this.options.baseUrl);
        const response = await fetch(url, {
            method: "GET",
            headers: {
                Accept: "application/json",
                Authorization: `Bearer ${accessToken}`,
                "User-Agent": this.options.userAgent,
            },
        });

        if (!response.ok) {
            throw await ApiClientError.fromResponse(response);
        }

        return (await response.json()) as Promise<{
            currentIpv4Address: string;
        }>;
    }

    async sendEvents(events: BaseEvent[]): Promise<void> {
        let endpoint = "api/private/unauth/telemetry/events";
        const headers: Record<string, string> = {
            Accept: "application/json",
            "Content-Type": "application/json",
            "User-Agent": this.options.userAgent,
        };

        const accessToken = await this.getAccessToken();
        if (accessToken) {
            endpoint = "api/private/v1.0/telemetry/events";
            headers["Authorization"] = `Bearer ${accessToken}`;
        }

        const url = new URL(endpoint, this.options.baseUrl);
        const response = await fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(events),
        });

        if (!response.ok) {
            throw await ApiClientError.fromResponse(response);
        }
    }

    // DO NOT EDIT. This is auto-generated code.
    async listClustersForAllProjects(options?: FetchOptions<operations["listClustersForAllProjects"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/clusters", options);
        return data;
    }

    async listProjects(options?: FetchOptions<operations["listProjects"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups", options);
        return data;
    }

    async createProject(options: FetchOptions<operations["createProject"]>) {
        const { data } = await this.client.POST("/api/atlas/v2/groups", options);
        return data;
    }

    async deleteProject(options: FetchOptions<operations["deleteProject"]>) {
        await this.client.DELETE("/api/atlas/v2/groups/{groupId}", options);
    }

    async getProject(options: FetchOptions<operations["getProject"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}", options);
        return data;
    }

    async listProjectIpAccessLists(options: FetchOptions<operations["listProjectIpAccessLists"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/accessList", options);
        return data;
    }

    async createProjectIpAccessList(options: FetchOptions<operations["createProjectIpAccessList"]>) {
        const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/accessList", options);
        return data;
    }

    async deleteProjectIpAccessList(options: FetchOptions<operations["deleteProjectIpAccessList"]>) {
        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/accessList/{entryValue}", options);
    }

    async listClusters(options: FetchOptions<operations["listClusters"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters", options);
        return data;
    }

    async createCluster(options: FetchOptions<operations["createCluster"]>) {
        const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/clusters", options);
        return data;
    }

    async deleteCluster(options: FetchOptions<operations["deleteCluster"]>) {
        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);
    }

    async getCluster(options: FetchOptions<operations["getCluster"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);
        return data;
    }

    async listDatabaseUsers(options: FetchOptions<operations["listDatabaseUsers"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/databaseUsers", options);
        return data;
    }

    async createDatabaseUser(options: FetchOptions<operations["createDatabaseUser"]>) {
        const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/databaseUsers", options);
        return data;
    }

    async deleteDatabaseUser(options: FetchOptions<operations["deleteDatabaseUser"]>) {
        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}", options);
    }

    async listOrganizations(options?: FetchOptions<operations["listOrganizations"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/orgs", options);
        return data;
    }

    async listOrganizationProjects(options: FetchOptions<operations["listOrganizationProjects"]>) {
        const { data } = await this.client.GET("/api/atlas/v2/orgs/{orgId}/groups", options);
        return data;
    }

    // DO NOT EDIT. This is auto-generated code.
}

1	import createClient, { Client, Middleware } from "openapi-fetch";	18✔
2	import type { FetchOptions } from "openapi-fetch";
3	import { AccessToken, ClientCredentials } from "simple-oauth2";	18✔
4	import { ApiClientError } from "./apiClientError.js";	18✔
5	import { paths, operations } from "./openapi.js";
6	import { BaseEvent } from "../../telemetry/types.js";
7	import { mongoLogId } from "mongodb-log-writer";	18✔
8	import logger from "../../logger.js";	18✔
9	import { packageInfo } from "../../packageInfo.js";	18✔
10
11	const ATLAS_API_VERSION = "2025-03-12";	18✔
12
13	export interface ApiClientCredentials {
14	clientId: string;
15	clientSecret: string;
16	}
17
18	export interface ApiClientOptions {
19	credentials?: ApiClientCredentials;
20	baseUrl?: string;
21	userAgent?: string;
22	}
23
24	export class ApiClient {	18✔
25	private options: {
26	baseUrl: string;
27	userAgent: string;
28	credentials?: {
29	clientId: string;
30	clientSecret: string;
31	};
32	};
33	private client: Client<paths>;
34	private oauth2Client?: ClientCredentials;
35	private accessToken?: AccessToken;
36
37	private getAccessToken = async () => {	19✔
38	if (this.oauth2Client && (!this.accessToken \|\| this.accessToken.expired())) {	45✔
39	this.accessToken = await this.oauth2Client.getToken({});	5✔
40	}
41	return this.accessToken?.token.access_token as string \| undefined;	45✔
42	};
43
44	private authMiddleware: Middleware = {	19✔
45	onRequest: async ({ request, schemaPath }) => {
46	if (schemaPath.startsWith("/api/private/unauth") \|\| schemaPath.startsWith("/api/oauth")) {	43!
47	return undefined;	×
48	}
49
50	try {	43✔
51	const accessToken = await this.getAccessToken();	43✔
52	request.headers.set("Authorization", `Bearer ${accessToken}`);	43✔
53	return request;	43✔
54	} catch {
55	// ignore not availble tokens, API will return 401
56	}
57	},
58	};
59
60	private readonly errorMiddleware: Middleware = {	19✔
61	async onResponse({ response }) {
62	if (!response.ok) {	43✔
63	throw await ApiClientError.fromResponse(response);	1✔
64	}
65	},
66	};
67
68	constructor(options?: ApiClientOptions) {
69	this.options = {	19✔
70	...options,
71	baseUrl: options?.baseUrl \|\| "https://cloud.mongodb.com/",	19!
72	userAgent:
73	options?.userAgent \|\|	38✔
74	`AtlasMCP/${packageInfo.version} (${process.platform}; ${process.arch}; ${process.env.HOSTNAME \|\| "unknown"})`,	38✔
75	};
76
77	this.client = createClient<paths>({	19✔
78	baseUrl: this.options.baseUrl,
79	headers: {
80	"User-Agent": this.options.userAgent,
81	Accept: `application/vnd.atlas.${ATLAS_API_VERSION}+json`,
82	},
83	});
84	if (this.options.credentials?.clientId && this.options.credentials?.clientSecret) {	19✔
85	this.oauth2Client = new ClientCredentials({	18✔
86	client: {
87	id: this.options.credentials.clientId,
88	secret: this.options.credentials.clientSecret,
89	},
90	auth: {
91	tokenHost: this.options.baseUrl,
92	tokenPath: "/api/oauth/token",
93	},
94	});
95	this.client.use(this.authMiddleware);	18✔
96	}
97	this.client.use(this.errorMiddleware);	19✔
98	}
99
100	public hasCredentials(): boolean {
NEW 101	logger.info(	×
102	mongoLogId(1_000_000),
103	"api-client",
104	`Checking if API client has credentials: ${!!(this.oauth2Client && this.accessToken)}`	×
105	);
NEW 106	return !!(this.oauth2Client && this.accessToken);	×
107	}
108
109	public async getIpInfo(): Promise<{
110	currentIpv4Address: string;
111	}> {
112	const accessToken = await this.getAccessToken();	2✔
113
114	const endpoint = "api/private/ipinfo";	2✔
115	const url = new URL(endpoint, this.options.baseUrl);	2✔
116	const response = await fetch(url, {	2✔
117	method: "GET",
118	headers: {
119	Accept: "application/json",
120	Authorization: `Bearer ${accessToken}`,
121	"User-Agent": this.options.userAgent,
122	},
123	});
124
125	if (!response.ok) {	2!
126	throw await ApiClientError.fromResponse(response);	×
127	}
128
129	return (await response.json()) as Promise<{	2✔
130	currentIpv4Address: string;
131	}>;
132	}
133
134	async sendEvents(events: BaseEvent[]): Promise<void> {
NEW 135	let endpoint = "api/private/unauth/telemetry/events";	×
NEW 136	const headers: Record<string, string> = {	×
137	Accept: "application/json",
138	"Content-Type": "application/json",
139	"User-Agent": this.options.userAgent,
140	};
141
NEW 142	const accessToken = await this.getAccessToken();	×
NEW 143	if (accessToken) {	×
NEW 144	endpoint = "api/private/v1.0/telemetry/events";	×
NEW 145	headers["Authorization"] = `Bearer ${accessToken}`;	×
146	}
147
NEW 148	const url = new URL(endpoint, this.options.baseUrl);	×
NEW 149	const response = await fetch(url, {	×
150	method: "POST",
151	headers,
152	body: JSON.stringify(events),
153	});
154
NEW 155	if (!response.ok) {	×
NEW 156	throw await ApiClientError.fromResponse(response);	×
157	}
158	}
159
160	// DO NOT EDIT. This is auto-generated code.
161	async listClustersForAllProjects(options?: FetchOptions<operations["listClustersForAllProjects"]>) {
162	const { data } = await this.client.GET("/api/atlas/v2/clusters", options);	×
163	return data;	×
164	}
165
166	async listProjects(options?: FetchOptions<operations["listProjects"]>) {
167	const { data } = await this.client.GET("/api/atlas/v2/groups", options);	2✔
168	return data;	2✔
169	}
170
171	async createProject(options: FetchOptions<operations["createProject"]>) {
172	const { data } = await this.client.POST("/api/atlas/v2/groups", options);	4✔
173	return data;	4✔
174	}
175
176	async deleteProject(options: FetchOptions<operations["deleteProject"]>) {
177	await this.client.DELETE("/api/atlas/v2/groups/{groupId}", options);	4✔
178	}
179
180	async getProject(options: FetchOptions<operations["getProject"]>) {
181	const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}", options);	1✔
182	return data;	1✔
183	}
184
185	async listProjectIpAccessLists(options: FetchOptions<operations["listProjectIpAccessLists"]>) {
186	const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/accessList", options);	1✔
187	return data;	1✔
188	}
189
190	async createProjectIpAccessList(options: FetchOptions<operations["createProjectIpAccessList"]>) {
191	const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/accessList", options);	1✔
192	return data;	1✔
193	}
194
195	async deleteProjectIpAccessList(options: FetchOptions<operations["deleteProjectIpAccessList"]>) {
196	await this.client.DELETE("/api/atlas/v2/groups/{groupId}/accessList/{entryValue}", options);	5✔
197	}
198
199	async listClusters(options: FetchOptions<operations["listClusters"]>) {
200	const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters", options);	1✔
201	return data;	1✔
202	}
203
204	async createCluster(options: FetchOptions<operations["createCluster"]>) {
205	const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/clusters", options);	1✔
206	return data;	1✔
207	}
208
209	async deleteCluster(options: FetchOptions<operations["deleteCluster"]>) {
210	await this.client.DELETE("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);	1✔
211	}
212
213	async getCluster(options: FetchOptions<operations["getCluster"]>) {
214	const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);	14✔
215	return data;	13✔
216	}
217
218	async listDatabaseUsers(options: FetchOptions<operations["listDatabaseUsers"]>) {
219	const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/databaseUsers", options);	1✔
220	return data;	1✔
221	}
222
223	async createDatabaseUser(options: FetchOptions<operations["createDatabaseUser"]>) {
224	const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/databaseUsers", options);	1✔
225	return data;	1✔
226	}
227
228	async deleteDatabaseUser(options: FetchOptions<operations["deleteDatabaseUser"]>) {
229	await this.client.DELETE("/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}", options);	1✔
230	}
231
232	async listOrganizations(options?: FetchOptions<operations["listOrganizations"]>) {
233	const { data } = await this.client.GET("/api/atlas/v2/orgs", options);	5✔
234	return data;	5✔
235	}
236
237	async listOrganizationProjects(options: FetchOptions<operations["listOrganizationProjects"]>) {
238	const { data } = await this.client.GET("/api/atlas/v2/orgs/{orgId}/groups", options);	×
239	return data;	×
240	}
241
242	// DO NOT EDIT. This is auto-generated code.
243	}

mongodb-js / mongodb-mcp-server / 14624246692

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