This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1925

exchange: return bundle info from getbundlechunks() (API)
ClosedPublic

Authored by indygreg on Jan 20 2018, 7:44 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGba15580e53d5: exchange: return bundle info from getbundlechunks() (API)
Summary

We generally want a mechanism to pass information about the
generated bundle back to callers (in addition to the byte stream).
Ideally we would return a bundler from this function and have the
caller code to an interface. But the bundling APIs are not great
and getbundlechunks() is the best API we have for obtaining bundle
contents in a unified manner.

We change getbundlechunks() to return a dict that we can use to
communicate metadata.

We populate that dict with the bundle version number to demonstrate
some value.

.. api::

exchange.getbundlechunks() now returns a 2-tuple instead of just
an iterator.

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.Jan 20 2018, 7:44 PM
lothiraldan added a subscriber: lothiraldan.Jan 22 2018, 11:01 AM

Just an idea, instead of changing the return API of getbundlechunks, would it be possible of returning a (newly introduced) bundlechunks object which is also an iterator and where we could store such info?

durin42 added a subscriber: durin42.Jan 22 2018, 3:03 PM
In D1925#32538, @lothiraldan wrote:

Just an idea, instead of changing the return API of getbundlechunks, would it be possible of returning a (newly introduced) bundlechunks object which is also an iterator and where we could store such info?

Not a bad idea, but that's an idea for when we're not scrambling to get an rc out the door.

durin42 accepted this revision.Jan 22 2018, 3:04 PM
This revision is now accepted and ready to land.Jan 22 2018, 3:04 PM
Closed by commit rHGba15580e53d5: exchange: return bundle info from getbundlechunks() (API) (authored by indygreg). · Explain WhyJan 22 2018, 3:07 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/exchange.py (12 lines)
Mmercurial/localrepo.py (2 lines)
Mmercurial/wireproto.py (4 lines)

Diff 4983

mercurial/exchange.py

def getbundlechunks(repo, source, heads=None, common=None, bundlecaps=None, def getbundlechunks(repo, source, heads=None, common=None, bundlecaps=None,
**kwargs): **kwargs):
"""Return chunks constituting a bundle's raw data. """Return chunks constituting a bundle's raw data.
Could be a bundle HG10 or a bundle HG20 depending on bundlecaps Could be a bundle HG10 or a bundle HG20 depending on bundlecaps
passed. passed.
Returns an iterator over raw chunks (of varying sizes). Returns a 2-tuple of a dict with metadata about the generated bundle
and an iterator over raw chunks (of varying sizes).
""" """
kwargs = pycompat.byteskwargs(kwargs) kwargs = pycompat.byteskwargs(kwargs)
info = {}
usebundle2 = bundle2requested(bundlecaps) usebundle2 = bundle2requested(bundlecaps)
# bundle10 case # bundle10 case
if not usebundle2: if not usebundle2:
if bundlecaps and not kwargs.get('cg', True): if bundlecaps and not kwargs.get('cg', True):
raise ValueError(_('request for bundle10 must include changegroup')) raise ValueError(_('request for bundle10 must include changegroup'))
if kwargs: if kwargs:
raise ValueError(_('unsupported getbundle arguments: %s') raise ValueError(_('unsupported getbundle arguments: %s')
% ', '.join(sorted(kwargs.keys()))) % ', '.join(sorted(kwargs.keys())))
outgoing = _computeoutgoing(repo, heads, common) outgoing = _computeoutgoing(repo, heads, common)
return changegroup.makestream(repo, outgoing, '01', source, info['bundleversion'] = 1
return info, changegroup.makestream(repo, outgoing, '01', source,
bundlecaps=bundlecaps) bundlecaps=bundlecaps)
# bundle20 case # bundle20 case
info['bundleversion'] = 2
b2caps = {} b2caps = {}
for bcaps in bundlecaps: for bcaps in bundlecaps:
if bcaps.startswith('bundle2='): if bcaps.startswith('bundle2='):
blob = urlreq.unquote(bcaps[len('bundle2='):]) blob = urlreq.unquote(bcaps[len('bundle2='):])
b2caps.update(bundle2.decodecaps(blob)) b2caps.update(bundle2.decodecaps(blob))
bundler = bundle2.bundle20(repo.ui, b2caps) bundler = bundle2.bundle20(repo.ui, b2caps)
kwargs['heads'] = heads kwargs['heads'] = heads
kwargs['common'] = common kwargs['common'] = common
for name in getbundle2partsorder: for name in getbundle2partsorder:
func = getbundle2partsmapping[name] func = getbundle2partsmapping[name]
func(bundler, repo, source, bundlecaps=bundlecaps, b2caps=b2caps, func(bundler, repo, source, bundlecaps=bundlecaps, b2caps=b2caps,
**pycompat.strkwargs(kwargs)) **pycompat.strkwargs(kwargs))
return bundler.getchunks() return info, bundler.getchunks()
@getbundle2partsgenerator('stream') @getbundle2partsgenerator('stream')
def _getbundlestream(bundler, repo, source, bundlecaps=None, def _getbundlestream(bundler, repo, source, bundlecaps=None,
b2caps=None, heads=None, common=None, **kwargs): b2caps=None, heads=None, common=None, **kwargs):
if not kwargs.get('stream', False): if not kwargs.get('stream', False):
return return
filecount, bytecount, it = streamclone.generatev2(repo) filecount, bytecount, it = streamclone.generatev2(repo)
requirements = ' '.join(sorted(repo.requirements)) requirements = ' '.join(sorted(repo.requirements))

