server.js
14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
'use strict';
const CServer = require('../core').Server;
const Cursor = require('../cursor');
const TopologyBase = require('./topology_base').TopologyBase;
const Store = require('./topology_base').Store;
const MongoError = require('../core').MongoError;
const MAX_JS_INT = require('../utils').MAX_JS_INT;
const translateOptions = require('../utils').translateOptions;
const filterOptions = require('../utils').filterOptions;
const mergeOptions = require('../utils').mergeOptions;
/**
* @fileOverview The **Server** class is a class that represents a single server topology and is
* used to construct connections.
*
* **Server Should not be used, use MongoClient.connect**
*/
// Allowed parameters
var legalOptionNames = [
'ha',
'haInterval',
'acceptableLatencyMS',
'poolSize',
'ssl',
'checkServerIdentity',
'sslValidate',
'sslCA',
'sslCRL',
'sslCert',
'ciphers',
'ecdhCurve',
'sslKey',
'sslPass',
'socketOptions',
'bufferMaxEntries',
'store',
'auto_reconnect',
'autoReconnect',
'emitError',
'keepAlive',
'keepAliveInitialDelay',
'noDelay',
'connectTimeoutMS',
'socketTimeoutMS',
'family',
'loggerLevel',
'logger',
'reconnectTries',
'reconnectInterval',
'monitoring',
'appname',
'domainsEnabled',
'servername',
'promoteLongs',
'promoteValues',
'promoteBuffers',
'compression',
'promiseLibrary',
'monitorCommands'
];
/**
* Creates a new Server instance
* @class
* @deprecated
* @param {string} host The host for the server, can be either an IP4, IP6 or domain socket style host.
* @param {number} [port] The server port if IP4.
* @param {object} [options] Optional settings.
* @param {number} [options.poolSize=5] Number of connections in the connection pool for each server instance, set to 5 as default for legacy reasons.
* @param {boolean} [options.ssl=false] Use ssl connection (needs to have a mongod server with ssl support)
* @param {boolean} [options.sslValidate=false] Validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {boolean|function} [options.checkServerIdentity=true] Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
* @param {array} [options.sslCA] Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {array} [options.sslCRL] Array of revocation certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {(Buffer|string)} [options.sslCert] String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {string} [options.ciphers] Passed directly through to tls.createSecureContext. See https://nodejs.org/dist/latest-v9.x/docs/api/tls.html#tls_tls_createsecurecontext_options for more info.
* @param {string} [options.ecdhCurve] Passed directly through to tls.createSecureContext. See https://nodejs.org/dist/latest-v9.x/docs/api/tls.html#tls_tls_createsecurecontext_options for more info.
* @param {(Buffer|string)} [options.sslKey] String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {(Buffer|string)} [options.sslPass] String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher)
* @param {string} [options.servername] String containing the server name requested via TLS SNI.
* @param {object} [options.socketOptions] Socket options
* @param {boolean} [options.socketOptions.autoReconnect=true] Reconnect on error.
* @param {boolean} [options.socketOptions.noDelay=true] TCP Socket NoDelay option.
* @param {boolean} [options.socketOptions.keepAlive=true] TCP Connection keep alive enabled
* @param {number} [options.socketOptions.keepAliveInitialDelay=30000] The number of milliseconds to wait before initiating keepAlive on the TCP socket
* @param {number} [options.socketOptions.connectTimeoutMS=0] TCP Connection timeout setting
* @param {number} [options.socketOptions.socketTimeoutMS=0] TCP Socket timeout setting
* @param {number} [options.reconnectTries=30] Server attempt to reconnect #times
* @param {number} [options.reconnectInterval=1000] Server will wait # milliseconds between retries
* @param {boolean} [options.monitoring=true] Triggers the server instance to call ismaster
* @param {number} [options.haInterval=10000] The interval of calling ismaster when monitoring is enabled.
* @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
* @param {boolean} [options.monitorCommands=false] Enable command monitoring for this topology
* @fires Server#connect
* @fires Server#close
* @fires Server#error
* @fires Server#timeout
* @fires Server#parseError
* @fires Server#reconnect
* @fires Server#commandStarted
* @fires Server#commandSucceeded
* @fires Server#commandFailed
* @property {string} parserType the parser type used (c++ or js).
* @return {Server} a Server instance.
*/
class Server extends TopologyBase {
constructor(host, port, options) {
super();
var self = this;
// Filter the options
options = filterOptions(options, legalOptionNames);
// Promise library
const promiseLibrary = options.promiseLibrary;
// Stored options
var storeOptions = {
force: false,
bufferMaxEntries:
typeof options.bufferMaxEntries === 'number' ? options.bufferMaxEntries : MAX_JS_INT
};
// Shared global store
var store = options.store || new Store(self, storeOptions);
// Detect if we have a socket connection
if (host.indexOf('/') !== -1) {
if (port != null && typeof port === 'object') {
options = port;
port = null;
}
} else if (port == null) {
throw MongoError.create({ message: 'port must be specified', driver: true });
}
// Get the reconnect option
var reconnect = typeof options.auto_reconnect === 'boolean' ? options.auto_reconnect : true;
reconnect = typeof options.autoReconnect === 'boolean' ? options.autoReconnect : reconnect;
// Clone options
var clonedOptions = mergeOptions(
{},
{
host: host,
port: port,
disconnectHandler: store,
cursorFactory: Cursor,
reconnect: reconnect,
emitError: typeof options.emitError === 'boolean' ? options.emitError : true,
size: typeof options.poolSize === 'number' ? options.poolSize : 5,
monitorCommands:
typeof options.monitorCommands === 'boolean' ? options.monitorCommands : false
}
);
// Translate any SSL options and other connectivity options
clonedOptions = translateOptions(clonedOptions, options);
// Socket options
var socketOptions =
options.socketOptions && Object.keys(options.socketOptions).length > 0
? options.socketOptions
: options;
// Translate all the options to the core types
clonedOptions = translateOptions(clonedOptions, socketOptions);
// Build default client information
clonedOptions.clientInfo = this.clientInfo;
// Do we have an application specific string
if (options.appname) {
clonedOptions.clientInfo.application = { name: options.appname };
}
// Define the internal properties
this.s = {
// Create an instance of a server instance from core module
coreTopology: new CServer(clonedOptions),
// Server capabilities
sCapabilities: null,
// Cloned options
clonedOptions: clonedOptions,
// Reconnect
reconnect: clonedOptions.reconnect,
// Emit error
emitError: clonedOptions.emitError,
// Pool size
poolSize: clonedOptions.size,
// Store Options
storeOptions: storeOptions,
// Store
store: store,
// Host
host: host,
// Port
port: port,
// Options
options: options,
// Server Session Pool
sessionPool: null,
// Active client sessions
sessions: new Set(),
// Promise library
promiseLibrary: promiseLibrary || Promise
};
}
// Connect
connect(_options, callback) {
var self = this;
if ('function' === typeof _options) (callback = _options), (_options = {});
if (_options == null) _options = this.s.clonedOptions;
if (!('function' === typeof callback)) callback = null;
_options = Object.assign({}, this.s.clonedOptions, _options);
self.s.options = _options;
// Update bufferMaxEntries
self.s.storeOptions.bufferMaxEntries =
typeof _options.bufferMaxEntries === 'number' ? _options.bufferMaxEntries : -1;
// Error handler
var connectErrorHandler = function() {
return function(err) {
// Remove all event handlers
var events = ['timeout', 'error', 'close'];
events.forEach(function(e) {
self.s.coreTopology.removeListener(e, connectHandlers[e]);
});
self.s.coreTopology.removeListener('connect', connectErrorHandler);
// Try to callback
try {
callback(err);
} catch (err) {
process.nextTick(function() {
throw err;
});
}
};
};
// Actual handler
var errorHandler = function(event) {
return function(err) {
if (event !== 'error') {
self.emit(event, err);
}
};
};
// Error handler
var reconnectHandler = function() {
self.emit('reconnect', self);
self.s.store.execute();
};
// Reconnect failed
var reconnectFailedHandler = function(err) {
self.emit('reconnectFailed', err);
self.s.store.flush(err);
};
// Destroy called on topology, perform cleanup
var destroyHandler = function() {
self.s.store.flush();
};
// relay the event
var relay = function(event) {
return function(t, server) {
self.emit(event, t, server);
};
};
// Connect handler
var connectHandler = function() {
// Clear out all the current handlers left over
['timeout', 'error', 'close', 'destroy'].forEach(function(e) {
self.s.coreTopology.removeAllListeners(e);
});
// Set up listeners
self.s.coreTopology.on('timeout', errorHandler('timeout'));
self.s.coreTopology.once('error', errorHandler('error'));
self.s.coreTopology.on('close', errorHandler('close'));
// Only called on destroy
self.s.coreTopology.on('destroy', destroyHandler);
// Emit open event
self.emit('open', null, self);
// Return correctly
try {
callback(null, self);
} catch (err) {
process.nextTick(function() {
throw err;
});
}
};
// Set up listeners
var connectHandlers = {
timeout: connectErrorHandler('timeout'),
error: connectErrorHandler('error'),
close: connectErrorHandler('close')
};
// Clear out all the current handlers left over
[
'timeout',
'error',
'close',
'serverOpening',
'serverDescriptionChanged',
'serverHeartbeatStarted',
'serverHeartbeatSucceeded',
'serverHeartbeatFailed',
'serverClosed',
'topologyOpening',
'topologyClosed',
'topologyDescriptionChanged',
'commandStarted',
'commandSucceeded',
'commandFailed'
].forEach(function(e) {
self.s.coreTopology.removeAllListeners(e);
});
// Add the event handlers
self.s.coreTopology.once('timeout', connectHandlers.timeout);
self.s.coreTopology.once('error', connectHandlers.error);
self.s.coreTopology.once('close', connectHandlers.close);
self.s.coreTopology.once('connect', connectHandler);
// Reconnect server
self.s.coreTopology.on('reconnect', reconnectHandler);
self.s.coreTopology.on('reconnectFailed', reconnectFailedHandler);
// Set up SDAM listeners
self.s.coreTopology.on('serverDescriptionChanged', relay('serverDescriptionChanged'));
self.s.coreTopology.on('serverHeartbeatStarted', relay('serverHeartbeatStarted'));
self.s.coreTopology.on('serverHeartbeatSucceeded', relay('serverHeartbeatSucceeded'));
self.s.coreTopology.on('serverHeartbeatFailed', relay('serverHeartbeatFailed'));
self.s.coreTopology.on('serverOpening', relay('serverOpening'));
self.s.coreTopology.on('serverClosed', relay('serverClosed'));
self.s.coreTopology.on('topologyOpening', relay('topologyOpening'));
self.s.coreTopology.on('topologyClosed', relay('topologyClosed'));
self.s.coreTopology.on('topologyDescriptionChanged', relay('topologyDescriptionChanged'));
self.s.coreTopology.on('commandStarted', relay('commandStarted'));
self.s.coreTopology.on('commandSucceeded', relay('commandSucceeded'));
self.s.coreTopology.on('commandFailed', relay('commandFailed'));
self.s.coreTopology.on('attemptReconnect', relay('attemptReconnect'));
self.s.coreTopology.on('monitoring', relay('monitoring'));
// Start connection
self.s.coreTopology.connect(_options);
}
}
Object.defineProperty(Server.prototype, 'poolSize', {
enumerable: true,
get: function() {
return this.s.coreTopology.connections().length;
}
});
Object.defineProperty(Server.prototype, 'autoReconnect', {
enumerable: true,
get: function() {
return this.s.reconnect;
}
});
Object.defineProperty(Server.prototype, 'host', {
enumerable: true,
get: function() {
return this.s.host;
}
});
Object.defineProperty(Server.prototype, 'port', {
enumerable: true,
get: function() {
return this.s.port;
}
});
/**
* Server connect event
*
* @event Server#connect
* @type {object}
*/
/**
* Server close event
*
* @event Server#close
* @type {object}
*/
/**
* Server reconnect event
*
* @event Server#reconnect
* @type {object}
*/
/**
* Server error event
*
* @event Server#error
* @type {MongoError}
*/
/**
* Server timeout event
*
* @event Server#timeout
* @type {object}
*/
/**
* Server parseError event
*
* @event Server#parseError
* @type {object}
*/
/**
* An event emitted indicating a command was started, if command monitoring is enabled
*
* @event Server#commandStarted
* @type {object}
*/
/**
* An event emitted indicating a command succeeded, if command monitoring is enabled
*
* @event Server#commandSucceeded
* @type {object}
*/
/**
* An event emitted indicating a command failed, if command monitoring is enabled
*
* @event Server#commandFailed
* @type {object}
*/
module.exports = Server;