Node.js MongoDB Driver API

Source: node_modules/mongodb-core/lib/error.js

  1. 'use strict';
  3. var util = require('util');
  5. /**
  6.  * Creates a new MongoError
  7.  * @class
  8.  * @augments Error
  9.  * @param {Error|string|object} message The error message
  10.  * @property {string} message The error message
  11.  * @property {string} stack The error call stack
  12.  * @return {MongoError} A MongoError instance
  13.  */
  14. function MongoError(message) {
  15.   var tmp = Error.apply(this, arguments);
  16.   tmp.name = this.name = 'MongoError';
  18.   if (message instanceof Error) {
  19.     this.message = message.message;
  20.     this.stack = message.stack;
  21.   } else {
  22.     if (typeof message === 'string') {
  23.       this.message = message;
  24.     } else {
  25.       this.message = message.message || message.errmsg || message.$err || 'n/a';
  26.       for (var name in message) {
  27.         this[name] = message[name];
  28.       }
  29.     }
  30.     if (Error.captureStackTrace) {
  31.       Error.captureStackTrace(this, this.constructor);
  32.     }
  33.   }
  34. }
  35. util.inherits(MongoError, Error);
  37. /**
  38.  * Creates a new MongoError object
  39.  * @method
  40.  * @param {Error|string|object} options The options used to create the error.
  41.  * @return {MongoError} A MongoError instance
  42.  * @deprecated Use `new MongoError()` instead.
  43.  */
  44. MongoError.create = function(options) {
  45.   return new MongoError(options);
  46. };
  48. /**
  49.  * Creates a new MongoNetworkError
  50.  * @class
  51.  * @param {Error|string|object} message The error message
  52.  * @property {string} message The error message
  53.  * @property {string} stack The error call stack
  54.  * @return {MongoNetworkError} A MongoNetworkError instance
  55.  * @extends {MongoError}
  56.  */
  57. var MongoNetworkError = function(message) {
  58.   MongoError.call(this, message);
  59.   this.name = 'MongoNetworkError';
  60. };
  61. util.inherits(MongoNetworkError, MongoError);
  63. /**
  64.  * An error used when attempting to parse a value (like a connection string)
  65.  *
  66.  * @class
  67.  * @param {Error|string|object} message The error message
  68.  * @property {string} message The error message
  69.  * @return {MongoParseError} A MongoNetworkError instance
  70.  * @extends {MongoError}
  71.  */
  72. const MongoParseError = function(message) {
  73.   MongoError.call(this, message);
  74.   this.name = 'MongoParseError';
  75. };
  76. util.inherits(MongoParseError, MongoError);
  78. // see: https://github.com/mongodb/specifications/blob/master/source/retryable-writes/retryable-writes.rst#terms
  79. const RETRYABLE_ERROR_CODES = new Set([
  80.   6, // HostUnreachable
  81.   7, // HostNotFound
  82.   64, // WriteConcernFailed
  83.   89, // NetworkTimeout
  84.   91, // ShutdownInProgress
  85.   189, // PrimarySteppedDown
  86.   9001, // SocketException
  87.   11600, // InterruptedAtShutdown
  88.   11602, // InterruptedDueToReplStateChange
  89.   10107, // NotMaster
  90.   13435, // NotMasterNoSlaveOk
  91.   13436 // NotMasterOrSecondary
  92. ]);
  94. function isRetryableError(error) {
  95.   if (
  96.     RETRYABLE_ERROR_CODES.has(error.code) ||
  97.     error instanceof MongoNetworkError ||
  98.     error.message.match(/not master/) ||
  99.     error.message.match(/node is recovering/)
  100.   ) {
  101.     return true;
  102.   }
  104.   return false;
  105. }
  107. module.exports = {
  108.   MongoError,
  109.   MongoNetworkError,
  110.   MongoParseError,
  111.   isRetryableError
  112. };