mercurial-scm/hg: mercurial/wireprotoframing.py annotate

annotate mercurial/wireprotoframing.py @ 52644:e627cc25b6f3

pyupgrade: rewrite `yield` statements in a loop to `yield from` This is the `legacy` fixer in `pyupgrade`, with the `yield` statement yielding loop commented back in. This seems to help pytype in some cases, and hurt it in others. But that can be manually fixed later. Note that it's possibly buggy in that it aggressively changed `import-checker.py` to `yield from 'fcntl', 'grp', 'pwd', 'select', 'termios': # Unix only`, which is invalid syntax. Possibly it needed help from the token fixer that I've disabled locally (because that wants to make a bunch of unrelated changes). Just change those few places to yield from a list, to avoid having to constantly revert that.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Sun, 05 Jan 2025 22:26:16 -0500
parents	5cc8deb96b48
children	1a612f9ec2c4

rev	line source
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 # wireprotoframing.py - unified framing protocol for wire protocol
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 #
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 #
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5 # This software may be used and distributed according to the terms of the
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 # GNU General Public License version 2 or any later version.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	8 # This file contains functionality to support the unified frame-based wire
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9 # protocol. For details about the protocol, see
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	10 # `hg help internals.wireprotocol`.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	11
51859 f4733654f144 typing: add `from __future__ import annotations` to most files Matt Harbison <matt_harbison@yahoo.com> parents: 51725 diff changeset	12 from __future__ import annotations
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	13
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	14 import collections
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	15 import struct
51725 278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	16 import typing
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	17
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	18 from .i18n import _
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	19 from .thirdparty import attr
51725 278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	20
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	21 # Force pytype to use the non-vendored package
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	22 if typing.TYPE_CHECKING:
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	23 # noinspection PyPackageRequirements
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	24 import attr
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51699 diff changeset	25
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	26 from . import (
37474 d33997123ea5 py3: system-stringify repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37473 diff changeset	27 encoding,
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	28 error,
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	29 pycompat,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	30 util,
40020 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	31 wireprototypes,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	32 )
37084 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37063 diff changeset	33 from .utils import (
39446 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	34 cborutil,
37084 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37063 diff changeset	35 stringutil,
f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37063 diff changeset	36 )
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	37
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	38 FRAME_HEADER_SIZE = 8
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39 DEFAULT_MAX_FRAME_SIZE = 32768
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	40
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	41 STREAM_FLAG_BEGIN_STREAM = 0x01
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	42 STREAM_FLAG_END_STREAM = 0x02
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	43 STREAM_FLAG_ENCODING_APPLIED = 0x04
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	44
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	45 STREAM_FLAGS = {
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	46 b'stream-begin': STREAM_FLAG_BEGIN_STREAM,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	47 b'stream-end': STREAM_FLAG_END_STREAM,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	48 b'encoded': STREAM_FLAG_ENCODING_APPLIED,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	49 }
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	50
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	51 FRAME_TYPE_COMMAND_REQUEST = 0x01
37723 e8fba6d578f0 wireprotov2: change frame type value for command data Gregory Szorc <gregory.szorc@gmail.com> parents: 37722 diff changeset	52 FRAME_TYPE_COMMAND_DATA = 0x02
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	53 FRAME_TYPE_COMMAND_RESPONSE = 0x03
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	54 FRAME_TYPE_ERROR_RESPONSE = 0x05
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	55 FRAME_TYPE_TEXT_OUTPUT = 0x06
37291 b0041036214e wireproto: define frame to represent progress updates Gregory Szorc <gregory.szorc@gmail.com> parents: 37290 diff changeset	56 FRAME_TYPE_PROGRESS = 0x07
40125 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	57 FRAME_TYPE_SENDER_PROTOCOL_SETTINGS = 0x08
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	58 FRAME_TYPE_STREAM_SETTINGS = 0x09
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60 FRAME_TYPES = {
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	61 b'command-request': FRAME_TYPE_COMMAND_REQUEST,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62 b'command-data': FRAME_TYPE_COMMAND_DATA,
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	63 b'command-response': FRAME_TYPE_COMMAND_RESPONSE,
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	64 b'error-response': FRAME_TYPE_ERROR_RESPONSE,
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	65 b'text-output': FRAME_TYPE_TEXT_OUTPUT,
37291 b0041036214e wireproto: define frame to represent progress updates Gregory Szorc <gregory.szorc@gmail.com> parents: 37290 diff changeset	66 b'progress': FRAME_TYPE_PROGRESS,
40125 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	67 b'sender-protocol-settings': FRAME_TYPE_SENDER_PROTOCOL_SETTINGS,
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	68 b'stream-settings': FRAME_TYPE_STREAM_SETTINGS,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	69 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	70
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	71 FLAG_COMMAND_REQUEST_NEW = 0x01
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	72 FLAG_COMMAND_REQUEST_CONTINUATION = 0x02
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	73 FLAG_COMMAND_REQUEST_MORE_FRAMES = 0x04
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	74 FLAG_COMMAND_REQUEST_EXPECT_DATA = 0x08
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	75
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	76 FLAGS_COMMAND_REQUEST = {
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	77 b'new': FLAG_COMMAND_REQUEST_NEW,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	78 b'continuation': FLAG_COMMAND_REQUEST_CONTINUATION,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	79 b'more': FLAG_COMMAND_REQUEST_MORE_FRAMES,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	80 b'have-data': FLAG_COMMAND_REQUEST_EXPECT_DATA,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	81 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	82
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	83 FLAG_COMMAND_DATA_CONTINUATION = 0x01
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	84 FLAG_COMMAND_DATA_EOS = 0x02
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86 FLAGS_COMMAND_DATA = {
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 b'continuation': FLAG_COMMAND_DATA_CONTINUATION,
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	88 b'eos': FLAG_COMMAND_DATA_EOS,
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	89 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	90
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	91 FLAG_COMMAND_RESPONSE_CONTINUATION = 0x01
deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	92 FLAG_COMMAND_RESPONSE_EOS = 0x02
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	93
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	94 FLAGS_COMMAND_RESPONSE = {
deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	95 b'continuation': FLAG_COMMAND_RESPONSE_CONTINUATION,
deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	96 b'eos': FLAG_COMMAND_RESPONSE_EOS,
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	97 }
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	98
40125 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	99 FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION = 0x01
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	100 FLAG_SENDER_PROTOCOL_SETTINGS_EOS = 0x02
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	101
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	102 FLAGS_SENDER_PROTOCOL_SETTINGS = {
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	103 b'continuation': FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	104 b'eos': FLAG_SENDER_PROTOCOL_SETTINGS_EOS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	105 }
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	106
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	107 FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION = 0x01
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	108 FLAG_STREAM_ENCODING_SETTINGS_EOS = 0x02
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	109
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	110 FLAGS_STREAM_ENCODING_SETTINGS = {
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	111 b'continuation': FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	112 b'eos': FLAG_STREAM_ENCODING_SETTINGS_EOS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	113 }
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	114
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	115 # Maps frame types to their available flags.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	116 FRAME_TYPE_FLAGS = {
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	117 FRAME_TYPE_COMMAND_REQUEST: FLAGS_COMMAND_REQUEST,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	118 FRAME_TYPE_COMMAND_DATA: FLAGS_COMMAND_DATA,
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	119 FRAME_TYPE_COMMAND_RESPONSE: FLAGS_COMMAND_RESPONSE,
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	120 FRAME_TYPE_ERROR_RESPONSE: {},
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	121 FRAME_TYPE_TEXT_OUTPUT: {},
37291 b0041036214e wireproto: define frame to represent progress updates Gregory Szorc <gregory.szorc@gmail.com> parents: 37290 diff changeset	122 FRAME_TYPE_PROGRESS: {},
40125 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	123 FRAME_TYPE_SENDER_PROTOCOL_SETTINGS: FLAGS_SENDER_PROTOCOL_SETTINGS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	124 FRAME_TYPE_STREAM_SETTINGS: FLAGS_STREAM_ENCODING_SETTINGS,
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	125 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	126
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	127 ARGUMENT_RECORD_HEADER = struct.Struct('<HH')
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	128
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	129
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	130 def humanflags(mapping, value):
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	131 """Convert a numeric flags value to a human value, using a mapping table."""
48913 f254fc73d956 global: bulk replace simple pycompat.iteritems(x) with x.items() Gregory Szorc <gregory.szorc@gmail.com> parents: 48900 diff changeset	132 namemap = {v: k for k, v in mapping.items()}
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	133 flags = []
37473 7c2c7c749411 wireproto: show unknown id and flags in repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37472 diff changeset	134 val = 1
7c2c7c749411 wireproto: show unknown id and flags in repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37472 diff changeset	135 while value >= val:
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	136 if value & val:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	137 flags.append(namemap.get(val, b'<unknown 0x%02x>' % val))
37473 7c2c7c749411 wireproto: show unknown id and flags in repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37472 diff changeset	138 val <<= 1
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	139
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	140 return b'\|'.join(flags)
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	141
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	142
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	143 @attr.s(slots=True)
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	144 class frameheader:
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	145 """Represents the data in a frame header."""
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	146
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	147 length = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	148 requestid = attr.ib()
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	149 streamid = attr.ib()
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	150 streamflags = attr.ib()
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	151 typeid = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	152 flags = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	153
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	154
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	155 @attr.s(slots=True, repr=False)
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	156 class frame:
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	157 """Represents a parsed frame."""
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	158
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	159 requestid = attr.ib()
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	160 streamid = attr.ib()
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	161 streamflags = attr.ib()
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	162 typeid = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	163 flags = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	164 payload = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	165
37474 d33997123ea5 py3: system-stringify repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37473 diff changeset	166 @encoding.strmethod
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	167 def __repr__(self):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	168 typename = b'<unknown 0x%02x>' % self.typeid
48913 f254fc73d956 global: bulk replace simple pycompat.iteritems(x) with x.items() Gregory Szorc <gregory.szorc@gmail.com> parents: 48900 diff changeset	169 for name, value in FRAME_TYPES.items():
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	170 if value == self.typeid:
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	171 typename = name
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	172 break
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	173
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	174 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	175 b'frame(size=%d; request=%d; stream=%d; streamflags=%s; '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	176 b'type=%s; flags=%s)'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	177 % (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	178 len(self.payload),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	179 self.requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	180 self.streamid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	181 humanflags(STREAM_FLAGS, self.streamflags),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	182 typename,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	183 humanflags(FRAME_TYPE_FLAGS.get(self.typeid, {}), self.flags),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	184 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	185 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	186
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	187
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	188 def makeframe(requestid, streamid, streamflags, typeid, flags, payload):
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189 """Assemble a frame into a byte array."""
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 # TODO assert size of payload.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	191 frame = bytearray(FRAME_HEADER_SIZE + len(payload))
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	192
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	193 # 24 bits length
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	194 # 16 bits request id
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	195 # 8 bits stream id
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	196 # 8 bits stream flags
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	197 # 4 bits type
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	198 # 4 bits flags
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	199
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	200 l = struct.pack('<I', len(payload))
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	201 frame[0:3] = l[0:3]
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	202 struct.pack_into('<HBB', frame, 3, requestid, streamid, streamflags)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	203 frame[7] = (typeid << 4) \| flags
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	204 frame[8:] = payload
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	205
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	206 return frame
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	207
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	208
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	209 def makeframefromhumanstring(s):
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	210 """Create a frame from a human readable string
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	211
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	212 Strings have the form:
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	213
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	214 <request-id> <stream-id> <stream-flags> <type> <flags> <payload>
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	215
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	216 This can be used by user-facing applications and tests for creating
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	217 frames easily without having to type out a bunch of constants.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	218
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	219 Request ID and stream IDs are integers.
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	220
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	221 Stream flags, frame type, and flags can be specified by integer or
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	222 named constant.
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	223
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	224 Flags can be delimited by `\|` to bitwise OR them together.
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	225
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	226 If the payload begins with ``cbor:``, the following string will be
37476 e9dea82ea1f3 wireproto: convert python literal to object without using unsafe eval() Yuya Nishihara <yuya@tcha.org> parents: 37474 diff changeset	227 evaluated as Python literal and the resulting object will be fed into
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	228 a CBOR encoder. Otherwise, the payload is interpreted as a Python
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	229 byte string literal.
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	230 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	231 fields = s.split(b' ', 5)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	232 requestid, streamid, streamflags, frametype, frameflags, payload = fields
37057 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	233
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37056 diff changeset	234 requestid = int(requestid)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	235 streamid = int(streamid)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	236
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	237 finalstreamflags = 0
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	238 for flag in streamflags.split(b'\|'):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	239 if flag in STREAM_FLAGS:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	240 finalstreamflags \|= STREAM_FLAGS[flag]
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	241 else:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	242 finalstreamflags \|= int(flag)
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	243
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	244 if frametype in FRAME_TYPES:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	245 frametype = FRAME_TYPES[frametype]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	246 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	247 frametype = int(frametype)
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	248
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	249 finalflags = 0
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	250 validflags = FRAME_TYPE_FLAGS[frametype]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	251 for flag in frameflags.split(b'\|'):
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	252 if flag in validflags:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	253 finalflags \|= validflags[flag]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	254 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	255 finalflags \|= int(flag)
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	256
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	257 if payload.startswith(b'cbor:'):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	258 payload = b''.join(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	259 cborutil.streamencode(stringutil.evalpythonliteral(payload[5:]))
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	260 )
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	261
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	262 else:
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	263 payload = stringutil.unescapestr(payload)
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	264
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	265 return makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	266 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	267 streamid=streamid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	268 streamflags=finalstreamflags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	269 typeid=frametype,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	270 flags=finalflags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	271 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	272 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	273
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	274
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	275 def parseheader(data):
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	276 """Parse a unified framing protocol frame header from a buffer.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	277
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	278 The header is expected to be in the buffer at offset 0 and the
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	279 buffer is expected to be large enough to hold a full header.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	280 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	281 # 24 bits payload length (little endian)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	282 # 16 bits request ID
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	283 # 8 bits stream ID
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	284 # 8 bits stream flags
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	285 # 4 bits frame type
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	286 # 4 bits frame flags
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	287 # ... payload
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	288 framelength = data[0] + 256 * data[1] + 16384 * data[2]
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	289 requestid, streamid, streamflags = struct.unpack_from('<HBB', data, 3)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	290 typeflags = data[7]
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	291
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	292 frametype = (typeflags & 0xF0) >> 4
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	293 frameflags = typeflags & 0x0F
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	294
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	295 return frameheader(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	296 framelength, requestid, streamid, streamflags, frametype, frameflags
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	297 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	298
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	299
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	300 def readframe(fh):
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	301 """Read a unified framing protocol frame from a file object.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	302
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	303 Returns a 3-tuple of (type, flags, payload) for the decoded frame or
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	304 None if no frame is available. May raise if a malformed frame is
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	305 seen.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	306 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	307 header = bytearray(FRAME_HEADER_SIZE)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	308
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	309 readcount = fh.readinto(header)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	310
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	311 if readcount == 0:
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	312 return None
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	313
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	314 if readcount != FRAME_HEADER_SIZE:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	315 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	316 _(b'received incomplete frame: got %d bytes: %s')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	317 % (readcount, header)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	318 )
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	319
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	320 h = parseheader(header)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	321
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	322 payload = fh.read(h.length)
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	323 if len(payload) != h.length:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	324 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	325 _(b'frame length error: expected %d; got %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	326 % (h.length, len(payload))
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	327 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	328
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	329 return frame(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	330 h.requestid, h.streamid, h.streamflags, h.typeid, h.flags, payload
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	331 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	332
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	333
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	334 def createcommandframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	335 stream,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	336 requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	337 cmd,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	338 args,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	339 datafh=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	340 maxframesize=DEFAULT_MAX_FRAME_SIZE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	341 redirect=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	342 ):
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	343 """Create frames necessary to transmit a request to run a command.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	345 This is a generator of bytearrays. Each item represents a frame
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	346 ready to be sent over the wire to a peer.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	347 """
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	348 data = {b'name': cmd}
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	349 if args:
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	350 data[b'args'] = args
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	351
40024 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	352 if redirect:
86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	353 data[b'redirect'] = redirect
86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	354
39446 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	355 data = b''.join(cborutil.streamencode(data))
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	356
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	357 offset = 0
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	358
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	359 while True:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	360 flags = 0
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	361
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	362 # Must set new or continuation flag.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	363 if not offset:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	364 flags \|= FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	365 else:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	366 flags \|= FLAG_COMMAND_REQUEST_CONTINUATION
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	367
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	368 # Data frames is set on all frames.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	369 if datafh:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	370 flags \|= FLAG_COMMAND_REQUEST_EXPECT_DATA
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	371
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	372 payload = data[offset : offset + maxframesize]
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	373 offset += len(payload)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	374
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	375 if len(payload) == maxframesize and offset < len(data):
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	376 flags \|= FLAG_COMMAND_REQUEST_MORE_FRAMES
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	377
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	378 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	379 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	380 typeid=FRAME_TYPE_COMMAND_REQUEST,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	381 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	382 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	383 )
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	384
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	385 if not (flags & FLAG_COMMAND_REQUEST_MORE_FRAMES):
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	386 break
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	387
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	388 if datafh:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 while True:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	390 data = datafh.read(DEFAULT_MAX_FRAME_SIZE)
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 done = False
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	393 if len(data) == DEFAULT_MAX_FRAME_SIZE:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	394 flags = FLAG_COMMAND_DATA_CONTINUATION
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	395 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	396 flags = FLAG_COMMAND_DATA_EOS
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	397 assert datafh.read(1) == b''
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398 done = True
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	399
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	400 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	401 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	402 typeid=FRAME_TYPE_COMMAND_DATA,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	403 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	404 payload=data,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	405 )
37051 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	406
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 if done:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	408 break
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	409
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	410
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	411 def createcommandresponseokframe(stream, requestid):
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	412 overall = b''.join(cborutil.streamencode({b'status': b'ok'}))
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	413
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	414 if stream.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	415 overall = stream.encode(overall)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	416 encoded = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	417
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	418 if not overall:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	419 return None
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	420 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	421 encoded = False
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	422
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	423 return stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	424 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	425 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	426 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	427 payload=overall,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	428 encoded=encoded,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	429 )
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	430
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	431
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	432 def createcommandresponseeosframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	433 stream, requestid, maxframesize=DEFAULT_MAX_FRAME_SIZE
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	434 ):
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	435 """Create an empty payload frame representing command end-of-stream."""
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	436 payload = stream.flush()
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	437
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	438 offset = 0
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	439 while True:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	440 chunk = payload[offset : offset + maxframesize]
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	441 offset += len(chunk)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	442
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	443 done = offset == len(payload)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	444
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	445 if done:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	446 flags = FLAG_COMMAND_RESPONSE_EOS
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	447 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	448 flags = FLAG_COMMAND_RESPONSE_CONTINUATION
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	449
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	450 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	451 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	452 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	453 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	454 payload=chunk,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	455 encoded=payload != b'',
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	456 )
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	457
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	458 if done:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	459 break
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	460
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	461
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	462 def createalternatelocationresponseframe(stream, requestid, location):
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	463 data = {
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	464 b'status': b'redirect',
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	465 b'location': {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	466 b'url': location.url,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	467 b'mediatype': location.mediatype,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	468 },
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	469 }
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	470
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	471 for a in (
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	472 'size',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	473 'fullhashes',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	474 'fullhashseed',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	475 'serverdercerts',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	476 'servercadercerts',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	477 ):
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	478 value = getattr(location, a)
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	479 if value is not None:
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	480 # pytype: disable=unsupported-operands
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	481 data[b'location'][pycompat.bytestr(a)] = value
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	482 # pytype: enable=unsupported-operands
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	483
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	484 payload = b''.join(cborutil.streamencode(data))
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	485
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	486 if stream.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	487 payload = stream.encode(payload)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	488 encoded = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	489 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	490 encoded = False
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	491
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	492 return stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	493 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	494 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	495 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	496 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	497 encoded=encoded,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	498 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	499
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	500
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	501 def createcommanderrorresponse(stream, requestid, message, args=None):
39486 43d92d68ac88 wireprotov2peer: properly format errors Gregory Szorc <gregory.szorc@gmail.com> parents: 39446 diff changeset	502 # TODO should this be using a list of {'msg': ..., 'args': {}} so atom
43d92d68ac88 wireprotov2peer: properly format errors Gregory Szorc <gregory.szorc@gmail.com> parents: 39446 diff changeset	503 # formatting works consistently?
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	504 m = {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	505 b'status': b'error',
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	506 b'error': {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	507 b'message': message,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	508 },
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	509 }
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	510
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	511 if args:
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	512 m[b'error'][b'args'] = args # pytype: disable=unsupported-operands
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	513
39446 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	514 overall = b''.join(cborutil.streamencode(m))
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	515
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	516 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	517 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	518 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	519 flags=FLAG_COMMAND_RESPONSE_EOS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	520 payload=overall,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	521 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	522
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	523
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	524 def createerrorframe(stream, requestid, msg, errtype):
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	525 # TODO properly handle frame size limits.
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	526 assert len(msg) <= DEFAULT_MAX_FRAME_SIZE
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	527
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	528 payload = b''.join(
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	529 cborutil.streamencode(
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	530 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	531 b'type': errtype,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	532 b'message': [{b'msg': msg}],
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	533 }
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	534 )
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	535 )
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	536
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	537 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	538 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	539 typeid=FRAME_TYPE_ERROR_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	540 flags=0,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	541 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	542 )
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	543
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	544
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	545 def createtextoutputframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	546 stream, requestid, atoms, maxframesize=DEFAULT_MAX_FRAME_SIZE
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	547 ):
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	548 """Create a text output frame to render text to people.
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	549
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	550 ``atoms`` is a 3-tuple of (formatting string, args, labels).
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	551
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	552 The formatting string contains ``%s`` tokens to be replaced by the
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	553 corresponding indexed entry in ``args``. ``labels`` is an iterable of
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	554 formatters to be applied at rendering time. In terms of the ``ui``
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	555 class, each atom corresponds to a ``ui.write()``.
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	556 """
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	557 atomdicts = []
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	558
51699 ca7bde5dbafb black: format the codebase with 23.3.0 Rapha?l Gom?s <rgomes@octobus.net> parents: 51696 diff changeset	559 for formatting, args, labels in atoms:
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	560 # TODO look for localstr, other types here?
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	561
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	562 if not isinstance(formatting, bytes):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	563 raise ValueError(b'must use bytes formatting strings')
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	564 for arg in args:
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	565 if not isinstance(arg, bytes):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	566 raise ValueError(b'must use bytes for arguments')
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	567 for label in labels:
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	568 if not isinstance(label, bytes):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	569 raise ValueError(b'must use bytes for labels')
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	570
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	571 # Formatting string must be ASCII.
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	572 formatting = formatting.decode('ascii', 'replace').encode('ascii')
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	573
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	574 # Arguments must be UTF-8.
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	575 args = [a.decode('utf-8', 'replace').encode('utf-8') for a in args]
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	576
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	577 # Labels must be ASCII.
43506 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	578 labels = [l.decode('ascii', 'strict').encode('ascii') for l in labels]
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	579
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	580 atom = {b'msg': formatting}
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	581 if args:
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	582 atom[b'args'] = args
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	583 if labels:
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	584 atom[b'labels'] = labels
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	585
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	586 atomdicts.append(atom)
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	587
39446 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	588 payload = b''.join(cborutil.streamencode(atomdicts))
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	589
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	590 if len(payload) > maxframesize:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	591 raise ValueError(b'cannot encode data in a single frame')
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	592
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	593 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	594 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	595 typeid=FRAME_TYPE_TEXT_OUTPUT,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	596 flags=0,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	597 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	598 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	599
37285 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	600
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	601 class bufferingcommandresponseemitter:
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	602 """Helper object to emit command response frames intelligently.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	603
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	604 Raw command response data is likely emitted in chunks much smaller
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	605 than what can fit in a single frame. This class exists to buffer
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	606 chunks until enough data is available to fit in a single frame.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	607
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	608 TODO we'll need something like this when compression is supported.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	609 So it might make sense to implement this functionality at the stream
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	610 level.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	611 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	612
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	613 def __init__(self, stream, requestid, maxframesize=DEFAULT_MAX_FRAME_SIZE):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	614 self._stream = stream
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	615 self._requestid = requestid
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	616 self._maxsize = maxframesize
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	617 self._chunks = []
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	618 self._chunkssize = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	619
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	620 def send(self, data):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	621 """Send new data for emission.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	622
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	623 Is a generator of new frames that were derived from the new input.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	624
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	625 If the special input ``None`` is received, flushes all buffered
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	626 data to frames.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	627 """
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	628
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	629 if data is None:
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	630 yield from self._flush()
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	631 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	632
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	633 data = self._stream.encode(data)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	634
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	635 # There is a ton of potential to do more complicated things here.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	636 # Our immediate goal is to coalesce small chunks into big frames,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	637 # not achieve the fewest number of frames possible. So we go with
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	638 # a simple implementation:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	639 #
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	640 # * If a chunk is too large for a frame, we flush and emit frames
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	641 # for the new chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	642 # * If a chunk can be buffered without total buffered size limits
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	643 # being exceeded, we do that.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	644 # * If a chunk causes us to go over our buffering limit, we flush
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	645 # and then buffer the new chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	646
40136 3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	647 if not data:
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	648 return
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	649
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	650 if len(data) > self._maxsize:
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	651 yield from self._flush()
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	652
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	653 # Now emit frames for the big chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	654 offset = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	655 while True:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	656 chunk = data[offset : offset + self._maxsize]
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	657 offset += len(chunk)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	658
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	659 yield self._stream.makeframe(
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	660 self._requestid,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	661 typeid=FRAME_TYPE_COMMAND_RESPONSE,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	662 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	663 payload=chunk,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	664 encoded=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	665 )
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	666
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	667 if offset == len(data):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	668 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	669
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	670 # If we don't have enough to constitute a full frame, buffer and
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	671 # return.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	672 if len(data) + self._chunkssize < self._maxsize:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	673 self._chunks.append(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	674 self._chunkssize += len(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	675 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	676
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	677 # Else flush what we have and buffer the new chunk. We could do
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	678 # something more intelligent here, like break the chunk. Let's
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	679 # keep things simple for now.
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	680 yield from self._flush()
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	681
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	682 self._chunks.append(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	683 self._chunkssize = len(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	684
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	685 def _flush(self):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	686 payload = b''.join(self._chunks)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	687 assert len(payload) <= self._maxsize
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	688
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	689 self._chunks[:] = []
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	690 self._chunkssize = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	691
40136 3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	692 if not payload:
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	693 return
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	694
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	695 yield self._stream.makeframe(
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	696 self._requestid,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	697 typeid=FRAME_TYPE_COMMAND_RESPONSE,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	698 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	699 payload=payload,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	700 encoded=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	701 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	702
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	703
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	704 # TODO consider defining encoders/decoders using the util.compressionengine
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	705 # mechanism.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	706
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	707
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	708 class identityencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	709 """Encoder for the "identity" stream encoding profile."""
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	710
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	711 def __init__(self, ui):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	712 pass
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	713
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	714 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	715 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	716
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	717 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	718 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	719
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	720 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	721 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	722
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	723
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	724 class identitydecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	725 """Decoder for the "identity" stream encoding profile."""
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	726
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	727 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	728 if extraobjs:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	729 raise error.Abort(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	730 _(b'identity decoder received unexpected additional values')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	731 )
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	732
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	733 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	734 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	735
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	736
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	737 class zlibencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	738 def __init__(self, ui):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	739 import zlib
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	740
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	741 self._zlib = zlib
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	742 self._compressor = zlib.compressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	743
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	744 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	745 return self._compressor.compress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	746
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	747 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	748 # Z_SYNC_FLUSH doesn't reset compression context, which is
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	749 # what we want.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	750 return self._compressor.flush(self._zlib.Z_SYNC_FLUSH)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	751
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	752 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	753 res = self._compressor.flush(self._zlib.Z_FINISH)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	754 self._compressor = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	755 return res
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	756
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	757
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	758 class zlibdecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	759 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	760 import zlib
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	761
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	762 if extraobjs:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	763 raise error.Abort(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	764 _(b'zlib decoder received unexpected additional values')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	765 )
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	766
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	767 self._decompressor = zlib.decompressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	768
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	769 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	770 return self._decompressor.decompress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	771
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	772
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	773 class zstdbaseencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	774 def __init__(self, level):
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	775 from . import zstd # pytype: disable=import-error
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	776
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	777 self._zstd = zstd
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	778 cctx = zstd.ZstdCompressor(level=level)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	779 self._compressor = cctx.compressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	780
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	781 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	782 return self._compressor.compress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	783
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	784 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	785 # COMPRESSOBJ_FLUSH_BLOCK flushes all data previously fed into the
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	786 # compressor and allows a decompressor to access all encoded data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	787 # up to this point.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	788 return self._compressor.flush(self._zstd.COMPRESSOBJ_FLUSH_BLOCK)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	789
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	790 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	791 res = self._compressor.flush(self._zstd.COMPRESSOBJ_FLUSH_FINISH)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	792 self._compressor = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	793 return res
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	794
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	795
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	796 class zstd8mbencoder(zstdbaseencoder):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	797 def __init__(self, ui):
52643 5cc8deb96b48 pyupgrade: modernize calls to superclass methods Matt Harbison <matt_harbison@yahoo.com> parents: 52124 diff changeset	798 super().__init__(3)
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	799
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	800
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	801 class zstdbasedecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	802 def __init__(self, maxwindowsize):
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	803 from . import zstd # pytype: disable=import-error
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	804
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	805 dctx = zstd.ZstdDecompressor(max_window_size=maxwindowsize)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	806 self._decompressor = dctx.decompressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	807
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	808 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	809 return self._decompressor.decompress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	810
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	811
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	812 class zstd8mbdecoder(zstdbasedecoder):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	813 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	814 if extraobjs:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	815 raise error.Abort(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	816 _(b'zstd8mb decoder received unexpected additional values')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	817 )
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	818
52643 5cc8deb96b48 pyupgrade: modernize calls to superclass methods Matt Harbison <matt_harbison@yahoo.com> parents: 52124 diff changeset	819 super().__init__(maxwindowsize=8 * 1048576)
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	820
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	821
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	822 # We lazily populate this to avoid excessive module imports when importing
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	823 # this module.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	824 STREAM_ENCODERS = {}
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	825 STREAM_ENCODERS_ORDER = []
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	826
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	827
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	828 def populatestreamencoders():
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	829 if STREAM_ENCODERS:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	830 return
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	831
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	832 try:
52124 0c260e7158e0 typing: suppress bogus pytype errors in `mercurial/wireprotoframing.py` Matt Harbison <matt_harbison@yahoo.com> parents: 51859 diff changeset	833 from . import zstd # pytype: disable=import-error
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	834
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	835 zstd.__version__
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	836 except ImportError:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	837 zstd = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	838
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	839 # zstandard is fastest and is preferred.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	840 if zstd:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	841 STREAM_ENCODERS[b'zstd-8mb'] = (zstd8mbencoder, zstd8mbdecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	842 STREAM_ENCODERS_ORDER.append(b'zstd-8mb')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	843
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	844 STREAM_ENCODERS[b'zlib'] = (zlibencoder, zlibdecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	845 STREAM_ENCODERS_ORDER.append(b'zlib')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	846
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	847 STREAM_ENCODERS[b'identity'] = (identityencoder, identitydecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	848 STREAM_ENCODERS_ORDER.append(b'identity')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	849
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	850
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	851 class stream:
37285 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	852 """Represents a logical unidirectional series of frames."""
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	853
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	854 def __init__(self, streamid, active=False):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	855 self.streamid = streamid
37655 b9502b5f2066 wireprotoframing: use value passed into function Gregory Szorc <gregory.szorc@gmail.com> parents: 37544 diff changeset	856 self._active = active
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	857
37285 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	858 def makeframe(self, requestid, typeid, flags, payload):
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	859 """Create a frame to be sent out over this stream.
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	860
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	861 Only returns the frame instance. Does not actually send it.
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37084 diff changeset	862 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	863 streamflags = 0
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	864 if not self._active:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	865 streamflags \|= STREAM_FLAG_BEGIN_STREAM
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	866 self._active = True
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	867
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	868 return makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	869 requestid, self.streamid, streamflags, typeid, flags, payload
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	870 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	871
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	872
40130 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	873 class inputstream(stream):
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	874 """Represents a stream used for receiving data."""
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	875
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	876 def __init__(self, streamid, active=False):
52643 5cc8deb96b48 pyupgrade: modernize calls to superclass methods Matt Harbison <matt_harbison@yahoo.com> parents: 52124 diff changeset	877 super().__init__(streamid, active=active)
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	878 self._decoder = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	879
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	880 def setdecoder(self, ui, name, extraobjs):
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	881 """Set the decoder for this stream.
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	882
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	883 Receives the stream profile name and any additional CBOR objects
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	884 decoded from the stream encoding settings frame payloads.
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	885 """
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	886 if name not in STREAM_ENCODERS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	887 raise error.Abort(_(b'unknown stream decoder: %s') % name)
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	888
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	889 self._decoder = STREAM_ENCODERS[name][1](ui, extraobjs)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	890
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	891 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	892 # Default is identity decoder. We don't bother instantiating one
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	893 # because it is trivial.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	894 if not self._decoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	895 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	896
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	897 return self._decoder.decode(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	898
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	899 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	900 if not self._decoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	901 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	902
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	903 return self._decoder.flush()
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	904
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	905
40130 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	906 class outputstream(stream):
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	907 """Represents a stream used for sending data."""
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	908
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	909 def __init__(self, streamid, active=False):
52643 5cc8deb96b48 pyupgrade: modernize calls to superclass methods Matt Harbison <matt_harbison@yahoo.com> parents: 52124 diff changeset	910 super().__init__(streamid, active=active)
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	911 self.streamsettingssent = False
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	912 self._encoder = None
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	913 self._encodername = None
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	914
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	915 def setencoder(self, ui, name):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	916 """Set the encoder for this stream.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	917
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	918 Receives the stream profile name.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	919 """
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	920 if name not in STREAM_ENCODERS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	921 raise error.Abort(_(b'unknown stream encoder: %s') % name)
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	922
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	923 self._encoder = STREAM_ENCODERS[name][0](ui)
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	924 self._encodername = name
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	925
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	926 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	927 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	928 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	929
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	930 return self._encoder.encode(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	931
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	932 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	933 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	934 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	935
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	936 return self._encoder.flush()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	937
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	938 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	939 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	940 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	941
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	942 self._encoder.finish()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	943
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	944 def makeframe(self, requestid, typeid, flags, payload, encoded=False):
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	945 """Create a frame to be sent out over this stream.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	946
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	947 Only returns the frame instance. Does not actually send it.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	948 """
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	949 streamflags = 0
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	950 if not self._active:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	951 streamflags \|= STREAM_FLAG_BEGIN_STREAM
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	952 self._active = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	953
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	954 if encoded:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	955 if not self.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	956 raise error.ProgrammingError(
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	957 b'attempting to send encoded frame without sending stream '
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	958 b'settings'
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	959 )
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	960
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	961 streamflags \|= STREAM_FLAG_ENCODING_APPLIED
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	962
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	963 if (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	964 typeid == FRAME_TYPE_STREAM_SETTINGS
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	965 and flags & FLAG_STREAM_ENCODING_SETTINGS_EOS
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	966 ):
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	967 self.streamsettingssent = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	968
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	969 return makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	970 requestid, self.streamid, streamflags, typeid, flags, payload
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	971 )
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	972
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	973 def makestreamsettingsframe(self, requestid):
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	974 """Create a stream settings frame for this stream.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	975
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	976 Returns frame data or None if no stream settings frame is needed or has
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	977 already been sent.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	978 """
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	979 if not self._encoder or self.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	980 return None
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	981
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	982 payload = b''.join(cborutil.streamencode(self._encodername))
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	983 return self.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	984 requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	985 FRAME_TYPE_STREAM_SETTINGS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	986 FLAG_STREAM_ENCODING_SETTINGS_EOS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	987 payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	988 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	989
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	990
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	991 def ensureserverstream(stream):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	992 if stream.streamid % 2:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	993 raise error.ProgrammingError(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	994 b'server should only write to even '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	995 b'numbered streams; %d is not even' % stream.streamid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	996 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	997
37060 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	998
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	999 DEFAULT_PROTOCOL_SETTINGS = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1000 b'contentencodings': [b'identity'],
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1001 }
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1002
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1003
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	1004 class serverreactor:
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1005 """Holds state of a server handling frame-based protocol requests.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1006
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1007 This class is the "brain" of the unified frame-based protocol server
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1008 component. While the protocol is stateless from the perspective of
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1009 requests/commands, something needs to track which frames have been
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1010 received, what frames to expect, etc. This class is that thing.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1011
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1012 Instances are modeled as a state machine of sorts. Instances are also
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1013 reactionary to external events. The point of this class is to encapsulate
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1014 the state of the connection and the exchange of frames, not to perform
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1015 work. Instead, callers tell this class when something occurs, like a
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1016 frame arriving. If that activity is worthy of a follow-up action (say
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1017 run a command), the return value of that handler will say so.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1018
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1019 I/O and CPU intensive operations are purposefully delegated outside of
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1020 this class.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1021
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1022 Consumers are expected to tell instances when events occur. They do so by
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1023 calling the various ``on*`` methods. These methods return a 2-tuple
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1024 describing any follow-up action(s) to take. The first element is the
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1025 name of an action to perform. The second is a data structure (usually
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1026 a dict) specific to that action that contains more information. e.g.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1027 if the server wants to send frames back to the client, the data structure
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1028 will contain a reference to those frames.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1029
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1030 Valid actions that consumers can be instructed to take are:
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1031
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1032 sendframes
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1033 Indicates that frames should be sent to the client. The ``framegen``
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1034 key contains a generator of frames that should be sent. The server
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1035 assumes that all frames are sent to the client.
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1036
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1037 error
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1038 Indicates that an error occurred. Consumer should probably abort.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1039
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1040 runcommand
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1041 Indicates that the consumer should run a wire protocol command. Details
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1042 of the command to run are given in the data structure.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1043
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1044 wantframe
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1045 Indicates that nothing of interest happened and the server is waiting on
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1046 more frames from the client before anything interesting can be done.
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1047
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1048 noop
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1049 Indicates no additional action is required.
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1050
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1051 Known Issues
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1052 ------------
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1053
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1054 There are no limits to the number of partially received commands or their
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1055 size. A malicious client could stream command request data and exhaust the
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1056 server's memory.
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1057
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1058 Partially received commands are not acted upon when end of input is
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1059 reached. Should the server error if it receives a partial request?
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1060 Should the client send a message to abort a partially transmitted request
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1061 to facilitate graceful shutdown?
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1062
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1063 Active requests that haven't been responded to aren't tracked. This means
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1064 that if we receive a command and instruct its dispatch, another command
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1065 with its request ID can come in over the wire and there will be a race
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1066 between who responds to what.
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1067 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1068
40129 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1069 def __init__(self, ui, deferoutput=False):
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1070 """Construct a new server reactor.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1071
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1072 ``deferoutput`` can be used to indicate that no output frames should be
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1073 instructed to be sent until input has been exhausted. In this mode,
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1074 events that would normally generate output frames (such as a command
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1075 response being ready) will instead defer instructing the consumer to
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1076 send those frames. This is useful for half-duplex transports where the
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1077 sender cannot receive until all data has been transmitted.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1078 """
40129 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1079 self._ui = ui
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1080 self._deferoutput = deferoutput
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1081 self._state = b'initial'
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1082 self._nextoutgoingstreamid = 2
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1083 self._bufferedframegens = []
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1084 # stream id -> stream instance for all active streams from the client.
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1085 self._incomingstreams = {}
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1086 self._outgoingstreams = {}
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1087 # request id -> dict of commands that are actively being received.
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1088 self._receivingcommands = {}
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1089 # Request IDs that have been received and are actively being processed.
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1090 # Once all output for a request has been sent, it is removed from this
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1091 # set.
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1092 self._activecommands = set()
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1093
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1094 self._protocolsettingsdecoder = None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1095
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1096 # Sender protocol settings are optional. Set implied default values.
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1097 self._sendersettings = dict(DEFAULT_PROTOCOL_SETTINGS)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1098
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1099 populatestreamencoders()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1100
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1101 def onframerecv(self, frame):
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1102 """Process a frame that has been received off the wire.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1103
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1104 Returns a dict with an ``action`` key that details what action,
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1105 if any, the consumer should take next.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1106 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1107 if not frame.streamid % 2:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1108 self._state = b'errored'
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1109 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1110 _(b'received frame with even numbered stream ID: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1111 % frame.streamid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1112 )
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1113
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1114 if frame.streamid not in self._incomingstreams:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1115 if not frame.streamflags & STREAM_FLAG_BEGIN_STREAM:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1116 self._state = b'errored'
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1117 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1118 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1119 b'received frame on unknown inactive stream without '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1120 b'beginning of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1121 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1122 )
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1123
40130 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1124 self._incomingstreams[frame.streamid] = inputstream(frame.streamid)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1125
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1126 if frame.streamflags & STREAM_FLAG_ENCODING_APPLIED:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1127 # TODO handle decoding frames
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1128 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1129 raise error.ProgrammingError(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1130 b'support for decoding stream payloads not yet implemented'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1131 )
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1132
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1133 if frame.streamflags & STREAM_FLAG_END_STREAM:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1134 del self._incomingstreams[frame.streamid]
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1135
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1136 handlers = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1137 b'initial': self._onframeinitial,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1138 b'protocol-settings-receiving': self._onframeprotocolsettings,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1139 b'idle': self._onframeidle,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1140 b'command-receiving': self._onframecommandreceiving,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1141 b'errored': self._onframeerrored,
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1142 }
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1143
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1144 meth = handlers.get(self._state)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1145 if not meth:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1146 raise error.ProgrammingError(b'unhandled state: %s' % self._state)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1147
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1148 return meth(frame)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1149
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1150 def oncommandresponsereadyobjects(self, stream, requestid, objs):
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1151 """Signal that objects are ready to be sent to the client.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1152
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1153 ``objs`` is an iterable of objects (typically a generator) that will
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1154 be encoded via CBOR and added to frames, which will be sent to the
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1155 client.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1156 """
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1157 ensureserverstream(stream)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1158
40135 966b5f7fd30b wireprotov2: remove functions for creating response frames from bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 40133 diff changeset	1159 # A more robust solution would be to check for objs.{next,__next__}.
966b5f7fd30b wireprotov2: remove functions for creating response frames from bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 40133 diff changeset	1160 if isinstance(objs, list):
966b5f7fd30b wireprotov2: remove functions for creating response frames from bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 40133 diff changeset	1161 objs = iter(objs)
966b5f7fd30b wireprotov2: remove functions for creating response frames from bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 40133 diff changeset	1162
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1163 # We need to take care over exception handling. Uncaught exceptions
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1164 # when generating frames could lead to premature end of the frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1165 # stream and the possibility of the server or client process getting
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1166 # in a bad state.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1167 #
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1168 # Keep in mind that if ``objs`` is a generator, advancing it could
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1169 # raise exceptions that originated in e.g. wire protocol command
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1170 # functions. That is why we differentiate between exceptions raised
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1171 # when iterating versus other exceptions that occur.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1172 #
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1173 # In all cases, when the function finishes, the request is fully
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1174 # handled and no new frames for it should be seen.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1175
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1176 def sendframes():
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1177 emitted = False
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1178 alternatelocationsent = False
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1179 emitter = bufferingcommandresponseemitter(stream, requestid)
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1180 while True:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1181 try:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1182 o = next(objs)
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1183 except StopIteration:
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1184 for frame in emitter.send(None):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1185 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1186
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1187 if emitted:
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1188 for frame in createcommandresponseeosframes(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1189 stream, requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1190 ):
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1191 yield frame
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1192 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1193
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1194 except error.WireprotoCommandError as e:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1195 for frame in createcommanderrorresponse(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1196 stream, requestid, e.message, e.messageargs
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1197 ):
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1198 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1199 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1200
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1201 except Exception as e:
39838 bce1c1af7518 py3: cast exception to bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 39560 diff changeset	1202 for frame in createerrorframe(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1203 stream,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1204 requestid,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1205 b'%s' % stringutil.forcebytestr(e),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1206 errtype=b'server',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1207 ):
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1208 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1209
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1210 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1211
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1212 try:
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1213 # Alternate location responses can only be the first and
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1214 # only object in the output stream.
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1215 if isinstance(o, wireprototypes.alternatelocationresponse):
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1216 if emitted:
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1217 raise error.ProgrammingError(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1218 b'alternatelocationresponse seen after initial '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1219 b'output object'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1220 )
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1221
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1222 frame = stream.makestreamsettingsframe(requestid)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1223 if frame:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1224 yield frame
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1225
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1226 yield createalternatelocationresponseframe(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1227 stream, requestid, o
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1228 )
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1229
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1230 alternatelocationsent = True
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1231 emitted = True
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1232 continue
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1233
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1234 if alternatelocationsent:
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1235 raise error.ProgrammingError(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1236 b'object follows alternatelocationresponse'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1237 )
40025 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40024 diff changeset	1238
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1239 if not emitted:
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1240 # Frame is optional.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1241 frame = stream.makestreamsettingsframe(requestid)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1242 if frame:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1243 yield frame
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1244
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1245 # May be None if empty frame (due to encoding).
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1246 frame = createcommandresponseokframe(stream, requestid)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1247 if frame:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1248 yield frame
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1249
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1250 emitted = True
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1251
40020 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1252 # Objects emitted by command functions can be serializable
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1253 # data structures or special types.
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1254 # TODO consider extracting the content normalization to a
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1255 # standalone function, as it may be useful for e.g. cachers.
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1256
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1257 # A pre-encoded object is sent directly to the emitter.
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1258 if isinstance(o, wireprototypes.encodedresponse):
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1259 for frame in emitter.send(o.data):
39560 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1260 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39559 diff changeset	1261
40328 2c55716f8a1c wireprotov2: add response type that serializes to indefinite length bytestring Gregory Szorc <gregory.szorc@gmail.com> parents: 40138 diff changeset	1262 elif isinstance(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1263 o, wireprototypes.indefinitebytestringresponse
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1264 ):
40328 2c55716f8a1c wireprotov2: add response type that serializes to indefinite length bytestring Gregory Szorc <gregory.szorc@gmail.com> parents: 40138 diff changeset	1265 for chunk in cborutil.streamencodebytestringfromiter(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1266 o.chunks
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1267 ):
40328 2c55716f8a1c wireprotov2: add response type that serializes to indefinite length bytestring Gregory Szorc <gregory.szorc@gmail.com> parents: 40138 diff changeset	1268 for frame in emitter.send(chunk):
2c55716f8a1c wireprotov2: add response type that serializes to indefinite length bytestring Gregory Szorc <gregory.szorc@gmail.com> parents: 40138 diff changeset	1269 yield frame
2c55716f8a1c wireprotov2: add response type that serializes to indefinite length bytestring Gregory Szorc <gregory.szorc@gmail.com> parents: 40138 diff changeset	1270
40020 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1271 # A regular object is CBOR encoded.
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1272 else:
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1273 for chunk in cborutil.streamencode(o):
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1274 for frame in emitter.send(chunk):
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1275 yield frame
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39838 diff changeset	1276
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1277 except Exception as e:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1278 for frame in createerrorframe(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1279 stream, requestid, b'%s' % e, errtype=b'server'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1280 ):
39559 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1281 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1282
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39486 diff changeset	1283 break
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1284
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1285 self._activecommands.remove(requestid)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1286
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1287 return self._handlesendframes(sendframes())
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1288
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1289 def oninputeof(self):
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1290 """Signals that end of input has been received.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1291
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1292 No more frames will be received. All pending activity should be
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1293 completed.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1294 """
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1295 # TODO should we do anything about in-flight commands?
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1296
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1297 if not self._deferoutput or not self._bufferedframegens:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1298 return b'noop', {}
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1299
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1300 # If we buffered all our responses, emit those.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1301 def makegen():
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1302 for gen in self._bufferedframegens:
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1303 yield from gen
37056 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1304
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1305 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1306 b'framegen': makegen(),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1307 }
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1308
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1309 def _handlesendframes(self, framegen):
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1310 if self._deferoutput:
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1311 self._bufferedframegens.append(framegen)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1312 return b'noop', {}
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1313 else:
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1314 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1315 b'framegen': framegen,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1316 }
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1317
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	1318 def onservererror(self, stream, requestid, msg):
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1319 ensureserverstream(stream)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37285 diff changeset	1320
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1321 def sendframes():
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1322 yield from createerrorframe(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1323 stream, requestid, msg, errtype=b'server'
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1324 )
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1325
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1326 self._activecommands.remove(requestid)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1327
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1328 return self._handlesendframes(sendframes())
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1329
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1330 def oncommanderror(self, stream, requestid, message, args=None):
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1331 """Called when a command encountered an error before sending output."""
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1332 ensureserverstream(stream)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1333
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1334 def sendframes():
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1335 yield from createcommanderrorresponse(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1336 stream, requestid, message, args
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1337 )
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1338
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1339 self._activecommands.remove(requestid)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1340
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1341 return self._handlesendframes(sendframes())
37055 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37052 diff changeset	1342
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1343 def makeoutputstream(self):
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1344 """Create a stream to be used for sending data to the client.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1345
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1346 If this is called before protocol settings frames are received, we
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1347 don't know what stream encodings are supported by the client and
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1348 we will default to identity.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1349 """
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1350 streamid = self._nextoutgoingstreamid
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1351 self._nextoutgoingstreamid += 2
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1352
40130 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1353 s = outputstream(streamid)
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1354 self._outgoingstreams[streamid] = s
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1355
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1356 # Always use the server's preferred encoder over the client's,
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1357 # as servers have more to lose from sub-optimal encoders being used.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1358 for name in STREAM_ENCODERS_ORDER:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1359 if name in self._sendersettings[b'contentencodings']:
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1360 s.setencoder(self._ui, name)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1361 break
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1362
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1363 return s
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1364
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1365 def _makeerrorresult(self, msg):
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1366 return b'error', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1367 b'message': msg,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1368 }
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1369
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1370 def _makeruncommandresult(self, requestid):
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1371 entry = self._receivingcommands[requestid]
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1372
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1373 if not entry[b'requestdone']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1374 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1375 raise error.ProgrammingError(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1376 b'should not be called without requestdone set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1377 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1378
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1379 del self._receivingcommands[requestid]
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1380
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1381 if self._receivingcommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1382 self._state = b'command-receiving'
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1383 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1384 self._state = b'idle'
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1385
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1386 # Decode the payloads as CBOR.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1387 entry[b'payload'].seek(0)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1388 request = cborutil.decodeall(entry[b'payload'].getvalue())[0]
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1389
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1390 if b'name' not in request:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1391 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1392 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1393 _(b'command request missing "name" field')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1394 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1395
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1396 if b'args' not in request:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1397 request[b'args'] = {}
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1398
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1399 assert requestid not in self._activecommands
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1400 self._activecommands.add(requestid)
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1401
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1402 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1403 b'runcommand',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1404 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1405 b'requestid': requestid,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1406 b'command': request[b'name'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1407 b'args': request[b'args'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1408 b'redirect': request.get(b'redirect'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1409 b'data': entry[b'data'].getvalue() if entry[b'data'] else None,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1410 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1411 )
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1412
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1413 def _makewantframeresult(self):
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1414 return b'wantframe', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1415 b'state': self._state,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1416 }
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1417
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1418 def _validatecommandrequestframe(self, frame):
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1419 new = frame.flags & FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1420 continuation = frame.flags & FLAG_COMMAND_REQUEST_CONTINUATION
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1421
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1422 if new and continuation:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1423 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1424 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1425 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1426 b'received command request frame with both new and '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1427 b'continuation flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1428 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1429 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1430
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1431 if not new and not continuation:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1432 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1433 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1434 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1435 b'received command request frame with neither new nor '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1436 b'continuation flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1437 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1438 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1439
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1440 def _onframeinitial(self, frame):
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1441 # Called when we receive a frame when in the "initial" state.
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1442 if frame.typeid == FRAME_TYPE_SENDER_PROTOCOL_SETTINGS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1443 self._state = b'protocol-settings-receiving'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1444 self._protocolsettingsdecoder = cborutil.bufferingdecoder()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1445 return self._onframeprotocolsettings(frame)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1446
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1447 elif frame.typeid == FRAME_TYPE_COMMAND_REQUEST:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1448 self._state = b'idle'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1449 return self._onframeidle(frame)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1450
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1451 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1452 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1453 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1454 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1455 b'expected sender protocol settings or command request '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1456 b'frame; got %d'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1457 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1458 % frame.typeid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1459 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1460
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1461 def _onframeprotocolsettings(self, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1462 assert self._state == b'protocol-settings-receiving'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1463 assert self._protocolsettingsdecoder is not None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1464
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1465 if frame.typeid != FRAME_TYPE_SENDER_PROTOCOL_SETTINGS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1466 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1467 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1468 _(b'expected sender protocol settings frame; got %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1469 % frame.typeid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1470 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1471
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1472 more = frame.flags & FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1473 eos = frame.flags & FLAG_SENDER_PROTOCOL_SETTINGS_EOS
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1474
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1475 if more and eos:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1476 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1477 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1478 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1479 b'sender protocol settings frame cannot have both '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1480 b'continuation and end of stream flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1481 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1482 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1483
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1484 if not more and not eos:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1485 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1486 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1487 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1488 b'sender protocol settings frame must have continuation or '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1489 b'end of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1490 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1491 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1492
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1493 # TODO establish limits for maximum amount of data that can be
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1494 # buffered.
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1495 try:
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1496 self._protocolsettingsdecoder.decode(frame.payload)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1497 except Exception as e:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1498 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1499 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1500 _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1501 b'error decoding CBOR from sender protocol settings frame: %s'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1502 )
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1503 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1504 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1505
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1506 if more:
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1507 return self._makewantframeresult()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1508
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1509 assert eos
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1510
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1511 decoded = self._protocolsettingsdecoder.getavailable()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1512 self._protocolsettingsdecoder = None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1513
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1514 if not decoded:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1515 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1516 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1517 _(b'sender protocol settings frame did not contain CBOR data')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1518 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1519 elif len(decoded) > 1:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1520 self._state = b'errored'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1521 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1522 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1523 b'sender protocol settings frame contained multiple CBOR '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1524 b'values'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1525 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1526 )
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1527
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1528 d = decoded[0]
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1529
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1530 if b'contentencodings' in d:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1531 self._sendersettings[b'contentencodings'] = d[b'contentencodings']
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1532
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1533 self._state = b'idle'
40126 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1534
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1535 return self._makewantframeresult()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40125 diff changeset	1536
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1537 def _onframeidle(self, frame):
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1538 # The only frame type that should be received in this state is a
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1539 # command request.
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1540 if frame.typeid != FRAME_TYPE_COMMAND_REQUEST:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1541 self._state = b'errored'
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1542 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1543 _(b'expected command request frame; got %d') % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1544 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1545
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1546 res = self._validatecommandrequestframe(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1547 if res:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1548 return res
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1549
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1550 if frame.requestid in self._receivingcommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1551 self._state = b'errored'
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1552 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1553 _(b'request with ID %d already received') % frame.requestid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1554 )
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1555
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1556 if frame.requestid in self._activecommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1557 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1558 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1559 _(b'request with ID %d is already active') % frame.requestid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1560 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1561
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1562 new = frame.flags & FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1563 moreframes = frame.flags & FLAG_COMMAND_REQUEST_MORE_FRAMES
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1564 expectingdata = frame.flags & FLAG_COMMAND_REQUEST_EXPECT_DATA
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1565
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1566 if not new:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1567 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1568 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1569 _(b'received command request frame without new flag set')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1570 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1571
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1572 payload = util.bytesio()
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1573 payload.write(frame.payload)
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1574
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1575 self._receivingcommands[frame.requestid] = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1576 b'payload': payload,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1577 b'data': None,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1578 b'requestdone': not moreframes,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1579 b'expectingdata': bool(expectingdata),
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1580 }
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1581
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1582 # This is the final frame for this request. Dispatch it.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1583 if not moreframes and not expectingdata:
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1584 return self._makeruncommandresult(frame.requestid)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1585
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1586 assert moreframes or expectingdata
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1587 self._state = b'command-receiving'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1588 return self._makewantframeresult()
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1589
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1590 def _onframecommandreceiving(self, frame):
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1591 if frame.typeid == FRAME_TYPE_COMMAND_REQUEST:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1592 # Process new command requests as such.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1593 if frame.flags & FLAG_COMMAND_REQUEST_NEW:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1594 return self._onframeidle(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1595
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1596 res = self._validatecommandrequestframe(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1597 if res:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1598 return res
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1599
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1600 # All other frames should be related to a command that is currently
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1601 # receiving but is not active.
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1602 if frame.requestid in self._activecommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1603 self._state = b'errored'
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1604 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1605 _(b'received frame for request that is still active: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1606 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1607 )
37063 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37062 diff changeset	1608
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1609 if frame.requestid not in self._receivingcommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1610 self._state = b'errored'
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1611 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1612 _(b'received frame for request that is not receiving: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1613 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1614 )
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1615
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1616 entry = self._receivingcommands[frame.requestid]
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1617
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1618 if frame.typeid == FRAME_TYPE_COMMAND_REQUEST:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1619 moreframes = frame.flags & FLAG_COMMAND_REQUEST_MORE_FRAMES
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1620 expectingdata = bool(frame.flags & FLAG_COMMAND_REQUEST_EXPECT_DATA)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1621
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1622 if entry[b'requestdone']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1623 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1624 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1625 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1626 b'received command request frame when request frames '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1627 b'were supposedly done'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1628 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1629 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1630
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1631 if expectingdata != entry[b'expectingdata']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1632 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1633 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1634 _(b'mismatch between expect data flag and previous frame')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1635 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1636
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1637 entry[b'payload'].write(frame.payload)
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1638
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1639 if not moreframes:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1640 entry[b'requestdone'] = True
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1641
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1642 if not moreframes and not expectingdata:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1643 return self._makeruncommandresult(frame.requestid)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1644
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1645 return self._makewantframeresult()
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1646
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1647 elif frame.typeid == FRAME_TYPE_COMMAND_DATA:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1648 if not entry[b'expectingdata']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1649 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1650 return self._makeerrorresult(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1651 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1652 b'received command data frame for request that is not '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1653 b'expecting data: %d'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1654 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1655 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1656 )
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1657
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1658 if entry[b'data'] is None:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1659 entry[b'data'] = util.bytesio()
37058 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37057 diff changeset	1660
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1661 return self._handlecommanddataframe(frame, entry)
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1662 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1663 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1664 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1665 _(b'received unexpected frame type: %d') % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1666 )
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1667
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1668 def _handlecommanddataframe(self, frame, entry):
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1669 assert frame.typeid == FRAME_TYPE_COMMAND_DATA
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1670
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1671 # TODO support streaming data instead of buffering it.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1672 entry[b'data'].write(frame.payload)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1673
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1674 if frame.flags & FLAG_COMMAND_DATA_CONTINUATION:
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1675 return self._makewantframeresult()
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1676 elif frame.flags & FLAG_COMMAND_DATA_EOS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1677 entry[b'data'].seek(0)
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1678 return self._makeruncommandresult(frame.requestid)
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1679 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1680 self._state = b'errored'
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1681 return self._makeerrorresult(_(b'command data frame without flags'))
37052 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37051 diff changeset	1682
37061 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1683 def _onframeerrored(self, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1684 return self._makeerrorresult(_(b'server already errored'))
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1685
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1686
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	1687 class commandrequest:
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1688 """Represents a request to run a command."""
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1689
40024 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	1690 def __init__(self, requestid, name, args, datafh=None, redirect=None):
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1691 self.requestid = requestid
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1692 self.name = name
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1693 self.args = args
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1694 self.datafh = datafh
40024 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	1695 self.redirect = redirect
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1696 self.state = b'pending'
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1697
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1698
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	1699 class clientreactor:
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1700 """Holds state of a client issuing frame-based protocol requests.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1701
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1702 This is like ``serverreactor`` but for client-side state.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1703
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1704 Each instance is bound to the lifetime of a connection. For persistent
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1705 connection transports using e.g. TCP sockets and speaking the raw
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1706 framing protocol, there will be a single instance for the lifetime of
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1707 the TCP socket. For transports where there are multiple discrete
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1708 interactions (say tunneled within in HTTP request), there will be a
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1709 separate instance for each distinct interaction.
40127 080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1710
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1711 Consumers are expected to tell instances when events occur by calling
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1712 various methods. These methods return a 2-tuple describing any follow-up
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1713 action(s) to take. The first element is the name of an action to
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1714 perform. The second is a data structure (usually a dict) specific to
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1715 that action that contains more information. e.g. if the reactor wants
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1716 to send frames to the server, the data structure will contain a reference
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1717 to those frames.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1718
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1719 Valid actions that consumers can be instructed to take are:
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1720
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1721 noop
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1722 Indicates no additional action is required.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1723
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1724 sendframes
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1725 Indicates that frames should be sent to the server. The ``framegen``
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1726 key contains a generator of frames that should be sent. The reactor
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1727 assumes that all frames in this generator are sent to the server.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1728
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1729 error
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1730 Indicates that an error occurred. The ``message`` key contains an
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1731 error message describing the failure.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1732
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1733 responsedata
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1734 Indicates a response to a previously-issued command was received.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1735
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1736 The ``request`` key contains the ``commandrequest`` instance that
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1737 represents the request this data is for.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1738
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1739 The ``data`` key contains the decoded data from the server.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1740
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1741 ``expectmore`` and ``eos`` evaluate to True when more response data
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1742 is expected to follow or we're at the end of the response stream,
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1743 respectively.
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1744 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1745
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1746 def __init__(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1747 self,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1748 ui,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1749 hasmultiplesend=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1750 buffersends=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1751 clientcontentencoders=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1752 ):
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1753 """Create a new instance.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1754
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1755 ``hasmultiplesend`` indicates whether multiple sends are supported
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1756 by the transport. When True, it is possible to send commands immediately
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1757 instead of buffering until the caller signals an intent to finish a
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1758 send operation.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1759
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1760 ``buffercommands`` indicates whether sends should be buffered until the
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1761 last request has been issued.
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1762
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1763 ``clientcontentencoders`` is an iterable of content encoders the client
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1764 will advertise to the server and that the server can use for encoding
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1765 data. If not defined, the client will not advertise content encoders
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1766 to the server.
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1767 """
40129 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1768 self._ui = ui
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1769 self._hasmultiplesend = hasmultiplesend
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1770 self._buffersends = buffersends
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1771 self._clientcontentencoders = clientcontentencoders
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1772
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1773 self._canissuecommands = True
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1774 self._cansend = True
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1775 self._protocolsettingssent = False
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1776
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1777 self._nextrequestid = 1
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1778 # We only support a single outgoing stream for now.
40130 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1779 self._outgoingstream = outputstream(1)
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1780 self._pendingrequests = collections.deque()
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1781 self._activerequests = {}
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1782 self._incomingstreams = {}
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1783 self._streamsettingsdecoders = {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1784
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1785 populatestreamencoders()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1786
40024 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40020 diff changeset	1787 def callcommand(self, name, args, datafh=None, redirect=None):
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1788 """Request that a command be executed.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1789
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1790 Receives the command name, a dict of arguments to pass to the command,
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1791 and an optional file object containing the raw data for the command.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1792
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1793 Returns a 3-tuple of (request, action, action data).
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1794 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1795 if not self._canissuecommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1796 raise error.ProgrammingError(b'cannot issue new commands')
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1797
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1798 requestid = self._nextrequestid
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1799 self._nextrequestid += 2
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1800
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1801 request = commandrequest(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1802 requestid, name, args, datafh=datafh, redirect=redirect
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1803 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1804
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1805 if self._buffersends:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1806 self._pendingrequests.append(request)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1807 return request, b'noop', {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1808 else:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1809 if not self._cansend:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1810 raise error.ProgrammingError(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1811 b'sends cannot be performed on this instance'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1812 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1813
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1814 if not self._hasmultiplesend:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1815 self._cansend = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1816 self._canissuecommands = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1817
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1818 return (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1819 request,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1820 b'sendframes',
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1821 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1822 b'framegen': self._makecommandframes(request),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1823 },
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1824 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1825
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1826 def flushcommands(self):
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1827 """Request that all queued commands be sent.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1828
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1829 If any commands are buffered, this will instruct the caller to send
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1830 them over the wire. If no commands are buffered it instructs the client
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1831 to no-op.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1832
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1833 If instances aren't configured for multiple sends, no new command
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1834 requests are allowed after this is called.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1835 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1836 if not self._pendingrequests:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1837 return b'noop', {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1838
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1839 if not self._cansend:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1840 raise error.ProgrammingError(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1841 b'sends cannot be performed on this instance'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1842 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1843
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1844 # If the instance only allows sending once, mark that we have fired
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1845 # our one shot.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1846 if not self._hasmultiplesend:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1847 self._canissuecommands = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1848 self._cansend = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1849
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1850 def makeframes():
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1851 while self._pendingrequests:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1852 request = self._pendingrequests.popleft()
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1853 yield from self._makecommandframes(request)
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1854
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1855 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1856 b'framegen': makeframes(),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1857 }
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1858
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1859 def _makecommandframes(self, request):
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1860 """Emit frames to issue a command request.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1861
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1862 As a side-effect, update request accounting to reflect its changed
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1863 state.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1864 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1865 self._activerequests[request.requestid] = request
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1866 request.state = b'sending'
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1867
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1868 if not self._protocolsettingssent and self._clientcontentencoders:
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1869 self._protocolsettingssent = True
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1870
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1871 payload = b''.join(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1872 cborutil.streamencode(
45942 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1873 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1874 b'contentencodings': self._clientcontentencoders,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43506 diff changeset	1875 }
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1876 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1877 )
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1878
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1879 yield self._outgoingstream.makeframe(
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1880 requestid=request.requestid,
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1881 typeid=FRAME_TYPE_SENDER_PROTOCOL_SETTINGS,
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1882 flags=FLAG_SENDER_PROTOCOL_SETTINGS_EOS,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1883 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1884 )
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1885
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1886 res = createcommandframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1887 self._outgoingstream,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1888 request.requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1889 request.name,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1890 request.args,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1891 datafh=request.datafh,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1892 redirect=request.redirect,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1893 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1894
52644 e627cc25b6f3 pyupgrade: rewrite `yield` statements in a loop to `yield from` Matt Harbison <matt_harbison@yahoo.com> parents: 52643 diff changeset	1895 yield from res
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1896
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1897 request.state = b'sent'
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1898
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1899 def onframerecv(self, frame):
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1900 """Process a frame that has been received off the wire.
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1901
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1902 Returns a 2-tuple of (action, meta) describing further action the
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1903 caller needs to take as a result of receiving this frame.
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1904 """
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1905 if frame.streamid % 2:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1906 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1907 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1908 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1909 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1910 _(b'received frame with odd numbered stream ID: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1911 % frame.streamid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1912 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1913 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1914 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1915
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1916 if frame.streamid not in self._incomingstreams:
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1917 if not frame.streamflags & STREAM_FLAG_BEGIN_STREAM:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1918 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1919 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1920 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1921 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1922 b'received frame on unknown stream '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1923 b'without beginning of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1924 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1925 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1926 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1927
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1928 self._incomingstreams[frame.streamid] = inputstream(frame.streamid)
37656 e6870bca1f47 wireprotoframing: record when new stream is encountered Gregory Szorc <gregory.szorc@gmail.com> parents: 37655 diff changeset	1929
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1930 stream = self._incomingstreams[frame.streamid]
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1931
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1932 # If the payload is encoded, ask the stream to decode it. We
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1933 # merely substitute the decoded result into the frame payload as
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1934 # if it had been transferred all along.
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1935 if frame.streamflags & STREAM_FLAG_ENCODING_APPLIED:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1936 frame.payload = stream.decode(frame.payload)
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1937
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1938 if frame.streamflags & STREAM_FLAG_END_STREAM:
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1939 del self._incomingstreams[frame.streamid]
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1940
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1941 if frame.typeid == FRAME_TYPE_STREAM_SETTINGS:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1942 return self._onstreamsettingsframe(frame)
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1943
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1944 if frame.requestid not in self._activerequests:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1945 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1946 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1947 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1948 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1949 _(b'received frame for inactive request ID: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1950 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1951 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1952 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1953 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1954
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1955 request = self._activerequests[frame.requestid]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1956 request.state = b'receiving'
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1957
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1958 handlers = {
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	1959 FRAME_TYPE_COMMAND_RESPONSE: self._oncommandresponseframe,
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	1960 FRAME_TYPE_ERROR_RESPONSE: self._onerrorresponseframe,
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1961 }
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1962
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1963 meth = handlers.get(frame.typeid)
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1964 if not meth:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1965 raise error.ProgrammingError(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1966 b'unhandled frame type: %d' % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1967 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1968
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1969 return meth(request, frame)
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1970
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1971 def _onstreamsettingsframe(self, frame):
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1972 assert frame.typeid == FRAME_TYPE_STREAM_SETTINGS
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1973
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1974 more = frame.flags & FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1975 eos = frame.flags & FLAG_STREAM_ENCODING_SETTINGS_EOS
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1976
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1977 if more and eos:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1978 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1979 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1980 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1981 b'message': (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1982 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1983 b'stream encoding settings frame cannot have both '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1984 b'continuation and end of stream flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1985 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1986 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1987 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1988 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1989
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1990 if not more and not eos:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1991 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1992 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1993 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1994 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1995 b'stream encoding settings frame must have '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1996 b'continuation or end of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1997 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1998 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1999 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2000
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2001 if frame.streamid not in self._streamsettingsdecoders:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2002 decoder = cborutil.bufferingdecoder()
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2003 self._streamsettingsdecoders[frame.streamid] = decoder
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2004
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2005 decoder = self._streamsettingsdecoders[frame.streamid]
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2006
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2007 try:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2008 decoder.decode(frame.payload)
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2009 except Exception as e:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2010 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2011 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2012 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2013 b'message': (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2014 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2015 b'error decoding CBOR from stream encoding '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2016 b'settings frame: %s'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2017 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2018 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2019 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2020 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2021 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2022
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2023 if more:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2024 return b'noop', {}
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2025
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2026 assert eos
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2027
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2028 decoded = decoder.getavailable()
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2029 del self._streamsettingsdecoders[frame.streamid]
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2030
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2031 if not decoded:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2032 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2033 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2034 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2035 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2036 b'stream encoding settings frame did not contain '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2037 b'CBOR data'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2038 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2039 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2040 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2041
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2042 try:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2043 self._incomingstreams[frame.streamid].setdecoder(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2044 self._ui, decoded[0], decoded[1:]
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2045 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2046 except Exception as e:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2047 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2048 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2049 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2050 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2051 _(b'error setting stream decoder: %s')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2052 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2053 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2054 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2055 )
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2056
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2057 return b'noop', {}
40128 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	2058
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	2059 def _oncommandresponseframe(self, request, frame):
deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	2060 if frame.flags & FLAG_COMMAND_RESPONSE_EOS:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2061 request.state = b'received'
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	2062 del self._activerequests[request.requestid]
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	2063
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2064 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2065 b'responsedata',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2066 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2067 b'request': request,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2068 b'expectmore': frame.flags & FLAG_COMMAND_RESPONSE_CONTINUATION,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2069 b'eos': frame.flags & FLAG_COMMAND_RESPONSE_EOS,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2070 b'data': frame.payload,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2071 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2072 )
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2073
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2074 def _onerrorresponseframe(self, request, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2075 request.state = b'errored'
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2076 del self._activerequests[request.requestid]
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2077
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2078 # The payload should be a CBOR map.
39446 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	2079 m = cborutil.decodeall(frame.payload)[0]
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2080
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2081 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2082 b'error',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2083 {
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2084 b'request': request,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2085 b'type': m[b'type'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2086 b'message': m[b'message'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2087 },
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2088 )

Mercurial > public > mercurial-scm > hg

annotate mercurial/wireprotoframing.py @ 52644:e627cc25b6f3