dekopon-shell 0.78.0

Sandboxed bash-flavored script interpreter whose commands dispatch to Dekopon capabilities
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
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
use crate::interp::telemetry::StageObservation;
use dekopon_process::pipe::{PipeReader, ReadOutcome};
use dekopon_process::{ExitCode, LimitExceeded, ThreadName};
use std::{
    io::{self, BufRead as _, Read as _, Write as _},
    process::{Command, Stdio},
    sync::mpsc::{RecvTimeoutError, sync_channel},
    time::Duration,
};

use clap::{Arg, ArgAction, Command as ClapCommand};
use jaq_core::{
    Compiler, Ctx, Exn, Vars, data,
    load::{Arena, File, Loader},
};
use jaq_json::{Num, Val};
use serde_json::Value;

use super::{CommandFailure, parse_flags};
use crate::{
    jq_worker::{JQ_WORKER_MARKER, WorkerChild, executable},
    limits::Budget,
};

const HOST_REACHING_FILTERS: &[&str] = &["env", "now"];

pub(crate) const HELP: &str = "-r -c -n -s --arg NAME VALUE";

pub(crate) fn valid_name(name: &str) -> bool {
    let mut chars = name.bytes();
    matches!(chars.next(), Some(b'a'..=b'z' | b'A'..=b'Z' | b'_'))
        && chars.all(|c| c.is_ascii_alphanumeric() || c == b'_')
}

pub(crate) struct Options {
    filter: String,
    bindings: Vec<(String, String)>,
    raw: bool,
    null_input: bool,
    slurp: bool,
}

fn request_header(
    opts: &mut Options,
    budget: &Budget,
) -> Result<(Vec<u8>, dekopon_process::RetainedBytes), CommandFailure> {
    let header = serde_json::to_vec(&(&opts.filter, opts.slurp, &opts.bindings))
        .map_err(|error| CommandFailure::failed(format!("jq: worker request: {error}")))?;
    let charge = budget.charge_value_bytes(header.len() as u64)?;
    drop(std::mem::take(&mut opts.bindings));
    drop(std::mem::take(&mut opts.filter));
    Ok((header, charge))
}

pub(crate) fn options(arguments: &[String]) -> Result<Options, CommandFailure> {
    let mut grammar = ClapCommand::new("jq");
    for (id, short, long) in [
        ("raw", 'r', "raw-output"),
        ("compact", 'c', "compact-output"),
        ("null", 'n', "null-input"),
        ("slurp", 's', "slurp"),
    ] {
        grammar = grammar.arg(
            Arg::new(id)
                .short(short)
                .long(long)
                .action(ArgAction::SetTrue),
        );
    }
    let matches = parse_flags(
        grammar
            .arg(
                Arg::new("arg")
                    .long("arg")
                    .num_args(2)
                    .allow_hyphen_values(true)
                    .action(ArgAction::Append),
            )
            .arg(Arg::new("filter").required(true)),
        arguments,
        "jq",
        HELP,
    )?;
    let mut bindings: Vec<(String, String)> = Vec::new();
    if let Some(values) = matches.get_many::<String>("arg") {
        for (name, value) in values.clone().zip(values.skip(1)).step_by(2) {
            if !valid_name(name) {
                return Err(CommandFailure::usage(format!(
                    "jq: invalid --arg name {name:?}"
                )));
            }
            bindings.retain(|(old, _)| old != name);
            bindings.push((name.clone(), value.clone()));
        }
    }
    Ok(Options {
        filter: matches
            .get_one::<String>("filter")
            .cloned()
            .unwrap_or_default(),
        bindings,
        raw: matches.get_flag("raw"),
        null_input: matches.get_flag("null"),
        slurp: matches.get_flag("slurp"),
    })
}

pub(crate) fn stream(
    opts: Options,
    reader: &mut PipeReader<StageObservation>,
    budget: &mut Budget,

    emit: &mut impl FnMut(&[u8]) -> Result<bool, CommandFailure>,
) -> Result<(), CommandFailure> {
    evaluate(opts, reader, budget, emit)
}

enum ReadOutput {
    Value(Value),
    Done,
    Exhausted,
    Invalid(String),
}

