This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3234

httppeer: extract code for creating a request into own function
ClosedPublic

Authored by indygreg on Apr 10 2018, 9:28 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG66d1001e1500: httppeer: extract code for creating a request into own function
Summary

Some of this feels awkward, such as having to pass in a function
to evaluate a capability. And this code is generally pretty difficult
to read. I didn't want to perform too much refactoring as part of
the code move since it would make review more difficult.

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

indygreg created this revision.Apr 10 2018, 9:28 PM
durin42 accepted this revision.Apr 11 2018, 12:45 PM
This revision is now accepted and ready to land.Apr 11 2018, 12:45 PM
Closed by commit rHG66d1001e1500: httppeer: extract code for creating a request into own function (authored by indygreg). · Explain WhyApr 11 2018, 1:00 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/httppeer.py (212 lines)

Diff 7995

mercurial/httppeer.py

if offset != 0: if offset != 0:
raise NotImplementedError( raise NotImplementedError(
'_multifile only supports seeking to start, but that ' '_multifile only supports seeking to start, but that '
'could be fixed if you need it') 'could be fixed if you need it')
for f in self._fileobjs: for f in self._fileobjs:
f.seek(0) f.seek(0)
self._index = 0 self._index = 0
def sendrequest(ui, opener, req): def makev1commandrequest(ui, requestbuilder, caps, capablefn,
"""Send a prepared HTTP request. repobaseurl, cmd, args):
"""Make an HTTP request to run a command for a version 1 client.
Returns the response object.
"""
if (ui.debugflag
and ui.configbool('devel', 'debug.peer-request')):
dbg = ui.debug
line = 'devel-peer-request: %s\n'
dbg(line % '%s %s' % (req.get_method(), req.get_full_url()))
hgargssize = None
for header, value in sorted(req.header_items()):
if header.startswith('X-hgarg-'):
if hgargssize is None:
hgargssize = 0
hgargssize += len(value)
else:
dbg(line % ' %s %s' % (header, value))
if hgargssize is not None:
dbg(line % ' %d bytes of commands arguments in headers'
% hgargssize)
if req.has_data(): ``caps`` is a set of known server capabilities. The value may be
data = req.get_data() None if capabilities are not yet known.
length = getattr(data, 'length', None)
if length is None:
length = len(data)
dbg(line % ' %d bytes of data' % length)
start = util.timer() ``capablefn`` is a function to evaluate a capability.
res = opener.open(req)
if ui.configbool('devel', 'debug.peer-request'):
dbg(line % ' finished in %.4f seconds (%s)'
% (util.timer() - start, res.code))
return res
class httppeer(wireproto.wirepeer):
def __init__(self, ui, path, url, opener, requestbuilder):
self.ui = ui
self._path = path
self._url = url
self._caps = None
self._urlopener = opener
self._requestbuilder = requestbuilder
def __del__(self): ``cmd``, ``args``, and ``data`` define the command, its arguments, and
for h in self._urlopener.handlers: raw data to pass to it.
h.close() """
getattr(h, "close_all", lambda: None)()
# Begin of ipeerconnection interface.
def url(self):
return self._path
def local(self):
return None
def peer(self):
return self
def canpush(self):
return True
def close(self):
pass
# End of ipeerconnection interface.
# Begin of ipeercommands interface.
def capabilities(self):
# self._fetchcaps() should have been called as part of peer
# handshake. So self._caps should always be set.
assert self._caps is not None
return self._caps
# End of ipeercommands interface.
# look up capabilities only when needed
def _fetchcaps(self):
self._caps = set(self._call('capabilities').split())
def _callstream(self, cmd, _compressible=False, **args):
args = pycompat.byteskwargs(args)
if cmd == 'pushkey': if cmd == 'pushkey':
args['data'] = '' args['data'] = ''
data = args.pop('data', None) data = args.pop('data', None)
headers = args.pop('headers', {}) headers = args.pop('headers', {})
self.ui.debug("sending %s command\n" % cmd) ui.debug("sending %s command\n" % cmd)
q = [('cmd', cmd)] q = [('cmd', cmd)]
headersize = 0 headersize = 0
varyheaders = [] varyheaders = []
# Important: don't use self.capable() here or else you end up # Important: don't use self.capable() here or else you end up
# with infinite recursion when trying to look up capabilities # with infinite recursion when trying to look up capabilities
# for the first time. # for the first time.
postargsok = self._caps is not None and 'httppostargs' in self._caps postargsok = caps is not None and 'httppostargs' in caps
# Send arguments via POST. # Send arguments via POST.
if postargsok and args: if postargsok and args:
strargs = urlreq.urlencode(sorted(args.items())) strargs = urlreq.urlencode(sorted(args.items()))
if not data: if not data:
data = strargs data = strargs
else: else:
if isinstance(data, bytes): if isinstance(data, bytes):
i = io.BytesIO(data) i = io.BytesIO(data)
i.length = len(data) i.length = len(data)
data = i data = i
argsio = io.BytesIO(strargs) argsio = io.BytesIO(strargs)
argsio.length = len(strargs) argsio.length = len(strargs)
data = _multifile(argsio, data) data = _multifile(argsio, data)
headers[r'X-HgArgs-Post'] = len(strargs) headers[r'X-HgArgs-Post'] = len(strargs)
elif args: elif args:
# Calling self.capable() can infinite loop if we are calling # Calling self.capable() can infinite loop if we are calling
# "capabilities". But that command should never accept wire # "capabilities". But that command should never accept wire
# protocol arguments. So this should never happen. # protocol arguments. So this should never happen.
assert cmd != 'capabilities' assert cmd != 'capabilities'
httpheader = self.capable('httpheader') httpheader = capablefn('httpheader')
if httpheader: if httpheader:
headersize = int(httpheader.split(',', 1)[0]) headersize = int(httpheader.split(',', 1)[0])
# Send arguments via HTTP headers. # Send arguments via HTTP headers.
if headersize > 0: if headersize > 0:
# The headers can typically carry more data than the URL. # The headers can typically carry more data than the URL.
encargs = urlreq.urlencode(sorted(args.items())) encargs = urlreq.urlencode(sorted(args.items()))
for header, value in encodevalueinheaders(encargs, 'X-HgArg', for header, value in encodevalueinheaders(encargs, 'X-HgArg',
headersize): headersize):
headers[header] = value headers[header] = value
varyheaders.append(header) varyheaders.append(header)
# Send arguments via query string (Mercurial <1.9). # Send arguments via query string (Mercurial <1.9).
else: else:
q += sorted(args.items()) q += sorted(args.items())
qs = '?%s' % urlreq.urlencode(q) qs = '?%s' % urlreq.urlencode(q)
cu = "%s%s" % (self._url, qs) cu = "%s%s" % (repobaseurl, qs)
size = 0 size = 0
if util.safehasattr(data, 'length'): if util.safehasattr(data, 'length'):
size = data.length size = data.length
elif data is not None: elif data is not None:
size = len(data) size = len(data)
if data is not None and r'Content-Type' not in headers: if data is not None and r'Content-Type' not in headers:
headers[r'Content-Type'] = r'application/mercurial-0.1' headers[r'Content-Type'] = r'application/mercurial-0.1'
# Tell the server we accept application/mercurial-0.2 and multiple # Tell the server we accept application/mercurial-0.2 and multiple
# compression formats if the server is capable of emitting those # compression formats if the server is capable of emitting those
# payloads. # payloads.
protoparams = {'partial-pull'} protoparams = {'partial-pull'}
mediatypes = set() mediatypes = set()
if self._caps is not None: if caps is not None:
mt = self.capable('httpmediatype') mt = capablefn('httpmediatype')
if mt: if mt:
protoparams.add('0.1') protoparams.add('0.1')
mediatypes = set(mt.split(',')) mediatypes = set(mt.split(','))
if '0.2tx' in mediatypes: if '0.2tx' in mediatypes:
protoparams.add('0.2') protoparams.add('0.2')
if '0.2tx' in mediatypes and self.capable('compression'): if '0.2tx' in mediatypes and capablefn('compression'):
# We /could/ compare supported compression formats and prune # We /could/ compare supported compression formats and prune
# non-mutually supported or error if nothing is mutually supported. # non-mutually supported or error if nothing is mutually supported.
# For now, send the full list to the server and have it error. # For now, send the full list to the server and have it error.
comps = [e.wireprotosupport().name for e in comps = [e.wireprotosupport().name for e in
util.compengines.supportedwireengines(util.CLIENTROLE)] util.compengines.supportedwireengines(util.CLIENTROLE)]
protoparams.add('comp=%s' % ','.join(comps)) protoparams.add('comp=%s' % ','.join(comps))
if protoparams: if protoparams:
protoheaders = encodevalueinheaders(' '.join(sorted(protoparams)), protoheaders = encodevalueinheaders(' '.join(sorted(protoparams)),
'X-HgProto', 'X-HgProto',
headersize or 1024) headersize or 1024)
for header, value in protoheaders: for header, value in protoheaders:
headers[header] = value headers[header] = value
varyheaders.append(header) varyheaders.append(header)
if varyheaders: if varyheaders:
headers[r'Vary'] = r','.join(varyheaders) headers[r'Vary'] = r','.join(varyheaders)
req = self._requestbuilder(pycompat.strurl(cu), data, headers) req = requestbuilder(pycompat.strurl(cu), data, headers)
if data is not None: if data is not None:
self.ui.debug("sending %d bytes\n" % size) ui.debug("sending %d bytes\n" % size)
req.add_unredirected_header(r'Content-Length', r'%d' % size) req.add_unredirected_header(r'Content-Length', r'%d' % size)
return req, cu, qs
def sendrequest(ui, opener, req):
"""Send a prepared HTTP request.
Returns the response object.
"""
if (ui.debugflag
and ui.configbool('devel', 'debug.peer-request')):
dbg = ui.debug
line = 'devel-peer-request: %s\n'
dbg(line % '%s %s' % (req.get_method(), req.get_full_url()))
hgargssize = None
for header, value in sorted(req.header_items()):
if header.startswith('X-hgarg-'):
if hgargssize is None:
hgargssize = 0
hgargssize += len(value)
else:
dbg(line % ' %s %s' % (header, value))
if hgargssize is not None:
dbg(line % ' %d bytes of commands arguments in headers'
% hgargssize)
if req.has_data():
data = req.get_data()
length = getattr(data, 'length', None)
if length is None:
length = len(data)
dbg(line % ' %d bytes of data' % length)
start = util.timer()
res = opener.open(req)
if ui.configbool('devel', 'debug.peer-request'):
dbg(line % ' finished in %.4f seconds (%s)'
% (util.timer() - start, res.code))
return res
class httppeer(wireproto.wirepeer):
def __init__(self, ui, path, url, opener, requestbuilder):
self.ui = ui
self._path = path
self._url = url
self._caps = None
self._urlopener = opener
self._requestbuilder = requestbuilder
def __del__(self):
for h in self._urlopener.handlers:
h.close()
getattr(h, "close_all", lambda: None)()
# Begin of ipeerconnection interface.
def url(self):
return self._path
def local(self):
return None
def peer(self):
return self
def canpush(self):
return True
def close(self):
pass
# End of ipeerconnection interface.
# Begin of ipeercommands interface.
def capabilities(self):
# self._fetchcaps() should have been called as part of peer
# handshake. So self._caps should always be set.
assert self._caps is not None
return self._caps
# End of ipeercommands interface.
# look up capabilities only when needed
def _fetchcaps(self):
self._caps = set(self._call('capabilities').split())
def _callstream(self, cmd, _compressible=False, **args):
args = pycompat.byteskwargs(args)
req, cu, qs = makev1commandrequest(self.ui, self._requestbuilder,
self._caps, self.capable,
self._url, cmd, args)
try: try:
resp = sendrequest(self.ui, self._urlopener, req) resp = sendrequest(self.ui, self._urlopener, req)
except urlerr.httperror as inst: except urlerr.httperror as inst:
if inst.code == 401: if inst.code == 401:
raise error.Abort(_('authorization failed')) raise error.Abort(_('authorization failed'))
raise raise
except httplib.HTTPException as inst: except httplib.HTTPException as inst:
self.ui.debug('http error while sending %s command\n' % cmd) self.ui.debug('http error while sending %s command\n' % cmd)