( )⚙ D3258 wireproto: move gboptsmap to wireprototypes and rename (API)

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3258

wireproto: move gboptsmap to wireprototypes and rename (API)
ClosedPublic

Authored by indygreg on Apr 11 2018, 7:42 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG96d735601ca1: wireproto: move gboptsmap to wireprototypes and rename (API)
Summary

This is also shared between client and server and will need to
exist in a shared module when that code is split into different
modules.

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 11 2018, 7:42 PM
durin42 accepted this revision.Apr 12 2018, 6:21 PM
This revision is now accepted and ready to land.Apr 12 2018, 6:21 PM
Closed by commit rHG96d735601ca1: wireproto: move gboptsmap to wireprototypes and rename (API) (authored by indygreg). · Explain WhyApr 12 2018, 6:23 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 8099

hgext/narrow/narrowbundle2.py

changegroup, changegroup,
dagutil, dagutil,
error, error,
exchange, exchange,
extensions, extensions,
narrowspec, narrowspec,
repair, repair,
util, util,
wireproto, wireprototypes,
) )
from mercurial.utils import ( from mercurial.utils import (
stringutil, stringutil,
) )
NARROWCAP = 'narrow' NARROWCAP = 'narrow'
_NARROWACL_SECTION = 'narrowhgacl' _NARROWACL_SECTION = 'narrowhgacl'
_CHANGESPECPART = NARROWCAP + ':changespec' _CHANGESPECPART = NARROWCAP + ':changespec'
# Remove partial backup only if there were no exceptions # Remove partial backup only if there were no exceptions
vfs.unlink(chgrpfile) vfs.unlink(chgrpfile)
def setup(): def setup():
"""Enable narrow repo support in bundle2-related extension points.""" """Enable narrow repo support in bundle2-related extension points."""
extensions.wrapfunction(bundle2, 'getrepocaps', getrepocaps_narrow) extensions.wrapfunction(bundle2, 'getrepocaps', getrepocaps_narrow)
wireproto.gboptsmap['narrow'] = 'boolean' getbundleargs = wireprototypes.GETBUNDLE_ARGUMENTS
wireproto.gboptsmap['depth'] = 'plain'
wireproto.gboptsmap['oldincludepats'] = 'csv' getbundleargs['narrow'] = 'boolean'
wireproto.gboptsmap['oldexcludepats'] = 'csv' getbundleargs['depth'] = 'plain'
wireproto.gboptsmap['includepats'] = 'csv' getbundleargs['oldincludepats'] = 'csv'
wireproto.gboptsmap['excludepats'] = 'csv' getbundleargs['oldexcludepats'] = 'csv'
wireproto.gboptsmap['known'] = 'csv' getbundleargs['includepats'] = 'csv'
getbundleargs['excludepats'] = 'csv'
getbundleargs['known'] = 'csv'
# Extend changegroup serving to handle requests from narrow clients. # Extend changegroup serving to handle requests from narrow clients.
origcgfn = exchange.getbundle2partsmapping['changegroup'] origcgfn = exchange.getbundle2partsmapping['changegroup']
def wrappedcgfn(*args, **kwargs): def wrappedcgfn(*args, **kwargs):
repo = args[1] repo = args[1]
if repo.ui.has_section(_NARROWACL_SECTION): if repo.ui.has_section(_NARROWACL_SECTION):
getbundlechangegrouppart_narrow( getbundlechangegrouppart_narrow(
*args, **applyacl_narrow(repo, kwargs)) *args, **applyacl_narrow(repo, kwargs))

mercurial/wireproto.py

