From 3a5e413ae360d44a002b483be7837cf8615beefe Mon Sep 17 00:00:00 2001
From: Enrique Gonzalez <egonzalezh94@gmail.com>
Date: Tue, 18 Dec 2018 17:30:27 -0800
Subject: [PATCH] chore(config): Update docs regarding proxies (#5048)

This change updates documentation on the different proxies.

The sauceAgent key's comment said that adding a webDriverProxy would override this and this is not true. sauceAgent is overwritten by sauceProxy since both are passed onto the saucelabs module.

This means that if you are under a corporate proxy and need to proxy both Sauce Labs API calls as well as calls to the Selenium endpoint (ondemand.saucelabs.com) both sauceProxy/sauceAgent and webDriverProxy need to be used.
---
 lib/config.ts     | 11 ++++++-----
 package-lock.json |  2 +-
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/lib/config.ts b/lib/config.ts
index b26b59b09..ccb0d89a8 100644
--- a/lib/config.ts
+++ b/lib/config.ts
@@ -99,14 +99,15 @@ export interface Config {
    */
   seleniumSessionId?: string;
   /**
-   * The address of a proxy server to use for communicating to Sauce Labs rest APIs via the
+   * The address of a proxy server to use for communicating to Sauce Labs REST APIs via the
    * saucelabs node module. For example, the Sauce Labs Proxy can be setup with: sauceProxy:
    * 'http://localhost:3128'
    */
   sauceProxy?: string;
 
   /**
-   * The proxy address that browser traffic will go through which is tied to the browser session.
+   * The proxy address that WebDriver (e.g. Selenium commands) traffic will go through
+   * which is tied to the browser session.
    */
   webDriverProxy?: string;
 
@@ -136,13 +137,13 @@ export interface Config {
    */
   sauceKey?: string;
   /**
-   * Use sauceAgent if you need custom HTTP agent to connect to saucelabs.com.
+   * Use sauceAgent if you need custom HTTP agent to connect to saucelabs.com APIs.
    * This is needed if your computer is behind a corporate proxy.
    *
    * To match sauce agent implementation, use
    * [HttpProxyAgent](https://github.com/TooTallNate/node-http-proxy-agent)
-   * to generate the agent or use webDriverProxy as an alternative. If a
-   * webDriverProxy is provided, the sauceAgent will be overridden.
+   * to generate the agent or use sauceProxy as an alternative. If a
+   * sauceProxy is provided, the sauceAgent will be overridden.
    */
   sauceAgent?: any;
   /**
diff --git a/package-lock.json b/package-lock.json
index 73b9d8aec..12b48bbcc 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1002,7 +1002,7 @@
     },
     "es6-promise": {
       "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.0.2.tgz",
+      "resolved": "http://registry.npmjs.org/es6-promise/-/es6-promise-3.0.2.tgz",
       "integrity": "sha1-AQ1YWEI6XxGJeWZfRkhqlcbuK7Y="
     },
     "es6-promisify": {