feat(NODE-4849): Add Typescript support for log path in client options

src/connection_string.ts

@@ -529,7 +529,7 @@ export function parseOptions(
       ...mongoOptions[Symbol.for('@@mdb.internalLoggerConfig')]
     };
     loggerClientOptions = {
-      mongodbLogPath: mongoOptions.mongodbLogPath
+      mongodbLogPath: mongoOptions.mongoLoggerClientOptions.mongodbLogPath
     };
   }
   mongoOptions.mongoLoggerOptions = MongoLogger.resolveOptions(
@@ -1224,8 +1224,11 @@ export const OPTIONS = {
       'useUnifiedTopology has no effect since Node.js Driver version 4.0.0 and will be removed in the next major version'
   } as OptionDescriptor,
   // MongoLogger
-  // TODO(NODE-4849): Tighten the type of mongodbLogPath
-  mongodbLogPath: { type: 'any' }
+  /**
+   * @internal
+   * TODO: NODE-5671 - remove internal flag
+   */
+  mongoLoggerClientOptions: { type: 'any' }
 } as Record<keyof MongoClientOptions, OptionDescriptor>;
 
 export const DEFAULT_OPTIONS = new CaseInsensitiveMap(

src/mongo_client.ts

@@ -21,7 +21,11 @@ import { MONGO_CLIENT_EVENTS } from './constants';
 import { Db, type DbOptions } from './db';
 import type { Encrypter } from './encrypter';
 import { MongoInvalidArgumentError } from './error';
-import { MongoLogger, type MongoLoggerOptions } from './mongo_logger';
+import {
+  MongoLogger,
+  type MongoLoggerMongoClientOptions,
+  type MongoLoggerOptions
+} from './mongo_logger';
 import { TypedEventEmitter } from './mongo_types';
 import { executeOperation } from './operations/execute_operation';
 import { RunAdminCommandOperation } from './operations/run_command';
@@ -252,6 +256,11 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
   srvPoller?: SrvPoller;
   /** @internal */
   connectionType?: typeof Connection;
+  /**
+   * @internal
+   * TODO: NODE-5671 - remove internal flag
+   */
+  mongoLoggerClientOptions?: MongoLoggerMongoClientOptions;
 
   /** @internal */
   [featureFlag: symbol]: any;
@@ -825,6 +834,14 @@ export interface MongoOptions
   /** @internal */
   [featureFlag: symbol]: any;
 
-  /** @internal */
+  /**
+   * @internal
+   * TODO: NODE-5671 - remove internal flag
+   */
   mongoLoggerOptions: MongoLoggerOptions;
+  /**
+   * @internal
+   * TODO: NODE-5671 - remove internal flag
+   */
+  mongoLoggerClientOptions?: MongoLoggerMongoClientOptions;
 }

src/mongo_logger.ts

@@ -191,7 +191,7 @@ export function createStdioLogger(stream: {
  */
 function resolveLogPath(
   { MONGODB_LOG_PATH }: MongoLoggerEnvOptions,
-  { mongodbLogPath }: { mongodbLogPath?: string | Writable | MongoDBLogWritable }
+  { mongodbLogPath }: MongoLoggerMongoClientOptions
 ): MongoDBLogWritable {
   if (typeof mongodbLogPath === 'string' && /^stderr$/i.test(mongodbLogPath)) {
     return createStdioLogger(process.stderr);

test/tools/unified-spec-runner/entities.ts

@@ -189,10 +189,9 @@ export class UnifiedMongoClient extends MongoClient {
       [Symbol.for('@@mdb.skipPingOnConnect')]: true,
       [Symbol.for('@@mdb.enableMongoLogger')]: true,
       [Symbol.for('@@mdb.internalLoggerConfig')]: componentSeverities,
-      // @ts-expect-error TODO(NODE-4849): Remove this once we have support for mongodbLogPath
-      mongodbLogPath: logCollector,
       ...getEnvironmentalOptions(),
-      ...(description.serverApi ? { serverApi: description.serverApi } : {})
+      ...(description.serverApi ? { serverApi: description.serverApi } : {}),
+      mongoLoggerClientOptions: { mongodbLogPath: logCollector }
     } as any);
     this.logCollector = logCollector;