Synchronise S3 initialisation with ember-cli-deploy-s3

.github/workflows/ci.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}

README.md

@@ -76,6 +76,13 @@ The AWS secret for the user that has the ability to upload to the `bucket`. This
 
 *Default:* `undefined`
 
+### sessionToken
+
+The AWS session token for the user that has the ability to upload to the `bucket`. This may be required if you are using the [AWS Security Token Service][6].
+This requires both `accessKeyId` and `secretAccessKey` to be defined.
+
+*Default:* `undefined`
+
 ### profile
 
 The AWS profile as definied in ~/.aws/credentials. If this is left undefined, the normal [AWS SDK credential resolution][7] will take place.
@@ -155,6 +162,11 @@ If `endpoint` set the `region` option will be ignored.
 
 *Default:* `[region].s3.amazonaws.com`
 
+### proxy
+
+The network proxy url used when sending requests to S3.
+
+*Default:* `undefined`
 
 ### serverSideEncryption
 

lib/s3.js

@@ -22,41 +22,74 @@ async function headObject(client, params) {
 
 module.exports = CoreObject.extend({
   init: function(options) {
-    this._super();
-    var plugin = options.plugin;
-    var config = plugin.pluginConfig;
-    var profile = plugin.readConfig('profile');
-    var endpoint = plugin.readConfig('endpoint');
-    var credentials;
+    this._super(options);
 
-    this._plugin = plugin;
-
-    var providedS3Client = plugin.readConfig("s3Client");
+    var s3Options = {
+      region: this.plugin.readConfig('region')
+    };
 
+    const proxy = this.plugin.readConfig('proxy');
+    if (proxy) {
+      var agent;
+      this._proxyAgent = this.plugin.readConfig('proxyAgent');
+      if (this._proxyAgent) {
+        agent = this._proxyAgent(proxy);
+      } else {
+        const { ProxyAgent } = require('proxy-agent');
+        agent = new ProxyAgent(proxy);
+      }
+      s3Options.httpOptions = {
+        agent
+      };
+    }
 
-    if (profile && !providedS3Client) {
-      this._plugin.log("Using AWS profile from config", { verbose: true });
-      credentials = fromIni({ profile: profile });
+    const accessKeyId = this.plugin.readConfig('accessKeyId');
+    const secretAccessKey = this.plugin.readConfig('secretAccessKey');
+    const sessionToken = this.plugin.readConfig('sessionToken');
+    const profile = this.plugin.readConfig('profile');
+    const signatureVersion = this.plugin.readConfig('signatureVersion');
+    const endpoint = this.plugin.readConfig('endpoint');
+
+    if (accessKeyId && secretAccessKey) {
+      this.plugin.log('Using AWS access key id and secret access key from config', { verbose: true });
+      s3Options.credentials = {
+        accessKeyId: accessKeyId,
+        secretAccessKey: secretAccessKey,
+      };
+
+      if (sessionToken) {
+        this.plugin.log('Using AWS session token from config', { verbose: true });
+        s3Options.credentials.sessionToken = sessionToken;
+      }
     }
 
-    if (endpoint) {
-      this._plugin.log('Using endpoint from config', { verbose: true });
+    if (signatureVersion) {
+      this.plugin.log('Using signature version from config', { verbose: true });
+      s3Options.signatureVersion = signatureVersion;
     }
 
-    this._client = providedS3Client || new S3(config);
+    if (profile && !this.plugin.readConfig('s3Client')) {
+      this.plugin.log('Using AWS profile from config', { verbose: true });
+      s3Options.credentials = fromIni({ profile: profile });
+    }
 
     if (endpoint) {
-      this._client.config.endpoint = endpoint;
-    }
-    if (credentials) {
-      this._client.config.credentials = credentials;
+      this.plugin.log('Using endpoint from config', { verbose: true });
+      s3Options.endpoint = endpoint;
     }
 
+    this._client = this.plugin.readConfig('s3Client') || new S3(s3Options);
+
+    if (this.plugin.readConfig('s3Client')) {
+      if (endpoint) {
+        this._client.config.endpoint = endpoint;
+      }
+    }
   },
 
   upload: function(options) {
     var client                    = this._client;
-    var plugin                    = this._plugin;
+    var plugin                    = this.plugin;
     var bucket                    = options.bucket;
     var acl                       = options.acl;
     var cacheControl              = options.cacheControl;
@@ -112,7 +145,7 @@ module.exports = CoreObject.extend({
   },
 
   activate: function(options) {
-    var plugin                = this._plugin;
+    var plugin                = this.plugin;
     var client                = this._client;
     var bucket                = options.bucket;
     var acl                   = options.acl;

package.json

@@ -23,6 +23,7 @@
     "core-object": "^3.0.0",
     "ember-cli-deploy-plugin": "^0.2.9",
     "mime-types": "^2.1.27",
+    "proxy-agent": "^6.5.0",
     "rsvp": "^4.8.5"
   },
   "devDependencies": {
@@ -36,7 +37,7 @@
     "release-it-lerna-changelog": "^3.1.0"
   },
   "engines": {
-    "node": "14.* || 16.* || 18.* || >= 20"
+    "node": "18.* || >= 20"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"