EOD commit

Author: aditi-khare-mongoDB

src/cmap/connect.ts

@@ -25,7 +25,7 @@ import {
   type ConnectionOptions,
   CryptoConnection
 } from './connection';
-import type { ClientMetadata } from './handshake/client_metadata';
+import { type ClientMetadata, addAllEnvClientMetadata } from './handshake/client_metadata';
 import {
   MAX_SUPPORTED_SERVER_VERSION,
   MAX_SUPPORTED_WIRE_VERSION,
@@ -200,11 +200,11 @@ export async function prepareHandshakeDocument(
   const options = authContext.options;
   const compressors = options.compressors ? options.compressors : [];
   const { serverApi } = authContext.connection;
-
+  const clientMetadata = await addAllEnvClientMetadata(options.internalMetadata);
   const handshakeDoc: HandshakeDocument = {
     [serverApi?.version || options.loadBalanced === true ? 'hello' : LEGACY_HELLO_COMMAND]: 1,
     helloOk: true,
-    client: options.metadata,
+    client: clientMetadata.toObject(),
     compression: compressors
   };
 

src/cmap/connection.ts

@@ -57,7 +57,7 @@ import {
   type WriteProtocolMessageType
 } from './commands';
 import type { Stream } from './connect';
-import type { ClientMetadata } from './handshake/client_metadata';
+import type { ClientMetadata, LimitedSizeDocument } from './handshake/client_metadata';
 import { StreamDescription, type StreamDescriptionOptions } from './stream_description';
 import { type CompressorName, decompressResponse } from './wire_protocol/compression';
 import { onData } from './wire_protocol/on_data';
@@ -118,6 +118,8 @@ export interface ConnectionOptions
   socketTimeoutMS?: number;
   cancellationToken?: CancellationToken;
   metadata: ClientMetadata;
+   /** @internal */
+   internalMetadata: LimitedSizeDocument;
   /** @internal */
   mongoLogger?: MongoLogger | undefined;
 }

src/cmap/connection_pool.ts

@@ -234,7 +234,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
       waitQueueTimeoutMS: options.waitQueueTimeoutMS ?? 0,
       minPoolSizeCheckFrequencyMS: options.minPoolSizeCheckFrequencyMS ?? 100,
       autoEncrypter: options.autoEncrypter,
-      metadata: options.metadata
+      metadata: options.metadata,
     });
 
     if (this.options.minPoolSize > this.options.maxPoolSize) {
@@ -634,7 +634,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
       generation: this[kGeneration],
       cancellationToken: this[kCancellationToken],
       mongoLogger: this.mongoLogger,
-      authProviders: this[kServer].topology.client.s.authProviders
+      authProviders: this[kServer].topology.client.s.authProviders,
     };
 
     this[kPending]++;

src/cmap/handshake/client_metadata.ts

@@ -1,3 +1,4 @@
+import { promises as fs } from 'fs';
 import * as os from 'os';
 import * as process from 'process';
 
@@ -91,8 +92,14 @@ type MakeClientMetadataOptions = Pick<MongoOptions, 'appName' | 'driverInfo'>;
  * 4. Truncate `platform`. -- special we do not truncate this field
  */
 export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMetadata {
-  const metadataDocument = new LimitedSizeDocument(512);
+  let metadataDocument = new LimitedSizeDocument(512);
+  metadataDocument = addNonEnvClientMetadata(options, metadataDocument);
+  metadataDocument = addFAASOnlyEnvClientMetadata(metadataDocument);
+  return metadataDocument.toObject();
+}
+
 
+export function addNonEnvClientMetadata(options: MakeClientMetadataOptions, metadataDocument: LimitedSizeDocument): LimitedSizeDocument {
   const { appName = '' } = options;
   // Add app name first, it must be sent
   if (appName.length > 0) {
@@ -142,6 +149,10 @@ export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMe
     }
   }
 
+  return metadataDocument;
+}
+
+function addFAASOnlyEnvClientMetadata(metadataDocument: LimitedSizeDocument): LimitedSizeDocument {
   const faasEnv = getFAASEnv();
   if (faasEnv != null) {
     if (!metadataDocument.ifItFitsItSits('env', faasEnv)) {
@@ -152,8 +163,50 @@ export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMe
       }
     }
   }
