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

# Filter output by pyflakes to control which warnings we check

     4

     5

import sys, re, os

     6

     7

def makekey(typeandline):

     8

    """

     9

    for sorting lines by: msgtype, path/to/file, lineno, message

    10

    11

    typeandline is a sequence of a message type and the entire message line

    12

    the message line format is path/to/file:line: message

    13

    14

    >>> makekey((3, 'example.py:36: any message'))

    15

    (3, 'example.py', 36, ' any message')

    16

    >>> makekey((7, 'path/to/file.py:68: dummy message'))

    17

    (7, 'path/to/file.py', 68, ' dummy message')

    18

    >>> makekey((2, 'fn:88: m')) > makekey((2, 'fn:9: m'))

    19

    True

    20

    """

    21

    22

    msgtype, line = typeandline

    23

    fname, line, message = line.split(":", 2)

    24

    # line as int for ordering 9 before 88

    25

    return msgtype, fname, int(line), message

    26

    27

    28

lines = []

    29

for line in sys.stdin:

    30

    # We whitelist tests (see more messages in pyflakes.messages)

    31

    pats = [

    32

            (r"imported but unused", None),

    33

            (r"local variable '.*' is assigned to but never used", None),

    34

            (r"unable to detect undefined names", None),

    35

            (r"undefined name '.*'",

    36

             r"undefined name '(WindowsError|memoryview)'")

    37

           ]

    38

    39

    for msgtype, (pat, excl) in enumerate(pats):

    40

        if re.search(pat, line) and (not excl or not re.search(excl, line)):

    41

            break # pattern matches

    42

    else:

    43

        continue # no pattern matched, next line

    44

    fn = line.split(':', 1)[0]

    45

    f = open(os.path.join(os.path.dirname(os.path.dirname(__file__)), fn))

    46

    data = f.read()

    47

    f.close()

    48

    if 'no-' 'check-code' in data:

    49

        continue

    50

    lines.append((msgtype, line))

    51

    52

for msgtype, line in sorted(lines, key=makekey):

    53

    sys.stdout.write(line)

    54

print

    55

    56

# self test of "undefined name" detection for other than 'memoryview'

    57

if False:

    58

    print undefinedname