( )⚙ D318 wireproto: remove support for local results in @batchable (API)

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D318

wireproto: remove support for local results in @batchable (API)
ClosedPublic

Authored by indygreg on Aug 10 2017, 2:47 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGe2fc2122029c: wireproto: remove support for local results in @batchable (API)
Summary

@peer.batchable decorated generator functions have two forms:

yield value, None

and

yield args, future
yield value

These forms have been present since the decorator was introduced.

There are currently no in-repo consumers of the first form. So this
commit removes support for it.

Note that remoteiterbatcher.submit() asserts the 2nd form. And
b6e71f8af5b8 removed the last user of remotebatcher, forcing everyone
to remoteiterbatcher. So anything relying on this in the wild would
have been broken since b6e71f8af5b8.

.. api::

@peer.batchable can no longer emit local values

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Aug 10 2017, 2:47 AM
Closed by commit rHGe2fc2122029c: wireproto: remove support for local results in @batchable (API) (authored by indygreg). · Explain WhyAug 11 2017, 2:52 PM
This revision was automatically updated to reflect the committed changes.
yuja added a subscriber: yuja.Aug 13 2017, 2:31 AM
yuja added inline comments.
mercurial/peer.py
99

Perhaps this could be deleted too.

Revision Contents
Changeset List

Diff 733

mercurial/peer.py

def batchable(f): def batchable(f):
'''annotation for batchable methods '''annotation for batchable methods
Such methods must implement a coroutine as follows: Such methods must implement a coroutine as follows:
@batchable @batchable
def sample(self, one, two=None): def sample(self, one, two=None):
# Handle locally computable results first:
if not one:
yield "a local result", None
# Build list of encoded arguments suitable for your wire protocol: # Build list of encoded arguments suitable for your wire protocol:
encargs = [('one', encode(one),), ('two', encode(two),)] encargs = [('one', encode(one),), ('two', encode(two),)]
# Create future for injection of encoded result: # Create future for injection of encoded result:
encresref = future() encresref = future()
# Return encoded arguments and future: # Return encoded arguments and future:
yield encargs, encresref yield encargs, encresref
# Assuming the future to be filled with the result from the batched # Assuming the future to be filled with the result from the batched
# request now. Decode it: # request now. Decode it:
yield decode(encresref.value) yield decode(encresref.value)
The decorator returns a function which wraps this coroutine as a plain The decorator returns a function which wraps this coroutine as a plain
method, but adds the original method as an attribute called "batchable", method, but adds the original method as an attribute called "batchable",
which is used by remotebatch to split the call into separate encoding and which is used by remotebatch to split the call into separate encoding and
decoding phases. decoding phases.
''' '''
def plain(*args, **opts): def plain(*args, **opts):
batchable = f(*args, **opts) batchable = f(*args, **opts)
encargsorres, encresref = next(batchable) encargsorres, encresref = next(batchable)
if not encresref: if not encresref:
yujaUnsubmitted
Not Done

Perhaps this could be deleted too.

yuja: Perhaps this could be deleted too.
return encargsorres # a local result in this case return encargsorres # a local result in this case
self = args[0] self = args[0]
encresref.set(self._submitone(f.func_name, encargsorres)) encresref.set(self._submitone(f.func_name, encargsorres))
return next(batchable) return next(batchable)
setattr(plain, 'batchable', f) setattr(plain, 'batchable', f)
return plain return plain
class peerrepository(object): class peerrepository(object):

mercurial/wireproto.py

def submit(self): def submit(self):
req, rsp = [], [] req, rsp = [], []
for name, args, opts, resref in self.calls: for name, args, opts, resref in self.calls:
mtd = getattr(self.remote, name) mtd = getattr(self.remote, name)
batchablefn = getattr(mtd, 'batchable', None) batchablefn = getattr(mtd, 'batchable', None)
if batchablefn is not None: if batchablefn is not None:
batchable = batchablefn(mtd.im_self, *args, **opts) batchable = batchablefn(mtd.im_self, *args, **opts)
encargsorres, encresref = next(batchable) encargsorres, encresref = next(batchable)
if encresref: assert encresref
req.append((name, encargsorres,)) req.append((name, encargsorres,))
rsp.append((batchable, encresref, resref,)) rsp.append((batchable, encresref, resref,))
else: else:
resref.set(encargsorres)
else:
if req: if req:
self._submitreq(req, rsp) self._submitreq(req, rsp)
req, rsp = [], [] req, rsp = [], []
resref.set(mtd(*args, **opts)) resref.set(mtd(*args, **opts))
if req: if req:
self._submitreq(req, rsp) self._submitreq(req, rsp)
def _submitreq(self, req, rsp): def _submitreq(self, req, rsp):
encresults = self.remote._submitbatch(req) encresults = self.remote._submitbatch(req)

