import { AssertionError, expect } from 'chai'; import { EventEmitter } from 'events'; import * as process from 'process'; import { setImmediate } from 'timers'; import { AbstractCursor, ChangeStream, ClientEncryption, ClientSession, type ClusterTime, Collection, type CommandFailedEvent, type CommandStartedEvent, type CommandSucceededEvent, type ConnectionCheckedInEvent, type ConnectionCheckedOutEvent, type ConnectionCheckOutFailedEvent, type ConnectionCheckOutStartedEvent, type ConnectionClosedEvent, type ConnectionCreatedEvent, type ConnectionPool, type ConnectionPoolClearedEvent, type ConnectionPoolClosedEvent, type ConnectionPoolCreatedEvent, type ConnectionPoolReadyEvent, type ConnectionReadyEvent, Db, type Document, GridFSBucket, type HostAddress, type Log, MongoClient, type MongoClientOptions, type MongoCredentials, ReadConcern, ReadPreference, SENSITIVE_COMMANDS, type ServerClosedEvent, type ServerDescriptionChangedEvent, type ServerHeartbeatFailedEvent, type ServerHeartbeatStartedEvent, type ServerHeartbeatSucceededEvent, type ServerOpeningEvent, Timeout, TimeoutError, type TopologyClosedEvent, type TopologyDescription, type TopologyDescriptionChangedEvent, type TopologyOpeningEvent, WriteConcern } from '../../mongodb'; import { getEncryptExtraOptions, getEnvironmentalOptions } from '../../tools/utils'; import { AlpineTestConfiguration, type TestConfiguration } from '../runner/config'; import { EntityEventRegistry } from './entity_event_registry'; import { trace } from './runner'; import type { ClientEntity, EntityDescription, ExpectedLogMessage } from './schema'; import { createClientEncryption, getCSFLETestDataFromEnvironment, makeConnectionString, mergeKMSProviders, patchCollectionOptions, patchDbOptions } from './unified-utils'; export interface UnifiedChangeStream extends ChangeStream { eventCollector: InstanceType<(typeof import('../../tools/utils'))['EventCollector']>; } export class UnifiedThread { // Every function queued will have a catch handler attached to it, which will prevent `await this.#promise` from throwing // The potential error thrown by the functionToQueue can still be inspected on the `this.#error` property #promise: Promise; #error: Error | null = null; #killed = false; id: string; constructor(id) { this.id = id; this.#promise = Promise.resolve(); } queue(functionToQueue: () => Promise) { if (this.#killed || this.#error) { return; } this.#promise = this.#promise.then(functionToQueue).catch(e => (this.#error = e)); } async finish() { this.#killed = true; await this.#promise; if (this.#error) { this.#error.message = `: ${this.#error.message}`; throw this.#error; } } } export type CommandEvent = CommandStartedEvent | CommandSucceededEvent | CommandFailedEvent; export type CmapEvent = | ConnectionPoolCreatedEvent | ConnectionPoolClosedEvent | ConnectionPoolReadyEvent | ConnectionCreatedEvent | ConnectionReadyEvent | ConnectionClosedEvent | ConnectionCheckOutStartedEvent | ConnectionCheckOutFailedEvent | ConnectionCheckedOutEvent | ConnectionCheckedInEvent | ConnectionPoolClearedEvent; export type SdamEvent = | ServerDescriptionChangedEvent | ServerHeartbeatStartedEvent | ServerHeartbeatFailedEvent | ServerHeartbeatSucceededEvent | TopologyOpeningEvent | TopologyDescriptionChangedEvent | TopologyClosedEvent | ServerOpeningEvent | ServerClosedEvent; export type LogMessage = Omit; function getClient(address) { return new MongoClient(`mongodb://${address}`, getEnvironmentalOptions()); } export class UnifiedMongoClient extends MongoClient { commandEvents: CommandEvent[] = []; cmapEvents: CmapEvent[] = []; sdamEvents: SdamEvent[] = []; failPoints: Document[] = []; logCollector?: { buffer: LogMessage[]; write: (log: Log) => void }; ignoredEvents: string[]; observeSensitiveCommands: boolean; observedCommandEvents: ('commandStarted' | 'commandSucceeded' | 'commandFailed')[]; observedCmapEvents: ( | 'connectionPoolCreated' | 'connectionPoolClosed' | 'connectionPoolReady' | 'connectionPoolCleared' | 'connectionCreated' | 'connectionReady' | 'connectionClosed' | 'connectionCheckOutStarted' | 'connectionCheckOutFailed' | 'connectionCheckedOut' | 'connectionCheckedIn' )[]; observedSdamEvents: ( | 'serverDescriptionChanged' | 'serverHeartbeatStarted' | 'serverHeartbeatFailed' | 'serverHeartbeatSucceeded' | 'serverOpened' | 'serverClosed' | 'topologyOpened' | 'topologyClosed' | 'topologyDescriptionChangedEvent' )[]; observedEventEmitter = new EventEmitter(); _credentials: MongoCredentials | null; static COMMAND_EVENT_NAME_LOOKUP = { commandStartedEvent: 'commandStarted', commandSucceededEvent: 'commandSucceeded', commandFailedEvent: 'commandFailed' } as const; static CMAP_EVENT_NAME_LOOKUP = { poolCreatedEvent: 'connectionPoolCreated', poolClosedEvent: 'connectionPoolClosed', poolReadyEvent: 'connectionPoolReady', poolClearedEvent: 'connectionPoolCleared', connectionCreatedEvent: 'connectionCreated', connectionReadyEvent: 'connectionReady', connectionClosedEvent: 'connectionClosed', connectionCheckOutStartedEvent: 'connectionCheckOutStarted', connectionCheckOutFailedEvent: 'connectionCheckOutFailed', connectionCheckedOutEvent: 'connectionCheckedOut', connectionCheckedInEvent: 'connectionCheckedIn' } as const; static SDAM_EVENT_NAME_LOOKUP = { serverDescriptionChangedEvent: 'serverDescriptionChanged', serverHeartbeatStartedEvent: 'serverHeartbeatStarted', serverHeartbeatFailedEvent: 'serverHeartbeatFailed', serverHeartbeatSucceededEvent: 'serverHeartbeatSucceeded', serverOpeningEvent: 'serverOpening', serverClosedEvent: 'serverClosed', topologyOpeningEvent: 'topologyOpening', topologyClosedEvent: 'topologyClosed', topologyDescriptionChangedEvent: 'topologyDescriptionChanged' } as const; static LOGGING_COMPONENT_TO_ENV_VAR_NAME = { command: 'MONGODB_LOG_COMMAND', serverSelection: 'MONGODB_LOG_SERVER_SELECTION', connection: 'MONGODB_LOG_CONNECTION', topology: 'MONGODB_LOG_TOPOLOGY' } as const; constructor(uri: string, description: ClientEntity, config: TestConfiguration) { const options: MongoClientOptions = { monitorCommands: true, __skipPingOnConnect: true, ...getEnvironmentalOptions(), ...(description.serverApi ? { serverApi: description.serverApi } : {}), // TODO(NODE-5785): We need to increase the truncation length because signature.hash is a Buffer making hellos too long mongodbLogMaxDocumentLength: 1500 }; let logCollector: { buffer: LogMessage[]; write: (log: Log) => void } | undefined; if (description.observeLogMessages != null) { options.mongodbLogComponentSeverities = description.observeLogMessages; logCollector = { buffer: [], write(log: Log): void { const transformedLog = { level: log.s, component: log.c, data: { ...log } }; this.buffer.push(transformedLog); } }; options.mongodbLogPath = logCollector; } else if (config.loggingEnabled) { config.setupLogging?.(options, description.id); } if (description.autoEncryptOpts) { const { kmsProviders: kmsProvidersFromEnvironment } = getCSFLETestDataFromEnvironment( process.env ); let extraOptions = {}; if (config instanceof AlpineTestConfiguration) { extraOptions = { ...config.encryptDefaultExtraOptions, ...description.autoEncryptOpts.extraOptions }; } else if (getEncryptExtraOptions().cryptSharedLibPath != null) { extraOptions = { cryptSharedLibPath: getEncryptExtraOptions().cryptSharedLibPath, ...description.autoEncryptOpts.extraOptions }; } const kmsProviders = mergeKMSProviders( description.autoEncryptOpts.kmsProviders, kmsProvidersFromEnvironment ); options.autoEncryption = { ...description.autoEncryptOpts, kmsProviders, extraOptions }; } super(uri, options); this.observedEventEmitter.on('error', () => null); this.logCollector = logCollector; this.observeSensitiveCommands = description.observeSensitiveCommands ?? false; this.ignoredEvents = [ ...(description.ignoreCommandMonitoringEvents ?? []), 'configureFailPoint' ]; if (!this.observeSensitiveCommands) { this.ignoredEvents.push(...Array.from(SENSITIVE_COMMANDS)); } this.observedCommandEvents = (description.observeEvents ?? []) .map(e => UnifiedMongoClient.COMMAND_EVENT_NAME_LOOKUP[e]) .filter(e => !!e); this.observedCmapEvents = (description.observeEvents ?? []) .map(e => UnifiedMongoClient.CMAP_EVENT_NAME_LOOKUP[e]) .filter(e => !!e); this.observedSdamEvents = (description.observeEvents ?? []) .map(e => UnifiedMongoClient.SDAM_EVENT_NAME_LOOKUP[e]) .filter(e => !!e); for (const eventName of this.observedCommandEvents) { this.on(eventName, this.pushCommandEvent); } for (const eventName of this.observedCmapEvents) { this.on(eventName, this.pushCmapEvent); } for (const eventName of this.observedSdamEvents) { this.on(eventName, this.pushSdamEvent); } } // If the command or reply included a speculativeAuthenticate field, // they will be already have redacted in maybeRedact() // See src/cmap/command_monitoring_events.ts // We can infer that the command was sensitive if its command or reply is an empty object. isSensitiveCommand(e: CommandEvent): boolean { if ( (e.name === 'commandStarted' && typeof e.command === 'object' && !Object.keys(e.command).length) || (e.name === 'commandSucceeded' && typeof e.reply === 'object' && (e.reply === null || !Object.keys(e.reply).length)) ) { return true; } return false; } isIgnored(e: CommandEvent): boolean { return this.ignoredEvents.includes(e.commandName); } getCapturedEvents( eventType: 'command' | 'cmap' | 'sdam' ): CommandEvent[] | CmapEvent[] | SdamEvent[]; getCapturedEvents(eventType: 'all'): (CommandEvent | CmapEvent | SdamEvent)[]; getCapturedEvents( eventType: 'command' | 'cmap' | 'sdam' | 'all' ): (CommandEvent | CmapEvent | SdamEvent)[] { switch (eventType) { case 'command': return this.commandEvents; case 'cmap': return this.cmapEvents; case 'sdam': return this.sdamEvents; case 'all': return [...this.commandEvents, ...this.cmapEvents, ...this.sdamEvents]; default: throw new AssertionError(`Unknown eventType: ${eventType}`); } } // NOTE: pushCommandEvent must be an arrow function pushCommandEvent: (e: CommandEvent) => void = e => { if ( (this.observeSensitiveCommands === true || !this.isSensitiveCommand(e)) && !this.isIgnored(e) ) { this.commandEvents.push(e); this.observedEventEmitter.emit('observedEvent'); } }; // NOTE: pushCmapEvent must be an arrow function pushCmapEvent: (e: CmapEvent) => void = e => { this.cmapEvents.push(e); this.observedEventEmitter.emit('observedEvent'); }; // NOTE: pushSdamEvent must be an arrow function pushSdamEvent: (e: SdamEvent) => void = e => { this.sdamEvents.push(e); this.observedEventEmitter.emit('observedEvent'); }; /** Disables command monitoring for the client and returns a list of the captured events. */ stopCapturingEvents(): void { for (const eventName of this.observedCommandEvents) { this.off(eventName, this.pushCommandEvent); } for (const eventName of this.observedCmapEvents) { this.off(eventName, this.pushCmapEvent); } for (const eventName of this.observedSdamEvents) { this.off(eventName, this.pushSdamEvent); } } get collectedLogs(): LogMessage[] { return this.logCollector?.buffer ?? []; } } export class FailPointMap extends Map { constructor() { super(); } async enableFailPoint( addressOrClient: string | HostAddress | UnifiedMongoClient, failPoint: Document ): Promise { let client: MongoClient; let address: string; if (addressOrClient instanceof MongoClient) { client = addressOrClient; address = client.topology?.s.seedlist.join(','); if (client.topology?.s.credentials) { if ( client.topology.s.credentials.mechanism === 'DEFAULT' || client.topology.s.credentials.mechanism.startsWith('SCRAM') ) { address = `${client.topology.s.credentials.username}:${client.topology.s.credentials.password}@${address}`; } } } else { // create a new client address = addressOrClient.toString(); client = getClient(address); try { await client.connect(); } catch (error) { console.error(`failed to connect enableFailPoint ${address}`); throw error; } } const admin = client.db('admin'); const result = await admin.command(failPoint); if (!(addressOrClient instanceof MongoClient)) { // we created this client await client.close(); } expect(result).to.have.property('ok', 1); this.set(address, failPoint.configureFailPoint); return result; } async disableFailPoints(): Promise { const entries = Array.from(this.entries()); await Promise.all( entries.map(async ([hostAddress, configureFailPoint]) => { if (process.env.LOAD_BALANCER) { hostAddress += '?loadBalanced=true'; } const client = getClient(hostAddress); try { await client.connect(); } catch (error) { console.error(`failed to connect disableFailPoints ${hostAddress}`); throw error; } const admin = client.db('admin'); const result = await admin.command({ configureFailPoint, mode: 'off' }); expect(result).to.have.property('ok', 1); await client.close(); }) ); } } export type Entity = | UnifiedMongoClient | Db | Collection | ClientSession | AbstractCursor | UnifiedChangeStream | GridFSBucket | Document | ClientEncryption | TopologyDescription // From recordTopologyDescription operation | number; export type EntityCtor = | typeof UnifiedMongoClient | typeof Db | typeof Collection | typeof ClientSession | typeof ChangeStream | typeof AbstractCursor | typeof GridFSBucket | typeof UnifiedThread | typeof ClientEncryption; export type EntityTypeId = | 'client' | 'db' | 'collection' | 'session' | 'bucket' | 'thread' | 'cursor' | 'stream' | 'clientEncryption' | 'errors' | 'failures' | 'events' | 'iterations' | 'successes'; const ENTITY_CTORS = new Map(); ENTITY_CTORS.set('client', UnifiedMongoClient); ENTITY_CTORS.set('db', Db); ENTITY_CTORS.set('clientEncryption', ClientEncryption); ENTITY_CTORS.set('collection', Collection); ENTITY_CTORS.set('session', ClientSession); ENTITY_CTORS.set('bucket', GridFSBucket); ENTITY_CTORS.set('thread', UnifiedThread); ENTITY_CTORS.set('cursor', AbstractCursor); ENTITY_CTORS.set('stream', ChangeStream); const NO_INSTANCE_CHECK = ['errors', 'failures', 'events', 'successes', 'iterations']; export class EntitiesMap extends Map { failPoints: FailPointMap; constructor(entries?: readonly (readonly [string, E])[] | null) { super(entries); this.failPoints = new FailPointMap(); } mapOf(type: 'client'): EntitiesMap; mapOf(type: 'db'): EntitiesMap; mapOf(type: 'collection'): EntitiesMap; mapOf(type: 'session'): EntitiesMap; mapOf(type: 'bucket'): EntitiesMap; mapOf(type: 'cursor'): EntitiesMap; mapOf(type: 'stream'): EntitiesMap; mapOf(type: 'clientEncryption'): EntitiesMap; mapOf(type: EntityTypeId): EntitiesMap { const ctor = ENTITY_CTORS.get(type); if (!ctor) { throw new AssertionError(`Unknown type ${type}`); } return new EntitiesMap(Array.from(this.entries()).filter(([, e]) => e instanceof ctor)); } getChangeStreamOrCursor(key: string): UnifiedChangeStream | AbstractCursor { try { const cs = this.getEntity('stream', key); return cs; } catch { const cursor = this.getEntity('cursor', key); return cursor; } } getEntity(type: 'client', key: string, assertExists?: boolean): UnifiedMongoClient; getEntity(type: 'db', key: string, assertExists?: boolean): Db; getEntity(type: 'collection', key: string, assertExists?: boolean): Collection; getEntity(type: 'session', key: string, assertExists?: boolean): ClientSession; getEntity(type: 'bucket', key: string, assertExists?: boolean): GridFSBucket; getEntity(type: 'thread', key: string, assertExists?: boolean): UnifiedThread; getEntity(type: 'cursor', key: string, assertExists?: boolean): AbstractCursor; getEntity(type: 'stream', key: string, assertExists?: boolean): UnifiedChangeStream; getEntity(type: 'iterations', key: string, assertExists?: boolean): number; getEntity(type: 'successes', key: string, assertExists?: boolean): number; getEntity(type: 'errors', key: string, assertExists?: boolean): Document[]; getEntity(type: 'failures', key: string, assertExists?: boolean): Document[]; getEntity(type: 'events', key: string, assertExists?: boolean): Document[]; getEntity(type: 'clientEncryption', key: string, assertExists?: boolean): ClientEncryption; getEntity(type: EntityTypeId, key: string, assertExists = true): Entity | undefined { const entity = this.get(key); if (!entity) { if (assertExists) throw new AssertionError(`Entity '${key}' does not exist`); return undefined; } if (NO_INSTANCE_CHECK.includes(type)) { // Skip constructor checks for interfaces. return entity; } const ctor = ENTITY_CTORS.get(type); if (!ctor) { throw new AssertionError(`Unknown type ${type}`); } if (!(entity instanceof ctor)) { throw new AssertionError(`${key} is not an instance of ${type}`); } return entity; } async cleanup(): Promise { await this.failPoints.disableFailPoints(); trace('closeCursors'); for (const [, cursor] of this.mapOf('cursor')) { await cursor.close(); } trace('closeStreams'); for (const [, stream] of this.mapOf('stream')) { await stream.close(); } trace('endSessions'); for (const [, session] of this.mapOf('session')) { await session.endSession({ force: true }); } trace('closeClient'); for (const [, client] of this.mapOf('client')) { await client.close(); } trace('clear'); this.clear(); } static async createEntities( config: TestConfiguration, clusterTime: ClusterTime | null, entities?: EntityDescription[], entityMap?: EntitiesMap ): Promise { const map = entityMap ?? new EntitiesMap(); for (const entity of entities ?? []) { if ('client' in entity) { const useMultipleMongoses = (config.topologyType === 'LoadBalanced' || config.topologyType === 'Sharded') && entity.client.useMultipleMongoses; let uri: string; // For OIDC we need to ensure we use MONGODB_URI_SINGLE for the MongoClient. if (process.env.MONGODB_URI_SINGLE?.includes('MONGODB-OIDC')) { uri = makeConnectionString(process.env.MONGODB_URI_SINGLE, entity.client.uriOptions); } else { uri = makeConnectionString(config.url({ useMultipleMongoses }), entity.client.uriOptions); } const client = new UnifiedMongoClient(uri, entity.client, config); try { new EntityEventRegistry(client, entity.client, map).register(); await client.connect(); if (entity.client.awaitMinPoolSizeMS) { if (client.topology?.s?.servers) { const timeout = Timeout.expires(entity.client.awaitMinPoolSizeMS); const servers = Array.from(client.topology.s.servers.values()).filter( ({ description: { isDataBearing } }) => isDataBearing ); const poolSizeChecks = servers.map(server => checkMinPoolSize(server.pool)); try { await Promise.race([Promise.allSettled(poolSizeChecks), timeout]); } catch (error) { if (TimeoutError.is(error)) { throw new AssertionError( `Timed out waiting for min pool size to be populated within ${entity.client.awaitMinPoolSizeMS}ms` ); } throw error; } finally { timeout.clear(); } } } } catch (error) { console.error('failed to connect entity', entity); // In the case where multiple clients are defined in the test and any one of them failed // to connect, but others did succeed, we need to ensure all open clients are closed. const clients = map.mapOf('client'); for (const clientEntry of clients.values()) { await clientEntry.close(); } throw error; } map.set(entity.client.id, client); } else if ('database' in entity) { const client = map.getEntity('client', entity.database.client); const db = client.db( entity.database.databaseName, patchDbOptions(entity.database.databaseOptions) ); map.set(entity.database.id, db); } else if ('collection' in entity) { const db = map.getEntity('db', entity.collection.database); const collection = db.collection( entity.collection.collectionName, patchCollectionOptions(entity.collection.collectionOptions) ); map.set(entity.collection.id, collection); } else if ('session' in entity) { const client = map.getEntity('client', entity.session.client); const options = Object.create(null); if (entity.session.sessionOptions?.defaultTimeoutMS != null) { options.defaultTimeoutMS = entity.session.sessionOptions?.defaultTimeoutMS; } if (entity.session.sessionOptions?.causalConsistency) { options.causalConsistency = entity.session.sessionOptions?.causalConsistency; } if (entity.session.sessionOptions?.snapshot) { options.snapshot = entity.session.sessionOptions.snapshot; } if (entity.session.sessionOptions?.defaultTransactionOptions) { options.defaultTransactionOptions = Object.create(null); const defaultOptions = entity.session.sessionOptions.defaultTransactionOptions; if (defaultOptions.readConcern) { options.defaultTransactionOptions.readConcern = ReadConcern.fromOptions( defaultOptions.readConcern ); } if (defaultOptions.writeConcern) { options.defaultTransactionOptions.writeConcern = WriteConcern.fromOptions(defaultOptions); } if (defaultOptions.readPreference) { options.defaultTransactionOptions.readPreference = ReadPreference.fromOptions(defaultOptions); } if (typeof defaultOptions.maxCommitTimeMS === 'number') { options.defaultTransactionOptions.maxCommitTimeMS = defaultOptions.maxCommitTimeMS; } } const session = client.startSession(options); // Advance the session cluster time. See DRIVERS-2816. if (clusterTime) { session.advanceClusterTime(clusterTime); } map.set(entity.session.id, session); } else if ('bucket' in entity) { const db = map.getEntity('db', entity.bucket.database); const options = Object.create(null); if (entity.bucket.bucketOptions?.bucketName) { options.bucketName = entity.bucket.bucketOptions?.bucketName; } if (entity.bucket.bucketOptions?.chunkSizeBytes) { options.chunkSizeBytes = entity.bucket.bucketOptions?.chunkSizeBytes; } if (entity.bucket.bucketOptions?.readPreference) { options.readPreference = entity.bucket.bucketOptions?.readPreference; } map.set(entity.bucket.id, new GridFSBucket(db, options)); } else if ('thread' in entity) { map.set(entity.thread.id, new UnifiedThread(entity.thread.id)); } else if ('stream' in entity) { throw new AssertionError(`Unsupported Entity ${JSON.stringify(entity)}`); } else if ('clientEncryption' in entity) { const clientEncryption = await createClientEncryption(map, entity.clientEncryption); map.set(entity.clientEncryption.id, clientEncryption); } else { throw new AssertionError(`Unsupported Entity ${JSON.stringify(entity)}`); } } return map; } } function checkMinPoolSize(pool: ConnectionPool): Promise { return new Promise(resolve => { const checkSize = () => { if (pool.totalConnectionCount >= pool.options.minPoolSize) { resolve(true); } else { setImmediate(checkSize); } }; checkSize(); }); }