This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2851

wireproto: define and implement protocol for issuing requests
ClosedPublic

Authored by indygreg on Mar 13 2018, 10:49 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG40206e227412: wireproto: define and implement protocol for issuing requests
Summary

The existing HTTP and SSH wire protocols suffer from a host of flaws
and shortcomings. I've been wanting to rewrite the protocol for a while
now. Supporting partial clone - which will require new wire protocol
commands and capabilities - and other advanced server functionality
will be much easier if we start from a clean slate and don't have
to be constrained by limitations of the existing wire protocol.

This commit starts to introduce a new data exchange format for
use over the wire protocol.

The new protocol is built on top of "frames," which are atomic
units of metadata + data. Frames will make it easier to implement
proxies and other mechanisms that want to inspect data without
having to maintain state. The existing frame metadata is very
minimal and it will evolve heavily. (We will eventually support
things like concurrent requests, out-of-order responses,
compression, side-channels for status updates, etc. Some of
these will require additions to the frame header.)

Another benefit of frames is that all reads are of a fixed size.
A reader works by consuming a frame header, extracting the payload
length, then reading that many bytes. No lookahead, buffering, or
memory reallocations are needed.

The new protocol attempts to be transport agnostic. I want all that's
required to use the new protocol to be a pair of unidirectional,
half-duplex pipes. (Yes, we will eventually make use of full-duplex
pipes, but that's for another commit.) Notably, when the SSH
transport switches to this new protocol, stderr will be unused.
This is by design: the lack of stderr on HTTP harms protocol
behavior there. By shoehorning everything into a pair of pipes,
we can have more consistent behavior across transports.

We currently only define the client side parts of the new protocol,
specifically the bits for requesting that a command run. This keeps
the new code and feature small and somewhat easy to review.

We add support to hg debugwireproto for writing frames into
HTTP request bodies. Our tests that issue commands to the new
HTTP endpoint have been updated to transmit frames. The server
bits haven't been touched to consume the frames yet. This will
occur in the next commit...

Astute readers may notice that the command name is transmitted in
both the HTTP request URL and the command request frame. This is
partially a kludge from me initially implementing the frame-based
protocol for SSH first. But it is also a feature: I intend to
eventually support issuing multiple commands per HTTP request. This
will allow us to replace the abomination that is the "batch" wire
protocol command with a protocol-level mechanism for performing
multi-dispatch. Because I want the frame-based protocol to be
as similar as possible across transports, I'd rather we (redundantly)
include the command name in the frame than differ behavior between
transports that have out-of-band routing information (like HTTP)
readily available.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Mar 13 2018, 10:49 PM
indygreg planned changes to this revision.Mar 14 2018, 3:20 PM
indygreg added inline comments.
mercurial/wireprotoframing.py
100–101

We don't increment offset here. I have a fix for this locally. Will upload once I know someone starts looking at these commits, as I don't want to cause too much spam via resends.

indygreg updated this revision to Diff 7047.Mar 14 2018, 9:10 PM
indygreg updated this revision to Diff 7139.Mar 19 2018, 7:59 PM
durin42 accepted this revision.Mar 21 2018, 3:18 PM
This revision is now accepted and ready to land.Mar 21 2018, 3:18 PM
indygreg updated this revision to Diff 7199.Mar 21 2018, 6:19 PM
durin42 accepted this revision.Mar 21 2018, 6:22 PM
Closed by commit rHG40206e227412: wireproto: define and implement protocol for issuing requests (authored by indygreg). · Explain WhyMar 21 2018, 8:58 PM
This revision was automatically updated to reflect the committed changes.
yuja added a subscriber: yuja.Mar 24 2018, 10:13 AM
yuja added inline comments.
mercurial/help/internals/wireprotocol.txt
486

Nit: The order of Type and Flags seems a bit confusing. I read it as
flags << 4 | type since this is a little-endian (so naturally LSB-first) protocol.

Revision Contents
Changeset List

Diff 7227

mercurial/debugcommands.py

sslutil, sslutil,
streamclone, streamclone,
templater, templater,
treediscovery, treediscovery,
upgrade, upgrade,
url as urlmod, url as urlmod,
util, util,
vfs as vfsmod, vfs as vfsmod,
wireprotoframing,
wireprotoserver, wireprotoserver,
) )
from .utils import dateutil from .utils import dateutil
release = lockmod.release release = lockmod.release
command = registrar.command() command = registrar.command()
headers to add to the request. e.g. ``Accept: foo``. headers to add to the request. e.g. ``Accept: foo``.
The following arguments are special: The following arguments are special:
``BODYFILE`` ``BODYFILE``
The content of the file defined as the value to this argument will be The content of the file defined as the value to this argument will be
transferred verbatim as the HTTP request body. transferred verbatim as the HTTP request body.
``frame <type> <flags> <payload>``
Send a unified protocol frame as part of the request body.
All frames will be collected and sent as the body to the HTTP
request.
close close
----- -----
Close the connection to the server. Close the connection to the server.
flush flush
----- -----
-------- --------
``read()`` N bytes from the server's main output pipe. ``read()`` N bytes from the server's main output pipe.
eread <X> eread <X>
--------- ---------
``read()`` N bytes from the server's stderr pipe, if available. ``read()`` N bytes from the server's stderr pipe, if available.
Specifying Unified Frame-Based Protocol Frames
----------------------------------------------
It is possible to emit a *Unified Frame-Based Protocol* by using special
syntax.
A frame is composed as a type, flags, and payload. These can be parsed
from a string of the form ``<type> <flags> <payload>``. That is, 3
space-delimited strings.
``payload`` is the simplest: it is evaluated as a Python byte string
literal.
``type`` can be an integer value for the frame type or the string name
of the type. The strings are defined in ``wireprotoframing.py``. e.g.
``command-name``.
``flags`` is a ``|`` delimited list of flag components. Each component
(and there can be just one) can be an integer or a flag name for the
specified frame type. Values are resolved to integers and then bitwise
OR'd together.
""" """
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
if opts['localssh'] and not repo: if opts['localssh'] and not repo:
raise error.Abort(_('--localssh requires a repository')) raise error.Abort(_('--localssh requires a repository'))
if opts['peer'] and opts['peer'] not in ('raw', 'ssh1', 'ssh2'): if opts['peer'] and opts['peer'] not in ('raw', 'ssh1', 'ssh2'):
raise error.Abort(_('invalid value for --peer'), raise error.Abort(_('invalid value for --peer'),
request = action.split(' ', 2) request = action.split(' ', 2)
if len(request) != 3: if len(request) != 3:
raise error.Abort(_('invalid httprequest: expected format is ' raise error.Abort(_('invalid httprequest: expected format is '
'"httprequest <method> <path>')) '"httprequest <method> <path>'))
method, httppath = request[1:] method, httppath = request[1:]
headers = {} headers = {}
body = None body = None
frames = []
for line in lines: for line in lines:
line = line.lstrip() line = line.lstrip()
m = re.match(b'^([a-zA-Z0-9_-]+): (.*)$', line) m = re.match(b'^([a-zA-Z0-9_-]+): (.*)$', line)
if m: if m:
headers[m.group(1)] = m.group(2) headers[m.group(1)] = m.group(2)
continue continue
if line.startswith(b'BODYFILE '): if line.startswith(b'BODYFILE '):
with open(line.split(b' ', 1), 'rb') as fh: with open(line.split(b' ', 1), 'rb') as fh:
body = fh.read() body = fh.read()
elif line.startswith(b'frame '):
frame = wireprotoframing.makeframefromhumanstring(
line[len(b'frame '):])
frames.append(frame)
else: else:
raise error.Abort(_('unknown argument to httprequest: %s') % raise error.Abort(_('unknown argument to httprequest: %s') %
line) line)
url = path + httppath url = path + httppath
if frames:
body = b''.join(bytes(f) for f in frames)
req = urlmod.urlreq.request(pycompat.strurl(url), body, headers) req = urlmod.urlreq.request(pycompat.strurl(url), body, headers)
# urllib.Request insists on using has_data() as a proxy for # urllib.Request insists on using has_data() as a proxy for
# determining the request method. Override that to use our # determining the request method. Override that to use our
# explicitly requested method. # explicitly requested method.
req.get_method = lambda: method req.get_method = lambda: method
try: try:

mercurial/help/internals/wireprotocol.txt

authentication requirements are discovered upon attempting the first authentication requirements are discovered upon attempting the first
command - not potentially several commands into the exchange. This command - not potentially several commands into the exchange. This
allows clients to fail faster or prompt for credentials as soon as the allows clients to fail faster or prompt for credentials as soon as the
exchange takes place. This provides a better end-user experience. exchange takes place. This provides a better end-user experience.
Requests to unknown commands or URLS result in an HTTP 404. Requests to unknown commands or URLS result in an HTTP 404.
TODO formally define response type, how error is communicated, etc. TODO formally define response type, how error is communicated, etc.
HTTP request and response bodies use the *TBD Protocol* for media exchange. HTTP request and response bodies use the *Unified Frame-Based Protocol*
(defined below) for media exchange. The entirety of the HTTP message
body is 0 or more frames as defined by this protocol.
Clients and servers MUST advertise the ``TBD`` media type via the Clients and servers MUST advertise the ``TBD`` media type via the
``Content-Type`` request and response headers. In addition, clients MUST ``Content-Type`` request and response headers. In addition, clients MUST
advertise this media type value in their ``Accept`` request header in all advertise this media type value in their ``Accept`` request header in all
requests. requests.
TODO finalize the media type. For now, it is defined in wireprotoserver.py.
Servers receiving requests without an ``Accept`` header SHOULD respond with Servers receiving requests without an ``Accept`` header SHOULD respond with
an HTTP 406. an HTTP 406.
Servers receiving requests with an invalid ``Content-Type`` header SHOULD Servers receiving requests with an invalid ``Content-Type`` header SHOULD
respond with an HTTP 415. respond with an HTTP 415.
SSH Protocol SSH Protocol
If the server receives an unknown command, it will send an empty ``string`` If the server receives an unknown command, it will send an empty ``string``
response. response.
The server terminates if it receives an empty command (a ``\n`` character). The server terminates if it receives an empty command (a ``\n`` character).
SSH Version 2 Transport SSH Version 2 Transport
----------------------- -----------------------
**Experimental** **Experimental and under development**
Version 2 of the SSH transport behaves identically to version 1 of the SSH Version 2 of the SSH transport behaves identically to version 1 of the SSH
transport with the exception of handshake semantics. See above for how transport with the exception of handshake semantics. See above for how
version 2 of the SSH transport is negotiated. version 2 of the SSH transport is negotiated.
Immediately following the ``upgraded`` line signaling a switch to version Immediately following the ``upgraded`` line signaling a switch to version
2 of the SSH protocol, the server automatically sends additional details 2 of the SSH protocol, the server automatically sends additional details
about the capabilities of the remote server. This has the form: about the capabilities of the remote server. This has the form:
<integer length of value>\n <integer length of value>\n
capabilities: ...\n capabilities: ...\n
e.g. e.g.
s: upgraded 2e82ab3f-9ce3-4b4e-8f8c-6fd1c0e9e23a ssh-v2\n s: upgraded 2e82ab3f-9ce3-4b4e-8f8c-6fd1c0e9e23a ssh-v2\n
s: 240\n s: 240\n
s: capabilities: known getbundle batch ...\n s: capabilities: known getbundle batch ...\n
Following capabilities advertisement, the peers communicate using version Following capabilities advertisement, the peers communicate using version
1 of the SSH transport. 1 of the SSH transport.
Unified Frame-Based Protocol
============================
**Experimental and under development**
The *Unified Frame-Based Protocol* is a communications protocol between
Mercurial peers. The protocol aims to be mostly transport agnostic
(works similarly on HTTP, SSH, etc).
To operate the protocol, a bi-directional, half-duplex pipe supporting
ordered sends and receives is required. That is, each peer has one pipe
for sending data and another for receiving.
The protocol is request-response based: the client issues requests to
the server, which issues replies to those requests. Server-initiated
messaging is not supported.
All data is read and written in atomic units called *frames*. These
are conceptually similar to TCP packets. Higher-level functionality
is built on the exchange and processing of frames.
Frames begin with a 4 octet header followed by a variable length
payload::
+-----------------------------------------------+
| Length (24) |
+-----------+-----------------------------------+
| Type (4) |
+-----------+
| Flags (4) |
yujaUnsubmitted
Not Done

Nit: The order of Type and Flags seems a bit confusing. I read it as
flags << 4 | type since this is a little-endian (so naturally LSB-first) protocol.

yuja: Nit: The order of Type and Flags seems a bit confusing. I read it as `flags << 4 | type` since…
+===========+===================================================|
| Frame Payload (0...) ...
+---------------------------------------------------------------+
The length of the frame payload is expressed as an unsigned 24 bit
little endian integer. Values larger than 65535 MUST NOT be used unless
given permission by the server as part of the negotiated capabilities
during the handshake. The frame header is not part of the advertised
frame length.
The 4-bit ``Type`` field denotes the type of message being sent.
The 4-bit ``Flags`` field defines special, per-type attributes for
the frame.
The sections below define the frame types and their behavior.
Command Request (``0x01``)
--------------------------
This frame contains a request to run a command.
The name of the command to run constitutes the entirety of the frame
payload.
This frame type MUST ONLY be sent from clients to servers: it is illegal
for a server to send this frame to a client.
The following flag values are defined for this type:
0x01
End of command data. When set, the client will not send any command
arguments or additional command data. When set, the command has been
fully issued and the server has the full context to process the command.
The next frame issued by the client is not part of this command.
0x02
Command argument frames expected. When set, the client will send
*Command Argument* frames containing command argument data.
0x04
Command data frames expected. When set, the client will send
*Command Data* frames containing a raw stream of data for this
command.
The ``0x01`` flag is mutually exclusive with both the ``0x02`` and ``0x04``
flags.
Command Argument (``0x02``)
---------------------------
This frame contains a named argument for a command.
The frame type MUST ONLY be sent from clients to servers: it is illegal
for a server to send this frame to a client.
The payload consists of:
* A 16-bit little endian integer denoting the length of the
argument name.
* A 16-bit little endian integer denoting the length of the
argument value.
* N bytes of ASCII data containing the argument name.
* N bytes of binary data containing the argument value.
The payload MUST hold the entirety of the 32-bit header and the
argument name. The argument value MAY span multiple frames. If this
occurs, the appropriate frame flag should be set to indicate this.
The following flag values are defined for this type:
0x01
Argument data continuation. When set, the data for this argument did
not fit in a single frame and the next frame will contain additional
argument data.
0x02
End of arguments data. When set, the client will not send any more
command arguments for the command this frame is associated with.
The next frame issued by the client will be command data or
belong to a separate request.
Command Data (``0x03``)
-----------------------
This frame contains raw data for a command.
Most commands can be executed by specifying arguments. However,
arguments have an upper bound to their length. For commands that
accept data that is beyond this length or whose length isn't known
when the command is initially sent, they will need to stream
arbitrary data to the server. This frame type facilitates the sending
of this data.
The payload of this frame type consists of a stream of raw data to be
consumed by the command handler on the server. The format of the data
is command specific.
The following flag values are defined for this type:
0x01
Command data continuation. When set, the data for this command
continues into a subsequent frame.
0x02
End of data. When set, command data has been fully sent to the
server. The command has been fully issued and no new data for this
command will be sent. The next frame will belong to a new command.
Issuing Commands
----------------
A client can request that a remote run a command by sending it
frames defining that command. This logical stream is composed of
1 ``Command Request`` frame, 0 or more ``Command Argument`` frames,
and 0 or more ``Command Data`` frames.
Argument frames are the recommended mechanism for transferring fixed
sets of parameters to a command. Data frames are appropriate for
transferring variable data. A similar comparison would be to HTTP:
argument frames are headers and the message body is data frames.
It is recommended for servers to delay the dispatch of a command
until all argument frames for that command have been received. Servers
MAY impose limits on the maximum argument size.
TODO define failure mechanism.
Servers MAY dispatch to commands immediately once argument data
is available or delay until command data is received in full.
Capabilities Capabilities
============ ============
Servers advertise supported wire protocol features. This allows clients to Servers advertise supported wire protocol features. This allows clients to
probe for server features before blindly calling a command or passing a probe for server features before blindly calling a command or passing a
specific argument. specific argument.
The server's features are exposed via a *capabilities* string. This is a The server's features are exposed via a *capabilities* string. This is a

mercurial/wireprotoframing.py

  • This file was added.
# wireprotoframing.py - unified framing protocol for wire protocol
#
# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
# This file contains functionality to support the unified frame-based wire
# protocol. For details about the protocol, see
# `hg help internals.wireprotocol`.
from __future__ import absolute_import
import struct
from . import (
util,
)
FRAME_HEADER_SIZE = 4
DEFAULT_MAX_FRAME_SIZE = 32768
FRAME_TYPE_COMMAND_NAME = 0x01
FRAME_TYPE_COMMAND_ARGUMENT = 0x02
FRAME_TYPE_COMMAND_DATA = 0x03
FRAME_TYPES = {
b'command-name': FRAME_TYPE_COMMAND_NAME,
b'command-argument': FRAME_TYPE_COMMAND_ARGUMENT,
b'command-data': FRAME_TYPE_COMMAND_DATA,
}
FLAG_COMMAND_NAME_EOS = 0x01
FLAG_COMMAND_NAME_HAVE_ARGS = 0x02
FLAG_COMMAND_NAME_HAVE_DATA = 0x04
FLAGS_COMMAND = {
b'eos': FLAG_COMMAND_NAME_EOS,
b'have-args': FLAG_COMMAND_NAME_HAVE_ARGS,
b'have-data': FLAG_COMMAND_NAME_HAVE_DATA,
}
FLAG_COMMAND_ARGUMENT_CONTINUATION = 0x01
FLAG_COMMAND_ARGUMENT_EOA = 0x02
FLAGS_COMMAND_ARGUMENT = {
b'continuation': FLAG_COMMAND_ARGUMENT_CONTINUATION,
b'eoa': FLAG_COMMAND_ARGUMENT_EOA,
}
FLAG_COMMAND_DATA_CONTINUATION = 0x01
FLAG_COMMAND_DATA_EOS = 0x02
FLAGS_COMMAND_DATA = {
b'continuation': FLAG_COMMAND_DATA_CONTINUATION,
b'eos': FLAG_COMMAND_DATA_EOS,
}
# Maps frame types to their available flags.
FRAME_TYPE_FLAGS = {
FRAME_TYPE_COMMAND_NAME: FLAGS_COMMAND,
FRAME_TYPE_COMMAND_ARGUMENT: FLAGS_COMMAND_ARGUMENT,
FRAME_TYPE_COMMAND_DATA: FLAGS_COMMAND_DATA,
}
ARGUMENT_FRAME_HEADER = struct.Struct(r'<HH')
def makeframe(frametype, frameflags, payload):
"""Assemble a frame into a byte array."""
# TODO assert size of payload.
frame = bytearray(FRAME_HEADER_SIZE + len(payload))
l = struct.pack(r'<I', len(payload))
frame[0:3] = l[0:3]
frame[3] = (frametype << 4) | frameflags
frame[4:] = payload
return frame
def makeframefromhumanstring(s):
"""Given a string of the form: <type> <flags> <payload>, creates a frame.
This can be used by user-facing applications and tests for creating
frames easily without having to type out a bunch of constants.
Frame type and flags can be specified by integer or named constant.
Flags can be delimited by `|` to bitwise OR them together.
"""
frametype, frameflags, payload = s.split(b' ', 2)
if frametype in FRAME_TYPES:
frametype = FRAME_TYPES[frametype]
else:
frametype = int(frametype)
finalflags = 0
validflags = FRAME_TYPE_FLAGS[frametype]
for flag in frameflags.split(b'|'):
if flag in validflags:
finalflags |= validflags[flag]
else:
indygregAuthorUnsubmitted
Not Done

We don't increment offset here. I have a fix for this locally. Will upload once I know someone starts looking at these commits, as I don't want to cause too much spam via resends.

indygreg: We don't increment offset here. I have a fix for this locally. Will upload once I know someone…
finalflags |= int(flag)
payload = util.unescapestr(payload)
return makeframe(frametype, finalflags, payload)
def createcommandframes(cmd, args, datafh=None):
"""Create frames necessary to transmit a request to run a command.
This is a generator of bytearrays. Each item represents a frame
ready to be sent over the wire to a peer.
"""
flags = 0
if args:
flags |= FLAG_COMMAND_NAME_HAVE_ARGS
if datafh:
flags |= FLAG_COMMAND_NAME_HAVE_DATA
if not flags:
flags |= FLAG_COMMAND_NAME_EOS
yield makeframe(FRAME_TYPE_COMMAND_NAME, flags, cmd)
for i, k in enumerate(sorted(args)):
v = args[k]
last = i == len(args) - 1
# TODO handle splitting of argument values across frames.
payload = bytearray(ARGUMENT_FRAME_HEADER.size + len(k) + len(v))
offset = 0
ARGUMENT_FRAME_HEADER.pack_into(payload, offset, len(k), len(v))
offset += ARGUMENT_FRAME_HEADER.size
payload[offset:offset + len(k)] = k
offset += len(k)
payload[offset:offset + len(v)] = v
flags = FLAG_COMMAND_ARGUMENT_EOA if last else 0
yield makeframe(FRAME_TYPE_COMMAND_ARGUMENT, flags, payload)
if datafh:
while True:
data = datafh.read(DEFAULT_MAX_FRAME_SIZE)
done = False
if len(data) == DEFAULT_MAX_FRAME_SIZE:
flags = FLAG_COMMAND_DATA_CONTINUATION
else:
flags = FLAG_COMMAND_DATA_EOS
assert datafh.read(1) == b''
done = True
yield makeframe(FRAME_TYPE_COMMAND_DATA, flags, data)
if done:
break

mercurial/wireprotoserver.py

urlerr = util.urlerr urlerr = util.urlerr
urlreq = util.urlreq urlreq = util.urlreq
HTTP_OK = 200 HTTP_OK = 200
HGTYPE = 'application/mercurial-0.1' HGTYPE = 'application/mercurial-0.1'
HGTYPE2 = 'application/mercurial-0.2' HGTYPE2 = 'application/mercurial-0.2'
HGERRTYPE = 'application/hg-error' HGERRTYPE = 'application/hg-error'
HTTPV2TYPE = 'application/mercurial-tbd' FRAMINGTYPE = b'application/mercurial-exp-framing-0001'
HTTPV2 = wireprototypes.HTTPV2 HTTPV2 = wireprototypes.HTTPV2
SSHV1 = wireprototypes.SSHV1 SSHV1 = wireprototypes.SSHV1
SSHV2 = wireprototypes.SSHV2 SSHV2 = wireprototypes.SSHV2
def decodevaluefromheaders(req, headerprefix): def decodevaluefromheaders(req, headerprefix):
"""Decode a long value from multiple HTTP request headers. """Decode a long value from multiple HTTP request headers.
proto = httpv2protocolhandler(req, ui) proto = httpv2protocolhandler(req, ui)
if not wireproto.commands.commandavailable(command, proto): if not wireproto.commands.commandavailable(command, proto):
res.status = b'404 Not Found' res.status = b'404 Not Found'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('invalid wire protocol command: %s') % command) res.setbodybytes(_('invalid wire protocol command: %s') % command)
return return
if req.headers.get(b'Accept') != HTTPV2TYPE: if req.headers.get(b'Accept') != FRAMINGTYPE:
res.status = b'406 Not Acceptable' res.status = b'406 Not Acceptable'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('client MUST specify Accept header with value: %s\n') res.setbodybytes(_('client MUST specify Accept header with value: %s\n')
% HTTPV2TYPE) % FRAMINGTYPE)
return return
if (b'Content-Type' in req.headers if (b'Content-Type' in req.headers
and req.headers[b'Content-Type'] != HTTPV2TYPE): and req.headers[b'Content-Type'] != FRAMINGTYPE):
res.status = b'415 Unsupported Media Type' res.status = b'415 Unsupported Media Type'
# TODO we should send a response with appropriate media type, # TODO we should send a response with appropriate media type,
# since client does Accept it. # since client does Accept it.
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('client MUST send Content-Type header with ' res.setbodybytes(_('client MUST send Content-Type header with '
'value: %s\n') % HTTPV2TYPE) 'value: %s\n') % FRAMINGTYPE)
return return
# We don't do anything meaningful yet. # We don't do anything meaningful yet.
res.status = b'200 OK' res.status = b'200 OK'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(b'/'.join(urlparts) + b'\n') res.setbodybytes(b'/'.join(urlparts) + b'\n')
# Maps API name to metadata so custom API can be registered. # Maps API name to metadata so custom API can be registered.

