mongodb 3.3.0-beta2 → 3.3.3

package/lib/aggregation_cursor.js

@@ -1,12 +1,9 @@
 'use strict';
 
-const inherits = require('util').inherits;
 const MongoError = require('./core').MongoError;
-const Readable = require('stream').Readable;
-const CoreCursor = require('./cursor');
+const Cursor = require('./cursor');
+const CursorState = require('./core/cursor').CursorState;
 const deprecate = require('util').deprecate;
-const SUPPORTS = require('./utils').SUPPORTS;
-const MongoDBNamespace = require('./utils').MongoDBNamespace;
 
 /**
  * @fileOverview The **AggregationCursor** class is an internal class that embodies an aggregation cursor on MongoDB
@@ -56,253 +53,211 @@ const MongoDBNamespace = require('./utils').MongoDBNamespace;
  * @fires AggregationCursor#readable
  * @return {AggregationCursor} an AggregationCursor instance.
  */
-var AggregationCursor = function(topology, ns, cmd, options) {
-  CoreCursor.apply(this, Array.prototype.slice.call(arguments, 0));
-  var state = AggregationCursor.INIT;
-  var streamOptions = {};
-  const bson = topology.s.bson;
-  const topologyOptions = topology.s.options;
-
-  // MaxTimeMS
-  var maxTimeMS = null;
-
-  // Get the promiseLibrary
-  var promiseLibrary = options.promiseLibrary || Promise;
-
-  // Set up
-  Readable.call(this, { objectMode: true });
-
-  // Internal state
-  this.s = {
-    // MaxTimeMS
-    maxTimeMS: maxTimeMS,
-    // State
-    state: state,
-    // Stream options
-    streamOptions: streamOptions,
-    // BSON
-    bson: bson,
-    // Namespace
-    // TODO: switch to raw namespace object later
-    namespace: MongoDBNamespace.fromString(ns),
-    // Command
-    cmd: cmd,
-    // Options
-    options: options,
-    // Topology
-    topology: topology,
-    // Topology Options
-    topologyOptions: topologyOptions,
-    // Promise library
-    promiseLibrary: promiseLibrary,
-    // Optional ClientSession
-    session: options.session
-  };
-};
+class AggregationCursor extends Cursor {
+  constructor(topology, operation, options) {
+    super(topology, operation, options);
+  }
 
-/**
- * AggregationCursor stream data event, fired for each document in the cursor.
- *
- * @event AggregationCursor#data
- * @type {object}
- */
+  /**
+   * Set the batch size for the cursor.
+   * @method
+   * @param {number} value The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
+   * @throws {MongoError}
+   * @return {AggregationCursor}
+   */
+  batchSize(value) {
+    if (this.s.state === CursorState.CLOSED || this.isDead()) {
+      throw MongoError.create({ message: 'Cursor is closed', driver: true });
+    }
+
+    if (typeof value !== 'number') {
+      throw MongoError.create({ message: 'batchSize requires an integer', driver: true });
+    }
+
+    this.operation.options.batchSize = value;
+    this.setCursorBatchSize(value);
+    return this;
+  }
 
-/**
- * AggregationCursor stream end event
- *
- * @event AggregationCursor#end
- * @type {null}
- */
+  /**
+   * Add a geoNear stage to the aggregation pipeline
+   * @method
+   * @param {object} document The geoNear stage document.
+   * @return {AggregationCursor}
+   */
+  geoNear(document) {
+    this.operation.addToPipeline({ $geoNear: document });
+    return this;
+  }
 
-/**
- * AggregationCursor stream close event
- *
- * @event AggregationCursor#close
- * @type {null}
- */
+  /**
+   * Add a group stage to the aggregation pipeline
+   * @method
+   * @param {object} document The group stage document.
+   * @return {AggregationCursor}
+   */
+  group(document) {
+    this.operation.addToPipeline({ $group: document });
+    return this;
+  }
 
-/**
- * AggregationCursor stream readable event
- *
- * @event AggregationCursor#readable
- * @type {null}
- */
+  /**
+   * Add a limit stage to the aggregation pipeline
+   * @method
+   * @param {number} value The state limit value.
+   * @return {AggregationCursor}
+   */
+  limit(value) {
+    this.operation.addToPipeline({ $limit: value });
+    return this;
+  }
 
-// Inherit from Readable
-inherits(AggregationCursor, Readable);
+  /**
+   * Add a match stage to the aggregation pipeline
+   * @method
+   * @param {object} document The match stage document.
+   * @return {AggregationCursor}
+   */
+  match(document) {
+    this.operation.addToPipeline({ $match: document });
+    return this;
+  }
 
-// Extend the Cursor
-for (var name in CoreCursor.prototype) {
-  AggregationCursor.prototype[name] = CoreCursor.prototype[name];
-}
-if (SUPPORTS.ASYNC_ITERATOR) {
-  AggregationCursor.prototype[
-    Symbol.asyncIterator
-  ] = require('./async/async_iterator').asyncIterator;
-}
+  /**
+   * Add a maxTimeMS stage to the aggregation pipeline
+   * @method
+   * @param {number} value The state maxTimeMS value.
+   * @return {AggregationCursor}
+   */
+  maxTimeMS(value) {
+    this.operation.options.maxTimeMS = value;
+    return this;
+  }
 
-/**
- * Set the batch size for the cursor.
- * @method
- * @param {number} value The batchSize for the cursor.
- * @throws {MongoError}
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.batchSize = function(value) {
-  if (this.s.state === AggregationCursor.CLOSED || this.isDead())
-    throw MongoError.create({ message: 'Cursor is closed', driver: true });
-  if (typeof value !== 'number')
-    throw MongoError.create({ message: 'batchSize requires an integer', driver: true });
-  if (this.s.cmd.cursor) this.s.cmd.cursor.batchSize = value;
-  this.setCursorBatchSize(value);
-  return this;
-};
+  /**
+   * Add a out stage to the aggregation pipeline
+   * @method
+   * @param {number} destination The destination name.
+   * @return {AggregationCursor}
+   */
+  out(destination) {
+    this.operation.addToPipeline({ $out: destination });
+    return this;
+  }
 
-/**
- * Add a geoNear stage to the aggregation pipeline
- * @method
- * @param {object} document The geoNear stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.geoNear = deprecate(function(document) {
-  this.s.cmd.pipeline.push({ $geoNear: document });
-  return this;
-}, 'The `$geoNear` stage is deprecated in MongoDB 4.0, and removed in version 4.2.');
+  /**
+   * Add a project stage to the aggregation pipeline
+   * @method
+   * @param {object} document The project stage document.
+   * @return {AggregationCursor}
+   */
+  project(document) {
+    this.operation.addToPipeline({ $project: document });
+    return this;
+  }
 
-/**
- * Add a group stage to the aggregation pipeline
- * @method
- * @param {object} document The group stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.group = function(document) {
-  this.s.cmd.pipeline.push({ $group: document });
-  return this;
-};
+  /**
+   * Add a lookup stage to the aggregation pipeline
+   * @method
+   * @param {object} document The lookup stage document.
+   * @return {AggregationCursor}
+   */
+  lookup(document) {
+    this.operation.addToPipeline({ $lookup: document });
+    return this;
+  }
 
-/**
- * Add a limit stage to the aggregation pipeline
- * @method
- * @param {number} value The state limit value.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.limit = function(value) {
-  this.s.cmd.pipeline.push({ $limit: value });
-  return this;
-};
+  /**
+   * Add a redact stage to the aggregation pipeline
+   * @method
+   * @param {object} document The redact stage document.
+   * @return {AggregationCursor}
+   */
+  redact(document) {
+    this.operation.addToPipeline({ $redact: document });
+    return this;
+  }
 
-/**
- * Add a match stage to the aggregation pipeline
- * @method
- * @param {object} document The match stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.match = function(document) {
-  this.s.cmd.pipeline.push({ $match: document });
-  return this;
-};
+  /**
+   * Add a skip stage to the aggregation pipeline
+   * @method
+   * @param {number} value The state skip value.
+   * @return {AggregationCursor}
+   */
+  skip(value) {
+    this.operation.addToPipeline({ $skip: value });
+    return this;
+  }
 
-/**
- * Add a maxTimeMS stage to the aggregation pipeline
- * @method
- * @param {number} value The state maxTimeMS value.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.maxTimeMS = function(value) {
-  if (this.s.topology.lastIsMaster().minWireVersion > 2) {
-    this.s.cmd.maxTimeMS = value;
+  /**
+   * Add a sort stage to the aggregation pipeline
+   * @method
+   * @param {object} document The sort stage document.
+   * @return {AggregationCursor}
+   */
+  sort(document) {
+    this.operation.addToPipeline({ $sort: document });
+    return this;
   }
-  return this;
-};
 
