( )⚙ D3232 httppeer: move requestbuilder defaults into makepeer() argument

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3232

httppeer: move requestbuilder defaults into makepeer() argument
ClosedPublic

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

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG835ccc2a5ef1: httppeer: move requestbuilder defaults into makepeer() argument
Summary

Upcoming commits will move the initial ?cmd=capabilities handshake
request out of httppeer so the handshake can be performed before a
peer instance is constructed. In order to do this, we'll need to
refactor code for making HTTP requests.

The type used to construct HTTP requests is configurable. If we'll
be making HTTP requests outside of httppeer, we should be able to
use a custom request builder. So move the definition of that type
into makepeer().

Extensions can monkeypatch the function and override the argument
value.

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:38 PM
This revision is now accepted and ready to land.Apr 11 2018, 12:38 PM
Closed by commit rHG835ccc2a5ef1: httppeer: move requestbuilder defaults into makepeer() argument (authored by indygreg). · Explain WhyApr 11 2018, 1:00 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 7993

mercurial/debugcommands.py

peer = httppeer.httpv2peer(ui, path, opener) peer = httppeer.httpv2peer(ui, path, opener)
elif opts['peer'] == 'raw': elif opts['peer'] == 'raw':
ui.write(_('using raw connection to peer\n')) ui.write(_('using raw connection to peer\n'))
peer = None peer = None
elif opts['peer']: elif opts['peer']:
raise error.Abort(_('--peer %s not supported with HTTP peers') % raise error.Abort(_('--peer %s not supported with HTTP peers') %
opts['peer']) opts['peer'])
else: else:
peer = httppeer.httppeer(ui, path, url, opener) peer = httppeer.httppeer(ui, path, url, opener,
requestbuilder=httppeer.urlreq.request)
peer._fetchcaps() peer._fetchcaps()
# We /could/ populate stdin/stdout with sock.makefile()... # We /could/ populate stdin/stdout with sock.makefile()...
else: else:
raise error.Abort(_('unsupported connection configuration')) raise error.Abort(_('unsupported connection configuration'))
batchedcommands = None batchedcommands = None

mercurial/httppeer.py

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
class httppeer(wireproto.wirepeer): class httppeer(wireproto.wirepeer):
def __init__(self, ui, path, url, opener): def __init__(self, ui, path, url, opener, requestbuilder):
self.ui = ui self.ui = ui
self._path = path self._path = path
self._url = url self._url = url
self._caps = None self._caps = None
self._urlopener = opener self._urlopener = opener
# This is an its own attribute to facilitate extensions overriding self._requestbuilder = requestbuilder
# the default type.
self._requestbuilder = urlreq.request
def __del__(self): def __del__(self):
for h in self._urlopener.handlers: for h in self._urlopener.handlers:
h.close() h.close()
getattr(h, "close_all", lambda: None)() getattr(h, "close_all", lambda: None)()
def _openurl(self, req): def _openurl(self, req):
if (self.ui.debugflag if (self.ui.debugflag
results.append(decoder.decode()) results.append(decoder.decode())
else: else:
results.append(meta['data']) results.append(meta['data'])
else: else:
error.ProgrammingError('unhandled action: %s' % action) error.ProgrammingError('unhandled action: %s' % action)
return results return results
def makepeer(ui, path): def makepeer(ui, path, requestbuilder=urlreq.request):
"""Construct an appropriate HTTP peer instance.
``requestbuilder`` is the type used for constructing HTTP requests.
It exists as an argument so extensions can override the default.
"""
u = util.url(path) u = util.url(path)
if u.query or u.fragment: if u.query or u.fragment:
raise error.Abort(_('unsupported URL component: "%s"') % raise error.Abort(_('unsupported URL component: "%s"') %
(u.query or u.fragment)) (u.query or u.fragment))
# urllib cannot handle URLs with embedded user or passwd. # urllib cannot handle URLs with embedded user or passwd.
url, authinfo = u.authinfo() url, authinfo = u.authinfo()
ui.debug('using %s\n' % url) ui.debug('using %s\n' % url)
opener = urlmod.opener(ui, authinfo) opener = urlmod.opener(ui, authinfo)
return httppeer(ui, path, url, opener) return httppeer(ui, path, url, opener, requestbuilder)
def instance(ui, path, create): def instance(ui, path, create):
if create: if create:
raise error.Abort(_('cannot create new http repository')) raise error.Abort(_('cannot create new http repository'))
try: try:
if path.startswith('https:') and not urlmod.has_https: if path.startswith('https:') and not urlmod.has_https:
raise error.Abort(_('Python support for SSL and HTTPS ' raise error.Abort(_('Python support for SSL and HTTPS '
'is not installed')) 'is not installed'))

tests/test-check-interfaces.py

pass pass
class dummyopener(object): class dummyopener(object):
handlers = [] handlers = []
# Facilitates testing sshpeer without requiring an SSH server. # Facilitates testing sshpeer without requiring an SSH server.
class badpeer(httppeer.httppeer): class badpeer(httppeer.httppeer):
def __init__(self): def __init__(self):
super(badpeer, self).__init__(None, None, None, dummyopener()) super(badpeer, self).__init__(None, None, None, dummyopener(), None)
self.badattribute = True self.badattribute = True
def badmethod(self): def badmethod(self):
pass pass
class dummypipe(object): class dummypipe(object):
def close(self): def close(self):
pass pass
def main(): def main():
ui = uimod.ui() ui = uimod.ui()
# Needed so we can open a local repo with obsstore without a warning. # Needed so we can open a local repo with obsstore without a warning.
ui.setconfig('experimental', 'evolution.createmarkers', True) ui.setconfig('experimental', 'evolution.createmarkers', True)
checkzobject(badpeer()) checkzobject(badpeer())
ziverify.verifyClass(repository.ipeerbaselegacycommands, ziverify.verifyClass(repository.ipeerbaselegacycommands,
httppeer.httppeer) httppeer.httppeer)
checkzobject(httppeer.httppeer(None, None, None, dummyopener())) checkzobject(httppeer.httppeer(None, None, None, dummyopener(), None))
ziverify.verifyClass(repository.ipeerbase, ziverify.verifyClass(repository.ipeerbase,
localrepo.localpeer) localrepo.localpeer)
checkzobject(localrepo.localpeer(dummyrepo())) checkzobject(localrepo.localpeer(dummyrepo()))
ziverify.verifyClass(repository.ipeerbaselegacycommands, ziverify.verifyClass(repository.ipeerbaselegacycommands,
sshpeer.sshv1peer) sshpeer.sshv1peer)
checkzobject(sshpeer.sshv1peer(ui, 'ssh://localhost/foo', None, dummypipe(), checkzobject(sshpeer.sshv1peer(ui, 'ssh://localhost/foo', None, dummypipe(),