tests/test-http-api-httpv2.t

$ HTTPV2=exp-http-v2-0001 $ HTTPV2=exp-http-v2-0001
$ MEDIATYPE=application/mercurial-tbd $ MEDIATYPE=application/mercurial-exp-framing-0001
$ send() { $ send() {
> hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/ > hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/
> } > }
$ cat > dummycommands.py << EOF $ cat > dummycommands.py << EOF
> from mercurial import wireprototypes, wireproto > from mercurial import wireprototypes, wireproto
> @wireproto.wireprotocommand('customreadonly', permission='pull') > @wireproto.wireprotocommand('customreadonly', permission='pull')
s> user-agent: test\r\n s> user-agent: test\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 406 Not Acceptable\r\n s> HTTP/1.1 406 Not Acceptable\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 72\r\n s> Content-Length: 85\r\n
s> \r\n s> \r\n
s> client MUST specify Accept header with value: application/mercurial-tbd\n s> client MUST specify Accept header with value: application/mercurial-exp-framing-0001\n
Bad Accept header results in 406 Bad Accept header results in 406
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/ro/customreadonly > httprequest POST api/$HTTPV2/ro/customreadonly
> accept: invalid > accept: invalid
> user-agent: test > user-agent: test
> EOF > EOF
using raw connection to peer using raw connection to peer
s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n s> Accept-Encoding: identity\r\n
s> accept: invalid\r\n s> accept: invalid\r\n
s> user-agent: test\r\n s> user-agent: test\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 406 Not Acceptable\r\n s> HTTP/1.1 406 Not Acceptable\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 72\r\n s> Content-Length: 85\r\n
s> \r\n s> \r\n
s> client MUST specify Accept header with value: application/mercurial-tbd\n s> client MUST specify Accept header with value: application/mercurial-exp-framing-0001\n
Bad Content-Type header results in 415 Bad Content-Type header results in 415
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/ro/customreadonly > httprequest POST api/$HTTPV2/ro/customreadonly
> accept: $MEDIATYPE > accept: $MEDIATYPE
> user-agent: test > user-agent: test
> content-type: badmedia > content-type: badmedia
> EOF > EOF
using raw connection to peer using raw connection to peer
s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n s> Accept-Encoding: identity\r\n
s> accept: application/mercurial-tbd\r\n s> accept: application/mercurial-exp-framing-0001\r\n
s> content-type: badmedia\r\n s> content-type: badmedia\r\n
s> user-agent: test\r\n s> user-agent: test\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 415 Unsupported Media Type\r\n s> HTTP/1.1 415 Unsupported Media Type\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 75\r\n s> Content-Length: 88\r\n
s> \r\n s> \r\n
s> client MUST send Content-Type header with value: application/mercurial-tbd\n s> client MUST send Content-Type header with value: application/mercurial-exp-framing-0001\n
Request to read-only command works out of the box Request to read-only command works out of the box
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/ro/customreadonly > httprequest POST api/$HTTPV2/ro/customreadonly
> accept: $MEDIATYPE > accept: $MEDIATYPE
> content-type: $MEDIATYPE > content-type: $MEDIATYPE
> user-agent: test > user-agent: test
> frame command-name eos customreadonly
> EOF > EOF
using raw connection to peer using raw connection to peer
s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n s> POST /api/exp-http-v2-0001/ro/customreadonly HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n s> Accept-Encoding: identity\r\n
s> accept: application/mercurial-tbd\r\n s> accept: application/mercurial-exp-framing-0001\r\n
s> content-type: application/mercurial-tbd\r\n s> content-type: application/mercurial-exp-framing-0001\r\n
s> user-agent: test\r\n s> user-agent: test\r\n
s> content-length: 18\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> \x0e\x00\x00\x11customreadonly
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 200 OK\r\n s> HTTP/1.1 200 OK\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 18\r\n s> Content-Length: 18\r\n
s> \r\n s> \r\n
s> ro/customreadonly\n s> ro/customreadonly\n
Authorized request for valid read-write command works Authorized request for valid read-write command works
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/rw/customreadonly > httprequest POST api/$HTTPV2/rw/customreadonly
> user-agent: test > user-agent: test
> accept: $MEDIATYPE > accept: $MEDIATYPE
> content-type: $MEDIATYPE > content-type: $MEDIATYPE
> frame command-name eos customreadonly
> EOF > EOF
using raw connection to peer using raw connection to peer
s> POST /api/exp-http-v2-0001/rw/customreadonly HTTP/1.1\r\n s> POST /api/exp-http-v2-0001/rw/customreadonly HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n s> Accept-Encoding: identity\r\n
s> accept: application/mercurial-tbd\r\n s> accept: application/mercurial-exp-framing-0001\r\n
s> content-type: application/mercurial-tbd\r\n s> content-type: application/mercurial-exp-framing-0001\r\n
s> user-agent: test\r\n s> user-agent: test\r\n
s> content-length: 18\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> \x0e\x00\x00\x11customreadonly
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 200 OK\r\n s> HTTP/1.1 200 OK\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 18\r\n s> Content-Length: 18\r\n
s> \r\n s> \r\n
s> rw/customreadonly\n s> rw/customreadonly\n
Authorized request for unknown command is rejected Authorized request for unknown command is rejected
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/rw/badcommand > httprequest POST api/$HTTPV2/rw/badcommand
> user-agent: test > user-agent: test
> accept: $MEDIATYPE > accept: $MEDIATYPE
> EOF > EOF
using raw connection to peer using raw connection to peer
s> POST /api/exp-http-v2-0001/rw/badcommand HTTP/1.1\r\n s> POST /api/exp-http-v2-0001/rw/badcommand HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n s> Accept-Encoding: identity\r\n
s> accept: application/mercurial-tbd\r\n s> accept: application/mercurial-exp-framing-0001\r\n
s> user-agent: test\r\n s> user-agent: test\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob) s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n s> \r\n
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 404 Not Found\r\n s> HTTP/1.1 404 Not Found\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 42\r\n s> Content-Length: 42\r\n
s> \r\n s> \r\n
s> unknown wire protocol command: badcommand\n s> unknown wire protocol command: badcommand\n