mongodb 4.0.0 → 4.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "4.0.0",
+  "version": "4.1.2",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -31,68 +31,57 @@
     "name": "The MongoDB NodeJS Team",
     "email": "dbx-node@mongodb.com"
   },
-  "peerOptionalDependencies": {
-    "kerberos": "^1.1.0",
-    "mongodb-client-encryption": "^1.0.0",
-    "snappy": "^6.1.1",
-    "bson-ext": "^2.0.0"
-  },
   "dependencies": {
-    "bson": "^4.4.0",
-    "denque": "^1.5.0",
-    "mongodb-connection-string-url": "^1.0.0"
+    "bson": "^4.5.2",
+    "denque": "^2.0.1",
+    "mongodb-connection-string-url": "^2.0.0"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@microsoft/api-extractor": "^7.16.1",
+    "@microsoft/api-extractor": "^7.18.7",
     "@microsoft/tsdoc-config": "^0.15.2",
-    "@types/aws4": "^1.5.1",
-    "@types/chai": "^4.2.14",
+    "@types/chai": "^4.2.21",
     "@types/chai-subset": "^1.3.3",
-    "@types/kerberos": "^1.1.0",
-    "@types/mocha": "^8.2.0",
-    "@types/node": "^15.3.1",
-    "@types/saslprep": "^1.0.0",
-    "@types/semver": "^7.3.4",
-    "@typescript-eslint/eslint-plugin": "^4.19.0",
-    "@typescript-eslint/parser": "^4.19.0",
-    "chai": "^4.2.0",
+    "@types/kerberos": "^1.1.1",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.7.13",
+    "@types/saslprep": "^1.0.1",
+    "@types/semver": "^7.3.8",
+    "@types/whatwg-url": "^8.2.1",
+    "@typescript-eslint/eslint-plugin": "^4.31.0",
+    "@typescript-eslint/parser": "^4.31.0",
+    "bluebird": "^3.7.2",
+    "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
-    "chalk": "^4.1.0",
+    "chalk": "^4.1.2",
     "co": "4.6.0",
-    "coveralls": "^3.0.11",
     "downlevel-dts": "^0.7.0",
-    "eslint": "^7.26.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-jsdoc": "^30.7.8",
-    "eslint-plugin-prettier": "^3.1.3",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
-    "js-yaml": "^3.14.0",
-    "jsdoc": "^3.6.4",
+    "js-yaml": "^4.1.0",
+    "jsdoc": "^3.6.7",
     "lodash.camelcase": "^4.3.0",
-    "madge": "^4.0.2",
-    "mocha": "^7.1.1",
-    "mocha-sinon": "^2.1.0",
+    "mocha": "^9.1.1",
+    "mocha-sinon": "^2.1.2",
     "mongodb-mock-server": "^2.0.1",
     "nyc": "^15.1.0",
-    "prettier": "2.1.1",
+    "prettier": "^2.3.2",
     "rimraf": "^3.0.2",
-    "semver": "^5.5.0",
-    "sinon": "^4.3.0",
-    "sinon-chai": "^3.2.0",
-    "snappy": "^6.3.0",
+    "semver": "^7.3.5",
+    "sinon": "^11.1.2",
+    "sinon-chai": "^3.7.0",
     "source-map-support": "^0.5.19",
-    "standard-version": "^9.3.0",
-    "through2": "^3.0.1",
-    "ts-node": "^10.0.0",
+    "standard-version": "^9.3.1",
+    "ts-node": "^10.2.1",
     "tsd": "^0.17.0",
-    "typedoc": "^0.21.0",
-    "typescript": "^4.3.4",
+    "typedoc": "^0.21.9",
+    "typescript": "4.3.5",
     "typescript-cached-transpile": "^0.0.6",
-    "worker-farm": "^1.5.0",
-    "wtfnode": "^0.8.2",
     "xml2js": "^0.4.23",
-    "yargs": "^14.2.0"
+    "yargs": "^17.1.1"
   },
   "license": "Apache-2.0",
   "engines": {
@@ -103,7 +92,7 @@
   },
   "homepage": "https://github.com/mongodb/node-mongodb-native",
   "optionalDependencies": {
-    "saslprep": "^1.0.0"
+    "saslprep": "^1.0.3"
   },
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
@@ -112,8 +101,9 @@
     "build:docs": "typedoc",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run check:test",