fn read_outputs(
    stdout: impl io::Read,
    maximum: u64,
    raw: bool,
    sender: &std::sync::mpsc::SyncSender<ReadOutput>,
) -> io::Result<()> {
    let mut stdout = io::BufReader::new(stdout);
    let frame_limit = if raw {
        maximum.saturating_mul(6).saturating_add(3)
    } else {
        maximum.saturating_add(1)
    };
    loop {
        let mut line = Vec::new();
        let count = stdout
            .by_ref()
            .take(frame_limit.saturating_add(1))
            .read_until(b'\n', &mut line)?;
        if count == 0 {
            break;
        }
        let item = if count as u64 > frame_limit {
            ReadOutput::Exhausted
        } else {
            match serde_json::from_slice(&line) {
                Ok(value) => ReadOutput::Value(value),
                Err(error) => ReadOutput::Invalid(format!("jq: invalid worker output: {error}")),
            }
        };
        let terminal = !matches!(item, ReadOutput::Value(_));
        if sender.send(item).is_err() || terminal {
            return Ok(());
        }
    }
    let _sent = sender.send(ReadOutput::Done);
    Ok(())
}

fn collect(
    receiver: &std::sync::mpsc::Receiver<ReadOutput>,
    budget: &mut Budget,

    raw: bool,
    emit: &mut impl FnMut(&[u8]) -> Result<bool, CommandFailure>,
) -> Result<bool, CommandFailure> {
    loop {
        let wait = budget
            .remaining()
            .min(Duration::from_secs(1))
            .max(Duration::from_millis(1));
        match receiver.recv_timeout(wait) {
            Ok(ReadOutput::Value(value)) => {
                budget.charge_step()?;
                let bytes = match (raw, value) {
                    (true, Value::String(text)) => text.into_bytes(),
                    (_, value) => serde_json::to_vec(&value).map_err(|error| {
                        CommandFailure::failed(format!("jq: invalid worker output: {error}"))
                    })?,
                };
                let _charge = budget.charge_value_bytes(bytes.len() as u64)?;
                if !emit(&bytes)? || !emit(b"\n")? {
                    return Ok(false);
                }
            }
            Ok(ReadOutput::Exhausted) => {
                return Err(LimitExceeded::ValueBytes {
                    maximum: budget.max_value_bytes(),
                }
                .into());
            }
            Ok(ReadOutput::Invalid(message)) => return Err(CommandFailure::failed(message)),
            Ok(ReadOutput::Done) => {
                if budget.tree().is_cancelled() {
                    return Err(LimitExceeded::Cancelled.into());
                }
                budget.check_deadline()?;
                return Ok(true);
            }
            Err(RecvTimeoutError::Disconnected) => {
                return Err(CommandFailure::failed("jq: worker output reader stopped"));
            }
            Err(RecvTimeoutError::Timeout) => {
                if budget.tree().is_cancelled() {
                    return Err(LimitExceeded::Cancelled.into());
                }
                budget.check_deadline()?;
            }
        }
    }
}

fn worker_status(status: std::process::ExitStatus, stderr: &str) -> CommandFailure {
    CommandFailure::Status {
        message: format!("jq: worker exited {status}: {stderr}"),
        status: if status.code() == Some(2) {
            ExitCode::SYNTAX
        } else {
            ExitCode::FAILURE
        },
    }
}

const STDERR_BYTES: u64 = 4096;

const WRITER_THREAD: ThreadName = ThreadName::new("jq-write");
const ERRORS_THREAD: ThreadName = ThreadName::new("jq-err");
const READER_THREAD: ThreadName = ThreadName::new("jq-read");

