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

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;
+ }
  }
 }
 

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, MongoCredentials } 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');
+ }
+ });
+ });
+ });
 });