-/**
- * Add a out stage to the aggregation pipeline
- * @method
- * @param {number} destination The destination name.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.out = function(destination) {
-  this.s.cmd.pipeline.push({ $out: destination });
-  return this;
-};
+  /**
+   * Add a unwind stage to the aggregation pipeline
+   * @method
+   * @param {number} field The unwind field name.
+   * @return {AggregationCursor}
+   */
+  unwind(field) {
+    this.operation.addToPipeline({ $unwind: field });
+    return this;
+  }
 
-/**
- * Add a project stage to the aggregation pipeline
- * @method
- * @param {object} document The project stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.project = function(document) {
-  this.s.cmd.pipeline.push({ $project: document });
-  return this;
-};
+  /**
+   * Return the cursor logger
+   * @method
+   * @return {Logger} return the cursor logger
+   * @ignore
+   */
+  getLogger() {
+    return this.logger;
+  }
+}
 
-/**
- * Add a lookup stage to the aggregation pipeline
- * @method
- * @param {object} document The lookup stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.lookup = function(document) {
-  this.s.cmd.pipeline.push({ $lookup: document });
-  return this;
-};
+// aliases
+AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
 
-/**
- * Add a redact stage to the aggregation pipeline
- * @method
- * @param {object} document The redact stage document.
- * @return {AggregationCursor}
- */
-AggregationCursor.prototype.redact = function(document) {
-  this.s.cmd.pipeline.push({ $redact: document });
-  return this;
-};
+// deprecated methods
+deprecate(
+  AggregationCursor.prototype.geoNear,
+  'The `$geoNear` stage is deprecated in MongoDB 4.0, and removed in version 4.2.'
+);
 
 /**
- * Add a skip stage to the aggregation pipeline
- * @method
- * @param {number} value The state skip value.
- * @return {AggregationCursor}
+ * AggregationCursor stream data event, fired for each document in the cursor.
+ *
+ * @event AggregationCursor#data
+ * @type {object}
  */
