dekopon-shell 0.28.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
use std::{
    io::{self, Read as _, Write as _},
    process::{Command, Stdio},
    sync::mpsc::{RecvTimeoutError, sync_channel},
    time::Duration,
};

use jaq_core::{
    Compiler, Ctx, Exn, Vars, data,
    load::{Arena, File, Loader},
};
use jaq_json::{Num, Val};
use serde_json::Value;

use super::{Builtin, BuiltinContext, CommandFailure, CommandResult, unsupported_flag};
use crate::{
    CapabilityInvoker,
    jq_worker::{JQ_WORKER_MARKER, WorkerChild, executable},
    limits::{Budget, LimitExceeded},
};

/// env reads the host process environment and now reads the host wall clock; neither is reachable
/// any other way in this crate, so both are excluded from the filter set.
const HOST_REACHING_FILTERS: &[&str] = &["env", "now"];

const HELP: &str = "-r -c";

pub(crate) struct Jq;

impl Builtin for Jq {
    fn name(&self) -> &'static str {
        "jq"
    }

    fn help(&self) -> &'static str {
        HELP
    }

    fn run(
        &self,
        context: &mut BuiltinContext<'_>,
        arguments: &[String],
        input: Option<Value>,
    ) -> Result<CommandResult, CommandFailure> {
        let mut filter = None;
        for argument in arguments {
            match argument.as_str() {
                "-r" | "--raw-output" | "-c" | "--compact-output" => {}
                flag if flag.starts_with('-') && flag.len() > 1 => {
                    return Err(unsupported_flag("jq", flag, HELP));
                }
                _ => {
                    if filter.is_some() {
                        return Err(CommandFailure::usage(
                            "jq: exactly one filter argument is supported",
                        ));
                    }
                    filter = Some(argument.clone());
                }
            }
        }
        let Some(filter) = filter else {
            return Err(CommandFailure::usage("jq: a filter argument is required"));
        };

        evaluate(
            &filter,
            parse_string_input(input),
            context.budget,
            context.invoker,
        )
        .map(CommandResult::value)
    }
}

/// `echo "$r"` stringifies a captured value's structure into display text; parsing that text
/// back into an object or array here makes filtering it match filtering the original value. A
/// scalar stays a string: this crate parses without `arbitrary_precision`, so a decimal-seconds
/// timestamp like `1727400000.123450` would come back a rounded `f64`, and a filter built for a
/// string (`test("^[0-9]+$")`) would see a number instead.
fn parse_string_input(input: Option<Value>) -> Value {
    match input {
        Some(Value::String(text)) => match serde_json::from_str(&text) {
            Ok(parsed @ (Value::Object(_) | Value::Array(_))) => parsed,
            _ => Value::String(text),
        },
        Some(other) => other,
        None => Value::Null,
    }
}

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

fn read_outputs(
    stdout: impl io::Read,
    maximum: u64,
    sender: &std::sync::mpsc::SyncSender<ReadOutput>,
) -> io::Result<()> {
    let mut limited = io::BufReader::new(stdout).take(maximum);
    let mut stream = serde_json::Deserializer::from_reader(&mut limited).into_iter::<Value>();
    let mut failure = None;
    for item in &mut stream {
        match item {
            Ok(value) => {
                if sender.send(ReadOutput::Value(value)).is_err() {
                    return Ok(());
                }
            }
            Err(error) => {
                failure = Some(error);
                break;
            }
        }
    }
    drop(stream);
    if let Some(error) = failure {
        let output = if limited.limit() == 0 {
            ReadOutput::Exhausted
        } else {
            ReadOutput::Invalid(format!("jq: invalid worker output: {error}"))
        };
        let _sent = sender.send(output);
        return Ok(());
    }
    if limited.limit() == 0 {
        let mut extra = [0];
        if limited.get_mut().read(&mut extra)? != 0 {
            let _sent = sender.send(ReadOutput::Exhausted);
            return Ok(());
        }
    }
    let _sent = sender.send(ReadOutput::Done);
    Ok(())
}

