Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

chore(config): Update docs regarding proxies #5048

Merged
merged 1 commit into from
Dec 19, 2018

Conversation

enriquegh
Copy link
Contributor

This change tries to make the different proxies available easier to differentiate.
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.

See:
https://github.com/angular/protractor/blob/master/lib/driverProviders/sauce.ts#L60-L61

webDriverProxy on the other hand is passed onto the WebDriver session.
See:
https://github.com/angular/protractor/blob/master/lib/driverProviders/driverProvider.ts#L54

This means that if you're 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.

This change tries to make the different proxies available easier to differentiate.
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.

See:
https://github.com/angular/protractor/blob/master/lib/driverProviders/sauce.ts#L60-L61

webDriverProxy on the other hand is passed onto the WebDriver session.
See:
https://github.com/angular/protractor/blob/master/lib/driverProviders/driverProvider.ts#L54

This means that if you're 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.
* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I remember trying to set it all to webDriverProxy at one point 3 years ago...

@cnishina cnishina merged commit 0b83f49 into angular:master Dec 19, 2018
cnishina pushed a commit to cnishina/protractor that referenced this pull request Dec 19, 2018
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.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants