Commit

node_modules/mongoose/lib/cursor/aggregationCursor.js

@@ -0,0 +1,476 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('../error/mongooseError');
+const Readable = require('stream').Readable;
+const eachAsync = require('../helpers/cursor/eachAsync');
+const immediate = require('../helpers/immediate');
+const kareem = require('kareem');
+const util = require('util');
+
+/**
+ * An AggregationCursor is a concurrency primitive for processing aggregation
+ * results one document at a time. It is analogous to QueryCursor.
+ *
+ * An AggregationCursor fulfills the Node.js streams3 API,
+ * in addition to several other mechanisms for loading documents from MongoDB
+ * one at a time.
+ *
+ * Creating an AggregationCursor executes the model's pre aggregate hooks,
+ * but **not** the model's post aggregate hooks.
+ *
+ * Unless you're an advanced user, do **not** instantiate this class directly.
+ * Use [`Aggregate#cursor()`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.cursor()) instead.
+ *
+ * @param {Aggregate} agg
+ * @inherits Readable https://nodejs.org/api/stream.html#class-streamreadable
+ * @event `cursor`: Emitted when the cursor is created
+ * @event `error`: Emitted when an error occurred
+ * @event `data`: Emitted when the stream is flowing and the next doc is ready
+ * @event `end`: Emitted when the stream is exhausted
+ * @api public
+ */
+
+function AggregationCursor(agg) {
+  // set autoDestroy=true because on node 12 it's by default false
+  // gh-10902 need autoDestroy to destroy correctly and emit 'close' event
+  Readable.call(this, { autoDestroy: true, objectMode: true });
+
+  this.cursor = null;
+  this.agg = agg;
+  this._transforms = [];
+  const connection = agg._connection;
+  const model = agg._model;
+  delete agg.options.cursor.useMongooseAggCursor;
+  this._mongooseOptions = {};
+
+  if (connection) {
+    this.cursor = connection.db.aggregate(agg._pipeline, agg.options || {});
+    setImmediate(() => this.emit('cursor', this.cursor));
+  } else {
+    _init(model, this, agg);
+  }
+}
+
+util.inherits(AggregationCursor, Readable);
+
+/*!
+ * ignore
+ */
+
+function _init(model, c, agg) {
+  if (!model.collection.buffer) {
+    model.hooks.execPre('aggregate', agg, function(err) {
+      if (err != null) {
+        _handlePreHookError(c, err);
+        return;
+      }
+      if (typeof agg.options?.cursor?.transform === 'function') {
+        c._transforms.push(agg.options.cursor.transform);
+      }
+
+      c.cursor = model.collection.aggregate(agg._pipeline, agg.options || {});
+      c.emit('cursor', c.cursor);
+    });
+  } else {
+    model.collection.emitter.once('queue', function() {
+      model.hooks.execPre('aggregate', agg, function(err) {
+        if (err != null) {
+          _handlePreHookError(c, err);
+          return;
+        }
+
+        if (typeof agg.options?.cursor?.transform === 'function') {
+          c._transforms.push(agg.options.cursor.transform);
+        }
+
+        c.cursor = model.collection.aggregate(agg._pipeline, agg.options || {});
+        c.emit('cursor', c.cursor);
+      });
+    });
+  }
+}
+
+/**
+* Handles error emitted from pre middleware. In particular, checks for `skipWrappedFunction`, which allows skipping
+* the actual aggregation and overwriting the function's return value. Because aggregation cursors don't return a value,
+* we need to make sure the user doesn't accidentally set a value in skipWrappedFunction.
+*
+* @param {QueryCursor} queryCursor
+* @param {Error} err
+* @returns
+*/
+
+function _handlePreHookError(queryCursor, err) {
+  if (err instanceof kareem.skipWrappedFunction) {
+    const resultValue = err.args[0];
+    if (resultValue != null && (!Array.isArray(resultValue) || resultValue.length)) {
+      const err = new MongooseError(
+        'Cannot `skipMiddlewareFunction()` with a value when using ' +
+        '`.aggregate().cursor()`, value must be nullish or empty array, got "' +
+        util.inspect(resultValue) +
+        '".'
+      );
+      queryCursor._markError(err);
+      queryCursor.listeners('error').length > 0 && queryCursor.emit('error', err);
+      return;
+    }
+    queryCursor.emit('cursor', null);
+    return;
+  }
+  queryCursor._markError(err);
+  queryCursor.listeners('error').length > 0 && queryCursor.emit('error', err);
+}
+
+
+/**
+ * Necessary to satisfy the Readable API
+ * @method _read
+ * @memberOf AggregationCursor
+ * @instance
+ * @api private
+ */
+
+AggregationCursor.prototype._read = function() {
+  const _this = this;
+  _next(this, function(error, doc) {
+    if (error) {
+      return _this.emit('error', error);
+    }
+    if (!doc) {
+      _this.push(null);
+      _this.cursor.close(function(error) {
+        if (error) {
+          return _this.emit('error', error);
+        }
+      });
+      return;
+    }
+    _this.push(doc);
+  });
+};
+
+if (Symbol.asyncIterator != null) {
+  const msg = 'Mongoose does not support using async iterators with an ' +
+    'existing aggregation cursor. See https://bit.ly/mongoose-async-iterate-aggregation';
+
+  AggregationCursor.prototype[Symbol.asyncIterator] = function() {
+    throw new MongooseError(msg);
+  };
+}
+
+/**
+ * Registers a transform function which subsequently maps documents retrieved
+ * via the streams interface or `.next()`
+ *
+ * #### Example:
+ *
+ *     // Map documents returned by `data` events
+ *     Thing.
+ *       find({ name: /^hello/ }).
+ *       cursor().
+ *       map(function (doc) {
+ *        doc.foo = "bar";
+ *        return doc;
+ *       })
+ *       on('data', function(doc) { console.log(doc.foo); });
+ *
+ *     // Or map documents returned by `.next()`
+ *     const cursor = Thing.find({ name: /^hello/ }).
+ *       cursor().
+ *       map(function (doc) {
+ *         doc.foo = "bar";
+ *         return doc;
+ *       });
+ *     cursor.next(function(error, doc) {
+ *       console.log(doc.foo);
+ *     });
+ *
+ * @param {Function} fn
+ * @return {AggregationCursor}
+ * @memberOf AggregationCursor
+ * @api public
+ * @method map
+ */
+
+Object.defineProperty(AggregationCursor.prototype, 'map', {
+  value: function(fn) {
+    this._transforms.push(fn);
+    return this;
+  },
+  enumerable: true,
+  configurable: true,
+  writable: true
+});
+
+/**
+ * Marks this cursor as errored
+ * @method _markError
+ * @instance
+ * @memberOf AggregationCursor
+ * @api private
+ */
+
+AggregationCursor.prototype._markError = function(error) {
+  this._error = error;
+  return this;
+};
+
+/**
+ * Marks this cursor as closed. Will stop streaming and subsequent calls to
+ * `next()` will error.
+ *
+ * @return {Promise}
+ * @api public
+ * @method close
+ * @emits "close"
+ * @see AggregationCursor.close https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html#close
+ */
+
+AggregationCursor.prototype.close = async function close() {
+  if (typeof arguments[0] === 'function') {
+    throw new MongooseError('AggregationCursor.prototype.close() no longer accepts a callback');
+  }
+  try {
+    await this.cursor.close();
+  } catch (error) {
+    this.listeners('error').length > 0 && this.emit('error', error);
+    throw error;
+  }
+  this.emit('close');
+};
+
+/**
+ * Marks this cursor as destroyed. Will stop streaming and subsequent calls to
+ * `next()` will error.
+ *
+ * @return {this}
+ * @api private
+ * @method _destroy
+ */
+
+AggregationCursor.prototype._destroy = function _destroy(_err, callback) {
+  let waitForCursor = null;
+  if (!this.cursor) {
+    waitForCursor = new Promise((resolve) => {
+      this.once('cursor', resolve);
+    });
+  } else {
+    waitForCursor = Promise.resolve();
+  }
+
+  waitForCursor
+    .then(() => this.cursor.close())
+    .then(() => {
+      this._closed = true;
+      callback();
+    })
+    .catch(error => {
+      callback(error);
+    });
+  return this;
+};
+
+/**
+ * Get the next document from this cursor. Will return `null` when there are
+ * no documents left.
+ *
+ * @return {Promise}
+ * @api public
+ * @method next
+ */
+
+AggregationCursor.prototype.next = async function next() {
+  if (typeof arguments[0] === 'function') {
+    throw new MongooseError('AggregationCursor.prototype.next() no longer accepts a callback');
+  }
+  return new Promise((resolve, reject) => {
+    _next(this, (err, res) => {
+      if (err != null) {
+        return reject(err);
+      }
+      resolve(res);
+    });
+  });
+};
+
+/**
+ * Execute `fn` for every document in the cursor. If `fn` returns a promise,
+ * will wait for the promise to resolve before iterating on to the next one.
+ * Returns a promise that resolves when done.
+ *
+ * @param {Function} fn
+ * @param {Object} [options]
+ * @param {Number} [options.parallel] the number of promises to execute in parallel. Defaults to 1.
+ * @param {Number} [options.batchSize=null] if set, Mongoose will call `fn` with an array of at most `batchSize` documents, instead of a single document
+ * @param {Boolean} [options.continueOnError=false] if true, `eachAsync()` iterates through all docs even if `fn` throws an error. If false, `eachAsync()` throws an error immediately if the given function `fn()` throws an error.
+ * @return {Promise}
+ * @api public
+ * @method eachAsync
+ */
+
+AggregationCursor.prototype.eachAsync = function(fn, opts) {
+  if (typeof arguments[2] === 'function') {
+    throw new MongooseError('AggregationCursor.prototype.eachAsync() no longer accepts a callback');
+  }
+  const _this = this;
+  if (typeof opts === 'function') {
+    opts = {};
+  }
+  opts = opts || {};
+
+  return eachAsync(function(cb) { return _next(_this, cb); }, fn, opts);
+};
+
+/**
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
+ * You do not need to call this function explicitly, the JavaScript runtime
+ * will call it for you.
+ *
+ * #### Example:
+ *
+ *     // Async iterator without explicitly calling `cursor()`. Mongoose still
+ *     // creates an AggregationCursor instance internally.
+ *     const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
+ *     for await (const doc of agg) {
+ *       console.log(doc.name);
+ *     }
+ *
+ *     // You can also use an AggregationCursor instance for async iteration
+ *     const cursor = Model.aggregate([{ $match: { age: { $gte: 25 } } }]).cursor();
+ *     for await (const doc of cursor) {
+ *       console.log(doc.name);
+ *     }
+ *
+ * Node.js 10.x supports async iterators natively without any flags. You can
+ * enable async iterators in Node.js 8.x using the [`--harmony_async_iteration` flag](https://github.com/tc39/proposal-async-iteration/issues/117#issuecomment-346695187).
+ *
+ * **Note:** This function is not set if `Symbol.asyncIterator` is undefined. If
+ * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
+ * support async iterators.
+ *
+ * @method [Symbol.asyncIterator]
+ * @memberOf AggregationCursor
+ * @instance
+ * @api public
+ */
+
+if (Symbol.asyncIterator != null) {
+  AggregationCursor.prototype[Symbol.asyncIterator] = function() {
+    return this.transformNull()._transformForAsyncIterator();
+  };
+}
+
+/*!
+ * ignore
+ */
+
+AggregationCursor.prototype._transformForAsyncIterator = function() {
+  if (this._transforms.indexOf(_transformForAsyncIterator) === -1) {
+    this.map(_transformForAsyncIterator);
+  }
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+AggregationCursor.prototype.transformNull = function(val) {
+  if (arguments.length === 0) {
+    val = true;
+  }
+  this._mongooseOptions.transformNull = val;
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+function _transformForAsyncIterator(doc) {
+  return doc == null ? { done: true } : { value: doc, done: false };
+}
+
+/**
+ * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html#addCursorFlag).
+ * Useful for setting the `noCursorTimeout` and `tailable` flags.
+ *
+ * @param {String} flag
+ * @param {Boolean} value
+ * @return {AggregationCursor} this
+ * @api public
+ * @method addCursorFlag
+ */
+
+AggregationCursor.prototype.addCursorFlag = function(flag, value) {
+  const _this = this;
+  _waitForCursor(this, function() {
+    _this.cursor.addCursorFlag(flag, value);
+  });
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+function _waitForCursor(ctx, cb) {
+  if (ctx.cursor) {
+    return cb();
+  }
+  ctx.once('cursor', function() {
+    cb();
+  });
+}
+
+/**
+ * Get the next doc from the underlying cursor and mongooseify it
+ * (populate, etc.)
+ * @param {Any} ctx
+ * @param {Function} cb
+ * @api private
+ */
+
+function _next(ctx, cb) {
+  let callback = cb;
+  if (ctx._transforms.length) {
+    callback = function(err, doc) {
+      if (err || (doc === null && !ctx._mongooseOptions.transformNull)) {
+        return cb(err, doc);
+      }
+      cb(err, ctx._transforms.reduce(function(doc, fn) {
+        return fn(doc);
+      }, doc));
+    };
+  }
+
+  if (ctx._error) {
+    return immediate(function() {
+      callback(ctx._error);
+    });
+  }
+
+  if (ctx.cursor) {
+    return ctx.cursor.next().then(
+      doc => {
+        if (!doc) {
+          return callback(null, null);
+        }
+
+        callback(null, doc);
+      },
+      err => callback(err)
+    );
+  } else {
+    ctx.once('error', cb);
+    ctx.once('cursor', function() {
+      _next(ctx, cb);
+    });
+  }
+}
+
+module.exports = AggregationCursor;