fn collect(
    receiver: &std::sync::mpsc::Receiver<ReadOutput>,
    budget: &mut Budget,
    invoker: &dyn CapabilityInvoker,
) -> Result<Vec<Value>, CommandFailure> {
    let mut outputs = Vec::new();
    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_with(invoker)?;
                budget.charge_value_bytes(weigh(&value))?;
                outputs.push(value);
            }
            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 invoker.cancelled() {
                    return Err(LimitExceeded::Cancelled.into());
                }
                budget.check_deadline()?;
                return Ok(outputs);
            }
            Err(RecvTimeoutError::Disconnected) => {
                return Err(CommandFailure::failed("jq: worker output reader stopped"));
            }
            Err(RecvTimeoutError::Timeout) => {
                if invoker.cancelled() {
                    return Err(LimitExceeded::Cancelled.into());
                }
                budget.check_deadline()?;
            }
        }
    }
}

fn worker_status(status: std::process::ExitStatus, stderr: &str) -> CommandFailure {
    CommandFailure::failed(format!("jq: worker exited {status}: {stderr}"))
}

const STDERR_BYTES: u64 = 4096;

fn evaluate(
    filter: &str,
    input: Value,
    budget: &mut Budget,
    invoker: &dyn CapabilityInvoker,
) -> Result<Value, CommandFailure> {
    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"))?;
    std::thread::scope(|scope| {
        let writer = scope.spawn(move || -> io::Result<()> {
            let mut stdin = io::BufWriter::new(stdin);
            serde_json::to_writer(&mut stdin, &(filter, input))?;
            stdin.flush()
        });
        let errors = scope.spawn(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
        });
        let (sender, receiver) = sync_channel(0);
        let maximum = budget
            .max_value_bytes()
            .saturating_sub(budget.value_bytes());
        let reader = scope.spawn(move || {
            if let Err(error) = read_outputs(stdout, maximum, &sender) {
                let _sent = sender.send(ReadOutput::Invalid(format!(
                    "jq: could not read worker output: {error}"
                )));
            }
        });
        let result = collect(&receiver, budget, invoker);
        drop(receiver);
        if result.is_err() {
            drop(child);
            let _reader_result = reader.join();
            let _writer_result = writer.join();
            let _stderr_result = errors.join();
            return result.map(reduce);
        }
        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"));
        }
        if let Ok(Err(error)) = written {
            return Err(CommandFailure::failed(format!(
                "jq: could not send worker input: {error}"
            )));
        }
        result.map(reduce)
    })
}

fn reduce(outputs: Vec<Value>) -> Value {
    match outputs.len() {
        0 => Value::Null,
        1 => outputs.into_iter().next().unwrap_or(Value::Null),
        _ => Value::Array(outputs),
    }
}

pub(crate) fn run_filter(
    filter: &str,
    input: Val,
    output: &mut impl io::Write,
) -> Result<(), String> {
    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| format!("jq: invalid filter: {}", describe_load_errors(&errors)))?;
    let compiled = Compiler::default()
        .with_funs(functions)
        .compile(modules)
        .map_err(|errors| format!("jq: invalid filter: {}", describe_compile_errors(&errors)))?;

    let context = Ctx::<data::JustLut<Val>>::new(&compiled.lut, Vars::new([]));
    for result in compiled.id.run((context, input)) {
        let produced = result.map_err(describe_exception)?;
        let value = convert(&produced, 0)?;
        serde_json::to_writer(&mut *output, &value)
            .map_err(|error| format!("jq: could not write output: {error}"))?;
        output
            .write_all(b"\n")
            .map_err(|error| format!("jq: could not write output: {error}"))?;
    }
    Ok(())
}

/// jaq_core::unwrap_valr calls process::exit on halt; the worker must report the halt as a failure.
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(),
        },
    }
}

/// Matches serde_json's own nesting ceiling; without it a filter like
/// `reduce range(100000) as $i (.;[.])` recurses once per level in convert and can abort the
/// worker before reporting a jq failure.
const MAX_OUTPUT_DEPTH: usize = 128;

/// jaq's value type is a JSON superset (byte strings, non-string keys, NaN) that its own writer
/// says cannot round-trip through JSON text, so this refuses them rather than inventing a meaning.
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("; ")
}