initial POC

Author: baileympearson

.eslintrc.json

@@ -276,7 +276,8 @@
             "patterns": [
               "**/../lib/**",
               "mongodb-mock-server",
-              "node:*"
+              "node:*",
+              "os"
             ],
             "paths": [
               {
@@ -327,4 +328,4 @@
       }
     }
   ]
-}
+}

src/cmap/auth/gssapi.ts

@@ -1,5 +1,4 @@
 import * as dns from 'dns';
-import * as os from 'os';
 
 import { getKerberos, type Kerberos, type KerberosClient } from '../../deps';
 import { MongoInvalidArgumentError, MongoMissingCredentialsError } from '../../error';
@@ -69,9 +68,13 @@ export class GSSAPI extends AuthProvider {
   }
 }
 
-async function makeKerberosClient(authContext: AuthContext): Promise<KerberosClient> {
-  const { hostAddress } = authContext.options;
-  const { credentials } = authContext;
+async function makeKerberosClient({
+  options: {
+    hostAddress,
+    runtime: { os }
+  },
+  credentials
+}: AuthContext): Promise<KerberosClient> {
   if (!hostAddress || typeof hostAddress.host !== 'string' || !credentials) {
     throw new MongoInvalidArgumentError(
       'Connection must have host and port and credentials defined.'

src/cmap/connection.ts

@@ -35,6 +35,7 @@ import { type MongoClientAuthProviders } from '../mongo_client_auth_providers';
 import { MongoLoggableComponent, type MongoLogger, SeverityLevel } from '../mongo_logger';
 import { type Abortable, type CancellationToken, TypedEventEmitter } from '../mongo_types';
 import { ReadPreference, type ReadPreferenceLike } from '../read_preference';
+import { type Runtime } from '../runtime_adapters';
 import { ServerType } from '../sdam/common';
 import { applySession, type ClientSession, updateSessionFromResponse } from '../sessions';
 import { type TimeoutContext, TimeoutError } from '../timeout';
@@ -118,8 +119,8 @@ export interface ProxyOptions {
 /** @public */
 export interface ConnectionOptions
   extends SupportedNodeConnectionOptions,
-    StreamDescriptionOptions,
-    ProxyOptions {
+  StreamDescriptionOptions,
+  ProxyOptions {
   // Internal creation info
   id: number | '<monitor>';
   generation: number;
@@ -143,6 +144,8 @@ export interface ConnectionOptions
   metadata: Promise<ClientMetadata>;
   /** @internal */
   mongoLogger?: MongoLogger | undefined;
+  /** @internal */
+  runtime: Runtime;
 }
 
 /** @public */
@@ -526,10 +529,10 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
       options.documentsReturnedIn == null || !options.raw
         ? options
         : {
-            ...options,
-            raw: false,
-            fieldsAsRaw: { [options.documentsReturnedIn]: true }
-          };
+          ...options,
+          raw: false,
+          fieldsAsRaw: { [options.documentsReturnedIn]: true }
+        };
 
     /** MongoDBResponse instance or subclass */
     let document: MongoDBResponse | undefined = undefined;
@@ -692,9 +695,9 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
       options.agreedCompressor === 'none' || !OpCompressedRequest.canCompress(command)
         ? command
         : new OpCompressedRequest(command, {
-            agreedCompressor: options.agreedCompressor ?? 'none',
-            zlibCompressionLevel: options.zlibCompressionLevel ?? 0
-          });
+          agreedCompressor: options.agreedCompressor ?? 'none',
+          zlibCompressionLevel: options.zlibCompressionLevel ?? 0
+        });
 
     const buffer = Buffer.concat(await finalCommand.toBin());
 

src/cmap/handshake/client_metadata.ts

@@ -1,4 +1,3 @@
-import * as os from 'os';
 import * as process from 'process';
 
 import { BSON, type Document, Int32, NumberUtils } from '../../bson';
@@ -96,7 +95,8 @@ export class LimitedSizeDocument {
   }
 }
 
-type MakeClientMetadataOptions = Pick<MongoOptions, 'appName'>;
+type MakeClientMetadataOptions = Pick<MongoOptions, 'appName' | 'runtime'>;
+
 /**
  * From the specs:
  * Implementors SHOULD cumulatively update fields in the following order until the document is under the size limit:
@@ -107,7 +107,7 @@ type MakeClientMetadataOptions = Pick<MongoOptions, 'appName'>;
  */
 export async function makeClientMetadata(
   driverInfoList: DriverInfo[],
-  { appName = '' }: MakeClientMetadataOptions
+  { appName = '', runtime: { os } }: MakeClientMetadataOptions
 ): Promise<ClientMetadata> {
   const metadataDocument = new LimitedSizeDocument(512);
 

src/connection_string.ts

@@ -20,6 +20,7 @@ import {
 import { MongoLoggableComponent, MongoLogger, SeverityLevel } from './mongo_logger';
 import { ReadConcern, type ReadConcernLevel } from './read_concern';
 import { ReadPreference, type ReadPreferenceMode } from './read_preference';
+import { type Runtime } from './runtime_adapters';
 import { ServerMonitoringMode } from './sdam/monitor';
 import type { TagSet } from './sdam/server_description';
 import {
@@ -538,6 +539,13 @@ export function parseOptions(
     }
   );
 
+  const runtime: Runtime = {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    os: options.runtimeAdapters?.os ?? require('os')
+  };
+
+  mongoOptions.runtime = runtime;
+
   return mongoOptions;
 }
 
@@ -1061,6 +1069,9 @@ export const OPTIONS = {
     default: true,
     type: 'boolean'
   },
+  runtimeAdapters: {
+    type: 'record'
+  },
   serializeFunctions: {
     type: 'boolean'
   },

src/index.ts

@@ -562,6 +562,7 @@ export type {
   ReadPreferenceLikeOptions,
   ReadPreferenceOptions
 } from './read_preference';
+export type { OsAdapter, Runtime, RuntimeAdapters } from './runtime_adapters';
 export type { ClusterTime } from './sdam/common';
 export type {
   Monitor,

src/mongo_client.ts

@@ -46,6 +46,7 @@ import { EndSessionsOperation } from './operations/end_sessions';
 import { executeOperation } from './operations/execute_operation';
 import type { ReadConcern, ReadConcernLevel, ReadConcernLike } from './read_concern';
 import { ReadPreference, type ReadPreferenceMode } from './read_preference';
+import { type Runtime, type RuntimeAdapters } from './runtime_adapters';
 import type { ServerMonitoringMode } from './sdam/monitor';
 import type { TagSet } from './sdam/server_description';
 import { DeprioritizedServers, readPreferenceServerSelector } from './sdam/server_selection';
@@ -318,6 +319,8 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
   connectionType?: typeof Connection;
   /** @internal */
   __skipPingOnConnect?: boolean;
+  /** @experimental  */
+  runtimeAdapters?: RuntimeAdapters;
 }
 
 /** @public */
@@ -1032,39 +1035,39 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
  */
 export interface MongoOptions
   extends Required<
-      Pick<
-        MongoClientOptions,
-        | 'autoEncryption'
-        | 'connectTimeoutMS'
-        | 'directConnection'
-        | 'driverInfo'
-        | 'forceServerObjectId'
-        | 'minHeartbeatFrequencyMS'
-        | 'heartbeatFrequencyMS'
-        | 'localThresholdMS'
-        | 'maxConnecting'
-        | 'maxIdleTimeMS'
-        | 'maxPoolSize'
-        | 'minPoolSize'
-        | 'monitorCommands'
-        | 'noDelay'
-        | 'pkFactory'
-        | 'raw'
-        | 'replicaSet'
-        | 'retryReads'
-        | 'retryWrites'
-        | 'serverSelectionTimeoutMS'
-        | 'socketTimeoutMS'
-        | 'srvMaxHosts'
-        | 'srvServiceName'
-        | 'tlsAllowInvalidCertificates'
-        | 'tlsAllowInvalidHostnames'
-        | 'tlsInsecure'
-        | 'waitQueueTimeoutMS'
-        | 'zlibCompressionLevel'
-      >
-    >,
-    SupportedNodeConnectionOptions {
+    Pick<
+      MongoClientOptions,
+      | 'autoEncryption'
+      | 'connectTimeoutMS'
+      | 'directConnection'
+      | 'driverInfo'
+      | 'forceServerObjectId'
+      | 'minHeartbeatFrequencyMS'
+      | 'heartbeatFrequencyMS'
+      | 'localThresholdMS'
+      | 'maxConnecting'
+      | 'maxIdleTimeMS'
+      | 'maxPoolSize'
+      | 'minPoolSize'
+      | 'monitorCommands'
+      | 'noDelay'
+      | 'pkFactory'
+      | 'raw'
+      | 'replicaSet'
+      | 'retryReads'
+      | 'retryWrites'
+      | 'serverSelectionTimeoutMS'
+      | 'socketTimeoutMS'
+      | 'srvMaxHosts'
+      | 'srvServiceName'
+      | 'tlsAllowInvalidCertificates'
+      | 'tlsAllowInvalidHostnames'
+      | 'tlsInsecure'
+      | 'waitQueueTimeoutMS'
+      | 'zlibCompressionLevel'
+    >
+  >,
+  SupportedNodeConnectionOptions {
   appName?: string;
   hosts: HostAddress[];
   srvHost?: string;
@@ -1152,4 +1155,7 @@ export interface MongoOptions
   timeoutMS?: number;
   /** @internal */
   __skipPingOnConnect?: boolean;
+
+  /** @internal */
+  runtime: Runtime;
 }

test/unit/assorted/optional_require.test.ts

@@ -41,7 +41,9 @@ describe('optionalRequire', function () {
       const gssapi = new GSSAPI();
 
       const error = await gssapi
-        .auth(new AuthContext(null, true, { hostAddress: new HostAddress('a'), credentials: true }))
+        .auth(new AuthContext(null, true, {
+          hostAddress: new HostAddress('a'), credentials: true, runtime: { os: require('os') }
+        }))
         .then(
           () => null,
           e => e

test/unit/cmap/connect.test.ts

@@ -210,7 +210,9 @@ describe('Connect Tests', function () {
             connection: {},
             options: {
               ...CONNECT_DEFAULTS,
-              metadata: makeClientMetadata([], {})
+              metadata: makeClientMetadata([], {
+                runtime: { os: require('os') }
+              })
             }
           };
         });
@@ -239,7 +241,9 @@ describe('Connect Tests', function () {
                   name: 's'.repeat(128)
                 }
               ],
-              { appName: longAppName }
+              {
+                appName: longAppName, runtime: { os: require('os') }
+              }
             );
             const longAuthContext = {
               connection: {},
@@ -267,7 +271,9 @@ describe('Connect Tests', function () {
             connection: {},
             options: {
               ...CONNECT_DEFAULTS,
-              metadata: makeClientMetadata([], {})
+              metadata: makeClientMetadata([], {
+                runtime: { os: require('os') }
+              })
             }
           };
         });
@@ -296,7 +302,10 @@ describe('Connect Tests', function () {
                   name: 's'.repeat(128)
                 }
               ],
-              { appName: longAppName }
+              {
+                appName: longAppName,
+                runtime: { os: require('os') }
+              }
             );
             const longAuthContext = {
               connection: {},