rustferry-remote 0.1.0

Versioned remote-build contracts and provider interfaces for RustFerry
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
//! Length-framed binary transport for large worker source and artifact payloads.

use std::io::{Read, Write};

use thiserror::Error;

use crate::{MAX_SOURCE_BUNDLE_DESCRIPTOR_BYTES, protocol::MAX_EVENT_LINE_BYTES};

/// Current schema for binary worker data-plane frame headers.
pub const WORKER_DATA_PLANE_SCHEMA_VERSION: u16 = 1;
/// Exact encoded size of one binary worker data-plane frame header.
pub const WORKER_DATA_PLANE_HEADER_BYTES: usize = 24;
/// Maximum build-request JSON size.
pub const MAX_WORKER_DATA_PLANE_REQUEST_BYTES: u64 = 1024 * 1024;
/// Maximum cancellation or acknowledgement JSON size.
pub const MAX_WORKER_DATA_PLANE_CONTROL_BYTES: u64 = 64 * 1024;
/// Maximum terminal result JSON size.
pub const MAX_WORKER_DATA_PLANE_RESULT_BYTES: u64 = MAX_SOURCE_BUNDLE_DESCRIPTOR_BYTES;
/// Maximum snapshot ZIP accepted from a client.
pub const MAX_WORKER_DATA_PLANE_SOURCE_BYTES: u64 = 640 * 1024 * 1024;
/// Maximum sealed physical-iPhone artifact returned by a worker.
pub const MAX_WORKER_DATA_PLANE_ARTIFACT_BYTES: u64 = 2 * 1024 * 1024 * 1024;

const WORKER_DATA_PLANE_MAGIC: [u8; 4] = *b"RFDP";

/// Typed frame carried by the full-duplex worker data plane.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u16)]
pub enum WorkerDataPlaneFrameKind {
    /// Declarative [`crate::IosDeviceBuildRequest`] JSON.
    BuildRequest = 1,
    /// Strict [`crate::SourceBundleDescriptor`] JSON.
    SourceDescriptor = 2,
    /// Raw deterministic source ZIP bytes.
    SourceArchive = 3,
    /// In-band cancellation request JSON.
    Cancel = 4,
    /// Worker job acknowledgement JSON.
    JobAccepted = 5,
    /// One [`crate::RemoteBuildEvent`] JSON object.
    Event = 6,
    /// Strict artifact descriptor or manifest JSON.
    ArtifactDescriptor = 7,
    /// Raw artifact bytes bound by the preceding descriptor.
    Artifact = 8,
    /// Terminal build and cleanup result JSON.
    Complete = 9,
    /// Stable secret-free error JSON.
    Error = 10,
    /// Client proof that the offered artifact was verified and published.
    ArtifactReceipt = 11,
}

impl WorkerDataPlaneFrameKind {
    /// Maximum payload bytes accepted for this frame kind.
    #[must_use]
    pub const fn maximum_payload_bytes(self) -> u64 {
        match self {
            Self::BuildRequest => MAX_WORKER_DATA_PLANE_REQUEST_BYTES,
            Self::SourceDescriptor | Self::ArtifactDescriptor => MAX_SOURCE_BUNDLE_DESCRIPTOR_BYTES,
            Self::SourceArchive => MAX_WORKER_DATA_PLANE_SOURCE_BYTES,
            Self::Cancel | Self::JobAccepted | Self::Error | Self::ArtifactReceipt => {
                MAX_WORKER_DATA_PLANE_CONTROL_BYTES
            }
            Self::Event => MAX_EVENT_LINE_BYTES as u64,
            Self::Artifact => MAX_WORKER_DATA_PLANE_ARTIFACT_BYTES,
            Self::Complete => MAX_WORKER_DATA_PLANE_RESULT_BYTES,
        }
    }

    fn from_wire(value: u16) -> Result<Self, WorkerDataPlaneFrameError> {
        match value {
            1 => Ok(Self::BuildRequest),
            2 => Ok(Self::SourceDescriptor),
            3 => Ok(Self::SourceArchive),
            4 => Ok(Self::Cancel),
            5 => Ok(Self::JobAccepted),
            6 => Ok(Self::Event),
            7 => Ok(Self::ArtifactDescriptor),
            8 => Ok(Self::Artifact),
            9 => Ok(Self::Complete),
            10 => Ok(Self::Error),
            11 => Ok(Self::ArtifactReceipt),
            _ => Err(WorkerDataPlaneFrameError::UnknownFrameKind),
        }
    }
}

