Skip to content

get_info memleak fix: cache exception string only #156

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

Open
freewil wants to merge 1 commit into
base: maint
Choose a base branch
from
Open

get_info memleak fix: cache exception string only #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 11 additions & 11 deletions stem/control.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,8 +1063,8 @@ def __init__(self, control_socket, is_authenticated = False):
self._enabled_features = []
self._is_geoip_unavailable = None

self._last_address_exc = None
self._last_fingerprint_exc = None
self._last_address_error = None
self._last_fingerprint_error = None

super(Controller, self).__init__(control_socket, is_authenticated)

Expand Down Expand Up @@ -1094,7 +1094,7 @@ def _address_changed_listener(event):
if event.action in ('EXTERNAL_ADDRESS', 'DNS_USELESS'):
self._set_cache({'exit_policy': None})
self._set_cache({'address': None}, 'getinfo')
self._last_address_exc = None
self._last_address_error = None

self.add_event_listener(_address_changed_listener, EventType.STATUS_SERVER)

Expand Down Expand Up @@ -1179,10 +1179,10 @@ def get_info(self, params, default = UNDEFINED, get_bytes = False):
for param in params:
if param.startswith('ip-to-country/') and param != 'ip-to-country/0.0.0.0' and self.is_geoip_unavailable():
raise stem.ProtocolError('Tor geoip database is unavailable')
elif param == 'address' and self._last_address_exc:
raise self._last_address_exc # we already know we can't resolve an address
elif param == 'fingerprint' and self._last_fingerprint_exc and self.get_conf('ORPort', None) is None:
raise self._last_fingerprint_exc # we already know we're not a relay
elif param == 'address' and self._last_address_error:
raise stem.ControllerError(self._last_address_error) # we already know we can't resolve an address
elif param == 'fingerprint' and self._last_fingerprint_error and self.get_conf('ORPort', None) is None:
raise stem.ControllerError(self._last_fingerprint_error) # we already know we're not a relay

# check for cached results

Expand Down Expand Up @@ -1230,10 +1230,10 @@ def get_info(self, params, default = UNDEFINED, get_bytes = False):
self._set_cache(to_cache, 'getinfo')

if 'address' in params:
self._last_address_exc = None
self._last_address_error = None

if 'fingerprint' in params:
self._last_fingerprint_exc = None
self._last_fingerprint_error = None

log.debug('GETINFO %s (runtime: %0.4f)' % (' '.join(params), time.time() - start_time))

Expand All @@ -1243,10 +1243,10 @@ def get_info(self, params, default = UNDEFINED, get_bytes = False):
return list(reply.values())[0]
except stem.ControllerError as exc:
if 'address' in params:
self._last_address_exc = exc
self._last_address_error = str(exc)

if 'fingerprint' in params:
self._last_fingerprint_exc = exc
self._last_fingerprint_error = str(exc)

log.debug('GETINFO %s (failed: %s)' % (' '.join(params), exc))
raise
Expand Down
20 changes: 10 additions & 10 deletions test/unit/control/controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,20 @@ def test_get_info(self, msg_mock):
def test_get_info_address_caching(self, msg_mock):
msg_mock.return_value = ControlMessage.from_str('551 Address unknown\r\n')

self.assertEqual(None, self.controller._last_address_exc)
self.assertRaisesWith(stem.OperationFailed, 'Address unknown', self.controller.get_info, 'address')
self.assertEqual('Address unknown', str(self.controller._last_address_exc))
self.assertEqual(None, self.controller._last_address_error)
self.assertRaisesWith(stem.ControllerError, 'Address unknown', self.controller.get_info, 'address')
self.assertEqual('Address unknown', self.controller._last_address_error)
self.assertEqual(1, msg_mock.call_count)

# now that we have a cached failure we should provide that back

self.assertRaisesWith(stem.OperationFailed, 'Address unknown', self.controller.get_info, 'address')
self.assertRaisesWith(stem.ControllerError, 'Address unknown', self.controller.get_info, 'address')
self.assertEqual(1, msg_mock.call_count)

# invalidates the cache, transitioning from no address to having one

msg_mock.return_value = ControlMessage.from_str('250-address=17.2.89.80\r\n250 OK\r\n', 'GETINFO')
self.assertRaisesWith(stem.OperationFailed, 'Address unknown', self.controller.get_info, 'address')
self.assertRaisesWith(stem.ControllerError, 'Address unknown', self.controller.get_info, 'address')
self.controller._handle_event(ControlMessage.from_str('650 STATUS_SERVER NOTICE EXTERNAL_ADDRESS ADDRESS=17.2.89.80 METHOD=DIRSERV\r\n'))
self.assertEqual('17.2.89.80', self.controller.get_info('address'))

Expand All @@ -102,20 +102,20 @@ def test_get_info_without_fingerprint(self, get_conf_mock, msg_mock):
msg_mock.return_value = ControlMessage.from_str('551 Not running in server mode\r\n')
get_conf_mock.return_value = None

self.assertEqual(None, self.controller._last_fingerprint_exc)
self.assertRaisesWith(stem.OperationFailed, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertEqual('Not running in server mode', str(self.controller._last_fingerprint_exc))
self.assertEqual(None, self.controller._last_fingerprint_error)
self.assertRaisesWith(stem.ControllerError, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertEqual('Not running in server mode', self.controller._last_fingerprint_error)
self.assertEqual(1, msg_mock.call_count)

# now that we have a cached failure we should provide that back

self.assertRaisesWith(stem.OperationFailed, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertRaisesWith(stem.ControllerError, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertEqual(1, msg_mock.call_count)

# ... but if we become a relay we'll call it again

get_conf_mock.return_value = '443'
self.assertRaisesWith(stem.OperationFailed, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertRaisesWith(stem.ControllerError, 'Not running in server mode', self.controller.get_info, 'fingerprint')
self.assertEqual(2, msg_mock.call_count)

@patch('stem.control.Controller.get_info')
Expand Down