moqtap_client/draft22/connection.rs
1use std::collections::VecDeque;
2use std::sync::Mutex;
3
4use bytes::{Buf, Bytes, BytesMut};
5
6use crate::draft22::endpoint::{Endpoint, EndpointError};
7use crate::draft22::event::{ClientEvent, Direction, StreamKind};
8use crate::draft22::fill::LocationFilter;
9use crate::draft22::observer::ConnectionObserver;
10use crate::draft22::session::request_id::Role;
11use crate::draft22::session::setup;
12use crate::malformed_tracks::MalformedTrackCondition;
13use crate::track_locations::{ObjectLocation, ObjectRole, TrackObjects};
14use crate::transport::{RecvStream, SendStream, Transport, TransportError};
15use moqtap_codec::dispatch::{
16 AnyControlMessage, AnyDatagramHeader, AnyFetchHeader, AnySubgroupHeader,
17};
18use moqtap_codec::draft22::data_stream::{
19 FetchHeader, FetchObject, FetchObjectHeader, FetchObjectReader, GroupOrder, SubgroupObject,
20 SubgroupObjectReader,
21};
22use moqtap_codec::draft22::error_codes::StreamResetErrorCode;
23use moqtap_codec::draft22::message::{
24 ControlMessage, FetchOk, MessageType, Namespace, NamespaceDone, PublishSkipped, RequestError,
25 RequestOk, SubscribeOk,
26};
27use moqtap_codec::error::CodecError;
28use moqtap_codec::kvp::KeyValuePair;
29use moqtap_codec::types::*;
30use moqtap_codec::varint::VarInt;
31use moqtap_codec::version::DraftVersion;
32
33/// The ALPN identifier draft-22 uses on raw QUIC, `moqt-22`.
34///
35/// Drafts 07 to 14 share one ALPN, `moq-00`, and a peer that offers it has
36/// said nothing about which of the eight it speaks. Draft-15 ended that:
37/// from there each draft has an ALPN of its own, so the version is settled
38/// by the TLS handshake before a byte of MoQT is written.
39///
40/// This is [`DraftVersion::Draft22`]'s own
41/// [`quic_alpn`](DraftVersion::quic_alpn), which is what
42/// [`ClientConfig::alpn`] offers; the test below holds the two together.
43pub const MOQT_ALPN: &[u8] = b"moqt-22";
44
45/// The unidirectional stream type that marks one direction of the control
46/// plane, and the SETUP message type. On draft-22 they are one number,
47/// 0x2F00: Section 6.4.1 (Unidirectional Stream Types) lists it as the type of
48/// a SETUP stream, and Section 9.1 gives it as the SETUP message's own type
49/// field.
50///
51/// Because they are the same number a control stream carries no separate
52/// stream header. The varint a reader uses to recognise the stream is the
53/// first field of the SETUP message it then decodes, and a writer that
54/// encodes a SETUP onto a fresh unidirectional stream has already written the
55/// stream type by writing the message.
56///
57/// Encoded with MoQT's variable-length integer, whose width is the number of
58/// leading 1 bits in the first byte, 0x2F00 is the two bytes `AF 00` — four
59/// under RFC 9000's encoding, which this draft does not use. Read it through
60/// [`DraftVersion::decode_varint`] rather than assuming a width.
61pub const CONTROL_STREAM_TYPE: u64 = 0x2F00;
62
63/// The unidirectional stream type of FETCH_HEADER, 0x05 (draft-22 Section 6.4.1).
64///
65/// A fill fetch stream opens with it too: draft-22 Section 3.4 has a
66/// subscription carrying FILL_PARAMETERS open "a unidirectional stream
67/// beginning with a FETCH_HEADER".
68const FETCH_STREAM_TYPE: u64 = 0x05;
69
70/// The application error code a request stream is reset with when the
71/// requester abandons it: `CANCELLED`, 0x1.
72///
73/// Draft-17 removed UNSUBSCRIBE and FETCH_CANCEL and draft-22 has not brought
74/// them back. Cancelling a request is resetting the bidirectional stream it
75/// was made on, and `CANCELLED` is the code draft-22 assigns for "the stream
76/// was cancelled by either endpoint" — see [`StreamResetErrorCode::Cancelled`].
77/// Taken from the codec's own registry rather than written as a literal so a
78/// renumbering in a later draft cannot be missed here.
79///
80/// This is what [`RequestStream::cancel`] uses when no code is chosen for it,
81/// and what `RequestStream`'s [`Drop`] sends.
82pub const REQUEST_CANCELLED: u64 = StreamResetErrorCode::Cancelled as u64;
83
84/// The application error code a request stream **the peer opened** is reset
85/// with when this endpoint abandons it: `INTERNAL_ERROR`, 0x0.
86///
87/// Dropping an inbound request is not the act [`REQUEST_CANCELLED`] describes.
88/// Draft-22 Section 6.4.2.3 grants a responder a cancel — "Receivers cancel
89/// requests if they are unable to or choose not to respond" — but a handle
90/// that fell out of scope chose nothing; it failed to serve, which is what
91/// [`StreamResetErrorCode::InternalError`], "an implementation specific
92/// error", names. The two codes are on the wire, so a peer counting refusals
93/// can tell a deliberate rejection from a dropped request only if they differ.
94///
95/// It is also what a responder that already answered is reset with when it is
96/// dropped without finishing. A FIN there would claim the request completed,
97/// and Section 6.4.2.2 says when it has not: "the publisher of an Established
98/// subscription MUST send PUBLISH_DONE, before sending a FIN."
99pub const REQUEST_UNANSWERED: u64 = StreamResetErrorCode::InternalError as u64;
100
101/// Errors from the connection layer.
102#[derive(Debug, thiserror::Error)]
103pub enum ConnectionError {
104 /// Endpoint state machine error.
105 #[error("endpoint error: {0}")]
106 Endpoint(#[from] EndpointError),
107 /// Wire codec error.
108 #[error("codec error: {0}")]
109 Codec(#[from] CodecError),
110 /// Transport-level error.
111 #[error("transport error: {0}")]
112 Transport(#[from] TransportError),
113 /// Variable-length integer decoding error.
114 #[error("varint error: {0}")]
115 VarInt(#[from] moqtap_codec::varint::VarIntError),
116 /// Control stream was not opened.
117 #[error("control stream not open")]
118 NoControlStream,
119 /// Stream ended before a complete message was read.
120 #[error("unexpected end of stream")]
121 UnexpectedEnd,
122 /// Stream was finished by the peer.
123 #[error("stream finished")]
124 StreamFinished,
125 /// Invalid server address string.
126 #[error("invalid server address: {0}")]
127 InvalidAddress(String),
128 /// TLS configuration error.
129 #[error("TLS config error: {0}")]
130 TlsConfig(String),
131 /// Data stream used out of order (e.g. object before header).
132 #[error("data stream state error: {0}")]
133 DataStreamState(&'static str),
134 /// A control message this build decoded for draft-22 and then could not
135 /// narrow to draft-22's own message type.
136 ///
137 /// Unreachable, and that is not the same as harmless. `read_control`
138 /// decodes with this connection's own draft, so the `AnyControlMessage` it
139 /// hands back can only carry this draft's variant — but the narrowing arm
140 /// is compiled in every configuration anyway, under
141 /// `#[allow(unreachable_patterns)]` rather than a `cfg` naming the other
142 /// drafts, because such a list has to be edited in every per-draft
143 /// module whenever a draft is added and a copy that omits one leaves the
144 /// match non-exhaustive.
145 ///
146 /// Spelled as `CodecError::UnknownMessageType(0)` it would not stay inert:
147 /// every draft's
148 /// [`codec_session_error_code`](Connection::codec_session_error_code)
149 /// answers that variant `Some(PROTOCOL_VIOLATION)`. So the day the
150 /// narrowing did fail, this build's own defect would reach a caller as *the
151 /// peer sent a control message type this draft does not assign, and the
152 /// session must be closed with a Protocol Violation* — carrying `0x00` as
153 /// the codepoint that proved it. A conformance report reading that
154 /// publishes a named, well-evidenced accusation against a relay for
155 /// something no relay did.
156 ///
157 /// A variant of its own is what stops that.
158 /// [`draft_specific_cause`](Connection::draft_specific_cause) answers it
159 /// [`LocalRefusal`], the facade turns that into [`ErrorCause::Facade`], and
160 /// nothing downstream can read a rule out of a cause that says nothing
161 /// reached the wire. What is pinned is the consequence rather than the
162 /// unreachability: nothing pins the arm's reachability, which is exactly
163 /// why the consequence must not be an accusation.
164 ///
165 /// [`LocalRefusal`]: crate::above_codec_rules::DraftSpecificCause::LocalRefusal
166 /// [`ErrorCause::Facade`]: crate::dispatch::ErrorCause::Facade
167 #[error(
168 "a control message decoded for draft-22 did not narrow to draft-22: a defect in this build, and evidence about nothing the peer did"
169 )]
170 ControlMessageNarrowing,
171 /// A message that begins a request stream was handed to
172 /// [`Connection::send_control`]. Nothing was written.
173 #[error(
174 "{0:?} begins a request stream of its own and must not be written on the control stream"
175 )]
176 RequestOnControlStream(MessageType),
177 /// A message draft-22 places on a request stream was handed to
178 /// [`Connection::send_control`]. Nothing was written.
179 ///
180 /// Distinct from [`ConnectionError::RequestOnControlStream`], which is about
181 /// a message that would *begin* a request stream of its own. This one is
182 /// about a message that belongs on a request stream already open, and so has
183 /// no meaning without one around it.
184 #[error("{0:?} belongs on a request stream, not on the control stream")]
185 RequestStreamMessageOnControlStream(MessageType),
186 /// The codec refused a datagram with [`CodecError::MalformedTrack`], for a
187 /// Prior Group ID Gap or Prior Object ID Gap fault (draft-22 Section 10.8,
188 /// draft-22 Section 10.9), or with [`CodecError::MalformedObjectProperties`],
189 /// for a property block that does not parse (draft-22 Section 10.7). Either
190 /// makes the datagram's track malformed.
191 ///
192 /// Carries the datagram's Track Alias, which the codec's error does not
193 /// name, so [`Connection::requests_to_cancel`] can name the requests to
194 /// cancel. The session stays open.
195 #[error("datagram for track alias {track_alias}: {error}")]
196 MalformedTrackDatagram {
197 /// The Track Alias the datagram named.
198 track_alias: u64,
199 /// The codec's refusal.
200 error: CodecError,
201 },
202 /// A datagram with the PROPERTIES bit set arrived with a Properties Length
203 /// of 0.
204 ///
205 /// draft-22 Section 11.2.1: "If an endpoint receives a datagram with the
206 /// PROPERTIES bit set and an Properties Length of 0, it MUST close the
207 /// session with a PROTOCOL_VIOLATION."
208 ///
209 /// [`Connection::recv_datagram`] checks the decoded header for it, and
210 /// [`Connection::close_for_data_stream`] closes the session over it.
211 #[error(
212 "the datagram for object {object_id} sets the PROPERTIES bit and has a Properties Length of 0"
213 )]
214 EmptyDatagramProperties {
215 /// The Object ID the datagram named.
216 object_id: u64,
217 },
218 /// A datagram carrying an Object Status arrived with bytes after its
219 /// header.
220 /// Draft-22 Section 11.1.1: "An Object MUST have an empty payload unless
221 /// its Object Status value is registered as permitting a payload in the
222 /// Object Status registry" Section 11.2.1 says the same thing about the
223 /// framing: a datagram with the STATUS bit set "is present and there is no
224 /// Object Payload."
225 ///
226 /// The codec cannot see this. `DatagramHeader::decode` stops at the end of
227 /// the header and never owns the datagram's tail, so the only layer that
228 /// holds both the status and the bytes after it is this one. Without the
229 /// check the application is handed, say, an End-of-Group object carrying
230 /// four bytes of payload — a combination the draft forbids outright.
231 ///
232 /// Recoverable: the drafts state the rule as a property of a conforming
233 /// object, not as one of the "MUST close the session" cases, so the datagram
234 /// is refused and the session left running.
235 #[error(
236 "datagram for object {object_id} carries {payload_len} bytes after a header \
237 whose status is {status:?}, which permits no payload"
238 )]
239 PayloadOnStatusDatagram {
240 /// Object ID from the datagram header.
241 object_id: u64,
242 /// How many bytes followed the header.
243 payload_len: usize,
244 /// The status the header declared.
245 ///
246 /// Spelled out in full because the glob import of `moqtap_codec::types`
247 /// brings a different `ObjectStatus` into this module.
248 status: Option<moqtap_codec::draft22::types::ObjectStatus>,
249 },
250 /// An Object arrived carrying properties on a status that is not Normal.
251 ///
252 /// Draft-22 Section 11.1.2: "Any Object with status Normal can have
253 /// properties (Section 8.4). If an endpoint receives properties on an
254 /// Object with status that is not Normal, it MUST close the session with a
255 /// PROTOCOL_VIOLATION."
256 ///
257 /// The codec's `read_object` refuses such an Object as a bare
258 /// `InvalidField`. Its `read_object_meta` frames it, which is how the
259 /// receive path names the rule here and stays in step with the wire.
260 #[error(
261 "object {object_id} carries {properties_len} bytes of properties on status {status:?}, \
262 which is not Normal"
263 )]
264 PropertiesOnNonNormalStatus {
265 /// The Object ID the properties arrived on.
266 object_id: u64,
267 /// Length in bytes of the properties block.
268 properties_len: usize,
269 /// The Object's status, resolved through the encoding's elision rule.
270 ///
271 /// Spelled out in full because the glob import of `moqtap_codec::types`
272 /// brings a different `ObjectStatus` into this module.
273 status: moqtap_codec::draft22::types::ObjectStatus,
274 },
275 /// A bidirectional stream the peer opened began with a message type that
276 /// does not open a request stream.
277 ///
278 /// Draft-22 Section 6.3: "Bidirectional streams MUST NOT begin with any
279 /// other message type unless negotiated. If they do, the peer MUST close
280 /// the Session with a PROTOCOL_VIOLATION." The session has already been
281 /// closed on the wire by the time this is returned, and the offending
282 /// stream reset.
283 #[error(
284 "a bidirectional stream the peer opened began with {0:?}, which does not begin a request stream; the session was closed"
285 )]
286 NonRequestOnRequestStream(MessageType),
287 /// A `respond_*` helper was handed a request stream this endpoint opened.
288 /// Nothing was written and no state moved.
289 #[error(
290 "this endpoint opened request {0}; only the endpoint a request stream was opened toward may answer it"
291 )]
292 RespondedToOwnRequest(u64),
293 /// [`RequestStream::finish`] was called on a request stream the peer opened
294 /// before a response had been written on it. Nothing was written.
295 ///
296 /// Draft-22 Section 6.4.2.2: "An endpoint MUST NOT send a FIN on a direction
297 /// of a request stream until it has sent all required messages on that
298 /// direction for its request type. In particular, an endpoint sending a
299 /// response to a request MUST send the corresponding response message ...
300 /// before sending a FIN." The section arrived in draft-19 and draft-22
301 /// keeps it verbatim; drafts 17 and 18 have no such rule and no such
302 /// guard.
303 #[error(
304 "request {0} has not been answered; draft-22 Section 6.4.2.2 forbids finishing a request stream before its response"
305 )]
306 FinBeforeResponse(u64),
307 /// [`RequestStream::finish`] was called on a subscription this endpoint is
308 /// the publisher of, before PUBLISH_DONE. Nothing was written.
309 ///
310 /// The second half of the same sentence in draft-22 Section 6.4.2.2: "the
311 /// publisher of an Established subscription MUST send PUBLISH_DONE, before
312 /// sending a FIN." It applies to the accepted SUBSCRIBE a responder
313 /// answered with SUBSCRIBE_OK and to the PUBLISH this endpoint sent, which
314 /// is why [`Connection::publish_done`] and
315 /// [`Connection::publish_done_on`] are the only routes that clear it.
316 #[error(
317 "request {0} is an established subscription; draft-22 Section 6.4.2.2 requires PUBLISH_DONE before a FIN"
318 )]
319 FinBeforePublishDone(u64),
320}
321
322impl From<crate::transport::DialError> for ConnectionError {
323 /// Maps a dial failure onto the variants this error already has, so a
324 /// caller matches `InvalidAddress` or `TlsConfig`.
325 ///
326 /// A `LocalSocket` failure maps to `InvalidAddress`, which the facade reads
327 /// as this side's failure
328 /// ([`ErrorCause::Facade`](crate::dispatch::ErrorCause::Facade)). The dial
329 /// phase stays on [`DialError::phase`](crate::transport::DialError::phase).
330 fn from(e: crate::transport::DialError) -> Self {
331 match e {
332 // Two variants, one arm, deliberately — see above.
333 crate::transport::DialError::InvalidAddress(s)
334 | crate::transport::DialError::LocalSocket(s) => ConnectionError::InvalidAddress(s),
335 crate::transport::DialError::TlsConfig(s) => ConnectionError::TlsConfig(s),
336 crate::transport::DialError::Transport(e) => ConnectionError::Transport(e),
337 }
338 }
339}
340
341/// Transport type for the connection.
342#[derive(Debug, Clone)]
343pub enum TransportType {
344 /// Raw QUIC via quinn. The `addr` field should be `host:port`.
345 Quic,
346 /// WebTransport via wtransport. The `url` field is the WebTransport URL.
347 WebTransport {
348 /// The WebTransport endpoint URL (e.g., `https://host:port/path`).
349 url: String,
350 },
351}
352
353/// Configuration for a MoQT client connection.
354///
355/// Both `draft` and `transport` are required -- there is no `Default` impl.
356pub struct ClientConfig {
357 /// The MoQT draft version to use (primary, determines codec/framing).
358 pub draft: DraftVersion,
359 /// The transport type (QUIC or WebTransport).
360 pub transport: TransportType,
361 /// Whether to skip TLS certificate verification (for testing).
362 pub skip_cert_verification: bool,
363 /// Custom CA certificates to trust (DER-encoded).
364 pub ca_certs: Vec<Vec<u8>>,
365 /// Setup parameters to include in CLIENT_SETUP (e.g., auth tokens).
366 pub setup_parameters: Vec<KeyValuePair>,
367}
368
369impl ClientConfig {
370 /// Returns the ALPN protocol identifiers for the transport.
371 pub fn alpn(&self) -> Vec<Vec<u8>> {
372 match &self.transport {
373 TransportType::Quic => vec![self.draft.quic_alpn().to_vec()],
374 TransportType::WebTransport { .. } => vec![b"h3".to_vec()],
375 }
376 }
377}
378
379/// A framed writer for a send stream. Handles MoQT length-prefixed framing.
380pub struct FramedSendStream {
381 inner: SendStream,
382 draft: DraftVersion,
383 /// Stateful subgroup object writer.
384 subgroup_io: Option<SubgroupObjectReader>,
385}
386
387impl FramedSendStream {
388 /// Create a new framed send stream for the given draft version.
389 pub fn new(inner: SendStream, draft: DraftVersion) -> Self {
390 Self { inner, draft, subgroup_io: None }
391 }
392
393 /// Get the transport-level stream ID.
394 pub fn stream_id(&self) -> u64 {
395 self.inner.stream_id()
396 }
397
398 /// Write a control message to the stream with type+length framing.
399 /// Returns the raw bytes that were written (for event capture).
400 pub async fn write_control(
401 &mut self,
402 msg: &AnyControlMessage,
403 ) -> Result<Vec<u8>, ConnectionError> {
404 let mut buf = Vec::new();
405 msg.encode(&mut buf)?;
406 self.inner.write_all(&buf).await?;
407 Ok(buf)
408 }
409
410 /// Write a subgroup stream header. Also initializes the internal
411 /// delta-encoding state used by
412 /// [`FramedSendStream::write_subgroup_object`].
413 ///
414 /// The header is refused, and nothing is written, if its fields disagree
415 /// with its own stream type. That check has to happen here rather than at
416 /// the first object: the type is what every object after it is framed
417 /// against, so a header that went out saying the wrong thing cannot be
418 /// taken back.
419 pub async fn write_subgroup_header(
420 &mut self,
421 header: &AnySubgroupHeader,
422 ) -> Result<(), ConnectionError> {
423 let mut buf = Vec::new();
424 header.encode_stream_checked(&mut buf)?;
425 self.inner.write_all(&buf).await?;
426 // Clippy would rather see these two arms as an `if let`, and rustc rejects
427 // that in a single-draft build, where the pattern is irrefutable. Only a
428 // `match` satisfies both.
429 #[allow(clippy::single_match)]
430 match header {
431 AnySubgroupHeader::Draft22(ref header) => {
432 self.subgroup_io = Some(SubgroupObjectReader::new(header));
433 }
434 // Only this draft's header seeds the object reader. With draft 22 the only enabled
435 // draft `AnySubgroupHeader` has a single variant, the arm above is exhaustive and this
436 // one unreachable. Compiled in every configuration with the lint allowed, rather than
437 // gated on a `cfg` naming the other drafts: such a list has to be edited in
438 // every draft module whenever a draft is added, and a copy that omits one leaves this
439 // match non-exhaustive.
440 #[allow(unreachable_patterns)]
441 _ => {}
442 }
443 Ok(())
444 }
445
446 /// Write a fetch response header.
447 pub async fn write_fetch_header(
448 &mut self,
449 header: &AnyFetchHeader,
450 ) -> Result<(), ConnectionError> {
451 let mut buf = Vec::new();
452 header.encode_stream(&mut buf);
453 self.inner.write_all(&buf).await?;
454 Ok(())
455 }
456
457 /// Append a draft-22 subgroup object to the stream using the
458 /// stateful writer seeded from
459 /// [`FramedSendStream::write_subgroup_header`].
460 pub async fn write_subgroup_object(
461 &mut self,
462 object: &SubgroupObject,
463 ) -> Result<(), ConnectionError> {
464 let writer = self
465 .subgroup_io
466 .as_mut()
467 .ok_or(ConnectionError::DataStreamState("subgroup header not written yet"))?;
468 let mut buf = Vec::new();
469 writer.write_object(object, &mut buf)?;
470 self.inner.write_all(&buf).await?;
471 Ok(())
472 }
473
474 /// Append a fetch object to the stream.
475 ///
476 /// The fetch stream had a header writer and no object writer, so a caller
477 /// could open one and put nothing on it through this type. The subgroup
478 /// stream has had both since the writer was introduced.
479 ///
480 /// The declared length comes from the payload rather than from the caller's
481 /// field: a header that disagrees with the bytes beside it desynchronises
482 /// every object after it on the stream, and nothing downstream can recover.
483 ///
484 /// # Errors
485 ///
486 /// [`ConnectionError::Codec`] if the header's fields disagree with the
487 /// Serialization Flags that announce them, which the encoder refuses rather
488 /// than writing a frame its own reader cannot take apart.
489 pub async fn write_fetch_object(
490 &mut self,
491 header: &FetchObjectHeader,
492 payload: &[u8],
493 ) -> Result<(), ConnectionError> {
494 let mut header = header.clone();
495 header.payload_length = VarInt::from_usize(payload.len());
496 let mut buf = Vec::new();
497 header.encode(&mut buf)?;
498 buf.extend_from_slice(payload);
499 self.inner.write_all(&buf).await?;
500 Ok(())
501 }
502
503 /// Finish the stream (send FIN).
504 pub async fn finish(&mut self) -> Result<(), ConnectionError> {
505 self.inner.finish()?;
506 Ok(())
507 }
508
509 /// Reset the stream with `code`, telling the peer transmission was
510 /// abandoned rather than completed.
511 ///
512 /// Dropping a send stream sends a FIN, which claims the stream ended
513 /// cleanly; this is the only way to say the opposite. See
514 /// [`SendStream::reset`].
515 pub fn reset(&mut self, code: u64) -> Result<(), ConnectionError> {
516 self.inner.reset(code)?;
517 Ok(())
518 }
519
520 /// Returns the draft version this stream is framed for.
521 pub fn draft(&self) -> DraftVersion {
522 self.draft
523 }
524}
525
526/// What an Object Status makes of an object here.
527///
528/// Two answers where drafts 08 through 13 have three, and the missing one is
529/// the point: the end-of-track status settles where the track ended and is
530/// judged against nothing, because the rule about where one may be placed is
531/// not in this draft. `a_track_may_end_where_it_has_already_been.rs` asserts
532/// that acceptance.
533///
534/// Every other status is a statement about objects rather than one of them.
535fn object_role(status: Option<u64>) -> ObjectRole {
536 match status {
537 None | Some(0x0) => ObjectRole::Produced,
538 Some(0x4) => ObjectRole::EndsTrack(None),
539 _ => ObjectRole::Neither,
540 }
541}
542
543/// A framed reader for a recv stream. Handles MoQT varint-length decoding.
544pub struct FramedRecvStream {
545 inner: RecvStream,
546 buf: BytesMut,
547 draft: DraftVersion,
548 /// Stateful subgroup object reader.
549 subgroup_io: Option<SubgroupObjectReader>,
550 /// Stateful fetch object reader, started by
551 /// [`FramedRecvStream::begin_fetch_objects`] rather than by the fetch
552 /// header, which does not carry the order.
553 fetch_io: Option<FetchObjectReader>,
554 /// The record this stream's objects are measured against, and the Group ID
555 /// its header named.
556 ///
557 /// One group for the whole stream: a subgroup header names it once and no
558 /// object header repeats it. `None` on a stream that was never given one -
559 /// a stream for an alias no live binding names, and every stream built
560 /// outside [`Connection::accept_subgroup_stream`].
561 tracking: Option<(TrackObjects, u64)>,
562 /// The bytes of the last control frame a capturing read refused.
563 refused: Option<Vec<u8>>,
564}
565
566impl FramedRecvStream {
567 /// Create a new framed receive stream for the given draft version.
568 pub fn new(inner: RecvStream, draft: DraftVersion) -> Self {
569 Self {
570 inner,
571 buf: BytesMut::with_capacity(4096),
572 draft,
573 subgroup_io: None,
574 fetch_io: None,
575 tracking: None,
576 refused: None,
577 }
578 }
579
580 /// The bytes of the control frame the last capturing read refused.
581 pub(crate) fn take_refused(&mut self) -> Option<Vec<u8>> {
582 self.refused.take()
583 }
584
585 /// Keep the first `len` buffered bytes as a refused frame when the read is
586 /// capturing, and hand `err` back.
587 fn refuse(&mut self, capture_raw: bool, len: usize, err: ConnectionError) -> ConnectionError {
588 if capture_raw {
589 self.refused = Some(self.buf[..len].to_vec());
590 }
591 err
592 }
593
594 /// Get the transport-level stream ID.
595 pub fn stream_id(&self) -> u64 {
596 self.inner.stream_id()
597 }
598
599 /// Measure this stream's objects against `objects`, all of them in `group`.
600 fn measure_objects_against(&mut self, objects: TrackObjects, group: u64) {
601 self.tracking = Some((objects, group));
602 }
603
604 /// Judge one object this stream carried against where its track ended.
605 fn note_subgroup_object(
606 &self,
607 object: u64,
608 status: Option<u64>,
609 ) -> Result<(), ConnectionError> {
610 let Some((objects, group)) = &self.tracking else { return Ok(()) };
611 let at = ObjectLocation { group: *group, object };
612 objects.note_past_final(at, object_role(status)).map_err(|end| {
613 ConnectionError::Endpoint(EndpointError::ObjectPastFinalObject {
614 alias: objects.alias(),
615 group: at.group,
616 object: at.object,
617 final_group: end.group,
618 final_object: end.object,
619 })
620 })
621 }
622
623 /// Read more data from the stream into the internal buffer.
624 async fn fill(&mut self) -> Result<bool, ConnectionError> {
625 let mut tmp = [0u8; 4096];
626 match self.inner.read(&mut tmp).await {
627 Ok(Some(n)) => {
628 self.buf.extend_from_slice(&tmp[..n]);
629 Ok(true)
630 }
631 Ok(None) => Ok(false),
632 Err(e) => Err(ConnectionError::Transport(e)),
633 }
634 }
635
636 /// Ensure at least `n` bytes are available in the buffer.
637 async fn ensure(&mut self, n: usize) -> Result<(), ConnectionError> {
638 while self.buf.len() < n {
639 if !self.fill().await? {
640 return Err(ConnectionError::UnexpectedEnd);
641 }
642 }
643 Ok(())
644 }
645
646 /// Read this stream's leading variable-length integer **without
647 /// consuming it**, and return its value.
648 ///
649 /// Every unidirectional MoQT stream on draft-22 opens with a varint
650 /// naming what it is (Section 6.4.1): 0x05 for FETCH_HEADER, 0x10-0x1D for
651 /// SUBGROUP_HEADER, and [`CONTROL_STREAM_TYPE`] for SETUP. Telling the
652 /// peer's control stream apart from a data stream means reading that
653 /// varint, and taking it off the transport would destroy it: the control
654 /// stream's type varint *is* the SETUP message's type field, so a stream
655 /// whose type had been stripped would no longer decode as a SETUP.
656 ///
657 /// Nothing is stripped. The bytes land in this reader's own buffer, and
658 /// every other method here — [`read_control`](Self::read_control),
659 /// [`read_subgroup_header`](Self::read_subgroup_header),
660 /// [`read_fetch_header`](Self::read_fetch_header) — decodes out of that
661 /// buffer and advances it only on a successful decode. A stream this was
662 /// called on is indistinguishable from one it was not, which is what
663 /// makes it safe to peek a stream and then hand it to whichever reader
664 /// the type turned out to call for.
665 ///
666 /// It reads, so it can block: a peer that opens a stream and then writes
667 /// nothing leaves this pending until a byte arrives or the stream ends.
668 ///
669 /// # Errors
670 ///
671 /// - [`ConnectionError::UnexpectedEnd`] if the stream ends before a whole
672 /// varint has arrived.
673 /// - [`ConnectionError::Transport`] if the peer reset the stream.
674 /// - [`ConnectionError::VarInt`] if the bytes are not a valid varint.
675 ///
676 /// Whatever did arrive stays in the buffer in every case.
677 pub async fn peek_stream_type(&mut self) -> Result<u64, ConnectionError> {
678 self.ensure(1).await?;
679 let type_len = self.draft.varint_len(self.buf[0]);
680 self.ensure(type_len).await?;
681 let mut cursor = &self.buf[..type_len];
682 Ok(self.draft.decode_varint(&mut cursor)?.into_inner())
683 }
684
685 /// Read a control message from the stream.
686 ///
687 /// When `capture_raw` is true, the returned tuple includes a clone of the
688 /// framed wire bytes (for observer emission). When false, the second
689 /// element is `None` and the payload clone is skipped.
690 pub async fn read_control(
691 &mut self,
692 capture_raw: bool,
693 ) -> Result<(AnyControlMessage, Option<Vec<u8>>), ConnectionError> {
694 self.refused = None;
695 // Read type ID varint
696 self.ensure(1).await?;
697 let type_len = self.draft.varint_len(self.buf[0]);
698 self.ensure(type_len).await?;
699
700 let mut cursor = &self.buf[..type_len];
701 if let Err(e) = self.draft.decode_varint(&mut cursor) {
702 return Err(self.refuse(capture_raw, type_len, e.into()));
703 }
704
705 // Draft-22: 16-bit BE payload length
706 let (payload_len, len_field_size) = if self.draft.uses_fixed_length_framing() {
707 self.ensure(type_len + 2).await?;
708 let hi = self.buf[type_len] as usize;
709 let lo = self.buf[type_len + 1] as usize;
710 ((hi << 8) | lo, 2)
711 } else {
712 self.ensure(type_len + 1).await?;
713 let payload_len_start = type_len;
714 let payload_len_varint_len = self.draft.varint_len(self.buf[payload_len_start]);
715 self.ensure(type_len + payload_len_varint_len).await?;
716 let header_len = type_len + payload_len_varint_len;
717 let mut cursor = &self.buf[payload_len_start..header_len];
718 let payload_len = match self.draft.decode_varint(&mut cursor) {
719 Ok(length) => length.into_inner() as usize,
720 Err(e) => return Err(self.refuse(capture_raw, header_len, e.into())),
721 };
722 (payload_len, payload_len_varint_len)
723 };
724
725 // Read full payload
726 let total = type_len + len_field_size + payload_len;
727 self.ensure(total).await?;
728
729 // Capture raw bytes only if requested (observer attached).
730 let raw = capture_raw.then(|| self.buf[..total].to_vec());
731
732 // Now decode the whole message
733 let mut frame = &self.buf[..total];
734 let msg = match AnyControlMessage::decode(self.draft, &mut frame) {
735 Ok(msg) => msg,
736 Err(e) => return Err(self.refuse(capture_raw, total, e.into())),
737 };
738 self.buf.advance(total);
739 Ok((msg, raw))
740 }
741
742 /// Read a subgroup stream header. Also initializes the internal
743 /// delta-decoding state.
744 pub async fn read_subgroup_header(&mut self) -> Result<AnySubgroupHeader, ConnectionError> {
745 self.ensure(1).await?;
746 loop {
747 let mut cursor = &self.buf[..];
748 match AnySubgroupHeader::decode(self.draft, &mut cursor) {
749 Ok(header) => {
750 let consumed = self.buf.len() - cursor.remaining();
751 self.buf.advance(consumed);
752 // Clippy would rather see these two arms as an `if let`, and rustc rejects
753 // that in a single-draft build, where the pattern is irrefutable. Only a
754 // `match` satisfies both.
755 #[allow(clippy::single_match)]
756 match header {
757 AnySubgroupHeader::Draft22(ref header) => {
758 self.subgroup_io = Some(SubgroupObjectReader::new(header));
759 }
760 // Only this draft's header seeds the object reader. With draft 22 the only
761 // enabled draft `AnySubgroupHeader` has a single variant, the arm above is
762 // exhaustive and this one unreachable. Compiled in every configuration with
763 // the lint allowed, rather than gated on a `cfg` naming every other
764 // draft: such a list has to be edited in every draft module whenever a
765 // draft is added, and a copy that omits one leaves this match
766 // non-exhaustive.
767 #[allow(unreachable_patterns)]
768 _ => {}
769 }
770 return Ok(header);
771 }
772 Err(e) if e.is_incomplete() => {
773 if !self.fill().await? {
774 return Err(ConnectionError::UnexpectedEnd);
775 }
776 }
777 Err(e) => return Err(ConnectionError::Codec(e)),
778 }
779 }
780 }
781
782 /// Read a fetch response header.
783 pub async fn read_fetch_header(&mut self) -> Result<AnyFetchHeader, ConnectionError> {
784 self.ensure(1).await?;
785 loop {
786 let mut cursor = &self.buf[..];
787 match AnyFetchHeader::decode(self.draft, &mut cursor) {
788 Ok(header) => {
789 let consumed = self.buf.len() - cursor.remaining();
790 self.buf.advance(consumed);
791 return Ok(header);
792 }
793 Err(e) if e.is_incomplete() => {
794 if !self.fill().await? {
795 return Err(ConnectionError::UnexpectedEnd);
796 }
797 }
798 Err(e) => return Err(ConnectionError::Codec(e)),
799 }
800 }
801 }
802
803 /// Read the next draft-22 subgroup object from this stream using
804 /// the stateful reader seeded by
805 /// [`FramedRecvStream::read_subgroup_header`].
806 ///
807 /// Errors with [`ConnectionError::PropertiesOnNonNormalStatus`] on an
808 /// Object that carries properties on a status other than Normal, which
809 /// draft-22 Section 11.1.2 answers with a session close. The object is
810 /// consumed from the stream before the check, so the reader stays in step
811 /// with the wire and a caller that reports the violation and reads on sees
812 /// the following object rather than a re-parse of this one.
813 pub async fn read_subgroup_object(&mut self) -> Result<SubgroupObject, ConnectionError> {
814 if self.subgroup_io.is_none() {
815 return Err(ConnectionError::DataStreamState("subgroup header not read yet"));
816 }
817 loop {
818 let reader = self.subgroup_io.as_mut().unwrap();
819 let mut probe = reader.clone();
820 let mut cursor = &self.buf[..];
821 match probe.read_object(&mut cursor) {
822 Ok(obj) => {
823 let consumed = self.buf.len() - cursor.remaining();
824 self.buf.advance(consumed);
825 *reader = probe;
826 if !obj.properties_permitted() {
827 return Err(ConnectionError::PropertiesOnNonNormalStatus {
828 object_id: obj.object_id.into_inner(),
829 properties_len: obj.extension_headers.len(),
830 status: obj.status(),
831 });
832 }
833 self.note_subgroup_object(
834 obj.object_id.into_inner(),
835 obj.object_status.map(|s| s as u64),
836 )?;
837 return Ok(obj);
838 }
839 Err(e) if e.is_incomplete() => {
840 if !self.fill().await? {
841 return Err(ConnectionError::UnexpectedEnd);
842 }
843 }
844 // The codec refuses properties on a non-Normal status as
845 // `InvalidField`, one of many readings of that variant. Its
846 // framing-only reader accepts them, which tells this case apart
847 // from the others and keeps the stream in step.
848 Err(CodecError::InvalidField) => {
849 let mut framing = reader.clone();
850 let mut cursor = &self.buf[..];
851 if let Ok(meta) = framing.read_object_meta(&mut cursor) {
852 let status = meta
853 .status
854 .and_then(moqtap_codec::draft22::types::ObjectStatus::from_u64);
855 if let Some(status) = status.filter(|s| {
856 meta.extension_headers_len > 0
857 && *s != moqtap_codec::draft22::types::ObjectStatus::Normal
858 }) {
859 let consumed = self.buf.len() - cursor.remaining();
860 self.buf.advance(consumed);
861 *reader = framing;
862 return Err(ConnectionError::PropertiesOnNonNormalStatus {
863 object_id: meta.object_id,
864 properties_len: meta.extension_headers_len as usize,
865 status,
866 });
867 }
868 }
869 return Err(ConnectionError::Codec(CodecError::InvalidField));
870 }
871 Err(e) => return Err(ConnectionError::Codec(e)),
872 }
873 }
874 }
875
876 /// Read the next draft-22 fetch header from this stream.
877 pub async fn read_fetch_stream_header(&mut self) -> Result<FetchHeader, ConnectionError> {
878 loop {
879 let mut cursor = &self.buf[..];
880 match FetchHeader::decode(&mut cursor) {
881 Ok(hdr) => {
882 let consumed = self.buf.len() - cursor.remaining();
883 self.buf.advance(consumed);
884 return Ok(hdr);
885 }
886 Err(e) if e.is_incomplete() => {
887 if !self.fill().await? {
888 return Err(ConnectionError::UnexpectedEnd);
889 }
890 }
891 Err(e) => return Err(ConnectionError::Codec(e)),
892 }
893 }
894 }
895
896 /// Stop accepting data on this stream with `code` as the `STOP_SENDING`
897 /// application error code, discarding anything unread.
898 ///
899 /// Dropping a receive stream also stops it, but with a hard-coded 0. See
900 /// [`RecvStream::stop`].
901 pub fn stop(&mut self, code: u64) -> Result<(), ConnectionError> {
902 self.inner.stop(code)?;
903 Ok(())
904 }
905
906 /// Wait for the peer to reset this stream, consuming nothing.
907 ///
908 /// See [`RecvStream::received_reset`] for what `Ok(None)` means and why a
909 /// caller must not re-poll after it.
910 pub async fn received_reset(&mut self) -> Result<Option<u64>, ConnectionError> {
911 Ok(self.inner.received_reset().await?)
912 }
913
914 /// Start reading fetch objects on this stream, in a response whose Groups
915 /// arrive in `group_order`.
916 ///
917 /// Draft-22 has to be told, as draft-18 does. Section 11.4.1.1 makes a
918 /// Group ID Delta count downward under Descending and upward under
919 /// Ascending, so the same bytes are two different Locations and nothing on
920 /// the data stream says which. The order is the one the **request** asked
921 /// for — Section 3.2.1: "A publisher MUST send fetched groups in the
922 /// requested group order (see Section 9.20.8)." — carried by the
923 /// GROUP_ORDER parameter on the FETCH, or by its absence, which Section
924 /// 9.20.8 reads as Ascending. Either way it is a control message this
925 /// stream never sees. Drafts 15, 16 and 17 resolve their fetch objects
926 /// without an order, because none of those drafts encodes an ID as a
927 /// difference.
928 ///
929 /// Call it after [`FramedRecvStream::read_fetch_header`] and before the
930 /// first [`FramedRecvStream::read_fetch_object`]; calling it again restarts
931 /// the running state, which is what a second fetch stream on the same
932 /// connection would want and what the middle of one would not.
933 pub fn begin_fetch_objects(&mut self, group_order: GroupOrder) {
934 self.fetch_io = Some(FetchObjectReader::new(group_order));
935 }
936
937 /// Read the next draft-22 fetch object and its payload.
938 ///
939 /// The mirror of [`FramedSendStream::write_fetch_object`]. What comes back
940 /// is a [`FetchObject`] rather than a header: draft-22's reader resolves the
941 /// delta-encoded fields, so the Group ID, Subgroup ID, Object ID and
942 /// Priority it carries are the frame's own values rather than differences
943 /// from the frame before. `object.header` is the frame exactly as it
944 /// arrived, for a caller forwarding the bytes on.
945 ///
946 /// The payload comes back with it for the reason the codec leaves it on the
947 /// wire: `payload_length` says how many bytes follow, and a reader that
948 /// takes the wrong number of them desynchronises every later object on the
949 /// stream. Doing it here is the only place that count and the buffer are
950 /// both in hand.
951 ///
952 /// # Errors
953 ///
954 /// [`ConnectionError::DataStreamState`] when
955 /// [`FramedRecvStream::begin_fetch_objects`] has not been called,
956 /// [`ConnectionError::UnexpectedEnd`] when the stream ends inside the header
957 /// or inside the payload it declared, and [`ConnectionError::Codec`] on
958 /// every rule Section 11.4.1.1 states — a first Object that inherits, a
959 /// delta that runs off either end of the space, or an Object ID above
960 /// 2^64-1.
961 ///
962 /// A Prior Group ID Gap or Prior Object ID Gap fault the stream shows is
963 /// returned as [`CodecError::MalformedTrack`], and a property block that
964 /// does not parse as [`CodecError::MalformedObjectProperties`];
965 /// [`Connection::requests_to_cancel_for_fetch_stream`] names the requests to
966 /// cancel.
967 pub async fn read_fetch_object(&mut self) -> Result<(FetchObject, Vec<u8>), ConnectionError> {
968 if self.fetch_io.is_none() {
969 return Err(ConnectionError::DataStreamState("fetch object reader not started"));
970 }
971 let object = loop {
972 let reader = self.fetch_io.as_mut().unwrap();
973 // Advanced on a probe and committed only once the whole header was
974 // there to read: a reader advanced by a short read would resolve
975 // the next Object against a half-read one.
976 let mut probe = reader.clone();
977 let mut cursor = &self.buf[..];
978 match probe.read_object_header(&mut cursor) {
979 Ok(object) => {
980 let consumed = self.buf.len() - cursor.remaining();
981 self.buf.advance(consumed);
982 *reader = probe;
983 break object;
984 }
985 Err(e) if e.is_incomplete() => {
986 if !self.fill().await? {
987 return Err(ConnectionError::UnexpectedEnd);
988 }
989 }
990 Err(e) => return Err(ConnectionError::Codec(e)),
991 }
992 };
993 let payload = self.read_object_payload(&object.header.payload_length).await?;
994 Ok((object, payload))
995 }
996
997 /// Take the `length` payload bytes that follow a fetch object's header.
998 ///
999 /// Separate from the header read because the header is decoded from a probe
1000 /// cursor that may have to be retried after a fill, and the payload is a
1001 /// flat byte count that never is.
1002 async fn read_object_payload(&mut self, length: &VarInt) -> Result<Vec<u8>, ConnectionError> {
1003 let length = length.into_inner() as usize;
1004 self.ensure(length).await?;
1005 let payload = self.buf[..length].to_vec();
1006 self.buf.advance(length);
1007 Ok(payload)
1008 }
1009
1010 /// Returns the draft version this stream is framed for.
1011 pub fn draft(&self) -> DraftVersion {
1012 self.draft
1013 }
1014}
1015
1016/// Which of the seven message types draft-22 Section 6.3 lets a bidirectional
1017/// stream begin with opened a request stream.
1018///
1019/// Draft-22 Section 6.3: "A request stream begins with one of these seven
1020/// message types: TRACK_STATUS, SUBSCRIBE, PUBLISH, FETCH, PUBLISH_NAMESPACE,
1021/// SUBSCRIBE_NAMESPACE, and SUBSCRIBE_TRACKS. Bidirectional streams MUST NOT
1022/// begin with any other message type unless negotiated."
1023///
1024/// The set is per draft and is not stable across drafts: draft-17 had six of
1025/// these, and draft-18 — whose set draft-22 keeps — both added
1026/// SUBSCRIBE_TRACKS and renumbered SUBSCRIBE_NAMESPACE from 0x11 to 0x50. A
1027/// seven-variant enum here is what makes it impossible to label a draft-22
1028/// request stream with a kind this draft does not have.
1029#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1030pub enum RequestKind {
1031 /// TRACK_STATUS, 0x0D.
1032 TrackStatus,
1033 /// SUBSCRIBE, 0x03.
1034 Subscribe,
1035 /// PUBLISH, 0x1D.
1036 Publish,
1037 /// FETCH, 0x16. Draft-22 has one shape of FETCH: Section 9.11 has no
1038 /// `Fetch Type` field and so no standalone/joining distinction (draft-20
1039 /// removed both).
1040 Fetch,
1041 /// PUBLISH_NAMESPACE, 0x06.
1042 PublishNamespace,
1043 /// SUBSCRIBE_NAMESPACE, 0x50 on this draft — 0x11 on draft-17.
1044 SubscribeNamespace,
1045 /// SUBSCRIBE_TRACKS, 0x51. Added in draft-18; draft-17 has no such
1046 /// message and no such request stream.
1047 SubscribeTracks,
1048}
1049
1050impl RequestKind {
1051 /// The message type a request stream of this kind begins with.
1052 pub const fn message_type(self) -> MessageType {
1053 match self {
1054 RequestKind::TrackStatus => MessageType::TrackStatus,
1055 RequestKind::Subscribe => MessageType::Subscribe,
1056 RequestKind::Publish => MessageType::Publish,
1057 RequestKind::Fetch => MessageType::Fetch,
1058 RequestKind::PublishNamespace => MessageType::PublishNamespace,
1059 RequestKind::SubscribeNamespace => MessageType::SubscribeNamespace,
1060 RequestKind::SubscribeTracks => MessageType::SubscribeTracks,
1061 }
1062 }
1063
1064 /// The kind of request stream `ty` opens, or `None` when it opens none.
1065 ///
1066 /// The inverse of [`message_type`](Self::message_type) and the classifier
1067 /// the accept path runs on the first message of a bidirectional stream the
1068 /// peer opened. `None` is the PROTOCOL_VIOLATION case of draft-22
1069 /// Section 6.3.
1070 ///
1071 /// Like [`starts_a_request_stream`] the match is exhaustive over
1072 /// [`MessageType`] with **no wildcard arm**, so a message type added in a
1073 /// later draft stops this compiling until someone classifies it; the unit
1074 /// test below holds the two functions to the same answer for every
1075 /// assigned type, so neither can drift from the other.
1076 pub const fn from_message_type(ty: MessageType) -> Option<RequestKind> {
1077 match ty {
1078 MessageType::TrackStatus => Some(RequestKind::TrackStatus),
1079 MessageType::Subscribe => Some(RequestKind::Subscribe),
1080 MessageType::Publish => Some(RequestKind::Publish),
1081 MessageType::Fetch => Some(RequestKind::Fetch),
1082 MessageType::PublishNamespace => Some(RequestKind::PublishNamespace),
1083 MessageType::SubscribeNamespace => Some(RequestKind::SubscribeNamespace),
1084 MessageType::SubscribeTracks => Some(RequestKind::SubscribeTracks),
1085 MessageType::Setup
1086 | MessageType::GoAway
1087 | MessageType::Namespace
1088 | MessageType::NamespaceDone
1089 | MessageType::PublishSkipped
1090 | MessageType::RequestUpdate
1091 | MessageType::SubscribeOk
1092 | MessageType::RequestOk
1093 | MessageType::RequestError
1094 | MessageType::FetchOk
1095 | MessageType::PublishDone
1096 // New in draft-20. Section 9.10 puts it on "a subscription's
1097 // bidirectional stream", which is a stream a SUBSCRIBE or a PUBLISH
1098 // already opened, so it begins none of its own.
1099 | MessageType::PublishStateNotify => None,
1100 }
1101 }
1102}
1103
1104/// Which side opened the bidirectional stream a request travels on.
1105///
1106/// Draft-22 Section 6.3 gives every request a bidirectional stream, and either
1107/// endpoint may open one. The two directions are not symmetric — one side owes
1108/// a response and the other is waiting for it — so a [`RequestStream`] carries
1109/// this to say which side of that it is on.
1110#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1111pub enum RequestOrigin {
1112 /// This endpoint opened the stream and wrote the request on it. What comes
1113 /// back is a response, and dropping the handle cancels the request.
1114 Local,
1115 /// The peer opened the stream; this endpoint owes it a response. What
1116 /// comes back is a follow-up to the peer's request, never a response, and
1117 /// dropping the handle abandons a request that was asked of us.
1118 Peer,
1119}
1120/// Whether draft-22 Table 5 places this message on a request stream that is
1121/// already open.
1122///
1123/// All five of the messages Table 5 marks "Request" without their beginning one:
1124/// REQUEST_UPDATE modifies the request its stream carries (Section 9.5),
1125/// NAMESPACE and NAMESPACE_DONE report namespaces on the SUBSCRIBE_NAMESPACE
1126/// stream that asked for them (Section 9.16 and Section 9.17), PUBLISH_SKIPPED
1127/// names a track on the SUBSCRIBE_TRACKS stream that asked for it (Section
1128/// 9.18), and PUBLISH_STATE_NOTIFY — new in draft-20 — reports a change on the
1129/// subscription's own stream (Section 9.10).
1130///
1131/// `Endpoint::receive_message` already closes the session over all five when
1132/// they arrive on the control stream. Without this the client would write on the
1133/// control stream exactly what its own peer half refuses to read there.
1134fn belongs_on_a_request_stream(ty: MessageType) -> bool {
1135 matches!(
1136 ty,
1137 MessageType::RequestUpdate
1138 | MessageType::Namespace
1139 | MessageType::NamespaceDone
1140 | MessageType::PublishSkipped
1141 | MessageType::PublishStateNotify
1142 )
1143}
1144
1145/// Whether `ty` is one of the seven message types draft-22 Section 6.3 lets a
1146/// bidirectional stream begin with.
1147///
1148/// The match is exhaustive over [`MessageType`] and deliberately has **no
1149/// wildcard arm**. That is the drift guard: `MessageType` is not
1150/// `#[non_exhaustive]`, so the day a draft gains a message type this stops
1151/// compiling until someone says here whether the new type opens a request
1152/// stream. A wildcard would silently answer "no" for it.
1153///
1154/// Classification is over the typed `MessageType`, never over a raw `u64`,
1155/// because the number alone does not say which registry it came from: on
1156/// draft-22, 0x50 is SUBSCRIBE_NAMESPACE as a control message type and also a
1157/// SUBGROUP_HEADER as a unidirectional stream type.
1158pub const fn starts_a_request_stream(ty: MessageType) -> bool {
1159 match ty {
1160 // The seven that begin a request stream.
1161 MessageType::TrackStatus
1162 | MessageType::Subscribe
1163 | MessageType::Publish
1164 | MessageType::Fetch
1165 | MessageType::PublishNamespace
1166 | MessageType::SubscribeNamespace
1167 | MessageType::SubscribeTracks => true,
1168 // Messages that cannot begin a request stream. SETUP is the control
1169 // stream's own type varint. NAMESPACE, NAMESPACE_DONE, PUBLISH_SKIPPED
1170 // and REQUEST_UPDATE all travel ON a request stream — Table 5 gives
1171 // every one of them the Stream value "Request" — but none of them
1172 // opens one: the first three report on the namespace or publication of
1173 // the stream that is already there, and REQUEST_UPDATE modifies a
1174 // request that already has a stream, draft-22 Section 9.5 putting it
1175 // "on the same bidi stream as the request". This function answers
1176 // *does this message open a stream*, not *does it belong on one*.
1177 //
1178 // GOAWAY is here because it opens nothing, not because it is confined
1179 // to the control stream: draft-18 gave it an optional Request ID
1180 // present only on the control stream, draft-19 removed the field
1181 // outright and draft-22 keeps it gone, leaving one wire form for both
1182 // places. It may follow a
1183 // request on an already-open request stream — see
1184 // [`Connection::send_on_request_stream`], which refuses nothing.
1185 MessageType::Setup
1186 | MessageType::GoAway
1187 | MessageType::Namespace
1188 | MessageType::NamespaceDone
1189 | MessageType::PublishSkipped
1190 | MessageType::RequestUpdate => false,
1191 // Responses. They cannot begin a stream: they arrive on the request
1192 // stream their request opened, which is why they carry no request id
1193 // of their own on this draft. There is no PublishOk here — draft-18
1194 // folded PUBLISH_OK into REQUEST_OK and draft-22 keeps it that way.
1195 MessageType::SubscribeOk
1196 | MessageType::RequestOk
1197 | MessageType::RequestError
1198 | MessageType::FetchOk
1199 | MessageType::PublishDone => false,
1200 // Not a response — Section 9.10 makes it unilateral, answered with
1201 // nothing — but it opens no stream either: it travels on the
1202 // subscription's, which a SUBSCRIBE or a PUBLISH already opened.
1203 MessageType::PublishStateNotify => false,
1204 }
1205}
1206
1207/// One request and its answer, on a bidirectional stream of their own.
1208///
1209/// Draft-22 Section 6.3 keeps requests off the control plane: each request is
1210/// the first message on a bidirectional stream it opens, and the response
1211/// comes back on that same stream. Responses carry no request id on this
1212/// draft — **the stream is the correlation**, which is why this handle exists
1213/// and why a bare request id is no longer enough to find an answer.
1214///
1215/// # Reading and writing go through the connection
1216///
1217/// This handle owns both halves of the stream but not the session, so the
1218/// endpoint state machine and the observer stay where they were. Read a
1219/// response with [`Connection::recv_on_request_stream`], write a follow-up with
1220/// [`Connection::send_on_request_stream`], and cancel with
1221/// [`Connection::cancel_request_stream`].
1222///
1223/// [`cancel`](Self::cancel) and [`peer_cancelled`](Self::peer_cancelled) are on
1224/// the handle because they touch the stream and nothing else, and [`Drop`]
1225/// needs the first of them. Neither moves the endpoint's record of the request,
1226/// which is why the connection carries a pair of its own.
1227///
1228/// # Dropping this cancels the request
1229///
1230/// A dropped handle resets the send half and sends `STOP_SENDING` on the
1231/// receive half, both with [`REQUEST_CANCELLED`], unless the stream was
1232/// already cancelled or finished. Letting the default drop stand would send a
1233/// FIN instead, telling the peer the request ended *cleanly* when it was
1234/// abandoned.
1235///
1236/// The consequence is sharp and worth stating: a live subscription's request
1237/// stream must be **held for the subscription's life**, because PUBLISH_DONE
1238/// arrives on it. Keeping only [`request_id`](Self::request_id) and letting
1239/// the handle fall out of scope cancels the subscription.
1240///
1241/// What a drop cannot do is say so at the endpoint. [`Drop`] holds the stream
1242/// and not the session, so the request stays where it was in the endpoint's
1243/// record while the stream it travelled on is gone. Call
1244/// [`Connection::cancel_request_stream`] wherever that record matters.
1245///
1246/// # Which side opened it changes what this handle does
1247///
1248/// [`origin`](Self::origin) says whether this endpoint opened the stream or
1249/// accepted it, and three behaviours turn on it: reads dispatch as responses
1250/// or as follow-ups to the peer's request, the `respond_*` helpers refuse a
1251/// stream this endpoint opened, and [`Drop`] resets with
1252/// [`REQUEST_UNANSWERED`] rather than [`REQUEST_CANCELLED`]. Everything else —
1253/// [`cancel`](Self::cancel), [`peer_cancelled`](Self::peer_cancelled),
1254/// [`Connection::send_on_request_stream`] — is the same in both directions.
1255/// Draft-22 Section 6.4.2.3 is explicit that a cancel is available to both:
1256/// "Senders cancel requests if the response is no longer of interest;
1257/// Receivers cancel requests if they are unable to or choose not to respond."
1258///
1259/// [`finish`](Self::finish) is the one act that is constrained rather than
1260/// merely different: Section 6.4.2.2 forbids a FIN before the messages that
1261/// direction still owes.
1262///
1263/// All fields are private so the shape can grow without breaking callers.
1264#[must_use = "dropping a request stream cancels the request; hold it until the response arrives"]
1265pub struct RequestStream {
1266 send: FramedSendStream,
1267 recv: FramedRecvStream,
1268 request_id: VarInt,
1269 kind: RequestKind,
1270 /// The unidirectional stream this request's objects are being served on.
1271 ///
1272 /// Only a FETCH has one, and only once the caller has opened it through
1273 /// [`Connection::open_fetch_stream_on`]. Held here rather than in a table
1274 /// on the connection because the request stream is already the thing that
1275 /// knows what this request still owes, and because a handle kept beside
1276 /// the request cannot outlive it.
1277 fetch_data: Option<FramedSendStream>,
1278 draft: DraftVersion,
1279 stream_id: u64,
1280 cancelled: bool,
1281 finished: bool,
1282 origin: RequestOrigin,
1283 /// Whether a `respond_*` helper has written a response on this stream.
1284 /// True on a [`RequestOrigin::Peer`] stream from the response written on
1285 /// it, and on a [`RequestOrigin::Local`] one from the answer to an update
1286 /// the peer sent, which is the only response this endpoint writes on a
1287 /// stream of its own.
1288 responded: bool,
1289 /// Whether this endpoint is the publisher of a subscription established on
1290 /// this stream and has not yet sent PUBLISH_DONE.
1291 ///
1292 /// True from the PUBLISH this endpoint sent, and from the SUBSCRIBE_OK it
1293 /// wrote answering a peer's SUBSCRIBE; false again once PUBLISH_DONE is
1294 /// out. It is what draft-22 Section 6.4.2.2's second clause is checked
1295 /// against in [`finish`](Self::finish).
1296 owes_publish_done: bool,
1297}
1298
1299impl RequestStream {
1300 /// The request id the endpoint allocated for this request.
1301 ///
1302 /// Useful for logging and for endpoint calls that still take one. It is
1303 /// not enough to find the response: draft-22 responses carry no request
1304 /// id, so only this stream identifies them.
1305 pub fn request_id(&self) -> VarInt {
1306 self.request_id
1307 }
1308
1309 /// Which of the seven request types opened this stream.
1310 pub fn kind(&self) -> RequestKind {
1311 self.kind
1312 }
1313
1314 /// The transport-level stream identifier, the same one
1315 /// [`ClientEvent::StreamOpened`] reports for data streams.
1316 pub fn stream_id(&self) -> u64 {
1317 self.stream_id
1318 }
1319
1320 /// The draft version this stream is framed for.
1321 pub fn draft(&self) -> DraftVersion {
1322 self.draft
1323 }
1324
1325 /// Which side opened this stream.
1326 ///
1327 /// [`RequestOrigin::Peer`] means this endpoint owes a response and the
1328 /// `respond_*` helpers apply; [`RequestOrigin::Local`] means it is waiting
1329 /// for one.
1330 pub fn origin(&self) -> RequestOrigin {
1331 self.origin
1332 }
1333
1334 /// Whether a response has been written on this stream by one of the
1335 /// `respond_*` helpers.
1336 ///
1337 /// On a [`RequestOrigin::Local`] stream this says an update the peer sent
1338 /// was answered here, not that the request itself was: that one is
1339 /// answered by the peer.
1340 pub fn responded(&self) -> bool {
1341 self.responded
1342 }
1343
1344 /// Whether this endpoint still owes the peer a PUBLISH_DONE on this stream.
1345 ///
1346 /// True for a PUBLISH this endpoint sent and for a peer's SUBSCRIBE it
1347 /// answered with SUBSCRIBE_OK — the two ways draft-22 Section 6.4.2.2's
1348 /// "publisher of an Established subscription" is reached — until
1349 /// [`Connection::publish_done`] or [`Connection::publish_done_on`] has run.
1350 /// While it is true, [`finish`](Self::finish) refuses.
1351 pub fn owes_publish_done(&self) -> bool {
1352 self.owes_publish_done
1353 }
1354
1355 /// The stream this request's objects are being served on, if one is open.
1356 ///
1357 /// Only a FETCH answered through
1358 /// [`Connection::open_fetch_stream_on`](Connection::open_fetch_stream_on)
1359 /// has one. Writing objects goes through this rather than through a handle
1360 /// the caller keeps, so that the connection can still reach the stream
1361 /// when a rule says to reset it.
1362 pub fn fetch_data(&mut self) -> Option<&mut FramedSendStream> {
1363 self.fetch_data.as_mut()
1364 }
1365
1366 /// Reset the fetch data stream, if one was opened, and forget it.
1367 ///
1368 /// The sentence that requires this names no error code, so the code comes
1369 /// from the registry rather than from here: CANCELLED is "the stream was
1370 /// cancelled by either endpoint", which is what a publisher abandoning the
1371 /// objects it was serving has done.
1372 fn reset_fetch_data(&mut self) {
1373 if let Some(mut framed) = self.fetch_data.take() {
1374 let _ = framed.reset(StreamResetErrorCode::Cancelled as u64);
1375 }
1376 }
1377
1378 /// Whether [`cancel`](Self::cancel) has already run on this handle.
1379 ///
1380 /// Says nothing about the peer: a peer reset is learned from
1381 /// [`peer_cancelled`](Self::peer_cancelled) or from the next read.
1382 pub fn is_cancelled(&self) -> bool {
1383 self.cancelled
1384 }
1385
1386 /// Cancel the request by resetting the stream, handing the peer `code`.
1387 ///
1388 /// Draft-17 removed UNSUBSCRIBE and FETCH_CANCEL and draft-22 has not
1389 /// brought them back: resetting the request stream is how a request is
1390 /// withdrawn. Both halves are shut — a QUIC bidirectional stream has two
1391 /// independent halves, so resetting only the send half would leave the
1392 /// peer free to keep writing a response nobody will read. The send half is
1393 /// reset with `code` and the receive half is stopped with the same value.
1394 ///
1395 /// [`REQUEST_CANCELLED`] is the ordinary choice. Draft-22 Section 12.5
1396 /// says an application SHOULD take the code from the Stream Reset Error
1397 /// Codes registry when resetting, or sending STOP_SENDING on, any stream —
1398 /// request streams included — so [`StreamResetErrorCode`] is where a value
1399 /// other than the default should come from. The parameter is a plain `u64`
1400 /// because the registry reserves greasing code points that have no variant;
1401 /// a caller with a named code has [`StreamResetErrorCode::as_u64`].
1402 ///
1403 /// **This is the stream and nothing else.** The endpoint's record of the
1404 /// request does not move, so a response already in flight is still accepted
1405 /// after this returns. [`Connection::cancel_request_stream`] does both and
1406 /// is what a caller holding a connection should reach for; this stays
1407 /// because [`Drop`] has no connection to reach.
1408 ///
1409 /// Idempotent, and it retires the [`Drop`] behaviour: a cancelled handle
1410 /// does nothing further when it goes out of scope. Errors from a stream
1411 /// that was already reset or stopped are swallowed for the same reason —
1412 /// the request is cancelled either way.
1413 ///
1414 /// # Errors
1415 ///
1416 /// [`ConnectionError::Transport`] carrying [`TransportError::Write`] if
1417 /// `code` is outside the QUIC varint range (`0..2^62`). Nothing is sent
1418 /// in that case, and the handle is *not* marked cancelled, so a caller
1419 /// can retry with a representable code.
1420 pub fn cancel(&mut self, code: u64) -> Result<(), ConnectionError> {
1421 if self.cancelled {
1422 return Ok(());
1423 }
1424 // Reject an unrepresentable code before either half is touched, so a
1425 // failed call leaves the stream exactly as it was.
1426 if code > MAX_QUIC_VARINT {
1427 return Err(ConnectionError::Transport(TransportError::Write(format!(
1428 "error code {code} exceeds the varint range"
1429 ))));
1430 }
1431 self.cancelled = true;
1432 // Already-finished or already-reset halves report StreamClosed; the
1433 // request ends up cancelled regardless, so neither is worth raising.
1434 let _ = self.send.reset(code);
1435 let _ = self.recv.stop(code);
1436 Ok(())
1437 }
1438
1439 /// Wait for the peer to cancel this request, consuming nothing.
1440 ///
1441 /// A caller applying backpressure is deliberately not calling
1442 /// [`Connection::recv_on_request_stream`], which is the only other place a
1443 /// peer reset surfaces — so without this the abandonment goes unobserved
1444 /// for as long as the backpressure lasts. This grants no flow-control
1445 /// credit and is cancel-safe.
1446 ///
1447 /// Returns `Ok(Some(code))` with the peer's application error code, or
1448 /// `Ok(None)` meaning **no reset is observable, now or ever — stop
1449 /// asking**. A caller that re-polls after `Ok(None)` spins.
1450 ///
1451 /// Like [`cancel`](Self::cancel), this records nothing at the endpoint.
1452 /// [`Connection::peer_cancelled_on_request_stream`] is the same wait with
1453 /// the record attached.
1454 ///
1455 /// On WebTransport this always answers `Ok(None)`: `wtransport` exposes no
1456 /// reset-only observable, so a WebTransport caller learns of a peer cancel
1457 /// on its next read and not before.
1458 pub async fn peer_cancelled(&mut self) -> Result<Option<u64>, ConnectionError> {
1459 self.recv.received_reset().await
1460 }
1461
1462 /// Finish the send half cleanly, leaving the receive half open.
1463 ///
1464 /// Draft-22 Section 6.4.2.2 settles what a FIN means, which earlier drafts
1465 /// left open: "A FIN only indicates that an endpoint will send no further
1466 /// messages in that direction; it is not a request cancellation." A
1467 /// requester may therefore FIN before its response arrives — "A requester,
1468 /// with the exception of the sender of PUBLISH, MAY FIN immediately after
1469 /// sending a message if it will not send a REQUEST_UPDATE" — and the
1470 /// receive half stays open to carry the response, which is why this touches
1471 /// only the send half.
1472 ///
1473 /// What the same section forbids is finishing early: "An endpoint MUST NOT
1474 /// send a FIN on a direction of a request stream until it has sent all
1475 /// required messages on that direction for its request type", and "An
1476 /// endpoint that receives a FIN before all required messages have arrived
1477 /// treats the request as failed." The section names the two messages that
1478 /// are always required — "an endpoint sending a response to a request MUST
1479 /// send the corresponding response message, and the publisher of an
1480 /// Established subscription MUST send PUBLISH_DONE" — and both are things
1481 /// this handle knows about itself, so both are checked here and **nothing
1482 /// is written** when either is outstanding.
1483 ///
1484 /// A responder that owes a response has not sent one:
1485 /// [`ConnectionError::FinBeforeResponse`]. A publisher that owes a
1486 /// PUBLISH_DONE, whether from a PUBLISH it sent or a peer's SUBSCRIBE it
1487 /// accepted, gets [`ConnectionError::FinBeforePublishDone`] — which is why
1488 /// [`Connection::publish_done`] and [`Connection::publish_done_on`] are the
1489 /// routes that end a publication, rather than a bare `finish`.
1490 ///
1491 /// What is not checked is everything the caller alone knows: a
1492 /// SUBSCRIBE_NAMESPACE responder deciding it has no more namespaces to
1493 /// announce, or a requester deciding it will send no REQUEST_UPDATE. The
1494 /// section leaves those to the endpoint, and so does this.
1495 ///
1496 /// Drafts 17 and 18 have no Section 6.4.2.2 and no guard: their `finish` is
1497 /// unconditional. A porter must not carry this one back to them.
1498 ///
1499 /// A finished handle, like a cancelled one, does nothing further on
1500 /// [`Drop`]. That matters here: the default drop resets both halves, which
1501 /// Section 6.4.2.2 contrasts with a FIN as the abrupt close, so a request
1502 /// that ended cleanly must come through this to avoid being reported as
1503 /// cancelled.
1504 pub async fn finish(&mut self) -> Result<(), ConnectionError> {
1505 if self.finished || self.cancelled {
1506 return Ok(());
1507 }
1508 if self.origin == RequestOrigin::Peer && !self.responded {
1509 return Err(ConnectionError::FinBeforeResponse(self.request_id.into_inner()));
1510 }
1511 if self.owes_publish_done {
1512 return Err(ConnectionError::FinBeforePublishDone(self.request_id.into_inner()));
1513 }
1514 self.finished = true;
1515 self.send.finish().await
1516 }
1517}
1518
1519impl Drop for RequestStream {
1520 /// Reset the request unless it was already cancelled or finished.
1521 ///
1522 /// See the type-level note: the default drop would FIN the send half,
1523 /// which claims a clean end for a request the caller walked away from —
1524 /// and on draft-22 a FIN is a stronger claim than on earlier drafts, since
1525 /// Section 6.4.2.2 has the receiver of one *treat the request as failed*
1526 /// only when messages are still owed and complete otherwise.
1527 ///
1528 /// The code says which walking away it was. A stream this endpoint opened
1529 /// is cancelled — [`REQUEST_CANCELLED`] — which is the requester act
1530 /// Section 6.4.2.3 describes. A stream the peer opened is reset with
1531 /// [`REQUEST_UNANSWERED`] whether or not a response was already written:
1532 /// before one, the request was never served; after one, the obligations
1533 /// that follow it are still outstanding.
1534 fn drop(&mut self) {
1535 if self.cancelled || self.finished {
1536 return;
1537 }
1538 let code = match self.origin {
1539 RequestOrigin::Local => REQUEST_CANCELLED,
1540 RequestOrigin::Peer => REQUEST_UNANSWERED,
1541 };
1542 let _ = self.send.reset(code);
1543 let _ = self.recv.stop(code);
1544 }
1545}
1546
1547/// Holds a peer-opened stream pair while its first message is being read, and
1548/// puts it back on the connection's queue if that read is abandoned.
1549///
1550/// [`Connection::accept_request_stream`] awaits a whole control message, and a
1551/// caller may drop that future — a `select!` against a shutdown signal is the
1552/// ordinary reason. Without this the stream, and every byte already read off
1553/// it into the reader's buffer, would go with the future: the peer would see a
1554/// request stream reset for no reason it could act on.
1555///
1556/// [`Drop`] is the only place this can run, because a cancelled future is
1557/// never polled again. Every path that finishes — success or error — takes the
1558/// pair out first, so a pair still present when this drops was cancelled.
1559struct PendingInbound<'a> {
1560 pair: Option<(FramedSendStream, FramedRecvStream)>,
1561 queue: &'a Mutex<VecDeque<(FramedSendStream, FramedRecvStream)>>,
1562}
1563
1564impl Drop for PendingInbound<'_> {
1565 fn drop(&mut self) {
1566 if let Some(pair) = self.pair.take() {
1567 // Front, not back: this stream arrived before anything still
1568 // queued behind it, and a partially read message must not be
1569 // handed out after a stream that arrived later.
1570 self.queue.lock().unwrap_or_else(|p| p.into_inner()).push_front(pair);
1571 }
1572 }
1573}
1574
1575/// The largest value a QUIC application error code can carry, `2^62 - 1`.
1576///
1577/// Checked by [`RequestStream::cancel`] before either half of the stream is
1578/// touched, so an unrepresentable code cannot half-cancel a request.
1579const MAX_QUIC_VARINT: u64 = (1u64 << 62) - 1;
1580
1581/// A live MoQT connection over QUIC or WebTransport, combining the endpoint
1582/// state machine with actual network I/O.
1583pub struct Connection {
1584 transport: Transport,
1585 endpoint: Endpoint,
1586 draft: DraftVersion,
1587 control_send: Option<FramedSendStream>,
1588 control_recv: Option<FramedRecvStream>,
1589 observer: Option<Box<dyn ConnectionObserver>>,
1590 /// Setup events buffered during `connect()` and replayed when an
1591 /// observer attaches via `set_observer` — without this, an observer
1592 /// attached after `connect` returns would never see the handshake.
1593 pending_events: Vec<ClientEvent>,
1594 /// The server's half of the setup handshake, kept whole.
1595 ///
1596 /// The endpoint acts on the parameters it recognises and retains none of
1597 /// them, and which parameters a server sends — in what order, with what
1598 /// values — is the sharpest thing a session says about the implementation
1599 /// behind it.
1600 server_setup: AnyControlMessage,
1601 /// The framed wire bytes of [`Self::server_setup`].
1602 server_setup_raw: Option<Vec<u8>>,
1603 /// Unidirectional streams accepted while `connect` was looking for the
1604 /// peer's control stream, in arrival order, and then any stream that is
1605 /// not a FETCH_HEADER one that a fetch or fill accept met.
1606 ///
1607 /// Data streams are allowed to arrive before the control streams on this
1608 /// draft, so the search cannot assume the first unidirectional stream is
1609 /// the control one — and dropping the ones that are not would silently
1610 /// lose objects the peer already sent.
1611 /// [`accept_subgroup_stream`](Connection::accept_subgroup_stream) empties
1612 /// this before it accepts anything new.
1613 ///
1614 /// Behind a mutex because that method takes `&self`. The lock is only
1615 /// ever held for a push or a pop, never across an await.
1616 deferred_uni: Mutex<VecDeque<FramedRecvStream>>,
1617 /// FETCH_HEADER streams, fetch and fill alike, accepted by a call that
1618 /// wanted another kind, in arrival order. The type varint is still on
1619 /// the front of each.
1620 /// [`accept_fetch_stream`](Connection::accept_fetch_stream) and
1621 /// [`accept_fill_stream`](Connection::accept_fill_stream) empty this
1622 /// before they accept anything new.
1623 deferred_fetch: Mutex<VecDeque<FramedRecvStream>>,
1624 /// Bidirectional streams the peer opened that
1625 /// [`accept_request_stream`](Connection::accept_request_stream) took off
1626 /// the transport but did not finish reading a first message from, because
1627 /// its future was dropped. In arrival order.
1628 ///
1629 /// Without this a caller could not put `accept_request_stream` in a
1630 /// `select!` at all: losing the race would lose a stream the peer had
1631 /// already opened and, with it, whatever of the request had arrived.
1632 /// [`accept_request_stream`](Connection::accept_request_stream) empties
1633 /// this before it accepts anything new.
1634 ///
1635 /// Behind a mutex for the same reason `deferred_uni` is: the lock is only
1636 /// ever held for a push or a pop, never across an await.
1637 pending_inbound: Mutex<VecDeque<(FramedSendStream, FramedRecvStream)>>,
1638}
1639
1640impl Connection {
1641 /// Connect to a MoQT server as a client.
1642 ///
1643 /// Establishes a QUIC or WebTransport connection (based on
1644 /// `config.transport`), brings up the control plane, performs the SETUP
1645 /// handshake, and returns a ready-to-use connection.
1646 ///
1647 /// # The control plane is a pair of unidirectional streams
1648 ///
1649 /// Draft-22 Section 6.3: "MOQT uses a pair of unidirectional streams for
1650 /// creating the session and exchanging control messages. Each peer opens
1651 /// one control stream beginning with a SETUP message." So each direction
1652 /// is a separate stream opened by the peer that writes on it. This opens
1653 /// one with `open_uni` and writes SETUP on it, then finds the peer's by
1654 /// accepting unidirectional streams until one leads with
1655 /// [`CONTROL_STREAM_TYPE`].
1656 ///
1657 /// Nothing is written ahead of the SETUP: 0x2F00 is both the SETUP
1658 /// message type and the unidirectional stream type for a control stream,
1659 /// so the message's own first field is the stream header. See
1660 /// [`CONTROL_STREAM_TYPE`].
1661 ///
1662 /// A bidirectional stream is *not* the control stream here — the same
1663 /// section makes it a request stream, one that begins with TRACK_STATUS,
1664 /// SUBSCRIBE, PUBLISH, FETCH, PUBLISH_NAMESPACE, SUBSCRIBE_NAMESPACE or
1665 /// SUBSCRIBE_TRACKS: "Bidirectional streams MUST NOT begin with any other
1666 /// message type unless negotiated. If they do, the peer MUST close the
1667 /// Session with a PROTOCOL_VIOLATION." A SETUP written on a bidirectional
1668 /// stream is exactly that case, so a peer that enforces the topology
1669 /// answers it by closing the session.
1670 ///
1671 /// # Unidirectional streams that arrive before the peer's control stream
1672 ///
1673 /// They are kept, not dropped. Section 6.3 expects them: "Unidirectional
1674 /// streams containing Objects or bidirectional stream(s) beginning with a
1675 /// request message could arrive prior to the control streams, in which
1676 /// case the data SHOULD be buffered until both control streams arrive and
1677 /// setup is complete." Each such stream is set aside and handed to
1678 /// [`accept_subgroup_stream`](Self::accept_subgroup_stream) in arrival
1679 /// order, ahead of any newly accepted stream. Only the leading type
1680 /// varint is read from them here; the rest stays on the transport, unread
1681 /// and still flow-controlled, so nothing is buffered in this process
1682 /// beyond those few bytes.
1683 ///
1684 /// One limit worth knowing: the search waits for each stream's type
1685 /// varint in turn, so a peer that opens a unidirectional stream and then
1686 /// writes nothing on it stalls the handshake behind that stream.
1687 pub async fn connect(addr: &str, config: ClientConfig) -> Result<Self, ConnectionError> {
1688 // PATH is for native QUIC only, and the transport is known here and
1689 // nowhere further in. Refusing before dialling means a session that
1690 // the server would close on sight is never opened.
1691 setup::validate_client_path_transport(
1692 &config.setup_parameters,
1693 matches!(config.transport, TransportType::WebTransport { .. }),
1694 )
1695 .map_err(EndpointError::from)?;
1696
1697 let transport = match &config.transport {
1698 TransportType::Quic => Self::connect_quic(addr, &config).await?,
1699 TransportType::WebTransport { url } => {
1700 let url = url.clone();
1701 Self::connect_webtransport(&url, &config).await?
1702 }
1703 };
1704
1705 Self::adopt(transport, config).await
1706 }
1707
1708 /// Run the MoQT setup handshake over a transport somebody else established.
1709 ///
1710 /// For choosing the draft from what the server selected: dial once through
1711 /// [`crate::transport::dial_quic`] offering every ALPN, then bring the
1712 /// connection to the module its answer names. [`Self::connect`] cannot do
1713 /// this — it derives its single ALPN from the draft it was given.
1714 ///
1715 /// `config.draft` must match this module. The transport is adopted as
1716 /// given; nothing here re-checks the ALPN it was negotiated with.
1717 pub async fn adopt(
1718 transport: Transport,
1719 config: ClientConfig,
1720 ) -> Result<Self, ConnectionError> {
1721 Self::adopt_with(transport, config, None).await
1722 }
1723
1724 /// [`Self::adopt`] with `observer` attached before the handshake.
1725 ///
1726 /// The SETUP this side sends is reported as it is written, and a SETUP from
1727 /// the peer that this side refuses as [`ClientEvent::ControlMessageRefused`].
1728 /// [`Self::set_observer`] after `adopt` sees the same handshake events, but
1729 /// only once the handshake has succeeded.
1730 pub async fn adopt_observed(
1731 transport: Transport,
1732 config: ClientConfig,
1733 observer: Box<dyn ConnectionObserver>,
1734 ) -> Result<Self, ConnectionError> {
1735 Self::adopt_with(transport, config, Some(observer)).await
1736 }
1737
1738 /// [`Self::adopt`], reporting to `observer` from the first byte written.
1739 pub(crate) async fn adopt_with(
1740 transport: Transport,
1741 config: ClientConfig,
1742 observer: Option<Box<dyn ConnectionObserver>>,
1743 ) -> Result<Self, ConnectionError> {
1744 let draft = config.draft;
1745 // PATH is for native QUIC only, and the transport is known here and
1746 // nowhere further in. Refusing before dialling means a session that
1747 // the server would close on sight is never opened.
1748 setup::validate_client_path_transport(
1749 &config.setup_parameters,
1750 matches!(config.transport, TransportType::WebTransport { .. }),
1751 )
1752 .map_err(EndpointError::from)?;
1753
1754 // Send half of the control plane: one unidirectional stream whose
1755 // first message is SETUP, which is also its stream header.
1756 let send = transport.open_uni().await?;
1757 let mut control_send = FramedSendStream::new(send, draft);
1758
1759 // Perform setup handshake (draft-22: no versions)
1760 let mut endpoint = Endpoint::new(Role::Client);
1761 endpoint.connect()?;
1762 let setup_msg = endpoint.send_setup(config.setup_parameters.clone())?;
1763 let any_setup = AnyControlMessage::Draft22(setup_msg);
1764 let raw_setup = control_send.write_control(&any_setup).await?;
1765 // Reported as written, so a peer that never answers still leaves it
1766 // observed.
1767 if let Some(obs) = &observer {
1768 obs.on_event_owned(ClientEvent::ControlMessage {
1769 direction: Direction::Send,
1770 message: any_setup.clone(),
1771 stream_id: None,
1772 raw: Some(raw_setup.clone()),
1773 });
1774 }
1775
1776 // Receive half: the peer's control stream is whichever unidirectional
1777 // stream leads with CONTROL_STREAM_TYPE.
1778 let mut deferred_uni: VecDeque<FramedRecvStream> = VecDeque::new();
1779 let mut deferred_fetch: VecDeque<FramedRecvStream> = VecDeque::new();
1780 let mut control_recv = loop {
1781 let recv = transport.accept_uni().await?;
1782 let mut framed = FramedRecvStream::new(recv, draft);
1783 match framed.peek_stream_type().await {
1784 Ok(CONTROL_STREAM_TYPE) => break framed,
1785 Ok(FETCH_STREAM_TYPE) => deferred_fetch.push_back(framed),
1786 // Every other type is a data stream — and so is a stream that
1787 // ended or failed before its type arrived, not because it is
1788 // one but because there is nothing left to decide with. The
1789 // data path sees the same end one read later and reports it
1790 // the way it reports every other. Treating it as the control
1791 // stream would hand the session's control plane to a stream
1792 // that carried nothing.
1793 _ => deferred_uni.push_back(framed),
1794 }
1795 };
1796
1797 let (server_setup, raw_server_setup) = match control_recv.read_control(true).await {
1798 Ok(read) => read,
1799 Err(e) => {
1800 if let Some(obs) = &observer {
1801 if let Some(event) = Self::refused_event(&e, None, control_recv.take_refused())
1802 {
1803 obs.on_event_owned(event);
1804 }
1805 }
1806 return Err(e);
1807 }
1808 };
1809 // Unified SETUP in draft-22: server responds with the same message type.
1810 match &server_setup {
1811 AnyControlMessage::Draft22(ControlMessage::Setup(ref s)) => {
1812 if let Err(e) = endpoint.receive_setup(s) {
1813 let err = ConnectionError::from(e);
1814 Self::refuse_setup(observer.as_deref(), &err, &server_setup, &raw_server_setup);
1815 return Err(err);
1816 }
1817 }
1818 _ => {
1819 return Err(ConnectionError::Endpoint(EndpointError::NotActive));
1820 }
1821 }
1822
1823 let mut pending_events = vec![
1824 ClientEvent::ControlMessage {
1825 direction: Direction::Send,
1826 message: any_setup,
1827 stream_id: None,
1828 raw: Some(raw_setup),
1829 },
1830 ClientEvent::ControlMessage {
1831 direction: Direction::Receive,
1832 message: server_setup.clone(),
1833 stream_id: None,
1834 raw: raw_server_setup.clone(),
1835 },
1836 ClientEvent::SetupComplete { negotiated_version: 0xff000000 + 22 },
1837 ];
1838
1839 if let Some(obs) = &observer {
1840 // The SETUP this side sent was reported as it was written.
1841 for event in pending_events.drain(..).skip(1) {
1842 obs.on_event_owned(event);
1843 }
1844 }
1845
1846 Ok(Self {
1847 transport,
1848 endpoint,
1849 draft,
1850 control_send: Some(control_send),
1851 control_recv: Some(control_recv),
1852 observer,
1853 pending_events,
1854 server_setup,
1855 server_setup_raw: raw_server_setup,
1856 deferred_uni: Mutex::new(deferred_uni),
1857 deferred_fetch: Mutex::new(deferred_fetch),
1858 pending_inbound: Mutex::new(VecDeque::new()),
1859 })
1860 }
1861
1862 /// Establish a raw QUIC connection.
1863 ///
1864 /// Offers this draft's ALPN alone; [`crate::transport::dial_quic`] holds the
1865 /// TLS and endpoint setup.
1866 async fn connect_quic(addr: &str, config: &ClientConfig) -> Result<Transport, ConnectionError> {
1867 let (transport, _negotiated) = crate::transport::dial_quic(
1868 addr,
1869 &crate::transport::QuicDialOptions {
1870 skip_cert_verification: config.skip_cert_verification,
1871 ca_certs: config.ca_certs.clone(),
1872 ..crate::transport::QuicDialOptions::new(config.alpn())
1873 },
1874 )
1875 .await?;
1876 Ok(transport)
1877 }
1878
1879 /// Establish a WebTransport connection.
1880 ///
1881 /// [`crate::transport::dial_webtransport`] holds the TLS and endpoint
1882 /// setup, exactly as `connect_quic` above defers its own. That is not
1883 /// only deduplication: both dials must trust the same roots. Settling trust
1884 /// at this call site instead — from `wtransport`'s own builder settings, or
1885 /// from a second config of this draft's own — puts the decision in two
1886 /// places, where it can stop matching what the QUIC dial trusts, so one
1887 /// relay would pass on one transport and fail on the other and a caller's
1888 /// private CA would reach only the dials whose call site installed it.
1889 /// Both ask the same function what to trust.
1890 #[cfg(feature = "webtransport")]
1891 async fn connect_webtransport(
1892 url: &str,
1893 config: &ClientConfig,
1894 ) -> Result<Transport, ConnectionError> {
1895 Ok(crate::transport::dial_webtransport(
1896 url,
1897 &crate::transport::QuicDialOptions {
1898 skip_cert_verification: config.skip_cert_verification,
1899 ca_certs: config.ca_certs.clone(),
1900 // The draft's own protocol identifier, which this draft
1901 // negotiates in `WT-Available-Protocols` rather than in
1902 // CLIENT_SETUP: "The client includes MOQT protocol identifiers
1903 // in the WT-Available-Protocols header". `config.alpn()` above
1904 // is `h3`, which is the HTTP/3 name and settles no version.
1905 wt_protocols: vec![config.draft.quic_alpn().to_vec()],
1906 ..crate::transport::QuicDialOptions::new(config.alpn())
1907 },
1908 )
1909 .await?)
1910 }
1911
1912 /// Stub for when the webtransport feature is not enabled.
1913 #[cfg(not(feature = "webtransport"))]
1914 async fn connect_webtransport(
1915 _url: &str,
1916 _config: &ClientConfig,
1917 ) -> Result<Transport, ConnectionError> {
1918 Err(ConnectionError::Transport(TransportError::Connect(
1919 "webtransport feature not enabled".into(),
1920 )))
1921 }
1922
1923 // -- Observer ---------------------------------------------------
1924
1925 /// Attach an observer. Buffered handshake events from `connect()` are
1926 /// flushed in arrival order before this returns.
1927 pub fn set_observer(&mut self, observer: Box<dyn ConnectionObserver>) {
1928 self.observer = Some(observer);
1929 for event in self.pending_events.drain(..) {
1930 if let Some(ref obs) = self.observer {
1931 obs.on_event_owned(event);
1932 }
1933 }
1934 }
1935
1936 /// Remove the observer.
1937 pub fn clear_observer(&mut self) {
1938 self.observer = None;
1939 }
1940
1941 /// How the QUIC connection was closed, once it has been. See
1942 /// [`TransportClose`](crate::transport::TransportClose).
1943 pub fn transport_close(&self) -> Option<crate::transport::TransportClose> {
1944 self.transport.transport_close()
1945 }
1946
1947 /// Emit an event to the observer, if one is attached.
1948 fn emit(&self, event: ClientEvent) {
1949 if let Some(ref obs) = self.observer {
1950 obs.on_event_owned(event);
1951 }
1952 }
1953
1954 /// Report a received frame this endpoint refused, when an observer is
1955 /// attached and the refusal is the peer's: see [`Self::refused_event`].
1956 fn emit_refused(&self, err: &ConnectionError, stream_id: Option<u64>, raw: Option<Vec<u8>>) {
1957 if self.observer.is_some() {
1958 if let Some(event) = Self::refused_event(err, stream_id, raw) {
1959 self.emit(event);
1960 }
1961 }
1962 }
1963
1964 /// The [`ClientEvent::ControlMessageRefused`] for `raw`, when `err` refuses
1965 /// what the peer sent: the decoder refused it, or it broke a rule
1966 /// [`EndpointError::fault`] or [`Self::draft_specific_cause`] lays on the
1967 /// peer.
1968 fn refused_event(
1969 err: &ConnectionError,
1970 stream_id: Option<u64>,
1971 raw: Option<Vec<u8>>,
1972 ) -> Option<ClientEvent> {
1973 use crate::above_codec_rules::{DraftSpecificCause, EndpointFault};
1974 let peers = match err {
1975 ConnectionError::Codec(_) | ConnectionError::VarInt(_) => true,
1976 ConnectionError::Endpoint(e) => matches!(e.fault(), EndpointFault::Peer(_)),
1977 other => matches!(
1978 Self::draft_specific_cause(other),
1979 Some(DraftSpecificCause::PeerViolation { .. } | DraftSpecificCause::Codec { .. })
1980 ),
1981 };
1982 let raw = raw.filter(|_| peers)?;
1983 Some(ClientEvent::ControlMessageRefused { stream_id, raw })
1984 }
1985
1986 /// Report a peer's SETUP the handshake refused to an observer attached
1987 /// before it: the message as received, then the refusal.
1988 fn refuse_setup(
1989 observer: Option<&dyn ConnectionObserver>,
1990 err: &ConnectionError,
1991 setup: &AnyControlMessage,
1992 raw: &Option<Vec<u8>>,
1993 ) {
1994 let Some(obs) = observer else { return };
1995 obs.on_event_owned(ClientEvent::ControlMessage {
1996 direction: Direction::Receive,
1997 message: setup.clone(),
1998 stream_id: None,
1999 raw: raw.clone(),
2000 });
2001 if let Some(event) = Self::refused_event(err, None, raw.clone()) {
2002 obs.on_event_owned(event);
2003 }
2004 }
2005
2006 // -- Control message I/O ----------------------------------------
2007
2008 /// Send a control message on the control stream.
2009 ///
2010 /// Wraps the draft-22 message in `AnyControlMessage::Draft22` for framing.
2011 /// Of the messages draft-22 Table 5 does not place on a request stream,
2012 /// exactly two reach the wire: SETUP, written by
2013 /// [`connect`](Self::connect) as the control stream's own type varint, and
2014 /// GOAWAY, which is the one message the table gives the Stream value
2015 /// "Control, Request" and which belongs here when it drains the session.
2016 ///
2017 /// # Four messages that this refuses
2018 ///
2019 /// Table 5 gives NAMESPACE (0x8), NAMESPACE_DONE (0xE), PUBLISH_SKIPPED
2020 /// (0xF) and REQUEST_UPDATE (0x2) the Stream value **Request**, not
2021 /// Control. REQUEST_UPDATE is sent "on the same bidi stream as the request"
2022 /// it modifies (Section 9.5); the other three report on the namespace or
2023 /// the publication of the request stream they arrive on. A conforming peer
2024 /// answers any of the four on the control stream by closing the session,
2025 /// and so does this client's own [`Endpoint::receive_message`] — writing
2026 /// one here produces a frame this implementation would itself refuse.
2027 ///
2028 /// All four have somewhere better to go, and none of them should come
2029 /// through here. REQUEST_UPDATE goes on the stream its request opened, with
2030 /// [`send_on_request_stream`](Self::send_on_request_stream). NAMESPACE and
2031 /// NAMESPACE_DONE go on a peer's SUBSCRIBE_NAMESPACE stream, with
2032 /// [`namespace_on`](Self::namespace_on) and
2033 /// [`namespace_done_on`](Self::namespace_done_on); PUBLISH_SKIPPED goes on
2034 /// a peer's SUBSCRIBE_TRACKS stream, with
2035 /// [`publish_skipped_on`](Self::publish_skipped_on). This method refuses
2036 /// all four with [`ConnectionError::RequestStreamMessageOnControlStream`]
2037 /// and writes nothing.
2038 ///
2039 /// [`Endpoint::receive_message`]: crate::draft22::endpoint::Endpoint::receive_message
2040 ///
2041 /// GOAWAY is correct here and is not confined here. Draft-18 gave it an
2042 /// optional Request ID present only on the control stream, and draft-20
2043 /// removed the field, so its control-stream and request-stream forms are
2044 /// now one wire form; [`send_on_request_stream`](Self::send_on_request_stream)
2045 /// will put it on an open request stream.
2046 ///
2047 /// # Requests are refused here
2048 ///
2049 /// Draft-22 Section 6.3 keeps requests off the control plane: "In addition
2050 /// to the control streams, this specification uses bidirectional streams
2051 /// to carry requests. A request stream begins with one of these seven
2052 /// message types: TRACK_STATUS, SUBSCRIBE, PUBLISH, FETCH,
2053 /// PUBLISH_NAMESPACE, SUBSCRIBE_NAMESPACE, and SUBSCRIBE_TRACKS." The
2054 /// response comes back on that same bidirectional stream, and resetting it
2055 /// cancels the request.
2056 ///
2057 /// Handing one of those seven to this method returns
2058 /// [`ConnectionError::RequestOnControlStream`] and writes **nothing** —
2059 /// an enforcing peer sees no bytes at all, not a misplaced request. Use
2060 /// the typed helpers, which open a bidirectional stream each:
2061 /// [`subscribe`](Self::subscribe), [`fetch`](Self::fetch),
2062 /// [`publish`](Self::publish), [`track_status`](Self::track_status),
2063 /// [`publish_namespace`](Self::publish_namespace),
2064 /// [`subscribe_namespace`](Self::subscribe_namespace) and
2065 /// [`subscribe_tracks`](Self::subscribe_tracks).
2066 ///
2067 /// Response types are still permitted here, and need not be. A
2068 /// response written here will be refused by a conforming peer, whose
2069 /// endpoint answers a response on the control stream with an error; the
2070 /// route that is correct is
2071 /// [`accept_request_stream`](Self::accept_request_stream) and the
2072 /// `respond_*` helpers, which write on the stream the request arrived on
2073 /// and take the Request ID off the handle rather than from the caller.
2074 /// [`publish_done`](Self::publish_done) and
2075 /// [`publish_done_on`](Self::publish_done_on) do not come through here
2076 /// either: each takes the request stream its publication travels on.
2077 pub async fn send_control(&mut self, msg: &ControlMessage) -> Result<(), ConnectionError> {
2078 let ty = msg.message_type();
2079 if starts_a_request_stream(ty) {
2080 return Err(ConnectionError::RequestOnControlStream(ty));
2081 }
2082 // What this endpoint refuses to receive on the control stream it must
2083 // not write there either, or the client emits frames its own peer half
2084 // would close the session over.
2085 if belongs_on_a_request_stream(ty) {
2086 return Err(ConnectionError::RequestStreamMessageOnControlStream(ty));
2087 }
2088 let any = AnyControlMessage::Draft22(msg.clone());
2089 let send = self.control_send.as_mut().ok_or(ConnectionError::NoControlStream)?;
2090 let raw = send.write_control(&any).await?;
2091 self.emit(ClientEvent::ControlMessage {
2092 direction: Direction::Send,
2093 message: any,
2094 stream_id: None,
2095 raw: Some(raw),
2096 });
2097 Ok(())
2098 }
2099
2100 /// Read the next control message from the control stream.
2101 ///
2102 /// Returns the `AnyControlMessage` and also extracts the draft-22
2103 /// `ControlMessage` for internal endpoint dispatch.
2104 pub async fn recv_control(&mut self) -> Result<ControlMessage, ConnectionError> {
2105 self.recv_control_raw().await.map(|(msg, _)| msg)
2106 }
2107
2108 /// [`Self::recv_control`], keeping the frame's wire bytes when an observer
2109 /// is attached.
2110 async fn recv_control_raw(
2111 &mut self,
2112 ) -> Result<(ControlMessage, Option<Vec<u8>>), ConnectionError> {
2113 let recv = self.control_recv.as_mut().ok_or(ConnectionError::NoControlStream)?;
2114 let capture_raw = self.observer.is_some();
2115 let read = recv.read_control(capture_raw).await;
2116 let (any, raw) = match read {
2117 Ok(v) => v,
2118 Err(e) => {
2119 let raw = recv.take_refused();
2120 let err = self.close_for_codec(e);
2121 self.emit_refused(&err, None, raw);
2122 return Err(err);
2123 }
2124 };
2125 if capture_raw {
2126 self.emit(ClientEvent::ControlMessage {
2127 direction: Direction::Receive,
2128 message: any.clone(),
2129 stream_id: None,
2130 raw: raw.clone(),
2131 });
2132 }
2133 // Unwrap to draft-22 for the endpoint
2134 match any {
2135 AnyControlMessage::Draft22(msg) => Ok((msg, raw)),
2136 // `AnyControlMessage` carries one variant per enabled draft feature. With draft 22 the
2137 // only one enabled the arm above is exhaustive and this rejection arm unreachable.
2138 // Compiled in every configuration with the lint allowed, rather than gated on a `cfg`
2139 // naming the other drafts: such a list has to be edited in every draft module
2140 // whenever a draft is added, and a copy that omits one leaves this match
2141 // non-exhaustive.
2142 #[allow(unreachable_patterns)]
2143 _ => Err(ConnectionError::ControlMessageNarrowing),
2144 }
2145 }
2146
2147 /// Read and dispatch the next incoming control message through the
2148 /// endpoint state machine. Returns the decoded message for inspection.
2149 ///
2150 /// Responses never arrive here. Draft-22 responses carry no request id
2151 /// and belong on the request stream that asked for them, so the endpoint
2152 /// refuses a response that turns up on the control stream. Read them with
2153 /// [`recv_on_request_stream`](Self::recv_on_request_stream).
2154 ///
2155 /// A violation the draft answers with a session close is closed on the
2156 /// wire here, before the error is returned: the QUIC connection is closed
2157 /// with the code [`EndpointError::session_error_code`] names, so the peer
2158 /// that broke the rule learns of it rather than only the local endpoint.
2159 pub async fn recv_and_dispatch(&mut self) -> Result<ControlMessage, ConnectionError> {
2160 let (msg, raw) = self.recv_control_raw().await?;
2161 if let Err(e) = self.endpoint.receive_message(msg.clone()) {
2162 let err = self.close_if_session_fatal(e);
2163 self.emit_refused(&err, None, raw);
2164 return Err(err);
2165 }
2166
2167 // Emit draining event if this was a GoAway
2168 if let ControlMessage::GoAway(ref ga) = msg {
2169 self.emit(ClientEvent::Draining { new_session_uri: ga.new_session_uri.clone() });
2170 }
2171
2172 Ok(msg)
2173 }
2174
2175 // -- Request streams --------------------------------------------
2176
2177 /// Open the bidirectional stream a request will be carried on.
2178 ///
2179 /// Opened *before* the endpoint allocates a request id, so a transport
2180 /// that refuses a new stream — the peer's `initial_max_streams_bidi` is
2181 /// exhausted, the connection is gone — costs nothing. The endpoint has no
2182 /// way to abandon a request it has already allocated, so every failure
2183 /// that can be moved ahead of the allocation is.
2184 ///
2185 /// Nothing is written here. A request stream carries no stream-type
2186 /// header: its first field is the leading message's own type field, which
2187 /// is what [`begin_request`](Self::begin_request) writes.
2188 async fn open_request_bi(
2189 &self,
2190 ) -> Result<(FramedSendStream, FramedRecvStream), ConnectionError> {
2191 let (send, recv) = self.transport.open_bi().await?;
2192 Ok((FramedSendStream::new(send, self.draft), FramedRecvStream::new(recv, self.draft)))
2193 }
2194
2195 /// Reset a request stream that was opened but whose request could not be
2196 /// built, and pass the endpoint's error through.
2197 ///
2198 /// Without this, an endpoint refusal — the session is draining, the
2199 /// request-id range is exhausted — would leave a bidirectional stream
2200 /// open that never carries a first message, and dropping it would FIN it,
2201 /// telling the peer an empty stream ended cleanly.
2202 fn or_abandon<T>(
2203 halves: &mut (FramedSendStream, FramedRecvStream),
2204 built: Result<T, EndpointError>,
2205 ) -> Result<T, ConnectionError> {
2206 match built {
2207 Ok(value) => Ok(value),
2208 Err(e) => {
2209 let _ = halves.0.reset(REQUEST_CANCELLED);
2210 let _ = halves.1.stop(REQUEST_CANCELLED);
2211 Err(ConnectionError::Endpoint(e))
2212 }
2213 }
2214 }
2215
2216 /// Write `msg` as the first message on an opened bidirectional stream and
2217 /// hand back the [`RequestStream`] that owns both halves.
2218 ///
2219 /// This is the one place a request reaches the wire. Every request helper
2220 /// funnels through it, so the ordering — open, allocate, write, emit — is
2221 /// stated once.
2222 ///
2223 /// A failed write resets both halves rather than leaving a half-written
2224 /// request stream behind. What it cannot undo is the endpoint's
2225 /// allocation: the request id and its state machine already exist, and
2226 /// there is no way to retract them, so a write that fails here leaves one
2227 /// pending request the endpoint will never see answered.
2228 async fn begin_request(
2229 &mut self,
2230 halves: (FramedSendStream, FramedRecvStream),
2231 kind: RequestKind,
2232 request_id: VarInt,
2233 msg: &ControlMessage,
2234 ) -> Result<RequestStream, ConnectionError> {
2235 debug_assert_eq!(
2236 msg.message_type(),
2237 kind.message_type(),
2238 "a request stream's first message must be the one its kind names"
2239 );
2240 let (mut send, mut recv) = halves;
2241 let stream_id = send.stream_id();
2242 self.emit(ClientEvent::StreamOpened {
2243 direction: Direction::Send,
2244 stream_kind: StreamKind::Request,
2245 stream_id,
2246 });
2247 let any = AnyControlMessage::Draft22(msg.clone());
2248 let raw = match send.write_control(&any).await {
2249 Ok(raw) => raw,
2250 Err(e) => {
2251 let _ = send.reset(REQUEST_CANCELLED);
2252 let _ = recv.stop(REQUEST_CANCELLED);
2253 return Err(e);
2254 }
2255 };
2256 self.emit(ClientEvent::ControlMessage {
2257 direction: Direction::Send,
2258 message: any,
2259 stream_id: Some(stream_id),
2260 raw: Some(raw),
2261 });
2262 Ok(RequestStream {
2263 send,
2264 recv,
2265 request_id,
2266 kind,
2267 draft: self.draft,
2268 stream_id,
2269 cancelled: false,
2270 finished: false,
2271 origin: RequestOrigin::Local,
2272 responded: false,
2273 fetch_data: None,
2274 // The sender of a PUBLISH is the one requester draft-22 Section
2275 // 6.4.2.2 excludes from "MAY FIN immediately after sending a
2276 // message": it is the publisher of the subscription the PUBLISH
2277 // establishes, so it owes a PUBLISH_DONE from the moment the
2278 // request goes out.
2279 owes_publish_done: matches!(kind, RequestKind::Publish),
2280 })
2281 }
2282
2283 /// Read the next message off a request stream and dispatch it through the
2284 /// endpoint with that stream's own request id.
2285 ///
2286 /// On draft-22 a response carries no request id; the stream is the
2287 /// correlation, so the id comes from the handle and not from the wire.
2288 ///
2289 /// This blocks until a whole message has arrived. Backpressure is per
2290 /// request: a stream nobody reads stays unread, and the peer stays flow
2291 /// controlled on it alone. A peer that reset the stream surfaces as
2292 /// [`ConnectionError::Transport`] carrying
2293 /// [`TransportError::StreamReset`] with the peer's code; a caller that is
2294 /// deliberately not reading should watch
2295 /// [`RequestStream::peer_cancelled`] instead.
2296 ///
2297 /// # Errors
2298 ///
2299 /// [`ConnectionError::Endpoint`] if the message is not one of this
2300 /// draft's response types, or if it does not fit the request's state.
2301 /// The message has already been emitted to the observer by then — what
2302 /// arrived is reported whether or not the endpoint accepts it.
2303 ///
2304 /// [`ConnectionError::Codec`] if the decoder refused the frame. The session is
2305 /// closed with the code [`Self::codec_session_error_code`] names, where it
2306 /// names one, as on the control stream.
2307 pub async fn recv_on_request_stream(
2308 &mut self,
2309 stream: &mut RequestStream,
2310 ) -> Result<ControlMessage, ConnectionError> {
2311 let capture_raw = self.observer.is_some();
2312 let (any, raw) = match stream.recv.read_control(capture_raw).await {
2313 Ok(read) => read,
2314 Err(e) => {
2315 // A peer that reset this stream cancelled the request on it,
2316 // and this is where a caller reading normally learns of it. The
2317 // record is made and its verdict dropped: the read's own error
2318 // is what the caller has to act on, and returning a state error
2319 // in its place would hide a reset behind it.
2320 if matches!(e, ConnectionError::Transport(TransportError::StreamReset(_))) {
2321 let _ = self.endpoint.cancel_request(stream.request_id);
2322 }
2323 let raw = stream.recv.take_refused();
2324 let err = self.close_for_codec(e);
2325 self.emit_refused(&err, Some(stream.stream_id()), raw);
2326 return Err(err);
2327 }
2328 };
2329 if capture_raw {
2330 self.emit(ClientEvent::ControlMessage {
2331 direction: Direction::Receive,
2332 message: any.clone(),
2333 stream_id: Some(stream.stream_id()),
2334 raw: raw.clone(),
2335 });
2336 }
2337 let msg = match any {
2338 AnyControlMessage::Draft22(msg) => Ok::<_, ConnectionError>(msg),
2339 // `AnyControlMessage` carries one variant per enabled draft feature. With draft 22 the
2340 // only one enabled the arm above is exhaustive and this rejection arm unreachable.
2341 // Compiled in every configuration with the lint allowed, rather than gated on a `cfg`
2342 // naming the other drafts: such a list has to be edited in every draft module
2343 // whenever a draft is added, and a copy that omits one leaves this match
2344 // non-exhaustive.
2345 #[allow(unreachable_patterns)]
2346 _ => Err(ConnectionError::ControlMessageNarrowing),
2347 }?;
2348 // Which dispatcher this belongs to is decided by who opened the
2349 // stream, not by the message. On a stream this endpoint opened the
2350 // next message is the answer to our request; on one the peer opened it
2351 // cannot be, because we are the one who owes an answer. Feeding a
2352 // peer's REQUEST_UPDATE to the response dispatcher would look up a
2353 // request we never made.
2354 let dispatched = match stream.origin {
2355 RequestOrigin::Local => {
2356 self.endpoint.receive_response_on_stream(stream.request_id, msg.clone())
2357 }
2358 RequestOrigin::Peer => {
2359 self.endpoint.receive_on_peer_request_stream(stream.request_id, msg.clone())
2360 }
2361 };
2362 if let Err(e) = dispatched {
2363 let err = self.close_if_session_fatal(e);
2364 self.emit_refused(&err, Some(stream.stream_id()), raw);
2365 return Err(err);
2366 }
2367 // Emitted after the dispatch rather than before it, so an observer sees
2368 // only a notify the endpoint accepted: one from the subscriber, or for
2369 // a request that is not a subscription, ends the session instead
2370 // (Section 9.10) and reporting it as a state change would be a lie.
2371 // The generic `ControlMessage` event above carries it either way.
2372 if let ControlMessage::PublishStateNotify(ref notify) = msg {
2373 self.emit(ClientEvent::PublishStateNotify {
2374 request_id: stream.request_id.into_inner(),
2375 stream_id: stream.stream_id(),
2376 parameters: notify.parameters.clone(),
2377 });
2378 }
2379 // A rejected request establishes nothing, so whatever the request type
2380 // would have owed on this direction is no longer owed. Without this a
2381 // PUBLISH the peer refused could never be finished cleanly — the
2382 // publisher's PUBLISH_DONE obligation would outlive the subscription
2383 // that was never created, and the only way out would be a reset.
2384 if matches!(msg, ControlMessage::RequestError(_)) {
2385 stream.owes_publish_done = false;
2386 }
2387 Ok(msg)
2388 }
2389
2390 /// Write a follow-up message on an already-open request stream.
2391 ///
2392 /// The request itself was written when the stream was opened; this is for
2393 /// what comes after it on the same stream, PUBLISH_DONE among them — see
2394 /// [`publish_done`](Self::publish_done), which uses this.
2395 ///
2396 /// It does not refuse any message type. Which messages may follow a
2397 /// request on its own stream is not something this implementation can
2398 /// settle, so the choice is left to the caller rather than guessed at.
2399 pub async fn send_on_request_stream(
2400 &mut self,
2401 stream: &mut RequestStream,
2402 msg: &ControlMessage,
2403 ) -> Result<(), ConnectionError> {
2404 let any = AnyControlMessage::Draft22(msg.clone());
2405 let raw = stream.send.write_control(&any).await?;
2406 self.emit(ClientEvent::ControlMessage {
2407 direction: Direction::Send,
2408 message: any,
2409 stream_id: Some(stream.stream_id()),
2410 raw: Some(raw),
2411 });
2412 Ok(())
2413 }
2414
2415 /// Cancel a request: record it at the endpoint, then terminate its stream.
2416 /// Section 6.4.2.3 puts the cancel at the stream — "Implementations cancel a
2417 /// request by abruptly terminating any directions of the stream that are
2418 /// still open" — while the request's own state lives in the endpoint, so
2419 /// the two have to move together. This is the only place that moves both.
2420 ///
2421 /// The endpoint goes first and the stream is terminated only if it agrees,
2422 /// which is the order every request path here uses: a caller acts on a
2423 /// stream after the endpoint has accepted the step, never before. A refused
2424 /// cancel therefore leaves the stream exactly as it was, and
2425 /// [`RequestStream::cancel`] is still there for a caller that wants the
2426 /// stream reset regardless.
2427 ///
2428 /// Idempotent from both ends: a request that has already ended accepts the
2429 /// cancel and stays where it is, and a handle that has already been
2430 /// cancelled resets nothing a second time.
2431 ///
2432 /// # Errors
2433 ///
2434 /// [`ConnectionError::Endpoint`] if no request carries this stream's id or
2435 /// the request has not been written, and [`ConnectionError::Transport`] if
2436 /// `code` is outside the QUIC varint range — see
2437 /// [`RequestStream::cancel`], which is what sends it.
2438 pub fn cancel_request_stream(
2439 &mut self,
2440 stream: &mut RequestStream,
2441 code: u64,
2442 ) -> Result<(), ConnectionError> {
2443 let recorded = self.endpoint.cancel_request(stream.request_id);
2444 recorded.map_err(|e| self.close_if_session_fatal(e))?;
2445 stream.cancel(code)
2446 }
2447
2448 /// Wait for the peer to cancel this request, and record it if it does.
2449 ///
2450 /// [`RequestStream::peer_cancelled`] with the endpoint's record attached. A
2451 /// caller applying backpressure is deliberately not calling
2452 /// [`recv_on_request_stream`](Self::recv_on_request_stream), which is the
2453 /// other place a peer reset surfaces, so without this the request would end
2454 /// on the wire and stay open in the endpoint's record for as long as the
2455 /// backpressure lasts.
2456 ///
2457 /// Returns what the handle's own method returns; see it for the `Ok(None)`
2458 /// case and for what WebTransport can and cannot observe. Cancel-safe, and
2459 /// it grants no flow-control credit.
2460 pub async fn peer_cancelled_on_request_stream(
2461 &mut self,
2462 stream: &mut RequestStream,
2463 ) -> Result<Option<u64>, ConnectionError> {
2464 let code = stream.peer_cancelled().await?;
2465 if code.is_some() {
2466 // Discarded for the reason the read path discards it: the peer has
2467 // ended the request whatever the record said, and a state error
2468 // here would replace the answer the caller asked for.
2469 let _ = self.endpoint.cancel_request(stream.request_id);
2470 }
2471 Ok(code)
2472 }
2473
2474 // -- Accepting the peer's request streams -----------------------
2475
2476 /// Accept the next bidirectional stream the peer opened, read the request
2477 /// it begins with, and hand back that request and a handle to answer it
2478 /// on.
2479 ///
2480 /// This is the mirror of the request helpers. Where
2481 /// [`subscribe`](Self::subscribe) and its siblings open a stream and write
2482 /// a request, this takes one the peer opened and reads one. Draft-22
2483 /// Section 6.3 puts requests in both directions on bidirectional streams,
2484 /// so a client that only ever calls the helpers can never be published to
2485 /// or subscribed from.
2486 ///
2487 /// The returned [`RequestStream`] carries [`RequestOrigin::Peer`]. Answer
2488 /// it with [`respond_subscribe_ok`](Self::respond_subscribe_ok),
2489 /// [`respond_fetch_ok`](Self::respond_fetch_ok),
2490 /// [`respond_ok`](Self::respond_ok) or
2491 /// [`respond_error`](Self::respond_error), and **hold it for as long as
2492 /// the request lasts** — a subscription's PUBLISH_DONE is written on it,
2493 /// and dropping it resets the stream.
2494 ///
2495 /// # Two refusals, two codes
2496 ///
2497 /// Draft-22 Section 6.3, on a stream that begins with the wrong type:
2498 /// "Bidirectional streams MUST NOT begin with any other message type
2499 /// unless negotiated. If they do, the peer MUST close the Session with a
2500 /// PROTOCOL_VIOLATION." Section 6.4.2.1, on the Request ID: "If an endpoint
2501 /// receives a Request ID where the least significant bit is incorrect for
2502 /// the sender, or a duplicate Request ID, it MUST close the session with
2503 /// INVALID_REQUEST_ID." Both are closes of the session on the wire, with
2504 /// different codes, and both happen before this returns — the error handed
2505 /// back reports a session that is already gone, not one the caller must
2506 /// remember to close.
2507 ///
2508 /// # Cancelling this future loses nothing
2509 ///
2510 /// A stream taken off the transport but not yet read is put back on an
2511 /// internal queue, and the next call takes it before accepting anything
2512 /// new — including whatever bytes of the request had already arrived,
2513 /// which live in the stream's own reader. So this is safe to `select!`
2514 /// against a shutdown signal or a timer. See
2515 /// [`pending_inbound_count`](Self::pending_inbound_count).
2516 ///
2517 /// What it is **not** safe to do is run concurrently with another method
2518 /// on the same connection: this takes `&mut self` because registering the
2519 /// peer's request moves endpoint state, and no signature avoids that while
2520 /// the connection owns the endpoint. A caller blocked in
2521 /// [`recv_on_request_stream`](Self::recv_on_request_stream) waiting for
2522 /// its own response is not accepting, and the peer's request streams queue
2523 /// up in the transport behind it. One loop that never blocks indefinitely
2524 /// on a single read is the shape this supports.
2525 ///
2526 /// # Ordering
2527 ///
2528 /// The endpoint is told about the request last, after every step that can
2529 /// fail or be cancelled, and building the handle afterwards cannot fail.
2530 /// This is the inverse of the outbound path's reasoning — it opens the
2531 /// stream before allocating a Request ID for the same reason — and rests
2532 /// on the same fact: the endpoint has no way to abandon a request it has
2533 /// already registered. Registering earlier would let a cancelled accept
2534 /// leave a state machine keyed to a stream nobody holds, and the peer's
2535 /// next use of that Request ID would then be reported as a duplicate — a
2536 /// session close, over an id the peer used exactly once.
2537 ///
2538 /// # Errors
2539 ///
2540 /// - [`ConnectionError::NonRequestOnRequestStream`] — the session has been
2541 /// closed with PROTOCOL_VIOLATION and the stream reset.
2542 /// - [`ConnectionError::Endpoint`] carrying `RequestId` or
2543 /// `DuplicateRequestId` — the session has been closed with
2544 /// INVALID_REQUEST_ID and the stream reset.
2545 /// - [`ConnectionError::Endpoint`] carrying `NotActive` or `Draining` —
2546 /// the stream is reset, the session is left alone.
2547 /// - [`ConnectionError::Transport`] — the stream is reset, the session is
2548 /// left alone.
2549 /// - [`ConnectionError::Codec`] — the stream is reset, and the session is
2550 /// closed with the code [`Self::codec_session_error_code`] names, where it
2551 /// names one. Section 9: "Every message on a control or request stream is
2552 /// formatted as follows", so the control message rules hold here too.
2553 pub async fn accept_request_stream(
2554 &mut self,
2555 ) -> Result<(ControlMessage, RequestStream), ConnectionError> {
2556 let pair = match self.take_pending_inbound() {
2557 Some(pair) => pair,
2558 None => {
2559 let (send, recv) = self.transport.accept_bi().await?;
2560 (FramedSendStream::new(send, self.draft), FramedRecvStream::new(recv, self.draft))
2561 }
2562 };
2563 let capture_raw = self.observer.is_some();
2564
2565 let (any, raw, mut send, mut recv) = {
2566 let mut pending = PendingInbound { pair: Some(pair), queue: &self.pending_inbound };
2567 let read = {
2568 let (_, recv) = pending.pair.as_mut().expect("set on construction");
2569 recv.read_control(capture_raw).await
2570 };
2571 // Taken out before anything can return, so the guard's Drop puts
2572 // the pair back for exactly one reason: this future was cancelled.
2573 let (mut send, mut recv) = pending.pair.take().expect("set on construction");
2574 match read {
2575 Ok((any, raw)) => (any, raw, send, recv),
2576 Err(e) => {
2577 // A stream whose first message could not be read is not
2578 // worth queueing: the next accept would fail on it the
2579 // same way. Reset rather than FIN — nothing was served.
2580 let _ = send.reset(REQUEST_UNANSWERED);
2581 let _ = recv.stop(REQUEST_UNANSWERED);
2582 let raw = recv.take_refused();
2583 let err = self.close_for_codec(e);
2584 self.emit_refused(&err, Some(send.stream_id()), raw);
2585 return Err(err);
2586 }
2587 }
2588 };
2589
2590 // Reported once the request has actually arrived rather than when the
2591 // stream came off the transport, so a cancelled accept that is retried
2592 // does not report the same stream twice.
2593 let stream_id = send.stream_id();
2594 self.emit(ClientEvent::StreamOpened {
2595 direction: Direction::Receive,
2596 stream_kind: StreamKind::Request,
2597 stream_id,
2598 });
2599 if capture_raw {
2600 self.emit(ClientEvent::ControlMessage {
2601 direction: Direction::Receive,
2602 message: any.clone(),
2603 stream_id: Some(stream_id),
2604 raw: raw.clone(),
2605 });
2606 }
2607
2608 let msg = match any {
2609 AnyControlMessage::Draft22(msg) => msg,
2610 // `AnyControlMessage` carries one variant per enabled draft feature. With draft 22 the
2611 // only one enabled the arm above is exhaustive and this rejection arm unreachable.
2612 // Compiled in every configuration with the lint allowed, rather than gated on a `cfg`
2613 // naming the other drafts: such a list has to be edited in every draft module
2614 // whenever a draft is added, and a copy that omits one leaves this match
2615 // non-exhaustive.
2616 #[allow(unreachable_patterns)]
2617 _ => {
2618 let _ = send.reset(REQUEST_UNANSWERED);
2619 let _ = recv.stop(REQUEST_UNANSWERED);
2620 return Err(ConnectionError::ControlMessageNarrowing);
2621 }
2622 };
2623
2624 let ty = msg.message_type();
2625 let Some(kind) = RequestKind::from_message_type(ty) else {
2626 let err = self.endpoint.refuse_non_request(ty);
2627 self.close_for(&err);
2628 let _ = send.reset(REQUEST_UNANSWERED);
2629 let _ = recv.stop(REQUEST_UNANSWERED);
2630 let refused = ConnectionError::NonRequestOnRequestStream(ty);
2631 self.emit_refused(&refused, Some(stream_id), raw);
2632 return Err(refused);
2633 };
2634
2635 let request_id = match self.endpoint.receive_request_on_stream(&msg) {
2636 Ok(request_id) => request_id,
2637 Err(e) => {
2638 let _ = send.reset(REQUEST_UNANSWERED);
2639 let _ = recv.stop(REQUEST_UNANSWERED);
2640 let err = self.close_if_session_fatal(e);
2641 self.emit_refused(&err, Some(stream_id), raw);
2642 return Err(err);
2643 }
2644 };
2645
2646 Ok((
2647 msg,
2648 RequestStream {
2649 send,
2650 recv,
2651 request_id,
2652 kind,
2653 draft: self.draft,
2654 stream_id,
2655 cancelled: false,
2656 finished: false,
2657 origin: RequestOrigin::Peer,
2658 responded: false,
2659 fetch_data: None,
2660 // A peer's SUBSCRIBE does not establish a subscription until
2661 // it is accepted, so nothing is owed until
2662 // `respond_subscribe_ok` runs.
2663 owes_publish_done: false,
2664 },
2665 ))
2666 }
2667
2668 /// Take the oldest stream pair a cancelled
2669 /// [`accept_request_stream`](Self::accept_request_stream) put back, if any.
2670 ///
2671 /// Synchronous on purpose, like
2672 /// [`take_deferred_uni`](Self::take_deferred_uni): the guard is dropped
2673 /// before the caller awaits, so the lock is never held across a suspension
2674 /// point.
2675 fn take_pending_inbound(&self) -> Option<(FramedSendStream, FramedRecvStream)> {
2676 self.pending_inbound.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).pop_front()
2677 }
2678
2679 /// How many peer-opened request streams a cancelled
2680 /// [`accept_request_stream`](Self::accept_request_stream) put back and a
2681 /// later call has not yet taken.
2682 ///
2683 /// Zero unless an accept future was dropped mid-read.
2684 pub fn pending_inbound_count(&self) -> usize {
2685 self.pending_inbound.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).len()
2686 }
2687
2688 // -- Answering the peer's requests ------------------------------
2689
2690 /// Write `msg` on the request stream `stream` carries, driving the
2691 /// endpoint first and the wire second.
2692 ///
2693 /// The response goes on the request's own bidirectional stream and never
2694 /// on the control stream: draft-22 responses carry no Request ID, so the
2695 /// stream is the only thing that says what is being answered. Taking the
2696 /// id off the handle rather than from the caller makes that correlation
2697 /// unforgeable.
2698 ///
2699 /// `fin` is true only for REQUEST_ERROR. See
2700 /// [`respond_error`](Self::respond_error).
2701 async fn respond(
2702 &mut self,
2703 stream: &mut RequestStream,
2704 msg: ControlMessage,
2705 fin: bool,
2706 ) -> Result<(), ConnectionError> {
2707 // A request this endpoint made is answered by the peer, with one
2708 // exception the draft states outright: "A subscriber can also send
2709 // REQUEST_UPDATE to modify parameters of a subscription established
2710 // with PUBLISH", and the receiver of one "MUST respond with exactly one
2711 // REQUEST_UPDATE_OK or REQUEST_UPDATE_ERROR message indicating if the
2712 // update was successful" — Section 1.5's names for a REQUEST_OK and a
2713 // REQUEST_ERROR answering an update. On a PUBLISH this endpoint sent, that receiver is this
2714 // endpoint, so the one response it may write on a stream of its own is
2715 // the answer to an update waiting there.
2716 let answers_an_update =
2717 matches!(msg, ControlMessage::RequestOk(_) | ControlMessage::RequestError(_))
2718 && self.endpoint.has_unanswered_update(stream.request_id);
2719 if stream.origin != RequestOrigin::Peer && !answers_an_update {
2720 return Err(ConnectionError::RespondedToOwnRequest(stream.request_id.into_inner()));
2721 }
2722 // The endpoint first, so a response that does not fit the request's
2723 // state is refused before any of it reaches the wire. What this cannot
2724 // undo is a write that fails afterwards, which leaves the state
2725 // machine one step ahead of the peer — the same asymmetry
2726 // `begin_request` carries on the outbound side.
2727 self.endpoint.send_response_on_stream(stream.request_id, &msg)?;
2728 self.send_on_request_stream(stream, &msg).await?;
2729 stream.responded = true;
2730 // A REQUEST_ERROR answering an update retires nothing: the
2731 // subscription is live and Section 9.5 now asks for a PUBLISH_DONE
2732 // carrying UPDATE_FAILED. So neither the flag nor the send half is
2733 // cleared, and the obligation this draft already models goes on
2734 // standing until that message is written.
2735 // Section 9.5.1: "When a REQUEST_UPDATE fails for a FETCH, the
2736 // publisher MUST reset the FETCH data stream." A REQUEST_ERROR on a
2737 // fetch that has already been answered can only be answering an
2738 // update, because the request's own answer was the FETCH_OK; one
2739 // before that refuses the fetch itself, and there is no data stream
2740 // open to reset.
2741 if fin && stream.kind == RequestKind::Fetch && stream.responded {
2742 stream.reset_fetch_data();
2743 }
2744 if fin && !self.endpoint.owes_update_failure(stream.request_id) {
2745 // A rejected request owes nothing further, so the guard in
2746 // `finish` cannot be standing: clear the flag rather than let a
2747 // REQUEST_ERROR trip over an obligation the error just retired.
2748 stream.owes_publish_done = false;
2749 stream.finish().await?;
2750 }
2751 Ok(())
2752 }
2753
2754 /// Answer a peer's PUBLISH, PUBLISH_NAMESPACE, SUBSCRIBE_NAMESPACE,
2755 /// SUBSCRIBE_TRACKS or TRACK_STATUS with REQUEST_OK.
2756 ///
2757 /// Draft-18 folded PUBLISH_OK into REQUEST_OK and draft-22 keeps the fold,
2758 /// so this is the one success message for five of the seven request kinds
2759 /// — there is no `respond_publish_ok` here, where draft-17 has one.
2760 ///
2761 /// The send half is left open. A SUBSCRIBE_NAMESPACE responder still owes
2762 /// the peer the namespaces it accepted, so finishing here would end the
2763 /// request before it had been served; a TRACK_STATUS responder owes
2764 /// nothing further and may call [`RequestStream::finish`] straight after.
2765 ///
2766 /// # Errors
2767 ///
2768 /// [`ConnectionError::RespondedToOwnRequest`] if `stream` is one this
2769 /// endpoint opened, and [`ConnectionError::Endpoint`] if no request of a
2770 /// kind REQUEST_OK answers is pending on it — including the Section 9.3
2771 /// case of Track Properties on anything but a TRACK_STATUS response.
2772 /// Nothing is written in any of them.
2773 pub async fn respond_ok(
2774 &mut self,
2775 stream: &mut RequestStream,
2776 response: RequestOk,
2777 ) -> Result<(), ConnectionError> {
2778 self.respond(stream, ControlMessage::RequestOk(response), false).await
2779 }
2780
2781 /// Answer a peer's SUBSCRIBE with SUBSCRIBE_OK.
2782 ///
2783 /// The send half is left open, and it must be: this endpoint is now the
2784 /// publisher of an established subscription and owes it a PUBLISH_DONE,
2785 /// which travels on this same stream —
2786 /// [`publish_done_on`](Self::publish_done_on). Until that has been sent,
2787 /// [`RequestStream::finish`] refuses, per draft-22 Section 6.4.2.2.
2788 pub async fn respond_subscribe_ok(
2789 &mut self,
2790 stream: &mut RequestStream,
2791 response: SubscribeOk,
2792 ) -> Result<(), ConnectionError> {
2793 self.respond(stream, ControlMessage::SubscribeOk(response), false).await?;
2794 stream.owes_publish_done = true;
2795 Ok(())
2796 }
2797
2798 /// Answer a peer's FETCH with FETCH_OK.
2799 ///
2800 /// The send half is left open. The fetched objects travel on separate
2801 /// unidirectional streams, so a fetch responder may call
2802 /// [`RequestStream::finish`] as soon as this returns; it is not done here
2803 /// because nothing about FETCH_OK says the responder has no more to write.
2804 pub async fn respond_fetch_ok(
2805 &mut self,
2806 stream: &mut RequestStream,
2807 response: FetchOk,
2808 ) -> Result<(), ConnectionError> {
2809 self.respond(stream, ControlMessage::FetchOk(response), false).await
2810 }
2811
2812 /// Reject a peer's request with REQUEST_ERROR, and finish the send half.
2813 ///
2814 /// The FIN is part of the act, not a convenience: draft-22 Section 6.4.2.3
2815 /// says "When an endpoint rejects a request without performing any
2816 /// application processing, it SHOULD send a REQUEST_ERROR and FIN the
2817 /// stream." It is also the one response that can be finished immediately,
2818 /// because a rejected request leaves nothing further to send — every
2819 /// success path owes the peer something more, which is what Section 6.4.2.2
2820 /// makes a MUST NOT for the rest of them.
2821 ///
2822 /// A finished handle does nothing further on [`Drop`], so the rejected
2823 /// stream is not then reset.
2824 pub async fn respond_error(
2825 &mut self,
2826 stream: &mut RequestStream,
2827 response: RequestError,
2828 ) -> Result<(), ConnectionError> {
2829 self.respond(stream, ControlMessage::RequestError(response), true).await
2830 }
2831
2832 /// End a subscription this endpoint accepted, on the stream the peer's
2833 /// SUBSCRIBE opened.
2834 ///
2835 /// The mirror of [`publish_done`](Self::publish_done), which ends a
2836 /// publication this endpoint offered with PUBLISH. Both write PUBLISH_DONE
2837 /// on a request stream and take the Request ID off the handle; they differ
2838 /// in which state machine moves, and therefore in which one refuses.
2839 ///
2840 /// The send half is finished once the message is out, for the reason
2841 /// [`publish_done`](Self::publish_done) gives: Section 6.4.2.2 names
2842 /// PUBLISH_DONE as the last required message on a publisher's direction and
2843 /// asks for the FIN promptly after it.
2844 pub async fn publish_done_on(
2845 &mut self,
2846 stream: &mut RequestStream,
2847 status_code: VarInt,
2848 stream_count: VarInt,
2849 reason_phrase: Vec<u8>,
2850 ) -> Result<(), ConnectionError> {
2851 let msg = ControlMessage::PublishDone(moqtap_codec::draft22::message::PublishDone {
2852 status_code,
2853 stream_count,
2854 reason_phrase,
2855 });
2856 self.respond(stream, msg, false).await?;
2857 stream.owes_publish_done = false;
2858 stream.finish().await
2859 }
2860
2861 /// Announce a namespace on a peer's SUBSCRIBE_NAMESPACE stream.
2862 ///
2863 /// Draft-22 Section 9.16 puts NAMESPACE "on the response stream of a
2864 /// SUBSCRIBE_NAMESPACE request", and Table 5 gives it the Stream value
2865 /// Request rather than Control — which is why this exists at all and why
2866 /// [`send_control`](Self::send_control) is the wrong route for it. Section
2867 /// 9.17 has the announcements follow the acceptance, so this refuses until
2868 /// [`respond_ok`](Self::respond_ok) has run on the same stream.
2869 pub async fn namespace_on(
2870 &mut self,
2871 stream: &mut RequestStream,
2872 response: Namespace,
2873 ) -> Result<(), ConnectionError> {
2874 self.respond(stream, ControlMessage::Namespace(response), false).await
2875 }
2876
2877 /// Withdraw a namespace on a peer's SUBSCRIBE_NAMESPACE stream.
2878 ///
2879 /// Section 4.2: "The publisher MUST NOT send NAMESPACE_DONE for a
2880 /// namespace suffix before the corresponding NAMESPACE." Which suffixes
2881 /// have been announced is the caller's bookkeeping, not this connection's,
2882 /// so what is enforced here is only that the request was accepted first.
2883 pub async fn namespace_done_on(
2884 &mut self,
2885 stream: &mut RequestStream,
2886 response: NamespaceDone,
2887 ) -> Result<(), ConnectionError> {
2888 self.respond(stream, ControlMessage::NamespaceDone(response), false).await
2889 }
2890
2891 /// Tell the peer a track matching its SUBSCRIBE_TRACKS will not be
2892 /// published, on that request's own stream.
2893 ///
2894 /// Section 9.19: "All PUBLISH_SKIPPED messages are in response to a
2895 /// SUBSCRIBE_TRACKS," which is why this refuses any other kind of stream —
2896 /// the endpoint looks the Request ID up among the SUBSCRIBE_TRACKS
2897 /// requests alone.
2898 pub async fn publish_skipped_on(
2899 &mut self,
2900 stream: &mut RequestStream,
2901 response: PublishSkipped,
2902 ) -> Result<(), ConnectionError> {
2903 self.respond(stream, ControlMessage::PublishSkipped(response), false).await
2904 }
2905
2906 // -- Subscribe flow ---------------------------------------------
2907
2908 /// Send a SUBSCRIBE on a bidirectional stream of its own.
2909 ///
2910 /// The returned [`RequestStream`] is where SUBSCRIBE_OK, REQUEST_ERROR
2911 /// and later PUBLISH_DONE arrive — read them with
2912 /// [`recv_on_request_stream`](Self::recv_on_request_stream). **Hold it for
2913 /// the subscription's life**: dropping it resets the stream, which
2914 /// cancels the subscription.
2915 pub async fn subscribe(
2916 &mut self,
2917 track_namespace: TrackNamespace,
2918 track_name: Vec<u8>,
2919 parameters: Vec<KeyValuePair>,
2920 ) -> Result<RequestStream, ConnectionError> {
2921 let mut halves = self.open_request_bi().await?;
2922 let (req_id, msg) = Self::or_abandon(
2923 &mut halves,
2924 self.endpoint.subscribe(track_namespace, track_name, parameters),
2925 )?;
2926 self.begin_request(halves, RequestKind::Subscribe, req_id, &msg).await
2927 }
2928
2929 // Draft-22 inherits draft-17's removal of UNSUBSCRIBE. Subscribers end a
2930 // subscription by resetting its request stream — `RequestStream::cancel`
2931 // — or wait for PublishDone.
2932
2933 // -- Fetch flow -------------------------------------------------
2934
2935 /// Send a FETCH on a bidirectional stream of its own.
2936 ///
2937 /// FETCH_OK or REQUEST_ERROR comes back on the returned
2938 /// [`RequestStream`]; the fetched objects arrive on separate
2939 /// unidirectional data streams. Dropping the handle cancels the fetch.
2940 ///
2941 /// # The range is a parameter now
2942 ///
2943 /// Draft-22 Section 9.11 is not draft-19's FETCH: there is no `Fetch Type`, no
2944 /// Standalone or Joining structure, and no inline `Start Location` /
2945 /// `End Location` pair. The range travels in the `LOCATION_FILTER`
2946 /// parameter, so this takes the same three arguments
2947 /// [`subscribe`](Self::subscribe) does. [`fetch_range`](Self::fetch_range)
2948 /// is the same call with the filter built for you; a FETCH with no filter
2949 /// covers `{0,0}` through Largest Object, inclusive.
2950 pub async fn fetch(
2951 &mut self,
2952 track_namespace: TrackNamespace,
2953 track_name: Vec<u8>,
2954 parameters: Vec<KeyValuePair>,
2955 ) -> Result<RequestStream, ConnectionError> {
2956 let mut halves = self.open_request_bi().await?;
2957 let (req_id, msg) = Self::or_abandon(
2958 &mut halves,
2959 self.endpoint.fetch(track_namespace, track_name, parameters),
2960 )?;
2961 self.begin_request(halves, RequestKind::Fetch, req_id, &msg).await
2962 }
2963
2964 /// Send a FETCH for one range, carried as a `LOCATION_FILTER` parameter.
2965 ///
2966 /// **The range is inclusive at both ends.** Draft-19's `End Location` was
2967 /// "the last Object, plus 1; or 0 to indicate the entire Group";
2968 /// draft-22 Section 3.2 and draft-22 Section 3.3.1 both call the range
2969 /// inclusive and carry neither convention, and nothing here restores them.
2970 /// Port a draft-19 call by removing the `+ 1`.
2971 pub async fn fetch_range(
2972 &mut self,
2973 track_namespace: TrackNamespace,
2974 track_name: Vec<u8>,
2975 range: &LocationFilter,
2976 parameters: Vec<KeyValuePair>,
2977 ) -> Result<RequestStream, ConnectionError> {
2978 let mut halves = self.open_request_bi().await?;
2979 let (req_id, msg) = Self::or_abandon(
2980 &mut halves,
2981 self.endpoint.fetch_range(track_namespace, track_name, range, parameters),
2982 )?;
2983 self.begin_request(halves, RequestKind::Fetch, req_id, &msg).await
2984 }
2985
2986 // Draft-22 has no joining fetch. Section 9.11 has no Fetch Type field, no
2987 // variant structures and no joining mechanism (draft-20 removed them), and
2988 // Section 3.4's fill fetch stream replaces it: a subscriber asks for the
2989 // Objects behind the live edge by putting a `FILL_PARAMETERS` parameter on
2990 // its SUBSCRIBE (or on a later REQUEST_UPDATE) rather than by opening a
2991 // second request. See [`accept_fill_stream`](Self::accept_fill_stream) for
2992 // the stream that answers it, and `crate::draft22::fill` for the parameter.
2993
2994 // Draft-22 inherits draft-17's removal of FETCH_CANCEL. Fetchers abort
2995 // with `RequestStream::cancel`, which resets the request stream.
2996
2997 // -- Namespace flows --------------------------------------------
2998
2999 /// Send a SUBSCRIBE_NAMESPACE on a bidirectional stream of its own.
3000 ///
3001 /// Draft-18 split the draft-17 SUBSCRIBE_NAMESPACE into two messages and
3002 /// draft-22 keeps the split. This call sends the renumbered
3003 /// SUBSCRIBE_NAMESPACE (type 0x50), which subscribes to NAMESPACE /
3004 /// NAMESPACE_DONE announcements only. To receive PUBLISH messages for
3005 /// matching tracks, use [`Self::subscribe_tracks`] instead — a separate
3006 /// request on a request stream of its own.
3007 pub async fn subscribe_namespace(
3008 &mut self,
3009 namespace_prefix: TrackNamespace,
3010 parameters: Vec<KeyValuePair>,
3011 ) -> Result<RequestStream, ConnectionError> {
3012 let mut halves = self.open_request_bi().await?;
3013 let (req_id, msg) = Self::or_abandon(
3014 &mut halves,
3015 self.endpoint.subscribe_namespace(namespace_prefix, parameters),
3016 )?;
3017 self.begin_request(halves, RequestKind::SubscribeNamespace, req_id, &msg).await
3018 }
3019
3020 /// Send a SUBSCRIBE_TRACKS (type 0x51, new in draft-18) on a bidirectional
3021 /// stream of its own. Causes the relay to PUBLISH matching tracks back to
3022 /// us.
3023 ///
3024 /// Draft-17 has no such message: this is the seventh request type, and the
3025 /// one that makes draft-22's set differ from draft-17's.
3026 pub async fn subscribe_tracks(
3027 &mut self,
3028 namespace_prefix: TrackNamespace,
3029 parameters: Vec<KeyValuePair>,
3030 ) -> Result<RequestStream, ConnectionError> {
3031 let mut halves = self.open_request_bi().await?;
3032 let (req_id, msg) = Self::or_abandon(
3033 &mut halves,
3034 self.endpoint.subscribe_tracks(namespace_prefix, parameters),
3035 )?;
3036 self.begin_request(halves, RequestKind::SubscribeTracks, req_id, &msg).await
3037 }
3038
3039 /// Send a PUBLISH_NAMESPACE on a bidirectional stream of its own.
3040 pub async fn publish_namespace(
3041 &mut self,
3042 track_namespace: TrackNamespace,
3043 parameters: Vec<KeyValuePair>,
3044 ) -> Result<RequestStream, ConnectionError> {
3045 let mut halves = self.open_request_bi().await?;
3046 let (req_id, msg) = Self::or_abandon(
3047 &mut halves,
3048 self.endpoint.publish_namespace(track_namespace, parameters),
3049 )?;
3050 self.begin_request(halves, RequestKind::PublishNamespace, req_id, &msg).await
3051 }
3052
3053 // -- Track Status flow ------------------------------------------
3054
3055 /// Send a TRACK_STATUS on a bidirectional stream of its own.
3056 pub async fn track_status(
3057 &mut self,
3058 track_namespace: TrackNamespace,
3059 track_name: Vec<u8>,
3060 parameters: Vec<KeyValuePair>,
3061 ) -> Result<RequestStream, ConnectionError> {
3062 let mut halves = self.open_request_bi().await?;
3063 let (req_id, msg) = Self::or_abandon(
3064 &mut halves,
3065 self.endpoint.track_status(track_namespace, track_name, parameters),
3066 )?;
3067 self.begin_request(halves, RequestKind::TrackStatus, req_id, &msg).await
3068 }
3069
3070 // -- Publish flow (publisher side) ------------------------------
3071
3072 /// Send a PUBLISH on a bidirectional stream of its own.
3073 ///
3074 /// REQUEST_OK — which is what draft-22 answers a PUBLISH with, PUBLISH_OK
3075 /// having been folded into it — or REQUEST_ERROR comes back on the
3076 /// returned [`RequestStream`], and [`publish_done`](Self::publish_done) is
3077 /// written back on it when the publication ends, so the handle must be
3078 /// held for as long as the publication lasts.
3079 pub async fn publish(
3080 &mut self,
3081 track_namespace: TrackNamespace,
3082 track_name: Vec<u8>,
3083 track_alias: VarInt,
3084 parameters: Vec<KeyValuePair>,
3085 track_properties: Vec<KeyValuePair>,
3086 ) -> Result<RequestStream, ConnectionError> {
3087 let mut halves = self.open_request_bi().await?;
3088 let (req_id, msg) = Self::or_abandon(
3089 &mut halves,
3090 self.endpoint.publish(
3091 track_namespace,
3092 track_name,
3093 track_alias,
3094 parameters,
3095 track_properties,
3096 ),
3097 )?;
3098 self.begin_request(halves, RequestKind::Publish, req_id, &msg).await
3099 }
3100
3101 /// Send a PUBLISH_DONE on the request stream the PUBLISH opened.
3102 ///
3103 /// PUBLISH_DONE is a response and carries no request id on the wire, so
3104 /// the stream is the only thing that says which publication ended. The id
3105 /// the endpoint needs is taken off `stream`, which makes the correlation
3106 /// unforgeable — there is no way to name one request and write on
3107 /// another's stream.
3108 ///
3109 /// The send half is finished once the message is out. Draft-22 Section
3110 /// 6.4.2.2 names PUBLISH_DONE as the last required message on a publisher's
3111 /// direction — "the publisher of an Established subscription MUST send
3112 /// PUBLISH_DONE, before sending a FIN" — and asks for the FIN promptly
3113 /// afterwards, since nothing further is owed on that direction. Leaving it
3114 /// open instead would end the publication at [`Drop`], which resets the
3115 /// stream with REQUEST_CANCELLED and tells the peer the request was
3116 /// abandoned rather than completed.
3117 ///
3118 /// The receive half stays open. A FIN closes one direction, so the
3119 /// subscriber can still be heard from on its own.
3120 pub async fn publish_done(
3121 &mut self,
3122 stream: &mut RequestStream,
3123 status_code: VarInt,
3124 stream_count: VarInt,
3125 reason_phrase: Vec<u8>,
3126 ) -> Result<(), ConnectionError> {
3127 let request_id = stream.request_id();
3128 let msg = self.endpoint.send_publish_done(
3129 request_id,
3130 status_code,
3131 stream_count,
3132 reason_phrase,
3133 )?;
3134 self.send_on_request_stream(stream, &msg).await?;
3135 stream.owes_publish_done = false;
3136 stream.finish().await
3137 }
3138
3139 // -- Data streams -----------------------------------------------
3140
3141 /// Open a new unidirectional stream for sending subgroup data.
3142 pub async fn open_subgroup_stream(
3143 &self,
3144 header: &AnySubgroupHeader,
3145 ) -> Result<FramedSendStream, ConnectionError> {
3146 let send = self.transport.open_uni().await?;
3147 let mut framed = FramedSendStream::new(send, self.draft);
3148 let sid = framed.stream_id();
3149 framed.write_subgroup_header(header).await?;
3150 self.emit(ClientEvent::StreamOpened {
3151 direction: Direction::Send,
3152 stream_kind: StreamKind::Subgroup,
3153 stream_id: sid,
3154 });
3155 self.emit(ClientEvent::DataStreamHeader {
3156 stream_id: sid,
3157 direction: Direction::Send,
3158 header: header.clone(),
3159 });
3160 Ok(framed)
3161 }
3162
3163 /// Open a new unidirectional stream for sending a FETCH's objects.
3164 ///
3165 /// The objects answering a FETCH do not go on the request's own stream:
3166 /// they go on a unidirectional stream of their own, which opens with a
3167 /// FETCH_HEADER naming the request they belong to. This writes that header
3168 /// and hands back the stream, the same way
3169 /// [`open_subgroup_stream`](Self::open_subgroup_stream) does for a
3170 /// subgroup.
3171 ///
3172 /// The caller owns the stream that comes back. Nothing here remembers
3173 /// which request it belongs to, so an endpoint serving several fetches at
3174 /// once keeps its own map from Request ID to stream.
3175 pub async fn open_fetch_stream(
3176 &self,
3177 header: &AnyFetchHeader,
3178 ) -> Result<FramedSendStream, ConnectionError> {
3179 let send = self.transport.open_uni().await?;
3180 let mut framed = FramedSendStream::new(send, self.draft);
3181 let sid = framed.stream_id();
3182 framed.write_fetch_header(header).await?;
3183 self.emit(ClientEvent::StreamOpened {
3184 direction: Direction::Send,
3185 stream_kind: StreamKind::Fetch,
3186 stream_id: sid,
3187 });
3188 Ok(framed)
3189 }
3190
3191 /// Open the data stream for a FETCH this endpoint is answering, and keep
3192 /// the handle on the request.
3193 ///
3194 /// The same stream [`open_fetch_stream`](Self::open_fetch_stream) returns,
3195 /// parked on the request stream it belongs to. That is what lets a rule
3196 /// about the fetch reach the objects it is serving: a refused
3197 /// REQUEST_UPDATE has to reset this stream, and the connection cannot
3198 /// reset a handle the caller walked away with.
3199 ///
3200 /// Write objects through
3201 /// [`RequestStream::fetch_data`](RequestStream::fetch_data), or through
3202 /// the borrow this returns.
3203 pub async fn open_fetch_stream_on<'s>(
3204 &self,
3205 stream: &'s mut RequestStream,
3206 header: &AnyFetchHeader,
3207 ) -> Result<&'s mut FramedSendStream, ConnectionError> {
3208 let framed = self.open_fetch_stream(header).await?;
3209 stream.fetch_data = Some(framed);
3210 Ok(stream.fetch_data.as_mut().expect("just stored"))
3211 }
3212
3213 /// Accept an incoming unidirectional data stream and read its subgroup
3214 /// header.
3215 ///
3216 /// Streams the peer opened before its control stream are returned first,
3217 /// in arrival order, before any new one is accepted from the transport:
3218 /// [`connect`](Self::connect) had to look at them to find the control
3219 /// stream and set the rest aside rather than drop them. They are
3220 /// otherwise ordinary — the type varint `connect` read is still on the
3221 /// front of each one.
3222 ///
3223 /// A FETCH_HEADER stream, fetch or fill, is never read as a subgroup: it
3224 /// is set aside for [`accept_fetch_stream`](Self::accept_fetch_stream)
3225 /// and [`accept_fill_stream`](Self::accept_fill_stream), and this waits
3226 /// for the next stream.
3227 pub async fn accept_subgroup_stream(
3228 &self,
3229 ) -> Result<(AnySubgroupHeader, FramedRecvStream), ConnectionError> {
3230 let mut framed = self.next_non_fetch_uni().await?;
3231 let sid = framed.stream_id();
3232 let header = framed.read_subgroup_header().await?;
3233 self.emit(ClientEvent::StreamOpened {
3234 direction: Direction::Receive,
3235 stream_kind: StreamKind::Subgroup,
3236 stream_id: sid,
3237 });
3238 self.emit(ClientEvent::DataStreamHeader {
3239 stream_id: sid,
3240 direction: Direction::Receive,
3241 header: header.clone(),
3242 });
3243 // The track is resolved here and not inside the stream: it takes the
3244 // endpoint's alias table, which a stream handle has no way back to.
3245 // Handed over rather than offered, so measuring is not something a
3246 // caller has to remember to ask for.
3247 if let Some(objects) = self.endpoint.track_objects(header.track_alias()) {
3248 framed.measure_objects_against(objects, header.group_id());
3249 }
3250 Ok((header, framed))
3251 }
3252
3253 /// Accept the next unidirectional stream and read its fetch header.
3254 ///
3255 /// [`accept_subgroup_stream`](Self::accept_subgroup_stream)'s twin. The two
3256 /// are separate because the header decides how every object after it is
3257 /// framed, so a caller has to know which it is expecting before the first
3258 /// byte is read.
3259 ///
3260 /// Objects come off the returned stream with
3261 /// [`FramedRecvStream::read_fetch_object`].
3262 ///
3263 /// FETCH_HEADER streams another accept set aside come first, in arrival
3264 /// order. A stream of any other type that arrives while this waits is
3265 /// set aside for [`accept_subgroup_stream`](Self::accept_subgroup_stream).
3266 pub async fn accept_fetch_stream(
3267 &self,
3268 ) -> Result<(AnyFetchHeader, FramedRecvStream), ConnectionError> {
3269 let mut framed = self.next_fetch_uni().await?;
3270 let sid = framed.stream_id();
3271 let header = framed.read_fetch_header().await?;
3272 self.emit(ClientEvent::StreamOpened {
3273 direction: Direction::Receive,
3274 stream_kind: StreamKind::Fetch,
3275 stream_id: sid,
3276 });
3277 self.emit(ClientEvent::FetchStreamHeader {
3278 stream_id: sid,
3279 direction: Direction::Receive,
3280 header: header.clone(),
3281 });
3282 // A fetch header goes out as `FetchStreamHeader`; `DataStreamHeader`
3283 // carries an `AnySubgroupHeader` and cannot express one. What
3284 // `accept_subgroup_stream` does beyond this - the forwarding-preference
3285 // note, the object measurement - is about a subgroup and has no
3286 // counterpart on a fetch stream.
3287 Ok((header, framed))
3288 }
3289
3290 /// Accept the next unidirectional stream as a **fill fetch stream**, new in
3291 /// draft-20 (Section 3.4).
3292 ///
3293 /// A fill fetch stream is framed exactly as a fetch response — a
3294 /// FETCH_HEADER and the fetch object records after it, read with
3295 /// [`FramedRecvStream::read_fetch_object`] — and differs only in what its
3296 /// Request ID names: the SUBSCRIBE (or the REQUEST_UPDATE, which travels
3297 /// under the same Request ID) that asked for the fill, rather than a FETCH.
3298 /// So this is [`accept_fetch_stream`](Self::accept_fetch_stream) with the
3299 /// attribution done: the endpoint is asked whether that request asked for a
3300 /// fill, the stream is counted against the subscription, and the event goes
3301 /// out under [`StreamKind::Fill`].
3302 ///
3303 /// # The object reader is already started
3304 ///
3305 /// Unlike [`accept_fetch_stream`](Self::accept_fetch_stream), the returned
3306 /// stream needs no
3307 /// [`begin_fetch_objects`](FramedRecvStream::begin_fetch_objects) call:
3308 /// objects can be read straight off it. A fetch stream cannot be started
3309 /// here because the Group Order lives on the FETCH the caller sent and
3310 /// nothing on this side holds it; a **fill** stream can, because the
3311 /// endpoint kept the order when the subscription asked for the fill — see
3312 /// [`Endpoint::fill_group_order`](crate::draft22::endpoint::Endpoint::fill_group_order)
3313 /// and [`fill::group_order`](crate::draft22::fill::group_order) for the
3314 /// three-step resolution Section 3.4 and Section 9.20.8 define.
3315 ///
3316 /// Doing it here rather than leaving it to the caller is the difference
3317 /// between an error and a wrong answer: a reader started in the wrong
3318 /// direction still parses every frame, and reports Group IDs that walk the
3319 /// wrong way. A caller that has since learned better restarts it by calling
3320 /// `begin_fetch_objects` itself before reading the first object.
3321 ///
3322 /// # What ends it, and what that does not do
3323 ///
3324 /// Section 3.4.1: a FIN means the whole fill range was delivered, and a
3325 /// reset means the fill failed — "Because there is no REQUEST_ERROR
3326 /// associated with a fill fetch stream, the publisher signals a fill
3327 /// failure by resetting the stream". Neither touches the subscription:
3328 /// "Resetting or cancelling a fill fetch stream, by either endpoint, does
3329 /// not affect the subscription, which continues to deliver objects using
3330 /// subscribe subgroups and datagrams." Tell the endpoint which happened
3331 /// with [`Endpoint::on_fill_stream_ended`](crate::draft22::endpoint::Endpoint::on_fill_stream_ended);
3332 /// a subscriber that wants to stop one early sends `STOP_SENDING` with
3333 /// [`FramedRecvStream::stop`], which Section 3.4.1 gives it outright.
3334 ///
3335 /// # Errors
3336 ///
3337 /// [`ConnectionError::Endpoint`] carrying
3338 /// [`EndpointError::UnrequestedFillStream`] when the header names a request
3339 /// that asked for no fill. Not fatal to the session — draft-22 states no
3340 /// rule for the case, and the stream is the only thing wrong.
3341 ///
3342 /// # Which stream it takes
3343 ///
3344 /// The same one [`accept_fetch_stream`](Self::accept_fetch_stream)
3345 /// would: a FETCH_HEADER stream another accept set aside, else the next
3346 /// one to arrive. Streams of any other type are set aside for
3347 /// [`accept_subgroup_stream`](Self::accept_subgroup_stream).
3348 pub async fn accept_fill_stream(
3349 &mut self,
3350 ) -> Result<(AnyFetchHeader, FramedRecvStream), ConnectionError> {
3351 let mut framed = self.next_fetch_uni().await?;
3352 let sid = framed.stream_id();
3353 let header = framed.read_fetch_header().await?;
3354 let request_id = VarInt::from_u64(header.request_id())
3355 .map_err(|e| ConnectionError::Codec(CodecError::VarInt(e)))?;
3356 self.endpoint.on_fill_stream_opened(request_id)?;
3357 // `on_fill_stream_opened` returned Ok, so the request asked for a fill
3358 // and the entry that answers this exists; the fallback is what a future
3359 // caller that split the two lookups would get, and it is the same
3360 // Section 9.20.8 default `fill::group_order` applies.
3361 let group_order =
3362 self.endpoint.fill_group_order(request_id).unwrap_or(GroupOrder::Ascending);
3363 framed.begin_fetch_objects(group_order);
3364 self.emit(ClientEvent::StreamOpened {
3365 direction: Direction::Receive,
3366 stream_kind: StreamKind::Fill,
3367 stream_id: sid,
3368 });
3369 self.emit(ClientEvent::FetchStreamHeader {
3370 stream_id: sid,
3371 direction: Direction::Receive,
3372 header: header.clone(),
3373 });
3374 Ok((header, framed))
3375 }
3376
3377 /// Take the oldest stream [`connect`](Self::connect) set aside, if any.
3378 ///
3379 /// Synchronous on purpose: the guard is dropped before the caller awaits,
3380 /// so the lock is never held across a suspension point. A poisoned lock
3381 /// is recovered rather than propagated — nothing here can leave the queue
3382 /// in a state a later reader could be misled by, since the only mutations
3383 /// are a `push_back` and a `pop_front`.
3384 fn take_deferred_uni(&self) -> Option<FramedRecvStream> {
3385 self.deferred_uni.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).pop_front()
3386 }
3387
3388 /// Take the oldest FETCH_HEADER stream set aside, if any. Synchronous for
3389 /// the reason [`take_deferred_uni`](Self::take_deferred_uni) is.
3390 fn take_deferred_fetch(&self) -> Option<FramedRecvStream> {
3391 self.deferred_fetch.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).pop_front()
3392 }
3393
3394 fn set_aside(queue: &Mutex<VecDeque<FramedRecvStream>>, framed: FramedRecvStream) {
3395 queue.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).push_back(framed);
3396 }
3397
3398 /// The next stream that is not a FETCH_HEADER stream: a set-aside one
3399 /// first, then the transport's. FETCH_HEADER streams met on the way are
3400 /// set aside. A stream whose type cannot be read is returned, so that the
3401 /// header read reports why.
3402 async fn next_non_fetch_uni(&self) -> Result<FramedRecvStream, ConnectionError> {
3403 loop {
3404 let mut framed = match self.take_deferred_uni() {
3405 Some(framed) => framed,
3406 None => FramedRecvStream::new(self.transport.accept_uni().await?, self.draft),
3407 };
3408 match framed.peek_stream_type().await {
3409 Ok(FETCH_STREAM_TYPE) => Self::set_aside(&self.deferred_fetch, framed),
3410 _ => return Ok(framed),
3411 }
3412 }
3413 }
3414
3415 /// The next FETCH_HEADER stream: a set-aside one first, then the
3416 /// transport's. Streams of other types met on the way are set aside. A
3417 /// stream whose type cannot be read is returned, so that the header read
3418 /// reports why.
3419 async fn next_fetch_uni(&self) -> Result<FramedRecvStream, ConnectionError> {
3420 if let Some(framed) = self.take_deferred_fetch() {
3421 return Ok(framed);
3422 }
3423 loop {
3424 let mut framed = FramedRecvStream::new(self.transport.accept_uni().await?, self.draft);
3425 match framed.peek_stream_type().await {
3426 Ok(stream_type) if stream_type != FETCH_STREAM_TYPE => {
3427 Self::set_aside(&self.deferred_uni, framed)
3428 }
3429 _ => return Ok(framed),
3430 }
3431 }
3432 }
3433
3434 /// How many unidirectional streams have been set aside and not yet handed
3435 /// back: those [`connect`](Self::connect) met before the control stream,
3436 /// and those an accept met that were for another accept.
3437 ///
3438 /// Zero for a peer that opened its control stream first and a caller
3439 /// that accepted each stream as the kind it is, which is the ordinary
3440 /// case.
3441 pub fn deferred_stream_count(&self) -> usize {
3442 self.deferred_uni.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).len()
3443 + self.deferred_fetch.lock().unwrap_or_else(|poisoned| poisoned.into_inner()).len()
3444 }
3445
3446 /// Send an object via datagram.
3447 ///
3448 /// A header whose object status the framing cannot carry is refused rather
3449 /// than sent. A datagram writes a status field only when its type byte sets
3450 /// the STATUS bit, so a header carrying End of Group under a type byte
3451 /// without that bit would go out as an ordinary payload object with the
3452 /// marker missing — a datagram the peer cannot tell from one that never had
3453 /// a status. `AnyDatagramHeader::encode` answers that with
3454 /// `CodecError::InvalidField` and writes nothing, on every draft.
3455 pub fn send_datagram(
3456 &self,
3457 header: &AnyDatagramHeader,
3458 payload: &[u8],
3459 ) -> Result<(), ConnectionError> {
3460 let mut buf = Vec::new();
3461 header.encode(&mut buf)?;
3462 buf.extend_from_slice(payload);
3463 self.emit(ClientEvent::DatagramReceived {
3464 direction: Direction::Send,
3465 header: header.clone(),
3466 payload_len: payload.len(),
3467 });
3468 self.transport.send_datagram(bytes::Bytes::from(buf))?;
3469 Ok(())
3470 }
3471
3472 /// Receive a datagram and decode it whole.
3473 ///
3474 /// Errors with [`ConnectionError::EmptyDatagramProperties`] on a datagram
3475 /// with the PROPERTIES bit set and a Properties Length of 0, which
3476 /// [`Connection::close_for_data_stream`] closes the session over.
3477 ///
3478 /// Errors with [`ConnectionError::PropertiesOnNonNormalStatus`] on a
3479 /// draft-22 datagram carrying properties on a status other than Normal.
3480 /// Draft-22 Section 11.2.1 builds the datagram's Properties field out of
3481 /// the structure defined in Section 11.1.2, and that section answers the
3482 /// combination with a session close — the same rule the subgroup form
3483 /// obeys, on the same receive side.
3484 ///
3485 /// A payload after a status is returned as
3486 /// [`ConnectionError::PayloadOnStatusDatagram`], and the session stays open.
3487 /// The codec's `DatagramHeader::decode_object` then reads the whole
3488 /// datagram. A Prior Group ID Gap or Prior Object ID Gap fault, and a
3489 /// property block that does not parse, are returned as
3490 /// [`ConnectionError::MalformedTrackDatagram`], for
3491 /// [`Connection::requests_to_cancel`]; its other refusals as
3492 /// [`ConnectionError::Codec`].
3493 ///
3494 /// The event is emitted before the checks, so an observer of the client's
3495 /// event stream still sees the datagram that caused the error.
3496 pub async fn recv_datagram(&self) -> Result<(AnyDatagramHeader, Bytes), ConnectionError> {
3497 let data = self.transport.recv_datagram().await?;
3498 let mut cursor = &data[..];
3499 let header = AnyDatagramHeader::decode(self.draft, &mut cursor)?;
3500 let consumed = data.len() - cursor.len();
3501 let payload = data.slice(consumed..);
3502 self.emit(ClientEvent::DatagramReceived {
3503 direction: Direction::Receive,
3504 header: header.clone(),
3505 payload_len: payload.len(),
3506 });
3507 // Refutable only in a build with more than one draft enabled;
3508 // in a single-draft build `AnyDatagramHeader` has one variant.
3509 #[allow(irrefutable_let_patterns)]
3510 if let AnyDatagramHeader::Draft22(h) = &header {
3511 // draft-22 Section 11.2.1: "If an endpoint receives a datagram with the
3512 // PROPERTIES bit set and an Properties Length of 0, it MUST close
3513 // the session with a PROTOCOL_VIOLATION."
3514 if !h.properties_block_well_formed() {
3515 return Err(ConnectionError::EmptyDatagramProperties {
3516 object_id: h.object_id.into_inner(),
3517 });
3518 }
3519 // draft-22 Section 11.2.1: "If an Object Datagram includes both the
3520 // STATUS bit and PROPERTIES bit, and the Object Status is not Normal
3521 // (0x0), the endpoint MUST close the session with a PROTOCOL_VIOLATION, because
3522 // only Normal Objects can have Properties."
3523 if !h.properties_permitted() {
3524 return Err(ConnectionError::PropertiesOnNonNormalStatus {
3525 object_id: h.object_id.into_inner(),
3526 properties_len: h.properties.len(),
3527 status: h.status(),
3528 });
3529 }
3530 if !h.permits_payload() && !payload.is_empty() {
3531 return Err(ConnectionError::PayloadOnStatusDatagram {
3532 object_id: h.object_id.into_inner(),
3533 payload_len: payload.len(),
3534 status: h.object_status,
3535 });
3536 }
3537 // The codec's whole-datagram read, for the rules a header alone
3538 // does not show. A gap fault is returned with the datagram's alias,
3539 // for `requests_to_cancel`.
3540 let whole =
3541 moqtap_codec::draft22::data_stream::DatagramHeader::decode_object(&mut &data[..]);
3542 match whole {
3543 Ok(_) => {}
3544 Err(
3545 error @ (CodecError::MalformedTrack { .. }
3546 | CodecError::MalformedObjectProperties { .. }),
3547 ) => {
3548 return Err(ConnectionError::MalformedTrackDatagram {
3549 track_alias: h.track_alias.into_inner(),
3550 error,
3551 });
3552 }
3553 Err(error) => return Err(ConnectionError::Codec(error)),
3554 }
3555 }
3556 // A datagram is a whole object, so the connection can measure it
3557 // without help from the caller. It cannot *answer* the condition,
3558 // though: the answer is a reset of a request stream the caller holds,
3559 // so both data paths report and neither withdraws - see
3560 // `Connection::requests_to_cancel`.
3561 let meta = header.meta();
3562 self.endpoint.note_received_object(
3563 meta.track_alias,
3564 ObjectLocation { group: meta.group_id, object: meta.object_id },
3565 object_role(meta.status),
3566 )?;
3567 Ok((header, payload))
3568 }
3569
3570 // -- Accessors --------------------------------------------------
3571
3572 /// Access the underlying endpoint state machine.
3573 pub fn endpoint(&self) -> &Endpoint {
3574 &self.endpoint
3575 }
3576
3577 /// Mutable access to the endpoint state machine.
3578 pub fn endpoint_mut(&mut self) -> &mut Endpoint {
3579 &mut self.endpoint
3580 }
3581
3582 /// The SETUP message the server answered the handshake with.
3583 ///
3584 /// `SERVER_SETUP` through draft-16, the server's half of the unified
3585 /// `SETUP` from draft-17. [`AnyControlMessage::fields`] renders it under
3586 /// this draft's own parameter names, in the order they arrived.
3587 pub fn server_setup(&self) -> &AnyControlMessage {
3588 &self.server_setup
3589 }
3590
3591 /// The framed wire bytes of [`Self::server_setup`], as they arrived.
3592 ///
3593 /// Kept beside the decoded form because the encoding is evidence the
3594 /// decoding discards: two relays sending the same parameter can still
3595 /// disagree on how wide a varint they wrote it in.
3596 pub fn server_setup_raw(&self) -> Option<&[u8]> {
3597 self.server_setup_raw.as_deref()
3598 }
3599
3600 /// Returns the draft version this connection is using.
3601 pub fn draft(&self) -> DraftVersion {
3602 self.draft
3603 }
3604
3605 /// Close the session on the wire when the endpoint says a violation is
3606 /// fatal to it, and hand the error back unchanged.
3607 ///
3608 /// [`EndpointError::session_error_code`] answers `Some` for exactly the
3609 /// errors draft-22 tells the receiver to close the session over, and the
3610 /// endpoint has already moved its own state machine to Closed by the time
3611 /// this runs. Without this step that move is purely internal: the local
3612 /// endpoint refuses to start anything new while the peer, which is the one
3613 /// that broke the rule, sees a session that is still open and goes on
3614 /// sending. "MUST close the session with a PROTOCOL_VIOLATION" is a
3615 /// statement about the wire, so it takes a CONNECTION_CLOSE to satisfy it.
3616 ///
3617 /// The reason phrase is the error's own `Display` text, which names the
3618 /// message and the rule rather than repeating the numeric code the close
3619 /// already carries.
3620 ///
3621 /// Errors that answer `None` are recoverable and nothing is sent.
3622 fn close_for(&self, err: &EndpointError) {
3623 if let Some(code) = err.session_error_code() {
3624 // QUIC application error codes are 62-bit; every code in this
3625 // registry is far below `u32::MAX`, and saturating rather than
3626 // truncating means a future code that is not could never be
3627 // reported as a different, assigned one.
3628 let wire_code = u32::try_from(code.as_u64()).unwrap_or(u32::MAX);
3629 self.close(wire_code, err.to_string().as_bytes());
3630 }
3631 }
3632
3633 /// [`close_for`](Self::close_for), then the error unchanged, for the
3634 /// common case where the endpoint's error is also what the caller returns.
3635 fn close_if_session_fatal(&self, err: EndpointError) -> ConnectionError {
3636 self.close_for(&err);
3637 ConnectionError::Endpoint(err)
3638 }
3639
3640 /// Which of this draft's *own* `ConnectionError` variants this error is,
3641 /// and which kind of thing it says.
3642 ///
3643 /// The ten every draft carries answer `None` here: [`AnyConnectionError`]
3644 /// classifies those itself, once, and never asks a draft about them. What
3645 /// is left splits two ways, and the split is the reason this function
3646 /// exists — before it, both halves reached a caller as a sentence and read
3647 /// exactly alike. A [`LocalRefusal`] is this endpoint declining to write
3648 /// something, so nothing reached the wire and no relay is implicated; a
3649 /// [`PeerViolation`] is a peer having done something draft-22 forbids, and
3650 /// carries the session error code draft-22's own text answers it with.
3651 ///
3652 /// Matched exhaustively, with no wildcard arm and deliberately so: a
3653 /// variant added to this draft's error type has to arrive here as a compile
3654 /// error, beside the doc comment quoting the sentence it enforces, rather
3655 /// than as a silent [`ErrorCause::Unclassified`] in the facade.
3656 ///
3657 /// [`AnyConnectionError`]: crate::dispatch::AnyConnectionError
3658 /// [`ErrorCause::Unclassified`]: crate::dispatch::ErrorCause::Unclassified
3659 /// [`LocalRefusal`]: crate::above_codec_rules::DraftSpecificCause::LocalRefusal
3660 /// [`PeerViolation`]: crate::above_codec_rules::DraftSpecificCause::PeerViolation
3661 pub fn draft_specific_cause(
3662 err: &ConnectionError,
3663 ) -> Option<crate::above_codec_rules::DraftSpecificCause> {
3664 use crate::above_codec_rules::{AboveCodecRule, DraftSpecificCause};
3665 use moqtap_codec::draft22::error_codes::SessionErrorCode;
3666
3667 match err {
3668 ConnectionError::Endpoint(_)
3669 | ConnectionError::Codec(_)
3670 | ConnectionError::Transport(_)
3671 | ConnectionError::VarInt(_)
3672 | ConnectionError::NoControlStream
3673 | ConnectionError::UnexpectedEnd
3674 | ConnectionError::StreamFinished
3675 | ConnectionError::InvalidAddress(_)
3676 | ConnectionError::TlsConfig(_)
3677 | ConnectionError::DataStreamState(_) => None,
3678 // This build decoding a message and then failing to narrow it to
3679 // its own draft. Nothing reached the wire and no peer is
3680 // implicated, which is the whole reason it is not
3681 // `ConnectionError::Codec`: under that name it would carry
3682 // `Some(PROTOCOL_VIOLATION)` out of `codec_session_error_code` and
3683 // publish a relay for this build's defect. See the variant's own
3684 // doc.
3685 ConnectionError::ControlMessageNarrowing => {
3686 Some(crate::above_codec_rules::DraftSpecificCause::LocalRefusal)
3687 }
3688 // Section 11.1.2 states the rule and names the code in the same
3689 // sentence. The codec refuses such an Object only as a bare
3690 // `InvalidField`, so this layer is the one that names the rule,
3691 // and `close_for_data_stream` performs the close by
3692 // reading this same answer.
3693 ConnectionError::PropertiesOnNonNormalStatus { .. } => {
3694 Some(DraftSpecificCause::PeerViolation {
3695 rule: AboveCodecRule::PropertiesOnNonNormalStatus,
3696 close: Some(SessionErrorCode::ProtocolViolation.as_u64()),
3697 })
3698 }
3699 // draft-22 Section 11.2.1 answers it with a close, which this variant
3700 // names. See the variant's own doc.
3701 ConnectionError::EmptyDatagramProperties { .. } => Some(DraftSpecificCause::Codec {
3702 error: CodecError::InvalidField,
3703 close: Some(SessionErrorCode::ProtocolViolation.as_u64()),
3704 }),
3705 // The codec's refusal, carried with the alias its error does
3706 // not name. draft-22 Section 12.1 answers a Malformed Track by
3707 // cancelling requests, and `codec_session_error_code` names no
3708 // close for it.
3709 ConnectionError::MalformedTrackDatagram { error, .. } => {
3710 Some(DraftSpecificCause::Codec {
3711 close: Self::codec_session_error_code(error).map(|code| code.as_u64()),
3712 error: error.clone(),
3713 })
3714 }
3715 // Section 11.1.1 states this one as a property of a conforming
3716 // Object rather than as one of the cases a draft answers with a
3717 // close. That phrase carries no quotation marks and must not: it
3718 // is this crate naming a shape of drafting, and the marks would
3719 // file the words on the section named right beside them — which is
3720 // the one section here that pointedly does not carry them. The
3721 // datagram is refused and the session is left running. `None` is
3722 // that reading, and it is what keeps a relay from being published
3723 // for a rule its draft attaches no consequence to.
3724 ConnectionError::PayloadOnStatusDatagram { .. } => {
3725 Some(DraftSpecificCause::PeerViolation {
3726 rule: AboveCodecRule::PayloadOnStatusDatagram,
3727 close: None,
3728 })
3729 }
3730 // Section 6.3: "Bidirectional streams MUST NOT begin with any
3731 // other message type unless negotiated. If they do, the peer MUST
3732 // close the Session with a PROTOCOL_VIOLATION." The session has
3733 // already been closed on the wire by the time this is returned, so
3734 // the code is carried here for a caller to read which rule was
3735 // answered, not for it to answer one again.
3736 ConnectionError::NonRequestOnRequestStream(_) => {
3737 Some(DraftSpecificCause::PeerViolation {
3738 rule: AboveCodecRule::BidiStreamOpener,
3739 close: Some(SessionErrorCode::ProtocolViolation.as_u64()),
3740 })
3741 }
3742 // Three ways of handing this endpoint a message it will not write,
3743 // and one answer: nothing reached the wire, so nothing here is
3744 // evidence about a peer. Two are messages put on the control stream
3745 // that belong on a request stream of their own; the third is a
3746 // `respond_*` helper pointed at a request this endpoint opened,
3747 // which only the endpoint a request was opened *toward* may answer.
3748 ConnectionError::RequestOnControlStream(_)
3749 | ConnectionError::RequestStreamMessageOnControlStream(_)
3750 | ConnectionError::RespondedToOwnRequest(_) => Some(DraftSpecificCause::LocalRefusal),
3751 // Section 6.4.2.2 forbids a FIN before the response a request type
3752 // requires, and before PUBLISH_DONE on an established
3753 // subscription. Both are raised when *this* endpoint asks for the
3754 // FIN, so both are refusals rather than findings: the draft's rule
3755 // is being kept, not broken.
3756 ConnectionError::FinBeforeResponse(_) | ConnectionError::FinBeforePublishDone(_) => {
3757 Some(DraftSpecificCause::LocalRefusal)
3758 }
3759 }
3760 }
3761
3762 /// The code to close the session with when a control message could not be
3763 /// decoded because the peer broke a rule draft-22 answers with a close.
3764 ///
3765 /// Every variant listed here comes from a sentence in the draft that names
3766 /// the consequence: the reason phrase and GOAWAY URI maxima (Section 8.5
3767 /// and Section 9.2), the KVP value maximum and the delta-encoded
3768 /// type overflow (Section 8.3), the duplicate-parameter rule (Section
3769 /// 9.20), the Track Namespace field, count and length rules
3770 /// (Section 8.7), and the Object ID delta wrap (Section 11.3.1). Each of
3771 /// those reads "MUST close the session with a PROTOCOL_VIOLATION".
3772 ///
3773 /// The Object ID wrap is the one that arrives here from a data stream
3774 /// rather than a control message, and it is drafts 18, 19 and 20 only:
3775 /// "The Object ID Delta + 1 is added to the previous Object ID in the
3776 /// Subgroup stream if there was one... If the resulting Object ID would be
3777 /// greater than 2^64 - 1, the endpoint MUST close the session with a
3778 /// PROTOCOL_VIOLATION." Draft-17 describes the same arithmetic and states
3779 /// no consequence for overflowing it, so its connection deliberately leaves
3780 /// the wrap off this list and treats it as a decode failure alone.
3781 ///
3782 /// One more rule reaches this table without naming a code: "An endpoint
3783 /// that receives an unknown message type MUST close the session", stated in
3784 /// those words by all the drafts. Protocol Violation is what carries
3785 /// it, as it does on every draft below this one.
3786 ///
3787 /// `None` for everything else, including [`CodecError::InvalidField`]. That
3788 /// variant is shared by a dozen unrelated malformations, only some of which
3789 /// the draft answers with a close, so treating it as fatal would close
3790 /// sessions the draft does not ask to be closed. Splitting it is the way to
3791 /// bring the rest of those rules under this function; widening the match is
3792 /// not — the Object ID wrap is answerable here because it has a variant of
3793 /// its own rather than being one more reading of `InvalidField`.
3794 pub fn codec_session_error_code(
3795 err: &CodecError,
3796 ) -> Option<moqtap_codec::draft22::error_codes::SessionErrorCode> {
3797 use moqtap_codec::draft22::error_codes::SessionErrorCode;
3798 use moqtap_codec::kvp::KvpError;
3799 match err {
3800 // The declared Length disagreeing with the fields, which every
3801 // draft answers with a close. Drafts 07 through 10 name no code for
3802 // it, so it takes the one their other unnamed rules take.
3803 // A `Location Filter Type` outside the six Section 9.20.9 assigns.
3804 // Section 9.20.9: "Any other Location Filter Type is a
3805 // PROTOCOL_VIOLATION." The type is the only thing that says how
3806 // many fields follow it, and the parameter carries no length, so a
3807 // reader that cannot name the type cannot find the next parameter
3808 // either: the close is the only answer there is room for.
3809 // `CodecRule::InvalidFilterType` publishes the same sentence for
3810 // this draft.
3811 CodecError::InvalidFilterType(_) => Some(SessionErrorCode::ProtocolViolation),
3812 // An AbsoluteRange filter whose End Group Delta carries the range
3813 // past the end of the number space, Section 9.20.9: "If StartGroup +
3814 // EndGroupDelta exceeds 2^64 - 1, the endpoint MUST close the
3815 // session with a PROTOCOL_VIOLATION."
3816 //
3817 // Draft-22's own wording. Drafts 18 and 19 state the rule as two
3818 // sentences, where the consequence follows a clause supplying the
3819 // antecedent for *the resulting Group ID*; draft-22 states it as
3820 // the one self-contained sentence above, naming its operands.
3821 // Drafts 18 and 19 put it in their Section 5.1.2 and draft-22 in
3822 // Section 9.20.9, and all three name
3823 // PROTOCOL_VIOLATION, so a sentence borrowed from a neighbour is
3824 // the shape a reader cannot tell from a transcription — which is
3825 // why `CodecRule` keeps the two wordings as separate runs, so that
3826 // neither draft is published with the other's words.
3827 //
3828 // New in draft-18; draft-17, which introduced the delta, states no
3829 // such sentence.
3830 CodecError::FilterEndGroupOverflow { .. } => {
3831 Some(SessionErrorCode::ProtocolViolation)
3832 }
3833 // Draft-22 has no Fetch Type: Section 9.11 has no such field, no
3834 // variant structures and no registry for it, so this draft's
3835 // FETCH decoder cannot produce this error. The arm stays because
3836 // `CodecError` is shared across every draft and is not
3837 // `#[non_exhaustive]`, and because the answer would not change if
3838 // it could: a discriminator a reader cannot name is a message it
3839 // cannot find the end of, which is the PROTOCOL_VIOLATION the arms
3840 // around it carry.
3841 CodecError::InvalidFetchType(_) => Some(SessionErrorCode::ProtocolViolation),
3842 CodecError::ControlMessageLengthMismatch { .. } => {
3843 Some(SessionErrorCode::ProtocolViolation)
3844 }
3845 CodecError::KeyDeltaOverflow(..)
3846 | CodecError::DuplicateParameter(_)
3847 | CodecError::TrackNameTooLong
3848 | CodecError::InvalidNamespaceTupleSize(_)
3849 | CodecError::ReasonPhraseTooLong
3850 | CodecError::GoAwayUriTooLong
3851 | CodecError::UnknownMessageType(_)
3852 | CodecError::Kvp(KvpError::ValueTooLong(_))
3853 | CodecError::EmptyNamespaceField
3854 | CodecError::ObjectIdOverflow(..) => Some(SessionErrorCode::ProtocolViolation),
3855 // An unknown data-plane type. Drafts 17 and later split the sentence
3856 // in two: Section 6.4.1 for streams, Section 11 for datagrams, both
3857 // ending "MUST close the session" and neither naming a code, so both
3858 // take the one this draft's other unnamed rules take.
3859 // A Message Parameter whose value is outside the range its type
3860 // allows: FORWARD in Section 9.20.18 and GROUP_ORDER in Section 9.20.8.
3861 // Each states that a receiver "MUST close the session with
3862 // PROTOCOL_VIOLATION".
3863 CodecError::ParameterValueOutOfRange { .. } => {
3864 Some(SessionErrorCode::ProtocolViolation)
3865 }
3866 // A Track Extension or Track Property whose value is outside the
3867 // range its type allows: DEFAULT_PUBLISHER_GROUP_ORDER in Section 10.5
3868 // and DYNAMIC_GROUPS in Section 10.6.
3869 // Each states that a receiver "MUST close the session with
3870 // PROTOCOL_VIOLATION".
3871 //
3872 // A separate arm from the parameter rule above because the two
3873 // registries are separate: 0x22 is GROUP_ORDER as a parameter and
3874 // DEFAULT_PUBLISHER_GROUP_ORDER as a Track Property, and a log that
3875 // named only the number would not say which.
3876 CodecError::TrackPropertyValueOutOfRange { .. } => {
3877 Some(SessionErrorCode::ProtocolViolation)
3878 }
3879 CodecError::UnknownStreamType(_) | CodecError::UnknownDatagramType(_) => {
3880 Some(SessionErrorCode::ProtocolViolation)
3881 }
3882 // A Type inside a form this draft defines but on a list it names as
3883 // invalid: Section 11.3.1 for a subgroup header whose SUBGROUP_ID_MODE
3884 // is the reserved 0b11, Section 11.2.1 for a datagram asking to be both
3885 // an object status and an end-of-group marker. Unlike the rule above,
3886 // these two name their code outright.
3887 CodecError::InvalidStreamTypeValue { .. }
3888 | CodecError::InvalidDatagramTypeValue { .. } => {
3889 Some(SessionErrorCode::ProtocolViolation)
3890 }
3891 // A key-value pair whose value is not the serialization its own
3892 // Type defines, Section 8.3: "If a receiver understands a Type,
3893 // and the following Value or Length/Value does not match the
3894 // serialization defined by that Type, the receiver MUST close the
3895 // session with error code KEY_VALUE_FORMATTING_ERROR."
3896 //
3897 // Section 8.9 states the same answer for the one structure this
3898 // draft spells out: "If the Token structure cannot be decoded, the
3899 // receiver MUST close the Session with KEY_VALUE_FORMATTING_ERROR."
3900 //
3901 // The one rule in this table that names a code other than Protocol
3902 // Violation.
3903 CodecError::KeyValueFormatting { .. }
3904 // A filter parameter whose value is not a filter reaches the same
3905 // sentence. Drafts 15 and 16 answered it with PROTOCOL_VIOLATION
3906 // instead, on the strength of a sentence of the parameter's own that
3907 // this draft dropped; what remains is the general rule above, so the
3908 // code changed with it.
3909 | CodecError::SubscriptionFilterMalformed { .. } => {
3910 Some(SessionErrorCode::KeyValueFormattingError)
3911 }
3912 // A Message Parameter whose type this draft does not define, Section
3913 // 9.20: "All Message Parameters MUST be defined in the negotiated
3914 // version of MOQT or negotiated via Setup Options. An endpoint that
3915 // receives an unknown Message Parameter MUST close the session with
3916 // PROTOCOL_VIOLATION."
3917 //
3918 // One namespace only. This draft also says a receiver ignores an
3919 // unrecognised Setup Option, so an unknown type in a SETUP is carried and
3920 // the codec never raises this for one.
3921 CodecError::UnknownMessageParameter(_) => Some(SessionErrorCode::ProtocolViolation),
3922 // A Message Parameter in a message type its own definition does not
3923 // name, Section 9.20.1: "Each Message Parameter definition indicates
3924 // the message types in which it can appear, and each control
3925 // message definition lists the parameters it allows. If a parameter
3926 // appears in some other type of message, the receiving endpoint
3927 // MUST close the connection with a PROTOCOL_VIOLATION."
3928 //
3929 // Draft-16 and every draft before it end that same sentence "it MUST
3930 // be ignored", so this is a rule whose answer reverses rather than
3931 // one that arrives.
3932 CodecError::ParameterOutOfScope { .. } => Some(SessionErrorCode::ProtocolViolation),
3933 // Everything this draft does not answer, named rather than swept up
3934 // by a wildcard. The arm is exhaustive deliberately: a new
3935 // `CodecError` variant will not compile until it has been placed on
3936 // one side or the other, on this draft, which is the decision a `_`
3937 // arm makes silently and invisibly on every draft at once.
3938 //
3939 // Adding one variant to `CodecError` produces one `E0004` per
3940 // draft, each naming the variant that has nowhere to go. That is
3941 // the whole mechanism.
3942 //
3943 // The nesting stops at `VarInt`, whose variants report how the bytes
3944 // ran out rather than a rule an endpoint states, so there is nothing
3945 // in it for a draft to answer. `Kvp` is spelled out because it does
3946 // carry one.
3947 // Neither field exists from draft-15 on. Forwarding became the
3948 // FORWARD parameter, which carries the same rule in a different
3949 // shape and is answered above under its own variant; Content Exists
3950 // became the presence or absence of a LARGEST_OBJECT parameter.
3951 CodecError::InvalidForward(_)
3952 | CodecError::InvalidContentExists(_)
3953 | CodecError::UnexpectedEnd
3954 | CodecError::MessageTooLong(_)
3955 | CodecError::VarInt(_)
3956 | CodecError::InvalidField
3957 | CodecError::InvalidRange(..)
3958 | CodecError::ParameterLengthMismatch(_)
3959 | CodecError::EndOfTrackObjectId(_)
3960 | CodecError::ParametersOutOfOrder(..)
3961 | CodecError::ExtensionsOnNonExistentObject(_)
3962 | CodecError::InvalidRequiredRequestIdDelta(..)
3963 // The object payload rule, Section 11.1.1, which draft-22 states
3964 // against a registry rather than against zero: "An Object MUST have
3965 // an empty payload unless its Object Status value is registered as
3966 // permitting a payload in the Object Status registry (Section 16.9).
3967 // Of the values defined in this document, only Normal (0x0) permits
3968 // a payload." Still a MUST on the sender with no receiver action
3969 // named, so the answer is the one every draft before it gets.
3970 | CodecError::PayloadNotPermitted { .. }
3971 // A property block that does not parse makes the Track malformed,
3972 // Section 10.7.
3973 | CodecError::MalformedObjectProperties { .. }
3974 // A Malformed Track (Section 12.1) costs the track and not the
3975 // session.
3976 | CodecError::MalformedTrack { .. }
3977 // Raised only by the draft-23 codec.
3978 | CodecError::ControlMessageExceedsLimit { .. }
3979 | CodecError::MissingErrorDetail { .. }
3980 | CodecError::MalformedErrorDetail { .. }
3981 | CodecError::TokenAliasInSetup { .. }
3982 | CodecError::EmptyTrackName
3983 | CodecError::MalformedAuthToken { .. }
3984 | CodecError::TrackPropertiesNotPermitted
3985 | CodecError::DeltaDecodingOverflow { .. }
3986 | CodecError::MalformedObject { .. }
3987 | CodecError::UnknownObjectStatus(_)
3988 | CodecError::UnsupportedDraft(_)
3989 | CodecError::Kvp(
3990 KvpError::MissingLength | KvpError::UnexpectedEnd | KvpError::VarInt(_),
3991 ) => None,
3992 }
3993 }
3994
3995 /// Close the session on the wire when a decode failure is one draft-22
3996 /// answers with a close, and hand the error back unchanged.
3997 ///
3998 /// The codec's counterpart to
3999 /// [`close_if_session_fatal`](Self::close_if_session_fatal). Without it
4000 /// every bound the decoder enforces would stop at *this endpoint refused the
4001 /// frame* while the peer, which is the one that broke the rule, saw a
4002 /// session that was still open and went on sending. "MUST close the session
4003 /// with a PROTOCOL_VIOLATION" is a statement about the wire.
4004 fn close_for_codec(&self, err: ConnectionError) -> ConnectionError {
4005 if let ConnectionError::Codec(inner) = &err {
4006 if let Some(code) = Self::codec_session_error_code(inner) {
4007 // QUIC application error codes are 62-bit; every code in this
4008 // registry is far below `u32::MAX`, and saturating rather than
4009 // truncating means a future code that is not could never be
4010 // reported as a different, assigned one.
4011 let wire_code = u32::try_from(code.as_u64()).unwrap_or(u32::MAX);
4012 self.close(wire_code, inner.to_string().as_bytes());
4013 }
4014 }
4015 err
4016 }
4017
4018 /// Name every request whose stream the caller must reset, for a track a
4019 /// data path has just found malformed.
4020 ///
4021 /// Section 12.1 answers its whole list of conditions at once: "it MUST
4022 /// cancel any corresponding subscription or fetches for that Track from
4023 /// that publisher". On this draft cancelling a request is a transport
4024 /// operation rather than a message — Section 6.4.2.3: "Implementations cancel a request by
4025 /// abruptly terminating any directions of the stream that are still open,
4026 /// using RESET_STREAM for a direction they are sending and STOP_SENDING for
4027 /// a direction they are receiving."
4028 ///
4029 /// **No RFC 2119 keyword on this draft.** Drafts 17 and 18 say
4030 /// implementations SHOULD cancel this way; draft-22 states it as what
4031 /// cancelling *is*, and adds the case of an endpoint that has already sent
4032 /// a FIN and sends STOP_SENDING alone.
4033 ///
4034 /// # Why this returns ids instead of doing it
4035 ///
4036 /// Because the streams are the caller's. Every request on this draft lives
4037 /// at the front of a bidirectional stream of its own, and
4038 /// [`Connection::recv_on_request_stream`] hands that stream back as a
4039 /// [`RequestStream`]. There is no handle here to reset. So the connection
4040 /// does the half it can — note the track, and work out which requests
4041 /// receive it — and the caller passes each id to
4042 /// [`Connection::cancel_request_stream`], which resets the stream *and*
4043 /// moves the endpoint's record.
4044 ///
4045 /// **This is the one place in this crate where the two halves of an answer
4046 /// are split across the API boundary**, and it is the draft that splits
4047 /// them: drafts 12 through 16 answer with a control message, which the
4048 /// connection owns, so `withdraw_for_data_stream` there does the whole
4049 /// thing.
4050 ///
4051 /// # Both data paths come here
4052 ///
4053 /// Unlike the drafts that answer with a message, where a datagram is read
4054 /// through the connection and answers itself. Here neither path can, for
4055 /// the same reason, so there is one entry point rather than two. Pass it
4056 /// whatever error a read returned; anything that is not this condition
4057 /// gives back an empty list.
4058 ///
4059 /// Empty is not "the track was fine" — it is also what an alias no live
4060 /// binding names gives, and what a track this endpoint only publishes
4061 /// gives.
4062 pub fn requests_to_cancel(&self, err: &ConnectionError) -> Vec<VarInt> {
4063 match err {
4064 ConnectionError::Endpoint(EndpointError::ObjectPastFinalObject { alias, .. }) => {
4065 self.endpoint.requests_for_malformed_track(
4066 *alias,
4067 MalformedTrackCondition::ObjectPastFinalObject,
4068 )
4069 }
4070 ConnectionError::MalformedTrackDatagram { track_alias, error } => {
4071 malformed_track_condition(error).map_or_else(Vec::new, |condition| {
4072 self.endpoint.requests_for_malformed_track(*track_alias, condition)
4073 })
4074 }
4075 _ => Vec::new(),
4076 }
4077 }
4078
4079 /// [`Connection::requests_to_cancel`] for an error read from the subgroup
4080 /// stream `header` opened, which also names the requests to cancel over
4081 /// the [`CodecError::MalformedTrack`] that
4082 /// [`FramedRecvStream::read_subgroup_object`] returns for a Prior Group ID
4083 /// Gap or Prior Object ID Gap fault (draft-22 Section 10.8,
4084 /// draft-22 Section 10.9), and over the
4085 /// [`CodecError::MalformedObjectProperties`] it returns for a property block
4086 /// that does not parse (draft-22 Section 10.7). Those errors name no track, so
4087 /// the header supplies its alias.
4088 ///
4089 /// draft-22 Section 12.1: "When a subscriber detects a Malformed Track, it
4090 /// MUST cancel any corresponding subscription or fetches for that Track
4091 /// from that publisher (see Section 6.4.2.3)". The session stays open.
4092 pub fn requests_to_cancel_for_subgroup_stream(
4093 &self,
4094 header: &AnySubgroupHeader,
4095 err: &ConnectionError,
4096 ) -> Vec<VarInt> {
4097 if let ConnectionError::Codec(codec) = err {
4098 if let Some(condition) = malformed_track_condition(codec) {
4099 return self.endpoint.requests_for_malformed_track(header.track_alias(), condition);
4100 }
4101 }
4102 self.requests_to_cancel(err)
4103 }
4104
4105 /// [`Connection::requests_to_cancel`] for an error read from the fetch stream
4106 /// `header` opened, which also names the requests to cancel over the
4107 /// [`CodecError::MalformedTrack`] that
4108 /// [`FramedRecvStream::read_fetch_object`] returns for a Prior Group ID
4109 /// Gap or Prior Object ID Gap fault (draft-22 Section 10.8,
4110 /// draft-22 Section 10.9), and over the
4111 /// [`CodecError::MalformedObjectProperties`] it returns for a property block
4112 /// that does not parse (draft-22 Section 10.7). Those errors name no track, so
4113 /// the track the FETCH under the header's Request ID asked for is the one.
4114 ///
4115 /// draft-22 Section 12.1: "When a subscriber detects a Malformed Track, it
4116 /// MUST cancel any corresponding subscription or fetches for that Track
4117 /// from that publisher (see Section 6.4.2.3)". The session stays open.
4118 pub fn requests_to_cancel_for_fetch_stream(
4119 &self,
4120 header: &AnyFetchHeader,
4121 err: &ConnectionError,
4122 ) -> Vec<VarInt> {
4123 if let ConnectionError::Codec(codec) = err {
4124 if let Some(condition) = malformed_track_condition(codec) {
4125 return self
4126 .endpoint
4127 .requests_for_malformed_fetch_track(header.request_id(), condition);
4128 }
4129 }
4130 self.requests_to_cancel(err)
4131 }
4132
4133 /// Close the session when a failure raised while reading a *data* stream is
4134 /// one draft-22 answers with a close. Reports whether it closed.
4135 ///
4136 /// [`recv_control`](Self::recv_control) does this for itself, because it
4137 /// owns both the stream and the connection. A data stream does not:
4138 /// [`accept_subgroup_stream`](Self::accept_subgroup_stream) hands the caller
4139 /// a [`FramedRecvStream`], which holds no connection and so cannot close
4140 /// one, and the reads that raise these failures happen there. The caller is
4141 /// the only party holding both halves, which is what this is for:
4142 ///
4143 /// ```no_run
4144 /// # async fn f(conn: &moqtap_client::draft22::connection::Connection,
4145 /// # framed: &mut moqtap_client::draft22::connection::FramedRecvStream)
4146 /// # -> Result<(), Box<dyn std::error::Error>> {
4147 /// if let Err(err) = framed.read_subgroup_object().await {
4148 /// conn.close_for_data_stream(&err);
4149 /// return Err(err.into());
4150 /// }
4151 /// # Ok(()) }
4152 /// ```
4153 ///
4154 /// Splitting it this way rather than closing inside the reader keeps a
4155 /// caller that is deliberately permissive — a tool reproducing a capture,
4156 /// say — able to read a violating stream and report it without tearing the
4157 /// session down. The rule is stated at endpoints, and this is where an
4158 /// endpoint decides it is one.
4159 ///
4160 /// Only [`ConnectionError::Codec`] failures are matched, against the same
4161 /// `codec_session_error_code` table the
4162 /// control path uses, so a rule is answered with one code whichever stream
4163 /// carried it. The Object ID delta wrap of Section 11.3.1 is the entry that
4164 /// can only arrive this way.
4165 pub fn close_for_data_stream(&self, err: &ConnectionError) -> bool {
4166 use crate::above_codec_rules::DraftSpecificCause;
4167
4168 match err {
4169 ConnectionError::Codec(inner) => {
4170 let Some(code) = Self::codec_session_error_code(inner) else { return false };
4171 let wire_code = u32::try_from(code.as_u64()).unwrap_or(u32::MAX);
4172 self.close(wire_code, inner.to_string().as_bytes());
4173 true
4174 }
4175 // Not a `Codec` failure: the codec refuses such an Object as a bare
4176 // `InvalidField`, which `read_subgroup_object` narrows to this
4177 // crate's own variant, so the mapping table above never sees it.
4178 //
4179 // The code comes from `draft_specific_cause` rather than from a
4180 // constant here, so this draft's reading of its own sentence is
4181 // written down once and a caller who reads the error as a value
4182 // sees the same code the peer was sent.
4183 ConnectionError::PropertiesOnNonNormalStatus { .. } => {
4184 let Some(DraftSpecificCause::PeerViolation { close: Some(code), .. }) =
4185 Self::draft_specific_cause(err)
4186 else {
4187 return false;
4188 };
4189 // Saturate rather than truncate, so a future code above
4190 // `u32::MAX` is never reported as a different assigned one.
4191 self.close(u32::try_from(code).unwrap_or(u32::MAX), err.to_string().as_bytes());
4192 true
4193 }
4194 // Not a `Codec` failure: the codec refuses the datagram as a bare
4195 // `InvalidField`, which `recv_datagram` names, so the code comes
4196 // from `draft_specific_cause`.
4197 ConnectionError::EmptyDatagramProperties { .. } => {
4198 let Some(DraftSpecificCause::Codec { close: Some(code), .. }) =
4199 Self::draft_specific_cause(err)
4200 else {
4201 return false;
4202 };
4203 self.close(u32::try_from(code).unwrap_or(u32::MAX), err.to_string().as_bytes());
4204 true
4205 }
4206 _ => false,
4207 }
4208 }
4209
4210 /// Close the connection.
4211 pub fn close(&self, code: u32, reason: &[u8]) {
4212 self.emit(ClientEvent::Closed { code, reason: reason.to_vec() });
4213 self.transport.close(code, reason);
4214 }
4215}
4216
4217/// The Malformed Track condition a codec refusal on a data path is, on this
4218/// draft, or `None` for a refusal that is not one.
4219fn malformed_track_condition(err: &CodecError) -> Option<MalformedTrackCondition> {
4220 match err {
4221 CodecError::MalformedTrack { .. } => Some(MalformedTrackCondition::PriorGap),
4222 // draft-22 Section 10.7: "A Key-Value-Pair cannot be parsed."
4223 CodecError::MalformedObjectProperties { .. } => {
4224 Some(MalformedTrackCondition::MalformedPropertyBlock)
4225 }
4226 _ => None,
4227 }
4228}
4229
4230#[cfg(test)]
4231mod tests {
4232 use super::*;
4233
4234 /// Only a refusal of what the peer sent is reported as a refused frame,
4235 /// and only with the bytes it was about.
4236 #[test]
4237 fn only_a_refusal_of_the_peers_frame_is_reported() {
4238 let raw = Some(vec![0x01]);
4239 let decoder = ConnectionError::Codec(CodecError::UnexpectedEnd);
4240 assert!(Connection::refused_event(&decoder, None, raw.clone()).is_some());
4241 assert!(Connection::refused_event(&decoder, None, None).is_none());
4242 let local = ConnectionError::Endpoint(EndpointError::NotActive);
4243 assert!(Connection::refused_event(&local, None, raw).is_none());
4244 }
4245
4246 /// This build failing to narrow a message it decoded is never a finding
4247 /// about the peer.
4248 ///
4249 /// The arm that raises `ControlMessageNarrowing` is unreachable — this
4250 /// draft's decoder can only hand back this draft's variant — and nothing
4251 /// pins that. What is pinned here is the half that matters.
4252 /// `CodecError::UnknownMessageType(0)` is what the arm must not raise:
4253 /// `codec_session_error_code` answers it `Some(PROTOCOL_VIOLATION)` on
4254 /// every draft in range, so the day the narrowing failed a conformance
4255 /// probe would publish a relay for sending a control message type this
4256 /// draft does not assign — with `0x00` attached as the codepoint that
4257 /// proved it, which is an accusation better evidenced than any real one
4258 /// this build makes. The section stating that rule is numbered differently
4259 /// on every draft, and the point does not turn on the number.
4260 #[test]
4261 fn a_message_this_build_could_not_narrow_names_nobody() {
4262 use crate::dispatch::{AnyConnectionError, ErrorCause};
4263
4264 let err: AnyConnectionError = ConnectionError::ControlMessageNarrowing.into();
4265 assert!(err.is_local(), "a narrowing this build could not do is this build's");
4266 assert_eq!(
4267 err.cause(),
4268 &ErrorCause::Facade,
4269 "nothing reached the wire, so there is no rule and no close code to read"
4270 );
4271 }
4272
4273 /// Draft-22 uses MoQT's variable-length integer, whose length is the
4274 /// number of leading 1 bits in the first byte, not RFC 9000's two-bit
4275 /// prefix. Control framing measures the type field with it before any
4276 /// bytes past the first have arrived.
4277 #[test]
4278 fn varint_len_follows_the_moqt_encoding() {
4279 let draft = DraftVersion::Draft22;
4280 assert_eq!(draft.varint_len(0x00), 1);
4281 assert_eq!(draft.varint_len(0x7F), 1);
4282 assert_eq!(draft.varint_len(0x80), 2);
4283 assert_eq!(draft.varint_len(0xBF), 2);
4284 assert_eq!(draft.varint_len(0xC0), 3);
4285 assert_eq!(draft.varint_len(0xFF), 9);
4286 // SETUP's type id, 0x2F00, is two bytes here and four under RFC 9000.
4287 assert_eq!(draft.varint_len(0xAF), 2);
4288 }
4289
4290 #[test]
4291 fn client_config_alpn_quic_draft22() {
4292 let config = ClientConfig {
4293 draft: DraftVersion::Draft22,
4294 transport: TransportType::Quic,
4295 skip_cert_verification: false,
4296 ca_certs: Vec::new(),
4297 setup_parameters: Vec::new(),
4298 };
4299 assert_eq!(config.alpn(), vec![b"moqt-22".to_vec()]);
4300 }
4301
4302 #[test]
4303 fn client_config_alpn_webtransport() {
4304 let config = ClientConfig {
4305 draft: DraftVersion::Draft22,
4306 transport: TransportType::WebTransport { url: "https://example.com".to_string() },
4307 skip_cert_verification: false,
4308 ca_certs: Vec::new(),
4309 setup_parameters: Vec::new(),
4310 };
4311 assert_eq!(config.alpn(), vec![b"h3".to_vec()]);
4312 }
4313
4314 /// `MOQT_ALPN` is the ALPN a client configured for this draft offers.
4315 #[test]
4316 fn moqt_alpn_is_the_one_a_client_offers() {
4317 // A literal on its own is what let this constant keep `moq-00` for
4318 // five drafts after draft-15 stopped using it, so the value is
4319 // checked against what a client configured for this draft actually
4320 // puts on the wire, and only then against the literal.
4321 let config = ClientConfig {
4322 draft: DraftVersion::Draft22,
4323 transport: TransportType::Quic,
4324 skip_cert_verification: false,
4325 ca_certs: Vec::new(),
4326 setup_parameters: Vec::new(),
4327 };
4328 assert_eq!(
4329 config.alpn(),
4330 vec![MOQT_ALPN.to_vec()],
4331 "MOQT_ALPN is {:?}; a draft-{} client offers {:?}",
4332 String::from_utf8_lossy(MOQT_ALPN),
4333 22,
4334 config
4335 .alpn()
4336 .iter()
4337 .map(|a| String::from_utf8_lossy(a).into_owned())
4338 .collect::<Vec<_>>(),
4339 );
4340 assert_eq!(MOQT_ALPN, b"moqt-22");
4341 }
4342
4343 /// Draft-22 Section 6.3 names seven message types a bidirectional stream
4344 /// may begin with, and no others. The set is checked against the raw
4345 /// numbers this draft's registry assigns rather than against the names,
4346 /// so a variant that is renumbered — SUBSCRIBE_NAMESPACE moved from 0x11
4347 /// to 0x50 between draft-17 and draft-18 — is caught even though the
4348 /// spelling did not change, and so is a port that carries draft-17's six
4349 /// over and leaves SUBSCRIBE_TRACKS (0x51) out.
4350 ///
4351 /// Every type this draft assigns is classified: the loop walks the whole
4352 /// assigned range and asks the classifier about each one it finds.
4353 #[test]
4354 fn only_seven_message_types_open_a_request_stream() {
4355 // TRACK_STATUS, SUBSCRIBE, PUBLISH, FETCH, PUBLISH_NAMESPACE,
4356 // SUBSCRIBE_NAMESPACE and SUBSCRIBE_TRACKS, written as the numbers
4357 // draft-22 assigns them.
4358 let mut expected = vec![0x0D, 0x03, 0x1D, 0x16, 0x06, 0x50, 0x51];
4359 expected.sort_unstable();
4360
4361 let mut opens = Vec::new();
4362 for id in 0..=CONTROL_STREAM_TYPE {
4363 if let Some(ty) = MessageType::from_id(id) {
4364 if starts_a_request_stream(ty) {
4365 opens.push(id);
4366 }
4367 }
4368 }
4369 opens.sort_unstable();
4370
4371 assert_eq!(
4372 opens, expected,
4373 "the types that open a request stream are {opens:?}; \
4374 draft-22 Section 6.3 names {expected:?}"
4375 );
4376 }
4377
4378 /// The kind a request helper labels its stream with must name the message
4379 /// that helper actually writes, and the check is made against the type
4380 /// varint the encoded message leads with — the byte a peer reads to
4381 /// decide whether the bidirectional stream is legal.
4382 ///
4383 /// This is the mislabelling a port from another draft is most likely to
4384 /// introduce, because the numbers move between drafts while the names do
4385 /// not. SUBSCRIBE_TRACKS is here for the opposite reason: it has no
4386 /// draft-17 counterpart at all, so a port that forgot it would leave
4387 /// `subscribe_tracks` on the control stream and nothing below would
4388 /// notice.
4389 #[test]
4390 fn each_request_kind_labels_the_message_its_helper_writes() {
4391 use crate::draft22::endpoint::Endpoint;
4392 use moqtap_codec::draft22::message::Setup;
4393
4394 let v = |n: u64| VarInt::from_u64(n).unwrap();
4395 let ns = TrackNamespace(vec![b"ns".to_vec()]);
4396
4397 let mut ep = Endpoint::new(Role::Client);
4398 ep.connect().unwrap();
4399 let _ = ep.send_setup(vec![]).unwrap();
4400 ep.receive_setup(&Setup { options: vec![] }).unwrap();
4401
4402 let (_, subscribe) = ep.subscribe(ns.clone(), b"t".to_vec(), vec![]).unwrap();
4403 let built = vec![
4404 (RequestKind::Subscribe, subscribe),
4405 // One FETCH, not two: draft-22 Section 9.11 has no Fetch Type field
4406 // and no joining fetch (draft-20 removed both), so there is no second shape
4407 // for this to label.
4408 (RequestKind::Fetch, ep.fetch(ns.clone(), b"t".to_vec(), vec![]).unwrap().1),
4409 (
4410 RequestKind::SubscribeNamespace,
4411 ep.subscribe_namespace(ns.clone(), vec![]).unwrap().1,
4412 ),
4413 (RequestKind::SubscribeTracks, ep.subscribe_tracks(ns.clone(), vec![]).unwrap().1),
4414 (RequestKind::PublishNamespace, ep.publish_namespace(ns.clone(), vec![]).unwrap().1),
4415 (
4416 RequestKind::TrackStatus,
4417 ep.track_status(ns.clone(), b"t".to_vec(), vec![]).unwrap().1,
4418 ),
4419 (
4420 RequestKind::Publish,
4421 ep.publish(ns.clone(), b"t".to_vec(), v(7), vec![], vec![]).unwrap().1,
4422 ),
4423 ];
4424
4425 for (kind, msg) in built {
4426 let mut wire = Vec::new();
4427 msg.encode(&mut wire).unwrap();
4428 let mut cursor = &wire[..];
4429 let on_the_wire =
4430 DraftVersion::Draft22.decode_varint(&mut cursor).unwrap().into_inner();
4431 assert_eq!(
4432 kind.message_type().id(),
4433 on_the_wire,
4434 "{kind:?} is labelled {} but its message leads with {on_the_wire}",
4435 kind.message_type().id(),
4436 );
4437 assert!(
4438 starts_a_request_stream(kind.message_type()),
4439 "{kind:?} labels a message type that may not begin a bidirectional stream",
4440 );
4441 }
4442 }
4443
4444 /// The classifier the accept path runs and the one
4445 /// [`Connection::send_control`] runs must answer alike for every message
4446 /// type this draft assigns, or a message could be refused on the control
4447 /// stream and refused again as the opening of a request stream — leaving
4448 /// no legal place for it.
4449 ///
4450 /// SUBSCRIBE_TRACKS is the one a port from draft-17 would drop, because
4451 /// draft-17 has no such message to copy.
4452 #[test]
4453 fn the_two_request_stream_classifiers_agree() {
4454 let mut classified = 0;
4455 for id in 0..=CONTROL_STREAM_TYPE {
4456 let Some(ty) = MessageType::from_id(id) else { continue };
4457 classified += 1;
4458 let kind = RequestKind::from_message_type(ty);
4459 assert_eq!(
4460 kind.is_some(),
4461 starts_a_request_stream(ty),
4462 "type {id} {} a request stream but from_message_type calls it {kind:?}",
4463 if starts_a_request_stream(ty) { "opens" } else { "does not open" },
4464 );
4465 if let Some(kind) = kind {
4466 assert_eq!(
4467 kind.message_type(),
4468 ty,
4469 "from_message_type sent type {id} to {kind:?}, which names a different message",
4470 );
4471 }
4472 }
4473 assert!(classified > 7, "the loop found only {classified} assigned message types");
4474 }
4475
4476 /// A stream this endpoint opened is cancelled when its handle is dropped;
4477 /// one the peer opened is reset as unserved. Both codes are on the wire,
4478 /// so they may not be the same number.
4479 #[test]
4480 fn the_two_abandonment_codes_are_distinct() {
4481 assert_eq!(REQUEST_CANCELLED, 0x1);
4482 assert_eq!(REQUEST_UNANSWERED, 0x0);
4483 assert_ne!(
4484 REQUEST_CANCELLED, REQUEST_UNANSWERED,
4485 "a peer cannot tell a rejected request from a dropped one if both reset with the same code",
4486 );
4487 }
4488
4489 #[test]
4490 fn transport_type_debug() {
4491 let quic = TransportType::Quic;
4492 assert!(format!("{quic:?}").contains("Quic"));
4493
4494 let wt = TransportType::WebTransport { url: "https://example.com".to_string() };
4495 assert!(format!("{wt:?}").contains("WebTransport"));
4496 }
4497}
4498
4499#[cfg(test)]
4500mod accept_on_the_wire {
4501 //! The accept path against a real QUIC peer.
4502 //!
4503 //! Everything the responder side does that a peer can see — which stream a
4504 //! response goes out on, which code an abandoned request stream is reset
4505 //! with, whether a FIN arrives before the messages that direction still
4506 //! owes, and which session error code a violation closes with — is
4507 //! observable only from the other end of a connection. A test holding an
4508 //! endpoint alone is satisfied by state that never reached the wire, so
4509 //! these hold the other end.
4510 //!
4511 //! The peer is raw `quinn` for everything the accept path decides. It does
4512 //! use [`FramedRecvStream`] to decode what comes back, because control
4513 //! framing is shared by both directions and gated elsewhere; the
4514 //! classification, registration, routing and stream-closing under test here
4515 //! are not part of it.
4516
4517 use super::*;
4518 use std::sync::Arc;
4519
4520 use std::net::SocketAddr;
4521 use std::time::Duration;
4522
4523 use moqtap_codec::draft22::message::{
4524 GoAway, Publish, PublishDone, Setup, Subscribe, SubscribeNamespace,
4525 };
4526
4527 /// Session termination codes, draft-22 Section 16.11.1.
4528 const PROTOCOL_VIOLATION: u64 = 0x3;
4529 const INVALID_REQUEST_ID: u64 = 0x4;
4530
4531 /// Long enough that a loaded machine cannot fail a test that would
4532 /// otherwise pass, short enough that a hang is reported rather than run to
4533 /// the harness timeout.
4534 const PATIENCE: Duration = Duration::from_secs(10);
4535
4536 /// How long to wait before concluding that nothing more is coming. Used
4537 /// only where the absence of a message is the assertion, so it is a floor
4538 /// on the test's run time and is kept small.
4539 const QUIET: Duration = Duration::from_millis(300);
4540
4541 fn v(n: u64) -> VarInt {
4542 VarInt::from_u64(n).unwrap()
4543 }
4544
4545 fn ns() -> TrackNamespace {
4546 TrackNamespace(vec![b"live".to_vec()])
4547 }
4548
4549 fn encode(msg: ControlMessage) -> Vec<u8> {
4550 let mut buf = Vec::new();
4551 AnyControlMessage::Draft22(msg).encode(&mut buf).expect("encode");
4552 buf
4553 }
4554
4555 /// A SUBSCRIBE carrying `id`. Odd ids are the ones a server allocates,
4556 /// which is what a client's peer must use.
4557 fn subscribe(id: u64) -> ControlMessage {
4558 ControlMessage::Subscribe(Subscribe {
4559 request_id: v(id),
4560 track_namespace: ns(),
4561 track_name: b"video".to_vec(),
4562 parameters: vec![],
4563 })
4564 }
4565
4566 fn request_update(id: u64) -> ControlMessage {
4567 ControlMessage::RequestUpdate(moqtap_codec::draft22::message::RequestUpdate {
4568 request_id: v(id),
4569 parameters: vec![],
4570 })
4571 }
4572
4573 fn peer_fetch(id: u64) -> ControlMessage {
4574 ControlMessage::Fetch(moqtap_codec::draft22::message::Fetch {
4575 request_id: v(id),
4576 track_namespace: ns(),
4577 track_name: b"video".to_vec(),
4578 parameters: vec![],
4579 })
4580 }
4581
4582 fn fetch_ok() -> FetchOk {
4583 FetchOk {
4584 end_of_track: 0,
4585 end_group: v(1),
4586 end_object: v(0),
4587 parameters: vec![],
4588 track_properties: vec![],
4589 }
4590 }
4591
4592 fn subscribe_ok() -> SubscribeOk {
4593 SubscribeOk { track_alias: v(7), parameters: vec![], track_properties: vec![] }
4594 }
4595
4596 fn request_error() -> RequestError {
4597 RequestError {
4598 error_code: v(0x1),
4599 retry_interval: v(0),
4600 reason_phrase: b"no".to_vec(),
4601 redirect: None,
4602 }
4603 }
4604
4605 fn init_crypto() {
4606 let _ = rustls::crypto::ring::default_provider().install_default();
4607 }
4608
4609 /// A quinn server on a loopback port, offering this draft's ALPN.
4610 fn server_endpoint() -> (quinn::Endpoint, SocketAddr) {
4611 use rcgen::{CertificateParams, KeyPair, PKCS_ECDSA_P256_SHA256};
4612 use rustls::pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer};
4613
4614 let key_pair = KeyPair::generate_for(&PKCS_ECDSA_P256_SHA256).expect("keypair");
4615 let params = CertificateParams::new(vec!["localhost".into()]).expect("params");
4616 let cert = params.self_signed(&key_pair).expect("self-sign");
4617 let cert_der = CertificateDer::from(cert.der().to_vec());
4618 let key_der = PrivateKeyDer::Pkcs8(PrivatePkcs8KeyDer::from(key_pair.serialize_der()));
4619
4620 let mut server_crypto = rustls::ServerConfig::builder()
4621 .with_no_client_auth()
4622 .with_single_cert(vec![cert_der], key_der)
4623 .expect("server cert");
4624 server_crypto.alpn_protocols = vec![DraftVersion::Draft22.quic_alpn().to_vec()];
4625 let server_crypto =
4626 quinn::crypto::rustls::QuicServerConfig::try_from(server_crypto).expect("quic crypto");
4627 let server_config = quinn::ServerConfig::with_crypto(Arc::new(server_crypto));
4628 let endpoint = quinn::Endpoint::server(server_config, "127.0.0.1:0".parse().unwrap())
4629 .expect("bind server");
4630 let addr = endpoint.local_addr().expect("local_addr");
4631 (endpoint, addr)
4632 }
4633
4634 async fn connect_client(addr: SocketAddr) -> Result<Connection, ConnectionError> {
4635 Connection::connect(
4636 &addr.to_string(),
4637 ClientConfig {
4638 draft: DraftVersion::Draft22,
4639 transport: TransportType::Quic,
4640 skip_cert_verification: true,
4641 ca_certs: Vec::new(),
4642 setup_parameters: Vec::new(),
4643 },
4644 )
4645 .await
4646 }
4647
4648 /// The peer's half of the setup exchange: read the client's SETUP off its
4649 /// unidirectional control stream, answer with one of our own.
4650 ///
4651 /// Both control streams are handed back so they stay open for the
4652 /// connection's life. Dropping a quinn receive stream sends STOP_SENDING
4653 /// and dropping a send stream resets it, either of which would look to the
4654 /// client like the control plane failing.
4655 async fn peer_handshake(
4656 endpoint: &quinn::Endpoint,
4657 ) -> (quinn::Connection, quinn::SendStream, quinn::RecvStream) {
4658 let conn = endpoint.accept().await.expect("accept").await.expect("tls handshake");
4659 let mut client_control = conn.accept_uni().await.expect("accept_uni");
4660 let mut seen = Vec::new();
4661 let mut chunk = [0u8; 1024];
4662 while seen.len() < 3 {
4663 match client_control.read(&mut chunk).await.expect("read SETUP") {
4664 Some(n) => seen.extend_from_slice(&chunk[..n]),
4665 None => break,
4666 }
4667 }
4668 assert!(!seen.is_empty(), "the client sent no SETUP");
4669 let mut ours = conn.open_uni().await.expect("open_uni");
4670 ours.write_all(&encode(ControlMessage::Setup(Setup { options: Vec::new() })))
4671 .await
4672 .expect("write SETUP");
4673 (conn, ours, client_control)
4674 }
4675
4676 /// A connected client and the peer holding the other end.
4677 struct Loopback {
4678 conn: Connection,
4679 peer: quinn::Connection,
4680 _endpoint: quinn::Endpoint,
4681 _control_send: quinn::SendStream,
4682 _control_recv: quinn::RecvStream,
4683 }
4684
4685 async fn loopback() -> Loopback {
4686 init_crypto();
4687 let (endpoint, addr) = server_endpoint();
4688 let (client, peer) = tokio::join!(connect_client(addr), peer_handshake(&endpoint));
4689 let (peer, control_send, control_recv) = peer;
4690 Loopback {
4691 conn: client.expect("client connect"),
4692 peer,
4693 _endpoint: endpoint,
4694 _control_send: control_send,
4695 _control_recv: control_recv,
4696 }
4697 }
4698
4699 fn framed(recv: quinn::RecvStream) -> FramedRecvStream {
4700 FramedRecvStream::new(RecvStream::Quic(recv), DraftVersion::Draft22)
4701 }
4702
4703 /// Read one control message the client wrote, failing rather than hanging.
4704 async fn next_control(recv: &mut FramedRecvStream) -> ControlMessage {
4705 let (any, _) = tokio::time::timeout(PATIENCE, recv.read_control(false))
4706 .await
4707 .expect("the client wrote nothing")
4708 .expect("read control");
4709 match any {
4710 AnyControlMessage::Draft22(msg) => msg,
4711 #[allow(unreachable_patterns)]
4712 other => panic!("expected a draft-22 message, got {other:?}"),
4713 }
4714 }
4715
4716 async fn assert_closed_with(peer: &quinn::Connection, code: u64, phrase: &str) {
4717 let reason = tokio::time::timeout(PATIENCE, peer.closed())
4718 .await
4719 .expect("the client reported the violation but never closed the connection");
4720 match reason {
4721 quinn::ConnectionError::ApplicationClosed(frame) => {
4722 assert_eq!(u64::from(frame.error_code), code, "the close carried the wrong code");
4723 let text = String::from_utf8_lossy(&frame.reason).to_string();
4724 assert!(
4725 text.contains(phrase),
4726 "the close reason should name the rule that was broken; got {text:?}",
4727 );
4728 }
4729 other => panic!("expected an application close, got {other:?}"),
4730 }
4731 }
4732
4733 /// A peer's SUBSCRIBE is accepted, answered on the stream it arrived on,
4734 /// and cannot be finished until each message draft-22 Section 6.4.2.2
4735 /// requires has been sent.
4736 #[tokio::test]
4737 async fn a_peers_subscribe_is_answered_on_the_stream_it_arrived_on() {
4738 let mut lb = loopback().await;
4739
4740 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
4741 ps.write_all(&encode(subscribe(1))).await.expect("write SUBSCRIBE");
4742 let mut pr = framed(pr);
4743
4744 let (msg, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4745 .await
4746 .expect("accept hung")
4747 .expect("accept");
4748 assert!(matches!(msg, ControlMessage::Subscribe(_)), "{msg:?}");
4749 assert_eq!(stream.origin(), RequestOrigin::Peer);
4750 assert_eq!(stream.kind(), RequestKind::Subscribe);
4751 assert_eq!(stream.request_id().into_inner(), 1);
4752 assert_eq!(lb.conn.endpoint().peer_request_count(), 1);
4753
4754 // Section 6.4.2.2: "an endpoint sending a response to a request MUST send
4755 // the corresponding response message ... before sending a FIN."
4756 let err = stream.finish().await.err();
4757 assert!(
4758 matches!(err, Some(ConnectionError::FinBeforeResponse(1))),
4759 "a FIN before the response must be refused: {err:?}",
4760 );
4761
4762 lb.conn.respond_subscribe_ok(&mut stream, subscribe_ok()).await.expect("respond");
4763 assert!(stream.responded());
4764 // On the request's own stream, not the control stream: this reader is
4765 // the peer's half of the bidirectional stream it opened.
4766 assert!(matches!(next_control(&mut pr).await, ControlMessage::SubscribeOk(_)));
4767
4768 // The rest of the same sentence: "the publisher of an Established
4769 // subscription MUST send PUBLISH_DONE, before sending a FIN."
4770 assert!(stream.owes_publish_done());
4771 let err = stream.finish().await.err();
4772 assert!(
4773 matches!(err, Some(ConnectionError::FinBeforePublishDone(1))),
4774 "a FIN before PUBLISH_DONE must be refused: {err:?}",
4775 );
4776
4777 lb.conn
4778 .publish_done_on(&mut stream, v(0), v(0), Vec::new())
4779 .await
4780 .expect("publish_done_on");
4781 assert!(matches!(next_control(&mut pr).await, ControlMessage::PublishDone(_)));
4782
4783 // And now the FIN, which is a clean end rather than a reset.
4784 let end = pr.read_control(false).await.expect_err("the stream should have ended");
4785 assert!(
4786 matches!(end, ConnectionError::UnexpectedEnd),
4787 "the completed request stream should end with a FIN, not {end}",
4788 );
4789 }
4790
4791 /// A refused update leaves the stream open for the termination it owes.
4792 ///
4793 /// Section 9.5.1: "When a REQUEST_UPDATE is unsuccessful, the publisher
4794 /// MUST also terminate the subscription by sending a PUBLISH_DONE with
4795 /// error code UPDATE_FAILED." That message has to go on the request's own
4796 /// stream, so a REQUEST_ERROR answering an update cannot finish the send
4797 /// half the way one answering the request does.
4798 #[tokio::test]
4799 async fn a_refused_update_leaves_the_stream_open_for_its_termination() {
4800 let mut lb = loopback().await;
4801
4802 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
4803 ps.write_all(&encode(subscribe(1))).await.expect("write SUBSCRIBE");
4804 let mut pr = framed(pr);
4805
4806 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4807 .await
4808 .expect("accept hung")
4809 .expect("accept");
4810 lb.conn.respond_subscribe_ok(&mut stream, subscribe_ok()).await.expect("respond");
4811 assert!(matches!(next_control(&mut pr).await, ControlMessage::SubscribeOk(_)));
4812 assert!(stream.owes_publish_done());
4813
4814 // The peer updates the subscription and this endpoint refuses it.
4815 // The read is what puts the update on the endpoint's books; refusing
4816 // one it has not seen is a different error entirely.
4817 ps.write_all(&encode(request_update(1))).await.expect("write REQUEST_UPDATE");
4818 let update = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut stream))
4819 .await
4820 .expect("the update never arrived")
4821 .expect("read the update");
4822 assert!(matches!(update, ControlMessage::RequestUpdate(_)), "{update:?}");
4823 lb.conn.respond_error(&mut stream, request_error()).await.expect("refuse the update");
4824 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestError(_)));
4825
4826 // The subscription is still live and still owes its ending, so the
4827 // stream is neither finished nor relieved of the obligation.
4828 assert!(
4829 stream.owes_publish_done(),
4830 "a refused update retires nothing: the subscription still owes a PUBLISH_DONE",
4831 );
4832
4833 lb.conn
4834 .publish_done_on(&mut stream, v(0x8), v(0), Vec::new())
4835 .await
4836 .expect("the termination the refusal owes");
4837 assert!(matches!(next_control(&mut pr).await, ControlMessage::PublishDone(_)));
4838 }
4839
4840 /// A refused namespace update closes the stream rather than owing a message.
4841 ///
4842 /// Section 9.5.1 sorts a refused REQUEST_UPDATE by what was being
4843 /// updated, and a namespace subscription falls in the clause that ends
4844 /// with the transport rather than with a message: "When a REQUEST_UPDATE
4845 /// fails for a SUBSCRIBE_NAMESPACE, SUBSCRIBE_TRACKS or PUBLISH_NAMESPACE,
4846 /// the responder MUST close the bidi stream (see Section 6.4.2.2)." There is
4847 /// no subscription to terminate here and no PUBLISH_DONE that could go
4848 /// out, so a send half held open for one would stay open for good.
4849 #[tokio::test]
4850 async fn a_refused_namespace_update_closes_the_stream() {
4851 let mut lb = loopback().await;
4852
4853 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
4854 ps.write_all(&encode(ControlMessage::SubscribeNamespace(SubscribeNamespace {
4855 request_id: v(1),
4856 namespace_prefix: ns(),
4857 parameters: vec![],
4858 })))
4859 .await
4860 .expect("write SUBSCRIBE_NAMESPACE");
4861 let mut pr = framed(pr);
4862
4863 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4864 .await
4865 .expect("accept hung")
4866 .expect("accept");
4867 lb.conn
4868 .respond_ok(&mut stream, RequestOk { parameters: vec![], track_properties: vec![] })
4869 .await
4870 .expect("respond_ok");
4871 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestOk(_)));
4872
4873 // The peer asks to move the prefix and this endpoint refuses.
4874 ps.write_all(&encode(request_update(1))).await.expect("write REQUEST_UPDATE");
4875 let update = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut stream))
4876 .await
4877 .expect("read hung")
4878 .expect("read REQUEST_UPDATE");
4879 assert!(matches!(update, ControlMessage::RequestUpdate(_)));
4880 lb.conn.respond_error(&mut stream, request_error()).await.expect("refuse the update");
4881 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestError(_)));
4882
4883 // The refusal ends this request stream, so the peer's next read finds
4884 // the send half closed rather than waiting on a message a namespace
4885 // subscription has no way to send.
4886 let ended = tokio::time::timeout(PATIENCE, pr.read_control(false))
4887 .await
4888 .expect("the peer is still reading: the refusal never closed the send half")
4889 .expect_err("a refused namespace update left the stream open");
4890 assert!(
4891 matches!(ended, ConnectionError::UnexpectedEnd),
4892 "the peer should have seen the FIN, got {ended:?}",
4893 );
4894 }
4895
4896 /// Draft-22 Section 6.4.2.3: "When an endpoint rejects a request without
4897 /// performing any application processing, it SHOULD send a REQUEST_ERROR
4898 /// and FIN the stream." The FIN is what tells the peer the request is over;
4899 /// without it the handle's [`Drop`] would reset the stream instead.
4900 #[tokio::test]
4901 async fn a_rejected_request_is_finished_rather_than_reset() {
4902 let mut lb = loopback().await;
4903
4904 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
4905 ps.write_all(&encode(subscribe(1))).await.expect("write SUBSCRIBE");
4906 let mut pr = framed(pr);
4907
4908 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4909 .await
4910 .expect("accept hung")
4911 .expect("accept");
4912 lb.conn.respond_error(&mut stream, request_error()).await.expect("respond_error");
4913 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestError(_)));
4914
4915 // Dropping the handle after the FIN must not turn a rejection into a
4916 // reset, so the end of stream is read after the handle is gone.
4917 drop(stream);
4918 let end = pr.read_control(false).await.expect_err("the stream should have ended");
4919 assert!(
4920 matches!(end, ConnectionError::UnexpectedEnd),
4921 "a rejected request stream should be finished, not {end}",
4922 );
4923 }
4924
4925 /// Draft-22 Section 6.3: a bidirectional stream that begins with a message
4926 /// type that opens no request "MUST close the Session with a
4927 /// PROTOCOL_VIOLATION" — on the wire, not only in the local state machine.
4928 /// The code is not draft-22 Section 6.4.2.1's INVALID_REQUEST_ID.
4929 #[tokio::test]
4930 async fn a_stream_that_opens_no_request_closes_the_session() {
4931 let mut lb = loopback().await;
4932
4933 let (mut ps, _pr) = lb.peer.open_bi().await.expect("open_bi");
4934 ps.write_all(&encode(ControlMessage::GoAway(GoAway {
4935 new_session_uri: Vec::new(),
4936 timeout: v(0),
4937 })))
4938 .await
4939 .expect("write GOAWAY");
4940
4941 // `RequestStream` is not `Debug` — it owns two live stream halves — so
4942 // the accepted case is named rather than unwrapped.
4943 let err = match tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4944 .await
4945 .expect("accept hung")
4946 {
4947 Err(e) => e,
4948 Ok((msg, _)) => panic!("a GOAWAY opens no request stream, but {msg:?} was accepted"),
4949 };
4950 assert!(
4951 matches!(err, ConnectionError::NonRequestOnRequestStream(MessageType::GoAway)),
4952 "{err}",
4953 );
4954
4955 assert_closed_with(&lb.peer, PROTOCOL_VIOLATION, "GoAway").await;
4956 }
4957
4958 /// Draft-22 Section 6.4.2.1: "If an endpoint receives a Request ID where the
4959 /// least significant bit is incorrect for the sender ... it MUST close the
4960 /// session with INVALID_REQUEST_ID." A different rule from the one above,
4961 /// and a different code, so a peer can tell them apart.
4962 #[tokio::test]
4963 async fn a_peer_id_with_the_wrong_parity_closes_the_session() {
4964 let mut lb = loopback().await;
4965
4966 let (mut ps, _pr) = lb.peer.open_bi().await.expect("open_bi");
4967 // 2 is even, so it is an id this client allocates for itself.
4968 ps.write_all(&encode(subscribe(2))).await.expect("write SUBSCRIBE");
4969
4970 let err = match tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4971 .await
4972 .expect("accept hung")
4973 {
4974 Err(e) => e,
4975 Ok((msg, _)) => {
4976 panic!("an even Request ID from a server peer must be refused, not {msg:?}")
4977 }
4978 };
4979 assert!(matches!(err, ConnectionError::Endpoint(EndpointError::RequestId(_))), "{err}");
4980
4981 assert_closed_with(&lb.peer, INVALID_REQUEST_ID, "parity").await;
4982 }
4983
4984 /// Dropping a request stream is one act with two meanings, and the peer
4985 /// can only tell them apart if the codes differ: a request this endpoint
4986 /// made was cancelled, a request made of it was never served.
4987 #[tokio::test]
4988 async fn an_unserved_request_and_a_cancelled_one_reset_with_different_codes() {
4989 let mut lb = loopback().await;
4990
4991 // Inbound: the peer asked, and the handle was dropped unanswered.
4992 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
4993 ps.write_all(&encode(subscribe(1))).await.expect("write SUBSCRIBE");
4994 let mut pr = framed(pr);
4995 let (_, stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
4996 .await
4997 .expect("accept hung")
4998 .expect("accept");
4999 drop(stream);
5000 let err = tokio::time::timeout(PATIENCE, pr.read_control(false))
5001 .await
5002 .expect("the inbound stream was neither reset nor answered")
5003 .expect_err("the dropped handle should have reset the stream");
5004 assert!(
5005 matches!(
5006 err,
5007 ConnectionError::Transport(TransportError::StreamReset(c))
5008 if c == REQUEST_UNANSWERED
5009 ),
5010 "an unserved inbound request should reset with INTERNAL_ERROR (0x0): {err}",
5011 );
5012
5013 // Outbound: this endpoint asked, and walked away.
5014 let outbound = lb.conn.subscribe(ns(), b"audio".to_vec(), vec![]).await.expect("subscribe");
5015 let (_, their_recv) = tokio::time::timeout(PATIENCE, lb.peer.accept_bi())
5016 .await
5017 .expect("the client opened no request stream")
5018 .expect("accept_bi");
5019 let mut their_recv = framed(their_recv);
5020 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::Subscribe(_)));
5021 drop(outbound);
5022 let err = tokio::time::timeout(PATIENCE, their_recv.read_control(false))
5023 .await
5024 .expect("the outbound stream was never reset")
5025 .expect_err("the dropped handle should have reset the stream");
5026 assert!(
5027 matches!(
5028 err,
5029 ConnectionError::Transport(TransportError::StreamReset(c))
5030 if c == REQUEST_CANCELLED
5031 ),
5032 "an abandoned outbound request should reset with CANCELLED (0x1): {err}",
5033 );
5034 }
5035
5036 /// A dropped accept future loses neither the stream nor the bytes of the
5037 /// request that had already arrived, which is what makes
5038 /// [`Connection::accept_request_stream`] safe to `select!` against anything
5039 /// else.
5040 #[tokio::test]
5041 async fn a_cancelled_accept_keeps_the_stream_and_what_had_arrived() {
5042 let mut lb = loopback().await;
5043
5044 let (mut ps, _pr) = lb.peer.open_bi().await.expect("open_bi");
5045 let bytes = encode(subscribe(1));
5046 // One byte: enough to open the stream and to be read as the start of a
5047 // message, not enough to complete one.
5048 ps.write_all(&bytes[..1]).await.expect("write the first byte");
5049
5050 assert!(
5051 tokio::time::timeout(QUIET, lb.conn.accept_request_stream()).await.is_err(),
5052 "a partial request must not complete an accept",
5053 );
5054 assert_eq!(
5055 lb.conn.pending_inbound_count(),
5056 1,
5057 "the cancelled accept dropped the peer's stream",
5058 );
5059
5060 ps.write_all(&bytes[1..]).await.expect("write the rest");
5061 let (msg, stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
5062 .await
5063 .expect("the retried accept hung")
5064 .expect("accept");
5065 // The Request ID could not be read at all if the first byte had gone
5066 // with the cancelled future: the message would not decode.
5067 assert_eq!(stream.request_id().into_inner(), 1);
5068 assert!(matches!(msg, ControlMessage::Subscribe(_)), "{msg:?}");
5069 assert_eq!(lb.conn.pending_inbound_count(), 0);
5070 }
5071
5072 /// The `respond_*` helpers answer requests the peer made, and refuse the
5073 /// ones this endpoint made. The consequence is that nothing is written:
5074 /// the peer sees the request and then silence, not a response to itself.
5075 #[tokio::test]
5076 async fn a_respond_helper_writes_nothing_on_a_stream_this_endpoint_opened() {
5077 let mut lb = loopback().await;
5078
5079 let mut outbound =
5080 lb.conn.subscribe(ns(), b"video".to_vec(), vec![]).await.expect("subscribe");
5081 let (_, their_recv) = tokio::time::timeout(PATIENCE, lb.peer.accept_bi())
5082 .await
5083 .expect("the client opened no request stream")
5084 .expect("accept_bi");
5085 let mut their_recv = framed(their_recv);
5086 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::Subscribe(_)));
5087
5088 let err = lb
5089 .conn
5090 .respond_error(&mut outbound, request_error())
5091 .await
5092 .expect_err("a request this endpoint made is not ours to answer");
5093 assert!(matches!(err, ConnectionError::RespondedToOwnRequest(0)), "{err}");
5094
5095 assert!(
5096 tokio::time::timeout(QUIET, their_recv.read_control(false)).await.is_err(),
5097 "the refused response reached the wire anyway",
5098 );
5099 }
5100
5101 /// A refused fetch update resets the stream the objects were going out on.
5102 ///
5103 /// Section 9.5.1: "When a REQUEST_UPDATE fails for a FETCH, the publisher
5104 /// MUST reset the FETCH data stream." The objects are not on the request
5105 /// stream, so refusing the update on that stream is only half of it; the
5106 /// data stream has to go too, and the connection can only reset a handle
5107 /// it still holds.
5108 #[tokio::test]
5109 async fn a_refused_fetch_update_resets_the_fetch_data_stream() {
5110 let mut lb = loopback().await;
5111
5112 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
5113 ps.write_all(&encode(peer_fetch(1))).await.expect("write FETCH");
5114 let mut pr = framed(pr);
5115
5116 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
5117 .await
5118 .expect("accept hung")
5119 .expect("accept");
5120 assert_eq!(stream.kind(), RequestKind::Fetch);
5121 lb.conn.respond_fetch_ok(&mut stream, fetch_ok()).await.expect("respond_fetch_ok");
5122 assert!(matches!(next_control(&mut pr).await, ControlMessage::FetchOk(_)));
5123
5124 // The objects go out on a stream of their own, which the request now
5125 // holds.
5126 lb.conn
5127 .open_fetch_stream_on(
5128 &mut stream,
5129 &AnyFetchHeader::Draft22(FetchHeader { request_id: v(1) }),
5130 )
5131 .await
5132 .expect("open the fetch data stream");
5133 let data = tokio::time::timeout(PATIENCE, lb.peer.accept_uni())
5134 .await
5135 .expect("no data stream arrived")
5136 .expect("accept_uni");
5137 let mut data = framed(data);
5138 tokio::time::timeout(PATIENCE, data.read_fetch_header())
5139 .await
5140 .expect("the header never arrived")
5141 .expect("the data stream opens with a FETCH_HEADER");
5142
5143 // The peer updates the fetch and this endpoint refuses it.
5144 ps.write_all(&encode(request_update(1))).await.expect("write REQUEST_UPDATE");
5145 tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut stream))
5146 .await
5147 .expect("read hung")
5148 .expect("read REQUEST_UPDATE");
5149 lb.conn.respond_error(&mut stream, request_error()).await.expect("refuse the update");
5150 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestError(_)));
5151
5152 // The data stream went with it: the peer's next read on it fails
5153 // rather than waiting for objects that are not coming.
5154 let err = tokio::time::timeout(PATIENCE, data.read_control(false))
5155 .await
5156 .expect("the peer is still waiting on a stream that should have been reset")
5157 .expect_err("the data stream should have been reset");
5158 assert!(
5159 format!("{err}").to_lowercase().contains("reset"),
5160 "the peer should see a reset, got {err}",
5161 );
5162 }
5163
5164 /// A publisher can open the stream a FETCH's objects go on, and owns it.
5165 ///
5166 /// The objects answering a FETCH go on a unidirectional stream of their
5167 /// own that opens with a FETCH_HEADER.
5168 #[tokio::test]
5169 async fn a_fetch_data_stream_can_be_opened_through_the_connection() {
5170 let lb = loopback().await;
5171
5172 let mut send = lb
5173 .conn
5174 .open_fetch_stream(&AnyFetchHeader::Draft22(FetchHeader { request_id: v(4) }))
5175 .await
5176 .expect("open a fetch data stream");
5177
5178 let recv = tokio::time::timeout(PATIENCE, lb.peer.accept_uni())
5179 .await
5180 .expect("the client opened no data stream")
5181 .expect("accept_uni");
5182 let mut recv = framed(recv);
5183 let header = tokio::time::timeout(PATIENCE, recv.read_fetch_header())
5184 .await
5185 .expect("the header never arrived")
5186 .expect("the stream opens with a FETCH_HEADER");
5187 assert!(
5188 matches!(&header, AnyFetchHeader::Draft22(h) if h.request_id.into_inner() == 4),
5189 "the header names the request it answers: {header:?}",
5190 );
5191
5192 // The caller holds the stream, which is what lets a request that fails
5193 // later reset the objects it was serving.
5194 send.reset(0).expect("reset the fetch data stream");
5195 }
5196
5197 /// Draft-22 Table 5 gives NAMESPACE the Stream value "Request", and
5198 /// Section 9.16 puts it "on the response stream of a SUBSCRIBE_NAMESPACE
5199 /// request". Draft-17 has no Stream column and treats NAMESPACE as a
5200 /// control-stream announcement, so this is the placement a port from
5201 /// draft-17 would get wrong — and it is checked by reading the peer's own
5202 /// half of the request stream, which a control-stream write could not
5203 /// reach.
5204 #[tokio::test]
5205 async fn a_namespace_is_announced_on_the_request_stream_that_asked_for_it() {
5206 let mut lb = loopback().await;
5207
5208 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
5209 ps.write_all(&encode(ControlMessage::SubscribeNamespace(SubscribeNamespace {
5210 request_id: v(1),
5211 namespace_prefix: ns(),
5212 parameters: vec![],
5213 })))
5214 .await
5215 .expect("write SUBSCRIBE_NAMESPACE");
5216 let mut pr = framed(pr);
5217
5218 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
5219 .await
5220 .expect("accept hung")
5221 .expect("accept");
5222 assert_eq!(stream.kind(), RequestKind::SubscribeNamespace);
5223
5224 lb.conn
5225 .respond_ok(&mut stream, RequestOk { parameters: vec![], track_properties: vec![] })
5226 .await
5227 .expect("respond_ok");
5228 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestOk(_)));
5229
5230 lb.conn
5231 .namespace_on(&mut stream, Namespace { namespace_suffix: ns() })
5232 .await
5233 .expect("namespace_on");
5234 assert!(matches!(next_control(&mut pr).await, ControlMessage::Namespace(_)));
5235
5236 lb.conn
5237 .namespace_done_on(&mut stream, NamespaceDone { namespace_suffix: ns() })
5238 .await
5239 .expect("namespace_done_on");
5240 assert!(matches!(next_control(&mut pr).await, ControlMessage::NamespaceDone(_)));
5241
5242 // Nothing further is owed on this direction, so the responder may
5243 // finish it — Section 6.4.2.2's guard covers the response and a
5244 // publisher's PUBLISH_DONE, not announcements that may never come.
5245 stream.finish().await.expect("finish an answered namespace subscription");
5246 }
5247
5248 /// An update on a PUBLISH this endpoint sent is answered here.
5249 ///
5250 /// Section 9.5 names the one case where a requester answers rather than
5251 /// asks: "A subscriber can also send REQUEST_UPDATE to modify parameters
5252 /// of a subscription established with PUBLISH." The receiver of that
5253 /// update "MUST respond with exactly one REQUEST_UPDATE_OK or
5254 /// REQUEST_UPDATE_ERROR message indicating if the update was successful" —
5255 /// a REQUEST_OK or a REQUEST_ERROR, under Section 1.5's names — and on a PUBLISH this
5256 /// endpoint sent, the receiver is this endpoint.
5257 #[tokio::test]
5258 async fn an_update_on_a_publish_we_sent_is_answered_here() {
5259 let mut lb = loopback().await;
5260
5261 let mut outbound =
5262 lb.conn.publish(ns(), b"video".to_vec(), v(7), vec![], vec![]).await.expect("publish");
5263 let (mut their_send, their_recv) = tokio::time::timeout(PATIENCE, lb.peer.accept_bi())
5264 .await
5265 .expect("the client opened no request stream")
5266 .expect("accept_bi");
5267 let mut their_recv = framed(their_recv);
5268 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::Publish(_)));
5269
5270 // The subscriber accepts the publication, then updates it.
5271 their_send
5272 .write_all(&encode(ControlMessage::RequestOk(RequestOk {
5273 parameters: vec![],
5274 track_properties: vec![],
5275 })))
5276 .await
5277 .expect("write REQUEST_OK");
5278 let msg = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut outbound))
5279 .await
5280 .expect("no REQUEST_OK arrived")
5281 .expect("read REQUEST_OK");
5282 assert!(matches!(msg, ControlMessage::RequestOk(_)), "{msg:?}");
5283
5284 their_send.write_all(&encode(request_update(0))).await.expect("write REQUEST_UPDATE");
5285 let msg = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut outbound))
5286 .await
5287 .expect("no REQUEST_UPDATE arrived")
5288 .expect("read REQUEST_UPDATE");
5289 assert!(matches!(msg, ControlMessage::RequestUpdate(_)), "{msg:?}");
5290
5291 lb.conn
5292 .respond_ok(&mut outbound, RequestOk { parameters: vec![], track_properties: vec![] })
5293 .await
5294 .expect("the subscriber's update is this endpoint's to answer");
5295 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::RequestOk(_)));
5296
5297 // The publication is untouched by the update and still owes its ending.
5298 assert!(outbound.owes_publish_done());
5299 lb.conn
5300 .publish_done(&mut outbound, v(0), v(0), Vec::new())
5301 .await
5302 .expect("an accepted update leaves the ending free");
5303 }
5304
5305 /// Refusing that update owes the same ending as refusing any other.
5306 ///
5307 /// Section 9.5.1: "When a REQUEST_UPDATE is unsuccessful, the publisher
5308 /// MUST also terminate the subscription by sending a PUBLISH_DONE with
5309 /// error code UPDATE_FAILED." The publisher of a subscription established
5310 /// with PUBLISH is the endpoint that sent it, and the ending goes on the
5311 /// stream that endpoint opened rather than on one the peer opened.
5312 #[tokio::test]
5313 async fn a_refused_update_on_a_publish_we_sent_owes_its_ending() {
5314 let mut lb = loopback().await;
5315
5316 let mut outbound =
5317 lb.conn.publish(ns(), b"video".to_vec(), v(7), vec![], vec![]).await.expect("publish");
5318 let (mut their_send, their_recv) = tokio::time::timeout(PATIENCE, lb.peer.accept_bi())
5319 .await
5320 .expect("the client opened no request stream")
5321 .expect("accept_bi");
5322 let mut their_recv = framed(their_recv);
5323 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::Publish(_)));
5324
5325 their_send
5326 .write_all(&encode(ControlMessage::RequestOk(RequestOk {
5327 parameters: vec![],
5328 track_properties: vec![],
5329 })))
5330 .await
5331 .expect("write REQUEST_OK");
5332 tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut outbound))
5333 .await
5334 .expect("no REQUEST_OK arrived")
5335 .expect("read REQUEST_OK");
5336
5337 their_send.write_all(&encode(request_update(0))).await.expect("write REQUEST_UPDATE");
5338 tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut outbound))
5339 .await
5340 .expect("no REQUEST_UPDATE arrived")
5341 .expect("read REQUEST_UPDATE");
5342
5343 lb.conn
5344 .respond_error(&mut outbound, request_error())
5345 .await
5346 .expect("refuse the subscriber's update");
5347 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::RequestError(_)));
5348 assert!(
5349 outbound.owes_publish_done(),
5350 "a refused update retires nothing: the subscription still owes a PUBLISH_DONE",
5351 );
5352
5353 // The ending is owed under one status, and asking for another leaves
5354 // the publication exactly where it was rather than half ended.
5355 let err = lb
5356 .conn
5357 .publish_done(&mut outbound, v(0), v(0), Vec::new())
5358 .await
5359 .expect_err("a refused update fixes the status of the ending");
5360 assert!(
5361 matches!(
5362 err,
5363 ConnectionError::Endpoint(EndpointError::WrongUpdateFailureStatus {
5364 request: 0,
5365 required: 0x8,
5366 })
5367 ),
5368 "{err}",
5369 );
5370 lb.conn
5371 .publish_done(&mut outbound, v(0x8), v(0), Vec::new())
5372 .await
5373 .expect("the termination the refusal owes");
5374 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::PublishDone(_)));
5375 }
5376
5377 /// Draft-22 Section 6.4.2.2 excludes the sender of a PUBLISH from the
5378 /// requesters that "MAY FIN immediately after sending a message", because
5379 /// an accepted PUBLISH makes it the publisher of an Established
5380 /// subscription. A **rejected** one establishes nothing, so the obligation
5381 /// has to end with the REQUEST_ERROR — otherwise the only way to close a
5382 /// refused publication would be to reset the stream, telling the peer the
5383 /// request was abandoned rather than answered.
5384 #[tokio::test]
5385 async fn a_refused_publish_can_still_be_finished_cleanly() {
5386 let mut lb = loopback().await;
5387
5388 let mut outbound =
5389 lb.conn.publish(ns(), b"video".to_vec(), v(7), vec![], vec![]).await.expect("publish");
5390 assert!(outbound.owes_publish_done(), "a PUBLISH sender owes a PUBLISH_DONE");
5391 let err = outbound.finish().await.err();
5392 assert!(
5393 matches!(err, Some(ConnectionError::FinBeforePublishDone(0))),
5394 "a PUBLISH may not be finished while its subscription could still be established: \
5395 {err:?}",
5396 );
5397
5398 let (mut their_send, their_recv) = tokio::time::timeout(PATIENCE, lb.peer.accept_bi())
5399 .await
5400 .expect("the client opened no request stream")
5401 .expect("accept_bi");
5402 let mut their_recv = framed(their_recv);
5403 assert!(matches!(next_control(&mut their_recv).await, ControlMessage::Publish(_)));
5404
5405 their_send
5406 .write_all(&encode(ControlMessage::RequestError(request_error())))
5407 .await
5408 .expect("write REQUEST_ERROR");
5409 let msg = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut outbound))
5410 .await
5411 .expect("no REQUEST_ERROR arrived")
5412 .expect("a refused PUBLISH is an ordinary response");
5413 assert!(matches!(msg, ControlMessage::RequestError(_)), "{msg:?}");
5414 assert!(!outbound.owes_publish_done());
5415
5416 outbound.finish().await.expect("a refused publication owes nothing further");
5417 drop(outbound);
5418 let end = their_recv.read_control(false).await.expect_err("the stream should have ended");
5419 assert!(
5420 matches!(end, ConnectionError::UnexpectedEnd),
5421 "a refused publication should end with a FIN, not {end}",
5422 );
5423 }
5424
5425 /// A peer that PUBLISHes to us is the publisher, so PUBLISH_DONE arrives
5426 /// on the stream it opened rather than being sent on it. Routing a
5427 /// peer-opened stream's reads through the response dispatcher would look
5428 /// up a request this endpoint never made.
5429 #[tokio::test]
5430 async fn a_peers_publish_is_ended_by_the_peer_on_its_own_stream() {
5431 let mut lb = loopback().await;
5432
5433 let (mut ps, pr) = lb.peer.open_bi().await.expect("open_bi");
5434 ps.write_all(&encode(ControlMessage::Publish(Publish {
5435 request_id: v(1),
5436 track_namespace: ns(),
5437 track_name: b"video".to_vec(),
5438 track_alias: v(7),
5439 parameters: vec![],
5440 track_properties: vec![],
5441 })))
5442 .await
5443 .expect("write PUBLISH");
5444 let mut pr = framed(pr);
5445
5446 let (_, mut stream) = tokio::time::timeout(PATIENCE, lb.conn.accept_request_stream())
5447 .await
5448 .expect("accept hung")
5449 .expect("accept");
5450 assert_eq!(stream.kind(), RequestKind::Publish);
5451
5452 lb.conn
5453 .respond_ok(&mut stream, RequestOk { parameters: vec![], track_properties: vec![] })
5454 .await
5455 .expect("respond_ok");
5456 assert!(matches!(next_control(&mut pr).await, ControlMessage::RequestOk(_)));
5457
5458 ps.write_all(&encode(ControlMessage::PublishDone(PublishDone {
5459 status_code: v(0),
5460 stream_count: v(0),
5461 reason_phrase: Vec::new(),
5462 })))
5463 .await
5464 .expect("write PUBLISH_DONE");
5465
5466 let msg = tokio::time::timeout(PATIENCE, lb.conn.recv_on_request_stream(&mut stream))
5467 .await
5468 .expect("no PUBLISH_DONE arrived")
5469 .expect("the publishing peer may end its own publication");
5470 assert!(matches!(msg, ControlMessage::PublishDone(_)), "{msg:?}");
5471 }
5472}