/// Validated header for one length-framed worker payload.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct WorkerDataPlaneFrameHeader {
    kind: WorkerDataPlaneFrameKind,
    sequence: u64,
    payload_bytes: u64,
}

/// Per-direction monotonic frame-sequence validator.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct WorkerDataPlaneSequence {
    next: Option<u64>,
}

impl WorkerDataPlaneSequence {
    /// Start a stream at sequence zero.
    #[must_use]
    pub const fn new() -> Self {
        Self { next: Some(0) }
    }

    /// Accept exactly the next header in this direction.
    ///
    /// # Errors
    ///
    /// Rejects gaps, duplicates, replay, and frames after sequence exhaustion.
    pub fn accept(
        &mut self,
        header: WorkerDataPlaneFrameHeader,
    ) -> Result<(), WorkerDataPlaneFrameError> {
        let Some(expected) = self.next else {
            return Err(WorkerDataPlaneFrameError::SequenceExhausted);
        };
        if header.sequence != expected {
            return Err(WorkerDataPlaneFrameError::UnexpectedSequence {
                expected,
                received: header.sequence,
            });
        }
        self.next = expected.checked_add(1);
        Ok(())
    }
}

impl Default for WorkerDataPlaneSequence {
    fn default() -> Self {
        Self::new()
    }
}

impl WorkerDataPlaneFrameHeader {
    /// Construct one bounded frame header.
    ///
    /// # Errors
    ///
    /// Rejects payload sizes above the fixed limit for `kind`.
    pub fn new(
        kind: WorkerDataPlaneFrameKind,
        sequence: u64,
        payload_bytes: u64,
    ) -> Result<Self, WorkerDataPlaneFrameError> {
        let maximum = kind.maximum_payload_bytes();
        if payload_bytes > maximum {
            return Err(WorkerDataPlaneFrameError::PayloadTooLarge {
                kind,
                payload_bytes,
                maximum,
            });
        }
        Ok(Self {
            kind,
            sequence,
            payload_bytes,
        })
    }

    /// Typed payload interpretation.
    #[must_use]
    pub const fn kind(self) -> WorkerDataPlaneFrameKind {
        self.kind
    }

    /// Monotonic sequence within one stream direction.
    #[must_use]
    pub const fn sequence(self) -> u64 {
        self.sequence
    }

    /// Exact following payload size.
    #[must_use]
    pub const fn payload_bytes(self) -> u64 {
        self.payload_bytes
    }
}

/// Stable binary-frame parsing or serialization failure.
#[derive(Clone, Copy, Debug, Eq, Error, PartialEq)]
pub enum WorkerDataPlaneFrameError {
    /// Reading or writing the stream failed.
    #[error("worker data-plane I/O failed")]
    Io,
    /// No frame header was supplied.
    #[error("worker data-plane stream is empty")]
    EmptyInput,
    /// Input ended inside a frame header.
    #[error("worker data-plane frame header is truncated")]
    TruncatedHeader,
    /// Header magic does not identify the `RustFerry` data plane.
    #[error("worker data-plane frame magic is invalid")]
    InvalidMagic,
    /// Header schema is not supported.
    #[error("worker data-plane frame schema is unsupported")]
    UnsupportedSchemaVersion {
        /// Supported header schema.
        supported: u16,
        /// Received header schema.
        received: u16,
    },
    /// Frame kind has no defined v1 meaning.
    #[error("worker data-plane frame kind is unknown")]
    UnknownFrameKind,
    /// Declared payload exceeds the fixed bound for its kind.
    #[error("worker data-plane frame payload exceeds its limit")]
    PayloadTooLarge {
        /// Frame interpretation.
        kind: WorkerDataPlaneFrameKind,
        /// Declared payload size.
        payload_bytes: u64,
        /// Maximum accepted size.
        maximum: u64,
    },
    /// Input ended before the declared payload length.
    #[error("worker data-plane frame payload is truncated")]
    TruncatedPayload,
    /// A small payload cannot be represented in local address space.
    #[error("worker data-plane frame payload cannot be represented")]
    PayloadSizeUnsupported,
    /// A raw source or artifact payload must be copied into a bounded sink.
    #[error("worker data-plane raw payload requires streaming")]
    StreamingRequired {
        /// Raw frame interpretation.
        kind: WorkerDataPlaneFrameKind,
    },
    /// A frame was replayed, skipped, or reordered within its direction.
    #[error("worker data-plane frame sequence is invalid")]
    UnexpectedSequence {
        /// Exact next sequence required.
        expected: u64,
        /// Sequence received from the peer.
        received: u64,
    },
    /// No frame may follow sequence `u64::MAX`.
    #[error("worker data-plane frame sequence is exhausted")]
    SequenceExhausted,
}

