feat(NODE-5994)!: Remove metadata-related properties from public driver API (#4716)

Author: baileympearson

src/cmap/connect.ts

@@ -222,7 +222,7 @@ export async function prepareHandshakeDocument(
   const options = authContext.options;
   const compressors = options.compressors ? options.compressors : [];
   const { serverApi } = authContext.connection;
-  const clientMetadata: Document = await options.extendedMetadata;
+  const clientMetadata: Document = await options.metadata;
 
   const handshakeDoc: HandshakeDocument = {
     [serverApi?.version || options.loadBalanced === true ? 'hello' : LEGACY_HELLO_COMMAND]: 1,

src/cmap/connection.ts

@@ -140,9 +140,8 @@ export interface ConnectionOptions
   socketTimeoutMS?: number;
   /** @internal */
   cancellationToken?: CancellationToken;
-  metadata: ClientMetadata;
   /** @internal */
-  extendedMetadata: Promise<Document>;
+  metadata: Promise<ClientMetadata>;
   /** @internal */
   mongoLogger?: MongoLogger | undefined;
 }

src/cmap/connection_pool.ts

@@ -601,17 +601,17 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
   }
 
   private createConnection(callback: Callback<Connection>) {
-    // Note that metadata and extendedMetadata may have changed on the client but have
-    // been frozen here, so we pull the extendedMetadata promise always from the client
-    // no mattter what options were set at the construction of the pool.
+    // Note that metadata may have changed on the client but have
+    // been frozen here, so we pull the metadata promise always from the client
+    // no matter what options were set at the construction of the pool.
     const connectOptions: ConnectionOptions = {
       ...this.options,
       id: this.connectionCounter.next().value,
       generation: this.generation,
       cancellationToken: this.cancellationToken,
       mongoLogger: this.mongoLogger,
       authProviders: this.server.topology.client.s.authProviders,
-      extendedMetadata: this.server.topology.client.options.extendedMetadata
+      metadata: this.server.topology.client.options.metadata
     };
 
     this.pending++;

src/cmap/handshake/client_metadata.ts

@@ -27,8 +27,7 @@ export function isDriverInfoEqual(info1: DriverInfo, info2: DriverInfo): boolean
 }
 
 /**
- * @public
- * @deprecated This interface will be made internal in the next major release.
+ * @internal
  * @see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command
  */
 export interface ClientMetadata {
@@ -48,11 +47,14 @@ export interface ClientMetadata {
   };
   /** FaaS environment information */
   env?: {
-    name: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
+    name?: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
     timeout_sec?: Int32;
     memory_mb?: Int32;
     region?: string;
-    url?: string;
+    container?: {
+      runtime?: string;
+      orchestrator?: string;
+    };
   };
 }
 
@@ -103,10 +105,10 @@ type MakeClientMetadataOptions = Pick<MongoOptions, 'appName'>;
  * 3. Omit the `env` document entirely.
  * 4. Truncate `platform`. -- special we do not truncate this field
  */
-export function makeClientMetadata(
+export async function makeClientMetadata(
   driverInfoList: DriverInfo[],
   { appName = '' }: MakeClientMetadataOptions
-): ClientMetadata {
+): Promise<ClientMetadata> {
   const metadataDocument = new LimitedSizeDocument(512);
 
   // Add app name first, it must be sent
@@ -178,19 +180,21 @@ export function makeClientMetadata(
       }
     }
   }
-  return metadataDocument.toObject() as ClientMetadata;
+  return await addContainerMetadata(metadataDocument.toObject() as ClientMetadata);
 }
 
 let dockerPromise: Promise<boolean>;
+type ContainerMetadata = NonNullable<NonNullable<ClientMetadata['env']>['container']>;
 /** @internal */