-AggregationCursor.prototype.skip = function(value) {
-  this.s.cmd.pipeline.push({ $skip: value });
-  return this;
-};
 
 /**
- * Add a sort stage to the aggregation pipeline
- * @method
- * @param {object} document The sort stage document.
- * @return {AggregationCursor}
+ * AggregationCursor stream end event
+ *
+ * @event AggregationCursor#end
+ * @type {null}
  */
-AggregationCursor.prototype.sort = function(document) {
-  this.s.cmd.pipeline.push({ $sort: document });
-  return this;
-};
 
 /**
- * Add a unwind stage to the aggregation pipeline
- * @method
- * @param {number} field The unwind field name.
- * @return {AggregationCursor}
+ * AggregationCursor stream close event
+ *
+ * @event AggregationCursor#close
+ * @type {null}
  */
-AggregationCursor.prototype.unwind = function(field) {
-  this.s.cmd.pipeline.push({ $unwind: field });
-  return this;
-};
 
 /**
- * Return the cursor logger
- * @method
- * @return {Logger} return the cursor logger
- * @ignore
+ * AggregationCursor stream readable event
+ *
+ * @event AggregationCursor#readable
+ * @type {null}
  */
-AggregationCursor.prototype.getLogger = function() {
-  return this.logger;
-};
-
-AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
 
 /**
  * Get the next available document from the cursor, returns null if no more documents are available.
@@ -353,6 +308,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * at any given time if batch size is specified. Otherwise, the caller is responsible
  * for making sure that the entire result can fit the memory.
  * @method AggregationCursor.prototype.each
+ * @deprecated
  * @param {AggregationCursor~resultCallback} callback The result callback.
  * @throws {MongoError}
  * @return {null}
@@ -402,7 +358,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * @param {MongoError} error An error instance representing the error during the execution.
  */
 
-/*
+/**
  * Iterates over all the documents for this cursor using the iterator, callback pattern.
  * @method AggregationCursor.prototype.forEach
  * @param {AggregationCursor~iteratorCallback} iterator The iteration callback.
@@ -411,8 +367,4 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * @return {null}
  */
 
-AggregationCursor.INIT = 0;
-AggregationCursor.OPEN = 1;
-AggregationCursor.CLOSED = 2;
-
 module.exports = AggregationCursor;