wireprotov2: implement commands as a generator of objects Previously, wire protocol version 2 inherited version 1's model of having separate types to represent the results of different wire protocol commands. As I implemented more powerful commands in future commits, I found I was using a common pattern of returning a special type to hold a generator. This meant the command function required a closure to do most of the work. That made logic flow more difficult to follow. I also noticed that many commands were effectively a sequence of objects to be CBOR encoded. I think it makes sense to define version 2 commands as generators. This way, commands can simply emit the data structures they wish to send to the client. This eliminates the need for a closure in command functions and removes encoding from the bodies of commands. As part of this commit, the handling of response objects has been moved into the serverreactor class. This puts the reactor in the driver's seat with regards to CBOR encoding and error handling. Having error handling in the function that emits frames is particularly important because exceptions in that function can lead to things getting in a bad state: I'm fairly certain that uncaught exceptions in the frame generator were causing deadlocks. I also introduced a dedicated error type for explicit error reporting in command handlers. This will be used in subsequent commits. There's still a bit of work to be done here, especially around formalizing the error handling "protocol." I've added yet another TODO to track this so we don't forget. Test output changed because we're using generators and no longer know we are at the end of the data until we hit the end of the generator. This means we can't emit the end-of-stream flag until we've exhausted the generator. Hence the introduction of 0-sized end-of-stream frames. Differential Revision: https://phab.mercurial-scm.org/D4472

     1

HTTPV2=exp-http-v2-0001

     2

MEDIATYPE=application/mercurial-exp-framing-0005

     3

     4

sendhttpraw() {

     5

  hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/

     6

}

     7

     8

sendhttpv2peer() {

     9

  hg --verbose debugwireproto --nologhandshake --peer http2 http://$LOCALIP:$HGPORT/

    10

}

    11

    12

sendhttpv2peerhandshake() {

    13

  hg --verbose debugwireproto --peer http2 http://$LOCALIP:$HGPORT/

    14

}

    15

    16

cat > dummycommands.py << EOF

    17

from mercurial import (

    18

    wireprototypes,

    19

    wireprotov1server,

    20

    wireprotov2server,

    21

)

    22

    23

@wireprotov1server.wireprotocommand(b'customreadonly', permission=b'pull')

    24

def customreadonlyv1(repo, proto):

    25

    return wireprototypes.bytesresponse(b'customreadonly bytes response')

    26

    27

@wireprotov2server.wireprotocommand(b'customreadonly', permission=b'pull')

    28

def customreadonlyv2(repo, proto):

    29

    yield b'customreadonly bytes response'

    30

    31

@wireprotov1server.wireprotocommand(b'customreadwrite', permission=b'push')

    32

def customreadwrite(repo, proto):

    33

    return wireprototypes.bytesresponse(b'customreadwrite bytes response')

    34

    35

@wireprotov2server.wireprotocommand(b'customreadwrite', permission=b'push')

    36

def customreadwritev2(repo, proto):

    37

    yield b'customreadwrite bytes response'

    38

EOF

    39

    40

cat >> $HGRCPATH << EOF

    41

[extensions]

    42

drawdag = $TESTDIR/drawdag.py

    43

EOF

    44

    45

enabledummycommands() {

    46

  cat >> $HGRCPATH << EOF

    47

[extensions]

    48

dummycommands = $TESTTMP/dummycommands.py

    49

EOF

    50

}

    51

    52

enablehttpv2() {

    53

  cat >> $1/.hg/hgrc << EOF

    54

[experimental]

    55

web.apiserver = true

    56

web.api.http-v2 = true

    57

EOF

    58

}