@depup/mongoose 9.1.3-depup.0

package/lib/collection.js

@@ -0,0 +1,321 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const EventEmitter = require('events').EventEmitter;
+const STATES = require('./connectionState');
+const immediate = require('./helpers/immediate');
+
+/**
+ * Abstract Collection constructor
+ *
+ * This is the base class that drivers inherit from and implement.
+ *
+ * @param {String} name name of the collection
+ * @param {Connection} conn A MongooseConnection instance
+ * @param {Object} [opts] optional collection options
+ * @api public
+ */
+
+function Collection(name, conn, opts) {
+  if (opts === void 0) {
+    opts = {};
+  }
+
+  this.opts = opts;
+  this.name = name;
+  this.collectionName = name;
+  this.conn = conn;
+  this.queue = [];
+  this.buffer = !conn?._hasOpened;
+  this.emitter = new EventEmitter();
+
+  if (STATES.connected === this.conn.readyState) {
+    this.onOpen();
+  }
+}
+
+/**
+ * The collection name
+ *
+ * @api public
+ * @property name
+ */
+
+Collection.prototype.name;
+
+/**
+ * The collection name
+ *
+ * @api public
+ * @property collectionName
+ */
+
+Collection.prototype.collectionName;
+
+/**
+ * The Connection instance
+ *
+ * @api public
+ * @property conn
+ */
+
+Collection.prototype.conn;
+
+/**
+ * Called when the database connects
+ *
+ * @api private
+ */
+
+Collection.prototype.onOpen = function() {
+  this.buffer = false;
+  immediate(() => this.doQueue());
+};
+
+/**
+ * Called when the database disconnects
+ *
+ * @api private
+ */
+
+Collection.prototype.onClose = function() {};
+
+/**
+ * Queues a method for later execution when its
+ * database connection opens.
+ *
+ * @param {String} name name of the method to queue
+ * @param {Array} args arguments to pass to the method when executed
+ * @api private
+ */
+
+Collection.prototype.addQueue = function(name, args) {
+  this.queue.push([name, args]);
+  return this;
+};
+
+/**
+ * Removes a queued method
+ *
+ * @param {String} name name of the method to queue
+ * @param {Array} args arguments to pass to the method when executed
+ * @api private
+ */
+
+Collection.prototype.removeQueue = function(name, args) {
+  const index = this.queue.findIndex(v => v[0] === name && v[1] === args);
+  if (index === -1) {
+    return false;
+  }
+  this.queue.splice(index, 1);
+  return true;
+};
+
+/**
+ * Executes all queued methods and clears the queue.
+ *
+ * @api private
+ */
+
+Collection.prototype.doQueue = function() {
+  for (const method of this.queue) {
+    if (typeof method[0] === 'function') {
+      method[0].apply(this, method[1]);
+    } else {
+      this[method[0]].apply(this, method[1]);
+    }
+  }
+  this.queue = [];
+  const _this = this;
+  immediate(function() {
+    _this.emitter.emit('queue');
+  });
+  return this;
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.ensureIndex = function() {
+  throw new Error('Collection#ensureIndex unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.createIndex = function() {
+  throw new Error('Collection#createIndex unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.findAndModify = function() {
+  throw new Error('Collection#findAndModify unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.findOneAndUpdate = function() {
+  throw new Error('Collection#findOneAndUpdate unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.findOneAndDelete = function() {
+  throw new Error('Collection#findOneAndDelete unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.findOneAndReplace = function() {
+  throw new Error('Collection#findOneAndReplace unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.findOne = function() {
+  throw new Error('Collection#findOne unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.find = function() {
+  throw new Error('Collection#find unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.insert = function() {
+  throw new Error('Collection#insert unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.insertOne = function() {
+  throw new Error('Collection#insertOne unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.insertMany = function() {
+  throw new Error('Collection#insertMany unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.save = function() {
+  throw new Error('Collection#save unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.updateOne = function() {
+  throw new Error('Collection#updateOne unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.updateMany = function() {
+  throw new Error('Collection#updateMany unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.deleteOne = function() {
+  throw new Error('Collection#deleteOne unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.deleteMany = function() {
+  throw new Error('Collection#deleteMany unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.getIndexes = function() {
+  throw new Error('Collection#getIndexes unimplemented by driver');
+};
+
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.watch = function() {
+  throw new Error('Collection#watch unimplemented by driver');
+};
+
+/*!
+ * ignore
+ */
+
+Collection.prototype._shouldBufferCommands = function _shouldBufferCommands() {
+  const opts = this.opts;
+
+  if (opts.bufferCommands != null) {
+    return opts.bufferCommands;
+  }
+  if (opts?.schemaUserProvidedOptions?.bufferCommands != null) {
+    return opts.schemaUserProvidedOptions.bufferCommands;
+  }
+
+  return this.conn._shouldBufferCommands();
+};
+
+/*!
+ * ignore
+ */
+
+Collection.prototype._getBufferTimeoutMS = function _getBufferTimeoutMS() {
+  const conn = this.conn;
+  const opts = this.opts;
+
+  if (opts.bufferTimeoutMS != null) {
+    return opts.bufferTimeoutMS;
+  }
+  if (opts?.schemaUserProvidedOptions?.bufferTimeoutMS != null) {
+    return opts.schemaUserProvidedOptions.bufferTimeoutMS;
+  }
+  return conn._getBufferTimeoutMS();
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = Collection;