fix(NODE-4208): add aws http request timeout handler (#3225)

Author: dariakp

.evergreen/config.in.yml

@@ -599,6 +599,7 @@ functions:
         working_dir: "src"
         script: |
           ${PREPARE_SHELL}
+          export IS_EC2=true
           ${PROJECT_DIRECTORY}/.evergreen/run-mongodb-aws-test.sh
 
   "run aws auth test with aws credentials as environment variables":

.evergreen/config.yml

@@ -565,6 +565,7 @@ functions:
         working_dir: src
         script: |
           ${PREPARE_SHELL}
+          export IS_EC2=true
           ${PROJECT_DIRECTORY}/.evergreen/run-mongodb-aws-test.sh
   run aws auth test with aws credentials as environment variables:
     - command: shell.exec

src/cmap/auth/mongodb_aws.ts

@@ -6,6 +6,7 @@ import type { Binary, BSONSerializeOptions } from '../../bson';
 import * as BSON from '../../bson';
 import { aws4 } from '../../deps';
 import {
+  MongoAWSError,
   MongoCompatibilityError,
   MongoMissingCredentialsError,
   MongoRuntimeError
@@ -283,6 +284,10 @@ function request(uri: string, _options: RequestOptions | undefined, callback: Ca
     });
   });
 
+  req.on('timeout', () => {
+    req.destroy(new MongoAWSError(`AWS request to ${uri} timed out after ${options.timeout} ms`));
+  });
+
   req.on('error', err => callback(err));
   req.end();
 }

src/error.ts

@@ -347,6 +347,23 @@ export class MongoKerberosError extends MongoRuntimeError {
   }
 }
 
+/**
+ * A error generated when the user attempts to authenticate
+ * via AWS, but fails
+ *
+ * @public
+ * @category Error
+ */
+export class MongoAWSError extends MongoRuntimeError {
+  constructor(message: string) {
+    super(message);
+  }
+
+  override get name(): string {
+    return 'MongoAWSError';
+  }
+}
+
 /**
  * An error generated when a ChangeStream operation fails to execute.
  *

src/index.ts

@@ -38,6 +38,7 @@ export const ObjectID = ObjectId;
 export { AnyBulkWriteOperation, BulkWriteOptions, MongoBulkWriteError } from './bulk/common';
 export {
   MongoAPIError,
+  MongoAWSError,
   MongoBatchReExecutionError,
   MongoChangeStreamError,
   MongoCompatibilityError,

test/integration/auth/mongodb_aws.test.js

@@ -1,6 +1,10 @@
 'use strict';
 const { expect } = require('chai');
 const { removeAuthFromConnectionString } = require('../../tools/utils');
+const sinon = require('sinon');
+const http = require('http');
+const { performance } = require('perf_hooks');
+const { MongoAWSError } = require('../../../src');
 
 describe('MONGODB-AWS', function () {
   beforeEach(function () {
@@ -52,4 +56,46 @@ describe('MONGODB-AWS', function () {
       .to.have.nested.property('options.credentials.mechanismProperties.AWS_SESSION_TOKEN')
       .that.equals('');
   });
+
+  describe('EC2 with missing credentials', () => {
+    let client;
+
+    beforeEach(function () {
+      if (!process.env.IS_EC2) {
+        this.currentTest.skipReason = 'requires an AWS EC2 environment';
+        this.skip();
+      }
+      sinon.stub(http, 'request').callsFake(function () {
+        arguments[0].hostname = 'www.example.com';
+        arguments[0].port = 81;
+        return http.request.wrappedMethod.apply(this, arguments);
+      });
+    });
+
+    afterEach(async () => {
+      sinon.restore();
+      if (client) {
+        await client.close();
+      }
+    });
+
+    it('should respect the default timeout of 10000ms', async function () {
+      const config = this.configuration;
+      client = config.newClient(process.env.MONGODB_URI, { authMechanism: 'MONGODB-AWS' }); // use the URI built by the test environment
+      const startTime = performance.now();
+
+      let caughtError = null;
+      await client.connect().catch(err => {
+        caughtError = err;
+      });
+
+      const endTime = performance.now();
+      const timeTaken = endTime - startTime;
+      expect(caughtError).to.be.instanceOf(MongoAWSError);
+      expect(caughtError)
+        .property('message')
+        .match(/timed out after/);
+      expect(timeTaken).to.be.within(10000, 12000);
+    });
+  });
 });