fix(NODE-5537): remove credentials from ConnectionPoolCreatedEvent op…

…tions (#3813)
mongodb · Aug 15, 2023 · 4cf1e96 · 4cf1e96
1 parent e81d4a2
commit 4cf1e96
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 3 deletions.
diff --git a/global.d.ts b/global.d.ts
@@ -1,4 +1,4 @@
-import { OneOrMore } from './src/mongo_types';
+import { type OneOrMore } from './src/mongo_types';
 import type { TestConfiguration } from './test/tools/runner/config';
 
 declare global {

diff --git a/src/cmap/connection_pool_events.ts b/src/cmap/connection_pool_events.ts
@@ -54,14 +54,19 @@ export abstract 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 */
   name = CONNECTION_POOL_CREATED;
 
   /** @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;
+    }
   }
 }
 

diff --git a/test/integration/connection-monitoring-and-pooling/connection_monitoring_and_pooling.test.ts b/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 { type MongoClient } from '../../mongodb';
 import { loadSpecTests } from '../../spec';
 import { type CmapTest, runCmapTestSuite } from '../../tools/cmap_spec_runner';
 import { runUnifiedSuite } from '../../tools/unified-spec-runner/runner';
@@ -23,4 +27,49 @@ describe('Connection Monitoring and Pooling (Node Driver)', function () {
     '../integration/connection-monitoring-and-pooling/unified-cmap-node-specs'
   );
   runUnifiedSuite(unifiedTests);
+
+  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.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');
+        }
+      });
+    });
+  });
 });