according to the protocol capabilities. If no such capability has according to the protocol capabilities. If no such capability has
been announced, fallback to the default of zlib and uncompressed. been announced, fallback to the default of zlib and uncompressed.
""" """
for cap in proto.getprotocaps(): for cap in proto.getprotocaps():
if cap.startswith('comp='): if cap.startswith('comp='):
return cap[5:].split(',') return cap[5:].split(',')
return ['zlib', 'none'] return ['zlib', 'none']
# mapping of options accepted by getbundle and their types
#
# Meant to be extended by extensions. It is extensions responsibility to ensure
# such options are properly processed in exchange.getbundle.
#
# supported types are:
#
# :nodes: list of binary nodes
# :csv: list of comma-separated values
# :scsv: list of comma-separated values return as set
# :plain: string with no transformation needed.
gboptsmap = {'heads': 'nodes',
'bookmarks': 'boolean',
'common': 'nodes',
'obsmarkers': 'boolean',
'phases': 'boolean',
'bundlecaps': 'scsv',
'listkeys': 'csv',
'cg': 'boolean',
'cbattempted': 'boolean',
'stream': 'boolean',
}
# client side # client side
class wirepeer(repository.legacypeer): class wirepeer(repository.legacypeer):
"""Client-side interface for communicating with a peer repository. """Client-side interface for communicating with a peer repository.
Methods commonly call wire protocol commands of the same name. Methods commonly call wire protocol commands of the same name.
See also httppeer.py and sshpeer.py for protocol-specific See also httppeer.py and sshpeer.py for protocol-specific
def getbundle(self, source, **kwargs): def getbundle(self, source, **kwargs):
kwargs = pycompat.byteskwargs(kwargs) kwargs = pycompat.byteskwargs(kwargs)
self.requirecap('getbundle', _('look up remote changes')) self.requirecap('getbundle', _('look up remote changes'))
opts = {} opts = {}
bundlecaps = kwargs.get('bundlecaps') or set() bundlecaps = kwargs.get('bundlecaps') or set()
for key, value in kwargs.iteritems(): for key, value in kwargs.iteritems():
if value is None: if value is None:
continue continue
keytype = gboptsmap.get(key) keytype = wireprototypes.GETBUNDLE_ARGUMENTS.get(key)
if keytype is None: if keytype is None:
raise error.ProgrammingError( raise error.ProgrammingError(
'Unexpectedly None keytype for key %s' % key) 'Unexpectedly None keytype for key %s' % key)
elif keytype == 'nodes': elif keytype == 'nodes':
value = wireprototypes.encodelist(value) value = wireprototypes.encodelist(value)
elif keytype == 'csv': elif keytype == 'csv':
value = ','.join(value) value = ','.join(value)
elif keytype == 'scsv': elif keytype == 'scsv':
except IOError: except IOError:
repo.ui.debug('pullbundle "%s" not accessible\n' % path) repo.ui.debug('pullbundle "%s" not accessible\n' % path)
continue continue
return None return None
@wireprotocommand('getbundle', '*', permission='pull', @wireprotocommand('getbundle', '*', permission='pull',
transportpolicy=POLICY_V1_ONLY) transportpolicy=POLICY_V1_ONLY)
def getbundle(repo, proto, others): def getbundle(repo, proto, others):
opts = options('getbundle', gboptsmap.keys(), others) opts = options('getbundle', wireprototypes.GETBUNDLE_ARGUMENTS.keys(),
others)
for k, v in opts.iteritems(): for k, v in opts.iteritems():
keytype = gboptsmap[k] keytype = wireprototypes.GETBUNDLE_ARGUMENTS[k]
if keytype == 'nodes': if keytype == 'nodes':
opts[k] = wireprototypes.decodelist(v) opts[k] = wireprototypes.decodelist(v)
elif keytype == 'csv': elif keytype == 'csv':
opts[k] = list(v.split(',')) opts[k] = list(v.split(','))
elif keytype == 'scsv': elif keytype == 'scsv':
opts[k] = set(v.split(',')) opts[k] = set(v.split(','))
elif keytype == 'boolean': elif keytype == 'boolean':
# Client should serialize False as '0', which is a non-empty string # Client should serialize False as '0', which is a non-empty string

mercurial/wireprototypes.py

def unescapebatcharg(escaped): def unescapebatcharg(escaped):
return (escaped return (escaped
.replace(':e', '=') .replace(':e', '=')
.replace(':s', ';') .replace(':s', ';')
.replace(':o', ',') .replace(':o', ',')
.replace(':c', ':')) .replace(':c', ':'))
# mapping of options accepted by getbundle and their types
#
# Meant to be extended by extensions. It is extensions responsibility to ensure
# such options are properly processed in exchange.getbundle.
#
# supported types are:
#
# :nodes: list of binary nodes
# :csv: list of comma-separated values
# :scsv: list of comma-separated values return as set
# :plain: string with no transformation needed.
GETBUNDLE_ARGUMENTS = {
'heads': 'nodes',
'bookmarks': 'boolean',
'common': 'nodes',
'obsmarkers': 'boolean',
'phases': 'boolean',
'bundlecaps': 'scsv',
'listkeys': 'csv',
'cg': 'boolean',
'cbattempted': 'boolean',
'stream': 'boolean',
}
class baseprotocolhandler(zi.Interface): class baseprotocolhandler(zi.Interface):
"""Abstract base class for wire protocol handlers. """Abstract base class for wire protocol handlers.
A wire protocol handler serves as an interface between protocol command A wire protocol handler serves as an interface between protocol command
handlers and the wire protocol transport layer. Protocol handlers provide handlers and the wire protocol transport layer. Protocol handlers provide
methods to read command arguments, redirect stdio for the duration of methods to read command arguments, redirect stdio for the duration of
the request, handle response types, etc. the request, handle response types, etc.
""" """