fix(NODE-5536): remove credentials from ConnectionPoolCreatedEvent options (#3812)

Author: nbbeeken

src/cmap/connection_pool_events.ts

@@ -28,12 +28,17 @@ export class ConnectionPoolMonitoringEvent {
  */
 export class ConnectionPoolCreatedEvent extends ConnectionPoolMonitoringEvent {
   /** The options used to create this connection pool */
-  options?: ConnectionPoolOptions;
+  options: Omit<ConnectionPoolOptions, 'credentials'> & { credentials?: Record<never, never> };
 
   /** @internal */
   constructor(pool: ConnectionPool) {
     super(pool);
-    this.options = pool.options;
+    if (pool.options.credentials != null) {
+      // Intentionally remove credentials: NODE-5460
+      this.options = { ...pool.options, credentials: {} };
+    } else {
+      this.options = pool.options;
+    }
   }
 }
 

src/operations/operation.ts

@@ -19,10 +19,6 @@ export const Aspect = {
 /** @public */
 export type Hint = string | Document;
 
-export interface OperationConstructor extends Function {
-  aspects?: Set<symbol>;
-}
-
 /** @public */
 export interface OperationOptions extends BSONSerializeOptions {
   /** Specify ClientSession for this command */
@@ -96,7 +92,7 @@ export abstract class AbstractOperation<TResult = any> {
   ): void;
 
   hasAspect(aspect: symbol): boolean {
-    const ctor = this.constructor as OperationConstructor;
+    const ctor = this.constructor as { aspects?: Set<symbol> };
     if (ctor.aspects == null) {
       return false;
     }
@@ -122,7 +118,7 @@ export abstract class AbstractOperation<TResult = any> {
 }
 
 export function defineAspects(
-  operation: OperationConstructor,
+  operation: { new (...args: any[]): any },
   aspects: symbol | symbol[] | Set<symbol>
 ): Set<symbol> {
   if (!Array.isArray(aspects) && !(aspects instanceof Set)) {

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

@@ -1,3 +1,7 @@
+import { expect } from 'chai';
+import { once } from 'events';
+
+import { MongoClient } from '../../../src';
 import { loadSpecTests } from '../../spec';
 import { CmapTest, runCmapTestSuite } from '../../tools/cmap_spec_runner';
 
@@ -16,4 +20,49 @@ describe('Connection Monitoring and Pooling (Node Driver)', function () {
       }
     ]
   });
+
+  describe('ConnectionPoolCreatedEvent', () => {
+    let client: MongoClient;
+    beforeEach(async function () {
+      client = this.configuration.newClient();
+    });
+
+    afterEach(async function () {
+      await client.close();
+    });
+
+    describe('constructor()', () => {
+      it('when auth is enabled redacts credentials from options', {
+        metadata: { requires: { auth: 'enabled' } },
+        async test() {
+          const poolCreated = once(client, 'connectionPoolCreated');
+          await client.connect();
+          const [event] = await poolCreated;
+          expect(event).to.have.deep.nested.property('options.credentials', {});
+
+          const poolOptions = Array.from(client.topology?.s.servers.values() ?? []).map(
+            s => s.s.pool.options
+          );
+          expect(poolOptions).to.have.length.of.at.least(1);
+
+          for (const { credentials = {} } of poolOptions) {
+            expect(
+              Object.keys(credentials),
+              'pool.options.credentials must exist and have keys'
+            ).to.not.equal(0);
+          }
+        }
+      });
+
+      it('when auth is disabled does not add a credentials property to options', {
+        metadata: { requires: { auth: 'disabled' } },
+        async test() {
+          const poolCreated = once(client, 'connectionPoolCreated');
+          await client.connect();
+          const [event] = await poolCreated;
+          expect(event).to.not.have.nested.property('options.credentials');
+        }
+      });
+    });
+  });
 });