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

  $ hg init

     2

     3

  $ cat > .hg/hgrc <<EOF

     4

  > [extensions]

     5

  > prefixfilter = prefix.py

     6

  > [encode]

     7

  > *.txt = stripprefix: Copyright 2046, The Masters

     8

  > [decode]

     9

  > *.txt = insertprefix: Copyright 2046, The Masters

    10

  > EOF

    11

    12

  $ cat > prefix.py <<EOF

    13

  > from mercurial import util

    14

  > def stripprefix(s, cmd, filename, **kwargs):

    15

  >     header = '%s\n' % cmd

    16

  >     if s[:len(header)] != header:

    17

  >         raise util.Abort('missing header "%s" in %s' % (cmd, filename))

    18

  >     return s[len(header):]

    19

  > def insertprefix(s, cmd):

    20

  >     return '%s\n%s' % (cmd, s)

    21

  > def reposetup(ui, repo):

    22

  >     repo.adddatafilter('stripprefix:', stripprefix)

    23

  >     repo.adddatafilter('insertprefix:', insertprefix)

    24

  > EOF

    25

    26

  $ cat > .hgignore <<EOF

    27

  > .hgignore

    28

  > prefix.py

    29

  > prefix.pyc

    30

  > EOF

    31

    32

  $ cat > stuff.txt <<EOF

    33

  > Copyright 2046, The Masters

    34

  > Some stuff to ponder very carefully.

    35

  > EOF

    36

  $ hg add stuff.txt

    37

  $ hg ci -m stuff

    38

    39

Repository data:

    40

    41

  $ hg cat stuff.txt

    42

  Some stuff to ponder very carefully.

    43

    44

Fresh checkout:

    45

    46

  $ rm stuff.txt

    47

  $ hg up -C

    48

  1 files updated, 0 files merged, 0 files removed, 0 files unresolved

    49

  $ cat stuff.txt

    50

  Copyright 2046, The Masters

    51

  Some stuff to ponder very carefully.

    52

  $ echo "Very very carefully." >> stuff.txt

    53

  $ hg stat

    54

  M stuff.txt

    55

    56

  $ echo "Unauthorized material subject to destruction." > morestuff.txt

    57

    58

Problem encoding:

    59

    60

  $ hg add morestuff.txt

    61

  $ hg ci -m morestuff

    62

  abort: missing header "Copyright 2046, The Masters" in morestuff.txt

    63

  [255]

    64

  $ hg stat

    65

  M stuff.txt

    66

  A morestuff.txt