fix(NODE-6864): socket errors are not always converted to MongoNetworkErrors

Author: nbbeeken

src/cmap/connection.ts

@@ -246,9 +246,9 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
     this.lastUseTime = now();
 
     this.messageStream = this.socket
-      .on('error', this.onError.bind(this))
+      .on('error', this.onSocketError.bind(this))
       .pipe(new SizedMessageTransform({ connection: this }))
-      .on('error', this.onError.bind(this));
+      .on('error', this.onTransformError.bind(this));
     this.socket.on('close', this.onClose.bind(this));
     this.socket.on('timeout', this.onTimeout.bind(this));
 
@@ -303,6 +303,14 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
     this.lastUseTime = now();
   }
 
+  private onSocketError(cause: Error) {
+    this.onError(new MongoNetworkError(cause.message, { cause }));
+  }
+
+  private onTransformError(error: Error) {
+    this.onError(error);
+  }
+
   public onError(error: Error) {
     this.cleanup(error);
   }
@@ -768,7 +776,6 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
     } finally {
       this.dataEvents = null;
       this.messageStream.pause();
-      this.throwIfAborted();
     }
   }
 }

test/integration/node-specific/convert_socket_errors.test.ts

@@ -0,0 +1,138 @@
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+
+import { ConnectionPool, type MongoClient, MongoNetworkError } from '../../mongodb';
+import { clearFailPoint, configureFailPoint } from '../../tools/utils';
+
+describe('Socket Errors', () => {
+  describe('when destroyed after write', () => {
+    let client: MongoClient;
+    let collection;
+
+    beforeEach(async function () {
+      client = this.configuration.newClient({}, { appName: 'failInserts' });
+      await client.connect();
+      const db = client.db('closeConn');
+      collection = db.collection('closeConn');
+
+      const checkOut = sinon.stub(ConnectionPool.prototype, 'checkOut').callsFake(fakeCheckout);
+      async function fakeCheckout(...args) {
+        const connection = await checkOut.wrappedMethod.call(this, ...args);
+
+        const write = sinon.stub(connection.socket, 'write').callsFake(function (...args) {
+          queueMicrotask(() => {
+            this.destroy(new Error('read ECONNRESET'));
+          });
+          return write.wrappedMethod.call(this, ...args);
+        });
+
+        return connection;
+      }
+    });
+
+    afterEach(async function () {
+      sinon.restore();
+      await client.close();
+    });
+
+    it('throws a MongoNetworkError', async () => {
+      const error = await collection.insertOne({ name: 'test' }).catch(error => error);
+      expect(error).to.be.instanceOf(MongoNetworkError);
+    });
+  });
+
+  describe('when destroyed after read', () => {
+    let client: MongoClient;
+    let collection;
+
+    const metadata: MongoDBMetadataUI = { requires: { mongodb: '>=4.4' } };
+
+    beforeEach(async function () {
+      if (!this.configuration.filters.NodeVersionFilter.filter({ metadata })) {
+        return;
+      }
+
+      await configureFailPoint(this.configuration, {
+        configureFailPoint: 'failCommand',
+        mode: 'alwaysOn',
+        data: {
+          appName: 'failInserts',
+          failCommands: ['insert'],
+          blockConnection: true,
+          blockTimeMS: 1000 // just so the server doesn't reply super fast.
+        }
+      });
+
+      client = this.configuration.newClient({}, { appName: 'failInserts' });
+      await client.connect();
+      const db = client.db('closeConn');
+      collection = db.collection('closeConn');
+
+      const checkOut = sinon.stub(ConnectionPool.prototype, 'checkOut').callsFake(fakeCheckout);
+      async function fakeCheckout(...args) {
+        const connection = await checkOut.wrappedMethod.call(this, ...args);
+
+        const on = sinon.stub(connection.messageStream, 'on').callsFake(function (...args) {
+          if (args[0] === 'data') {
+            queueMicrotask(() => {
+              connection.socket.destroy(new Error('read ECONNRESET'));
+            });
+          }
+          return on.wrappedMethod.call(this, ...args);
+        });
+
+        return connection;
+      }
+    });
+
+    afterEach(async function () {
+      sinon.restore();
+      await clearFailPoint(this.configuration);
+      await client.close();
+    });
+
+    it('throws a MongoNetworkError', metadata, async () => {
+      const error = await collection.insertOne({ name: 'test' }).catch(error => error);
+      expect(error).to.be.instanceOf(MongoNetworkError);
+    });
+  });
+
+  describe('when destroyed by failpoint', () => {
+    let client: MongoClient;
+    let collection;
+
+    const metadata: MongoDBMetadataUI = { requires: { mongodb: '>=4.4' } };
+
+    beforeEach(async function () {
+      if (!this.configuration.filters.NodeVersionFilter.filter({ metadata })) {
+        return;
+      }
+
+      await configureFailPoint(this.configuration, {
+        configureFailPoint: 'failCommand',
+        mode: 'alwaysOn',
+        data: {
+          appName: 'failInserts2',
+          failCommands: ['insert'],
+          closeConnection: true
+        }
+      });
+
+      client = this.configuration.newClient({}, { appName: 'failInserts2' });
+      await client.connect();
+      const db = client.db('closeConn');
+      collection = db.collection('closeConn');
+    });
+
+    afterEach(async function () {
+      sinon.restore();
+      await clearFailPoint(this.configuration);
+      await client.close();
+    });
+
+    it('throws a MongoNetworkError', metadata, async () => {
+      const error = await collection.insertOne({ name: 'test' }).catch(error => error);
+      expect(error, error.stack).to.be.instanceOf(MongoNetworkError);
+    });
+  });
+});