fn evaluate(
    mut opts: Options,
    input: &mut PipeReader<StageObservation>,
    budget: &mut Budget,

    emit: &mut impl FnMut(&[u8]) -> Result<bool, CommandFailure>,
) -> Result<(), CommandFailure> {
    let [writer_permit, errors_permit, reader_permit] = budget.tree().shell_threads().reserve()?;
    let (header, _header_charge) = request_header(&mut opts, budget)?;
    let path =
        executable().ok_or_else(|| CommandFailure::failed("jq: no worker executable supplied"))?;
    let child = Command::new(path)
        .env_clear()
        .env(JQ_WORKER_MARKER, "1")
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::piped())
        .spawn()
        .map_err(|error| CommandFailure::failed(format!("jq: could not start worker: {error}")))?;
    let mut child = WorkerChild(child);
    let stdin = child
        .0
        .stdin
        .take()
        .ok_or_else(|| CommandFailure::failed("jq: worker stdin missing"))?;
    let stdout = child
        .0
        .stdout
        .take()
        .ok_or_else(|| CommandFailure::failed("jq: worker stdout missing"))?;
    let stderr = child
        .0
        .stderr
        .take()
        .ok_or_else(|| CommandFailure::failed("jq: worker stderr missing"))?;
    #[expect(
        clippy::disallowed_methods,
        reason = "owner: evaluate, which joins the worker's writer, stderr and reader threads; bound: their three ShellThreads permits"
    )]
    std::thread::scope(|scope| {
        let mut input_budget = budget.fork();
        let writer = writer_permit
            .spawn(
                scope,
                WRITER_THREAD,
                move || -> Result<Vec<dekopon_process::RetainedBytes>, CommandFailure> {
                    let mut stdin = io::BufWriter::new(stdin);
                    stdin.write_all(&header).map_err(input_error)?;
                    stdin.write_all(b"\n").map_err(input_error)?;
                    if opts.null_input {
                        stdin.write_all(b"null\n").map_err(input_error)?;
                        stdin.flush().map_err(input_error)?;
                        return Ok(Vec::new());
                    }
                    if opts.slurp {
                        let mut values = Vec::new();
                        let mut charges = Vec::new();
                        let retention = input_budget.fork();
                        let mut source = PipeSource::new(input, &mut input_budget);
                        loop {
                            let item = serde_json::Deserializer::from_reader(&mut source)
                                .into_iter::<Value>()
                                .next();
                            let value = match item {
                                Some(Ok(value)) => value,
                                Some(Err(error)) => {
                                    if let Some(failure) = source.failure {
                                        return Err(failure.into());
                                    }
                                    return Err(CommandFailure::Status {
                                        message: format!("jq: invalid JSON input: {error}"),
                                        status: ExitCode::SYNTAX,
                                    });
                                }
                                None => break,
                            };
                            drop(source.charged.take());
                            charges.push(retention.charge_value_bytes(weigh(&value))?);
                            values.push(value);
                        }
                        if let Some(error) = source.failure {
                            return Err(error.into());
                        }
                        serde_json::to_writer(&mut stdin, &values).map_err(|error| {
                            CommandFailure::failed(format!("jq: worker input: {error}"))
                        })?;
                        stdin.write_all(b"\n").map_err(input_error)?;
                        stdin.flush().map_err(input_error)?;
                        return Ok(charges);
                    } else {
                        while let ReadOutcome::Bytes(chunk) = input.read(input_budget.tree())? {
                            stdin.write_all(&chunk).map_err(input_error)?;
                            stdin.flush().map_err(input_error)?;
                            input_budget.charge_step()?;
                        }
                    }
                    stdin.flush().map_err(input_error)?;
                    Ok(Vec::new())
                },
            )
            .map_err(unstarted)?;
        let errors = errors_permit
            .spawn(scope, ERRORS_THREAD, move || {
                let mut stderr = stderr;
                let mut excerpt = String::new();
                let _excerpt_result = stderr
                    .by_ref()
                    .take(STDERR_BYTES)
                    .read_to_string(&mut excerpt);
                let _drain_result = io::copy(&mut stderr, &mut io::sink());
                excerpt
            })
            .map_err(unstarted)?;
        let (sender, receiver) = sync_channel(0);
        let maximum = budget.max_value_bytes();
        let reader = reader_permit
            .spawn(scope, READER_THREAD, move || {
                if let Err(error) = read_outputs(stdout, maximum, opts.raw, &sender) {
                    let _sent = sender.send(ReadOutput::Invalid(format!(
                        "jq: could not read worker output: {error}"
                    )));
                }
            })
            .map_err(unstarted)?;
        let result = collect(&receiver, budget, opts.raw, emit);
        drop(receiver);
        if !matches!(result, Ok(true)) {
            drop(child);
            let _reader_result = reader.join();
            let _writer_result = writer.join();
            let _stderr_result = errors.join();
            return result.map(|_| ());
        }
        let status = child.0.wait();
        drop(child);
        let read = reader.join();
        let written = writer.join();
        let stderr = errors.join().unwrap_or_default();
        let status = status.map_err(|error| {
            CommandFailure::failed(format!("jq: could not wait for worker: {error}"))
        })?;
        if !status.success() {
            return Err(worker_status(status, &stderr));
        }
        if read.is_err() {
            return Err(CommandFailure::failed("jq: worker output reader panicked"));
        }
        let _charges = match written {
            Ok(Ok(charges)) => charges,
            Ok(Err(error)) => return Err(error),
            Err(_) => return Err(CommandFailure::failed("jq: worker input writer panicked")),
        };
        result.map(|_| ())
    })
}

