Make proxy-agent require enabling via yml

Author: dougmoscrop

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   lint:
     docker:
-      - image: circleci/node:16
+      - image: circleci/node:18
 
     working_directory: ~/repo
 
@@ -25,7 +25,7 @@ jobs:
 
   test:
     docker:
-      - image: circleci/node:16
+      - image: circleci/node:18
 
     working_directory: ~/repo
 

README.md

@@ -94,3 +94,13 @@ __Be careful when introducing any customizations to default config. Many kind of
 ### Force Migration
 
 Custom migrations can specify `{ force: true }` to force the migration of an existing resource in to a new stack. BE CAREFUL. This will cause a resource to be deleted and recreated. It may not even work if CloudFormation tries to create the new one before deleting the old one and they have a name or some other unique property that cannot have two resources existing at the same time. It can also mean a small window of downtime during this period, for example as an `AWS::Lambda::Permission` is deleted/recreated calls may be denied until IAM sorts things out.
+
+## Proxy Support
+
+This plugin makes use of the `proxy-agent` library, which reads environmental varaibles for configuration. To avoid conflicts with existing deployments, it is not used automatically, but instead needs to be enabled via serverless config:
+
+```yml
+custom:
+  splitStacks:
+    proxyAgent: true
+```

__tests__/utils/bucket-endpoint.js

@@ -9,7 +9,7 @@ const originalRequest = https.request;
 test.beforeEach(t => {
   https.request = originalRequest;
   t.context = Object.assign(
-    {},
+    { config: {} },
     { serverless: { service: { provider: {} } } }
   );
 });

lib/deployment-bucket-endpoint.js

@@ -4,7 +4,7 @@ const { endpoint } = require('aws-info');
 const { ProxyAgent } = require('proxy-agent');
 const https = require('https');
 
-function getOptions(cli, bucket, endpoint) {
+function getOptions(cli, bucket, endpoint, useProxy) {
   const method = 'HEAD';
   const proxyAgent = new ProxyAgent();
 
@@ -18,19 +18,21 @@ function getOptions(cli, bucket, endpoint) {
       method,
       hostname: endpoint,
       path: `/${bucket}`,
-      agent: proxyAgent
+      agent: useProxy ? proxyAgent : undefined
     };
   }
 
   return {
     method,
     hostname: `${bucket}.${endpoint}`,
     path: '/',
-    agent: proxyAgent
+    agent: useProxy ? proxyAgent : undefined
   };
 }
 
 module.exports = function setDeploymentBucketEndpoint() {
+  const useProxy = !!this.config.proxyAgent
+
   return new Promise((resolve, reject) => {
     const { service: { provider } } = this.serverless;
     const { deploymentBucket } = provider;
@@ -43,7 +45,7 @@ module.exports = function setDeploymentBucketEndpoint() {
         ? deploymentBucket.name
         : deploymentBucket;
 
-      const options = getOptions(this.serverless.cli, bucket, s3Endpoint);
+      const options = getOptions(this.serverless.cli, bucket, s3Endpoint, useProxy);
       const request = https.request(options);
 
       request.on('response', response => {