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

#!/usr/bin/env python

     2

     3

"""

     4

Small and dumb HTTP server for use in tests.

     5

"""

     6

     7

from optparse import OptionParser

     8

import BaseHTTPServer, SimpleHTTPServer, signal, sys

     9

    10

from mercurial import cmdutil

    11

    12

class simplehttpservice(object):

    13

    def __init__(self, host, port):

    14

        self.address = (host, port)

    15

    def init(self):

    16

        self.httpd = BaseHTTPServer.HTTPServer(

    17

            self.address, SimpleHTTPServer.SimpleHTTPRequestHandler)

    18

    def run(self):

    19

        self.httpd.serve_forever()

    20

    21

if __name__ == '__main__':

    22

    parser = OptionParser()

    23

    parser.add_option('-p', '--port', dest='port', type='int', default=8000,

    24

        help='TCP port to listen on', metavar='PORT')

    25

    parser.add_option('-H', '--host', dest='host', default='localhost',

    26

        help='hostname or IP to listen on', metavar='HOST')

    27

    parser.add_option('--pid', dest='pid',

    28

        help='file name where the PID of the server is stored')

    29

    parser.add_option('-f', '--foreground', dest='foreground',

    30

        action='store_true',

    31

        help='do not start the HTTP server in the background')

    32

    parser.add_option('--daemon-pipefds')

    33

    34

    (options, args) = parser.parse_args()

    35

    36

    signal.signal(signal.SIGTERM, lambda x, y: sys.exit(0))

    37

    38

    if options.foreground and options.pid:

    39

        parser.error("options --pid and --foreground are mutually exclusive")

    40

    41

    opts = {'pid_file': options.pid,

    42

            'daemon': not options.foreground,

    43

            'daemon_pipefds': options.daemon_pipefds}

    44

    service = simplehttpservice(options.host, options.port)

    45

    cmdutil.service(opts, initfn=service.init, runfn=service.run,

    46

                    runargs=[sys.executable, __file__] + sys.argv[1:])