mongodb 4.0.0 → 4.1.2

package/src/utils.ts

@@ -1,10 +1,19 @@
 import * as os from 'os';
 import * as crypto from 'crypto';
 import { PromiseProvider } from './promise_provider';
-import { AnyError, MongoParseError, MongoDriverError } from './error';
+import {
+  AnyError,
+  MongoParseError,
+  MongoRuntimeError,
+  MongoCompatibilityError,
+  MongoNotConnectedError,
+  MongoInvalidArgumentError,
+  MongoExpiredSessionError
+} from './error';
 import { WriteConcern, WriteConcernOptions, W } from './write_concern';
 import type { Server } from './sdam/server';
 import type { Topology } from './sdam/topology';
+import { ServerType } from './sdam/common';
 import type { Db } from './db';
 import type { Collection } from './collection';
 import type { OperationOptions, Hint } from './operations/operation';
@@ -18,6 +27,7 @@ import type { MongoClient } from './mongo_client';
 import type { CommandOperationOptions, OperationParent } from './operations/command';
 import { ReadPreference } from './read_preference';
 import { URL } from 'url';
+import { MAX_SUPPORTED_WIRE_VERSION } from './cmap/wire_protocol/constants';
 
 /**
  * MongoDB Driver style callback
@@ -54,27 +64,30 @@ export function getSingleProperty(
  */
 export function checkCollectionName(collectionName: string): void {
   if ('string' !== typeof collectionName) {
-    throw new MongoDriverError('collection name must be a String');
+    throw new MongoInvalidArgumentError('Collection name must be a String');
   }
 
   if (!collectionName || collectionName.indexOf('..') !== -1) {
-    throw new MongoDriverError('collection names cannot be empty');
+    throw new MongoInvalidArgumentError('Collection names cannot be empty');
   }
 
   if (
     collectionName.indexOf('$') !== -1 &&
     collectionName.match(/((^\$cmd)|(oplog\.\$main))/) == null
   ) {
-    throw new MongoDriverError("collection names must not contain '$'");
+    // TODO(NODE-3483): Use MongoNamespace static method
+    throw new MongoInvalidArgumentError("Collection names must not contain '$'");
   }
 
   if (collectionName.match(/^\.|\.$/) != null) {
-    throw new MongoDriverError("collection names must not start or end with '.'");
+    // TODO(NODE-3483): Use MongoNamespace static method
+    throw new MongoInvalidArgumentError("Collection names must not start or end with '.'");
   }
 
   // Validate that we are not passing 0x00 in the collection name
   if (collectionName.indexOf('\x00') !== -1) {
-    throw new MongoDriverError('collection names cannot contain a null character');
+    // TODO(NODE-3483): Use MongoNamespace static method
+    throw new MongoInvalidArgumentError('Collection names cannot contain a null character');
   }
 }
 