/// Encode one validated header without buffering its payload.
///
/// # Errors
///
/// Returns a stable I/O error if the complete header cannot be written.
pub fn write_worker_data_plane_header(
    writer: &mut impl Write,
    header: WorkerDataPlaneFrameHeader,
) -> Result<(), WorkerDataPlaneFrameError> {
    let mut encoded = [0_u8; WORKER_DATA_PLANE_HEADER_BYTES];
    encoded[..4].copy_from_slice(&WORKER_DATA_PLANE_MAGIC);
    encoded[4..6].copy_from_slice(&WORKER_DATA_PLANE_SCHEMA_VERSION.to_be_bytes());
    encoded[6..8].copy_from_slice(&(header.kind as u16).to_be_bytes());
    encoded[8..16].copy_from_slice(&header.sequence.to_be_bytes());
    encoded[16..24].copy_from_slice(&header.payload_bytes.to_be_bytes());
    writer
        .write_all(&encoded)
        .map_err(|_| WorkerDataPlaneFrameError::Io)
}

/// Decode and validate one fixed-size frame header without reading its payload.
///
/// # Errors
///
/// Distinguishes empty input, truncation, schema/kind mismatch, and an
/// over-limit declaration before payload allocation or I/O.
pub fn read_worker_data_plane_header(
    reader: &mut impl Read,
) -> Result<WorkerDataPlaneFrameHeader, WorkerDataPlaneFrameError> {
    let mut encoded = [0_u8; WORKER_DATA_PLANE_HEADER_BYTES];
    read_header_exact(reader, &mut encoded)?;
    if encoded[..4] != WORKER_DATA_PLANE_MAGIC {
        return Err(WorkerDataPlaneFrameError::InvalidMagic);
    }
    let schema_version = u16::from_be_bytes([encoded[4], encoded[5]]);
    if schema_version != WORKER_DATA_PLANE_SCHEMA_VERSION {
        return Err(WorkerDataPlaneFrameError::UnsupportedSchemaVersion {
            supported: WORKER_DATA_PLANE_SCHEMA_VERSION,
            received: schema_version,
        });
    }
    let kind = WorkerDataPlaneFrameKind::from_wire(u16::from_be_bytes([encoded[6], encoded[7]]))?;
    let sequence = u64::from_be_bytes([
        encoded[8],
        encoded[9],
        encoded[10],
        encoded[11],
        encoded[12],
        encoded[13],
        encoded[14],
        encoded[15],
    ]);
    let payload_bytes = u64::from_be_bytes([
        encoded[16],
        encoded[17],
        encoded[18],
        encoded[19],
        encoded[20],
        encoded[21],
        encoded[22],
        encoded[23],
    ]);
    WorkerDataPlaneFrameHeader::new(kind, sequence, payload_bytes)
}

/// Write one bounded in-memory frame.
///
/// # Errors
///
/// Rejects an oversized payload before writing and returns a stable I/O error
/// if the header or complete payload cannot be written.
pub fn write_worker_data_plane_frame(
    writer: &mut impl Write,
    kind: WorkerDataPlaneFrameKind,
    sequence: u64,
    payload: &[u8],
) -> Result<(), WorkerDataPlaneFrameError> {
    let payload_bytes = u64::try_from(payload.len())
        .map_err(|_| WorkerDataPlaneFrameError::PayloadSizeUnsupported)?;
    let header = WorkerDataPlaneFrameHeader::new(kind, sequence, payload_bytes)?;
    write_worker_data_plane_header(writer, header)?;
    writer
        .write_all(payload)
        .map_err(|_| WorkerDataPlaneFrameError::Io)
}

