mongodb 4.1.0 → 4.1.4

package/src/db.ts

@@ -9,7 +9,7 @@ import {
 import { AggregationCursor } from './cursor/aggregation_cursor';
 import { Document, BSONSerializeOptions, resolveBSONOptions } from './bson';
 import { ReadPreference, ReadPreferenceLike } from './read_preference';
-import { MongoDriverError, MongoInvalidArgumentError } from './error';
+import { MongoAPIError, MongoInvalidArgumentError } from './error';
 import { Collection, CollectionOptions } from './collection';
 import { ChangeStream, ChangeStreamOptions } from './change_stream';
 import * as CONSTANTS from './constants';
@@ -289,7 +289,10 @@ export class Db {
    * @param pipeline - An array of aggregation stages to be executed
    * @param options - Optional settings for the command
    */
-  aggregate(pipeline: Document[] = [], options?: AggregateOptions): AggregationCursor {
+  aggregate<T = Document>(
+    pipeline: Document[] = [],
+    options?: AggregateOptions
+  ): AggregationCursor<T> {
     if (arguments.length > 2) {
       throw new MongoInvalidArgumentError('Method "db.aggregate()" accepts at most two arguments');
     }
@@ -319,16 +322,12 @@ export class Db {
    * @param name - the collection name we wish to access.
    * @returns return the new Collection instance
    */
-  collection<TSchema extends Document = Document>(name: string): Collection<TSchema>;
   collection<TSchema extends Document = Document>(
     name: string,
-    options?: CollectionOptions
+    options: CollectionOptions = {}
   ): Collection<TSchema> {
-    if (!options) {
-      options = {};
-    } else if (typeof options === 'function') {
-      // TODO(NODE-3485): Replace this with MongoDeprecationError
-      throw new MongoDriverError('The callback form of this helper has been removed.');
+    if (typeof options === 'function') {
+      throw new MongoInvalidArgumentError('The callback form of this helper has been removed.');
     }
     const finalOptions = resolveOptions(this, options);
     return new Collection<TSchema>(this, name, finalOptions);
@@ -701,7 +700,10 @@ export class Db {
     );
   }
 
-  /** Unref all sockets */
+  /**
+   * Unref all sockets
+   * @deprecated This function is deprecated and will be removed in the next major version.
+   */
   unref(): void {
     getTopology(this).unref();
   }
@@ -737,6 +739,7 @@ export class Db {
   }
 }
 
+// TODO(NODE-3484): Refactor into MongoDBNamespace
 // Validate the database name
 function validateDatabaseName(databaseName: string) {
   if (typeof databaseName !== 'string')
@@ -748,9 +751,6 @@ function validateDatabaseName(databaseName: string) {
   const invalidChars = [' ', '.', '$', '/', '\\'];
   for (let i = 0; i < invalidChars.length; i++) {
     if (databaseName.indexOf(invalidChars[i]) !== -1)
-      // TODO(NODE-3405): Change this out for a child of MongoParseError
-      throw new MongoDriverError(
-        `database names cannot contain the character '${invalidChars[i]}'`
-      );
+      throw new MongoAPIError(`database names cannot contain the character '${invalidChars[i]}'`);
   }
 }

package/src/deps.ts

@@ -1,7 +1,10 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 import { MongoMissingDependencyError } from './error';
 import type { MongoClient } from './mongo_client';
 import type { deserialize, Document, serialize } from './bson';
-import type { Callback } from './utils';
+import { Callback, parsePackageVersion } from './utils';
+
+export const PKG_VERSION = Symbol('kPkgVersion');
 
 function makeErrorModule(error: any) {
   const props = error ? { kModuleError: error } : {};
@@ -18,13 +21,12 @@ function makeErrorModule(error: any) {
   });
 }
 
-export let Kerberos:
-  | typeof import('kerberos')
-  | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
-  new MongoMissingDependencyError(
-    'Optional module `kerberos` not found. Please install it to enable kerberos authentication'
-  )
-);
+export let Kerberos: typeof import('kerberos') | { kModuleError: MongoMissingDependencyError } =
+  makeErrorModule(
+    new MongoMissingDependencyError(
+      'Optional module `kerberos` not found. Please install it to enable kerberos authentication'
+    )
+  );
 
 try {
   // Ensure you always wrap an optional require in the try block NODE-3199
@@ -41,9 +43,46 @@ export interface KerberosClient {
   unwrap: (challenge: string, callback?: Callback<string>) => Promise<string> | void;
 }
 
-export let Snappy:
-  | typeof import('snappy')
-  | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
+type SnappyLib = {
+  [PKG_VERSION]: { major: number; minor: number; patch: number };
+
+  /**
+   * - Snappy 6.x takes a callback and returns void
+   * - Snappy 7.x returns a promise
+   *
+   * In order to support both we must check the return value of the function
+   * @param buf - Buffer to be compressed
+   * @param callback - ONLY USED IN SNAPPY 6.x
+   */
+  compress(buf: Buffer): Promise<Buffer>;
+  compress(buf: Buffer, callback: (error?: Error, buffer?: Buffer) => void): Promise<Buffer> | void;
+  compress(
+    buf: Buffer,
+    callback?: (error?: Error, buffer?: Buffer) => void
+  ): Promise<Buffer> | void;
+
+  /**
+   * - Snappy 6.x takes a callback and returns void
+   * - Snappy 7.x returns a promise
+   *
+   * In order to support both we must check the return value of the function
+   * @param buf - Buffer to be compressed
+   * @param callback - ONLY USED IN SNAPPY 6.x
+   */
+  uncompress(buf: Buffer, opt: { asBuffer: true }): Promise<Buffer>;
+  uncompress(
+    buf: Buffer,
+    opt: { asBuffer: true },
+    callback: (error?: Error, buffer?: Buffer) => void
+  ): Promise<Buffer> | void;
+  uncompress(
+    buf: Buffer,
+    opt: { asBuffer: true },
+    callback?: (error?: Error, buffer?: Buffer) => void
+  ): Promise<Buffer> | void;
+};
+
+export let Snappy: SnappyLib | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
   new MongoMissingDependencyError(
     'Optional module `snappy` not found. Please install it to enable snappy compression'
   )
@@ -52,25 +91,65 @@ export let Snappy:
 try {
   // Ensure you always wrap an optional require in the try block NODE-3199
   Snappy = require('snappy');
+  try {
+    (Snappy as any)[PKG_VERSION] = parsePackageVersion(require('snappy/package.json'));
+  } catch {} // eslint-disable-line
 } catch {} // eslint-disable-line
 
-export let saslprep:
-  | typeof import('saslprep')
-  | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
-  new MongoMissingDependencyError(
-    'Optional module `saslprep` not found.' +
-      ' Please install it to enable Stringprep Profile for User Names and Passwords'
-  )
-);
+export let saslprep: typeof import('saslprep') | { kModuleError: MongoMissingDependencyError } =
+  makeErrorModule(
+    new MongoMissingDependencyError(
+      'Optional module `saslprep` not found.' +
+        ' Please install it to enable Stringprep Profile for User Names and Passwords'
+    )
+  );
 
 try {
   // Ensure you always wrap an optional require in the try block NODE-3199
   saslprep = require('saslprep');
 } catch {} // eslint-disable-line
 
-export let aws4:
-  | typeof import('aws4')
-  | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
+interface AWS4 {
+  /**
+   * Created these inline types to better assert future usage of this API
+   * @param options - options for request
+   * @param credentials - AWS credential details, sessionToken should be omitted entirely if its false-y
+   */
+  sign(
+    options: {
+      path: '/';
+      body: string;
+      host: string;
+      method: 'POST';
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded';
+        'Content-Length': number;
+        'X-MongoDB-Server-Nonce': string;
+        'X-MongoDB-GS2-CB-Flag': 'n';
+      };
+      service: string;
+      region: string;
+    },
+    credentials:
+      | {
+          accessKeyId: string;
+          secretAccessKey: string;
+          sessionToken: string;
+        }
+      | {
+          accessKeyId: string;
+          secretAccessKey: string;
+        }
+      | undefined
+  ): {
+    headers: {
+      Authorization: string;
+      'X-Amz-Date': string;
+    };
+  };
+}
+
+export let aws4: AWS4 | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
   new MongoMissingDependencyError(
     'Optional module `aws4` not found. Please install it to enable AWS authentication'
   )
@@ -91,7 +170,8 @@ export const AutoEncryptionLoggerLevel = Object.freeze({
 } as const);
 
 /** @public */
-export type AutoEncryptionLoggerLevel = typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel];
+export type AutoEncryptionLoggerLevel =
+  typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel];
 
 /** @public */
 export interface AutoEncryptionOptions {

package/src/error.ts

@@ -60,12 +60,12 @@ export const GET_MORE_RESUMABLE_CODES = new Set<number>([
 ]);
 
 /** @public */
-export interface ErrorDescription {
+export interface ErrorDescription extends Document {
   message?: string;
   errmsg?: string;
   $err?: string;
   errorLabels?: string[];
-  [key: string]: any;
+  errInfo?: Document;
 }
 
 /**
@@ -78,13 +78,17 @@ export interface ErrorDescription {
 export class MongoError extends Error {
   /** @internal */
   [kErrorLabels]: Set<string>;
+  /**
+   * This is a number in MongoServerError and a string in MongoDriverError
+   * @privateRemarks
+   * Define the type override on the subclasses when we can use the override keyword
+   */
   code?: number | string;
   topologyVersion?: TopologyVersion;
 
   constructor(message: string | Error) {
     if (message instanceof Error) {
       super(message.message);
-      this.stack = message.stack;
     } else {
       super(message);
     }
@@ -133,26 +137,21 @@ export class MongoError extends Error {
  * @category Error
  */
 export class MongoServerError extends MongoError {
-  code?: number;
   codeName?: string;
   writeConcernError?: Document;
+  errInfo?: Document;
+  ok?: number;
+  [key: string]: any;
 
-  constructor(message: Error | ErrorDescription) {
-    if (message instanceof Error) {
-      super(message);
-    } else {
-      super(message.message || message.errmsg || message.$err || 'n/a');
-      if (message.errorLabels) {
-        this[kErrorLabels] = new Set(message.errorLabels);
-      }
-
-      for (const name in message) {
-        if (name === 'errorLabels' || name === 'errmsg' || name === 'message') {
-          continue;
-        }
-
-        (this as any)[name] = message[name];
-      }
+  constructor(message: ErrorDescription) {
+    super(message.message || message.errmsg || message.$err || 'n/a');
+    if (message.errorLabels) {
+      this[kErrorLabels] = new Set(message.errorLabels);
+    }
+
+    for (const name in message) {
+      if (name !== 'errorLabels' && name !== 'errmsg' && name !== 'message')
+        this[name] = message[name];
     }
   }
 
@@ -168,7 +167,6 @@ export class MongoServerError extends MongoError {
  * @category Error
  */
 export class MongoDriverError extends MongoError {
-  code?: string;
   constructor(message: string) {
     super(message);
   }
@@ -189,7 +187,7 @@ export class MongoDriverError extends MongoError {
  */
 
 export class MongoAPIError extends MongoDriverError {
-  protected constructor(message: string) {
+  constructor(message: string) {
     super(message);
   }
 
@@ -209,7 +207,7 @@ export class MongoAPIError extends MongoDriverError {
  * @category Error
  */
 export class MongoRuntimeError extends MongoDriverError {
-  protected constructor(message: string) {
+  constructor(message: string) {
     super(message);
   }
 
@@ -226,45 +224,12 @@ export class MongoRuntimeError extends MongoDriverError {
  * @category Error
  */
 export class MongoBatchReExecutionError extends MongoAPIError {
-  constructor(message?: string) {
-    super(message || 'This batch has already been executed, create new batch to execute');
-  }
-
-  get name(): string {
-    return 'MongoBatchReExecutionError';
-  }
-}
-
-/**
- * An error generated when the user supplies an incorrect URI to the driver.
- *
- * @public
- * @category Error
- */
-export class MongoURIError extends MongoRuntimeError {
-  constructor(message: string) {
+  constructor(message = 'This batch has already been executed, create new batch to execute') {
     super(message);
   }
 
   get name(): string {
-    return 'MongoURIError';
-  }
-}
-
-/**
- * An error generated when the driver fails to compress data
- * before sending it to the server.
- *
- * @public
- * @category Error
- */
-export class MongoCompressionError extends MongoRuntimeError {
-  constructor(message: string) {
-    super(message);
-  }
-
-  get name(): string {
-    return 'MongoCompressionError';
+    return 'MongoBatchReExecutionError';
   }
 }
 
@@ -327,7 +292,7 @@ export class MongoTransactionError extends MongoAPIError {
  * @category Error
  */
 export class MongoExpiredSessionError extends MongoAPIError {
-  constructor(message: string) {
+  constructor(message = 'Cannot use a session that has ended') {
     super(message);
   }
 
@@ -376,8 +341,8 @@ export class MongoChangeStreamError extends MongoRuntimeError {
  * @category Error
  */
 export class MongoTailableCursorError extends MongoAPIError {
-  constructor(message?: string) {
-    super(message || 'Tailable cursor does not support this operation');
+  constructor(message = 'Tailable cursor does not support this operation') {
+    super(message);
   }
 
   get name(): string {
@@ -425,8 +390,8 @@ export class MongoGridFSChunkError extends MongoRuntimeError {
  * @category Error
  */
 export class MongoCursorInUseError extends MongoAPIError {
-  constructor(message?: string) {
-    super(message || 'Cursor is already initialized');
+  constructor(message = 'Cursor is already initialized') {
+    super(message);
   }
 
   get name(): string {
@@ -442,7 +407,7 @@ export class MongoCursorInUseError extends MongoAPIError {
  * @category Error
  */
 export class MongoServerClosedError extends MongoAPIError {
-  constructor(message: string) {
+  constructor(message = 'Server is closed') {
     super(message);
   }
 
@@ -475,7 +440,7 @@ export class MongoCursorExhaustedError extends MongoAPIError {
  * @category Error
  */
 export class MongoTopologyClosedError extends MongoAPIError {
-  constructor(message: string) {
+  constructor(message = 'Topology is closed') {
     super(message);
   }
 
@@ -682,13 +647,15 @@ function makeWriteConcernResultObject(input: any) {
 export class MongoWriteConcernError extends MongoServerError {
   /** The result document (provided if ok: 1) */
   result?: Document;
+  errInfo?: Document;
 
-  constructor(message: ErrorDescription, result: Document) {
+  constructor(message: ErrorDescription, result?: Document) {
     if (result && Array.isArray(result.errorLabels)) {
       message.errorLabels = result.errorLabels;
     }
 
     super(message);
+    this.errInfo = message.errInfo;
 
     if (result != null) {
       this.result = makeWriteConcernResultObject(result);

package/src/gridfs/download.ts

@@ -1,5 +1,10 @@
 import { Readable } from 'stream';
-import { AnyError, MongoDriverError, MongoInvalidArgumentError } from '../error';
+import {
+  MongoRuntimeError,
+  MongoGridFSChunkError,
+  MongoGridFSStreamError,
+  MongoInvalidArgumentError
+} from '../error';
 import type { Document } from '../bson';
 import type { FindOptions } from '../operations/find';
 import type { Sort } from '../sort';
@@ -68,7 +73,7 @@ export interface GridFSBucketReadStreamPrivate {
  * Do not instantiate this class directly. Use `openDownloadStream()` instead.
  * @public
  */
-export class GridFSBucketReadStream extends Readable {
+export class GridFSBucketReadStream extends Readable implements NodeJS.ReadableStream {
   /** @internal */
   s: GridFSBucketReadStreamPrivate;
 
@@ -195,7 +200,7 @@ export class GridFSBucketReadStream extends Readable {
 
 function throwIfInitialized(stream: GridFSBucketReadStream): void {
   if (stream.s.init) {
-    throw new MongoDriverError('Options cannot be changed after the stream is initialized');
+    throw new MongoGridFSStreamError('Options cannot be changed after the stream is initialized');
   }
 }
 
@@ -209,7 +214,8 @@ function doRead(stream: GridFSBucketReadStream): void {
       return;
     }
     if (error) {
-      return __handleError(stream, error);
+      stream.emit(GridFSBucketReadStream.ERROR, error);
+      return;
     }
     if (!doc) {
       stream.push(null);
@@ -218,7 +224,7 @@ function doRead(stream: GridFSBucketReadStream): void {
         if (!stream.s.cursor) return;
         stream.s.cursor.close(error => {
           if (error) {
-            __handleError(stream, error);
+            stream.emit(GridFSBucketReadStream.ERROR, error);
             return;
           }
 
@@ -234,31 +240,38 @@ function doRead(stream: GridFSBucketReadStream): void {
     const bytesRemaining = stream.s.file.length - stream.s.bytesRead;
     const expectedN = stream.s.expected++;
     const expectedLength = Math.min(stream.s.file.chunkSize, bytesRemaining);
-    let errmsg: string;
     if (doc.n > expectedN) {
-      errmsg = `ChunkIsMissing: Got unexpected n: ${doc.n}, expected: ${expectedN}`;
-      return __handleError(stream, new MongoDriverError(errmsg));
+      return stream.emit(
+        GridFSBucketReadStream.ERROR,
+        new MongoGridFSChunkError(
+          `ChunkIsMissing: Got unexpected n: ${doc.n}, expected: ${expectedN}`
+        )
+      );
     }
 
     if (doc.n < expectedN) {
-      errmsg = `ExtraChunk: Got unexpected n: ${doc.n}, expected: ${expectedN}`;
-      return __handleError(stream, new MongoDriverError(errmsg));
+      return stream.emit(
+        GridFSBucketReadStream.ERROR,
+        new MongoGridFSChunkError(`ExtraChunk: Got unexpected n: ${doc.n}, expected: ${expectedN}`)
+      );
     }
 
     let buf = Buffer.isBuffer(doc.data) ? doc.data : doc.data.buffer;
 
     if (buf.byteLength !== expectedLength) {
       if (bytesRemaining <= 0) {
-        errmsg = `ExtraChunk: Got unexpected n: ${doc.n}`;
-        return __handleError(stream, new MongoDriverError(errmsg));
+        return stream.emit(
+          GridFSBucketReadStream.ERROR,
+          new MongoGridFSChunkError(`ExtraChunk: Got unexpected n: ${doc.n}`)
+        );
       }
 
-      errmsg =
-        'ChunkIsWrongSize: Got unexpected length: ' +
-        buf.byteLength +
-        ', expected: ' +
-        expectedLength;
-      return __handleError(stream, new MongoDriverError(errmsg));
+      return stream.emit(
+        GridFSBucketReadStream.ERROR,
+        new MongoGridFSChunkError(
+          `ChunkIsWrongSize: Got unexpected length: ${buf.byteLength}, expected: ${expectedLength}`
+        )
+      );
     }
 
     stream.s.bytesRead += buf.byteLength;
@@ -305,7 +318,7 @@ function init(stream: GridFSBucketReadStream): void {
 
   stream.s.files.findOne(stream.s.filter, findOneOptions, (error, doc) => {
     if (error) {
-      return __handleError(stream, error);
+      return stream.emit(GridFSBucketReadStream.ERROR, error);
     }
 
     if (!doc) {
@@ -313,9 +326,10 @@ function init(stream: GridFSBucketReadStream): void {
         ? stream.s.filter._id.toString()
         : stream.s.filter.filename;
       const errmsg = `FileNotFound: file ${identifier} was not found`;
-      const err = new MongoDriverError(errmsg);
+      // TODO(NODE-3483)
+      const err = new MongoRuntimeError(errmsg);
       err.code = 'ENOENT'; // TODO: NODE-3338 set property as part of constructor
-      return __handleError(stream, err);
+      return stream.emit(GridFSBucketReadStream.ERROR, err);
     }
 
     // If document is empty, kill the stream immediately and don't
@@ -336,7 +350,7 @@ function init(stream: GridFSBucketReadStream): void {
     try {
       stream.s.bytesToSkip = handleStartOption(stream, doc, stream.s.options);
     } catch (error) {
-      return __handleError(stream, error);
+      return stream.emit(GridFSBucketReadStream.ERROR, error);
     }
 
     const filter: Document = { files_id: doc._id };
@@ -362,7 +376,7 @@ function init(stream: GridFSBucketReadStream): void {
     try {
       stream.s.bytesToTrim = handleEndOption(stream, doc, stream.s.cursor, stream.s.options);
     } catch (error) {
-      return __handleError(stream, error);
+      return stream.emit(GridFSBucketReadStream.ERROR, error);
     }
 
     stream.emit(GridFSBucketReadStream.FILE, doc);
@@ -438,7 +452,3 @@ function handleEndOption(
   }
   throw new MongoInvalidArgumentError('End option must be defined');
 }
-
-function __handleError(stream: GridFSBucketReadStream, error?: AnyError): void {
-  stream.emit(GridFSBucketReadStream.ERROR, error);
-}

package/src/gridfs/index.ts

@@ -1,4 +1,4 @@
-import { MongoDriverError } from '../error';
+import { MongoRuntimeError } from '../error';
 import {
   GridFSBucketReadStream,
   GridFSBucketReadStreamOptions,
@@ -229,7 +229,7 @@ function _delete(bucket: GridFSBucket, id: ObjectId, callback: Callback<void>):
       if (!res?.deletedCount) {
         // TODO(NODE-3483): Replace with more appropriate error
         // Consider creating new error MongoGridFSFileNotFoundError
-        return callback(new MongoDriverError(`File not found for id ${id}`));
+        return callback(new MongoRuntimeError(`File not found for id ${id}`));
       }
 
       return callback();
@@ -251,7 +251,7 @@ function _rename(
     }
 
     if (!res?.matchedCount) {
-      return callback(new MongoDriverError(`File with id ${id} not found`));
+      return callback(new MongoRuntimeError(`File with id ${id} not found`));
     }
 
     return callback();