chore(service-provider-node-driver): reduce reliance on driver internals MONGOSH-2620 (#2526)

Author: addaleax

packages/browser-repl/src/sandbox.tsx

@@ -106,12 +106,10 @@ class DemoServiceProvider {
     };
   }
 
-  getTopology(): object {
+  getTopologyDescription(): object {
     return {
-      description: {
-        type: 'ReplicaSetWithPrimary',
-        setName: 'replset',
-      },
+      type: 'ReplicaSetWithPrimary',
+      setName: 'replset',
     };
   }
 

packages/java-shell/src/main/kotlin/com/mongodb/mongosh/service/JavaServiceProvider.kt

@@ -443,7 +443,7 @@ internal class JavaServiceProvider(private var client: MongoClient?,
     }
 
     @HostAccess.Export
-    override fun getTopology(): Value = promise<Any?> {
+    override fun getTopologyDescription(): Value = promise<Any?> {
         Left(NotImplementedError())
     }
 

packages/java-shell/src/main/kotlin/com/mongodb/mongosh/service/ReadableServiceProvider.kt

@@ -13,7 +13,7 @@ internal interface ReadableServiceProvider {
     fun distinct(database: String, collection: String, fieldName: String, filter: Value?, options: Value?): Value
     fun estimatedDocumentCount(database: String, collection: String, options: Value?): Value
     fun find(database: String, collection: String, filter: Value?, options: Value?): Cursor
-    fun getTopology(): Value
+    fun getTopologyDescription(): Value
     fun getIndexes(database: String, collection: String, options: Value?): Value
     fun listCollections(database: String, filter: Value?, options: Value?): Value
 }

packages/service-provider-core/src/all-transport-types.ts

@@ -71,7 +71,6 @@ export type {
   ObjectId as ObjectIdType,
   Timestamp as TimestampType,
   Binary as BinaryType,
-  TopologyDescription,
   TopologyType,
   ServerType,
   AutoEncryptionOptions,

packages/service-provider-core/src/index.ts

@@ -10,6 +10,8 @@ export * from './all-fle-types';
 
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
 
+export { TopologyDescription, ServerDescription } from './readable';
+
 export {
   CreateEncryptedCollectionOptions,
   CheckMetadataConsistencyOptions,

packages/service-provider-core/src/readable.ts

@@ -11,6 +11,8 @@ import type {
   DbOptions,
   ReadPreferenceFromOptions,
   ReadPreferenceLike,
+  TopologyType,
+  ServerType,
 } from './all-transport-types';
 import type { ChangeStreamOptions } from './all-transport-types';
 import type {
@@ -19,6 +21,17 @@ import type {
   ServiceProviderFindCursor,
 } from './cursors';
 
+// These are trimmed-down versions of the MongoDB driver types
+export interface ServerDescription {
+  type?: ServerType;
+  setName?: string | null;
+}
+export interface TopologyDescription {
+  type?: TopologyType;
+  setName?: string | null;
+  servers?: Map<string, ServerDescription>;
+}
+
 /**
  * Interface for read operations in the CRUD specification.
  */
@@ -160,7 +173,7 @@ export default interface Readable {
   /**
    * Get currently known topology information.
    */
-  getTopology(): any;
+  getTopologyDescription(): TopologyDescription | undefined;
 
   /**
    * Returns an array that holds a list of documents that identify and

packages/service-provider-node-driver/src/compass/compass-service-provider.ts

@@ -1,6 +1,6 @@
 import type { DevtoolsConnectOptions } from '../node-driver-service-provider';
 import { NodeDriverServiceProvider } from '../node-driver-service-provider';
-import type { MongoClient } from 'mongodb';
+import type { MongoClient, TopologyDescription } from 'mongodb';
 import type { ReplPlatform } from '@mongosh/service-provider-core';
 import type ConnectionString from 'mongodb-connection-string-url';
 import type { EventEmitter } from 'events';
@@ -22,9 +22,10 @@ export class CompassServiceProvider extends NodeDriverServiceProvider {
     mongoClient: MongoClient,
     bus: EventEmitter,
     driverOptions: DevtoolsConnectOptions,
-    uri?: ConnectionString
+    uri?: ConnectionString,
+    lastSeenTopology?: TopologyDescription
   ) {
-    super(mongoClient, bus, driverOptions, uri);
+    super(mongoClient, bus, driverOptions, uri, lastSeenTopology);
     this.platform = 'Compass';
   }
 }

packages/service-provider-node-driver/src/node-driver-provider.integration.spec.ts

@@ -807,12 +807,6 @@ describe('NodeDriverServiceProvider [integration]', function () {
     });
   });
 
-  describe('#driverMetadata', function () {
-    it('returns information about the driver instance', function () {
-      expect(serviceProvider.driverMetadata?.driver.name).to.equal('nodejs');
-    });
-  });
-
   describe('#getURI', function () {
     it('returns the current URI', function () {
       expect(serviceProvider.getURI()).to.equal(connectionString);

packages/service-provider-node-driver/src/node-driver-service-provider.ts

@@ -1,7 +1,6 @@
 import type {
   Auth,
   AuthMechanism,
-  ClientMetadata,
   ReadPreferenceFromOptions,
   ReadPreferenceLike,
   OperationOptions,
@@ -242,18 +241,6 @@ export class NodeDriverServiceProvider
     let state: DevtoolsConnectionState | undefined;
     let lastSeenTopology: TopologyDescription | undefined;
 
-    class MongoshMongoClient extends MongoClientCtor {
-      constructor(url: string, options?: MongoClientOptions) {
-        super(url, options);
-        this.on(
-          'topologyDescriptionChanged',
-          (evt: TopologyDescriptionChangedEvent) => {
-            lastSeenTopology = evt.newDescription;
-          }
-        );
-      }
-    }
-
     if (cliOptions.nodb) {
       const clientOptionsCopy: MongoClientOptions &
         Partial<DevtoolsConnectOptions> = {
@@ -266,16 +253,15 @@ export class NodeDriverServiceProvider
       delete clientOptionsCopy.parentState;
       delete clientOptionsCopy.proxy;
       delete clientOptionsCopy.applyProxyToOIDC;
-      client = new MongoshMongoClient(
+      client = new MongoClientCtor(
         connectionString.toString(),
         clientOptionsCopy
       );
     } else {
-      ({ client, state } = await connectMongoClient(
+      ({ client, state, lastSeenTopology } = await this.connectMongoClient(
         connectionString.toString(),
         clientOptions,
-        bus,
-        MongoshMongoClient
+        bus
       ));
     }
     clientOptions.parentState = state;
@@ -299,13 +285,13 @@ export class NodeDriverServiceProvider
   private bus: MongoshBus;
 
   /**
-   * Stores the last seen topology at the time when .connect() finishes.
+   * Stores the last known topology for the MongoClient instance.
    */
   private _lastSeenTopology: TopologyDescription | undefined;
 
   /**
    * Instantiate a new NodeDriverServiceProvider with the Node driver's connected
-   * MongoClient instance.
+   * MongoClient instance. Do not call this directly, it is only public for testing.
    *
    * @param {MongoClient} mongoClient - The Node drivers' MongoClient instance.
    * @param {DevtoolsConnectOptions} clientOptions
@@ -326,13 +312,20 @@ export class NodeDriverServiceProvider
     this._lastSeenTopology = lastSeenTopology;
     this.platform = 'CLI';
     try {
-      this.initialDb = (mongoClient as any).s.options.dbName || DEFAULT_DB;
+      this.initialDb = mongoClient.options.dbName || DEFAULT_DB;
     } catch (err: any) {
       this.initialDb = DEFAULT_DB;
     }
     this.currentClientOptions = clientOptions;
     this.baseCmdOptions = { ...DEFAULT_BASE_OPTIONS }; // currently do not have any user-specified connection-wide command options, but I imagine we will eventually
     this.dbcache = new WeakMap();
+
+    this.mongoClient.on?.(
+      'topologyDescriptionChanged',
+      (evt: TopologyDescriptionChangedEvent) => {
+        this._lastSeenTopology = evt.newDescription;
+      }
+    );
   }
 
   static getVersionInformation(): DependencyVersionInfo {
@@ -355,7 +348,7 @@ export class NodeDriverServiceProvider
     };
   }
 
-  maybeThrowBetterMissingOptionalDependencyError(
+  static maybeThrowBetterMissingOptionalDependencyError(
     err: MongoMissingDependencyError
   ): never {
     if (err.message.includes('kerberos')) {
@@ -401,17 +394,37 @@ export class NodeDriverServiceProvider
     throw err;
   }
 
-  async connectMongoClient(
+  private static async connectMongoClient(
     connectionString: ConnectionString | string,
-    clientOptions: DevtoolsConnectOptions
-  ): Promise<{ client: MongoClient; state: DevtoolsConnectionState }> {
+    clientOptions: DevtoolsConnectOptions,
+    bus: MongoshBus
+  ): Promise<{
+    client: MongoClient;
+    state: DevtoolsConnectionState;
+    lastSeenTopology: TopologyDescription | undefined;
+  }> {
+    let lastSeenTopology: TopologyDescription | undefined;
+
+    class MongoshMongoClient extends MongoClientCtor {
+      constructor(url: string, options?: MongoClientOptions) {
+        super(url, options);
+        this.on(
+          'topologyDescriptionChanged',
+          (evt: TopologyDescriptionChangedEvent) => {
+            lastSeenTopology = evt.newDescription;
+          }
+        );
+      }
+    }
+
     try {
-      return await connectMongoClient(
+      const result = await connectMongoClient(
         connectionString.toString(),
         clientOptions,
-        this.bus,
-        MongoClientCtor
+        bus,
+        MongoshMongoClient
       );
+      return { ...result, lastSeenTopology };
     } catch (err: unknown) {
       if (
         typeof err === 'object' &&
@@ -434,17 +447,19 @@ export class NodeDriverServiceProvider
     const connectionString = new ConnectionString(uri);
     const clientOptions = this.processDriverOptions(connectionString, options);
 
-    const { client, state } = await this.connectMongoClient(
-      connectionString.toString(),
-      clientOptions
-    );
+    const { client, state, lastSeenTopology } =
+      await NodeDriverServiceProvider.connectMongoClient(
+        connectionString.toString(),
+        clientOptions,
+        this.bus
+      );
     clientOptions.parentState = state;
     return new NodeDriverServiceProvider(
       client,
       this.bus,
       clientOptions,
       connectionString,
-      this._lastSeenTopology
+      lastSeenTopology ?? this._lastSeenTopology
     );
   }
 
@@ -1152,8 +1167,8 @@ export class NodeDriverServiceProvider
   /**
    * Get currently known topology information.
    */
-  getTopology(): any | undefined {
-    return (this.mongoClient as any).topology;
+  getTopologyDescription(): TopologyDescription | undefined {
+    return this._lastSeenTopology;
   }
 
   /**
@@ -1365,16 +1380,19 @@ export class NodeDriverServiceProvider
       this.uri as ConnectionString,
       this.currentClientOptions
     );
-    const { client, state } = await this.connectMongoClient(
-      (this.uri as ConnectionString).toString(),
-      clientOptions
-    );
+    const { client, state, lastSeenTopology } =
+      await NodeDriverServiceProvider.connectMongoClient(
+        (this.uri as ConnectionString).toString(),
+        clientOptions,
+        this.bus
+      );
     try {
       await this.mongoClient.close();
       // eslint-disable-next-line no-empty
     } catch {}
     this.mongoClient = client;
     this.currentClientOptions.parentState = state;
+    if (lastSeenTopology) this._lastSeenTopology = lastSeenTopology;
   }
 
   startSession(options: ClientSessionOptions): ClientSession {
@@ -1389,25 +1407,17 @@ export class NodeDriverServiceProvider
     coll?: string
   ): ChangeStream<Document> {
     if (db === undefined && coll === undefined) {
-      // TODO: watch not exported, see NODE-2934
-      return (this.mongoClient as any).watch(pipeline, options);
+      return this.mongoClient.watch(pipeline, options);
     } else if (db !== undefined && coll === undefined) {
-      return (this.db(db, dbOptions) as any).watch(pipeline, options);
+      return this.db(db, dbOptions).watch(pipeline, options);
     } else if (db !== undefined && coll !== undefined) {
-      return (this.db(db, dbOptions).collection(coll) as any).watch(
-        pipeline,
-        options
-      );
+      return this.db(db, dbOptions).collection(coll).watch(pipeline, options);
     }
     throw new MongoshInternalError(
       'Cannot call watch with defined collection but undefined db'
     );
   }
 
-  get driverMetadata(): ClientMetadata | undefined {
-    return this.getTopology()?.clientMetadata;
-  }
-
   getRawClient(): MongoClient {
     return this.mongoClient;
   }

packages/shell-api/src/integration.spec.ts

@@ -2568,11 +2568,11 @@ describe('Shell API (integration)', function () {
       it('reconnects', async function () {
         const oldMC = serviceProvider.mongoClient;
         expect(
-          (serviceProvider.mongoClient as any).s.options.readPreference.mode
+          serviceProvider.mongoClient.options.readPreference.mode
         ).to.deep.equal('primary');
         await mongo.setReadPref('secondaryPreferred');
         expect(
-          (serviceProvider.mongoClient as any).s.options.readPreference.mode
+          serviceProvider.mongoClient.options.readPreference.mode
         ).to.equal('secondaryPreferred');
         expect(serviceProvider.mongoClient).to.not.equal(oldMC);
       });