chore: use typed connection string search params

packages/compass-connect/package.json

@@ -108,7 +108,7 @@
     "mongodb-build-info": "^1.3.0",
     "mongodb-cloud-info": "^1.1.3",
     "mongodb-connection-model": "^21.10.0",
-    "mongodb-connection-string-url": "^2.3.2",
+    "mongodb-connection-string-url": "^2.4.1",
     "mongodb-data-service": "^21.14.0",
     "mongodb-runner": "^4.8.3",
     "mongodb-shell-to-url": "^0.1.0",

packages/compass-metrics/package.json

@@ -124,7 +124,7 @@
     "lodash.values": "^4.3.0",
     "lodash.zipobject": "^4.1.3",
     "mongodb-cloud-info": "^1.1.3",
-    "mongodb-connection-string-url": "^2.3.2"
+    "mongodb-connection-string-url": "^2.4.1"
   },
   "homepage": "https://github.com/mongodb-js/compass",
   "bugs": {

packages/connect-form/package.json

@@ -53,7 +53,7 @@
     "react-dom": "*"
   },
   "dependencies": {
-    "mongodb-connection-string-url": "^2.3.2",
+    "mongodb-connection-string-url": "^2.4.1",
     "react": "*",
     "react-dom": "*"
   },
@@ -78,6 +78,7 @@
     "gen-esm-wrapper": "^1.1.0",
     "mocha": "^8.4.0",
     "mongodb-data-service": "^21.14.0",
+    "mongodb": "^4.2.2",
     "nyc": "^15.1.0",
     "prettier": "2.3.2",
     "sinon": "^9.2.3",

packages/connect-form/src/components/advanced-options-tabs/general/direct-connection-input.tsx

@@ -1,6 +1,7 @@
 import React, { useCallback } from 'react';
 import { Checkbox, Description } from '@mongodb-js/compass-components';
 import ConnectionStringUrl from 'mongodb-connection-string-url';
+import type { MongoClientOptions } from 'mongodb';
 
 import { UpdateConnectionFormField } from '../../../hooks/use-connect-form';
 