+  return metadataDocument;
+}
 
-  return metadataDocument.toObject();
+
+let isDocker: boolean;
+export async function addAllEnvClientMetadata(metadataDocument: LimitedSizeDocument) {
+  const faasEnv = getFAASEnv();
+  
+  async function getContainerMetadata() {
+    const containerMetadata: Record<string, any> = {};
+    if (isDocker !== false && isDocker !== true) {
+      try {
+        await fs.access('/.dockerenv');
+        isDocker = true;
+      } catch {
+        isDocker = false;
+      }
+    }
+    const isKubernetes = process.env.KUBERNETES_SERVICE_HOST ? true : false;
+  
+    if (isDocker || isKubernetes) {
+      if (isDocker) {
+        containerMetadata['runtime'] = 'docker';
+      }
+      if (isKubernetes) {
+        containerMetadata['orchestrator'] = 'kubernetes';
+      }
+    }
+    return containerMetadata;
+  }
+
+  const containerMetadata = await getContainerMetadata();
+  const envMetadata = faasEnv ? faasEnv.set('container', containerMetadata) : containerMetadata;
+
+  if (envMetadata != null) {
+    if (!metadataDocument.ifItFitsItSits('env', envMetadata)) {
+      for (const key of envMetadata.keys()) {
+        envMetadata.delete(key);
+        if (envMetadata.size === 0) break;
+        if (metadataDocument.ifItFitsItSits('env', envMetadata)) break;
+      }
+    }
+  }
+  return metadataDocument;
 }
 
 /**

src/connection_string.ts

@@ -5,7 +5,7 @@ import { URLSearchParams } from 'url';
 import type { Document } from './bson';
 import { MongoCredentials } from './cmap/auth/mongo_credentials';
 import { AUTH_MECHS_AUTH_SRC_EXTERNAL, AuthMechanism } from './cmap/auth/providers';
-import { makeClientMetadata } from './cmap/handshake/client_metadata';
+import { type ClientMetadata, makeClientMetadata } from './cmap/handshake/client_metadata';
 import { Compressor, type CompressorName } from './cmap/wire_protocol/compression';
 import { Encrypter } from './encrypter';
 import {

src/mongo_client.ts

@@ -14,7 +14,7 @@ import {
 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 type { ClientMetadata } from './cmap/handshake/client_metadata';
+import type { ClientMetadata, LimitedSizeDocument } from './cmap/handshake/client_metadata';
 import type { CompressorName } from './cmap/wire_protocol/compression';
 import { parseOptions, resolveSRVRecord } from './connection_string';
 import { MONGO_CLIENT_EVENTS } from './constants';
@@ -897,4 +897,11 @@ export interface MongoOptions
    * TODO: NODE-5671 - remove internal flag
    */
   mongodbLogPath?: 'stderr' | 'stdout' | MongoDBLogWritable;
+
+  /**
+   * @internal 
+   * Metadata as BSON bytes.
+   * Does not contain any environment information.
+   */
+  internalMetadata: LimitedSizeDocument;
 }

src/sdam/topology.ts

@@ -4,7 +4,7 @@ import type { BSONSerializeOptions, Document } from '../bson';
 import type { MongoCredentials } from '../cmap/auth/mongo_credentials';
 import type { ConnectionEvents, DestroyOptions } from '../cmap/connection';
 import type { CloseOptions, ConnectionPoolEvents } from '../cmap/connection_pool';
-import type { ClientMetadata } from '../cmap/handshake/client_metadata';
+import type { ClientMetadata, LimitedSizeDocument } from '../cmap/handshake/client_metadata';
 import { DEFAULT_OPTIONS, FEATURE_FLAGS } from '../connection_string';
 import {
   CLOSE,
@@ -158,6 +158,7 @@ export interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
   directConnection: boolean;
   loadBalanced: boolean;
   metadata: ClientMetadata;
+  internalMetadata: LimitedSizeDocument;
   serverMonitoringMode: ServerMonitoringMode;
   /** MongoDB server API version */
   serverApi?: ServerApi;