-async function getContainerMetadata() {
-  const containerMetadata: Record<string, any> = {};
+async function getContainerMetadata(): Promise<ContainerMetadata> {
   dockerPromise ??= fileIsAccessible('/.dockerenv');
   const isDocker = await dockerPromise;
 
   const { KUBERNETES_SERVICE_HOST = '' } = process.env;
   const isKubernetes = KUBERNETES_SERVICE_HOST.length > 0 ? true : false;
 
+  const containerMetadata: ContainerMetadata = {};
+
   if (isDocker) containerMetadata.runtime = 'docker';
   if (isKubernetes) containerMetadata.orchestrator = 'kubernetes';
 
@@ -202,15 +206,16 @@ async function getContainerMetadata() {
  * Re-add each metadata value.
  * Attempt to add new env container metadata, but keep old data if it does not fit.
  */
-export async function addContainerMetadata(
-  originalMetadata: ClientMetadata
-): Promise<ClientMetadata> {
+async function addContainerMetadata(originalMetadata: ClientMetadata): Promise<ClientMetadata> {
   const containerMetadata = await getContainerMetadata();
   if (Object.keys(containerMetadata).length === 0) return originalMetadata;
 
   const extendedMetadata = new LimitedSizeDocument(512);
 
-  const extendedEnvMetadata = { ...originalMetadata?.env, container: containerMetadata };
+  const extendedEnvMetadata: NonNullable<ClientMetadata['env']> = {
+    ...originalMetadata?.env,
+    container: containerMetadata
+  };
 
   for (const [key, val] of Object.entries(originalMetadata)) {
     if (key !== 'env') {

src/mongo_client.ts

@@ -16,7 +16,6 @@ import { AuthMechanism } from './cmap/auth/providers';
 import type { LEGAL_TCP_SOCKET_OPTIONS, LEGAL_TLS_SOCKET_OPTIONS } from './cmap/connect';
 import type { Connection } from './cmap/connection';
 import {
-  addContainerMetadata,
   type ClientMetadata,
   isDriverInfoEqual,
   makeClientMetadata
@@ -407,31 +406,12 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * The consolidate, parsed, transformed and merged options.
    */
   public readonly options: Readonly<
-    Omit<
-      MongoOptions,
-      | 'monitorCommands'
-      | 'ca'
-      | 'crl'
-      | 'key'
-      | 'cert'
-      | 'driverInfo'
-      | 'additionalDriverInfo'
-      | 'metadata'
-      | 'extendedMetadata'
-    >
+    Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'>
   > &
-    Pick<
-      MongoOptions,
-      | 'monitorCommands'
-      | 'ca'
-      | 'crl'
-      | 'key'
-      | 'cert'
-      | 'driverInfo'
-      | 'additionalDriverInfo'
-      | 'metadata'
-      | 'extendedMetadata'
-    >;
+    Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'> & {
+      /** @internal */
+      metadata: Promise<ClientMetadata>;
+    };
 
   private driverInfoList: DriverInfo[] = [];
 
@@ -502,10 +482,9 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     if (isDuplicateDriverInfo) return;
 
     this.driverInfoList.push(driverInfo);
-    this.options.metadata = makeClientMetadata(this.driverInfoList, this.options);
-    this.options.extendedMetadata = addContainerMetadata(this.options.metadata)
+    this.options.metadata = makeClientMetadata(this.driverInfoList, this.options)
       .then(undefined, squashError)
-      .then(result => result ?? {}); // ensure Promise<Document>
+      .then(result => result ?? ({} as ClientMetadata)); // ensure Promise<Document>
   }
 
   /** @internal */
@@ -1099,12 +1078,8 @@ export interface MongoOptions
   compressors: CompressorName[];
   writeConcern: WriteConcern;
   dbName: string;
-  /** @deprecated - Will be made internal in a future major release. */
-  metadata: ClientMetadata;
-  /** @deprecated - Will be made internal in a future major release. */
-  extendedMetadata: Promise<Document>;
-  /** @deprecated - Will be made internal in a future major release. */
-  additionalDriverInfo: DriverInfo[];
+  /** @internal */
+  metadata: Promise<ClientMetadata>;
   /** @internal */
   autoEncrypter?: AutoEncrypter;
   /** @internal */

src/sdam/topology.ts

@@ -150,8 +150,7 @@ export interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
   /** Indicates that a client should directly connect to a node without attempting to discover its topology type */
   directConnection: boolean;
   loadBalanced: boolean;
-  metadata: ClientMetadata;
-  extendedMetadata: Promise<Document>;
+  metadata: Promise<ClientMetadata>;
   serverMonitoringMode: ServerMonitoringMode;
   /** MongoDB server API version */
   serverApi?: ServerApi;
@@ -750,10 +749,6 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
     if (typeof callback === 'function') callback(undefined, true);
   }
 
-  get clientMetadata(): ClientMetadata {
-    return this.s.options.metadata;
-  }
-
   isConnected(): boolean {
     return this.s.state === STATE_CONNECTED;
   }

test/integration/connection-monitoring-and-pooling/connection.test.ts

@@ -15,10 +15,7 @@ import {
 } from '../../../src';
 import { connect } from '../../../src/cmap/connect';
 import { Connection } from '../../../src/cmap/connection';
-import {
-  addContainerMetadata,
-  makeClientMetadata
-} from '../../../src/cmap/handshake/client_metadata';
+import { makeClientMetadata } from '../../../src/cmap/handshake/client_metadata';
 import { MongoDBResponse } from '../../../src/cmap/wire_protocol/responses';
 import { LEGACY_HELLO_COMMAND } from '../../../src/constants';
 import { Topology } from '../../../src/sdam/topology';
@@ -51,8 +48,7 @@ describe('Connection', function () {
           ...commonConnectOptions,
           connectionType: Connection,
           ...this.configuration.options,
-          metadata: makeClientMetadata([], {}),
-          extendedMetadata: addContainerMetadata(makeClientMetadata([], {}))
+          metadata: makeClientMetadata([], {})
         };
 
         let conn;
@@ -74,8 +70,7 @@ describe('Connection', function () {
           connectionType: Connection,
           ...this.configuration.options,
           monitorCommands: true,
-          metadata: makeClientMetadata([], {}),
-          extendedMetadata: addContainerMetadata(makeClientMetadata([], {}))
+          metadata: makeClientMetadata([], {})
         };
 
         let conn;
@@ -106,8 +101,7 @@ describe('Connection', function () {
           connectionType: Connection,
           ...this.configuration.options,
           monitorCommands: true,
-          metadata: makeClientMetadata([], {}),
-          extendedMetadata: addContainerMetadata(makeClientMetadata([], {}))
+          metadata: makeClientMetadata([], {})
         };
 
         let conn;

test/integration/mongodb-handshake/mongodb-handshake.prose.test.ts

@@ -149,8 +149,8 @@ describe('Handshake Prose Tests', function () {
     it('includes both container and FAAS provider information in the client metadata', async function () {
       client = this.configuration.newClient();
       await client.connect();
-      expect(client.topology?.s.options.extendedMetadata).to.exist;
-      const { env } = await client.topology.s.options.extendedMetadata;
+      expect(client.topology?.s.options.metadata).to.exist;
+      const { env } = await client.topology.s.options.metadata;
 
       expect(env).to.deep.equal({
         region: 'us-east-2',