feat: update mongosh to 2.0.0 and driver to 6.0.0 VSCODE-453 (#592)

Author: addaleax

.depcheckrc

@@ -23,3 +23,4 @@ ignores:
  - postcss-loader
  - style-loader
  - ts-loader
+ - mongodb-runner

package-lock.json

@@ -47,11 +47,11 @@
     "watch": "npm run compile && npm-run-all -p watch:*",
     "watch:extension": "npm run compile:extension -- -watch",
     "watch:extension-bundles": "webpack --mode development --watch",
-    "pretest": "npm run compile && mongodb-runner start --port=27018",
+    "pretest": "npm run compile && mongodb-runner start --id=vscode -- --port 27018",
     "test": "npm run test-webview && npm run test-extension",
     "test-extension": "cross-env NODE_OPTIONS=--no-force-async-hooks-checks xvfb-maybe node ./out/test/runTest.js",
     "test-webview": "jest",
-    "posttest": "mongodb-runner stop --port=27018",
+    "posttest": "mongodb-runner stop --id=vscode",
     "analyze-bundle": "webpack --mode production --analyze",
     "vscode:prepublish": "npm run clean && npm run compile:keyfile && npm run compile:resources && webpack --mode production",
     "check": "npm run lint && npm run depcheck",
@@ -980,24 +980,25 @@
     "@iconify-icons/codicon": "^1.2.25",
     "@iconify/react": "^1.1.4",
     "@leafygreen-ui/logo": "^8.0.4",
-    "@mongodb-js/mongodb-constants": "^0.6.5",
-    "@mongosh/browser-runtime-electron": "^1.10.4",
-    "@mongosh/i18n": "^1.10.4",
-    "@mongosh/service-provider-server": "^1.10.4",
-    "@mongosh/shell-api": "^1.10.4",
+    "@mongodb-js/mongodb-constants": "^0.7.0",
+    "@mongosh/browser-runtime-electron": "^2.0.0",
+    "@mongosh/i18n": "^2.0.0",
+    "@mongosh/service-provider-server": "^2.0.0",
+    "@mongosh/shell-api": "^2.0.0",
     "analytics-node": "^6.2.0",
     "bson": "^5.3.0",
     "bson-transpilers": "^2.0.4",
     "classnames": "^2.3.2",
     "debug": "^4.3.4",
     "dotenv": "^16.3.1",
     "micromatch": "^4.0.5",
-    "mongodb": "^5.8.1",
-    "mongodb-build-info": "^1.5.0",
+    "mongodb": "^6.0.0",
+    "mongodb-build-info": "^1.6.2",
     "mongodb-cloud-info": "^2.1.0",
     "mongodb-connection-string-url": "^2.6.0",
-    "mongodb-data-service": "^22.8.0",
-    "mongodb-query-parser": "^2.5.0",
+    "mongodb-data-service": "^22.10.0",
+    "mongodb-data-service-legacy": "npm:[email protected]",
+    "mongodb-query-parser": "^3.1.3",
     "mongodb-schema": "^11.2.2",
     "numeral": "^2.0.6",
     "react": "^17.0.2",
@@ -1012,10 +1013,10 @@
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.22.5",
-    "@mongodb-js/oidc-plugin": "^0.2.4",
+    "@mongodb-js/oidc-plugin": "^0.3.0",
     "@mongodb-js/prettier-config-compass": "^1.0.0",
     "@mongodb-js/sbom-tools": "^0.5.4",
-    "@mongosh/service-provider-core": "^1.10.4",
+    "@mongosh/service-provider-core": "^2.0.0",
     "@types/analytics-node": "^3.1.11",
     "@types/babel__core": "^7.20.1",
     "@types/babel__traverse": "^7.20.1",
@@ -1064,8 +1065,8 @@
     "mocha": "^8.4.0",
     "mocha-junit-reporter": "^2.2.0",
     "mocha-multi": "^1.1.7",
-    "mongodb-client-encryption": "^2.8.0",
-    "mongodb-runner": "^4.10.0",
+    "mongodb-client-encryption": "^6.0.0",
+    "mongodb-runner": "^5.4.4",
     "node-loader": "^0.6.0",
     "npm-run-all": "^4.1.5",
     "ora": "^5.4.1",
@@ -1089,6 +1090,11 @@
     "xvfb-maybe": "^0.2.1",
     "yargs-parser": "^20.2.9"
   },
+  "overrides": {
+    "mongodb-connection-model": {
+      "@mongodb-js/compass-utils": "0.3.4"
+    }
+  },
   "precommit": [
     "check"
   ]

package.json

@@ -1,15 +1,8 @@
 import * as vscode from 'vscode';
-import {
-  convertConnectionModelToInfo,
-  getConnectionTitle,
-  extractSecrets,
-  mergeSecrets,
-  connect,
-} from 'mongodb-data-service';
+import { connect } from 'mongodb-data-service';
 import type {
   DataService,
-  ConnectionInfo,
-  ConnectionOptions,
+  ConnectionOptions as ConnectionOptionsFromCurrentDS,
 } from 'mongodb-data-service';
 import ConnectionString from 'mongodb-connection-string-url';
 import { EventEmitter } from 'events';
@@ -31,6 +24,24 @@ import { StorageVariables } from './storage';
 import type { StatusView } from './views';
 import type TelemetryService from './telemetry/telemetryService';
 import LINKS from './utils/links';
