Skip to content

chore(web): align cluster connection options with the design COMPASS-8794 #6603

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
merged 1 commit into from
Jan 10, 2025
Merged

chore(web): align cluster connection options with the design COMPASS-8794 #6603

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
21 changes: 4 additions & 17 deletions packages/compass-web/polyfills/net/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ import { Duplex } from 'stream';
* implementation
*/
class Socket extends Duplex {
private _tls = false;
private _ws: WebSocket | null = null;
private _setOptions: {
Copy link
Collaborator Author

@gribnoysup gribnoysup Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive-by clean-up, this was doing nothing after a recent change to the logic of the proxy

setKeepAlive?: { enabled?: boolean; initialDelay?: number };
setTimeout?: { timeout?: number };
setNoDelay?: { noDelay?: boolean };
} = {};
constructor() {
super();
}
Expand All @@ -27,7 +21,6 @@ class Socket extends Duplex {
lookup?: ConnectionOptions['lookup'];
tls?: boolean;
}) {
this._tls = !!options.tls;
const { wsURL, ...atlasOptions } =
lookup?.() ?? ({} as { wsURL?: string; clusterName?: string });
this._ws = new WebSocket(wsURL ?? '/ws-proxy');
Expand Down Expand Up @@ -62,7 +55,7 @@ class Socket extends Duplex {
const res = JSON.parse(data) as { preMessageOk: 1 };
if (res.preMessageOk) {
setTimeout(() => {
this.emit(this._tls ? 'secureConnect' : 'connect');
this.emit(options.tls ? 'secureConnect' : 'connect');
});
}
} catch (err) {
Expand Down Expand Up @@ -108,19 +101,13 @@ class Socket extends Duplex {
this._ws?.close();
return this;
}
setKeepAlive(enabled = false, initialDelay = 0) {
this._setOptions.setKeepAlive = { enabled, initialDelay };
setKeepAlive() {
return this;
}
setTimeout(timeout: number, cb?: () => void) {
this._setOptions.setTimeout = { timeout };
if (cb) {
this.once('timeout', cb);
}
setTimeout() {
return this;
}
setNoDelay(noDelay = true) {
this._setOptions.setNoDelay = { noDelay };
setNoDelay() {
return this;
}
}
Expand Down
11 changes: 1 addition & 10 deletions packages/compass-web/scripts/ws-proxy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ const net = require('net');
const tls = require('tls');
const { WebSocketServer } = require('ws');

function serializeError(err) {
if (err) {
return {
name: err.name,
message: err.message,
};
}
}

/**
* Creates a simple passthrough proxy that accepts a websocket connection and
* establishes a corresponding socket connection to a server. The connection
Expand Down Expand Up @@ -60,7 +51,7 @@ function createWebSocketProxy(port = 1337, logger = console) {
SOCKET_ERROR_EVENT_LIST.forEach((evt) => {
socket.on(evt, (err) => {
logger.log('server socket error event (%s)', evt, err);
ws.send(JSON.stringify({ evt, error: serializeError(err) }));
ws.close(evt === 'close' ? 1001 : 1011);
});
});
socket.on(connectEvent, () => {
Expand Down
6 changes: 3 additions & 3 deletions packages/compass-web/src/connection-storage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ describe('buildConnectionInfoFromClusterDescription', function () {
},
],
},
'mongodb+srv://replicaSet.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&maxPoolSize=3',
'mongodb+srv://replicaSet.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&serverMonitoringMode=poll&maxIdleTimeMS=30000&minPoolSize=0&maxPoolSize=5',
],
[
'sharded',
Expand Down Expand Up @@ -90,7 +90,7 @@ describe('buildConnectionInfoFromClusterDescription', function () {
},
],
},
'mongodb+srv://sharded.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&maxPoolSize=3&srvMaxHosts=3',
'mongodb+srv://sharded.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&serverMonitoringMode=poll&maxIdleTimeMS=30000&minPoolSize=0&maxPoolSize=5&srvMaxHosts=1',
],
[
'serverless',
Expand Down Expand Up @@ -119,7 +119,7 @@ describe('buildConnectionInfoFromClusterDescription', function () {
},
],
},
'mongodb+srv://serverless.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&maxPoolSize=3',
'mongodb+srv://serverless.mongodb.com/?tls=true&authMechanism=MONGODB-X509&authSource=%24external&serverMonitoringMode=poll&maxIdleTimeMS=30000&minPoolSize=0&maxPoolSize=5',
],
];

Expand Down
10 changes: 8 additions & 2 deletions packages/compass-web/src/connection-storage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,16 @@ export function buildConnectionInfoFromClusterDescription(
connectionString.searchParams.set('authMechanism', 'MONGODB-X509');
connectionString.searchParams.set('authSource', '$external');

// Make sure server monitoring is done without streaming
connectionString.searchParams.set('serverMonitoringMode', 'poll');
// Allow driver to clean up idle connections from the pool
connectionString.searchParams.set('maxIdleTimeMS', '30000');

// Limit connection pool for replicas and sharded
connectionString.searchParams.set('maxPoolSize', '3');
connectionString.searchParams.set('minPoolSize', '0');
connectionString.searchParams.set('maxPoolSize', '5');
if (isSharded(description)) {
connectionString.searchParams.set('srvMaxHosts', '3');
connectionString.searchParams.set('srvMaxHosts', '1');
}

for (const [key, value] of Object.entries(extraConnectionOptions ?? {})) {
Expand Down
Loading