|
| 1 | +import { ConnectOptions } from "./config.js"; |
| 2 | +import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver"; |
| 3 | +import EventEmitter from "events"; |
| 4 | +import { setAppNameParamIfMissing } from "../helpers/connectionOptions.js"; |
| 5 | +import { packageInfo } from "./packageInfo.js"; |
| 6 | +import ConnectionString from "mongodb-connection-string-url"; |
| 7 | +import { MongoClientOptions } from "mongodb"; |
| 8 | +import { ErrorCodes, MongoDBError } from "./errors.js"; |
| 9 | + |
| 10 | +export interface AtlasClusterConnectionInfo { |
| 11 | + username: string; |
| 12 | + projectId: string; |
| 13 | + clusterName: string; |
| 14 | + expiryDate: Date; |
| 15 | +} |
| 16 | + |
| 17 | +export interface ConnectionSettings extends ConnectOptions { |
| 18 | + connectionString: string; |
| 19 | + atlas?: AtlasClusterConnectionInfo; |
| 20 | +} |
| 21 | + |
| 22 | +type ConnectionTag = "connected" | "connecting" | "disconnected" | "errored"; |
| 23 | +type OIDCConnectionAuthType = "oidc-auth-flow" | "oidc-device-flow"; |
| 24 | +export type ConnectionStringAuthType = "scram" | "ldap" | "kerberos" | OIDCConnectionAuthType | "x.509"; |
| 25 | + |
| 26 | +export interface ConnectionState { |
| 27 | + tag: ConnectionTag; |
| 28 | + connectionStringAuthType?: ConnectionStringAuthType; |
| 29 | + connectedAtlasCluster?: AtlasClusterConnectionInfo; |
| 30 | +} |
| 31 | + |
| 32 | +export interface ConnectionStateConnected extends ConnectionState { |
| 33 | + tag: "connected"; |
| 34 | + serviceProvider: NodeDriverServiceProvider; |
| 35 | +} |
| 36 | + |
| 37 | +export interface ConnectionStateConnecting extends ConnectionState { |
| 38 | + tag: "connecting"; |
| 39 | + serviceProvider: NodeDriverServiceProvider; |
| 40 | + oidcConnectionType: OIDCConnectionAuthType; |
| 41 | + oidcLoginUrl?: string; |
| 42 | + oidcUserCode?: string; |
| 43 | +} |
| 44 | + |
| 45 | +export interface ConnectionStateDisconnected extends ConnectionState { |
| 46 | + tag: "disconnected"; |
| 47 | +} |
| 48 | + |
| 49 | +export interface ConnectionStateErrored extends ConnectionState { |
| 50 | + tag: "errored"; |
| 51 | + errorReason: string; |
| 52 | +} |
| 53 | + |
| 54 | +export type AnyConnectionState = |
| 55 | + | ConnectionStateConnected |
| 56 | + | ConnectionStateConnecting |
| 57 | + | ConnectionStateDisconnected |
| 58 | + | ConnectionStateErrored; |
| 59 | + |
| 60 | +export interface ConnectionManagerEvents { |
| 61 | + "connection-requested": [AnyConnectionState]; |
| 62 | + "connection-succeeded": [ConnectionStateConnected]; |
| 63 | + "connection-timed-out": [ConnectionStateErrored]; |
| 64 | + "connection-closed": [ConnectionStateDisconnected]; |
| 65 | + "connection-errored": [ConnectionStateErrored]; |
| 66 | +} |
| 67 | + |
| 68 | +export class ConnectionManager extends EventEmitter<ConnectionManagerEvents> { |
| 69 | + private state: AnyConnectionState; |
| 70 | + |
| 71 | + constructor() { |
| 72 | + super(); |
| 73 | + this.state = { tag: "disconnected" }; |
| 74 | + } |
| 75 | + |
| 76 | + async connect(settings: ConnectionSettings): Promise<AnyConnectionState> { |
| 77 | + this.emit("connection-requested", this.state); |
| 78 | + |
| 79 | + if (this.state.tag === "connected" || this.state.tag === "connecting") { |
| 80 | + await this.disconnect(); |
| 81 | + } |
| 82 | + |
| 83 | + let serviceProvider: NodeDriverServiceProvider; |
| 84 | + try { |
| 85 | + settings = { ...settings }; |
| 86 | + settings.connectionString = setAppNameParamIfMissing({ |
| 87 | + connectionString: settings.connectionString, |
| 88 | + defaultAppName: `${packageInfo.mcpServerName} ${packageInfo.version}`, |
| 89 | + }); |
| 90 | + |
| 91 | + serviceProvider = await NodeDriverServiceProvider.connect(settings.connectionString, { |
| 92 | + productDocsLink: "https://github.com/mongodb-js/mongodb-mcp-server/", |
| 93 | + productName: "MongoDB MCP", |
| 94 | + readConcern: { |
| 95 | + level: settings.readConcern, |
| 96 | + }, |
| 97 | + readPreference: settings.readPreference, |
| 98 | + writeConcern: { |
| 99 | + w: settings.writeConcern, |
| 100 | + }, |
| 101 | + timeoutMS: settings.timeoutMS, |
| 102 | + proxy: { useEnvironmentVariableProxies: true }, |
| 103 | + applyProxyToOIDC: true, |
| 104 | + }); |
| 105 | + } catch (error: unknown) { |
| 106 | + const errorReason = error instanceof Error ? error.message : `${error as string}`; |
| 107 | + this.changeState("connection-errored", { |
| 108 | + tag: "errored", |
| 109 | + errorReason, |
| 110 | + connectedAtlasCluster: settings.atlas, |
| 111 | + }); |
| 112 | + throw new MongoDBError(ErrorCodes.MisconfiguredConnectionString, errorReason); |
| 113 | + } |
| 114 | + |
| 115 | + try { |
| 116 | + await serviceProvider?.runCommand?.("admin", { hello: 1 }); |
| 117 | + |
| 118 | + return this.changeState("connection-succeeded", { |
| 119 | + tag: "connected", |
| 120 | + connectedAtlasCluster: settings.atlas, |
| 121 | + serviceProvider, |
| 122 | + connectionStringAuthType: ConnectionManager.inferConnectionTypeFromSettings(settings), |
| 123 | + }); |
| 124 | + } catch (error: unknown) { |
| 125 | + const errorReason = error instanceof Error ? error.message : `${error as string}`; |
| 126 | + this.changeState("connection-errored", { |
| 127 | + tag: "errored", |
| 128 | + errorReason, |
| 129 | + connectedAtlasCluster: settings.atlas, |
| 130 | + }); |
| 131 | + throw new MongoDBError(ErrorCodes.NotConnectedToMongoDB, errorReason); |
| 132 | + } |
| 133 | + } |
| 134 | + |
| 135 | + async disconnect(): Promise<ConnectionStateDisconnected | ConnectionStateErrored> { |
| 136 | + if (this.state.tag === "disconnected" || this.state.tag === "errored") { |
| 137 | + return this.state; |
| 138 | + } |
| 139 | + |
| 140 | + if (this.state.tag === "connected" || this.state.tag === "connecting") { |
| 141 | + try { |
| 142 | + await this.state.serviceProvider?.close(true); |
| 143 | + } finally { |
| 144 | + this.changeState("connection-closed", { |
| 145 | + tag: "disconnected", |
| 146 | + }); |
| 147 | + } |
| 148 | + } |
| 149 | + |
| 150 | + return { tag: "disconnected" }; |
| 151 | + } |
| 152 | + |
| 153 | + get currentConnectionState(): AnyConnectionState { |
| 154 | + return this.state; |
| 155 | + } |
| 156 | + |
| 157 | + changeState<Event extends keyof ConnectionManagerEvents, State extends ConnectionManagerEvents[Event][0]>( |
| 158 | + event: Event, |
| 159 | + newState: State |
| 160 | + ): State { |
| 161 | + this.state = newState; |
| 162 | + // TypeScript doesn't seem to be happy with the spread operator and generics |
| 163 | + // eslint-disable-next-line |
| 164 | + this.emit(event, ...([newState] as any)); |
| 165 | + return newState; |
| 166 | + } |
| 167 | + |
| 168 | + static inferConnectionTypeFromSettings(settings: ConnectionSettings): ConnectionStringAuthType { |
| 169 | + const connString = new ConnectionString(settings.connectionString); |
| 170 | + const searchParams = connString.typedSearchParams<MongoClientOptions>(); |
| 171 | + |
| 172 | + switch (searchParams.get("authMechanism")) { |
| 173 | + case "MONGODB-OIDC": { |
| 174 | + return "oidc-auth-flow"; // TODO: depending on if we don't have a --browser later it can be oidc-device-flow |
| 175 | + } |
| 176 | + case "MONGODB-X509": |
| 177 | + return "x.509"; |
| 178 | + case "GSSAPI": |
| 179 | + return "kerberos"; |
| 180 | + case "PLAIN": |
| 181 | + if (searchParams.get("authSource") === "$external") { |
| 182 | + return "ldap"; |
| 183 | + } |
| 184 | + return "scram"; |
| 185 | + // default should catch also null, but eslint complains |
| 186 | + // about it. |
| 187 | + case null: |
| 188 | + default: |
| 189 | + return "scram"; |
| 190 | + } |
| 191 | + } |
| 192 | +} |
0 commit comments