@@ -12,7 +13,9 @@ function DirectConnectionInput({
   updateConnectionFormField: UpdateConnectionFormField;
 }): React.ReactElement {
   const isDirectConnection =
-    connectionStringUrl.searchParams.get('directConnection') === 'true';
+    connectionStringUrl
+      .typedSearchParams<MongoClientOptions>()
+      .get('directConnection') === 'true';
 
   const updateDirectConnection = useCallback(
     (event: React.ChangeEvent<HTMLInputElement>) => {

packages/connect-form/src/components/advanced-options-tabs/general/host-input.tsx

@@ -8,6 +8,7 @@ import {
   spacing,
 } from '@mongodb-js/compass-components';
 import ConnectionStringUrl from 'mongodb-connection-string-url';
+import type { MongoClientOptions } from 'mongodb';
 
 import { UpdateConnectionFormField } from '../../../hooks/use-connect-form';
 import { ConnectionFormError } from '../../../utils/connect-form-errors';
@@ -44,7 +45,9 @@ function HostInput({
   const { isSRV } = connectionStringUrl;
 
   const showDirectConnectionInput =
-    connectionStringUrl.searchParams.get('directConnection') === 'true' ||
+    connectionStringUrl
+      .typedSearchParams<MongoClientOptions>()
+      .get('directConnection') === 'true' ||
     (!connectionStringUrl.isSRV && hosts.length === 1);
 
   useEffect(() => {

packages/connect-form/src/hooks/use-connect-form.ts

@@ -1,6 +1,7 @@
 import { useEffect, useReducer } from 'react';
 import ConnectionStringUrl from 'mongodb-connection-string-url';
 import { ConnectionInfo, ConnectionOptions } from 'mongodb-data-service';
+import type { MongoClientOptions } from 'mongodb';
 
 import { defaultConnectionString } from '../constants/default-connection';
 import {
@@ -215,6 +216,8 @@ export function handleConnectionFormFieldUpdate({
   errors: ConnectionFormError[];
 } {
   const updatedConnectionStringUrl = connectionStringUrl.clone();
+  const updatedSearchParams =
+    updatedConnectionStringUrl.typedSearchParams<MongoClientOptions>();
 
   switch (action.type) {
     case 'add-new-host': {
@@ -229,8 +232,8 @@ export function handleConnectionFormFieldUpdate({
         0,
         newHost
       );
-      if (updatedConnectionStringUrl.searchParams.get('directConnection')) {
-        updatedConnectionStringUrl.searchParams.delete('directConnection');
+      if (updatedSearchParams.get('directConnection')) {
+        updatedSearchParams.delete('directConnection');
       }
 
       return {
@@ -275,11 +278,9 @@ export function handleConnectionFormFieldUpdate({
     case 'update-direct-connection': {
       const { isDirectConnection } = action;
       if (isDirectConnection) {
-        updatedConnectionStringUrl.searchParams.set('directConnection', 'true');
-      } else if (
-        updatedConnectionStringUrl.searchParams.get('directConnection')
-      ) {
-        updatedConnectionStringUrl.searchParams.delete('directConnection');
+        updatedSearchParams.set('directConnection', 'true');
+      } else if (updatedSearchParams.get('directConnection')) {
+        updatedSearchParams.delete('directConnection');
       }
 
       return {

packages/connect-form/src/utils/connection-string-schema.ts

@@ -1,4 +1,5 @@
 import ConnectionStringUrl from 'mongodb-connection-string-url';
+import type { MongoClientOptions } from 'mongodb';
 
 import { defaultHostname, defaultPort } from '../constants/default-connection';
 
@@ -10,11 +11,8 @@ function updateConnectionStringToStandard(
     return connectionStringUrl;
   }
 
-  const newConnectionString = connectionStringUrl.toString();
-
-  const newConnectionStringUrl = new ConnectionStringUrl(
-    newConnectionString.replace('mongodb+srv://', 'mongodb://')
-  );
+  const newConnectionStringUrl = connectionStringUrl.clone();
+  newConnectionStringUrl.protocol = 'mongodb:';
 
   newConnectionStringUrl.hosts = [
     `${newConnectionStringUrl.hosts[0]}:${defaultPort}`,
@@ -31,7 +29,7 @@ function updateConnectionStringToSRV(
     return connectionStringUrl;
   }
 
-  let newConnectionStringUrl = connectionStringUrl.clone();
+  const newConnectionStringUrl = connectionStringUrl.clone();
 
   // Only include one host without port.
   const newHost =
@@ -45,14 +43,13 @@ function updateConnectionStringToSRV(
       : defaultHostname;
   newConnectionStringUrl.hosts = [newHost];
 
-  const newConnectionString = newConnectionStringUrl.toString();
-  newConnectionStringUrl = new ConnectionStringUrl(
-    newConnectionString.replace('mongodb://', 'mongodb+srv://')
-  );
+  newConnectionStringUrl.protocol = 'mongodb+srv:';
+  const searchParams =
+    newConnectionStringUrl.typedSearchParams<MongoClientOptions>();
 
   // SRV connections can't have directConnection set.
-  if (newConnectionStringUrl.searchParams.get('directConnection')) {
-    newConnectionStringUrl.searchParams.delete('directConnection');
+  if (searchParams.get('directConnection')) {
+    searchParams.delete('directConnection');
   }
 
   return newConnectionStringUrl;

packages/connection-model/package.json

@@ -41,7 +41,7 @@
     "ampersand-rest-collection": "^6.0.0",
     "debug": "4.3.0",
     "lodash": "^4.17.15",
-    "mongodb-connection-string-url": "^2.3.2",
+    "mongodb-connection-string-url": "^2.4.1",
     "mongodb3": "npm:mongodb@^3.6.3",
     "raf": "^3.4.1",
     "resolve-mongodb-srv": "^1.1.1",

packages/connections/package.json

@@ -82,7 +82,7 @@
     "mocha": "^8.4.0",
     "mongodb-build-info": "^1.3.0",
     "mongodb-cloud-info": "^1.1.3",
-    "mongodb-connection-string-url": "^2.3.2",
+    "mongodb-connection-string-url": "^2.4.1",
     "mongodb-data-service": "^21.14.0",
     "nyc": "^15.1.0",
     "prettier": "2.3.2",

packages/data-service/package.json

@@ -64,7 +64,7 @@
     "get-port": "^5.1.1",
     "lodash": "^4.17.20",
     "mongodb-build-info": "^1.3.0",
-    "mongodb-connection-string-url": "^2.3.2",
+    "mongodb-connection-string-url": "^2.4.1",
     "mongodb-index-model": "^3.7.0",
     "mongodb-ns": "^2.2.0",
     "resolve-mongodb-srv": "^1.1.1",

packages/data-service/src/connect-mongo-client.ts

@@ -107,29 +107,30 @@ function connectionOptionsToMongoClientParams(
   connectionOptions: ConnectionOptions
 ): [string, MongoClientOptions] {
   const url = new ConnectionStringUrl(connectionOptions.connectionString);
+  const searchParams = url.typedSearchParams<MongoClientOptions>();
 
   const options: MongoClientOptions = {
     monitorCommands: true,
   };
 
   // adds directConnection=true unless is explicitly a replica set
-  const isLoadBalanced = url.searchParams.get('loadBalanced') === 'true';
+  const isLoadBalanced = searchParams.get('loadBalanced') === 'true';
   const isReplicaSet =
-    url.isSRV || url.hosts.length > 1 || url.searchParams.has('replicaSet');
-  const hasDirectConnection = url.searchParams.has('directConnection');
+    url.isSRV || url.hosts.length > 1 || searchParams.has('replicaSet');
+  const hasDirectConnection = searchParams.has('directConnection');
 
   if (!isReplicaSet && !isLoadBalanced && !hasDirectConnection) {
-    url.searchParams.set('directConnection', 'true');
+    searchParams.set('directConnection', 'true');
   }
 
   // See https://jira.mongodb.org/browse/NODE-3591
   if (
-    !url.searchParams.has('tlsCertificateFile') &&
-    url.searchParams.has('tlsCertificateKeyFile')
+    !searchParams.has('tlsCertificateFile') &&
+    searchParams.has('tlsCertificateKeyFile')
   ) {
-    url.searchParams.set(
+    searchParams.set(
       'tlsCertificateFile',
-      url.searchParams.get('tlsCertificateKeyFile') as string
+      searchParams.get('tlsCertificateKeyFile') as string
     );
   }