/// Write one header followed by an exact-length streamed payload.
///
/// The caller must separately bind raw payload bytes to a trusted descriptor
/// and verify its digest. This function guarantees framing and constant memory.
///
/// # Errors
///
/// Rejects an over-limit declaration, a short source, or an I/O failure.
pub fn write_worker_data_plane_stream(
    writer: &mut impl Write,
    kind: WorkerDataPlaneFrameKind,
    sequence: u64,
    reader: &mut impl Read,
    payload_bytes: u64,
) -> Result<u64, WorkerDataPlaneFrameError> {
    let header = WorkerDataPlaneFrameHeader::new(kind, sequence, payload_bytes)?;
    write_worker_data_plane_header(writer, header)?;
    copy_worker_data_plane_payload(reader, writer, header)
}

/// Read one bounded in-memory payload after its validated header.
///
/// Raw source and artifact frames should instead use
/// [`copy_worker_data_plane_payload`] to avoid allocating their declared size.
///
/// # Errors
///
/// Rejects sizes unavailable in local address space and distinguishes a short
/// payload from another I/O failure.
pub fn read_worker_data_plane_payload(
    reader: &mut impl Read,
    header: WorkerDataPlaneFrameHeader,
) -> Result<Vec<u8>, WorkerDataPlaneFrameError> {
    if matches!(
        header.kind,
        WorkerDataPlaneFrameKind::SourceArchive | WorkerDataPlaneFrameKind::Artifact
    ) {
        return Err(WorkerDataPlaneFrameError::StreamingRequired { kind: header.kind });
    }
    let length = usize::try_from(header.payload_bytes)
        .map_err(|_| WorkerDataPlaneFrameError::PayloadSizeUnsupported)?;
    let mut payload = vec![0_u8; length];
    read_payload_exact(reader, &mut payload)?;
    Ok(payload)
}

/// Stream exactly one validated payload into a sink with constant memory.
///
/// # Errors
///
/// Returns [`WorkerDataPlaneFrameError::TruncatedPayload`] if input ends before
/// the declared length, or a stable I/O error if reading or writing otherwise
/// fails.
pub fn copy_worker_data_plane_payload(
    reader: &mut impl Read,
    writer: &mut impl Write,
    header: WorkerDataPlaneFrameHeader,
) -> Result<u64, WorkerDataPlaneFrameError> {
    let mut remaining = header.payload_bytes;
    let mut copied = 0_u64;
    let mut buffer = [0_u8; 16 * 1024];
    while remaining != 0 {
        let chunk = usize::try_from(remaining.min(buffer.len() as u64))
            .map_err(|_| WorkerDataPlaneFrameError::PayloadSizeUnsupported)?;
        let count = reader
            .read(&mut buffer[..chunk])
            .map_err(|_| WorkerDataPlaneFrameError::Io)?;
        if count == 0 {
            return Err(WorkerDataPlaneFrameError::TruncatedPayload);
        }
        writer
            .write_all(&buffer[..count])
            .map_err(|_| WorkerDataPlaneFrameError::Io)?;
        let count = count as u64;
        remaining -= count;
        copied += count;
    }
    Ok(copied)
}

fn read_header_exact(
    reader: &mut impl Read,
    output: &mut [u8],
) -> Result<(), WorkerDataPlaneFrameError> {
    let mut offset = 0;
    while offset < output.len() {
        let count = reader
            .read(&mut output[offset..])
            .map_err(|_| WorkerDataPlaneFrameError::Io)?;
        if count == 0 {
            return Err(if offset == 0 {
                WorkerDataPlaneFrameError::EmptyInput
            } else {
                WorkerDataPlaneFrameError::TruncatedHeader
            });
        }
        offset += count;
    }
    Ok(())
}