fn unstarted(error: io::Error) -> CommandFailure {
    CommandFailure::failed(format!("jq: could not start a worker thread: {error}"))
}

fn input_error(error: io::Error) -> CommandFailure {
    CommandFailure::failed(format!("jq: could not send worker input: {error}"))
}

struct PipeSource<'a> {
    reader: &'a mut PipeReader<StageObservation>,
    budget: &'a mut Budget,

    pending: Vec<u8>,
    offset: usize,
    failure: Option<LimitExceeded>,
    charged: Option<dekopon_process::RetainedBytes>,
}

impl<'a> PipeSource<'a> {
    fn new(reader: &'a mut PipeReader<StageObservation>, budget: &'a mut Budget) -> Self {
        Self {
            reader,
            budget,

            pending: Vec::new(),
            offset: 0,
            failure: None,
            charged: None,
        }
    }
}

impl io::Read for PipeSource<'_> {
    fn read(&mut self, target: &mut [u8]) -> io::Result<usize> {
        if target.is_empty() {
            return Ok(0);
        }
        if self.offset == self.pending.len() {
            match self.reader.read(self.budget.tree()) {
                Ok(ReadOutcome::Bytes(bytes)) => {
                    if let Err(error) = self.budget.charge_step() {
                        self.failure = Some(error);
                        return Err(io::Error::other("jq: input interrupted"));
                    }
                    self.pending = bytes;
                    self.offset = 0;
                }
                Ok(ReadOutcome::End) => return Ok(0),
                Err(error) => {
                    self.failure = Some(error);
                    return Err(io::Error::other("jq: input interrupted"));
                }
            }
        }
        let len = target.len().min(self.pending.len() - self.offset);
        let charge = match self.charged.as_mut() {
            Some(charge) => charge.grow(len as u64),
            None => self.budget.charge_value_bytes(len as u64).map(|charge| {
                self.charged = Some(charge);
            }),
        };
        if let Err(error) = charge {
            self.failure = Some(error);
            return Err(io::Error::other("jq: input exceeds retained-byte budget"));
        }
        target[..len].copy_from_slice(&self.pending[self.offset..self.offset + len]);
        self.offset += len;
        Ok(len)
    }
}

pub(crate) enum WorkerFailure {
    InvalidInput(String),
    Failed(String),
}

impl std::fmt::Display for WorkerFailure {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::InvalidInput(message) | Self::Failed(message) => f.write_str(message),
        }
    }
}

