Explicitly inject desired AWS.Config instance

Resolves issues caused by @elastic/elasticsearch not passing through custom options to the underlying Connection and Transport instances.

Working with multiple sets of credentials is easier now, and working with async credential sources should be more future-proof.

This change breaks completely with the previous version and the original http-aws-es library.

h/t to @kelyvin for inspiration on this.

Author: compwright

Diff for: README.md

@@ -8,7 +8,7 @@
 
 A tiny [Amazon Signature Version 4](https://www.npmjs.com/package/aws4) connection class for the official [Elasticsearch Node.js client](https://www.npmjs.com/package/elasticsearch), for compatibility with AWS Elasticsearch and IAM authentication.
 
-> For legacy [Elasticsearch.js 16.x](https://www.npmjs.com/package/elasticsearch) support, use version 7.x of this library.
+Supports AWS SDK global or specific configuration instances (AWS.Config), including asyncronous credentials from IAM roles and credential refreshing.
 
 ## Installation
 
@@ -18,78 +18,41 @@ npm install --save aws-elasticsearch-connector @elastic/elasticsearch aws-sdk
 
 ## Example usage
 
-### With static credentials
+### Using global configuration
 
 ```javascript
-const { Client } = require('@elastic/elasticsearch');
-const { AmazonConnection } = require('aws-elasticsearch-connector');
+const { Client } = require('@elastic/elasticsearch')
+const AWS = require('aws-sdk')
+const createAwsElasticsearchConnector = require('aws-elasticsearch-connector')
 
-const client = new Client({
-  node: 'my-elasticsearch-cluster.us-east-1.es.amazonaws.com',
-  Connection: AmazonConnection,
-  awsConfig: {
-    credentials: {
-      accessKeyId: 'foo',
-      secretAccessKey: 'bar',
-      sessionToken: 'baz' // optional
-    }
-  }
-});
-```
-
-### With static credentials from AWS.Config
-
-```javascript
-const AWS = require('aws-sdk');
-const { Client } = require('@elastic/elasticsearch');
-const { AmazonConnection } = require('aws-elasticsearch-connector');
-
-// Load AWS profile credentials
+// (Optional) load profile credentials from file
 AWS.config.update({
   profile: 'my-profile'
-});
+})
 
 const client = new Client({
-  node: 'my-elasticsearch-cluster.us-east-1.es.amazonaws.com',
-  Connection: AmazonConnection
-});
+  ...createAwsElasticsearchConnector(AWS.config),
+  node: 'https://my-elasticsearch-cluster.us-east-1.es.amazonaws.com'
+})
 ```
 
-### With static credentials from the environment
-
-```env
-AWS_ACCESS_KEY_ID=foo      # alias: AWS_ACCESS_KEY
-AWS_SECRET_ACCESS_KEY=bar  # alias: AWS_SECRET_KEY
-AWS_SESSION_TOKEN=baz
-```
+### Using specific configuration
 
 ```javascript
-const { Client } = require('@elastic/elasticsearch');
-const { AmazonConnection } = require('aws-elasticsearch-connector');
+const { Client } = require('@elastic/elasticsearch')
+const AWS = require('aws-sdk')
+const createAwsElasticsearchConnector = require('aws-elasticsearch-connector')
 
-const client = new Client({
-  node: 'my-elasticsearch-cluster.us-east-1.es.amazonaws.com',
-  Connection: AmazonConnection,
-});
-```
-
-### With asynchronous or refreshing credentials from AWS
-
-When reading AWS credentials from an IAM role or an EC2/ECS profile, the credentials
-will be retrieved and refreshed automatically. In this case you'll need to use the
-bundled `AmazonTransport` transport which will call AWS.Config.getCredentials()
-before each ElasticSearch request to ensure that the latest credentials are used.
-
-```javascript
-const { Client } = require('@elastic/elasticsearch');
-const { AmazonConnection, AmazonTransport } = require('aws-elasticsearch-connector');
+const awsConfig = new AWS.Config({
+  // Your credentials and settings here, see
+  // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#constructor-property
+})
 
 const client = new Client({
-  node: 'my-elasticsearch-cluster.us-east-1.es.amazonaws.com',
-  Connection: AmazonConnection,
-  Transport: AmazonTransport
-});
-```
+  ...createAwsElasticsearchConnector(awsConfig),
+  node: 'https://my-elasticsearch-cluster.us-east-1.es.amazonaws.com'
+})
+````
 
 ## Test
 
@@ -98,5 +61,5 @@ npm test
 
 # Run integration tests against a real endpoint
 AWS_PROFILE=your-profile npm run test:integration -- \