@@ -149,9 +162,9 @@ export function parseIndexOptions(indexSpec: IndexSpecification): IndexOptions {
   } else if (isObject(indexSpec)) {
     // {location:'2d', type:1}
     keys = Object.keys(indexSpec);
-    keys.forEach(key => {
-      indexes.push(key + '_' + indexSpec[key]);
-      fieldHash[key] = indexSpec[key];
+    Object.entries(indexSpec).forEach(([key, value]) => {
+      indexes.push(key + '_' + value);
+      fieldHash[key] = value;
     });
   }
 
@@ -228,7 +241,8 @@ export function executeLegacyOperation(
   const Promise = PromiseProvider.get();
 
   if (!Array.isArray(args)) {
-    throw new MongoDriverError('This method requires an array of arguments to apply');
+    // TODO(NODE-3483)
+    throw new MongoRuntimeError('This method requires an array of arguments to apply');
   }
 
   options = options ?? {};
@@ -248,7 +262,7 @@ export function executeLegacyOperation(
       const optionsIndex = args.length - 2;
       args[optionsIndex] = Object.assign({}, args[optionsIndex], { session: session });
     } else if (opOptions.session && opOptions.session.hasEnded) {
-      throw new MongoDriverError('Use of expired sessions is not permitted');
+      throw new MongoExpiredSessionError();
     }
   }
 
@@ -289,7 +303,8 @@ export function executeLegacyOperation(
 
   // Return a Promise
   if (args[args.length - 1] != null) {
-    throw new MongoDriverError('final argument to `executeLegacyOperation` must be a callback');
+    // TODO(NODE-3483)
+    throw new MongoRuntimeError('Final argument to `executeLegacyOperation` must be a callback');
   }
 
   return new Promise<any>((resolve, reject) => {
@@ -399,7 +414,7 @@ export function decorateWithCollation(
     if (capabilities && capabilities.commandsTakeCollation) {
       command.collation = options.collation;
     } else {
-      throw new MongoDriverError(`Current topology does not support collation`);
+      throw new MongoCompatibilityError(`Current topology does not support collation`);
     }
   }
 }
@@ -458,7 +473,7 @@ export function getTopology<T>(provider: MongoClient | Db | Collection<T>): Topo
     return provider.s.db.s.client.topology;
   }
 
-  throw new MongoDriverError('MongoClient must be connected to perform this operation');
+  throw new MongoNotConnectedError('MongoClient must be connected to perform this operation');
 }
 
 /**
@@ -574,7 +589,8 @@ export class MongoDBNamespace {
 
   static fromString(namespace?: string): MongoDBNamespace {
     if (!namespace) {
-      throw new MongoDriverError(`Cannot parse namespace from "${namespace}"`);
+      // TODO(NODE-3483): Replace with MongoNamespaceError
+      throw new MongoRuntimeError(`Cannot parse namespace from "${namespace}"`);
     }
 
     const [db, ...collection] = namespace.split('.');
@@ -663,6 +679,13 @@ export function uuidV4(): Buffer {
  */
 export function maxWireVersion(topologyOrServer?: Connection | Topology | Server): number {
   if (topologyOrServer) {
+    if (topologyOrServer.loadBalanced) {
+      // Since we do not have a monitor, we assume the load balanced server is always
+      // pointed at the latest mongodb version. There is a risk that for on-prem
+      // deployments that don't upgrade immediately that this could alert to the
+      // application that a feature is avaiable that is actually not.
+      return MAX_SUPPORTED_WIRE_VERSION;
+    }
     if (topologyOrServer.ismaster) {
       return topologyOrServer.ismaster.maxWireVersion;
     }
@@ -677,7 +700,7 @@ export function maxWireVersion(topologyOrServer?: Connection | Topology | Server
     if (
       topologyOrServer.description &&
       'maxWireVersion' in topologyOrServer.description &&
-      'undefined' !== typeof topologyOrServer.description.maxWireVersion
+      topologyOrServer.description.maxWireVersion != null
     ) {
       return topologyOrServer.description.maxWireVersion;
     }
@@ -827,7 +850,7 @@ export function makeStateMachine(stateTable: StateTable): StateTransitionFunctio
   return function stateTransition(target, newState) {
     const legalStates = stateTable[target.s.state];
     if (legalStates && legalStates.indexOf(newState) < 0) {
-      throw new MongoDriverError(
+      throw new MongoRuntimeError(
         `illegal state transition from [${target.s.state}] => [${newState}], allowed: [${legalStates}]`
       );
     }
@@ -921,7 +944,7 @@ export function now(): number {
 /** @internal */
 export function calculateDurationInMs(started: number): number {
   if (typeof started !== 'number') {
-    throw new MongoDriverError('numeric value required to calculate duration');
+    throw new MongoInvalidArgumentError('Numeric value required to calculate duration');
   }
 
   const elapsed = now() - started;
@@ -1222,7 +1245,7 @@ export class BufferPool {
   /** Reads the requested number of bytes, optionally consuming them */
   read(size: number, consume = true): Buffer {
     if (typeof size !== 'number' || size < 0) {
-      throw new MongoDriverError('Parameter size must be a non-negative number');
+      throw new MongoInvalidArgumentError('Argument "size" must be a non-negative number');
     }
 
     if (size > this[kLength]) {
@@ -1324,7 +1347,7 @@ export class HostAddress {
         throw new MongoParseError('Invalid port (zero) with hostname');
       }
     } else {
-      throw new MongoDriverError('Either socketPath or host must be defined.');
+      throw new MongoInvalidArgumentError('Either socketPath or host must be defined.');
     }
     Object.freeze(this);
   }
@@ -1385,3 +1408,33 @@ export function emitWarningOnce(message: string): void {
     return emitWarning(message);
   }
 }
+
+/**
+ * Takes a JS object and joins the values into a string separated by ', '
+ */
+export function enumToString(en: Record<string, unknown>): string {
+  return Object.values(en).join(', ');
+}
+
+/**
+ * Determine if a server supports retryable writes.
+ *
+ * @internal
+ */
+export function supportsRetryableWrites(server: Server): boolean {
+  return (
+    !!server.loadBalanced ||
+    (server.description.maxWireVersion >= 6 &&
+      !!server.description.logicalSessionTimeoutMinutes &&
+      server.description.type !== ServerType.Standalone)
+  );
+}
+
+export function parsePackageVersion({ version }: { version: string }): {
+  major: number;
+  minor: number;
+  patch: number;
+} {
+  const [major, minor, patch] = version.split('.').map((n: string) => Number.parseInt(n, 10));
+  return { major, minor, patch };
+}