Skip to content

Commit 25c099c

Browse files
durrandurran
authored
Merge branch 'main' into NODE-4970-deprecate-collstats
2 parents 144fc0d + aa4f5c0 commit 25c099c

20 files changed

+1433
-114
lines changed

‎src/cmap/command_monitoring_events.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
import type { Document, ObjectId } from '../bson';
2-
import { LEGACY_HELLO_COMMAND, LEGACY_HELLO_COMMAND_CAMEL_CASE } from '../constants';
2+
import {
3+
COMMAND_FAILED,
4+
COMMAND_STARTED,
5+
COMMAND_SUCCEEDED,
6+
LEGACY_HELLO_COMMAND,
7+
LEGACY_HELLO_COMMAND_CAMEL_CASE
8+
} from '../constants';
39
import { calculateDurationInMs, deepCopy } from '../utils';
410
import { Msg, WriteProtocolMessageType } from './commands';
511
import type { Connection } from './connection';
@@ -18,6 +24,8 @@ export class CommandStartedEvent {
1824
address: string;
1925
connectionId?: string | number;
2026
serviceId?: ObjectId;
27+
/** @internal */
28+
name = COMMAND_STARTED;
2129

2230
/**
2331
* Create a started event
@@ -65,6 +73,8 @@ export class CommandSucceededEvent {
6573
commandName: string;
6674
reply: unknown;
6775
serviceId?: ObjectId;
76+
/** @internal */
77+
name = COMMAND_SUCCEEDED;
6878

6979
/**
7080
* Create a succeeded event
@@ -113,6 +123,8 @@ export class CommandFailedEvent {
113123
commandName: string;
114124
failure: Error;
115125
serviceId?: ObjectId;
126+
/** @internal */
127+
name = COMMAND_FAILED;
116128

117129
/**
118130
* Create a failure event

‎src/cmap/connect.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,7 @@ function makeConnection(options: MakeConnectionOptions, _callback: Callback<Stre
401401

402402
if ('authorizationError' in socket) {
403403
if (socket.authorizationError && rejectUnauthorized) {
404+
// TODO(NODE-5192): wrap this with a MongoError subclass
404405
return callback(socket.authorizationError);
405406
}
406407
}

‎src/cmap/connection.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,9 @@ export interface ConnectionOptions
122122
credentials?: MongoCredentials;
123123
connectTimeoutMS?: number;
124124
tls: boolean;
125+
/** @deprecated - Will not be able to turn off in the future. */
125126
keepAlive?: boolean;
127+
/** @deprecated - Will not be configurable in the future. */
126128
keepAliveInitialDelay?: number;
127129
noDelay?: boolean;
128130
socketTimeoutMS?: number;

‎src/cmap/connection_pool.ts

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,10 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
641641
}
642642
}
643643

