1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
|
from __future__ import annotations
from typing import Any, Awaitable, Callable, Dict, List, Optional, Tuple, Type, Union
import h2
import h2.connection
import h2.events
import h2.exceptions
import priority
from .events import (
Body,
Data,
EndBody,
EndData,
Event as StreamEvent,
InformationalResponse,
Request,
Response,
StreamClosed,
)
from .http_stream import HTTPStream
from .ws_stream import WSStream
from ..config import Config
from ..events import Closed, Event, RawData, Updated
from ..typing import AppWrapper, Event as IOEvent, TaskGroup, WorkerContext
from ..utils import filter_pseudo_headers
BUFFER_HIGH_WATER = 2 * 2**14 # Twice the default max frame size (two frames worth)
BUFFER_LOW_WATER = BUFFER_HIGH_WATER / 2
class BufferCompleteError(Exception):
pass
class StreamBuffer:
def __init__(self, event_class: Type[IOEvent]) -> None:
self.buffer = bytearray()
self._complete = False
self._is_empty = event_class()
self._paused = event_class()
async def drain(self) -> None:
await self._is_empty.wait()
def set_complete(self) -> None:
self._complete = True
async def close(self) -> None:
self._complete = True
self.buffer = bytearray()
await self._is_empty.set()
await self._paused.set()
@property
def complete(self) -> bool:
return self._complete and len(self.buffer) == 0
async def push(self, data: bytes) -> None:
if self._complete:
raise BufferCompleteError()
self.buffer.extend(data)
await self._is_empty.clear()
if len(self.buffer) >= BUFFER_HIGH_WATER:
await self._paused.wait()
await self._paused.clear()
async def pop(self, max_length: int) -> bytes:
length = min(len(self.buffer), max_length)
data = bytes(self.buffer[:length])
del self.buffer[:length]
if len(data) < BUFFER_LOW_WATER:
await self._paused.set()
if len(self.buffer) == 0:
await self._is_empty.set()
return data
class H2Protocol:
def __init__(
self,
app: AppWrapper,
config: Config,
context: WorkerContext,
task_group: TaskGroup,
tls: Optional[dict[str, Any]],
client: Optional[Tuple[str, int]],
server: Optional[Tuple[str, int]],
send: Callable[[Event], Awaitable[None]],
transport=None,
) -> None:
self.app = app
self.client = client
self.closed = False
self.config = config
self.context = context
self.task_group = task_group
self.connection = h2.connection.H2Connection(
config=h2.config.H2Configuration(client_side=False, header_encoding=None)
)
self.connection.DEFAULT_MAX_INBOUND_FRAME_SIZE = config.h2_max_inbound_frame_size
self.connection.local_settings = h2.settings.Settings(
client=False,
initial_values={
h2.settings.SettingCodes.MAX_CONCURRENT_STREAMS: config.h2_max_concurrent_streams,
h2.settings.SettingCodes.MAX_HEADER_LIST_SIZE: config.h2_max_header_list_size,
h2.settings.SettingCodes.ENABLE_CONNECT_PROTOCOL: 1,
},
)
self.send = send
self.server = server
self.tls = tls
self.streams: Dict[int, Union[HTTPStream, WSStream]] = {}
# The below are used by the sending task
self.has_data = self.context.event_class()
self.priority = priority.PriorityTree()
self.stream_buffers: Dict[int, StreamBuffer] = {}
self.transport = transport
@property
def idle(self) -> bool:
return len(self.streams) == 0 or all(stream.idle for stream in self.streams.values())
async def initiate(
self, headers: Optional[List[Tuple[bytes, bytes]]] = None, settings: Optional[str] = None
) -> None:
if settings is not None:
self.connection.initiate_upgrade_connection(settings)
else:
self.connection.initiate_connection()
await self._flush()
if headers is not None:
event = h2.events.RequestReceived()
event.stream_id = 1
event.headers = headers
await self._create_stream(event)
await self.streams[event.stream_id].handle(EndBody(stream_id=event.stream_id))
self.task_group.spawn(self.send_task)
async def send_task(self) -> None:
# This should be run in a seperate task to the rest of this
# class. This allows it seperately choose when to send,
# crucially in what order.
while not self.closed:
try:
stream_id = next(self.priority)
except priority.DeadlockError:
await self.has_data.wait()
await self.has_data.clear()
else:
await self._send_data(stream_id)
async def _send_data(self, stream_id: int) -> None:
try:
chunk_size = min(
self.connection.local_flow_control_window(stream_id),
self.connection.max_outbound_frame_size,
)
chunk_size = max(0, chunk_size)
data = await self.stream_buffers[stream_id].pop(chunk_size)
if data:
self.connection.send_data(stream_id, data)
await self._flush()
else:
self.priority.block(stream_id)
if self.stream_buffers[stream_id].complete:
self.connection.end_stream(stream_id)
await self._flush()
del self.stream_buffers[stream_id]
self.priority.remove_stream(stream_id)
except (h2.exceptions.StreamClosedError, KeyError, h2.exceptions.ProtocolError):
# Stream or connection has closed whilst waiting to send
# data, not a problem - just force close it.
await self.stream_buffers[stream_id].close()
del self.stream_buffers[stream_id]
self.priority.remove_stream(stream_id)
async def handle(self, event: Event) -> None:
if isinstance(event, RawData):
try:
events = self.connection.receive_data(event.data)
except h2.exceptions.ProtocolError:
await self._flush()
await self.send(Closed())
raise
else:
await self._handle_events(events)
elif isinstance(event, Closed):
self.closed = True
stream_ids = list(self.streams.keys())
for stream_id in stream_ids:
await self._close_stream(stream_id)
await self.has_data.set()
async def stream_send(self, event: StreamEvent) -> None:
try:
if isinstance(event, (InformationalResponse, Response)):
self.connection.send_headers(
event.stream_id,
[(b":status", b"%d" % event.status_code)]
+ event.headers
+ self.config.response_headers("h2"),
)
await self._flush()
elif isinstance(event, (Body, Data)):
self.priority.unblock(event.stream_id)
await self.has_data.set()
await self.stream_buffers[event.stream_id].push(event.data)
elif isinstance(event, (EndBody, EndData)):
self.stream_buffers[event.stream_id].set_complete()
self.priority.unblock(event.stream_id)
await self.has_data.set()
await self.stream_buffers[event.stream_id].drain()
elif isinstance(event, StreamClosed):
await self._close_stream(event.stream_id)
idle = len(self.streams) == 0 or all(
stream.idle for stream in self.streams.values()
)
if idle and self.context.terminated.is_set():
self.connection.close_connection()
await self._flush()
await self.send(Updated(idle=idle))
elif isinstance(event, Request):
await self._create_server_push(event.stream_id, event.raw_path, event.headers)
except (
BufferCompleteError,
KeyError,
priority.MissingStreamError,
h2.exceptions.ProtocolError,
):
# Connection has closed whilst blocked on flow control or
# connection has advanced ahead of the last emitted event.
return
async def _handle_events(self, events: List[h2.events.Event]) -> None:
for event in events:
if isinstance(event, h2.events.RequestReceived):
if self.context.terminated.is_set():
self.connection.reset_stream(event.stream_id)
self.connection.update_settings(
{h2.settings.SettingCodes.MAX_CONCURRENT_STREAMS: 0}
)
else:
await self._create_stream(event)
await self.send(Updated(idle=False))
elif isinstance(event, h2.events.DataReceived):
await self.streams[event.stream_id].handle(
Body(stream_id=event.stream_id, data=event.data)
)
self.connection.acknowledge_received_data(
event.flow_controlled_length, event.stream_id
)
elif isinstance(event, h2.events.StreamEnded):
await self.streams[event.stream_id].handle(EndBody(stream_id=event.stream_id))
elif isinstance(event, h2.events.StreamReset):
await self._close_stream(event.stream_id)
await self._window_updated(event.stream_id)
elif isinstance(event, h2.events.WindowUpdated):
await self._window_updated(event.stream_id)
elif isinstance(event, h2.events.PriorityUpdated):
await self._priority_updated(event)
elif isinstance(event, h2.events.RemoteSettingsChanged):
if h2.settings.SettingCodes.INITIAL_WINDOW_SIZE in event.changed_settings:
await self._window_updated(None)
elif isinstance(event, h2.events.ConnectionTerminated):
await self.send(Closed())
await self._flush()
async def _flush(self) -> None:
data = self.connection.data_to_send()
if data != b"":
await self.send(RawData(data=data))
async def _window_updated(self, stream_id: Optional[int]) -> None:
if stream_id is None or stream_id == 0:
# Unblock all streams
for stream_id in list(self.stream_buffers.keys()):
self.priority.unblock(stream_id)
elif stream_id is not None and stream_id in self.stream_buffers:
self.priority.unblock(stream_id)
await self.has_data.set()
async def _priority_updated(self, event: h2.events.PriorityUpdated) -> None:
try:
self.priority.reprioritize(
stream_id=event.stream_id,
depends_on=event.depends_on or None,
weight=event.weight,
exclusive=event.exclusive,
)
except priority.MissingStreamError:
# Received PRIORITY frame before HEADERS frame
self.priority.insert_stream(
stream_id=event.stream_id,
depends_on=event.depends_on or None,
weight=event.weight,
exclusive=event.exclusive,
)
self.priority.block(event.stream_id)
await self.has_data.set()
async def _create_stream(self, request: h2.events.RequestReceived) -> None:
for name, value in request.headers:
if name == b":method":
method = value.decode("ascii").upper()
elif name == b":path":
raw_path = value
if method == "CONNECT":
self.streams[request.stream_id] = WSStream(
self.app,
self.config,
self.context,
self.task_group,
self.tls,
self.client,
self.server,
self.stream_send,
request.stream_id,
)
else:
self.streams[request.stream_id] = HTTPStream(
self.app,
self.config,
self.context,
self.task_group,
self.tls,
self.client,
self.server,
self.stream_send,
request.stream_id,
)
self.stream_buffers[request.stream_id] = StreamBuffer(self.context.event_class)
try:
self.priority.insert_stream(request.stream_id)
except priority.DuplicateStreamError:
# Recieved PRIORITY frame before HEADERS frame
pass
else:
self.priority.block(request.stream_id)
await self.streams[request.stream_id].handle(
Request(
stream_id=request.stream_id,
headers=filter_pseudo_headers(request.headers),
http_version="2",
method=method,
raw_path=raw_path,
)
)
async def _create_server_push(
self, stream_id: int, path: bytes, headers: List[Tuple[bytes, bytes]]
) -> None:
push_stream_id = self.connection.get_next_available_stream_id()
request_headers = [(b":method", b"GET"), (b":path", path)]
request_headers.extend(headers)
request_headers.extend(self.config.response_headers("h2"))
try:
self.connection.push_stream(
stream_id=stream_id,
promised_stream_id=push_stream_id,
request_headers=request_headers,
)
await self._flush()
except h2.exceptions.ProtocolError:
# Client does not accept push promises or we are trying to
# push on a push promises request.
pass
else:
event = h2.events.RequestReceived()
event.stream_id = push_stream_id
event.headers = request_headers
await self._create_stream(event)
await self.streams[event.stream_id].handle(EndBody(stream_id=event.stream_id))
async def _close_stream(self, stream_id: int) -> None:
if stream_id in self.streams:
stream = self.streams.pop(stream_id)
await stream.handle(StreamClosed(stream_id=stream_id))
await self.has_data.set()
|