fix: Add http agent to axios to work with proxy (twilio#109)

Co-authored-by: Elise Shanholtz <[email protected]>
Co-authored-by: Jennifer Mah <[email protected]>

Author: 3 people

README.md

@@ -30,6 +30,9 @@ Formatters to take a JSON array and write to the stdout. Current formatters incl
 
 A custom http client for the Twilio helper library to allow us to log API requests as well as modify the User-Agent header.
 
+### Usage with proxy
+ - `HTTP_PROXY`: If using Twilio CLI behind a proxy, set the URL of the proxy in an environment variable called `HTTP_PROXY`.
+
 ### Config
 
 Manages the CLI configuration options, such as Twilio profiles and credentials.

package.json

@@ -34,6 +34,7 @@
     "chalk": "^4.1.0",
     "columnify": "^1.5.4",
     "fs-extra": "^9.0.1",
+    "https-proxy-agent": "^5.0.0",
     "inquirer": "^7.3.0",
     "qs": "^6.9.4",
     "semver": "^7.3.2",

src/services/cli-http-client.js

@@ -2,6 +2,7 @@ const http_ = require('http');
 const https = require('https');
 const os = require('os');
 
+const HttpsProxyAgent = require('https-proxy-agent');
 const qs = require('qs');
 
 const pkg = require('../../package.json');
@@ -17,6 +18,14 @@ class CliRequestClient {
     this.commandName = commandName;
     this.logger = logger;
     this.http = http || require('axios');
+    if (process.env.HTTP_PROXY) {
+      /*
+       * If environment variable HTTP_PROXY is set,
+       * add an appropriate httpsAgent to axios.
+       */
+      this.http.defaults.proxy = false;
+      this.http.defaults.httpsAgent = new HttpsProxyAgent(process.env.HTTP_PROXY);
+    }
   }
 
   /**

test/services/cli-http-client.test.js

@@ -30,6 +30,14 @@ describe('services', () => {
       expect(response.body).to.equal('foo');
     });
 
+    test.it('should add the correct http agent for proxy', async () => {
+      process.env.HTTP_PROXY = 'http://someproxy.com:8080';
+      const client = new CliRequestClient('blah', logger, { defaults: {} });
+      const httpAgent = client.http.defaults.httpsAgent;
+      expect(httpAgent.proxy.host).to.equal('someproxy.com');
+      expect(httpAgent.proxy.port).to.equal(8080);
+    });
+
     test
       .nock('https://foo.com', (api) => {
         api.get('/bar').delay(100).reply(200);