+import type {
+  ConnectionInfo as ConnectionInfoFromLegacyDS,
+  ConnectionOptions as ConnectionOptionsFromLegacyDS,
+} from 'mongodb-data-service-legacy';
+import {
+  getConnectionTitle,
+  extractSecrets,
+  mergeSecrets,
+  convertConnectionModelToInfo,
+} from 'mongodb-data-service-legacy';
+
+export function launderConnectionOptionTypeFromLegacyToCurrent(
+  opts: ConnectionOptionsFromLegacyDS
+): ConnectionOptionsFromCurrentDS {
+  // Ensure that, at most, the types for OIDC mismatch here.
+  return opts as Omit<typeof opts, 'oidc'>;
+}
+
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageJSON = require('../package.json');
 
@@ -54,7 +65,7 @@ export interface StoreConnectionInfo {
   name: string; // Possibly user given name, not unique.
   storageLocation: StorageLocation;
   secretStorageLocation?: SecretStorageLocationType;
-  connectionOptions?: ConnectionOptions;
+  connectionOptions?: ConnectionOptionsFromLegacyDS;
   connectionModel?: LegacyConnectionModel;
 }
 
@@ -471,7 +482,7 @@ export default class ConnectionController {
 
   parseNewConnection(
     rawConnectionModel: LegacyConnectionModel
-  ): ConnectionInfo {
+  ): ConnectionInfoFromLegacyDS {
     return convertConnectionModelToInfo({
       ...rawConnectionModel,
       appname: `${packageJSON.name} ${packageJSON.version}`, // Override the default connection appname.
@@ -483,7 +494,7 @@ export default class ConnectionController {
   ): Promise<MigratedStoreConnectionInfoWithConnectionOptions> {
     // We don't want to store secrets to disc.
     const { connectionInfo: safeConnectionInfo, secrets } = extractSecrets(
-      newStoreConnectionInfoWithSecrets as ConnectionInfo
+      newStoreConnectionInfoWithSecrets as ConnectionInfoFromLegacyDS
     );
     const savedConnectionInfo = await this._storageController.saveConnection({
       ...newStoreConnectionInfoWithSecrets,
@@ -498,7 +509,7 @@ export default class ConnectionController {
   }
 
   async saveNewConnectionFromFormAndConnect(
-    originalConnectionInfo: ConnectionInfo,
+    originalConnectionInfo: ConnectionInfoFromLegacyDS,
     connectionType: ConnectionTypes
   ): Promise<ConnectionAttemptResult> {
     const name = getConnectionTitle(originalConnectionInfo);
@@ -526,9 +537,12 @@ export default class ConnectionController {
     return this._connect(savedConnectionInfo.id, connectionType);
   }
 
-  async _connectWithDataService(connectionOptions: ConnectionOptions) {
+  async _connectWithDataService(
+    connectionOptions: ConnectionOptionsFromLegacyDS
+  ) {
     return connect({
-      connectionOptions,
+      connectionOptions:
+        launderConnectionOptionTypeFromLegacyToCurrent(connectionOptions),
       productName: packageJSON.name,
       productDocsLink: LINKS.extensionDocs(),
     });

src/connectionController.ts

@@ -352,17 +352,19 @@ export default class MongoDBService {
     }
 
     try {
-      const documents = this._serviceProvider.find(
-        databaseName,
-        collectionName,
-        {},
-        // TODO: figure out if we need parseSchema for one field at all.
-        // For one document we can simply get deep object keys,
-        // or we could analyze the schema for at least 5-10 documents.
-        // The current behaviour came from Compass when we do the same:
-        // https://github.com/mongodb-js/compass/blob/main/packages/compass-field-store/src/stores/store.js#L193
-        { limit: 1 }
-      );
+      const documents = await this._serviceProvider
+        .find(
+          databaseName,
+          collectionName,
+          {},
+          // TODO: figure out if we need parseSchema for one field at all.
+          // For one document we can simply get deep object keys,
+          // or we could analyze the schema for at least 5-10 documents.
+          // The current behaviour came from Compass when we do the same:
+          // https://github.com/mongodb-js/compass/blob/main/packages/compass-field-store/src/stores/store.js#L193
+          { limit: 1 }
+        )
+        .toArray();
 
       const schema = await parseSchema(documents);
       result = schema?.fields ? schema.fields.map((item) => item.name) : [];

src/language/mongoDBService.ts

@@ -10,6 +10,7 @@ import AUTH_STRATEGY_VALUES from '../../views/webview-app/connection-model/const
 import ConnectionController, {
   DataServiceEventTypes,
   keytarMigrationFailedMessage,
+  launderConnectionOptionTypeFromLegacyToCurrent,
 } from '../../connectionController';
 import formatError from '../../utils/formatError';
 import { StorageController, StorageVariables } from '../../storage';
@@ -836,7 +837,8 @@ suite('Connection Controller Test Suite', function () {
         await sleep(50);
 
         return connect({
-          connectionOptions,
+          connectionOptions:
+            launderConnectionOptionTypeFromLegacyToCurrent(connectionOptions),
         });
       }
     );
@@ -1199,9 +1201,7 @@ suite('Connection Controller Test Suite', function () {
         monitorCommands: true,
         useSystemCA: undefined,
         authMechanismProperties: {},
-        oidc: {
-          allowedFlows: ['auth-code'],
-        },
+        oidc: {},
         productDocsLink:
           'https://docs.mongodb.com/mongodb-vscode/?utm_source=vscode&utm_medium=product',
         productName: 'mongodb-vscode',

src/test/suite/connectionController.test.ts

@@ -1935,6 +1935,15 @@
             }
           }
         },
+        {
+          "name": "meta.object.member.mongodb",
+          "match": "\\$vectorSearch\\b",
+          "captures": {
+            "0": {
+              "name": "keyword.other.$vectorSearch.mongodb"
+            }
+          }
+        },
         {
           "name": "meta.object.member.mongodb",
           "match": "\\$set\\b",