( )⚙ D2725 httppeer: refactor how httppeer is created (API)

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2725

httppeer: refactor how httppeer is created (API)
ClosedPublic

Authored by indygreg on Mar 8 2018, 12:31 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG8e89c2bec1f7: httppeer: refactor how httppeer is created (API)
Summary

Previously, we passed a bunch of arguments to httppeer.init,
validated them, then possibly constructed a valid instance.

A short while ago, we refactored sshpeer so all the validation and
setup work occurs before the constructor. We introduced a makepeer()
to hold most of this logic.

This commit gives httppeer the same treatment.

As a sign that the previous design was poor, del no longer
conditionally checks for the presence of an attribute that may
not be defined (it is always defined in the new code).

.. api::

httppeer.httppeer.__init__ now takes additional arguments.
Instances should be obtained by calling httppeer.instance()
or httppeer.makepeer() instead.

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.

Revision Contents
Changeset List

PathPackages
Mmercurial/httppeer.py (42 lines)
Mtests/test-check-interfaces.py (7 lines)

Diff 7152

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): def __init__(self, ui, path, url, opener):
self._ui = ui
self._path = path self._path = path
self._url = url
self._caps = None self._caps = None
self._urlopener = None self._urlopener = opener
# This is an its own attribute to facilitate extensions overriding # This is an its own attribute to facilitate extensions overriding
# the default type. # the default type.
self._requestbuilder = urlreq.request self._requestbuilder = urlreq.request
u = util.url(path)
if u.query or u.fragment:
raise error.Abort(_('unsupported URL component: "%s"') %
(u.query or u.fragment))
# urllib cannot handle URLs with embedded user or passwd
self._url, authinfo = u.authinfo()
self._ui = ui
ui.debug('using %s\n' % self._url)
self._urlopener = urlmod.opener(ui, authinfo)
def __del__(self): def __del__(self):
urlopener = getattr(self, '_urlopener', None) for h in self._urlopener.handlers:
if urlopener:
for h in 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
and self._ui.configbool('devel', 'debug.peer-request')): and self._ui.configbool('devel', 'debug.peer-request')):
dbg = self._ui.debug dbg = self._ui.debug
line = 'devel-peer-request: %s\n' line = 'devel-peer-request: %s\n'
dbg(line % '%s %s' % (req.get_method(), req.get_full_url())) dbg(line % '%s %s' % (req.get_method(), req.get_full_url()))
hgargssize = None hgargssize = None
os.unlink(filename) os.unlink(filename)
def _callcompressable(self, cmd, **args): def _callcompressable(self, cmd, **args):
return self._callstream(cmd, _compressible=True, **args) return self._callstream(cmd, _compressible=True, **args)
def _abort(self, exception): def _abort(self, exception):
raise exception raise exception
def makepeer(ui, path):
u = util.url(path)
if u.query or u.fragment:
raise error.Abort(_('unsupported URL component: "%s"') %
(u.query or u.fragment))
# urllib cannot handle URLs with embedded user or passwd.
url, authinfo = u.authinfo()
ui.debug('using %s\n' % url)
opener = urlmod.opener(ui, authinfo)
return httppeer(ui, path, url, opener)
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'))
inst = httppeer(ui, path) inst = makepeer(ui, path)
inst._fetchcaps() inst._fetchcaps()
return inst return inst
except error.RepoError as httpexception: except error.RepoError as httpexception:
try: try:
r = statichttprepo.instance(ui, "static-" + path, create) r = statichttprepo.instance(ui, "static-" + path, create)
ui.note(_('(falling back to static-http)\n')) ui.note(_('(falling back to static-http)\n'))
return r return r
except error.RepoError: except error.RepoError:
raise httpexception # use the original http RepoError instead raise httpexception # use the original http RepoError instead

tests/test-check-interfaces.py

class dummyrepo(object): class dummyrepo(object):
def __init__(self): def __init__(self):
self.ui = uimod.ui() self.ui = uimod.ui()
def filtered(self, name): def filtered(self, name):
pass pass
def _restrictcapabilities(self, caps): def _restrictcapabilities(self, caps):
pass pass
class dummyopener(object):
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__(uimod.ui(), 'http://localhost') super(badpeer, self).__init__(None, None, None, dummyopener())
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()
checkobject(badpeer()) checkobject(badpeer())
checkobject(httppeer.httppeer(ui, 'http://localhost')) checkobject(httppeer.httppeer(None, None, None, dummyopener()))
checkobject(localrepo.localpeer(dummyrepo())) checkobject(localrepo.localpeer(dummyrepo()))
checkobject(sshpeer.sshv1peer(ui, 'ssh://localhost/foo', None, dummypipe(), checkobject(sshpeer.sshv1peer(ui, 'ssh://localhost/foo', None, dummypipe(),
dummypipe(), None, None)) dummypipe(), None, None))
checkobject(sshpeer.sshv2peer(ui, 'ssh://localhost/foo', None, dummypipe(), checkobject(sshpeer.sshv2peer(ui, 'ssh://localhost/foo', None, dummypipe(),
dummypipe(), None, None)) dummypipe(), None, None))
checkobject(bundlerepo.bundlepeer(dummyrepo())) checkobject(bundlerepo.bundlepeer(dummyrepo()))
checkobject(statichttprepo.statichttppeer(dummyrepo())) checkobject(statichttprepo.statichttppeer(dummyrepo()))
checkobject(unionrepo.unionpeer(dummyrepo())) checkobject(unionrepo.unionpeer(dummyrepo()))
main() main()