oxygen-cli 1.40.1 → 1.40.2-beta.1

package/transpiled/mongodb/lib/cmap/connection_pool.js

@@ -0,0 +1,688 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ConnectionPool = exports.PoolState = void 0;
+
+const timers_1 = require("timers");
+
+const constants_1 = require("../constants");
+
+const error_1 = require("../error");
+
+const mongo_types_1 = require("../mongo_types");
+
+const timeout_1 = require("../timeout");
+
+const utils_1 = require("../utils");
+
+const connect_1 = require("./connect");
+
+const connection_1 = require("./connection");
+
+const connection_pool_events_1 = require("./connection_pool_events");
+
+const errors_1 = require("./errors");
+
+const metrics_1 = require("./metrics");
+/** @internal */
+
+
+exports.PoolState = Object.freeze({
+  paused: 'paused',
+  ready: 'ready',
+  closed: 'closed'
+});
+/**
+ * A pool of connections which dynamically resizes, and emit events related to pool activity
+ * @internal
+ */
+
+class ConnectionPool extends mongo_types_1.TypedEventEmitter {
+  constructor(server, options) {
+    super();
+    this.on('error', utils_1.noop);
+    this.options = Object.freeze({
+      connectionType: connection_1.Connection,
+      ...options,
+      maxPoolSize: options.maxPoolSize ?? 100,
+      minPoolSize: options.minPoolSize ?? 0,
+      maxConnecting: options.maxConnecting ?? 2,
+      maxIdleTimeMS: options.maxIdleTimeMS ?? 0,
+      waitQueueTimeoutMS: options.waitQueueTimeoutMS ?? 0,
+      minPoolSizeCheckFrequencyMS: options.minPoolSizeCheckFrequencyMS ?? 100,
+      autoEncrypter: options.autoEncrypter
+    });
+
+    if (this.options.minPoolSize > this.options.maxPoolSize) {
+      throw new error_1.MongoInvalidArgumentError('Connection pool minimum size must not be greater than maximum pool size');
+    }
+
+    this.poolState = exports.PoolState.paused;
+    this.server = server;
+    this.connections = new utils_1.List();
+    this.pending = 0;
+    this.checkedOut = new Set();
+    this.minPoolSizeTimer = undefined;
+    this.generation = 0;
+    this.serviceGenerations = new Map();
+    this.connectionCounter = (0, utils_1.makeCounter)(1);
+    this.cancellationToken = new mongo_types_1.CancellationToken();
+    this.cancellationToken.setMaxListeners(Infinity);
+    this.waitQueue = new utils_1.List();
+    this.metrics = new metrics_1.ConnectionPoolMetrics();
+    this.processingWaitQueue = false;
+    this.mongoLogger = this.server.topology.client?.mongoLogger;
+    this.component = 'connection';
+    process.nextTick(() => {
+      this.emitAndLog(ConnectionPool.CONNECTION_POOL_CREATED, new connection_pool_events_1.ConnectionPoolCreatedEvent(this));
+    });
+  }
+  /** The address of the endpoint the pool is connected to */
+
+
+  get address() {
+    return this.options.hostAddress.toString();
+  }
+  /**
+   * Check if the pool has been closed
+   *
+   * TODO(NODE-3263): We can remove this property once shell no longer needs it
+   */
+
+
+  get closed() {
+    return this.poolState === exports.PoolState.closed;
+  }
+  /** An integer expressing how many total connections (available + pending + in use) the pool currently has */
+
+
+  get totalConnectionCount() {
+    return this.availableConnectionCount + this.pendingConnectionCount + this.currentCheckedOutCount;
+  }
+  /** An integer expressing how many connections are currently available in the pool. */
+
+
+  get availableConnectionCount() {
+    return this.connections.length;
+  }
+
+  get pendingConnectionCount() {
+    return this.pending;
+  }
+
+  get currentCheckedOutCount() {
+    return this.checkedOut.size;
+  }
+
+  get waitQueueSize() {
+    return this.waitQueue.length;
+  }
+
+  get loadBalanced() {
+    return this.options.loadBalanced;
+  }
+
+  get serverError() {
+    return this.server.description.error;
+  }
+  /**
+   * This is exposed ONLY for use in mongosh, to enable
+   * killing all connections if a user quits the shell with
+   * operations in progress.
+   *
+   * This property may be removed as a part of NODE-3263.
+   */
+
+
+  get checkedOutConnections() {
+    return this.checkedOut;
+  }
+  /**
+   * Get the metrics information for the pool when a wait queue timeout occurs.
+   */
+
+
+  waitQueueErrorMetrics() {
+    return this.metrics.info(this.options.maxPoolSize);
+  }
+  /**
+   * Set the pool state to "ready"
+   */
+
+
+  ready() {
+    if (this.poolState !== exports.PoolState.paused) {
+      return;
+    }
+
+    this.poolState = exports.PoolState.ready;
+    this.emitAndLog(ConnectionPool.CONNECTION_POOL_READY, new connection_pool_events_1.ConnectionPoolReadyEvent(this));
+    (0, timers_1.clearTimeout)(this.minPoolSizeTimer);
+    this.ensureMinPoolSize();
+  }
+  /**
+   * Check a connection out of this pool. The connection will continue to be tracked, but no reference to it
+   * will be held by the pool. This means that if a connection is checked out it MUST be checked back in or
+   * explicitly destroyed by the new owner.
+   */
+
+
+  async checkOut(options) {
+    const checkoutTime = (0, utils_1.now)();
+    this.emitAndLog(ConnectionPool.CONNECTION_CHECK_OUT_STARTED, new connection_pool_events_1.ConnectionCheckOutStartedEvent(this));
+    const {
+      promise,
+      resolve,
+      reject
+    } = (0, utils_1.promiseWithResolvers)();
+    const timeout = options.timeoutContext.connectionCheckoutTimeout;
+    const waitQueueMember = {
+      resolve,
+      reject,
+      cancelled: false,
+      checkoutTime
+    };
+    const abortListener = (0, utils_1.addAbortListener)(options.signal, function () {
+      waitQueueMember.cancelled = true;
+      reject(this.reason);
+    });
+    this.waitQueue.push(waitQueueMember);
+    process.nextTick(() => this.processWaitQueue());
+
+    try {
+      timeout?.throwIfExpired();
+      return await (timeout ? Promise.race([promise, timeout]) : promise);
+    } catch (error) {
+      if (timeout_1.TimeoutError.is(error)) {
+        timeout?.clear();
+        waitQueueMember.cancelled = true;
+        this.emitAndLog(ConnectionPool.CONNECTION_CHECK_OUT_FAILED, new connection_pool_events_1.ConnectionCheckOutFailedEvent(this, 'timeout', waitQueueMember.checkoutTime));
+        const timeoutError = new errors_1.WaitQueueTimeoutError(this.loadBalanced ? this.waitQueueErrorMetrics() : 'Timed out while checking out a connection from connection pool', this.address);
+
+        if (options.timeoutContext.csotEnabled()) {
+          throw new error_1.MongoOperationTimeoutError('Timed out during connection checkout', {
+            cause: timeoutError
+          });
+        }
+
+        throw timeoutError;
+      }
+
+      throw error;
+    } finally {
+      abortListener?.[utils_1.kDispose]();
+      timeout?.clear();
+    }
+  }
+  /**
+   * Check a connection into the pool.
+   *
+   * @param connection - The connection to check in
+   */
+
+
+  checkIn(connection) {
+    if (!this.checkedOut.has(connection)) {
+      return;
+    }
+
+    const poolClosed = this.closed;
+    const stale = this.connectionIsStale(connection);
+    const willDestroy = !!(poolClosed || stale || connection.closed);
+
+    if (!willDestroy) {
+      connection.markAvailable();
+      this.connections.unshift(connection);
+    }
+
+    this.checkedOut.delete(connection);
+    this.emitAndLog(ConnectionPool.CONNECTION_CHECKED_IN, new connection_pool_events_1.ConnectionCheckedInEvent(this, connection));
+
+    if (willDestroy) {
+      const reason = connection.closed ? 'error' : poolClosed ? 'poolClosed' : 'stale';
+      this.destroyConnection(connection, reason);
+    }
+
+    process.nextTick(() => this.processWaitQueue());
+  }
+  /**
+   * Clear the pool
+   *
+   * Pool reset is handled by incrementing the pool's generation count. Any existing connection of a
+   * previous generation will eventually be pruned during subsequent checkouts.
+   */
+
+
+  clear(options = {}) {
+    if (this.closed) {
+      return;
+    } // handle load balanced case
+
+
+    if (this.loadBalanced) {
+      const {
+        serviceId
+      } = options;
+
+      if (!serviceId) {
+        throw new error_1.MongoRuntimeError('ConnectionPool.clear() called in load balanced mode with no serviceId.');
+      }
+
+      const sid = serviceId.toHexString();
+      const generation = this.serviceGenerations.get(sid); // Only need to worry if the generation exists, since it should
+      // always be there but typescript needs the check.
+
+      if (generation == null) {
+        throw new error_1.MongoRuntimeError('Service generations are required in load balancer mode.');
+      } else {
+        // Increment the generation for the service id.
+        this.serviceGenerations.set(sid, generation + 1);
+      }
+
+      this.emitAndLog(ConnectionPool.CONNECTION_POOL_CLEARED, new connection_pool_events_1.ConnectionPoolClearedEvent(this, {
+        serviceId
+      }));
+      return;
+    } // handle non load-balanced case
+
+
+    const interruptInUseConnections = options.interruptInUseConnections ?? false;
+    const oldGeneration = this.generation;
+    this.generation += 1;
+    const alreadyPaused = this.poolState === exports.PoolState.paused;
+    this.poolState = exports.PoolState.paused;
+    this.clearMinPoolSizeTimer();
+
+    if (!alreadyPaused) {
+      this.emitAndLog(ConnectionPool.CONNECTION_POOL_CLEARED, new connection_pool_events_1.ConnectionPoolClearedEvent(this, {
+        interruptInUseConnections
+      }));
+    }
+
+    if (interruptInUseConnections) {
+      process.nextTick(() => this.interruptInUseConnections(oldGeneration));
+    }
+
+    this.processWaitQueue();
+  }
+  /**
+   * Closes all stale in-use connections in the pool with a resumable PoolClearedOnNetworkError.
+   *
+   * Only connections where `connection.generation <= minGeneration` are killed.
+   */
+
+
+  interruptInUseConnections(minGeneration) {
+    for (const connection of this.checkedOut) {
+      if (connection.generation <= minGeneration) {
+        connection.onError(new errors_1.PoolClearedOnNetworkError(this));
+      }
+    }
+  }
+  /** For MongoClient.close() procedures */
+
+
+  closeCheckedOutConnections() {
+    for (const conn of this.checkedOut) {
+      conn.onError(new error_1.MongoClientClosedError());
+    }
+  }
+  /** Close the pool */
+
+
+  close() {
+    if (this.closed) {
+      return;
+    } // immediately cancel any in-flight connections
+
+
+    this.cancellationToken.emit('cancel'); // end the connection counter
+
+    if (typeof this.connectionCounter.return === 'function') {
+      this.connectionCounter.return(undefined);
+    }
+
+    this.poolState = exports.PoolState.closed;
+    this.clearMinPoolSizeTimer();
+    this.processWaitQueue();
+
+    for (const conn of this.connections) {
+      this.emitAndLog(ConnectionPool.CONNECTION_CLOSED, new connection_pool_events_1.ConnectionClosedEvent(this, conn, 'poolClosed'));
+      conn.destroy();
+    }
+
+    this.connections.clear();
+    this.emitAndLog(ConnectionPool.CONNECTION_POOL_CLOSED, new connection_pool_events_1.ConnectionPoolClosedEvent(this));
+  }
+  /**
+   * @internal
+   * Reauthenticate a connection
+   */
+
+
+  async reauthenticate(connection) {
+    const authContext = connection.authContext;
+
+    if (!authContext) {
+      throw new error_1.MongoRuntimeError('No auth context found on connection.');
+    }
+
+    const credentials = authContext.credentials;
+
+    if (!credentials) {
+      throw new error_1.MongoMissingCredentialsError('Connection is missing credentials when asked to reauthenticate');
+    }
+
+    const resolvedCredentials = credentials.resolveAuthMechanism(connection.hello);
+    const provider = this.server.topology.client.s.authProviders.getOrCreateProvider(resolvedCredentials.mechanism, resolvedCredentials.mechanismProperties);
+
+    if (!provider) {
+      throw new error_1.MongoMissingCredentialsError(`Reauthenticate failed due to no auth provider for ${credentials.mechanism}`);
+    }
+
+    await provider.reauth(authContext);
+    return;
+  }
+  /** Clear the min pool size timer */
+
+
+  clearMinPoolSizeTimer() {
+    const minPoolSizeTimer = this.minPoolSizeTimer;
+
+    if (minPoolSizeTimer) {
+      (0, timers_1.clearTimeout)(minPoolSizeTimer);
+    }
+  }
+
+  destroyConnection(connection, reason) {
+    this.emitAndLog(ConnectionPool.CONNECTION_CLOSED, new connection_pool_events_1.ConnectionClosedEvent(this, connection, reason)); // destroy the connection
+
+    connection.destroy();
+  }
+
+  connectionIsStale(connection) {
+    const serviceId = connection.serviceId;
+
+    if (this.loadBalanced && serviceId) {
+      const sid = serviceId.toHexString();
+      const generation = this.serviceGenerations.get(sid);
+      return connection.generation !== generation;
+    }
+
+    return connection.generation !== this.generation;
+  }
+
+  connectionIsIdle(connection) {
+    return !!(this.options.maxIdleTimeMS && connection.idleTime > this.options.maxIdleTimeMS);
+  }
+  /**
+   * Destroys a connection if the connection is perished.
+   *
+   * @returns `true` if the connection was destroyed, `false` otherwise.
+   */
+
+
+  destroyConnectionIfPerished(connection) {
+    const isStale = this.connectionIsStale(connection);
+    const isIdle = this.connectionIsIdle(connection);
+
+    if (!isStale && !isIdle && !connection.closed) {
+      return false;
+    }
+
+    const reason = connection.closed ? 'error' : isStale ? 'stale' : 'idle';
+    this.destroyConnection(connection, reason);
+    return true;
+  }
+
+  createConnection(callback) {
+    const connectOptions = { ...this.options,
+      id: this.connectionCounter.next().value,
+      generation: this.generation,
+      cancellationToken: this.cancellationToken,
+      mongoLogger: this.mongoLogger,
+      authProviders: this.server.topology.client.s.authProviders
+    };
+    this.pending++; // This is our version of a "virtual" no-I/O connection as the spec requires
+
+    const connectionCreatedTime = (0, utils_1.now)();
+    this.emitAndLog(ConnectionPool.CONNECTION_CREATED, new connection_pool_events_1.ConnectionCreatedEvent(this, {
+      id: connectOptions.id
+    }));
+    (0, connect_1.connect)(connectOptions).then(connection => {
+      // The pool might have closed since we started trying to create a connection
+      if (this.poolState !== exports.PoolState.ready) {
+        this.pending--;
+        connection.destroy();
+        callback(this.closed ? new errors_1.PoolClosedError(this) : new errors_1.PoolClearedError(this));
+        return;
+      } // forward all events from the connection to the pool
+
+
+      for (const event of [...constants_1.APM_EVENTS, connection_1.Connection.CLUSTER_TIME_RECEIVED]) {
+        connection.on(event, e => this.emit(event, e));
+      }
+
+      if (this.loadBalanced) {
+        connection.on(connection_1.Connection.PINNED, pinType => this.metrics.markPinned(pinType));
+        connection.on(connection_1.Connection.UNPINNED, pinType => this.metrics.markUnpinned(pinType));
+        const serviceId = connection.serviceId;
+
+        if (serviceId) {
+          let generation;
+          const sid = serviceId.toHexString();
+
+          if (generation = this.serviceGenerations.get(sid)) {
+            connection.generation = generation;
+          } else {
+            this.serviceGenerations.set(sid, 0);
+            connection.generation = 0;
+          }
+        }
+      }
+
+      connection.markAvailable();
+      this.emitAndLog(ConnectionPool.CONNECTION_READY, new connection_pool_events_1.ConnectionReadyEvent(this, connection, connectionCreatedTime));
+      this.pending--;
+      callback(undefined, connection);
+    }, error => {
+      this.pending--;
+      this.server.handleError(error);
+      this.emitAndLog(ConnectionPool.CONNECTION_CLOSED, new connection_pool_events_1.ConnectionClosedEvent(this, {
+        id: connectOptions.id,
+        serviceId: undefined
+      }, 'error', // TODO(NODE-5192): Remove this cast
+      error));
+
+      if (error instanceof error_1.MongoNetworkError || error instanceof error_1.MongoServerError) {
+        error.connectionGeneration = connectOptions.generation;
+      }
+
+      callback(error ?? new error_1.MongoRuntimeError('Connection creation failed without error'));
+    });
+  }
+
+  ensureMinPoolSize() {
+    const minPoolSize = this.options.minPoolSize;
+
+    if (this.poolState !== exports.PoolState.ready || minPoolSize === 0) {
+      return;
+    }
+
+    this.connections.prune(connection => this.destroyConnectionIfPerished(connection));
+
+    if (this.totalConnectionCount < minPoolSize && this.pendingConnectionCount < this.options.maxConnecting) {
+      // NOTE: ensureMinPoolSize should not try to get all the pending
+      // connection permits because that potentially delays the availability of
+      // the connection to a checkout request
+      this.createConnection((err, connection) => {
+        if (!err && connection) {
+          this.connections.push(connection);
+          process.nextTick(() => this.processWaitQueue());
+        }
+
+        if (this.poolState === exports.PoolState.ready) {
+          (0, timers_1.clearTimeout)(this.minPoolSizeTimer);
+          this.minPoolSizeTimer = (0, timers_1.setTimeout)(() => this.ensureMinPoolSize(), this.options.minPoolSizeCheckFrequencyMS);
+        }
+      });
+    } else {
+      (0, timers_1.clearTimeout)(this.minPoolSizeTimer);
+      this.minPoolSizeTimer = (0, timers_1.setTimeout)(() => this.ensureMinPoolSize(), this.options.minPoolSizeCheckFrequencyMS);
+    }
+  }
+
+  processWaitQueue() {
+    if (this.processingWaitQueue) {
+      return;
+    }
+
+    this.processingWaitQueue = true;
+
+    while (this.waitQueueSize) {
+      const waitQueueMember = this.waitQueue.first();
+
+      if (!waitQueueMember) {
+        this.waitQueue.shift();
+        continue;
+      }
+
+      if (waitQueueMember.cancelled) {
+        this.waitQueue.shift();
+        continue;
+      }
+
+      if (this.poolState !== exports.PoolState.ready) {
+        const reason = this.closed ? 'poolClosed' : 'connectionError';
+        const error = this.closed ? new errors_1.PoolClosedError(this) : new errors_1.PoolClearedError(this);
+        this.emitAndLog(ConnectionPool.CONNECTION_CHECK_OUT_FAILED, new connection_pool_events_1.ConnectionCheckOutFailedEvent(this, reason, waitQueueMember.checkoutTime, error));
+        this.waitQueue.shift();
+        waitQueueMember.reject(error);
+        continue;
+      }
+
+      if (!this.availableConnectionCount) {
+        break;
+      }
+
+      const connection = this.connections.shift();
+
+      if (!connection) {
+        break;
+      }
+
+      if (!this.destroyConnectionIfPerished(connection)) {
+        this.checkedOut.add(connection);
+        this.emitAndLog(ConnectionPool.CONNECTION_CHECKED_OUT, new connection_pool_events_1.ConnectionCheckedOutEvent(this, connection, waitQueueMember.checkoutTime));
+        this.waitQueue.shift();
+        waitQueueMember.resolve(connection);
+      }
+    }
+
+    const {
+      maxPoolSize,
+      maxConnecting
+    } = this.options;
+
+    while (this.waitQueueSize > 0 && this.pendingConnectionCount < maxConnecting && (maxPoolSize === 0 || this.totalConnectionCount < maxPoolSize)) {
+      const waitQueueMember = this.waitQueue.shift();
+
+      if (!waitQueueMember || waitQueueMember.cancelled) {
+        continue;
+      }
+
+      this.createConnection((err, connection) => {
+        if (waitQueueMember.cancelled) {
+          if (!err && connection) {
+            this.connections.push(connection);
+          }
+        } else {
+          if (err) {
+            this.emitAndLog(ConnectionPool.CONNECTION_CHECK_OUT_FAILED, // TODO(NODE-5192): Remove this cast
+            new connection_pool_events_1.ConnectionCheckOutFailedEvent(this, 'connectionError', waitQueueMember.checkoutTime, err));
+            waitQueueMember.reject(err);
+          } else if (connection) {
+            this.checkedOut.add(connection);
+            this.emitAndLog(ConnectionPool.CONNECTION_CHECKED_OUT, new connection_pool_events_1.ConnectionCheckedOutEvent(this, connection, waitQueueMember.checkoutTime));
+            waitQueueMember.resolve(connection);
+          }
+        }
+
+        process.nextTick(() => this.processWaitQueue());
+      });
+    }
+
+    this.processingWaitQueue = false;
+  }
+
+}
+
+exports.ConnectionPool = ConnectionPool;
+/**
+ * Emitted when the connection pool is created.
+ * @event
+ */
+
+ConnectionPool.CONNECTION_POOL_CREATED = constants_1.CONNECTION_POOL_CREATED;
+/**
+ * Emitted once when the connection pool is closed
+ * @event
+ */
+
+ConnectionPool.CONNECTION_POOL_CLOSED = constants_1.CONNECTION_POOL_CLOSED;
+/**
+ * Emitted each time the connection pool is cleared and it's generation incremented
+ * @event
+ */
+
+ConnectionPool.CONNECTION_POOL_CLEARED = constants_1.CONNECTION_POOL_CLEARED;
+/**
+ * Emitted each time the connection pool is marked ready
+ * @event
+ */
+
+ConnectionPool.CONNECTION_POOL_READY = constants_1.CONNECTION_POOL_READY;
+/**
+ * Emitted when a connection is created.
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CREATED = constants_1.CONNECTION_CREATED;
+/**
+ * Emitted when a connection becomes established, and is ready to use
+ * @event
+ */
+
+ConnectionPool.CONNECTION_READY = constants_1.CONNECTION_READY;
+/**
+ * Emitted when a connection is closed
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CLOSED = constants_1.CONNECTION_CLOSED;
+/**
+ * Emitted when an attempt to check out a connection begins
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CHECK_OUT_STARTED = constants_1.CONNECTION_CHECK_OUT_STARTED;
+/**
+ * Emitted when an attempt to check out a connection fails
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CHECK_OUT_FAILED = constants_1.CONNECTION_CHECK_OUT_FAILED;
+/**
+ * Emitted each time a connection is successfully checked out of the connection pool
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CHECKED_OUT = constants_1.CONNECTION_CHECKED_OUT;
+/**
+ * Emitted each time a connection is successfully checked into the connection pool
+ * @event
+ */
+
+ConnectionPool.CONNECTION_CHECKED_IN = constants_1.CONNECTION_CHECKED_IN;