This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2512

wireproto: add transport specific capabilities in the transport
ClosedPublic

Authored by indygreg on Mar 1 2018, 11:34 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG6e585bca962e: wireproto: add transport specific capabilities in the transport
Summary

We add a method to the protocol handler interface that allows
specific implementations to add their own capabilities.

The SSH implementation is a no-op.

The HTTP implementation adds the HTTP-specific capabilities.

The end result is transport specific capabilities now live in the
transport code instead of in some generic function in the wireproto
module.

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.Mar 1 2018, 11:34 AM
indygreg updated this revision to Diff 6341.Mar 2 2018, 9:50 AM
durin42 accepted this revision.Mar 2 2018, 7:06 PM
This revision is now accepted and ready to land.Mar 2 2018, 7:06 PM
Closed by commit rHG6e585bca962e: wireproto: add transport specific capabilities in the transport (authored by indygreg). · Explain WhyMar 2 2018, 7:13 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 6412

mercurial/wireproto.py

# otherwise, add 'streamreqs' detailing our local revlog format # otherwise, add 'streamreqs' detailing our local revlog format
else: else:
caps.append('streamreqs=%s' % ','.join(sorted(requiredformats))) caps.append('streamreqs=%s' % ','.join(sorted(requiredformats)))
if repo.ui.configbool('experimental', 'bundle2-advertise'): if repo.ui.configbool('experimental', 'bundle2-advertise'):
capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo, role='server')) capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo, role='server'))
caps.append('bundle2=' + urlreq.quote(capsblob)) caps.append('bundle2=' + urlreq.quote(capsblob))
caps.append('unbundle=%s' % ','.join(bundle2.bundlepriority)) caps.append('unbundle=%s' % ','.join(bundle2.bundlepriority))
if proto.name == 'http-v1': return proto.addcapabilities(repo, caps)
caps.append('httpheader=%d' %
repo.ui.configint('server', 'maxhttpheaderlen'))
if repo.ui.configbool('experimental', 'httppostargs'):
caps.append('httppostargs')
# FUTURE advertise 0.2rx once support is implemented
# FUTURE advertise minrx and mintx after consulting config option
caps.append('httpmediatype=0.1rx,0.1tx,0.2tx')
compengines = supportedcompengines(repo.ui, util.SERVERROLE)
if compengines:
comptypes = ','.join(urlreq.quote(e.wireprotosupport().name)
for e in compengines)
caps.append('compression=%s' % comptypes)
return caps
# If you are writing an extension and consider wrapping this function. Wrap # If you are writing an extension and consider wrapping this function. Wrap
# `_capabilities` instead. # `_capabilities` instead.
@wireprotocommand('capabilities') @wireprotocommand('capabilities')
def capabilities(repo, proto): def capabilities(repo, proto):
return bytesresponse(' '.join(_capabilities(repo, proto))) return bytesresponse(' '.join(_capabilities(repo, proto)))
@wireprotocommand('changegroup', 'roots', transportpolicy=POLICY_V1_ONLY) @wireprotocommand('changegroup', 'roots', transportpolicy=POLICY_V1_ONLY)

mercurial/wireprotoserver.py

self._ui.ferr = olderr self._ui.ferr = olderr
def client(self): def client(self):
return 'remote:%s:%s:%s' % ( return 'remote:%s:%s:%s' % (
self._req.env.get('wsgi.url_scheme') or 'http', self._req.env.get('wsgi.url_scheme') or 'http',
urlreq.quote(self._req.env.get('REMOTE_HOST', '')), urlreq.quote(self._req.env.get('REMOTE_HOST', '')),
urlreq.quote(self._req.env.get('REMOTE_USER', ''))) urlreq.quote(self._req.env.get('REMOTE_USER', '')))
def addcapabilities(self, repo, caps):
caps.append('httpheader=%d' %
repo.ui.configint('server', 'maxhttpheaderlen'))
if repo.ui.configbool('experimental', 'httppostargs'):
caps.append('httppostargs')
# FUTURE advertise 0.2rx once support is implemented
# FUTURE advertise minrx and mintx after consulting config option
caps.append('httpmediatype=0.1rx,0.1tx,0.2tx')
compengines = wireproto.supportedcompengines(repo.ui, util.SERVERROLE)
if compengines:
comptypes = ','.join(urlreq.quote(e.wireprotosupport().name)
for e in compengines)
caps.append('compression=%s' % comptypes)
return caps
# This method exists mostly so that extensions like remotefilelog can # This method exists mostly so that extensions like remotefilelog can
# disable a kludgey legacy method only over http. As of early 2018, # disable a kludgey legacy method only over http. As of early 2018,
# there are no other known users, so with any luck we can discard this # there are no other known users, so with any luck we can discard this
# hook if remotefilelog becomes a first-party extension. # hook if remotefilelog becomes a first-party extension.
def iscmd(cmd): def iscmd(cmd):
return cmd in wireproto.commands return cmd in wireproto.commands
def parsehttprequest(repo, req, query): def parsehttprequest(repo, req, query):
@contextlib.contextmanager @contextlib.contextmanager
def mayberedirectstdio(self): def mayberedirectstdio(self):
yield None yield None
def client(self): def client(self):
client = encoding.environ.get('SSH_CLIENT', '').split(' ', 1)[0] client = encoding.environ.get('SSH_CLIENT', '').split(' ', 1)[0]
return 'remote:ssh:' + client return 'remote:ssh:' + client
def addcapabilities(self, repo, caps):
return caps
class sshv2protocolhandler(sshv1protocolhandler): class sshv2protocolhandler(sshv1protocolhandler):
"""Protocol handler for version 2 of the SSH protocol.""" """Protocol handler for version 2 of the SSH protocol."""
@property @property
def name(self): def name(self):
return wireprototypes.SSHV2 return wireprototypes.SSHV2
def _runsshserver(ui, repo, fin, fout, ev): def _runsshserver(ui, repo, fin, fout, ev):

mercurial/wireprototypes.py

so it may be sent in the response. Some transports support streaming so it may be sent in the response. Some transports support streaming
stdio to the client in real time. For these transports, stdio output stdio to the client in real time. For these transports, stdio output
won't be captured. won't be captured.
""" """
@abc.abstractmethod @abc.abstractmethod
def client(self): def client(self):
"""Returns a string representation of this client (as bytes).""" """Returns a string representation of this client (as bytes)."""
@abc.abstractmethod
def addcapabilities(self, repo, caps):
"""Adds advertised capabilities specific to this protocol.
Receives the list of capabilities collected so far.
Returns a list of capabilities. The passed in argument can be returned.
"""