644-
private destroyConnection(connection: Connection, reason: string) {
644+
private destroyConnection(
645+
connection: Connection,
646+
reason: 'error' | 'idle' | 'stale' | 'poolClosed'
647+
) {
645648
this.emit(
646649
ConnectionPool.CONNECTION_CLOSED,
647650
new ConnectionClosedEvent(this, connection, reason)
@@ -701,7 +704,13 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
701704
this[kPending]--;
702705
this.emit(
703706
ConnectionPool.CONNECTION_CLOSED,
704-
new ConnectionClosedEvent(this, { id: connectOptions.id, serviceId: undefined }, 'error')
707+
new ConnectionClosedEvent(
708+
this,
709+
{ id: connectOptions.id, serviceId: undefined },
710+
'error',
711+
// TODO(NODE-5192): Remove this cast
712+
err as MongoError
713+
)
705714
);
706715
if (err instanceof MongoNetworkError || err instanceof MongoServerError) {
707716
err.connectionGeneration = connectOptions.generation;
@@ -812,7 +821,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
812821
const error = this.closed ? new PoolClosedError(this) : new PoolClearedError(this);
813822
this.emit(
814823
ConnectionPool.CONNECTION_CHECK_OUT_FAILED,
815-
new ConnectionCheckOutFailedEvent(this, reason)
824+
new ConnectionCheckOutFailedEvent(this, reason, error)
816825
);
817826
if (waitQueueMember.timer) {
818827
clearTimeout(waitQueueMember.timer);
@@ -865,7 +874,8 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
865874
if (err) {
866875
this.emit(
867876
ConnectionPool.CONNECTION_CHECK_OUT_FAILED,
868-
new ConnectionCheckOutFailedEvent(this, 'connectionError')
877+
// TODO(NODE-5192): Remove this cast
878+
new ConnectionCheckOutFailedEvent(this, 'connectionError', err as MongoError)
869879
);
870880
} else if (connection) {
871881
this[kCheckedOut].add(connection);

‎src/cmap/connection_pool_events.ts

Lines changed: 68 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
import type { ObjectId } from '../bson';
2-
import type { AnyError } from '../error';
2+
import {
3+
CONNECTION_CHECK_OUT_FAILED,
4+
CONNECTION_CHECK_OUT_STARTED,
5+
CONNECTION_CHECKED_IN,
6+
CONNECTION_CHECKED_OUT,
7+
CONNECTION_CLOSED,
8+
CONNECTION_CREATED,
9+
CONNECTION_POOL_CLEARED,
10+
CONNECTION_POOL_CLOSED,
11+
CONNECTION_POOL_CREATED,
12+
CONNECTION_POOL_READY,
13+
CONNECTION_READY
14+
} from '../constants';
15+
import type { MongoError } from '../error';
316
import type { Connection } from './connection';
417
import type { ConnectionPool, ConnectionPoolOptions } from './connection_pool';
518

@@ -8,11 +21,24 @@ import type { ConnectionPool, ConnectionPoolOptions } from './connection_pool';
821
* @public
922
* @category Event
1023
*/
11-
export class ConnectionPoolMonitoringEvent {
24+
export abstract class ConnectionPoolMonitoringEvent {
1225
/** A timestamp when the event was created */
1326
time: Date;
1427
/** The address (host/port pair) of the pool */
1528
address: string;
29+
/** @internal */
30+
abstract name:
31+
| typeof CONNECTION_CHECK_OUT_FAILED
32+
| typeof CONNECTION_CHECK_OUT_STARTED
33+
| typeof CONNECTION_CHECKED_IN
34+
| typeof CONNECTION_CHECKED_OUT
35+
| typeof CONNECTION_CLOSED
36+
| typeof CONNECTION_CREATED
37+
| typeof CONNECTION_POOL_CLEARED
38+
| typeof CONNECTION_POOL_CLOSED
39+
| typeof CONNECTION_POOL_CREATED
40+
| typeof CONNECTION_POOL_READY
41+
| typeof CONNECTION_READY;
1642

1743
/** @internal */
1844
constructor(pool: ConnectionPool) {
@@ -29,6 +55,8 @@ export class ConnectionPoolMonitoringEvent {
2955
export class ConnectionPoolCreatedEvent extends ConnectionPoolMonitoringEvent {
3056
/** The options used to create this connection pool */
3157
options?: ConnectionPoolOptions;
58+
/** @internal */
59+
name = CONNECTION_POOL_CREATED;
3260

3361
/** @internal */
3462
constructor(pool: ConnectionPool) {
@@ -43,6 +71,9 @@ export class ConnectionPoolCreatedEvent extends ConnectionPoolMonitoringEvent {
4371
* @category Event
4472
*/
4573
export class ConnectionPoolReadyEvent extends ConnectionPoolMonitoringEvent {
74+
/** @internal */
75+
name = CONNECTION_POOL_READY;
76+
4677
/** @internal */
4778
constructor(pool: ConnectionPool) {
4879
super(pool);
@@ -55,6 +86,9 @@ export class ConnectionPoolReadyEvent extends ConnectionPoolMonitoringEvent {
5586
* @category Event
5687
*/
5788
export class ConnectionPoolClosedEvent extends ConnectionPoolMonitoringEvent {
89+
/** @internal */
90+
name = CONNECTION_POOL_CLOSED;
91+
5892
/** @internal */
5993
constructor(pool: ConnectionPool) {
6094
super(pool);
@@ -69,6 +103,8 @@ export class ConnectionPoolClosedEvent extends ConnectionPoolMonitoringEvent {
69103
export class ConnectionCreatedEvent extends ConnectionPoolMonitoringEvent {
70104
/** A monotonically increasing, per-pool id for the newly created connection */
71105
connectionId: number | '<monitor>';
106+
/** @internal */
107+
name = CONNECTION_CREATED;
72108

73109
/** @internal */
74110
constructor(pool: ConnectionPool, connection: { id: number | '<monitor>' }) {
@@ -85,6 +121,8 @@ export class ConnectionCreatedEvent extends ConnectionPoolMonitoringEvent {
85121
export class ConnectionReadyEvent extends ConnectionPoolMonitoringEvent {
86122
/** The id of the connection */
87123
connectionId: number | '<monitor>';
124+
/** @internal */
125+
name = CONNECTION_READY;
88126

89127
/** @internal */
90128
constructor(pool: ConnectionPool, connection: Connection) {
@@ -104,17 +142,23 @@ export class ConnectionClosedEvent extends ConnectionPoolMonitoringEvent {
104142
/** The reason the connection was closed */
105143
reason: string;
106144
serviceId?: ObjectId;
145+
/** @internal */
146+
name = CONNECTION_CLOSED;
147+
/** @internal */
148+
error: MongoError | null;
107149

108150
/** @internal */
109151
constructor(
110152
pool: ConnectionPool,
111153
connection: Pick<Connection, 'id' | 'serviceId'>,
112-
reason: string
154+
reason: 'idle' | 'stale' | 'poolClosed' | 'error',
155+
error?: MongoError
113156
) {
114157
super(pool);
115158
this.connectionId = connection.id;
116-
this.reason = reason || 'unknown';
159+
this.reason = reason;
117160
this.serviceId = connection.serviceId;
161+
this.error = error ?? null;
118162
}
119163
}
120164

@@ -124,6 +168,9 @@ export class ConnectionClosedEvent extends ConnectionPoolMonitoringEvent {
124168
* @category Event
125169
*/
126170
export class ConnectionCheckOutStartedEvent extends ConnectionPoolMonitoringEvent {
171+
/** @internal */
172+
name = CONNECTION_CHECK_OUT_STARTED;
173+
127174
/** @internal */
128175
constructor(pool: ConnectionPool) {
129176
super(pool);
@@ -137,12 +184,21 @@ export class ConnectionCheckOutStartedEvent extends ConnectionPoolMonitoringEven
137184
*/
138185
export class ConnectionCheckOutFailedEvent extends ConnectionPoolMonitoringEvent {
139186
/** The reason the attempt to check out failed */
140-
reason: AnyError | string;
187+
reason: string;
188+
/** @internal */
189+
error?: MongoError;
190+
/** @internal */
191+
name = CONNECTION_CHECK_OUT_FAILED;
141192

142193
/** @internal */
143-
constructor(pool: ConnectionPool, reason: AnyError | string) {
194+
constructor(
195+
pool: ConnectionPool,
196+
reason: 'poolClosed' | 'timeout' | 'connectionError',
197+
error?: MongoError
198+
) {
144199
super(pool);
145200
this.reason = reason;
201+
this.error = error;
146202
}
147203
}
148204

@@ -154,6 +210,8 @@ export class ConnectionCheckOutFailedEvent extends ConnectionPoolMonitoringEvent
154210
export class ConnectionCheckedOutEvent extends ConnectionPoolMonitoringEvent {
155211
/** The id of the connection */
156212
connectionId: number | '<monitor>';
213+
/** @internal */
214+
name = CONNECTION_CHECKED_OUT;
157215

158216
/** @internal */
159217
constructor(pool: ConnectionPool, connection: Connection) {
@@ -170,6 +228,8 @@ export class ConnectionCheckedOutEvent extends ConnectionPoolMonitoringEvent {
170228
export class ConnectionCheckedInEvent extends ConnectionPoolMonitoringEvent {
171229
/** The id of the connection */
172230
connectionId: number | '<monitor>';
231+
/** @internal */
232+
name = CONNECTION_CHECKED_IN;
173233

174234
/** @internal */
175235
constructor(pool: ConnectionPool, connection: Connection) {
@@ -188,6 +248,8 @@ export class ConnectionPoolClearedEvent extends ConnectionPoolMonitoringEvent {
188248
serviceId?: ObjectId;
189249

190250
interruptInUseConnections?: boolean;
251+
/** @internal */
252+
name = CONNECTION_POOL_CLEARED;
191253

192254
/** @internal */
193255
constructor(

‎src/cmap/handshake/client_metadata.ts

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMe
116116
);
117117
}
118118

119-
const platformInfo =
120-
platform.length > 0
121-
? `Node.js ${process.version}, ${os.endianness()}|${platform}`
122-
: `Node.js ${process.version}, ${os.endianness()}`;
119+
let runtimeInfo = getRuntimeInfo();
120+
if (platform.length > 0) {
121+
runtimeInfo = `${runtimeInfo}|${platform}`;
122+
}
123123

124-
if (!metadataDocument.ifItFitsItSits('platform', platformInfo)) {
124+
if (!metadataDocument.ifItFitsItSits('platform', runtimeInfo)) {
125125
throw new MongoInvalidArgumentError(
126126
'Unable to include driverInfo platform, metadata cannot exceed 512 bytes'
127127
);
@@ -234,3 +234,39 @@ export function getFAASEnv(): Map<string, string | Int32> | null {
234234

235235
return null;
236236
}
237+
238+
/**
239+
* @internal
240+
* This type represents the global Deno object and the minimal type contract we expect it to satisfy.
241+
*/
242+
declare const Deno: { version?: { deno?: string } } | undefined;
243+
244+
/**
245+
* @internal
246+
* This type represents the global Bun object and the minimal type contract we expect it to satisfy.
247+
*/
248+
declare const Bun: { (): void; version?: string } | undefined;
249+
250+
/**
251+
* @internal
252+
* Get current JavaScript runtime platform
253+
*
254+
* NOTE: The version information fetching is intentionally written defensively
255+
* to avoid having a released driver version that becomes incompatible
256+
* with a future change to these global objects.
257+
*/
258+
function getRuntimeInfo(): string {
259+
if ('Deno' in globalThis) {
260+
const version = typeof Deno?.version?.deno === 'string' ? Deno?.version?.deno : '0.0.0-unknown';
261+
262+
return `Deno v${version}, ${os.endianness()}`;
263+
}
264+
265+
if ('Bun' in globalThis) {
266+
const version = typeof Bun?.version === 'string' ? Bun?.version : '0.0.0-unknown';
267+
268+
return `Bun v${version}, ${os.endianness()}`;
269+
}
270+
271+
return `Node.js ${process.version}, ${os.endianness()}`;
272+
}

‎src/collection.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ export class Collection<TSchema extends Document = Document> {
334334
filter: Filter<TSchema>,
335335
update: UpdateFilter<TSchema> | Partial<TSchema>,
336336
options?: UpdateOptions
337-
): Promise<UpdateResult> {
337+
): Promise<UpdateResult<TSchema>> {
338338
return executeOperation(
339339
this.s.db.s.client,
340340
new UpdateOneOperation(
@@ -357,7 +357,7 @@ export class Collection<TSchema extends Document = Document> {
357357
filter: Filter<TSchema>,
358358
replacement: WithoutId<TSchema>,
359359
options?: ReplaceOptions
360-
): Promise<UpdateResult | Document> {
360+
): Promise<UpdateResult<TSchema> | Document> {
361361
return executeOperation(
362362
this.s.db.s.client,
363363
new ReplaceOneOperation(
@@ -380,7 +380,7 @@ export class Collection<TSchema extends Document = Document> {
380380
filter: Filter<TSchema>,
381381
update: UpdateFilter<TSchema>,
382382
options?: UpdateOptions
383-
): Promise<UpdateResult> {
383+
): Promise<UpdateResult<TSchema>> {
384384
return executeOperation(
385385
this.s.db.s.client,
386386
new UpdateManyOperation(

‎src/connection_string.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -852,11 +852,13 @@ export const OPTIONS = {
852852
},
853853
keepAlive: {
854854
default: true,
855-
type: 'boolean'
855+
type: 'boolean',
856+
deprecated: 'Will not be able to turn off in the future.'
856857
},
857858
keepAliveInitialDelay: {
858859
default: 120000,
859-
type: 'uint'
860+
type: 'uint',
861+
deprecated: 'Will not be configurable in the future.'
860862
},
861863
loadBalanced: {
862864
default: false,
@@ -1278,5 +1280,6 @@ export const DEFAULT_OPTIONS = new CaseInsensitiveMap(
12781280
*/
12791281
export const FEATURE_FLAGS = new Set([
12801282
Symbol.for('@@mdb.skipPingOnConnect'),
1281-
Symbol.for('@@mdb.enableMongoLogger')
1283+
Symbol.for('@@mdb.enableMongoLogger'),
1284+
Symbol.for('@@mdb.internalLoggerConfig')
12821285
]);

0 commit comments

Comments
 (0)