-  --endpoint https://amazon-es-host.us-east-1.es.amazonaws.com
+  --endpoint https://my-elasticsearch-cluster.us-east-1.es.amazonaws.com
 ```

Diff for: package-lock.json

@@ -1,13 +1,11 @@
 {
   "name": "aws-elasticsearch-connector",
   "version": "8.3.0",
-  "description": "A tiny Amazon Signature Version 4 connection class for Elasticsearch.js 16.x, for compatibility with AWS Elasticsearch and IAM authentication. NOTE: This library is drop-in replacement for http-aws-es, which is no longer actively maintained.",
+  "description": "A tiny Amazon Signature Version 4 connection class for @elastic/elasticsearch, for compatibility with AWS Elasticsearch and IAM authentication.",
   "repository": "https://github.com/compwright/aws-elasticsearch-connector",
   "bugs": "https://github.com/compwright/aws-elasticsearch-connector/issues",
   "keywords": [
     "elasticsearch",
-    "elasticsearch-js",
-    "elasticsearch-js-legacy",
     "aws-es",
     "aws",
     "aws4",
@@ -21,7 +19,7 @@
     "HttpConnection"
   ],
   "engines": {
-    "node": ">= 10.0.0"
+    "node": ">= 10"
   },
   "main": "src/index.js",
   "scripts": {
@@ -53,11 +51,10 @@
     ]
   },
   "dependencies": {
-    "aws4": "^1.10.0",
-    "lodash.get": "^4.4.2"
+    "aws4": "^1.10.0"
   },
   "peerDependencies": {
-    "@elastic/elasticsearch": ">=5",
+    "@elastic/elasticsearch": ">=7.8.0",
     "aws-sdk": "^2.709.0"
   },
   "devDependencies": {

Diff for: package.json

@@ -1,49 +1,31 @@
 const { Connection } = require('@elastic/elasticsearch')
 const aws4 = require('aws4')
-const AWS = require('aws-sdk')
-const get = require('lodash.get')
 
-class AmazonConnection extends Connection {
-  constructor (options) {
-    super(options)
-    this.awsConfig = options.awsConfig || AWS.config
-  }
-
-  get credentials () {
-    const credentials = {
-      accessKeyId: get(this.awsConfig, 'credentials.accessKeyId', process.env.AWS_ACCESS_KEY_ID || process.env.AWS_ACCESS_KEY || false),
-      secretAccessKey: get(this.awsConfig, 'credentials.secretAccessKey', process.env.AWS_SECRET_ACCESS_KEY || process.env.AWS_SECRET_KEY || false),
-      sessionToken: get(this.awsConfig, 'credentials.sessionToken', process.env.AWS_SESSION_TOKEN)
-    }
-
-    if (!credentials.accessKeyId || !credentials.secretAccessKey) {
-      throw new Error('Missing AWS credentials')
-    }
+module.exports = awsConfig => {
+  class AmazonConnection extends Connection {
+    buildRequestObject (params) {
+      const req = super.buildRequestObject(params)
 
-    return credentials
-  }
+      req.service = 'es'
 
-  buildRequestObject (params) {
-    const req = super.buildRequestObject(params)
-    req.service = 'es'
+      if (!req.headers) {
+        req.headers = {}
+      }
 
-    if (!req.headers) {
-      req.headers = {}
-    }
+      // Fix the Host header, since HttpConnector.makeReqParams() appends
+      // the port number which will cause signature verification to fail
+      req.headers.host = req.hostname
 
-    // Fix the Host header, since HttpConnector.makeReqParams() appends
-    // the port number which will cause signature verification to fail
-    req.headers.host = req.hostname
+      if (params.body) {
+        req.headers['content-length'] = Buffer.byteLength(params.body, 'utf8')
+        req.body = params.body
+      } else {
+        req.headers['content-length'] = 0
+      }
 
-    if (params.body) {
-      req.headers['content-length'] = Buffer.byteLength(params.body, 'utf8')
-      req.body = params.body
-    } else {
-      req.headers['content-length'] = 0
+      return aws4.sign(req, awsConfig.credentials)
     }
-
-    return aws4.sign(req, this.credentials)
   }
-}
 
-module.exports = AmazonConnection
+  return AmazonConnection
+}

Diff for: src/AmazonConnection.js

@@ -1,35 +1,34 @@
 const { Transport } = require('@elastic/elasticsearch')
-const AWS = require('aws-sdk')
 
-class AmazonTransport extends Transport {
-  awaitAwsCredentials () {
-    return new Promise((resolve, reject) => {
-      AWS.config.getCredentials((err) => {
-        err ? reject(err) : resolve()
-      })
+function awaitAwsCredentials (awsConfig) {
+  return new Promise((resolve, reject) => {
+    awsConfig.getCredentials((err) => {
+      err ? reject(err) : resolve()
     })
-  }
+  })
+}
 
-  request (params, options = {}, callback = undefined) {
-    // options is optional, so if it is omitted, options will be the callback
-    if (typeof options === 'function') {
-      callback = options
-      options = {}
-    }
+module.exports = awsConfig => {
+  class AmazonTransport extends Transport {
+    request (params, options = {}, callback = undefined) {
+      // options is optional, so if it is omitted, options will be the callback
+      if (typeof options === 'function') {
+        callback = options
+        options = {}
+      }
 
-    // Promise support
-    if (typeof callback === 'undefined') {
-      return this.awaitAwsCredentials()
-        .then(() => super.request(params, options))
-    }
+      // Promise support
+      if (typeof callback === 'undefined') {
+        return awaitAwsCredentials(awsConfig)
+          .then(() => super.request(params, options))
+      }
 
-    // Callback support
-    this.awaitAwsCredentials()
-      .then(() => {
-        super.request(params, options, callback)
-      })
-      .catch(callback)
+      // Callback support
+      awaitAwsCredentials(awsConfig)
+        .then(() => super.request(params, options, callback))
+        .catch(callback)
+    }
   }
-}
 
-module.exports = AmazonTransport
+  return AmazonTransport
+}

Diff for: src/AmazonTransport.js

@@ -1,4 +1,4 @@
-module.exports = {
-  AmazonConnection: require('./AmazonConnection'),
-  AmazonTransport: require('./AmazonTransport')
-}
+module.exports = (awsConfig) => ({
+  Connection: require('./AmazonConnection')(awsConfig),
+  Transport: require('./AmazonTransport')(awsConfig)
+})