wireproto: correctly escape batched args and responses (issue4739) This issue appears to be as old as wireproto batching itself: I can reproduce the failure as far back as 08ef6b5f3715 trivially by rebasing the test changes in this patch, which was back in the 1.9 era. I didn't test before that change, because prior to that the testfile has a different name and I'm lazy. Note that the test thought it was checking this case, but it actually wasn't: it put a literal ; in the arg and response for its greet command, but the mangle/unmangle step defined in the test meant that instead of "Fo, =;o" going over the wire, "Gp-!><p" went instead, which doesn't contain any special characters (those being [.=;]) and thus not exercising the escaping. The test has been updated to use pre-unmangled special characters, so the request is now "Fo+<:o", which mangles to "Gp,=;p". I have confirmed that the test fails without the adjustment to the escaping rules in wireproto.py. No existing clients of RPC batching were depending on the old behavior in any way. The only *actual* users of batchable RPCs in core were: 1) largefiles, wherein it batches up many statlfile calls. It sends hexlified hashes over the wire and gets a 0, 1, or 2 back as a response. No risk of special characters. 2) setdiscovery, which was using heads() and known(), both of which communicate via hexlified nodes. Again, no risk of special characters. Since the escaping functionality has been completely broken since it was introduced, we know that it has no users. As such, we can change the escaping mechanism without having to worry about backwards compatibility issues. For the curious, this was detected by chance: it happens that the lz4-compressed text of a test file for remotefilelog compressed to something containing a ;, which then caused the failure when I moved remotefilelog to using batching for file content fetching.

     1

import os

     2

from mercurial import dispatch

     3

     4

def testdispatch(cmd):

     5

    """Simple wrapper around dispatch.dispatch()

     6

     7

    Prints command and result value, but does not handle quoting.

     8

    """

     9

    print "running: %s" % (cmd,)

    10

    req = dispatch.request(cmd.split())

    11

    result = dispatch.dispatch(req)

    12

    print "result: %r" % (result,)

    13

    14

    15

testdispatch("init test1")

    16

os.chdir('test1')

    17

    18

# create file 'foo', add and commit

    19

f = open('foo', 'wb')

    20

f.write('foo\n')

    21

f.close()

    22

testdispatch("add foo")

    23

testdispatch("commit -m commit1 -d 2000-01-01 foo")

    24

    25

# append to file 'foo' and commit

    26

f = open('foo', 'ab')

    27

f.write('bar\n')

    28

f.close()

    29

testdispatch("commit -m commit2 -d 2000-01-02 foo")

    30

    31

# check 88803a69b24 (fancyopts modified command table)

    32

testdispatch("log -r 0")

    33

testdispatch("log -r tip")