( )⚙ D12041 test-http-bad-server: track close condition in an object

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12041

test-http-bad-server: track close condition in an object
ClosedPublic

Authored by marmoute on Jan 24 2022, 9:44 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHGcaa6694dac45: test-http-bad-server: track close condition in an object
Summary

In order to make the logic more advanced, we need to unify it. To unify it, we
introduce a small object that will be responsible for tracking and enforcing
"premature socket close" conditions for both proxy object (socketproxy and
fileobjectproxy).

More logic will be moved into the object in later changesets.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

marmoute created this revision.Jan 24 2022, 9:44 AM
Alphare accepted this revision.Jan 24 2022, 9:58 AM
This revision is now accepted and ready to land.Jan 24 2022, 9:58 AM
baymax edited the summary of this revision. (Show Details)Jan 24 2022, 1:16 PM
baymax updated this revision to Diff 31865.

✅ refresh by Heptapod after a successful CI run (🐙 💚)

Revision Contents
Changeset List

PathPackages
Mtests/testlib/badserverext.py (135 lines)

Diff 31917

tests/testlib/badserverext.py

default=b'0', default=b'0',
) )
configitem( configitem(
b'badserver', b'badserver',
b'close-before-accept', b'close-before-accept',
default=False, default=False,
) )
class ConditionTracker(object):
def __init__(self, close_after_recv_bytes, close_after_send_bytes):
self._all_close_after_recv_bytes = close_after_recv_bytes
self._all_close_after_send_bytes = close_after_send_bytes
def start_next_request(self):
"""move to the next set of close condition"""
if self._all_close_after_recv_bytes:
self.target_recv_bytes = self._all_close_after_recv_bytes.pop(0)
self.remaining_recv_bytes = self.target_recv_bytes
else:
self.target_recv_bytes = None
self.remaining_recv_bytes = None
if self._all_close_after_send_bytes:
self.target_send_bytes = self._all_close_after_send_bytes.pop(0)
self.remaining_send_bytes = self.target_send_bytes
else:
self.target_send_bytes = None
self.remaining_send_bytes = None
def might_close(self):
"""True, if any processing will be needed"""
if self.remaining_recv_bytes is not None:
return True
if self.remaining_send_bytes is not None:
return True
return False
# We can't adjust __class__ on a socket instance. So we define a proxy type. # We can't adjust __class__ on a socket instance. So we define a proxy type.
class socketproxy(object): class socketproxy(object):
__slots__ = ( __slots__ = ('_orig', '_logfp', '_cond')
'_orig',
'_logfp',
'_close_after_recv_bytes',
'_close_after_send_bytes',
)
def __init__( def __init__(self, obj, logfp, condition_tracked):
self, obj, logfp, close_after_recv_bytes=0, close_after_send_bytes=0
):
object.__setattr__(self, '_orig', obj) object.__setattr__(self, '_orig', obj)
object.__setattr__(self, '_logfp', logfp) object.__setattr__(self, '_logfp', logfp)
object.__setattr__( object.__setattr__(self, '_cond', condition_tracked)
self, '_close_after_recv_bytes', close_after_recv_bytes
)
object.__setattr__(
self, '_close_after_send_bytes', close_after_send_bytes
)
def __getattribute__(self, name): def __getattribute__(self, name):
if name in ('makefile', 'sendall', '_writelog'): if name in ('makefile', 'sendall', '_writelog', '_cond_close'):
return object.__getattribute__(self, name) return object.__getattribute__(self, name)
return getattr(object.__getattribute__(self, '_orig'), name) return getattr(object.__getattribute__(self, '_orig'), name)
def __delattr__(self, name): def __delattr__(self, name):
delattr(object.__getattribute__(self, '_orig'), name) delattr(object.__getattribute__(self, '_orig'), name)
def __setattr__(self, name, value): def __setattr__(self, name, value):
setattr(object.__getattribute__(self, '_orig'), name, value) setattr(object.__getattribute__(self, '_orig'), name, value)
def _writelog(self, msg): def _writelog(self, msg):
msg = msg.replace(b'\r', b'\\r').replace(b'\n', b'\\n') msg = msg.replace(b'\r', b'\\r').replace(b'\n', b'\\n')
object.__getattribute__(self, '_logfp').write(msg) object.__getattribute__(self, '_logfp').write(msg)
object.__getattribute__(self, '_logfp').write(b'\n') object.__getattribute__(self, '_logfp').write(b'\n')
object.__getattribute__(self, '_logfp').flush() object.__getattribute__(self, '_logfp').flush()
def makefile(self, mode, bufsize): def makefile(self, mode, bufsize):
f = object.__getattribute__(self, '_orig').makefile(mode, bufsize) f = object.__getattribute__(self, '_orig').makefile(mode, bufsize)
logfp = object.__getattribute__(self, '_logfp') logfp = object.__getattribute__(self, '_logfp')
close_after_recv_bytes = object.__getattribute__( cond = object.__getattribute__(self, '_cond')
self, '_close_after_recv_bytes'
)
close_after_send_bytes = object.__getattribute__(
self, '_close_after_send_bytes'
)
return fileobjectproxy( return fileobjectproxy(f, logfp, cond)
f,
logfp,
close_after_recv_bytes=close_after_recv_bytes,
close_after_send_bytes=close_after_send_bytes,
)
def sendall(self, data, flags=0): def sendall(self, data, flags=0):
remaining = object.__getattribute__(self, '_close_after_send_bytes') remaining = object.__getattribute__(self, '_cond').remaining_send_bytes
# No read limit. Call original function. # No read limit. Call original function.
if not remaining: if not remaining:
result = object.__getattribute__(self, '_orig').sendall(data, flags) result = object.__getattribute__(self, '_orig').sendall(data, flags)
self._writelog(b'sendall(%d) -> %s' % (len(data), data)) self._writelog(b'sendall(%d) -> %s' % (len(data), data))
return result return result
if len(data) > remaining: if len(data) > remaining:
newdata = data[0:remaining] newdata = data[0:remaining]
else: else:
newdata = data newdata = data
remaining -= len(newdata) remaining -= len(newdata)
result = object.__getattribute__(self, '_orig').sendall(newdata, flags) result = object.__getattribute__(self, '_orig').sendall(newdata, flags)
self._writelog( self._writelog(
b'sendall(%d from %d) -> (%d) %s' b'sendall(%d from %d) -> (%d) %s'
% (len(newdata), len(data), remaining, newdata) % (len(newdata), len(data), remaining, newdata)
) )
object.__setattr__(self, '_close_after_send_bytes', remaining) object.__getattribute__(self, '_cond').remaining_send_bytes = remaining
if remaining <= 0: if remaining <= 0:
self._writelog(b'write limit reached; closing socket') self._writelog(b'write limit reached; closing socket')
object.__getattribute__(self, '_orig').shutdown(socket.SHUT_RDWR) object.__getattribute__(self, '_orig').shutdown(socket.SHUT_RDWR)
raise Exception('connection closed after sending N bytes') raise Exception('connection closed after sending N bytes')
return result return result
# We can't adjust __class__ on socket._fileobject, so define a proxy. # We can't adjust __class__ on socket._fileobject, so define a proxy.
class fileobjectproxy(object): class fileobjectproxy(object):
__slots__ = ( __slots__ = ('_orig', '_logfp', '_cond')
'_orig',
'_logfp',
'_close_after_recv_bytes',
'_close_after_send_bytes',
)
def __init__( def __init__(self, obj, logfp, condition_tracked):
self, obj, logfp, close_after_recv_bytes=0, close_after_send_bytes=0
):
object.__setattr__(self, '_orig', obj) object.__setattr__(self, '_orig', obj)
object.__setattr__(self, '_logfp', logfp) object.__setattr__(self, '_logfp', logfp)
object.__setattr__( object.__setattr__(self, '_cond', condition_tracked)
self, '_close_after_recv_bytes', close_after_recv_bytes
)
object.__setattr__(
self, '_close_after_send_bytes', close_after_send_bytes
)
def __getattribute__(self, name): def __getattribute__(self, name):
if name in ('_close', 'read', 'readline', 'write', '_writelog'): if name in ('_close', 'read', 'readline', 'write', '_writelog'):
return object.__getattribute__(self, name) return object.__getattribute__(self, name)
return getattr(object.__getattribute__(self, '_orig'), name) return getattr(object.__getattribute__(self, '_orig'), name)
def __delattr__(self, name): def __delattr__(self, name):
if hasattr(orig, 'raw'): if hasattr(orig, 'raw'):
orig.raw._sock.shutdown(socket.SHUT_RDWR) orig.raw._sock.shutdown(socket.SHUT_RDWR)
else: else:
self.close() self.close()
else: else:
self._sock.shutdown(socket.SHUT_RDWR) self._sock.shutdown(socket.SHUT_RDWR)
def read(self, size=-1): def read(self, size=-1):
remaining = object.__getattribute__(self, '_close_after_recv_bytes') remaining = object.__getattribute__(self, '_cond').remaining_recv_bytes
# No read limit. Call original function. # No read limit. Call original function.
if not remaining: if not remaining:
result = object.__getattribute__(self, '_orig').read(size) result = object.__getattribute__(self, '_orig').read(size)
self._writelog( self._writelog(
b'read(%d) -> (%d) (%s) %s' % (size, len(result), result) b'read(%d) -> (%d) (%s) %s' % (size, len(result), result)
) )
return result return result
origsize = size origsize = size
if size < 0: if size < 0:
size = remaining size = remaining
else: else:
size = min(remaining, size) size = min(remaining, size)
result = object.__getattribute__(self, '_orig').read(size) result = object.__getattribute__(self, '_orig').read(size)
remaining -= len(result) remaining -= len(result)
self._writelog( self._writelog(
b'read(%d from %d) -> (%d) %s' b'read(%d from %d) -> (%d) %s'
% (size, origsize, len(result), result) % (size, origsize, len(result), result)
) )
object.__setattr__(self, '_close_after_recv_bytes', remaining) object.__getattribute__(self, '_cond').remaining_recv_bytes = remaining
if remaining <= 0: if remaining <= 0:
self._writelog(b'read limit reached; closing socket') self._writelog(b'read limit reached; closing socket')
self._close() self._close()
# This is the easiest way to abort the current request. # This is the easiest way to abort the current request.
raise Exception('connection closed after receiving N bytes') raise Exception('connection closed after receiving N bytes')
return result return result
def readline(self, size=-1): def readline(self, size=-1):
remaining = object.__getattribute__(self, '_close_after_recv_bytes') remaining = object.__getattribute__(self, '_cond').remaining_recv_bytes
# No read limit. Call original function. # No read limit. Call original function.
if not remaining: if not remaining:
result = object.__getattribute__(self, '_orig').readline(size) result = object.__getattribute__(self, '_orig').readline(size)
self._writelog( self._writelog(
b'readline(%d) -> (%d) %s' % (size, len(result), result) b'readline(%d) -> (%d) %s' % (size, len(result), result)
) )
return result return result
origsize = size origsize = size
if size < 0: if size < 0:
size = remaining size = remaining
else: else:
size = min(remaining, size) size = min(remaining, size)
result = object.__getattribute__(self, '_orig').readline(size) result = object.__getattribute__(self, '_orig').readline(size)
remaining -= len(result) remaining -= len(result)
self._writelog( self._writelog(
b'readline(%d from %d) -> (%d) %s' b'readline(%d from %d) -> (%d) %s'
% (size, origsize, len(result), result) % (size, origsize, len(result), result)
) )
object.__setattr__(self, '_close_after_recv_bytes', remaining) object.__getattribute__(self, '_cond').remaining_recv_bytes = remaining
if remaining <= 0: if remaining <= 0:
self._writelog(b'read limit reached; closing socket') self._writelog(b'read limit reached; closing socket')
self._close() self._close()
# This is the easiest way to abort the current request. # This is the easiest way to abort the current request.
raise Exception('connection closed after receiving N bytes') raise Exception('connection closed after receiving N bytes')
return result return result
def write(self, data): def write(self, data):
remaining = object.__getattribute__(self, '_close_after_send_bytes') remaining = object.__getattribute__(self, '_cond').remaining_send_bytes
# No byte limit on this operation. Call original function. # No byte limit on this operation. Call original function.
if not remaining: if not remaining:
self._writelog(b'write(%d) -> %s' % (len(data), data)) self._writelog(b'write(%d) -> %s' % (len(data), data))
result = object.__getattribute__(self, '_orig').write(data) result = object.__getattribute__(self, '_orig').write(data)
return result return result
if len(data) > remaining: if len(data) > remaining:
newdata = data[0:remaining] newdata = data[0:remaining]
else: else:
newdata = data newdata = data
remaining -= len(newdata) remaining -= len(newdata)
self._writelog( self._writelog(
b'write(%d from %d) -> (%d) %s' b'write(%d from %d) -> (%d) %s'
% (len(newdata), len(data), remaining, newdata) % (len(newdata), len(data), remaining, newdata)
) )
result = object.__getattribute__(self, '_orig').write(newdata) result = object.__getattribute__(self, '_orig').write(newdata)
object.__setattr__(self, '_close_after_send_bytes', remaining) object.__getattribute__(self, '_cond').remaining_send_bytes = remaining
if remaining <= 0: if remaining <= 0:
self._writelog(b'write limit reached; closing socket') self._writelog(b'write limit reached; closing socket')
self._close() self._close()
raise Exception('connection closed after sending N bytes') raise Exception('connection closed after sending N bytes')
return result return result
def process_config(value):
parts = value.split(b',')
integers = [int(v) for v in parts if v]
return [v if v else None for v in integers]
def extsetup(ui): def extsetup(ui):
# Change the base HTTP server class so various events can be performed. # Change the base HTTP server class so various events can be performed.
# See SocketServer.BaseServer for how the specially named methods work. # See SocketServer.BaseServer for how the specially named methods work.
class badserver(server.MercurialHTTPServer): class badserver(server.MercurialHTTPServer):
def __init__(self, ui, *args, **kwargs): def __init__(self, ui, *args, **kwargs):
self._ui = ui self._ui = ui
super(badserver, self).__init__(ui, *args, **kwargs) super(badserver, self).__init__(ui, *args, **kwargs)
recvbytes = self._ui.config(b'badserver', b'close-after-recv-bytes') all_recv_bytes = self._ui.config(
recvbytes = recvbytes.split(b',') b'badserver', b'close-after-recv-bytes'
self.close_after_recv_bytes = [int(v) for v in recvbytes if v] )
sendbytes = self._ui.config(b'badserver', b'close-after-send-bytes') all_recv_bytes = process_config(all_recv_bytes)
sendbytes = sendbytes.split(b',') all_send_bytes = self._ui.config(
self.close_after_send_bytes = [int(v) for v in sendbytes if v] b'badserver', b'close-after-send-bytes'
)
all_send_bytes = process_config(all_send_bytes)
self._cond = ConditionTracker(all_recv_bytes, all_send_bytes)
# Need to inherit object so super() works. # Need to inherit object so super() works.
class badrequesthandler(self.RequestHandlerClass, object): class badrequesthandler(self.RequestHandlerClass, object):
def send_header(self, name, value): def send_header(self, name, value):
# Make headers deterministic to facilitate testing. # Make headers deterministic to facilitate testing.
if name.lower() == 'date': if name.lower() == 'date':
value = 'Fri, 14 Apr 2017 00:00:00 GMT' value = 'Fri, 14 Apr 2017 00:00:00 GMT'
elif name.lower() == 'server': elif name.lower() == 'server':
return super(badserver, self).get_request() return super(badserver, self).get_request()
# Does heavy lifting of processing a request. Invokes # Does heavy lifting of processing a request. Invokes
# self.finish_request() which calls self.RequestHandlerClass() which # self.finish_request() which calls self.RequestHandlerClass() which
# is a hgweb.server._httprequesthandler. # is a hgweb.server._httprequesthandler.
def process_request(self, socket, address): def process_request(self, socket, address):
# Wrap socket in a proxy if we need to count bytes. # Wrap socket in a proxy if we need to count bytes.
if self.close_after_recv_bytes: self._cond.start_next_request()
close_after_recv_bytes = self.close_after_recv_bytes.pop(0)
else:
close_after_recv_bytes = 0
if self.close_after_send_bytes:
close_after_send_bytes = self.close_after_send_bytes.pop(0)
else:
close_after_send_bytes = 0
if close_after_recv_bytes or close_after_send_bytes: if self._cond.might_close():
socket = socketproxy( socket = socketproxy(
socket, socket, self.errorlog, condition_tracked=self._cond
self.errorlog,
close_after_recv_bytes=close_after_recv_bytes,
close_after_send_bytes=close_after_send_bytes,
) )
return super(badserver, self).process_request(socket, address) return super(badserver, self).process_request(socket, address)
server.MercurialHTTPServer = badserver server.MercurialHTTPServer = badserver