-    "check:lint": "npm run build:dts && npm run check:dts && npm run check:eslint",
+    "check:lint": "npm run build:dts && npm run check:dts && npm run check:eslint && npm run check:tsd",
     "check:eslint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
+    "check:tsd": "tsd --version && tsd",
     "check:dts": "tsc --noEmit mongodb.d.ts && tsd",
     "check:test": "mocha --recursive test/functional test/unit",
     "check:ts": "tsc -v && tsc --noEmit",
@@ -129,6 +119,12 @@
     "test": "npm run check:lint && npm run check:test"
   },
   "tsd": {
-    "directory": "test/types"
+    "directory": "test/types",
+    "compilerOptions": {
+      "strict": true,
+      "target": "esnext",
+      "module": "commonjs",
+      "moduleResolution": "node"
+    }
   }
 }

package/src/bson.ts

@@ -7,6 +7,7 @@ import type {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 let BSON = require('bson');
 try {
+  // Ensure you always wrap an optional require in the try block NODE-3199
   BSON = require('bson-ext');
 } catch {} // eslint-disable-line
 

package/src/bulk/common.ts

@@ -5,7 +5,8 @@ import {
   AnyError,
   MONGODB_ERROR_CODES,
   MongoServerError,
-  MongoDriverError
+  MongoInvalidArgumentError,
+  MongoBatchReExecutionError
 } from '../error';
 import {
   applyRetryableWrites,
@@ -25,7 +26,10 @@ import type { Collection } from '../collection';
 import type { Topology } from '../sdam/topology';
 import type { CommandOperationOptions, CollationOptions } from '../operations/command';
 import type { Hint } from '../operations/operation';
-import type { Filter, OptionalId, UpdateFilter } from '../mongo_types';
+import type { Filter, OneOrMore, OptionalId, UpdateFilter } from '../mongo_types';
+
+/** @internal */
+const kServerError = Symbol('serverError');
 
 /** @public */
 export const BatchType = Object.freeze({
@@ -308,9 +312,7 @@ export class BulkWriteResult {
         if (i === 0) errmsg = errmsg + ' and ';
       }
 
-      return new WriteConcernError(
-        new MongoServerError({ errmsg: errmsg, code: MONGODB_ERROR_CODES.WriteConcernFailed })
-      );
+      return new WriteConcernError({ errmsg, code: MONGODB_ERROR_CODES.WriteConcernFailed });
     }
   }
 
@@ -327,34 +329,52 @@ export class BulkWriteResult {
   }
 }
 
+/** @public */
+export interface WriteConcernErrorData {
+  code: number;
+  errmsg: string;
+  errInfo?: Document;
+}
+
 /**
  * An error representing a failure by the server to apply the requested write concern to the bulk operation.
  * @public
  * @category Error
  */
 export class WriteConcernError {
-  err: MongoServerError;
+  /** @internal */
+  [kServerError]: WriteConcernErrorData;
 
-  constructor(err: MongoServerError) {
-    this.err = err;
+  constructor(error: WriteConcernErrorData) {
+    this[kServerError] = error;
   }
 
   /** Write concern error code. */
   get code(): number | undefined {
-    return this.err.code;
+    return this[kServerError].code;
   }
 
   /** Write concern error message. */
-  get errmsg(): string {
-    return this.err.errmsg;
+  get errmsg(): string | undefined {
+    return this[kServerError].errmsg;
   }
 
-  toJSON(): { code?: number; errmsg: string } {
-    return { code: this.err.code, errmsg: this.err.errmsg };
+  /** Write concern error info. */
+  get errInfo(): Document | undefined {
+    return this[kServerError].errInfo;
+  }
+
+  /** @deprecated The `err` prop that contained a MongoServerError has been deprecated. */
+  get err(): WriteConcernErrorData {
+    return this[kServerError];
+  }
+
+  toJSON(): WriteConcernErrorData {
+    return this[kServerError];
   }
 
   toString(): string {
-    return `WriteConcernError(${this.err.errmsg})`;
+    return `WriteConcernError(${this.errmsg})`;
   }
 }
 
@@ -363,6 +383,7 @@ export interface BulkWriteOperationError {
   index: number;
   code: number;
   errmsg: string;
+  errInfo: Document;
   op: Document | UpdateStatement | DeleteStatement;
 }
 
@@ -393,6 +414,11 @@ export class WriteError {
     return this.err.errmsg;
   }
 
+  /** WriteError details. */
+  get errInfo(): Document | undefined {
+    return this.err.errInfo;
+  }
+
   /** Returns the underlying operation that caused the error */
   getOperation(): Document {
     return this.err.op;
@@ -433,6 +459,7 @@ function mergeBatchResults(
       index: 0,
       code: result.code || 0,
       errmsg: result.message,
+      errInfo: result.errInfo,
       op: batch.operations[0]
     };
 
@@ -535,6 +562,7 @@ function mergeBatchResults(
         index: batch.originalIndexes[result.writeErrors[i].index],
         code: result.writeErrors[i].code,
         errmsg: result.writeErrors[i].errmsg,
+        errInfo: result.writeErrors[i].errInfo,
         op: batch.operations[result.writeErrors[i].index]
       };
 
@@ -655,17 +683,12 @@ function handleMongoWriteConcernError(
 ) {
   mergeBatchResults(batch, bulkResult, undefined, err.result);
 
-  // TODO: Remove multiple levels of wrapping (NODE-3337)
-  const wrappedWriteConcernError = new WriteConcernError(
-    new MongoServerError({
-      errmsg: err.result?.writeConcernError.errmsg,
-      code: err.result?.writeConcernError.result
-    })
-  );
-
   callback(
     new MongoBulkWriteError(
-      new MongoServerError(wrappedWriteConcernError),
+      {
+        message: err.result?.writeConcernError.errmsg,
+        code: err.result?.writeConcernError.result
+      },
       new BulkWriteResult(bulkResult)
     )
   );
@@ -678,13 +701,28 @@ function handleMongoWriteConcernError(
  */
 export class MongoBulkWriteError extends MongoServerError {
   result: BulkWriteResult;
+  writeErrors: OneOrMore<WriteError> = [];
+  err?: WriteConcernError;
 
   /** Creates a new MongoBulkWriteError */
-  constructor(error: AnyError, result: BulkWriteResult) {
-    super(error as Error);
-    Object.assign(this, error);
+  constructor(
+    error:
+      | { message: string; code: number; writeErrors?: WriteError[] }
+      | WriteConcernError
+      | AnyError,
+    result: BulkWriteResult
+  ) {
+    super(error);
+
+    if (error instanceof WriteConcernError) this.err = error;
+    else if (!(error instanceof Error)) {
+      this.message = error.message;
+      this.code = error.code;
+      this.writeErrors = error.writeErrors ?? [];
+    }
 
     this.result = result;
+    Object.assign(this, error);
   }
 
   get name(): string {
@@ -753,7 +791,7 @@ export class FindOperators {
   /** Add a single update operation to the bulk operation */
   updateOne(updateDocument: Document): BulkOperationBase {
     if (!hasAtomicOperators(updateDocument)) {
-      throw new MongoDriverError('Update document requires atomic operators');
+      throw new MongoInvalidArgumentError('Update document requires atomic operators');
     }
 
     const currentOp = buildCurrentOp(this.bulkOperation);
@@ -766,7 +804,7 @@ export class FindOperators {
   /** Add a replace one operation to the bulk operation */
   replaceOne(replacement: Document): BulkOperationBase {
     if (hasAtomicOperators(replacement)) {
-      throw new MongoDriverError('Replacement document must not use atomic operators');
+      throw new MongoInvalidArgumentError('Replacement document must not use atomic operators');
     }
 
     const currentOp = buildCurrentOp(this.bulkOperation);
@@ -1049,7 +1087,7 @@ export abstract class BulkOperationBase {
    */
   find(selector: Document): FindOperators {
     if (!selector) {
-      throw new MongoDriverError('Bulk find operation must specify a selector');
+      throw new MongoInvalidArgumentError('Bulk find operation must specify a selector');
     }
 
     // Save a current selector
@@ -1083,7 +1121,7 @@ export abstract class BulkOperationBase {
     if ('replaceOne' in op || 'updateOne' in op || 'updateMany' in op) {
       if ('replaceOne' in op) {
         if ('q' in op.replaceOne) {
-          throw new MongoDriverError('Raw operations are not allowed');
+          throw new MongoInvalidArgumentError('Raw operations are not allowed');
         }
         const updateStatement = makeUpdateStatement(
           op.replaceOne.filter,
@@ -1091,35 +1129,35 @@ export abstract class BulkOperationBase {
           { ...op.replaceOne, multi: false }
         );
         if (hasAtomicOperators(updateStatement.u)) {
-          throw new MongoDriverError('Replacement document must not use atomic operators');
+          throw new MongoInvalidArgumentError('Replacement document must not use atomic operators');
         }
         return this.addToOperationsList(BatchType.UPDATE, updateStatement);
       }
 
       if ('updateOne' in op) {
         if ('q' in op.updateOne) {
-          throw new MongoDriverError('Raw operations are not allowed');
+          throw new MongoInvalidArgumentError('Raw operations are not allowed');
         }
         const updateStatement = makeUpdateStatement(op.updateOne.filter, op.updateOne.update, {
           ...op.updateOne,
           multi: false
         });
         if (!hasAtomicOperators(updateStatement.u)) {
-          throw new MongoDriverError('Update document requires atomic operators');
+          throw new MongoInvalidArgumentError('Update document requires atomic operators');
         }
         return this.addToOperationsList(BatchType.UPDATE, updateStatement);
       }
 
       if ('updateMany' in op) {
         if ('q' in op.updateMany) {
-          throw new MongoDriverError('Raw operations are not allowed');
+          throw new MongoInvalidArgumentError('Raw operations are not allowed');
         }
         const updateStatement = makeUpdateStatement(op.updateMany.filter, op.updateMany.update, {
           ...op.updateMany,
           multi: true
         });
         if (!hasAtomicOperators(updateStatement.u)) {
-          throw new MongoDriverError('Update document requires atomic operators');
+          throw new MongoInvalidArgumentError('Update document requires atomic operators');
         }
         return this.addToOperationsList(BatchType.UPDATE, updateStatement);
       }
@@ -1127,7 +1165,7 @@ export abstract class BulkOperationBase {
 
     if ('deleteOne' in op) {
       if ('q' in op.deleteOne) {
-        throw new MongoDriverError('Raw operations are not allowed');
+        throw new MongoInvalidArgumentError('Raw operations are not allowed');
       }
       return this.addToOperationsList(
         BatchType.DELETE,
@@ -1137,7 +1175,7 @@ export abstract class BulkOperationBase {
 
     if ('deleteMany' in op) {
       if ('q' in op.deleteMany) {
-        throw new MongoDriverError('Raw operations are not allowed');
+        throw new MongoInvalidArgumentError('Raw operations are not allowed');
       }
       return this.addToOperationsList(
         BatchType.DELETE,
@@ -1146,7 +1184,7 @@ export abstract class BulkOperationBase {
     }
 
     // otherwise an unknown operation was provided
-    throw new MongoDriverError(
+    throw new MongoInvalidArgumentError(
       'bulkWrite only supports insertOne, updateOne, updateMany, deleteOne, deleteMany'
     );
   }
@@ -1180,7 +1218,7 @@ export abstract class BulkOperationBase {
     options = options ?? {};
 
     if (this.s.executed) {
-      return handleEarlyError(new MongoDriverError('Batch cannot be re-executed'), callback);
+      return handleEarlyError(new MongoBatchReExecutionError(), callback);
     }
 
     const writeConcern = WriteConcern.fromOptions(options);
@@ -1198,7 +1236,9 @@ export abstract class BulkOperationBase {
     }
     // If we have no operations in the bulk raise an error
     if (this.s.batches.length === 0) {
-      const emptyBatchError = new MongoDriverError('Invalid BulkOperation, Batch cannot be empty');
+      const emptyBatchError = new MongoInvalidArgumentError(
+        'Invalid BulkOperation, Batch cannot be empty'
+      );
       return handleEarlyError(emptyBatchError, callback);
     }
 
@@ -1222,11 +1262,11 @@ export abstract class BulkOperationBase {
 
       callback(
         new MongoBulkWriteError(
-          new MongoServerError({
+          {
             message: msg,
             code: this.s.bulkResult.writeErrors[0].code,
             writeErrors: this.s.bulkResult.writeErrors
-          }),
+          },
           writeResult
         )
       );
@@ -1236,7 +1276,7 @@ export abstract class BulkOperationBase {
 
     const writeConcernError = writeResult.getWriteConcernError();
     if (writeConcernError) {
-      callback(new MongoBulkWriteError(new MongoServerError(writeConcernError), writeResult));
+      callback(new MongoBulkWriteError(writeConcernError, writeResult));
       return true;
     }
   }

package/src/bulk/ordered.ts

@@ -4,7 +4,7 @@ import type { Document } from '../bson';
 import type { Collection } from '../collection';
 import type { UpdateStatement } from '../operations/update';
 import type { DeleteStatement } from '../operations/delete';
-import { MongoDriverError } from '../error';
+import { MongoInvalidArgumentError } from '../error';
 
 /** @public */
 export class OrderedBulkOperation extends BulkOperationBase {
@@ -26,7 +26,8 @@ export class OrderedBulkOperation extends BulkOperationBase {
 
     // Throw error if the doc is bigger than the max BSON size
     if (bsonSize >= this.s.maxBsonObjectSize)
-      throw new MongoDriverError(
+      // TODO(NODE-3483): Change this to MongoBSONError
+      throw new MongoInvalidArgumentError(
         `Document is larger than the maximum size ${this.s.maxBsonObjectSize}`
       );
 
@@ -68,7 +69,7 @@ export class OrderedBulkOperation extends BulkOperationBase {
 
     // We have an array of documents
     if (Array.isArray(document)) {
-      throw new MongoDriverError('Operation passed in cannot be an Array');
+      throw new MongoInvalidArgumentError('Operation passed in cannot be an Array');
     }
 
     this.s.currentBatch.originalIndexes.push(this.s.currentIndex);

package/src/bulk/unordered.ts

@@ -5,7 +5,7 @@ import type { Document } from '../bson';
 import type { Collection } from '../collection';
 import type { UpdateStatement } from '../operations/update';
 import type { DeleteStatement } from '../operations/delete';
-import { MongoDriverError } from '../error';
+import { MongoInvalidArgumentError } from '../error';
 
 /** @public */
 export class UnorderedBulkOperation extends BulkOperationBase {
@@ -36,7 +36,8 @@ export class UnorderedBulkOperation extends BulkOperationBase {
 
     // Throw error if the doc is bigger than the max BSON size
     if (bsonSize >= this.s.maxBsonObjectSize) {
-      throw new MongoDriverError(
+      // TODO(NODE-3483): Change this to MongoBSONError
+      throw new MongoInvalidArgumentError(
         `Document is larger than the maximum size ${this.s.maxBsonObjectSize}`
       );
     }
@@ -79,7 +80,7 @@ export class UnorderedBulkOperation extends BulkOperationBase {
 
     // We have an array of documents
     if (Array.isArray(document)) {
-      throw new MongoDriverError('Operation passed in cannot be an Array');
+      throw new MongoInvalidArgumentError('Operation passed in cannot be an Array');
     }
 
     this.s.currentBatch.operations.push(document);