Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Http proxy support #276

Merged
merged 5 commits into from
Aug 22, 2018
Merged

Http proxy support #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ee4978f
Add 'http_proxy' parameter to settings
Jul 19, 2018
6bc7a1e
refactored http proxy api
Jul 20, 2018
f2082d4
refactored http proxy api
Jul 20, 2018
cbc9c05
fix requests proxy config
Jul 20, 2018
73e9b78
fix py2.7 compat
Jul 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions rollbar/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,9 @@ def _get_pylons_request():
'capture_username': False,
'capture_ip': True,
'log_all_rate_limited_items': True,
'http_proxy': None,
'http_proxy_user': None,
'http_proxy_password': None,
}

_CURRENT_LAMBDA_CONTEXT = None
Expand Down Expand Up @@ -1370,10 +1373,13 @@ def _post_api(path, payload_str, access_token=None):

url = urljoin(SETTINGS['endpoint'], path)
resp = transport.post(url,
data=payload_str,
headers=headers,
timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT),
verify=SETTINGS.get('verify_https', True))
data=payload_str,
headers=headers,
timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT),
verify=SETTINGS.get('verify_https', True),
proxy=SETTINGS.get('http_proxy'),
proxy_user=SETTINGS.get('http_proxy_user'),
proxy_password=SETTINGS.get('http_proxy_password'))

return _parse_response(path, SETTINGS['access_token'], payload_str, resp)

Expand All @@ -1382,7 +1388,12 @@ def _get_api(path, access_token=None, endpoint=None, **params):
access_token = access_token or SETTINGS['access_token']
url = urljoin(endpoint or SETTINGS['endpoint'], path)
params['access_token'] = access_token
resp = transport.get(url, params=params, verify=SETTINGS.get('verify_https', True))
resp = transport.get(url,
params=params,
verify=SETTINGS.get('verify_https', True),
proxy=SETTINGS.get('http_proxy'),
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason to pass these values directly in the kw of the .get and .post calls?
Checking the requests documentation it looks like just setting the proxies kw, as you did below, should be enough.

Copy link
Author

Choose a reason for hiding this comment

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

Would you recommend to pass the proxies dict as a keyword to the transport.post and transport.get methods? Would be fine with me but i thought the transport module is meant to be an abstraction for the synchronous HTTP requests API. If so it should better not use requests specific constructs. Should I refactor the PR to pass the proxies dict directly to transport?

Copy link
Contributor

@corps corps Aug 21, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Oh no. I just mean, you already provide the proxies keyword inside of the transport calls. Is there a need to also specify the proxy settings at each call site to the transport? I'm curious why we also pass proxy proxy_user proxy_password to the transport.get if the implementation of transport.get should be providing the proxies keyword now.

Copy link
Author

Choose a reason for hiding this comment

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

The _get_proxy_cfg method in the transport module builds the proxies config dict for requests. To do so it needs access to the http_proxy, http_proxy_user and http_proxy_password settings. So either we access the settings in the transport module or we need to pass along http_proxy, http_proxy_user and http_proxy_password as keywords when we call a transport method. Would you prefer another solution? The settings could be passed along as an argument as well, or stored in transport as a thread local e.g.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah hah. Now I get it. I apologize, I was focused on the kw being pass through to the actual session call, and missed that it is used, as you say, to build the proxies value from the SETTINGS. This is an interesting scenario where, as you say, the SETTINGS object might preferably be refactored to be more shareable to all modules. But that isn't necessary for this change. Thank you for your patience answering my question and work on this PR, I'll get it merged.

proxy_user=SETTINGS.get('http_proxy_user'),
proxy_password=SETTINGS.get('http_proxy_password'))
return _parse_response(path, access_token, params, resp, endpoint=endpoint)


Expand Down
22 changes: 20 additions & 2 deletions rollbar/lib/transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,30 @@ def _session():
return _local.session


def _get_proxy_cfg(kw):
proxy = kw.pop('proxy', None)
proxy_user = kw.pop('proxy_user', None)
proxy_password = kw.pop('proxy_password', None)
if proxy and proxy_user and proxy_password:
return {
'http': 'http://{}:{}@{}'.format(proxy_user, proxy_password, proxy),
'https': 'http://{}:{}@{}'.format(proxy_user, proxy_password, proxy),
}
elif proxy:
return {
'http': 'http://{}'.format(proxy),
'https': 'http://{}'.format(proxy),
}


def post(*args, **kw):
return _session().post(*args, **kw)
proxies = _get_proxy_cfg(kw)
return _session().post(*args, proxies=proxies, **kw)


def get(*args, **kw):
return _session().get(*args, **kw)
proxies = _get_proxy_cfg(kw)
return _session().get(*args, proxies=proxies, **kw)


__all__ = ['post', 'get']