Skip to content

Commit ee41447

Browse files
dariakpdariakp
authored
feat(NODE-3750): make maxConnecting configurable (mongodb#3261)
1 parent f1887bf commit ee41447

File tree

10 files changed

+195
-6
lines changed

10 files changed

+195
-6
lines changed

‎src/cmap/connection_pool.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ export interface ConnectionPoolOptions extends Omit<ConnectionOptions, 'id' | 'g
6767
maxPoolSize: number;
6868
/** The minimum number of connections that MUST exist at any moment in a single connection pool. */
6969
minPoolSize: number;
70+
/** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
71+
maxConnecting: number;
7072
/** The maximum amount of time a connection should remain idle in the connection pool before being marked idle. */
7173
maxIdleTimeMS: number;
7274
/** The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit. */
@@ -107,7 +109,7 @@ export type ConnectionPoolEvents = {
107109
*/
108110
export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
109111
closed: boolean;
110-
options: Readonly<ConnectionPoolOptions & { maxConnecting: number }>;
112+
options: Readonly<ConnectionPoolOptions>;
111113
/** @internal */
112114
[kLogger]: Logger;
113115
/** @internal */
@@ -199,7 +201,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
199201
connectionType: Connection,
200202
maxPoolSize: options.maxPoolSize ?? 100,
201203
minPoolSize: options.minPoolSize ?? 0,
202-
maxConnecting: 2,
204+
maxConnecting: options.maxConnecting ?? 2,
203205
maxIdleTimeMS: options.maxIdleTimeMS ?? 0,
204206
waitQueueTimeoutMS: options.waitQueueTimeoutMS ?? 0,
205207
autoEncrypter: options.autoEncrypter,

‎src/connection_string.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -856,6 +856,16 @@ export const OPTIONS = {
856856
return new Logger('MongoClient', { loggerLevel: value as LoggerLevel });
857857
}
858858
},
859+
maxConnecting: {
860+
default: 2,
861+
transform({ name, values: [value] }): number {
862+
const maxConnecting = getUint(name, value);
863+
if (maxConnecting === 0) {
864+
throw new MongoInvalidArgumentError('maxConnecting must be > 0 if specified');
865+
}
866+
return maxConnecting;
867+
}
868+
},
859869
maxIdleTimeMS: {
860870
default: 0,
861871
type: 'uint'

‎src/mongo_client.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
141141
maxPoolSize?: number;
142142
/** The minimum number of connections in the connection pool. */
143143
minPoolSize?: number;
144+
/** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
145+
maxConnecting?: number;
144146
/** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
145147
maxIdleTimeMS?: number;
146148
/** The maximum time in milliseconds that a thread can wait for a connection to become available. */
@@ -652,6 +654,7 @@ export interface MongoOptions
652654
| 'keepAliveInitialDelay'
653655
| 'localThresholdMS'
654656
| 'logger'
657+
| 'maxConnecting'
655658
| 'maxIdleTimeMS'
656659
| 'maxPoolSize'
657660
| 'minPoolSize'

‎test/spec/connection-monitoring-and-pooling/pool-checkout-custom-maxConnecting-is-enforced.json‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"version": 1,
3+
"style": "integration",
4+
"description": "custom maxConnecting is enforced",
5+
"runOn": [
6+
{
7+
"minServerVersion": "4.4.0"
8+
}
9+
],
10+
"failPoint": {
11+
"configureFailPoint": "failCommand",
12+
"mode": "alwaysOn",
13+
"data": {
14+
"failCommands": [
15+
"isMaster",
16+
"hello"
17+
],
18+
"closeConnection": false,
19+
"blockConnection": true,
20+
"blockTimeMS": 500
21+
}
22+
},
23+
"poolOptions": {
24+
"maxConnecting": 1,
25+
"maxPoolSize": 2,
26+
"waitQueueTimeoutMS": 5000
27+
},
28+
"operations": [
29+
{
30+
"name": "ready"
31+
},
32+
{
33+
"name": "start",
34+
"target": "thread1"
35+
},
36+
{
37+
"name": "start",
38+
"target": "thread2"
39+
},
40+
{
41+
"name": "checkOut",
42+
"thread": "thread1"
43+
},
44+
{
45+
"name": "waitForEvent",
46+
"event": "ConnectionCreated",
47+
"count": 1
48+
},
49+
{
50+
"name": "checkOut",
51+
"thread": "thread2"
52+
},
53+
{
54+
"name": "waitForEvent",
55+
"event": "ConnectionReady",
56+
"count": 2
57+
}
58+
],
59+
"events": [
60+
{
61+
"type": "ConnectionCreated"
62+
},
63+
{
64+
"type": "ConnectionReady"
65+
},
66+
{
67+
"type": "ConnectionCreated"
68+
},
69+
{
70+
"type": "ConnectionReady"
71+
}
72+
],
73+
"ignore": [
74+
"ConnectionCheckOutStarted",
75+
"ConnectionCheckedIn",
76+
"ConnectionCheckedOut",
77+
"ConnectionClosed",
78+
"ConnectionPoolCreated",
79+
"ConnectionPoolReady"
80+
]
81+
}

‎test/spec/connection-monitoring-and-pooling/pool-checkout-custom-maxConnecting-is-enforced.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
version: 1
2+
style: integration
3+
description: custom maxConnecting is enforced
4+
runOn:
5+
-
6+
minServerVersion: "4.4.0"
7+
failPoint:
8+
configureFailPoint: failCommand
9+
mode: "alwaysOn"
10+
data:
11+
failCommands: ["isMaster","hello"]
12+
closeConnection: false
13+
blockConnection: true
14+
blockTimeMS: 500
15+
poolOptions:
16+
maxConnecting: 1
17+
# gives opportunity for the checkout in thread2 to establish a new connection, which it must not do until thread1 establishes one
18+
maxPoolSize: 2
19+
waitQueueTimeoutMS: 5000
20+
operations:
21+
- name: ready
22+
# thread1 exists to consume the single permit to open a connection,
23+
# so that thread2 would be blocked acquiring a permit, which results in ordering its ConnectionCreated event after
24+
# the ConnectionReady event from thread1.
25+
- name: start
26+
target: thread1
27+
- name: start
28+
target: thread2
29+
- name: checkOut
30+
thread: thread1
31+
- name: waitForEvent
32+
event: ConnectionCreated
33+
count: 1
34+
- name: checkOut
35+
thread: thread2
36+
- name: waitForEvent
37+
event: ConnectionReady
38+
count: 2
39+
events:
40+
- type: ConnectionCreated
41+
- type: ConnectionReady
42+
- type: ConnectionCreated
43+
- type: ConnectionReady
44+
ignore:
45+
- ConnectionCheckOutStarted
46+
- ConnectionCheckedIn
47+
- ConnectionCheckedOut
48+
- ConnectionClosed
49+
- ConnectionPoolCreated
50+
- ConnectionPoolReady

‎test/spec/uri-options/connection-pool-options.json‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
"tests": [
33
{
44
"description": "Valid connection pool options are parsed correctly",
5-
"uri": "mongodb://example.com/?maxIdleTimeMS=50000&maxPoolSize=5&minPoolSize=3",
5+
"uri": "mongodb://example.com/?maxIdleTimeMS=50000&maxPoolSize=5&minPoolSize=3&maxConnecting=1",
66
"valid": true,
77
"warning": false,
88
"hosts": null,
99
"auth": null,
1010
"options": {
1111
"maxIdleTimeMS": 50000,
1212
"maxPoolSize": 5,
13-
"minPoolSize": 3
13+
"minPoolSize": 3,
14+
"maxConnecting": 1
1415
}
1516
},
1617
{
@@ -52,6 +53,24 @@
5253
"options": {
5354
"minPoolSize": 0
5455
}
56+
},
57+
{
58+
"description": "maxConnecting=0 causes a warning",
59+
"uri": "mongodb://example.com/?maxConnecting=0",
60+
"valid": true,
61+
"warning": true,
62+
"hosts": null,
63+
"auth": null,
64+
"options": {}
65+
},
66+
{
67+
"description": "maxConnecting<0 causes a warning",
68+
"uri": "mongodb://example.com/?maxConnecting=-1",
69+
"valid": true,
70+
"warning": true,
71+
"hosts": null,
72+
"auth": null,
73+
"options": {}
5574
}
5675
]
5776
}

‎test/spec/uri-options/connection-pool-options.yml‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
tests:
22
-
33
description: "Valid connection pool options are parsed correctly"
4-
uri: "mongodb://example.com/?maxIdleTimeMS=50000&maxPoolSize=5&minPoolSize=3"
4+
uri: "mongodb://example.com/?maxIdleTimeMS=50000&maxPoolSize=5&minPoolSize=3&maxConnecting=1"
55
valid: true
66
warning: false
77
hosts: ~
@@ -10,6 +10,7 @@ tests:
1010
maxIdleTimeMS: 50000
1111
maxPoolSize: 5
1212
minPoolSize: 3
13+
maxConnecting: 1
1314
-
1415
description: "Non-numeric maxIdleTimeMS causes a warning"
1516
uri: "mongodb://example.com/?maxIdleTimeMS=invalid"
@@ -45,4 +46,23 @@ tests:
4546
hosts: ~
4647
auth: ~
4748
options:
48-
minPoolSize: 0
49+
minPoolSize: 0
50+
51+
-
52+
description: "maxConnecting=0 causes a warning"
53+
uri: "mongodb://example.com/?maxConnecting=0"
54+
valid: true
55+
warning: true
56+
hosts: ~
57+
auth: ~
58+
options: {}
59+
60+
-
61+
description: "maxConnecting<0 causes a warning"
62+
uri: "mongodb://example.com/?maxConnecting=-1"
63+
valid: true
64+
warning: true
65+
hosts: ~
66+
auth: ~
67+
options: {}
68+

‎test/tools/cmap_spec_runner.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ type CmapOperation =
1919
type CmapPoolOptions = {
2020
maxPoolSize?: number;
2121
minPoolSize?: number;
22+
maxConnecting?: number;
2223
maxIdleTimeMS?: number;
2324
waitQueueTimeoutMS?: number;
2425
};

‎test/tools/uri_spec_runner.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,7 @@ export function executeUriValidationTest(
309309

310310
//** DIRECTLY MAPPED OPTIONS **/
311311
case 'zlibCompressionLevel':
312+
case 'maxConnecting':
312313
case 'maxPoolSize':
313314
case 'minPoolSize':
314315
case 'connectTimeoutMS':

‎test/unit/mongo_client.test.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ describe('MongoOptions', function () {
9797
localThresholdMS: 3,
9898
logger: new Logger('Testing!'),
9999
loggerLevel: 'info',
100+
maxConnecting: 5,
100101
maxIdleTimeMS: 3,
101102
maxPoolSize: 2,
102103
maxStalenessSeconds: 3,
@@ -162,6 +163,7 @@ describe('MongoOptions', function () {
162163
'heartbeatFrequencyMS=2',
163164
'journal=true',
164165
'localThresholdMS=2',
166+
'maxConnecting=5',
165167
'maxIdleTimeMS=2',
166168
'maxPoolSize=4',
167169
'maxStalenessSeconds=2',

0 commit comments

Comments
 (0)