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

annotate mercurial/wireprotoframing.py @ 51788:278af66e6595

typing: induce pytype to use the standard `attr` instead of the vendored copy What was previously happening with the vendored copy was that pytype would stub out all(?) classes that were decorated with `@attr.s` as `Any`. After this, we get a ton of classes defined, and numerous fields and methods now have proper types.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Tue, 23 Jul 2024 19:20:22 -0400
parents	ca7bde5dbafb
children	f4733654f144

rev	line source
37054 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
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	12
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	13 import collections
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	14 import struct
51788 278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51762 diff changeset	15 import typing
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	16
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	17 from .i18n import _
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	18 from .thirdparty import attr
51788 278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51762 diff changeset	19
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51762 diff changeset	20 # 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: 51762 diff changeset	21 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: 51762 diff changeset	22 # noinspection PyPackageRequirements
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51762 diff changeset	23 import attr
278af66e6595 typing: induce pytype to use the standard `attr` instead of the vendored copy Matt Harbison <matt_harbison@yahoo.com> parents: 51762 diff changeset	24
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	25 from . import (
37474 d33997123ea5 py3: system-stringify repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37473 diff changeset	26 encoding,
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	27 error,
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	28 pycompat,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	29 util,
40021 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 diff changeset	30 wireprototypes,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	31 )
37087 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37066 diff changeset	32 from .utils import (
39465 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	33 cborutil,
37087 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37066 diff changeset	34 stringutil,
f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37066 diff changeset	35 )
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	37 FRAME_HEADER_SIZE = 8
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	38 DEFAULT_MAX_FRAME_SIZE = 32768
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	40 STREAM_FLAG_BEGIN_STREAM = 0x01
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	41 STREAM_FLAG_END_STREAM = 0x02
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	42 STREAM_FLAG_ENCODING_APPLIED = 0x04
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	43
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	44 STREAM_FLAGS = {
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	45 b'stream-begin': STREAM_FLAG_BEGIN_STREAM,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	46 b'stream-end': STREAM_FLAG_END_STREAM,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	47 b'encoded': STREAM_FLAG_ENCODING_APPLIED,
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	48 }
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	49
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	50 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	51 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	52 FRAME_TYPE_COMMAND_RESPONSE = 0x03
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	53 FRAME_TYPE_ERROR_RESPONSE = 0x05
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	54 FRAME_TYPE_TEXT_OUTPUT = 0x06
37291 b0041036214e wireproto: define frame to represent progress updates Gregory Szorc <gregory.szorc@gmail.com> parents: 37290 diff changeset	55 FRAME_TYPE_PROGRESS = 0x07
40126 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	56 FRAME_TYPE_SENDER_PROTOCOL_SETTINGS = 0x08
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	57 FRAME_TYPE_STREAM_SETTINGS = 0x09
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	58
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59 FRAME_TYPES = {
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	60 b'command-request': FRAME_TYPE_COMMAND_REQUEST,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	61 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	62 b'command-response': FRAME_TYPE_COMMAND_RESPONSE,
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	63 b'error-response': FRAME_TYPE_ERROR_RESPONSE,
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	64 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	65 b'progress': FRAME_TYPE_PROGRESS,
40126 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	66 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: 37287 diff changeset	67 b'stream-settings': FRAME_TYPE_STREAM_SETTINGS,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	68 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	69
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	70 FLAG_COMMAND_REQUEST_NEW = 0x01
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	71 FLAG_COMMAND_REQUEST_CONTINUATION = 0x02
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	72 FLAG_COMMAND_REQUEST_MORE_FRAMES = 0x04
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	73 FLAG_COMMAND_REQUEST_EXPECT_DATA = 0x08
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	74
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	75 FLAGS_COMMAND_REQUEST = {
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	76 b'new': FLAG_COMMAND_REQUEST_NEW,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	77 b'continuation': FLAG_COMMAND_REQUEST_CONTINUATION,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	78 b'more': FLAG_COMMAND_REQUEST_MORE_FRAMES,
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	79 b'have-data': FLAG_COMMAND_REQUEST_EXPECT_DATA,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	80 }
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 FLAG_COMMAND_DATA_CONTINUATION = 0x01
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	83 FLAG_COMMAND_DATA_EOS = 0x02
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	84
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85 FLAGS_COMMAND_DATA = {
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86 b'continuation': FLAG_COMMAND_DATA_CONTINUATION,
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 b'eos': FLAG_COMMAND_DATA_EOS,
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	88 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	89
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	90 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	91 FLAG_COMMAND_RESPONSE_EOS = 0x02
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	92
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	93 FLAGS_COMMAND_RESPONSE = {
deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	94 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	95 b'eos': FLAG_COMMAND_RESPONSE_EOS,
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	96 }
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	97
40126 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	98 FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION = 0x01
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	99 FLAG_SENDER_PROTOCOL_SETTINGS_EOS = 0x02
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	100
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	101 FLAGS_SENDER_PROTOCOL_SETTINGS = {
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	102 b'continuation': FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	103 b'eos': FLAG_SENDER_PROTOCOL_SETTINGS_EOS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	104 }
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	105
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	106 FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION = 0x01
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	107 FLAG_STREAM_ENCODING_SETTINGS_EOS = 0x02
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	108
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	109 FLAGS_STREAM_ENCODING_SETTINGS = {
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	110 b'continuation': FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	111 b'eos': FLAG_STREAM_ENCODING_SETTINGS_EOS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	112 }
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	113
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	114 # 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	115 FRAME_TYPE_FLAGS = {
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	116 FRAME_TYPE_COMMAND_REQUEST: FLAGS_COMMAND_REQUEST,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	117 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	118 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	119 FRAME_TYPE_ERROR_RESPONSE: {},
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	120 FRAME_TYPE_TEXT_OUTPUT: {},
37291 b0041036214e wireproto: define frame to represent progress updates Gregory Szorc <gregory.szorc@gmail.com> parents: 37290 diff changeset	121 FRAME_TYPE_PROGRESS: {},
40126 e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	122 FRAME_TYPE_SENDER_PROTOCOL_SETTINGS: FLAGS_SENDER_PROTOCOL_SETTINGS,
e2fe1074024c wireprotov2: update stream encoding specification Gregory Szorc <gregory.szorc@gmail.com> parents: 40026 diff changeset	123 FRAME_TYPE_STREAM_SETTINGS: FLAGS_STREAM_ENCODING_SETTINGS,
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	124 }
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	125
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	126 ARGUMENT_RECORD_HEADER = struct.Struct('<HH')
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	127
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	128
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	129 def humanflags(mapping, value):
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	130 """Convert a numeric flags value to a human value, using a mapping table."""
49004 f254fc73d956 global: bulk replace simple pycompat.iteritems(x) with x.items() Gregory Szorc <gregory.szorc@gmail.com> parents: 48991 diff changeset	131 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	132 flags = []
37473 7c2c7c749411 wireproto: show unknown id and flags in repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37472 diff changeset	133 val = 1
7c2c7c749411 wireproto: show unknown id and flags in repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37472 diff changeset	134 while value >= val:
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	135 if value & val:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	136 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	137 val <<= 1
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	138
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	139 return b'\|'.join(flags)
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	140
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	141
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	142 @attr.s(slots=True)
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	143 class frameheader:
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	144 """Represents the data in a frame header."""
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	145
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	146 length = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	147 requestid = attr.ib()
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	148 streamid = attr.ib()
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	149 streamflags = attr.ib()
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	150 typeid = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	151 flags = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	152
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	153
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	154 @attr.s(slots=True, repr=False)
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	155 class frame:
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	156 """Represents a parsed frame."""
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	157
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	158 requestid = attr.ib()
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	159 streamid = attr.ib()
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	160 streamflags = attr.ib()
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	161 typeid = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	162 flags = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	163 payload = attr.ib()
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	164
37474 d33997123ea5 py3: system-stringify repr(frame) Yuya Nishihara <yuya@tcha.org> parents: 37473 diff changeset	165 @encoding.strmethod
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	166 def __repr__(self):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	167 typename = b'<unknown 0x%02x>' % self.typeid
49004 f254fc73d956 global: bulk replace simple pycompat.iteritems(x) with x.items() Gregory Szorc <gregory.szorc@gmail.com> parents: 48991 diff changeset	168 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	169 if value == self.typeid:
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	170 typename = name
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	171 break
5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	172
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	173 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	174 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	175 b'type=%s; flags=%s)'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	176 % (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	177 len(self.payload),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	178 self.requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	179 self.streamid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	180 humanflags(STREAM_FLAGS, self.streamflags),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	181 typename,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	182 humanflags(FRAME_TYPE_FLAGS.get(self.typeid, {}), self.flags),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	183 )
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
37298 5ef2da00e935 wireproto: implement custom __repr__ for frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37292 diff changeset	186
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	187 def makeframe(requestid, streamid, streamflags, typeid, flags, payload):
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188 """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	189 # TODO assert size of payload.
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 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	191
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	192 # 24 bits length
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	193 # 16 bits request id
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	194 # 8 bits stream id
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	195 # 8 bits stream flags
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	196 # 4 bits type
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	197 # 4 bits flags
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	198
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	199 l = struct.pack('<I', len(payload))
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	200 frame[0:3] = l[0:3]
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	201 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: 37287 diff changeset	202 frame[7] = (typeid << 4) \| flags
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	203 frame[8:] = payload
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	204
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	205 return frame
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	206
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	207
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	208 def makeframefromhumanstring(s):
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	209 """Create a frame from a human readable string
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	210
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	211 Strings have the form:
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	212
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	213 <request-id> <stream-id> <stream-flags> <type> <flags> <payload>
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	214
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	215 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	216 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	217
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	218 Request ID and stream IDs are integers.
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	219
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	220 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: 37287 diff changeset	221 named constant.
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	222
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	223 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	224
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	225 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	226 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	227 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	228 byte string literal.
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	229 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	230 fields = s.split(b' ', 5)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	231 requestid, streamid, streamflags, frametype, frameflags, payload = fields
37060 2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	232
2ec1fb9de638 wireproto: add request IDs to frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37059 diff changeset	233 requestid = int(requestid)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	234 streamid = int(streamid)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	235
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	236 finalstreamflags = 0
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	237 for flag in streamflags.split(b'\|'):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	238 if flag in STREAM_FLAGS:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	239 finalstreamflags \|= STREAM_FLAGS[flag]
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	240 else:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	241 finalstreamflags \|= int(flag)
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	242
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	243 if frametype in FRAME_TYPES:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	244 frametype = FRAME_TYPES[frametype]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	245 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	246 frametype = int(frametype)
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	247
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	248 finalflags = 0
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	249 validflags = FRAME_TYPE_FLAGS[frametype]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	250 for flag in frameflags.split(b'\|'):
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	251 if flag in validflags:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	252 finalflags \|= validflags[flag]
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	253 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	254 finalflags \|= int(flag)
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	255
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	256 if payload.startswith(b'cbor:'):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	257 payload = b''.join(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	258 cborutil.streamencode(stringutil.evalpythonliteral(payload[5:]))
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	259 )
37290 cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	260
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	261 else:
cc5a040fe150 wireproto: syntax for encoding CBOR into frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37289 diff changeset	262 payload = stringutil.unescapestr(payload)
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	263
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	264 return makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	265 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	266 streamid=streamid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	267 streamflags=finalstreamflags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	268 typeid=frametype,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	269 flags=finalflags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	270 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	271 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	272
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	273
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	274 def parseheader(data):
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	275 """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: 37054 diff changeset	276
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	277 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: 37054 diff changeset	278 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: 37054 diff changeset	279 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	280 # 24 bits payload length (little endian)
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	281 # 16 bits request ID
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	282 # 8 bits stream ID
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	283 # 8 bits stream flags
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	284 # 4 bits frame type
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	285 # 4 bits frame flags
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	286 # ... payload
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	287 framelength = data[0] + 256 * data[1] + 16384 * data[2]
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	288 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: 37287 diff changeset	289 typeflags = data[7]
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	290
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	291 frametype = (typeflags & 0xF0) >> 4
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	292 frameflags = typeflags & 0x0F
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	293
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	294 return frameheader(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	295 framelength, requestid, streamid, streamflags, frametype, frameflags
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	296 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	297
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	298
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	299 def readframe(fh):
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	300 """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: 37054 diff changeset	301
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	302 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: 37054 diff changeset	303 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: 37054 diff changeset	304 seen.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	305 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	306 header = bytearray(FRAME_HEADER_SIZE)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	307
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	308 readcount = fh.readinto(header)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	309
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	310 if readcount == 0:
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	311 return None
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	312
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	313 if readcount != FRAME_HEADER_SIZE:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	314 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	315 _(b'received incomplete frame: got %d bytes: %s')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	316 % (readcount, header)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	317 )
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	318
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	319 h = parseheader(header)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	320
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	321 payload = fh.read(h.length)
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	322 if len(payload) != h.length:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	323 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	324 _(b'frame length error: expected %d; got %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	325 % (h.length, len(payload))
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	326 )
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 return frame(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	329 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	330 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	331
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	332
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	333 def createcommandframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	334 stream,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	335 requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	336 cmd,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	337 args,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	338 datafh=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	339 maxframesize=DEFAULT_MAX_FRAME_SIZE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	340 redirect=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	341 ):
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	342 """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	343
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344 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	345 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	346 """
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	347 data = {b'name': cmd}
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	348 if args:
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	349 data[b'args'] = args
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	350
40025 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	351 if redirect:
86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	352 data[b'redirect'] = redirect
86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	353
39465 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	354 data = b''.join(cborutil.streamencode(data))
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	355
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	356 offset = 0
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	357
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	358 while True:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	359 flags = 0
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	360
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	361 # Must set new or continuation flag.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	362 if not offset:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	363 flags \|= FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	364 else:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	365 flags \|= FLAG_COMMAND_REQUEST_CONTINUATION
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	366
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	367 # Data frames is set on all frames.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	368 if datafh:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	369 flags \|= FLAG_COMMAND_REQUEST_EXPECT_DATA
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	370
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	371 payload = data[offset : offset + maxframesize]
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	372 offset += len(payload)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	373
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	374 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	375 flags \|= FLAG_COMMAND_REQUEST_MORE_FRAMES
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	376
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	377 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	378 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	379 typeid=FRAME_TYPE_COMMAND_REQUEST,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	380 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	381 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	382 )
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	383
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	384 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	385 break
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	386
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	387 if datafh:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	388 while True:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 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	390
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391 done = False
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 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	393 flags = FLAG_COMMAND_DATA_CONTINUATION
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	394 else:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	395 flags = FLAG_COMMAND_DATA_EOS
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	396 assert datafh.read(1) == b''
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	397 done = True
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	399 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	400 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	401 typeid=FRAME_TYPE_COMMAND_DATA,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	402 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	403 payload=data,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	404 )
37054 40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	405
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	406 if done:
40206e227412 wireproto: define and implement protocol for issuing requests Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 break
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	408
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	409
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	410 def createcommandresponseokframe(stream, requestid):
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	411 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: 39503 diff changeset	412
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	413 if stream.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	414 overall = stream.encode(overall)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	415 encoded = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	416
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	417 if not overall:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	418 return None
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	419 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	420 encoded = False
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	421
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	422 return stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	423 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	424 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	425 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	426 payload=overall,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	427 encoded=encoded,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	428 )
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	429
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	430
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	431 def createcommandresponseeosframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	432 stream, requestid, maxframesize=DEFAULT_MAX_FRAME_SIZE
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	433 ):
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	434 """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	435 payload = stream.flush()
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	436
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	437 offset = 0
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	438 while True:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	439 chunk = payload[offset : offset + maxframesize]
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	440 offset += len(chunk)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	441
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	442 done = offset == len(payload)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	443
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	444 if done:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	445 flags = FLAG_COMMAND_RESPONSE_EOS
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	446 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	447 flags = FLAG_COMMAND_RESPONSE_CONTINUATION
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	448
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	449 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	450 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	451 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	452 flags=flags,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	453 payload=chunk,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	454 encoded=payload != b'',
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	455 )
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	456
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	457 if done:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	458 break
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	459
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	460
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	461 def createalternatelocationresponseframe(stream, requestid, location):
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	462 data = {
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	463 b'status': b'redirect',
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	464 b'location': {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	465 b'url': location.url,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	466 b'mediatype': location.mediatype,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	467 },
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	468 }
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	469
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	470 for a in (
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	471 'size',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	472 'fullhashes',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	473 'fullhashseed',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	474 'serverdercerts',
9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	475 'servercadercerts',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	476 ):
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	477 value = getattr(location, a)
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	478 if value is not None:
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	479 data[b'location'][pycompat.bytestr(a)] = value
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	480
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	481 payload = b''.join(cborutil.streamencode(data))
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	482
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	483 if stream.streamsettingssent:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	484 payload = stream.encode(payload)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	485 encoded = True
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	486 else:
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	487 encoded = False
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	488
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	489 return stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	490 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	491 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	492 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	493 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	494 encoded=encoded,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	495 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	496
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	497
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	498 def createcommanderrorresponse(stream, requestid, message, args=None):
39503 43d92d68ac88 wireprotov2peer: properly format errors Gregory Szorc <gregory.szorc@gmail.com> parents: 39465 diff changeset	499 # TODO should this be using a list of {'msg': ..., 'args': {}} so atom
43d92d68ac88 wireprotov2peer: properly format errors Gregory Szorc <gregory.szorc@gmail.com> parents: 39465 diff changeset	500 # formatting works consistently?
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	501 m = {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	502 b'status': b'error',
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	503 b'error': {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	504 b'message': message,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	505 },
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	506 }
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	507
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	508 if args:
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	509 m[b'error'][b'args'] = args
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	510
39465 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	511 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	512
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	513 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	514 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	515 typeid=FRAME_TYPE_COMMAND_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	516 flags=FLAG_COMMAND_RESPONSE_EOS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	517 payload=overall,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	518 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	519
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	520
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	521 def createerrorframe(stream, requestid, msg, errtype):
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	522 # TODO properly handle frame size limits.
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	523 assert len(msg) <= DEFAULT_MAX_FRAME_SIZE
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	524
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	525 payload = b''.join(
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	526 cborutil.streamencode(
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	527 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	528 b'type': errtype,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	529 b'message': [{b'msg': msg}],
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	530 }
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	531 )
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	532 )
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	533
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	534 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	535 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	536 typeid=FRAME_TYPE_ERROR_RESPONSE,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	537 flags=0,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	538 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	539 )
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	540
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	541
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	542 def createtextoutputframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	543 stream, requestid, atoms, maxframesize=DEFAULT_MAX_FRAME_SIZE
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	544 ):
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	545 """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: 37061 diff changeset	546
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	547 ``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: 37061 diff changeset	548
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	549 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: 37061 diff changeset	550 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: 37061 diff changeset	551 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: 37061 diff changeset	552 class, each atom corresponds to a ``ui.write()``.
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	553 """
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	554 atomdicts = []
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	555
51762 ca7bde5dbafb black: format the codebase with 23.3.0 Rapha?l Gom?s <rgomes@octobus.net> parents: 51759 diff changeset	556 for formatting, args, labels in atoms:
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	557 # TODO look for localstr, other types here?
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	558
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	559 if not isinstance(formatting, bytes):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	560 raise ValueError(b'must use bytes formatting strings')
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	561 for arg in args:
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	562 if not isinstance(arg, 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 for arguments')
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	564 for label in labels:
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	565 if not isinstance(label, 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 labels')
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	567
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	568 # Formatting string must be ASCII.
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	569 formatting = formatting.decode('ascii', 'replace').encode('ascii')
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	570
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	571 # Arguments must be UTF-8.
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	572 args = [a.decode('utf-8', 'replace').encode('utf-8') for a in args]
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	573
0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	574 # Labels must be ASCII.
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	575 labels = [l.decode('ascii', 'strict').encode('ascii') for l in labels]
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	576
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	577 atom = {b'msg': formatting}
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	578 if args:
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	579 atom[b'args'] = args
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	580 if labels:
36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	581 atom[b'labels'] = labels
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	582
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	583 atomdicts.append(atom)
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	584
39465 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	585 payload = b''.join(cborutil.streamencode(atomdicts))
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	586
37319 36d17f37db91 wireproto: convert human output frames to CBOR Gregory Szorc <gregory.szorc@gmail.com> parents: 37299 diff changeset	587 if len(payload) > maxframesize:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	588 raise ValueError(b'cannot encode data in a single frame')
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	589
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	590 yield stream.makeframe(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	591 requestid=requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	592 typeid=FRAME_TYPE_TEXT_OUTPUT,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	593 flags=0,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	594 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	595 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	596
37287 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37087 diff changeset	597
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	598 class bufferingcommandresponseemitter:
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	599 """Helper object to emit command response frames intelligently.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	600
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	601 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: 39575 diff changeset	602 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: 39575 diff changeset	603 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: 39575 diff changeset	604
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	605 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: 39575 diff changeset	606 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: 39575 diff changeset	607 level.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	608 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	609
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	610 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: 39575 diff changeset	611 self._stream = stream
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	612 self._requestid = requestid
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	613 self._maxsize = maxframesize
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	614 self._chunks = []
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	615 self._chunkssize = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	616
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	617 def send(self, data):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	618 """Send new data for emission.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	619
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	620 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: 39575 diff changeset	621
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	622 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: 39575 diff changeset	623 data to frames.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	624 """
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	625
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	626 if data is None:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	627 for frame in self._flush():
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	628 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	629 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	630
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	631 data = self._stream.encode(data)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	632
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	633 # 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: 39575 diff changeset	634 # 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: 39575 diff changeset	635 # 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: 39575 diff changeset	636 # a simple implementation:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	637 #
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	638 # * 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: 39575 diff changeset	639 # for the new chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	640 # * 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: 39575 diff changeset	641 # being exceeded, we do that.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	642 # * 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: 39575 diff changeset	643 # and then buffer the new chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	644
40136 3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	645 if not data:
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	646 return
3a6d6c54bd81 wireprotov2: don't emit empty frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40135 diff changeset	647
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	648 if len(data) > self._maxsize:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	649 for frame in self._flush():
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	650 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	651
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	652 # Now emit frames for the big chunk.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	653 offset = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	654 while True:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	655 chunk = data[offset : offset + self._maxsize]
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	656 offset += len(chunk)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	657
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	658 yield self._stream.makeframe(
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	659 self._requestid,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	660 typeid=FRAME_TYPE_COMMAND_RESPONSE,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	661 flags=FLAG_COMMAND_RESPONSE_CONTINUATION,
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	662 payload=chunk,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	663 encoded=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	664 )
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	665
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	666 if offset == len(data):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	667 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	668
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	669 # 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: 39575 diff changeset	670 # return.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	671 if len(data) + self._chunkssize < self._maxsize:
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	672 self._chunks.append(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	673 self._chunkssize += len(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	674 return
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	675
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	676 # 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: 39575 diff changeset	677 # 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: 39575 diff changeset	678 # keep things simple for now.
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	679 for frame in self._flush():
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	680 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	681
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	682 self._chunks.append(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	683 self._chunkssize = len(data)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	684
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	685 def _flush(self):
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	686 payload = b''.join(self._chunks)
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	687 assert len(payload) <= self._maxsize
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	688
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	689 self._chunks[:] = []
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	690 self._chunkssize = 0
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 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
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	695 yield self._stream.makeframe(
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	696 self._requestid,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	697 typeid=FRAME_TYPE_COMMAND_RESPONSE,
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 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
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	703
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	705 # mechanism.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	706
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	707
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	708 class identityencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	711 def __init__(self, ui):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	712 pass
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	713
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	714 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	715 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	716
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	717 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	718 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	719
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	720 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	721 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	722
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	723
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	724 class identitydecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	725 """Decoder for the "identity" stream encoding profile."""
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	726
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	727 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	732
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	733 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	734 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	735
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	736
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	737 class zlibencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	738 def __init__(self, ui):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	741 self._zlib = zlib
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	742 self._compressor = zlib.compressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	743
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	744 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	745 return self._compressor.compress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	746
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	747 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	749 # what we want.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	751
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	752 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	754 self._compressor = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	755 return res
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	756
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	757
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	758 class zlibdecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	759 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	760 import zlib
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	761
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	766
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	767 self._decompressor = zlib.decompressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	768
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	769 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	770 return self._decompressor.decompress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	771
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	772
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	773 class zstdbaseencoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	774 def __init__(self, level):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	775 from . import zstd
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	776
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	777 self._zstd = zstd
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	778 cctx = zstd.ZstdCompressor(level=level)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	779 self._compressor = cctx.compressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	780
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	781 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	782 return self._compressor.compress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	783
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	784 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 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: 40131 diff changeset	787 # up to this point.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	789
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	790 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	792 self._compressor = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	793 return res
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	796 class zstd8mbencoder(zstdbaseencoder):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	797 def __init__(self, ui):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	798 super(zstd8mbencoder, self).__init__(3)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	799
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	800
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	801 class zstdbasedecoder:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	802 def __init__(self, maxwindowsize):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	803 from . import zstd
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: 40131 diff changeset	805 dctx = zstd.ZstdDecompressor(max_window_size=maxwindowsize)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	806 self._decompressor = dctx.decompressobj()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	807
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	808 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	809 return self._decompressor.decompress(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	812 class zstd8mbdecoder(zstdbasedecoder):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	813 def __init__(self, ui, extraobjs):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	818
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	819 super(zstd8mbdecoder, self).__init__(maxwindowsize=8 * 1048576)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 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: 40131 diff changeset	823 # this module.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	824 STREAM_ENCODERS = {}
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	825 STREAM_ENCODERS_ORDER = []
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	828 def populatestreamencoders():
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	829 if STREAM_ENCODERS:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	830 return
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	831
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	832 try:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	833 from . import zstd
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: 40131 diff changeset	835 zstd.__version__
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	836 except ImportError:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	837 zstd = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	838
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	839 # zstandard is fastest and is preferred.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	840 if zstd:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	841 STREAM_ENCODERS[b'zstd-8mb'] = (zstd8mbencoder, zstd8mbdecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	842 STREAM_ENCODERS_ORDER.append(b'zstd-8mb')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	843
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	844 STREAM_ENCODERS[b'zlib'] = (zlibencoder, zlibdecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	845 STREAM_ENCODERS_ORDER.append(b'zlib')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	846
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	847 STREAM_ENCODERS[b'identity'] = (identityencoder, identitydecoder)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	848 STREAM_ENCODERS_ORDER.append(b'identity')
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	849
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	850
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	851 class stream:
37287 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37087 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: 37087 diff changeset	853
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	854 def __init__(self, streamid, active=False):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 diff changeset	857
37287 3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37087 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: 37087 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: 37087 diff changeset	860
3ed344546d9e wireproto: start to associate frame generation with a stream Gregory Szorc <gregory.szorc@gmail.com> parents: 37087 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: 37087 diff changeset	862 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	863 streamflags = 0
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	864 if not self._active:
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	865 streamflags \|= STREAM_FLAG_BEGIN_STREAM
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	866 self._active = True
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 diff changeset	872
40131 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	873 class inputstream(stream):
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 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: 40130 diff changeset	875
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	876 def __init__(self, streamid, active=False):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	877 super(inputstream, self).__init__(streamid, active=active)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	878 self._decoder = None
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	879
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	880 def setdecoder(self, ui, name, extraobjs):
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	881 """Set the decoder for this stream.
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	882
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 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: 40128 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: 40128 diff changeset	885 """
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	888
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	890
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	891 def decode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	893 # because it is trivial.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	894 if not self._decoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	895 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	896
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	897 return self._decoder.decode(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	898
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	899 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	900 if not self._decoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	901 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	902
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	903 return self._decoder.flush()
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	904
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	905
40131 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	906 class outputstream(stream):
5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 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: 40130 diff changeset	908
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	909 def __init__(self, streamid, active=False):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	910 super(outputstream, self).__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: 40131 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: 40131 diff changeset	914
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	915 def setencoder(self, ui, name):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	916 """Set the encoder for this stream.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	917
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	918 Receives the stream profile name.
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	919 """
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	922
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 40131 diff changeset	925
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	926 def encode(self, data):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	927 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	928 return data
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	929
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	930 return self._encoder.encode(data)
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	931
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	932 def flush(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	933 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	934 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	935
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	936 return self._encoder.flush()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	937
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	938 def finish(self):
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	939 if not self._encoder:
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	940 return b''
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	941
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	942 self._encoder.finish()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 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: 37287 diff changeset	991 def ensureserverstream(stream):
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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
37063 0a6c5cc09a88 wireproto: define human output side channel frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37061 diff changeset	998
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 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'],
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1001 }
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1002
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1003
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	1004 class serverreactor:
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1006
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 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: 37054 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: 37054 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: 37054 diff changeset	1011
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 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: 37054 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: 37054 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: 37054 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: 37054 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: 37054 diff changeset	1018
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1020 this class.
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1021
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 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: 37054 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: 37054 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: 37054 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: 37054 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: 37054 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: 37054 diff changeset	1029
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1031
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1032 sendframes
61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 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: 37055 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: 37055 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: 37055 diff changeset	1036
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1037 error
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1039
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1040 runcommand
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 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: 37054 diff changeset	1043
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1044 wantframe
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1046 more frames from the client before anything interesting can be done.
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1047
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1048 noop
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1049 Indicates no additional action is required.
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1050
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1051 Known Issues
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1052 ------------
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1053
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 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: 37060 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: 37060 diff changeset	1056 server's memory.
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1057
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 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: 37060 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: 37060 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: 37060 diff changeset	1061 to facilitate graceful shutdown?
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1062
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 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: 37060 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: 37060 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: 37060 diff changeset	1066 between who responds to what.
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1067 """
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1068
40130 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1069 def __init__(self, ui, deferoutput=False):
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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: 37058 diff changeset	1071
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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: 37058 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: 37058 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: 37058 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: 37058 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: 37058 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: 37058 diff changeset	1078 """
40130 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1079 self._ui = ui
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1083 self._bufferedframegens = []
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 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 = {}
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 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: 37060 diff changeset	1088 self._receivingcommands = {}
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 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: 37065 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: 37065 diff changeset	1091 # set.
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1092 self._activecommands = set()
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1093
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1094 self._protocolsettingsdecoder = None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1095
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 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: 40126 diff changeset	1097 self._sendersettings = dict(DEFAULT_PROTOCOL_SETTINGS)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1098
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1099 populatestreamencoders()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1100
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1101 def onframerecv(self, frame):
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 diff changeset	1103
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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: 37054 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: 37054 diff changeset	1106 """
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 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: 37287 diff changeset	1113
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 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: 37287 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: 37287 diff changeset	1123
40131 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 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: 37287 diff changeset	1125
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 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: 37287 diff changeset	1132
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 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: 37287 diff changeset	1134 del self._incomingstreams[frame.streamid]
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	1135
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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,
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1142 }
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1143
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1144 meth = handlers.get(self._state)
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 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)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1147
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1148 return meth(frame)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1149
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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: 39503 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: 39503 diff changeset	1152
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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: 39503 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: 39503 diff changeset	1155 client.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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: 39503 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: 39503 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: 39503 diff changeset	1166 # in a bad state.
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1167 #
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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: 39503 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: 39503 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: 39503 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: 39503 diff changeset	1172 #
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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: 39503 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: 39503 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():
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1177 emitted = False
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1178 alternatelocationsent = False
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	1179 emitter = bufferingcommandresponseemitter(stream, requestid)
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1180 while True:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1181 try:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1182 o = next(objs)
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1183 except StopIteration:
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 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: 39575 diff changeset	1185 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	1186
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1192 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1193
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1194 except error.WireprotoCommandError as e:
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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 ):
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1198 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1199 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1200
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1201 except Exception as e:
39843 bce1c1af7518 py3: cast exception to bytes Gregory Szorc <gregory.szorc@gmail.com> parents: 39576 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 ):
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1208 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1209
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1210 break
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1211
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1212 try:
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 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: 40025 diff changeset	1214 # only object in the output stream.
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1215 if isinstance(o, wireprototypes.alternatelocationresponse):
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1216 if emitted:
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 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 )
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 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
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 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 )
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1229
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1230 alternatelocationsent = True
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1231 emitted = True
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1232 continue
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1233
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1234 if alternatelocationsent:
b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 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 )
40026 b099e6032f38 wireprotov2: server support for sending content redirects Gregory Szorc <gregory.szorc@gmail.com> parents: 40025 diff changeset	1238
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1250 emitted = True
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1251
40021 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 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: 39843 diff changeset	1253 # data structures or special types.
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 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: 39843 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: 39843 diff changeset	1256
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 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: 39843 diff changeset	1258 if isinstance(o, wireprototypes.encodedresponse):
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 diff changeset	1259 for frame in emitter.send(o.data):
39576 84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 diff changeset	1260 yield frame
84bf6ded9317 wireprotoframing: buffer emitted data to reduce frame count Gregory Szorc <gregory.szorc@gmail.com> parents: 39575 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
40021 ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 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: 39843 diff changeset	1272 else:
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 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: 39843 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: 39843 diff changeset	1275 yield frame
ed919b90acda wireprotov2: define type to represent pre-encoded object Gregory Szorc <gregory.szorc@gmail.com> parents: 39843 diff changeset	1276
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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 ):
39575 07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1281 yield frame
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 diff changeset	1282
07b58266bce3 wireprotov2: implement commands as a generator of objects Gregory Szorc <gregory.szorc@gmail.com> parents: 39503 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
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1289 def oninputeof(self):
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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: 37058 diff changeset	1291
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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: 37058 diff changeset	1293 completed.
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1294 """
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 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: 37060 diff changeset	1296
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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', {}
37059 861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1299
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 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: 37058 diff changeset	1301 def makegen():
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1302 for gen in self._bufferedframegens:
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1303 for frame in gen:
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1304 yield frame
861e9d37e56e wireproto: buffer output frames when in half duplex mode Gregory Szorc <gregory.szorc@gmail.com> parents: 37058 diff changeset	1305
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1306 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1307 b'framegen': makegen(),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1308 }
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1309
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1310 def _handlesendframes(self, framegen):
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1311 if self._deferoutput:
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1312 self._bufferedframegens.append(framegen)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1313 return b'noop', {}
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1314 else:
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1315 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1316 b'framegen': framegen,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1317 }
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1318
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	1319 def onservererror(self, stream, requestid, msg):
37288 9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	1320 ensureserverstream(stream)
9bfcbe4f4745 wireproto: add streams to frame-based protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37287 diff changeset	1321
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1322 def sendframes():
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1323 for frame in createerrorframe(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1324 stream, requestid, msg, errtype=b'server'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1325 ):
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1326 yield frame
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 self._activecommands.remove(requestid)
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 return self._handlesendframes(sendframes())
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1331
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1332 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	1333 """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	1334 ensureserverstream(stream)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1335
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1336 def sendframes():
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1337 for frame in createcommanderrorresponse(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1338 stream, requestid, message, args
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1339 ):
37728 564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1340 yield frame
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1341
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1342 self._activecommands.remove(requestid)
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1343
564a3eec6e63 wireprotov2: add support for more response types Gregory Szorc <gregory.szorc@gmail.com> parents: 37726 diff changeset	1344 return self._handlesendframes(sendframes())
37058 61393f888dfe wireproto: define and implement responses in framing protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 37055 diff changeset	1345
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1346 def makeoutputstream(self):
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1347 """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	1348
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1349 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	1350 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	1351 we will default to identity.
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1352 """
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1353 streamid = self._nextoutgoingstreamid
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1354 self._nextoutgoingstreamid += 2
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1355
40131 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1356 s = outputstream(streamid)
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1357 self._outgoingstreams[streamid] = s
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1358
40138 b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1359 # 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	1360 # 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	1361 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	1362 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	1363 s.setencoder(self._ui, name)
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1364 break
b5bf3dd6ec5b wireprotov2: send content encoded frames from server Gregory Szorc <gregory.szorc@gmail.com> parents: 40136 diff changeset	1365
37289 5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1366 return s
5fadc63ac99f wireproto: explicit API to create outgoing streams Gregory Szorc <gregory.szorc@gmail.com> parents: 37288 diff changeset	1367
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1368 def _makeerrorresult(self, msg):
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1369 return b'error', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1370 b'message': msg,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1371 }
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1372
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1373 def _makeruncommandresult(self, requestid):
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1374 entry = self._receivingcommands[requestid]
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1375
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1376 if not entry[b'requestdone']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1377 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1378 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	1379 b'should not be called without requestdone set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1380 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1381
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1382 del self._receivingcommands[requestid]
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1383
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1384 if self._receivingcommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1385 self._state = b'command-receiving'
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1386 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1387 self._state = b'idle'
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1388
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1389 # Decode the payloads as CBOR.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1390 entry[b'payload'].seek(0)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1391 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	1392
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1393 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	1394 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1395 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1396 _(b'command request missing "name" field')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1397 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1398
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1399 if b'args' not in request:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1400 request[b'args'] = {}
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1401
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1402 assert requestid not in self._activecommands
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1403 self._activecommands.add(requestid)
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1404
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1405 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1406 b'runcommand',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1407 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1408 b'requestid': requestid,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1409 b'command': request[b'name'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1410 b'args': request[b'args'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1411 b'redirect': request.get(b'redirect'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1412 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	1413 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1414 )
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1415
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1416 def _makewantframeresult(self):
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1417 return b'wantframe', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1418 b'state': self._state,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1419 }
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1420
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1421 def _validatecommandrequestframe(self, frame):
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1422 new = frame.flags & FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1423 continuation = frame.flags & FLAG_COMMAND_REQUEST_CONTINUATION
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1424
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1425 if new and continuation:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1426 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1427 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1428 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1429 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	1430 b'continuation flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1431 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1432 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1433
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1434 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	1435 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1436 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1437 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1438 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	1439 b'continuation flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1440 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1441 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1442
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1443 def _onframeinitial(self, frame):
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1444 # 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: 40126 diff changeset	1445 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	1446 self._state = b'protocol-settings-receiving'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1447 self._protocolsettingsdecoder = cborutil.bufferingdecoder()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1448 return self._onframeprotocolsettings(frame)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1449
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1450 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	1451 self._state = b'idle'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1452 return self._onframeidle(frame)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1453
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1454 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1455 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1456 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1457 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1458 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	1459 b'frame; got %d'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1460 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1461 % frame.typeid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1462 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1463
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1464 def _onframeprotocolsettings(self, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1465 assert self._state == b'protocol-settings-receiving'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1466 assert self._protocolsettingsdecoder is not None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1467
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1468 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	1469 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1470 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1471 _(b'expected sender protocol settings frame; got %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1472 % frame.typeid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1473 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1474
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1475 more = frame.flags & FLAG_SENDER_PROTOCOL_SETTINGS_CONTINUATION
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1476 eos = frame.flags & FLAG_SENDER_PROTOCOL_SETTINGS_EOS
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1477
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1478 if more and eos:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1479 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1480 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1481 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1482 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	1483 b'continuation and end of stream flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1484 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1485 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1486
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1487 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	1488 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1489 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1490 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1491 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	1492 b'end of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1493 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1494 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1495
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1496 # 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: 40126 diff changeset	1497 # buffered.
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1498 try:
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1499 self._protocolsettingsdecoder.decode(frame.payload)
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1500 except Exception as e:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1501 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1502 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1503 _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1504 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	1505 )
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1506 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1507 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1508
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1509 if more:
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1510 return self._makewantframeresult()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1511
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1512 assert eos
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1513
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1514 decoded = self._protocolsettingsdecoder.getavailable()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1515 self._protocolsettingsdecoder = None
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1516
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1517 if not decoded:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1518 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1519 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1520 _(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	1521 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1522 elif len(decoded) > 1:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1523 self._state = b'errored'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1524 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1525 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1526 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	1527 b'values'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1528 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1529 )
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1530
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1531 d = decoded[0]
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1532
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1533 if b'contentencodings' in d:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1534 self._sendersettings[b'contentencodings'] = d[b'contentencodings']
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1535
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1536 self._state = b'idle'
40127 327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1537
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1538 return self._makewantframeresult()
327d40b94bed wireprotov2: handle sender protocol settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40126 diff changeset	1539
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1540 def _onframeidle(self, frame):
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1541 # 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: 37054 diff changeset	1542 # command request.
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1543 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	1544 self._state = b'errored'
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1545 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1546 _(b'expected command request frame; got %d') % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1547 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1548
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1549 res = self._validatecommandrequestframe(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1550 if res:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1551 return res
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1552
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1553 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	1554 self._state = b'errored'
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1555 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1556 _(b'request with ID %d already received') % frame.requestid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1557 )
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1558
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1559 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	1560 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1561 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1562 _(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	1563 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1564
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1565 new = frame.flags & FLAG_COMMAND_REQUEST_NEW
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1566 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	1567 expectingdata = frame.flags & FLAG_COMMAND_REQUEST_EXPECT_DATA
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1568
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1569 if not new:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1570 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1571 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1572 _(b'received command request frame without new flag set')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1573 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1574
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1575 payload = util.bytesio()
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1576 payload.write(frame.payload)
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1577
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1578 self._receivingcommands[frame.requestid] = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1579 b'payload': payload,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1580 b'data': None,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1581 b'requestdone': not moreframes,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1582 b'expectingdata': bool(expectingdata),
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1583 }
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1584
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1585 # 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	1586 if not moreframes and not expectingdata:
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1587 return self._makeruncommandresult(frame.requestid)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1588
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1589 assert moreframes or expectingdata
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1590 self._state = b'command-receiving'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1591 return self._makewantframeresult()
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1592
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1593 def _onframecommandreceiving(self, frame):
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1594 if frame.typeid == FRAME_TYPE_COMMAND_REQUEST:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1595 # Process new command requests as such.
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1596 if frame.flags & FLAG_COMMAND_REQUEST_NEW:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1597 return self._onframeidle(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1598
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1599 res = self._validatecommandrequestframe(frame)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1600 if res:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1601 return res
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1602
c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1603 # All other frames should be related to a command that is currently
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1604 # receiving but is not active.
39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1605 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	1606 self._state = b'errored'
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1607 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1608 _(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	1609 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1610 )
37066 39304dd63589 wireproto: explicitly track which requests are active Gregory Szorc <gregory.szorc@gmail.com> parents: 37065 diff changeset	1611
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1612 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	1613 self._state = b'errored'
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1614 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1615 _(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	1616 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1617 )
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1618
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1619 entry = self._receivingcommands[frame.requestid]
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1620
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1621 if frame.typeid == FRAME_TYPE_COMMAND_REQUEST:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1622 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	1623 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	1624
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1625 if entry[b'requestdone']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1626 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1627 return self._makeerrorresult(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1628 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1629 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	1630 b'were supposedly done'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1631 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1632 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1633
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1634 if expectingdata != entry[b'expectingdata']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1635 self._state = b'errored'
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1636 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1637 _(b'mismatch between expect data flag and previous frame')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1638 )
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1639
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1640 entry[b'payload'].write(frame.payload)
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1641
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1642 if not moreframes:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1643 entry[b'requestdone'] = True
37292 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 if not moreframes and not expectingdata:
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1646 return self._makeruncommandresult(frame.requestid)
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1647
3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1648 return self._makewantframeresult()
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1649
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1650 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	1651 if not entry[b'expectingdata']:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1652 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1653 return self._makeerrorresult(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1654 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1655 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	1656 b'expecting data: %d'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1657 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1658 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1659 )
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1660
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1661 if entry[b'data'] is None:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1662 entry[b'data'] = util.bytesio()
37061 c5e9c3b47366 wireproto: support for receiving multiple requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37060 diff changeset	1663
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1664 return self._handlecommanddataframe(frame, entry)
37292 3d0e2cd86e05 wireproto: use CBOR for command requests Gregory Szorc <gregory.szorc@gmail.com> parents: 37291 diff changeset	1665 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1666 self._state = b'errored'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1667 return self._makeerrorresult(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1668 _(b'received unexpected frame type: %d') % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1669 )
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1670
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1671 def _handlecommanddataframe(self, frame, entry):
884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1672 assert frame.typeid == FRAME_TYPE_COMMAND_DATA
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1673
8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1674 # 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	1675 entry[b'data'].write(frame.payload)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1676
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1677 if frame.flags & FLAG_COMMAND_DATA_CONTINUATION:
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1678 return self._makewantframeresult()
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1679 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	1680 entry[b'data'].seek(0)
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1681 return self._makeruncommandresult(frame.requestid)
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1682 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1683 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	1684 return self._makeerrorresult(_(b'command data frame without flags'))
37055 8c3c47362934 wireproto: implement basic frame reading and processing Gregory Szorc <gregory.szorc@gmail.com> parents: 37054 diff changeset	1685
37064 884a0c1604ad wireproto: define attr-based classes for representing frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37063 diff changeset	1686 def _onframeerrored(self, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1687 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	1688
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1689
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	1690 class commandrequest:
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1691 """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	1692
40025 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	1693 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	1694 self.requestid = requestid
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1695 self.name = name
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1696 self.args = args
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1697 self.datafh = datafh
40025 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	1698 self.redirect = redirect
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1699 self.state = b'pending'
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1700
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1701
49037 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 49004 diff changeset	1702 class clientreactor:
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1703 """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	1704
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1705 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	1706
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1707 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	1708 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	1709 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	1710 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	1711 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	1712 separate instance for each distinct interaction.
40128 080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1713
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1714 Consumers are expected to tell instances when events occur by calling
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1715 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: 40127 diff changeset	1716 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: 40127 diff changeset	1717 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: 40127 diff changeset	1718 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: 40127 diff changeset	1719 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: 40127 diff changeset	1720 to those frames.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1721
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1722 Valid actions that consumers can be instructed to take are:
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1723
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1724 noop
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1725 Indicates no additional action is required.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1726
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1727 sendframes
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1728 Indicates that frames should be sent to the server. The ``framegen``
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1729 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: 40127 diff changeset	1730 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: 40127 diff changeset	1731
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1732 error
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1733 Indicates that an error occurred. The ``message`` key contains an
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1734 error message describing the failure.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1735
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1736 responsedata
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1737 Indicates a response to a previously-issued command was received.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1738
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1739 The ``request`` key contains the ``commandrequest`` instance that
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1740 represents the request this data is for.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1741
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1742 The ``data`` key contains the decoded data from the server.
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1743
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1744 ``expectmore`` and ``eos`` evaluate to True when more response data
080419fa4fe4 wireprotov2: document client reactor actions Gregory Szorc <gregory.szorc@gmail.com> parents: 40127 diff changeset	1745 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: 40127 diff changeset	1746 respectively.
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1747 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1748
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1749 def __init__(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1750 self,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1751 ui,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1752 hasmultiplesend=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1753 buffersends=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1754 clientcontentencoders=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1755 ):
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1756 """Create a new instance.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1757
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1758 ``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	1759 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	1760 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	1761 send operation.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1762
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1763 ``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	1764 last request has been issued.
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1765
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1766 ``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	1767 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	1768 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	1769 to the server.
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1770 """
40130 293835e0fff7 wireprotov2: pass ui into clientreactor and serverreactor Gregory Szorc <gregory.szorc@gmail.com> parents: 40129 diff changeset	1771 self._ui = ui
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1772 self._hasmultiplesend = hasmultiplesend
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1773 self._buffersends = buffersends
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1774 self._clientcontentencoders = clientcontentencoders
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1775
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1776 self._canissuecommands = True
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1777 self._cansend = True
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1778 self._protocolsettingssent = False
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1779
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1780 self._nextrequestid = 1
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1781 # We only support a single outgoing stream for now.
40131 5d44c4d1d516 wireprotov2: establish dedicated classes for input and output streams Gregory Szorc <gregory.szorc@gmail.com> parents: 40130 diff changeset	1782 self._outgoingstream = outputstream(1)
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1783 self._pendingrequests = collections.deque()
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1784 self._activerequests = {}
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1785 self._incomingstreams = {}
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1786 self._streamsettingsdecoders = {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1787
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1788 populatestreamencoders()
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1789
40025 86b22a4cfab1 wireprotov2: client support for advertising redirect targets Gregory Szorc <gregory.szorc@gmail.com> parents: 40021 diff changeset	1790 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	1791 """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	1792
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1793 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	1794 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	1795
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1796 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	1797 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1798 if not self._canissuecommands:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1799 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	1800
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1801 requestid = self._nextrequestid
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1802 self._nextrequestid += 2
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1803
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1804 request = commandrequest(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1805 requestid, name, args, datafh=datafh, redirect=redirect
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1806 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1807
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1808 if self._buffersends:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1809 self._pendingrequests.append(request)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1810 return request, b'noop', {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1811 else:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1812 if not self._cansend:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1813 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	1814 b'sends cannot be performed on this instance'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1815 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1816
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1817 if not self._hasmultiplesend:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1818 self._cansend = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1819 self._canissuecommands = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1820
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1821 return (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1822 request,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1823 b'sendframes',
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1824 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1825 b'framegen': self._makecommandframes(request),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1826 },
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1827 )
37543 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 def flushcommands(self):
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1830 """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	1831
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1832 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	1833 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	1834 to no-op.
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 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	1837 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	1838 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1839 if not self._pendingrequests:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1840 return b'noop', {}
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1841
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1842 if not self._cansend:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1843 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	1844 b'sends cannot be performed on this instance'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1845 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1846
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1847 # 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	1848 # our one shot.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1849 if not self._hasmultiplesend:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1850 self._canissuecommands = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1851 self._cansend = False
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1852
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1853 def makeframes():
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1854 while self._pendingrequests:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1855 request = self._pendingrequests.popleft()
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1856 for frame in self._makecommandframes(request):
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1857 yield frame
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1858
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1859 return b'sendframes', {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1860 b'framegen': makeframes(),
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1861 }
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1862
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1863 def _makecommandframes(self, request):
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1864 """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	1865
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1866 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	1867 state.
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1868 """
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1869 self._activerequests[request.requestid] = request
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1870 request.state = b'sending'
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1871
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1872 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	1873 self._protocolsettingssent = True
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1874
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1875 payload = b''.join(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1876 cborutil.streamencode(
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1877 {
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1878 b'contentencodings': self._clientcontentencoders,
89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 43554 diff changeset	1879 }
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1880 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1881 )
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1882
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1883 yield self._outgoingstream.makeframe(
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1884 requestid=request.requestid,
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1885 typeid=FRAME_TYPE_SENDER_PROTOCOL_SETTINGS,
762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1886 flags=FLAG_SENDER_PROTOCOL_SETTINGS_EOS,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1887 payload=payload,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1888 )
40133 762ef19a07e3 wireprotov2: send protocol settings frame from client Gregory Szorc <gregory.szorc@gmail.com> parents: 40132 diff changeset	1889
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1890 res = createcommandframes(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1891 self._outgoingstream,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1892 request.requestid,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1893 request.name,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1894 request.args,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1895 datafh=request.datafh,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1896 redirect=request.redirect,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1897 )
37543 01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1898
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1899 for frame in res:
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1900 yield frame
01361be9e2dc wireproto: introduce a reactor for client-side state Gregory Szorc <gregory.szorc@gmail.com> parents: 37485 diff changeset	1901
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1902 request.state = b'sent'
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1903
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1904 def onframerecv(self, frame):
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1905 """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	1906
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1907 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	1908 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	1909 """
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1910 if frame.streamid % 2:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1911 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1912 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1913 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1914 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1915 _(b'received frame with odd numbered stream ID: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1916 % frame.streamid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1917 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1918 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1919 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1920
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1921 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	1922 if not frame.streamflags & STREAM_FLAG_BEGIN_STREAM:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1923 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1924 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1925 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1926 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1927 b'received frame on unknown stream '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1928 b'without beginning of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1929 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1930 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1931 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1932
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1933 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	1934
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1935 stream = self._incomingstreams[frame.streamid]
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1936
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1937 # 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: 40131 diff changeset	1938 # merely substitute the decoded result into the frame payload as
e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1939 # 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	1940 if frame.streamflags & STREAM_FLAG_ENCODING_APPLIED:
40132 e67522413ca8 wireprotov2: define and use stream encoders Gregory Szorc <gregory.szorc@gmail.com> parents: 40131 diff changeset	1941 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	1942
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1943 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	1944 del self._incomingstreams[frame.streamid]
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1945
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1946 if frame.typeid == FRAME_TYPE_STREAM_SETTINGS:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1947 return self._onstreamsettingsframe(frame)
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1948
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1949 if frame.requestid not in self._activerequests:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1950 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1951 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1952 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1953 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1954 _(b'received frame for inactive request ID: %d')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1955 % frame.requestid
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1956 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1957 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1958 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1959
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1960 request = self._activerequests[frame.requestid]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1961 request.state = b'receiving'
37544 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 handlers = {
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	1964 FRAME_TYPE_COMMAND_RESPONSE: self._oncommandresponseframe,
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	1965 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	1966 }
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1967
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1968 meth = handlers.get(frame.typeid)
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1969 if not meth:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1970 raise error.ProgrammingError(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1971 b'unhandled frame type: %d' % frame.typeid
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1972 )
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1973
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1974 return meth(request, frame)
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	1975
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1976 def _onstreamsettingsframe(self, frame):
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1977 assert frame.typeid == FRAME_TYPE_STREAM_SETTINGS
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1978
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1979 more = frame.flags & FLAG_STREAM_ENCODING_SETTINGS_CONTINUATION
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1980 eos = frame.flags & FLAG_STREAM_ENCODING_SETTINGS_EOS
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1981
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1982 if more and eos:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1983 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1984 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1985 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1986 b'message': (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1987 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1988 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	1989 b'continuation and end of stream flags set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1990 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1991 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1992 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1993 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1994
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	1995 if not more and not eos:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1996 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1997 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	1998 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1999 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2000 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	2001 b'continuation or end of stream flag set'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2002 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2003 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2004 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2005
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2006 if frame.streamid not in self._streamsettingsdecoders:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2007 decoder = cborutil.bufferingdecoder()
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2008 self._streamsettingsdecoders[frame.streamid] = decoder
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2009
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2010 decoder = self._streamsettingsdecoders[frame.streamid]
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2011
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2012 try:
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2013 decoder.decode(frame.payload)
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2014 except Exception as e:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2015 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2016 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2017 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2018 b'message': (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2019 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2020 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	2021 b'settings frame: %s'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2022 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2023 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2024 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2025 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2026 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2027
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2028 if more:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2029 return b'noop', {}
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2030
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2031 assert eos
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2032
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2033 decoded = decoder.getavailable()
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2034 del self._streamsettingsdecoders[frame.streamid]
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2035
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2036 if not decoded:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2037 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2038 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2039 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2040 b'message': _(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2041 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	2042 b'CBOR data'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2043 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2044 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2045 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2046
57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2047 try:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2048 self._incomingstreams[frame.streamid].setdecoder(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2049 self._ui, decoded[0], decoded[1:]
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2050 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2051 except Exception as e:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2052 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2053 b'error',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2054 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2055 b'message': (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2056 _(b'error setting stream decoder: %s')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2057 % stringutil.forcebytestr(e)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2058 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2059 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2060 )
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2061
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2062 return b'noop', {}
40129 57782791b7e9 wireprotov2: handle stream encoding settings frames Gregory Szorc <gregory.szorc@gmail.com> parents: 40128 diff changeset	2063
37724 deff7cf7eefd wireprotov2: change frame type and name for command response Gregory Szorc <gregory.szorc@gmail.com> parents: 37723 diff changeset	2064 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	2065 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	2066 request.state = b'received'
37544 55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	2067 del self._activerequests[request.requestid]
55b5ba8d4e68 wireproto: client reactor support for receiving frames Gregory Szorc <gregory.szorc@gmail.com> parents: 37543 diff changeset	2068
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2069 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2070 b'responsedata',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2071 {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2072 b'request': request,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2073 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	2074 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	2075 b'data': frame.payload,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2076 },
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2077 )
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2078
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2079 def _onerrorresponseframe(self, request, frame):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2080 request.state = b'errored'
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2081 del self._activerequests[request.requestid]
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2082
0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2083 # The payload should be a CBOR map.
39465 36f487a332ad wireprotoframing: use our CBOR module Gregory Szorc <gregory.szorc@gmail.com> parents: 37728 diff changeset	2084 m = cborutil.decodeall(frame.payload)[0]
37726 0c184ca594bb wireprotov2: change behavior of error frame Gregory Szorc <gregory.szorc@gmail.com> parents: 37725 diff changeset	2085
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2086 return (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2087 b'error',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2088 {
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2089 b'request': request,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2090 b'type': m[b'type'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2091 b'message': m[b'message'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2092 },
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 40328 diff changeset	2093 )

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/wireprotoframing.py @ 51788:278af66e6595