fn read_payload_exact(
    reader: &mut impl Read,
    output: &mut [u8],
) -> Result<(), WorkerDataPlaneFrameError> {
    let mut offset = 0;
    while offset < output.len() {
        let count = reader
            .read(&mut output[offset..])
            .map_err(|_| WorkerDataPlaneFrameError::Io)?;
        if count == 0 {
            return Err(WorkerDataPlaneFrameError::TruncatedPayload);
        }
        offset += count;
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use std::io::Cursor;

    use super::*;

    #[test]
    fn concatenated_frames_round_trip_without_consuming_each_other() {
        let mut bytes = Vec::new();
        write_worker_data_plane_frame(
            &mut bytes,
            WorkerDataPlaneFrameKind::BuildRequest,
            0,
            br#"{"request":"one"}"#,
        )
        .expect("request frame");
        write_worker_data_plane_frame(
            &mut bytes,
            WorkerDataPlaneFrameKind::Cancel,
            1,
            br#"{"reason":"user_requested"}"#,
        )
        .expect("cancel frame");

        let mut input = Cursor::new(bytes);
        let first = read_worker_data_plane_header(&mut input).expect("first header");
        assert_eq!(first.kind(), WorkerDataPlaneFrameKind::BuildRequest);
        assert_eq!(first.sequence(), 0);
        assert_eq!(
            read_worker_data_plane_payload(&mut input, first).expect("first payload"),
            br#"{"request":"one"}"#
        );
        let second = read_worker_data_plane_header(&mut input).expect("second header");
        assert_eq!(second.kind(), WorkerDataPlaneFrameKind::Cancel);
        assert_eq!(second.sequence(), 1);
        assert_eq!(
            read_worker_data_plane_payload(&mut input, second).expect("second payload"),
            br#"{"reason":"user_requested"}"#
        );
        assert_eq!(
            read_worker_data_plane_header(&mut input),
            Err(WorkerDataPlaneFrameError::EmptyInput)
        );
    }

    #[test]
    fn malformed_headers_are_rejected_before_payload_reads() {
        let valid = encoded_header(WorkerDataPlaneFrameKind::Event, 7, 0);
        let mut wrong_magic = valid;
        wrong_magic[0] = b'X';
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(wrong_magic)),
            Err(WorkerDataPlaneFrameError::InvalidMagic)
        );

        let mut wrong_schema = valid;
        wrong_schema[4..6].copy_from_slice(&2_u16.to_be_bytes());
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(wrong_schema)),
            Err(WorkerDataPlaneFrameError::UnsupportedSchemaVersion {
                supported: WORKER_DATA_PLANE_SCHEMA_VERSION,
                received: 2,
            })
        );

        let mut unknown_kind = valid;
        unknown_kind[6..8].copy_from_slice(&u16::MAX.to_be_bytes());
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(unknown_kind)),
            Err(WorkerDataPlaneFrameError::UnknownFrameKind)
        );
    }

    #[test]
    fn empty_truncated_header_and_payload_are_distinct() {
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(Vec::<u8>::new())),
            Err(WorkerDataPlaneFrameError::EmptyInput)
        );
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(vec![0_u8; 12])),
            Err(WorkerDataPlaneFrameError::TruncatedHeader)
        );

        let header = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::Event, 0, 4)
            .expect("bounded header");
        assert_eq!(
            read_worker_data_plane_payload(&mut Cursor::new(b"abc"), header),
            Err(WorkerDataPlaneFrameError::TruncatedPayload)
        );
    }

    #[test]
    fn oversized_declaration_is_rejected_from_header_alone() {
        let encoded = encoded_header(
            WorkerDataPlaneFrameKind::SourceArchive,
            0,
            MAX_WORKER_DATA_PLANE_SOURCE_BYTES + 1,
        );
        assert_eq!(
            read_worker_data_plane_header(&mut Cursor::new(encoded)),
            Err(WorkerDataPlaneFrameError::PayloadTooLarge {
                kind: WorkerDataPlaneFrameKind::SourceArchive,
                payload_bytes: MAX_WORKER_DATA_PLANE_SOURCE_BYTES + 1,
                maximum: MAX_WORKER_DATA_PLANE_SOURCE_BYTES,
            })
        );
    }

    #[test]
    fn raw_payload_copy_is_exact_and_constant_memory() {
        let payload = vec![0x5a; 3 * 64 * 1024 + 17];
        let header = WorkerDataPlaneFrameHeader::new(
            WorkerDataPlaneFrameKind::SourceArchive,
            2,
            payload.len() as u64,
        )
        .expect("bounded source frame");
        let mut output = Vec::new();
        assert_eq!(
            copy_worker_data_plane_payload(&mut Cursor::new(&payload), &mut output, header)
                .expect("streamed payload"),
            payload.len() as u64
        );
        assert_eq!(output, payload);
    }

    #[test]
    fn raw_payload_copy_reports_truncation() {
        let header = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::Artifact, 4, 4)
            .expect("bounded artifact frame");
        assert_eq!(
            copy_worker_data_plane_payload(&mut Cursor::new(b"abc"), &mut Vec::new(), header),
            Err(WorkerDataPlaneFrameError::TruncatedPayload)
        );
    }

    #[test]
    fn raw_payload_cannot_enter_the_in_memory_reader() {
        for kind in [
            WorkerDataPlaneFrameKind::SourceArchive,
            WorkerDataPlaneFrameKind::Artifact,
        ] {
            let header = WorkerDataPlaneFrameHeader::new(kind, 0, 1).expect("bounded raw frame");
            assert_eq!(
                read_worker_data_plane_payload(&mut Cursor::new([0_u8]), header),
                Err(WorkerDataPlaneFrameError::StreamingRequired { kind })
            );
        }
    }

    #[test]
    fn sequence_rejects_gap_replay_and_exhaustion() {
        let mut sequence = WorkerDataPlaneSequence::new();
        let first = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::BuildRequest, 0, 0)
            .expect("first header");
        sequence.accept(first).expect("first sequence");
        let gap = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::Cancel, 2, 0)
            .expect("gap header");
        assert_eq!(
            sequence.accept(gap),
            Err(WorkerDataPlaneFrameError::UnexpectedSequence {
                expected: 1,
                received: 2,
            })
        );
        let replay = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::Cancel, 0, 0)
            .expect("replay header");
        assert_eq!(
            sequence.accept(replay),
            Err(WorkerDataPlaneFrameError::UnexpectedSequence {
                expected: 1,
                received: 0,
            })
        );

        let mut exhausted = WorkerDataPlaneSequence {
            next: Some(u64::MAX),
        };
        let last = WorkerDataPlaneFrameHeader::new(WorkerDataPlaneFrameKind::Complete, u64::MAX, 0)
            .expect("last header");
        exhausted.accept(last).expect("last sequence");
        assert_eq!(
            exhausted.accept(last),
            Err(WorkerDataPlaneFrameError::SequenceExhausted)
        );
    }

    #[test]
    fn streamed_frame_writes_exact_payload_without_buffering_it() {
        let payload = vec![0x3c; 2 * 64 * 1024 + 9];
        let mut encoded = Vec::new();
        assert_eq!(
            write_worker_data_plane_stream(
                &mut encoded,
                WorkerDataPlaneFrameKind::Artifact,
                8,
                &mut Cursor::new(&payload),
                payload.len() as u64,
            )
            .expect("streamed frame"),
            payload.len() as u64
        );
        let mut input = Cursor::new(encoded);
        let header = read_worker_data_plane_header(&mut input).expect("stream header");
        assert_eq!(header.kind(), WorkerDataPlaneFrameKind::Artifact);
        assert_eq!(header.sequence(), 8);
        let mut output = Vec::new();
        copy_worker_data_plane_payload(&mut input, &mut output, header).expect("stream payload");
        assert_eq!(output, payload);
    }

    fn encoded_header(
        kind: WorkerDataPlaneFrameKind,
        sequence: u64,
        payload_bytes: u64,
    ) -> [u8; WORKER_DATA_PLANE_HEADER_BYTES] {
        let mut bytes = Vec::new();
        let header = WorkerDataPlaneFrameHeader {
            kind,
            sequence,
            payload_bytes,
        };
        write_worker_data_plane_header(&mut bytes, header).expect("encoded header");
        bytes.try_into().expect("fixed header size")
    }
}