Skip to content

Commit

Permalink
chore(config): Update docs regarding proxies (#5048)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
enriquegh authored and cnishina committed Dec 19, 2018
1 parent 6064b69 commit 3a5e413
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions lib/config.ts
Expand Up @@ -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;

Expand Down Expand Up @@ -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;
/**
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3a5e413

Please sign in to comment.