pub(crate) fn run_filter(
    filter: &str,
    bindings: &[(String, String)],
    inputs: impl Iterator<Item = Result<Val, serde_json::Error>>,
    output: &mut impl io::Write,
) -> Result<(), WorkerFailure> {
    let definitions = jaq_core::defs()
        .chain(jaq_std::defs())
        .chain(jaq_json::defs());
    let functions = jaq_core::funs()
        .chain(jaq_std::funs().filter(|(name, ..)| !HOST_REACHING_FILTERS.contains(name)))
        .chain(jaq_json::funs());

    let loader = Loader::new(definitions);
    let arena = Arena::default();
    let modules = loader
        .load(
            &arena,
            File {
                code: filter,
                path: (),
            },
        )
        .map_err(|errors| {
            WorkerFailure::Failed(format!(
                "jq: invalid filter: {}",
                describe_load_errors(&errors)
            ))
        })?;
    let names: Vec<_> = bindings
        .iter()
        .map(|(name, _)| format!("${name}"))
        .collect();
    let compiled = Compiler::default()
        .with_funs(functions)
        .with_global_vars(names.iter().map(String::as_str))
        .compile(modules)
        .map_err(|errors| {
            WorkerFailure::Failed(format!(
                "jq: invalid filter: {}",
                describe_compile_errors(&errors)
            ))
        })?;

    for input in inputs {
        let input = input.map_err(|error| {
            WorkerFailure::InvalidInput(format!("jq: invalid JSON input: {error}"))
        })?;
        let context = Ctx::<data::JustLut<Val>>::new(
            &compiled.lut,
            Vars::new(bindings.iter().map(|(_, value)| Val::from(value.clone()))),
        );
        for result in compiled.id.run((context, input)) {
            let produced = result
                .map_err(describe_exception)
                .map_err(WorkerFailure::Failed)?;
            let value = convert(&produced, 0).map_err(WorkerFailure::Failed)?;
            serde_json::to_writer(&mut *output, &value).map_err(|error| {
                WorkerFailure::Failed(format!("jq: could not write output: {error}"))
            })?;
            output.write_all(b"\n").map_err(|error| {
                WorkerFailure::Failed(format!("jq: could not write output: {error}"))
            })?;
            output.flush().map_err(|error| {
                WorkerFailure::Failed(format!("jq: could not flush output: {error}"))
            })?;
        }
    }
    Ok(())
}

fn describe_exception(exception: Exn<'_, Val>) -> String {
    match exception.get_err() {
        Ok(error) => format!("jq: {error}"),
        Err(exception) => match exception.get_halt() {
            Ok(code) => format!("jq: halt({code}) is not supported"),
            Err(_) => "jq: internal control flow escaped the filter".to_owned(),
        },
    }
}

const MAX_OUTPUT_DEPTH: usize = 128;

fn convert(value: &Val, depth: usize) -> Result<Value, String> {
    if depth > MAX_OUTPUT_DEPTH {
        return Err(format!(
            "jq: a filter produced a value nested deeper than {MAX_OUTPUT_DEPTH} levels"
        ));
    }
    match value {
        Val::Null => Ok(Value::Null),
        Val::Bool(flag) => Ok(Value::Bool(*flag)),
        Val::Num(number) => convert_number(number),
        Val::TStr(text) => Ok(Value::String(String::from_utf8_lossy(text).into_owned())),
        Val::BStr(_) => Err(not_json("a byte string")),
        Val::Arr(items) => items
            .iter()
            .map(|item| convert(item, depth + 1))
            .collect::<Result<Vec<_>, _>>()
            .map(Value::Array),
        Val::Obj(fields) => {
            let mut object = serde_json::Map::new();
            for (key, field) in fields.iter() {
                let Val::TStr(key) = key else {
                    return Err(not_json("an object with a non-string key"));
                };
                object.insert(
                    String::from_utf8_lossy(key).into_owned(),
                    convert(field, depth + 1)?,
                );
            }
            Ok(Value::Object(object))
        }
    }
}

fn convert_number(number: &Num) -> Result<Value, String> {
    match number {
        Num::Int(int) => i64::try_from(*int)
            .map(|int| Value::Number(int.into()))
            .or_else(|_| convert_written_number(number)),
        Num::Float(float) => serde_json::Number::from_f64(*float)
            .map(Value::Number)
            .ok_or_else(|| not_json(&number.to_string())),
        Num::BigInt(_) | Num::Dec(_) => convert_written_number(number),
    }
}

fn convert_written_number(number: &Num) -> Result<Value, String> {
    let written = number.to_string();
    serde_json::from_str::<Value>(&written)
        .ok()
        .filter(Value::is_number)
        .ok_or_else(|| not_json(&written))
}

fn not_json(what: &str) -> String {
    format!("jq: a filter produced {what}, which has no JSON form")
}

fn weigh(value: &Value) -> u64 {
    struct Meter(u64);

    impl io::Write for Meter {
        fn write(&mut self, bytes: &[u8]) -> io::Result<usize> {
            self.0 = self.0.saturating_add(bytes.len() as u64);
            Ok(bytes.len())
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    let mut meter = Meter(0);
    #[allow(
        clippy::let_underscore_must_use,
        reason = "Meter::write and flush both return Ok, and serde_json only fails here on a \
                  writer error, so there is no failure to propagate and no counter to correct"
    )]
    let _ = serde_json::to_writer(&mut meter, value);
    meter.0
}

