WIP

Author: W-A-James

src/connection_string.ts

@@ -1311,7 +1311,13 @@ export const OPTIONS = {
    * TODO: NODE-5671 - remove internal flag
    */
   mongodbLogMaxDocumentLength: { type: 'uint' }
-} as Record<keyof MongoClientOptions, OptionDescriptor>;
+} as Record<
+  keyof Omit<
+    MongoClientOptions,
+    '__enableMongoLogger' | '__internalLoggerConfig' | '__skipPingOnConnect'
+  >,
+  OptionDescriptor
+>;
 
 export const DEFAULT_OPTIONS = new CaseInsensitiveMap(
   Object.entries(OPTIONS)

src/mongo_client.ts

@@ -1010,9 +1010,6 @@ export interface MongoOptions
   tlsCRLFile?: string;
   tlsCertificateKeyFile?: string;
 
-  /** @internal */
-  [featureFlag: symbol]: any;
-
   /**
    * @internal
    * TODO: NODE-5671 - remove internal flag
@@ -1024,4 +1021,10 @@ export interface MongoOptions
    */
   mongodbLogPath?: 'stderr' | 'stdout' | MongoDBLogWritable;
   timeoutMS?: number;
+  /** @internal */
+  __skipPingOnConnect?: boolean;
+  /** @internal */
+  __internalLoggerConfig?: Document;
+  /** @internal */
+  __enableMongoLogger?: boolean;
 }

src/operations/execute_operation.ts

@@ -131,7 +131,7 @@ async function autoConnect(client: MongoClient): Promise<Topology> {
     if (client.s.hasBeenClosed) {
       throw new MongoNotConnectedError('Client must be connected before running operations');
     }
-    client.s.options[__skipPingOnConnect] = true;
+    client.s.options.__skipPingOnConnect = true;
     try {
       await client.connect();
       if (client.topology == null) {
@@ -141,7 +141,7 @@ async function autoConnect(client: MongoClient): Promise<Topology> {
       }
       return client.topology;
     } finally {
-      delete client.s.options[__skipPingOnConnect];
+      delete client.s.options.__skipPingOnConnect;
     }
   }
   return client.topology;

src/sdam/topology.ts

@@ -153,7 +153,7 @@ export interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
   serverMonitoringMode: ServerMonitoringMode;
   /** MongoDB server API version */
   serverApi?: ServerApi;
-  [featureFlag: symbol]: any;
+  __skipPingOnConnect?: boolean;
 }
 
 /** @public */
@@ -466,7 +466,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
         readPreferenceServerSelector(readPreference),
         selectServerOptions
       );
-      const skipPingOnConnect = this.s.options[__skipPingOnConnect] === true;
+      const skipPingOnConnect = this.s.options.__skipPingOnConnect === true;
       if (!skipPingOnConnect && this.s.credentials) {
         await server.command(ns('admin.$cmd'), { ping: 1 }, { timeoutContext });
         stateTransition(this, STATE_CONNECTED);

test/unit/connection_string.test.ts

@@ -12,7 +12,6 @@ import {
   COSMOS_DB_MSG,
   DEFAULT_ALLOWED_HOSTS,
   DOCUMENT_DB_MSG,
-  FEATURE_FLAGS,
   type Log,
   MongoAPIError,
   MongoClient,
@@ -748,43 +747,6 @@ describe('Connection String', function () {
     });
   });
 
-  describe('feature flags', () => {
-    it('should be stored in the FEATURE_FLAGS Set', () => {
-      expect(FEATURE_FLAGS.size).to.equal(3);
-      expect(FEATURE_FLAGS.has(__skipPingOnConnect)).to.be.true;
-      expect(FEATURE_FLAGS.has(__enableMongoLogger)).to.be.true;
-      expect(FEATURE_FLAGS.has(__internalLoggerConfig)).to.be.true;
-      // Add more flags here
-    });
-
-    it('should should ignore unknown symbols', () => {
-      const randomFlag = Symbol();
-      const client = new MongoClient('mongodb://iLoveJavaScript', { [randomFlag]: 23n });
-      expect(client.s.options).to.not.have.property(randomFlag);
-    });
-
-    it('should be prefixed with @@mdb.', () => {
-      for (const flag of FEATURE_FLAGS) {
-        expect(flag).to.be.a('symbol');
-        expect(flag).to.have.property('description');
-        expect(flag.description).to.match(/@@mdb\..+/);
-      }
-    });
-
-    it('should only exist if specified on options', () => {
-      const flag = Array.from(FEATURE_FLAGS)[0]; // grab a random supported flag
-      const client = new MongoClient('mongodb://iLoveJavaScript', { [flag]: true });
-      expect(client.s.options).to.have.property(flag, true);
-      expect(client.options).to.have.property(flag, true);
-    });
-
-    it('should support nullish values', () => {
-      const flag = Array.from(FEATURE_FLAGS.keys())[0]; // grab a random supported flag
-      const client = new MongoClient('mongodb://iLoveJavaScript', { [flag]: null });
-      expect(client.s.options).to.have.property(flag, null);
-    });
-  });
-
   describe('IPv6 host addresses', () => {
     it('should not allow multiple unbracketed portless localhost IPv6 addresses', () => {
       // Note there is no "port-full" version of this test, there's no way to distinguish when a port begins without brackets
@@ -874,8 +836,6 @@ describe('Connection String', function () {
   });
 
   describe('when mongodbLogPath is in options', function () {
-    const loggerFeatureFlag = __enableMongoLogger;
-
     let stderrStub;
     let stdoutStub;
 
@@ -891,7 +851,7 @@ describe('Connection String', function () {
     context('when option is `stderr`', function () {
       it('it is accessible through mongoLogger.logDestination', function () {
         const client = new MongoClient('mongodb://a/?mongodbLogPath=stderr', {
-          [loggerFeatureFlag]: true
+          __enableMongoLogger: true
         });
         const log: Log = { t: new Date(), c: 'ConnectionStringStdErr', s: 'error' };
         client.options.mongoLoggerOptions.logDestination.write(log);
@@ -903,7 +863,7 @@ describe('Connection String', function () {
     context('when option is `stdout`', function () {
       it('it is accessible through mongoLogger.logDestination', function () {
         const client = new MongoClient('mongodb://a/?mongodbLogPath=stdout', {
-          [loggerFeatureFlag]: true
+          __enableMongoLogger: true
         });
         const log: Log = { t: new Date(), c: 'ConnectionStringStdOut', s: 'error' };
         client.options.mongoLoggerOptions.logDestination.write(log);
@@ -916,7 +876,7 @@ describe('Connection String', function () {
       it('should throw error at construction', function () {
         expect(
           () =>
-            new MongoClient('mongodb://a/?mongodbLogPath=stdnothing', { [loggerFeatureFlag]: true })
+            new MongoClient('mongodb://a/?mongodbLogPath=stdnothing', { __enableMongoLogger: true })
         ).to.throw(MongoAPIError);
       });
     });
@@ -931,7 +891,6 @@ describe('Connection String', function () {
       process.env.MONGODB_LOG_CLIENT = undefined;
     });
 
-    const loggerFeatureFlag = __enableMongoLogger;
     const test_cases = [
       ['non-SRV example uri', 'mongodb://a.example.com:27017,b.example.com:27017/', ''],
       ['non-SRV default uri', 'mongodb://a.mongodb.net:27017', ''],
@@ -960,7 +919,7 @@ describe('Connection String', function () {
             }
           };
           new MongoClient(uri, {
-            [loggerFeatureFlag]: true,
+            __enableMongoLogger: true,
             mongodbLogPath: stream
           });