change_stream.js
12.1 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
'use strict';
var EventEmitter = require('events'),
inherits = require('util').inherits,
MongoNetworkError = require('mongodb-core').MongoNetworkError;
var cursorOptionNames = ['maxAwaitTimeMS', 'collation', 'readPreference'];
/**
* Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.
* @class ChangeStream
* @since 3.0.0
* @param {(Db|Collection)} changeDomain The collection against which to create the change stream
* @param {Array} pipeline An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents
* @param {object} [options=null] Optional settings
* @param {string} [options.fullDocument='default'] Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.
* @param {number} [options.maxAwaitTimeMS] The maximum amount of time for the server to wait on new documents to satisfy a change stream query
* @param {object} [options.resumeAfter=null] Specifies the logical starting point for the new change stream. This should be the _id field from a previously returned change stream document.
* @param {number} [options.batchSize=null] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
* @param {object} [options.collation=null] Specify collation settings for operation. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
* @param {ReadPreference} [options.readPreference=null] The read preference. Defaults to the read preference of the database or collection. See {@link https://docs.mongodb.com/manual/reference/read-preference|read preference documentation}.
* @fires ChangeStream#close
* @fires ChangeStream#change
* @fires ChangeStream#end
* @fires ChangeStream#error
* @return {ChangeStream} a ChangeStream instance.
*/
var ChangeStream = function(collection, pipeline, options) {
var Collection = require('./collection');
// Ensure the provided collection is actually a collection
if (!(collection instanceof Collection)) {
throw new Error(
'collection provided to ChangeStream constructor is not an instance of Collection'
);
}
var self = this;
self.pipeline = pipeline || [];
self.options = options || {};
self.promiseLibrary = collection.s.promiseLibrary;
// Extract namespace and serverConfig from the collection
self.namespace = {
collection: collection.collectionName,
database: collection.s.db.databaseName
};
self.serverConfig = collection.s.db.serverConfig;
// Determine correct read preference
self.options.readPreference = self.options.readPreference || collection.s.readPreference;
// Create contained Change Stream cursor
self.cursor = createChangeStreamCursor(self);
// Listen for any `change` listeners being added to ChangeStream
self.on('newListener', function(eventName) {
if (eventName === 'change' && self.cursor && self.cursor.listenerCount('change') === 0) {
self.cursor.on('data', function(change) {
processNewChange(self, null, change);
});
}
});
// Listen for all `change` listeners being removed from ChangeStream
self.on('removeListener', function(eventName) {
if (eventName === 'change' && self.listenerCount('change') === 0 && self.cursor) {
self.cursor.removeAllListeners('data');
}
});
};
inherits(ChangeStream, EventEmitter);
// Create a new change stream cursor based on self's configuration
var createChangeStreamCursor = function(self) {
if (self.resumeToken) {
self.options.resumeAfter = self.resumeToken;
}
var changeStreamCursor = buildChangeStreamAggregationCommand(
self.serverConfig,
self.namespace,
self.pipeline,
self.resumeToken,
self.options
);
/**
* Fired for each new matching change in the specified namespace. Attaching a `change` event listener to a Change Stream will switch the stream into flowing mode. Data will then be passed as soon as it is available.
*
* @event ChangeStream#change
* @type {object}
*/
if (self.listenerCount('change') > 0) {
changeStreamCursor.on('data', function(change) {
processNewChange(self, null, change);
});
}
/**
* Change stream close event
*
* @event ChangeStream#close
* @type {null}
*/
changeStreamCursor.on('close', function() {
self.emit('close');
});
/**
* Change stream end event
*
* @event ChangeStream#end
* @type {null}
*/
changeStreamCursor.on('end', function() {
self.emit('end');
});
/**
* Fired when the stream encounters an error.
*
* @event ChangeStream#error
* @type {Error}
*/
changeStreamCursor.on('error', function(error) {
self.emit('error', error);
});
return changeStreamCursor;
};
var buildChangeStreamAggregationCommand = function(
serverConfig,
namespace,
pipeline,
resumeToken,
options
) {
var changeStreamStageOptions = {};
if (options.fullDocument) {
changeStreamStageOptions.fullDocument = options.fullDocument;
}
if (resumeToken || options.resumeAfter) {
changeStreamStageOptions.resumeAfter = resumeToken || options.resumeAfter;
}
// Map cursor options
var cursorOptions = {};
cursorOptionNames.forEach(function(optionName) {
if (options[optionName]) {
cursorOptions[optionName] = options[optionName];
}
});
var changeStreamPipeline = [{ $changeStream: changeStreamStageOptions }];
changeStreamPipeline = changeStreamPipeline.concat(pipeline);
var command = {
aggregate: namespace.collection,
pipeline: changeStreamPipeline,
readConcern: { level: 'majority' },
cursor: {
batchSize: options.batchSize || 1
}
};
// Create and return the cursor
return serverConfig.cursor(
namespace.database + '.' + namespace.collection,
command,
cursorOptions
);
};
/**
* Check if there is any document still available in the Change Stream
* @function ChangeStream.prototype.hasNext
* @param {ChangeStream~resultCallback} [callback] The result callback.
* @throws {MongoError}
* @return {Promise} returns Promise if no callback passed
*/
ChangeStream.prototype.hasNext = function(callback) {
return this.cursor.hasNext(callback);
};
/**
* Get the next available document from the Change Stream, returns null if no more documents are available.
* @function ChangeStream.prototype.next
* @param {ChangeStream~resultCallback} [callback] The result callback.
* @throws {MongoError}
* @return {Promise} returns Promise if no callback passed
*/
ChangeStream.prototype.next = function(callback) {
var self = this;
if (this.isClosed()) {
if (callback) return callback(new Error('Change Stream is not open.'), null);
return self.promiseLibrary.reject(new Error('Change Stream is not open.'));
}
return this.cursor
.next()
.then(function(change) {
return processNewChange(self, null, change, callback);
})
.catch(function(err) {
return processNewChange(self, err, null, callback);
});
};
/**
* Is the cursor closed
* @method ChangeStream.prototype.isClosed
* @return {boolean}
*/
ChangeStream.prototype.isClosed = function() {
if (this.cursor) {
return this.cursor.isClosed();
}
return true;
};
/**
* Close the Change Stream
* @method ChangeStream.prototype.close
* @param {ChangeStream~resultCallback} [callback] The result callback.
* @return {Promise} returns Promise if no callback passed
*/
ChangeStream.prototype.close = function(callback) {
if (!this.cursor) {
if (callback) return callback();
return this.promiseLibrary.resolve();
}
// Tidy up the existing cursor
var cursor = this.cursor;
delete this.cursor;
return cursor.close(callback);
};
/**
* This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.
* @method
* @param {Writable} destination The destination for writing data
* @param {object} [options] {@link https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options|Pipe options}
* @return {null}
*/
ChangeStream.prototype.pipe = function(destination, options) {
if (!this.pipeDestinations) {
this.pipeDestinations = [];
}
this.pipeDestinations.push(destination);
return this.cursor.pipe(destination, options);
};
/**
* This method will remove the hooks set up for a previous pipe() call.
* @param {Writable} [destination] The destination for writing data
* @return {null}
*/
ChangeStream.prototype.unpipe = function(destination) {
if (this.pipeDestinations && this.pipeDestinations.indexOf(destination) > -1) {
this.pipeDestinations.splice(this.pipeDestinations.indexOf(destination), 1);
}
return this.cursor.unpipe(destination);
};
/**
* This method will cause a stream in flowing mode to stop emitting data events. Any data that becomes available will remain in the internal buffer.
* @return {null}
*/
ChangeStream.prototype.pause = function() {
return this.cursor.pause();
};
/**
* This method will cause the readable stream to resume emitting data events.
* @return {null}
*/
ChangeStream.prototype.resume = function() {
return this.cursor.resume();
};
/**
* Return a modified Readable stream including a possible transform method.
* @method
* @param {object} [options=null] Optional settings.
* @param {function} [options.transform=null] A transformation method applied to each document emitted by the stream.
* @return {Cursor}
*/
ChangeStream.prototype.stream = function(options) {
this.streamOptions = options;
return this.cursor.stream(options);
};
// Handle new change events. This method brings together the routes from the callback, event emitter, and promise ways of using ChangeStream.
var processNewChange = function(self, err, change, callback) {
// Handle errors
if (err) {
// Handle resumable MongoNetworkErrors
if (err instanceof MongoNetworkError && !self.attemptingResume) {
self.attemptingResume = true;
return self.cursor.close(function(closeErr) {
if (closeErr) {
if (callback) return callback(err, null);
return self.promiseLibrary.reject(err);
}
// Establish a new cursor
self.cursor = createChangeStreamCursor(self);
// Attempt to reconfigure piping
if (self.pipeDestinations) {
var cursorStream = self.cursor.stream(self.streamOptions);
for (var pipeDestination in self.pipeDestinations) {
cursorStream.pipe(pipeDestination);
}
}
// Attempt the next() operation again
if (callback) return self.next(callback);
return self.next();
});
}
if (typeof callback === 'function') return callback(err, null);
if (self.listenerCount('error')) return self.emit('error', err);
return self.promiseLibrary.reject(err);
}
self.attemptingResume = false;
// Cache the resume token if it is present. If it is not present return an error.
if (!change || !change._id) {
var noResumeTokenError = new Error(
'A change stream document has been received that lacks a resume token (_id).'
);
if (typeof callback === 'function') return callback(noResumeTokenError, null);
if (self.listenerCount('error')) return self.emit('error', noResumeTokenError);
return self.promiseLibrary.reject(noResumeTokenError);
}
self.resumeToken = change._id;
// Return the change
if (typeof callback === 'function') return callback(err, change);
if (self.listenerCount('change')) return self.emit('change', change);
return self.promiseLibrary.resolve(change);
};
/**
* The callback format for results
* @callback ChangeStream~resultCallback
* @param {MongoError} error An error instance representing the error during the execution.
* @param {(object|null)} result The result object if the command was executed successfully.
*/
module.exports = ChangeStream;