fn describe_load_errors<P>(errors: &[(File<&str, P>, jaq_core::load::Error<&str>)]) -> String {
    errors
        .iter()
        .map(|(_, error)| match error {
            jaq_core::load::Error::Io(entries) => entries
                .iter()
                .map(|(name, message)| format!("{name}: {message}"))
                .collect::<Vec<_>>()
                .join("; "),
            // `Expect::as_str` panics for non-standard delimiters, so lex errors are described
            // structurally instead. An untrusted filter must never be able to abort the process.
            jaq_core::load::Error::Lex(entries) => entries
                .iter()
                .map(|(expected, found)| format!("expected {expected:?} near {found:?}"))
                .collect::<Vec<_>>()
                .join("; "),
            jaq_core::load::Error::Parse(entries) => entries
                .iter()
                .map(|(expected, found)| format!("expected {} near {found:?}", expected.as_str()))
                .collect::<Vec<_>>()
                .join("; "),
        })
        .collect::<Vec<_>>()
        .join("; ")
}

type CompileErrors<'a, P> = (File<&'a str, P>, Vec<jaq_core::compile::Error<&'a str>>);

fn describe_compile_errors<P>(errors: &[CompileErrors<'_, P>]) -> String {
    errors
        .iter()
        .flat_map(|(_, entries)| entries.iter())
        .map(|(symbol, undefined)| format!("undefined {} {symbol:?}", undefined.as_str()))
        .collect::<Vec<_>>()
        .join("; ")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn request_header_releases_binding_copies_and_orders_last_appearances() {
        let mut opts = options(
            &[
                "--arg", "s", "first", "--arg", "t", "two", "--arg", "s", "last", "$s",
            ]
            .map(str::to_owned),
        )
        .expect("valid bindings");
        let expected = serde_json::to_vec(&("$s", false, [("t", "two"), ("s", "last")]))
            .expect("expected header");
        let binding_bytes: usize = opts
            .bindings
            .iter()
            .map(|(name, value)| name.len() + value.len())
            .sum();
        let limit = expected.len() + 1;
        assert!(binding_bytes > 1);
        assert!(expected.len() + binding_bytes > limit);
        let budget = Budget::start(dekopon_process::Limits {
            max_value_bytes: limit as u64,
            ..dekopon_process::Limits::default()
        });
        let (header, charge) =
            request_header(&mut opts, &budget).expect("one retained header fits");
        assert_eq!(header, expected);
        assert!(
            opts.bindings.is_empty(),
            "bindings must not coexist with the charged header"
        );
        assert_eq!(budget.value_bytes(), header.len() as u64);
        drop(charge);
        assert_eq!(budget.value_bytes(), 0);
    }

    #[test]
    fn slurp_refuses_an_oversized_document_before_finishing_its_parse() {
        let mut input = PipeReader::from_bytes(
            format!("\"{}\"", "x".repeat(100_000)).into_bytes(),
            None,
            crate::interp::telemetry::stage_read,
        );
        let mut budget = Budget::start(dekopon_process::Limits {
            max_value_bytes: 64,
            ..dekopon_process::Limits::default()
        });
        let mut source = PipeSource::new(&mut input, &mut budget);
        let parsed = serde_json::from_reader::<_, Value>(&mut source);
        assert!(parsed.is_err());
        assert!(matches!(
            source.failure,
            Some(LimitExceeded::ValueBytes { maximum: 64 })
        ));
        assert!(
            source.offset <= 64,
            "parser consumed {} bytes",
            source.offset
        );
        drop(source);
        assert_eq!(budget.value_bytes(), 0);
    }

    #[test]
    fn emitted_output_releases_its_charge() {
        let (sender, receiver) = sync_channel(2);
        sender
            .send(ReadOutput::Value(Value::from("retained")))
            .unwrap();
        sender.send(ReadOutput::Done).unwrap();
        let mut budget = Budget::start(dekopon_process::Limits::default());
        let mut output = Vec::new();
        collect(&receiver, &mut budget, false, &mut |bytes| {
            output.extend_from_slice(bytes);
            Ok(true)
        })
        .expect("collect output");
        assert_eq!(output, b"\"retained\"\n");
        assert_eq!(budget.value_bytes(), 0);
    }
}