fix(topology): add new error for retryWrites on MMAPv1

Fixes NODE-2098

Author: kvwalker

lib/core/sdam/topology.js

@@ -25,6 +25,7 @@ const createClientInfo = require('../topologies/shared').createClientInfo;
 const MongoError = require('../error').MongoError;
 const resolveClusterTime = require('../topologies/shared').resolveClusterTime;
 const SrvPoller = require('./srv_polling').SrvPoller;
+const getMMAPError = require('../topologies/shared').getMMAPError;
 
 // Global state
 let globalTopologyCounter = 0;
@@ -972,6 +973,7 @@ function executeWriteOperation(args, options, callback) {
     const handler = (err, result) => {
       if (!err) return callback(null, result);
       if (!isRetryableError(err)) {
+        err = getMMAPError(err);
         return callback(err);
       }
 

lib/core/topologies/mongos.js

@@ -17,6 +17,7 @@ const isRetryableWritesSupported = require('./shared').isRetryableWritesSupporte
 const relayEvents = require('../utils').relayEvents;
 const isRetryableError = require('../error').isRetryableError;
 const BSON = retrieveBSON();
+const getMMAPError = require('./shared').getMMAPError;
 
 /**
  * @fileOverview The **Mongos** class is a class that represents a Mongos Proxy topology and is
@@ -880,6 +881,7 @@ function executeWriteOperation(args, options, callback) {
   const handler = (err, result) => {
     if (!err) return callback(null, result);
     if (!isRetryableError(err) || !willRetryWrite) {
+      err = getMMAPError(err);
       return callback(err);
     }
 

lib/core/topologies/replset.js

@@ -20,6 +20,7 @@ const relayEvents = require('../utils').relayEvents;
 const isRetryableError = require('../error').isRetryableError;
 const BSON = retrieveBSON();
 const calculateDurationInMs = require('../utils').calculateDurationInMs;
+const getMMAPError = require('./shared').getMMAPError;
 
 //
 // States
@@ -1190,6 +1191,7 @@ function executeWriteOperation(args, options, callback) {
   const handler = (err, result) => {
     if (!err) return callback(null, result);
     if (!isRetryableError(err)) {
+      err = getMMAPError(err);
       return callback(err);
     }
 

lib/core/topologies/shared.js

@@ -5,6 +5,9 @@ const f = require('util').format;
 const ReadPreference = require('./read_preference');
 const Buffer = require('safe-buffer').Buffer;
 const TopologyType = require('../sdam/topology_description').TopologyType;
+const MongoError = require('../error').MongoError;
+
+const MMAPv1_RETRY_WRITES_ERROR_CODE = 20;
 
 /**
  * Emit event if it exists
@@ -437,6 +440,24 @@ const isRetryableWritesSupported = function(topology) {
   return true;
 };
 
+const MMAPv1_RETRY_WRITES_ERROR_MESSAGE =
+  'This MongoDB deployment does not support retryable writes. Please add retryWrites=false to your connection string.';
+
+function getMMAPError(err) {
+  if (err.code !== MMAPv1_RETRY_WRITES_ERROR_CODE || !err.errmsg.includes('Transaction numbers')) {
+    return err;
+  }
+
+  // According to the retryable writes spec, we must replace the error message in this case.
+  // We need to replace err.message so the thrown message is correct and we need to replace err.errmsg to meet the spec requirement.
+  const newErr = new MongoError({
+    message: MMAPv1_RETRY_WRITES_ERROR_MESSAGE,
+    errmsg: MMAPv1_RETRY_WRITES_ERROR_MESSAGE,
+    originalError: err
+  });
+  return newErr;
+}
+
 module.exports.SessionMixins = SessionMixins;
 module.exports.resolveClusterTime = resolveClusterTime;
 module.exports.inquireServerState = inquireServerState;
@@ -451,3 +472,4 @@ module.exports.diff = diff;
 module.exports.Interval = Interval;
 module.exports.Timeout = Timeout;
 module.exports.isRetryableWritesSupported = isRetryableWritesSupported;
+module.exports.getMMAPError = getMMAPError;