mercurial/localrepo.py

def debugwireargs(self, one, two, three=None, four=None, five=None): def debugwireargs(self, one, two, three=None, four=None, five=None):
"""Used to test argument passing over the wire""" """Used to test argument passing over the wire"""
return "%s %s %s %s %s" % (one, two, three, four, five) return "%s %s %s %s %s" % (one, two, three, four, five)
def getbundle(self, source, heads=None, common=None, bundlecaps=None, def getbundle(self, source, heads=None, common=None, bundlecaps=None,
**kwargs): **kwargs):
chunks = exchange.getbundlechunks(self._repo, source, heads=heads, chunks = exchange.getbundlechunks(self._repo, source, heads=heads,
common=common, bundlecaps=bundlecaps, common=common, bundlecaps=bundlecaps,
**kwargs) **kwargs)[1]
cb = util.chunkbuffer(chunks) cb = util.chunkbuffer(chunks)
if exchange.bundle2requested(bundlecaps): if exchange.bundle2requested(bundlecaps):
# When requesting a bundle2, getbundle returns a stream to make the # When requesting a bundle2, getbundle returns a stream to make the
# wire level function happier. We need to build a proper object # wire level function happier. We need to build a proper object
# from it in local peer. # from it in local peer.
return bundle2.getunbundler(self.ui, cb) return bundle2.getunbundler(self.ui, cb)
else: else:

mercurial/wireproto.py

heads = set(opts.get('heads', set())) heads = set(opts.get('heads', set()))
common = set(opts.get('common', set())) common = set(opts.get('common', set()))
common.discard(nullid) common.discard(nullid)
if changegroup and not common and clheads == heads: if changegroup and not common and clheads == heads:
raise error.Abort( raise error.Abort(
_('server has pull-based clones disabled'), _('server has pull-based clones disabled'),
hint=_('remove --pull if specified or upgrade Mercurial')) hint=_('remove --pull if specified or upgrade Mercurial'))
chunks = exchange.getbundlechunks(repo, 'serve', info, chunks = exchange.getbundlechunks(repo, 'serve',
**pycompat.strkwargs(opts)) **pycompat.strkwargs(opts))
except error.Abort as exc: except error.Abort as exc:
# cleanly forward Abort error to the client # cleanly forward Abort error to the client
if not exchange.bundle2requested(opts.get('bundlecaps')): if not exchange.bundle2requested(opts.get('bundlecaps')):
if proto.name == 'http': if proto.name == 'http':
return ooberror(str(exc) + '\n') return ooberror(str(exc) + '\n')
raise # cannot do better for bundle1 + ssh raise # cannot do better for bundle1 + ssh
# bundle2 request expect a bundle2 reply # bundle2 request expect a bundle2 reply
bundler = bundle2.bundle20(repo.ui) bundler = bundle2.bundle20(repo.ui)