tests/test-batching.py

# Direct calls to proxied methods. They cause individual roundtrips. # Direct calls to proxied methods. They cause individual roundtrips.
print(it.foo("Un", two="Deux")) print(it.foo("Un", two="Deux"))
print(it.bar("Eins", "Zwei")) print(it.bar("Eins", "Zwei"))
# Batched call to a couple of (possibly proxied) methods. # Batched call to a couple of (possibly proxied) methods.
batch = it.batch() batch = it.batch()
# The calls return futures to eventually hold results. # The calls return futures to eventually hold results.
foo = batch.foo(one="One", two="Two") foo = batch.foo(one="One", two="Two")
foo2 = batch.foo(None)
bar = batch.bar("Eins", "Zwei") bar = batch.bar("Eins", "Zwei")
# We can call non-batchable proxy methods, but the break the current batch # We can call non-batchable proxy methods, but the break the current batch
# request and cause additional roundtrips. # request and cause additional roundtrips.
greet = batch.greet(name="John Smith") greet = batch.greet(name="John Smith")
# We can also add local methods into the mix, but they break the batch too. # We can also add local methods into the mix, but they break the batch too.
hello = batch.hello() hello = batch.hello()
bar2 = batch.bar(b="Uno", a="Due") bar2 = batch.bar(b="Uno", a="Due")
# Only now are all the calls executed in sequence, with as few roundtrips # Only now are all the calls executed in sequence, with as few roundtrips
# as possible. # as possible.
batch.submit() batch.submit()
# After the call to submit, the futures actually contain values. # After the call to submit, the futures actually contain values.
print(foo.value) print(foo.value)
print(foo2.value)
print(bar.value) print(bar.value)
print(greet.value) print(greet.value)
print(hello.value) print(hello.value)
print(bar2.value) print(bar2.value)
# local usage # local usage
mylocal = localthing() mylocal = localthing()
print() print()
res = self._submitone('batch', [('cmds', req,)]) res = self._submitone('batch', [('cmds', req,)])
return res.split(';') return res.split(';')
def batch(self): def batch(self):
return wireproto.remotebatch(self) return wireproto.remotebatch(self)
@peer.batchable @peer.batchable
def foo(self, one, two=None): def foo(self, one, two=None):
if not one:
yield "Nope", None
encargs = [('one', mangle(one),), ('two', mangle(two),)] encargs = [('one', mangle(one),), ('two', mangle(two),)]
encresref = peer.future() encresref = peer.future()
yield encargs, encresref yield encargs, encresref
yield unmangle(encresref.value) yield unmangle(encresref.value)
@peer.batchable @peer.batchable
def bar(self, b, a): def bar(self, b, a):
encresref = peer.future() encresref = peer.future()

tests/test-batching.py.out

== Local == Local
Ready. Ready.
Un and Deux Un and Deux
Eins und Zwei Eins und Zwei
One and Two One and Two
Nope
Eins und Zwei Eins und Zwei
Hello, John Smith Hello, John Smith
Ready. Ready.
Uno und Due Uno und Due
== Remote == Remote
Ready. Ready.
REQ: foo?one=Vo&two=Efvy REQ: foo?one=Vo&two=Efvy
-> Vo!boe!Efvy -> Vo!boe!Efvy
Un and Deux Un and Deux
REQ: bar?b=Fjot&a=[xfj REQ: bar?b=Fjot&a=[xfj
-> Fjot!voe![xfj -> Fjot!voe![xfj
Eins und Zwei Eins und Zwei
REQ: batch?cmds=foo:one=Pof,two=Uxp;bar:b=Fjot,a=[xfj REQ: batch?cmds=foo:one=Pof,two=Uxp;bar:b=Fjot,a=[xfj
-> Pof!boe!Uxp;Fjot!voe![xfj -> Pof!boe!Uxp;Fjot!voe![xfj
REQ: greet?name=Kpio!Tnjui REQ: greet?name=Kpio!Tnjui
-> Ifmmp-!Kpio!Tnjui -> Ifmmp-!Kpio!Tnjui
REQ: batch?cmds=bar:b=Vop,a=Evf REQ: batch?cmds=bar:b=Vop,a=Evf
-> Vop!voe!Evf -> Vop!voe!Evf
One and Two One and Two
Nope
Eins und Zwei Eins und Zwei
Hello, John Smith Hello, John Smith
Ready. Ready.
Uno und Due Uno und Due