added support for topologyDescriptionChangedEvents in spec runner

Author: aditi-khare-mongoDB

src/mongo_logger.ts

@@ -308,7 +308,7 @@ export interface LogConvertible extends Record<string, any> {
 
 /** @internal */
 export function stringifyWithMaxLen(value: any, maxDocumentLength: number): string {
-  const ejson = EJSON.stringify(value);
+  const ejson = EJSON.stringify(value) ?? 'custom function';
 
   return maxDocumentLength !== 0 && ejson.length > maxDocumentLength
     ? `${ejson.slice(0, maxDocumentLength)}...`

src/sdam/topology.ts

@@ -31,7 +31,7 @@ import {
   MongoTopologyClosedError
 } from '../error';
 import type { MongoClient, ServerApi } from '../mongo_client';
-import type { MongoLogger } from '../mongo_logger';
+import { MongoLoggableComponent, type MongoLogger } from '../mongo_logger';
 import { TypedEventEmitter } from '../mongo_types';
 import { ReadPreference, type ReadPreferenceLike } from '../read_preference';
 import type { ClientSession } from '../sessions';
@@ -556,7 +556,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
     }
 
     this.client.mongoLogger.debug(
-      'topology',
+      MongoLoggableComponent.SERVER_SELECTION,
       new ServerSelectionStartedEvent(selector, this.description, options?.operationName)
     );
 
@@ -571,6 +571,15 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
     const transaction = session && session.transaction;
 
     if (isSharded && transaction && transaction.server) {
+      this.client.mongoLogger.debug(
+        MongoLoggableComponent.SERVER_SELECTION,
+        new ServerSelectionSucceededEvent(
+          selector,
+          this.description,
+          transaction.server.pool.address,
+          options?.operationName
+        )
+      );
       callback(undefined, transaction.server);
       return;
     }
@@ -593,7 +602,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
         this.description
       );
       this.client.mongoLogger.debug(
-        'topology',
+        MongoLoggableComponent.SERVER_SELECTION,
         new ServerSelectionFailedEvent(
           selector,
           this.description,
@@ -606,7 +615,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
 
     this[kWaitQueue].push(waitQueueMember);
     this.client.mongoLogger.info(
-      'topology',
+      MongoLoggableComponent.SERVER_SELECTION,
       new WaitingForSuitableServerEvent(
         selector,
         this.description,
@@ -886,7 +895,7 @@ function drainWaitQueue(queue: List<ServerSelectionRequest>, err?: MongoDriverEr
     if (!waitQueueMember[kCancelled]) {
       if (err) {
         waitQueueMember.mongoLogger.debug(
-          'topology',
+          MongoLoggableComponent.SERVER_SELECTION,
           new ServerSelectionFailedEvent(
             waitQueueMember.serverSelector,
             waitQueueMember.topologyDescription,
@@ -927,7 +936,15 @@ function processWaitQueue(topology: Topology) {
         : serverDescriptions;
     } catch (e) {
       waitQueueMember.timeoutController.clear();
-
+      topology.client.mongoLogger.debug(
+        MongoLoggableComponent.SERVER_SELECTION,
+        new ServerSelectionFailedEvent(
+          waitQueueMember.serverSelector,
+          topology.description,
+          e,
+          waitQueueMember?.operationName
+        )
+      );
       waitQueueMember.callback(e);
       continue;
     }
@@ -955,7 +972,7 @@ function processWaitQueue(topology: Topology) {
         topology.description
       );
       topology.client.mongoLogger.debug(
-        'topology',
+        MongoLoggableComponent.SERVER_SELECTION,
         new ServerSelectionFailedEvent(
           waitQueueMember.serverSelector,
           topology.description,
@@ -974,7 +991,7 @@ function processWaitQueue(topology: Topology) {
     waitQueueMember.timeoutController.clear();
 
     topology.client.mongoLogger.debug(
-      'topology',
+      MongoLoggableComponent.SERVER_SELECTION,
       new ServerSelectionSucceededEvent(
         waitQueueMember.serverSelector,
         waitQueueMember.topologyDescription,

test/spec/unified-test-format/invalid/expectedSdamEvent-topologyDescriptionChangedEvent-additionalProperties.json

@@ -0,0 +1,23 @@
+{
+  "description": "expectedSdamEvent-topologyDescriptionChangedEvent-additionalProperties",
+  "schemaVersion": "1.14",
+  "tests": [
+    {
+      "description": "foo",
+      "operations": [],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "eventType": "sdam",
+          "events": [
+            {
+              "topologyDescriptionChangedEvent": {
+                "foo": "bar"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

test/spec/unified-test-format/invalid/expectedSdamEvent-topologyDescriptionChangedEvent-additionalProperties.yml

@@ -0,0 +1,13 @@
+description: expectedSdamEvent-topologyDescriptionChangedEvent-additionalProperties
+
+schemaVersion: '1.14'
+
+tests:
+  - description: foo
+    operations: []
+    expectEvents:
+      - client: client0
+        eventType: sdam
+        events:
+          - topologyDescriptionChangedEvent:
+              foo: bar

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

@@ -37,6 +37,7 @@ import {
   type ServerHeartbeatStartedEvent,
   type ServerHeartbeatSucceededEvent,
   type TopologyDescription,
+  type TopologyDescriptionChangedEvent,
   WriteConcern
 } from '../../mongodb';
 import { ejson, getEnvironmentalOptions } from '../../tools/utils';
@@ -104,7 +105,8 @@ export type SdamEvent =
   | ServerDescriptionChangedEvent
   | ServerHeartbeatStartedEvent
   | ServerHeartbeatFailedEvent
-  | ServerHeartbeatSucceededEvent;
+  | ServerHeartbeatSucceededEvent
+  | TopologyDescriptionChangedEvent;
 export type LogMessage = Omit<ExpectedLogMessage, 'failureIsRedacted'>;
 
 function getClient(address) {
@@ -138,6 +140,7 @@ export class UnifiedMongoClient extends MongoClient {
     | 'serverHeartbeatStartedEvent'
     | 'serverHeartbeatFailedEvent'
     | 'serverHeartbeatSucceededEvent'
+    | 'topologyDescriptionChangedEvent'
   )[];
   observedEventEmitter = new EventEmitter();
   _credentials: MongoCredentials | null;
@@ -166,7 +169,8 @@ export class UnifiedMongoClient extends MongoClient {
     serverDescriptionChangedEvent: 'serverDescriptionChanged',
     serverHeartbeatStartedEvent: 'serverHeartbeatStarted',
     serverHeartbeatFailedEvent: 'serverHeartbeatFailed',
-    serverHeartbeatSucceededEvent: 'serverHeartbeatSucceeded'
+    serverHeartbeatSucceededEvent: 'serverHeartbeatSucceeded',
+    topologyDescriptionChangedEvent: 'topologyDescriptionChanged'
   } as const;
 
   static LOGGING_COMPONENT_TO_ENV_VAR_NAME = {

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

@@ -29,7 +29,8 @@ import {
   ServerDescriptionChangedEvent,
   ServerHeartbeatFailedEvent,
   ServerHeartbeatStartedEvent,
-  ServerHeartbeatSucceededEvent
+  ServerHeartbeatSucceededEvent,
+  TopologyDescriptionChangedEvent
 } from '../../mongodb';
 import { ejson } from '../utils';
 import { type CmapEvent, type CommandEvent, type EntitiesMap, type SdamEvent } from './entities';
@@ -561,6 +562,13 @@ function compareEvents(
         expect(actualEvent[property]).to.equal(expectedSdamEvent[property]);
       }
       return;
+    } else if (expectedEvent.topologyDescriptionChangedEvent) {
+      expect(actualEvent).to.be.instanceOf(TopologyDescriptionChangedEvent);
+      const expectedSdamEvent = expectedEvent.topologyDescriptionChangedEvent;
+      for (const property of Object.keys(expectedSdamEvent)) {
+        expect(actualEvent[property]).to.equal(expectedSdamEvent[property]);
+      }
+      return;
     } else {
       expect.fail(`Encountered unexpected event - ${inspect(actualEvent)}`);
     }
@@ -596,6 +604,8 @@ export function compareLogs(
   actual: ExpectedLogMessage[],
   entities: EntitiesMap
 ): void {
+  console.log('ACTUAL:', actual);
+  console.log('EXPECTED:', expected);
   expect(actual).to.have.lengthOf(expected.length);
 
   for (const [index, actualLog] of actual.entries()) {

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

@@ -317,6 +317,14 @@ export interface ExpectedSdamEvent {
   serverHeartbeatSucceededEvent?: {
     awaited?: boolean;
   };
+  topologyDescriptionChangedEvent?: {
+    previousDescription?: {
+      type?: string;
+    };
+    newDescription?: {
+      type?: string;
+    };
+  };
 }
 export interface StoreEventsAsEntity {
   id: string;

test/unit/index.test.ts

@@ -120,6 +120,10 @@ const EXPECTED_EXPORTS = [
   'ServerHeartbeatStartedEvent',
   'ServerHeartbeatSucceededEvent',
   'ServerOpeningEvent',
+  'ServerSelectionEvent',
+  'ServerSelectionStartedEvent',
+  'ServerSelectionFailedEvent',
+  'ServerSelectionSucceededEvent',
   'ServerType',
   'SrvPollingEvent',
   'Timestamp',
@@ -129,7 +133,8 @@ const EXPECTED_EXPORTS = [
   'TopologyType',
   'UnorderedBulkOperation',
   'UUID',
-  'WriteConcern'
+  'WriteConcern',
+  'WaitingForSuitableServerEvent'
 ];
 
 describe('mongodb entrypoint', () => {