moonlit-pdk 0.1.0

SDK for writing Moonlit release-pipeline plugins as WebAssembly components.
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
//! Config binding with §5.4 string coercion. The engine sends config JSON in
//! which every scalar is a string (see engine `value_to_json`); typed fields
//! parse those strings in the fixed order bool -> i64 -> f64 -> datetime ->
//! String. `deserialize_any` (dynamic targets) applies the same order, with
//! datetime collapsing to a string (serde has no datetime type).

use serde::de::{self, Deserializer, IntoDeserializer, Visitor};
use serde::forward_to_deserialize_any;
use std::fmt;

/// A config binding failure (serde message, with a field path when serde
/// provides one).
#[derive(Debug)]
pub struct ConfigError(String);

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "config error: {}", self.0)
    }
}
impl std::error::Error for ConfigError {}
impl de::Error for ConfigError {
    fn custom<T: fmt::Display>(msg: T) -> Self {
        ConfigError(msg.to_string())
    }
}

/// Deserialize `T` from a json-value string (the ABI form).
pub fn from_json_value<T: de::DeserializeOwned>(json: &str) -> Result<T, ConfigError> {
    let value: serde_json::Value =
        serde_json::from_str(json).map_err(|e| ConfigError(e.to_string()))?;
    from_serde_value(value)
}

/// Deserialize `T` from an already-parsed `serde_json::Value`.
pub fn from_serde_value<T: de::DeserializeOwned>(
    value: serde_json::Value,
) -> Result<T, ConfigError> {
    T::deserialize(Coerce(value))
}

struct Coerce(serde_json::Value);

impl Coerce {
    fn parse_i64(&self) -> Result<i64, ConfigError> {
        match &self.0 {
            serde_json::Value::String(s) => s
                .trim()
                .parse::<i64>()
                .map_err(|_| ConfigError(format!("expected integer, got {s:?}"))),
            serde_json::Value::Number(n) => n
                .as_i64()
                .ok_or_else(|| ConfigError(format!("expected integer, got {n}"))),
            other => Err(ConfigError(format!("expected integer, got {other}"))),
        }
    }
    fn parse_u64(&self) -> Result<u64, ConfigError> {
        match &self.0 {
            serde_json::Value::String(s) => s
                .trim()
                .parse::<u64>()
                .map_err(|_| ConfigError(format!("expected unsigned integer, got {s:?}"))),
            serde_json::Value::Number(n) => n
                .as_u64()
                .ok_or_else(|| ConfigError(format!("expected unsigned integer, got {n}"))),
            other => Err(ConfigError(format!(
                "expected unsigned integer, got {other}"
            ))),
        }
    }
    fn parse_f64(&self) -> Result<f64, ConfigError> {
        match &self.0 {
            serde_json::Value::String(s) => s
                .trim()
                .parse::<f64>()
                .map_err(|_| ConfigError(format!("expected number, got {s:?}"))),
            serde_json::Value::Number(n) => n
                .as_f64()
                .ok_or_else(|| ConfigError(format!("expected number, got {n}"))),
            other => Err(ConfigError(format!("expected number, got {other}"))),
        }
    }
    fn parse_bool(&self) -> Result<bool, ConfigError> {
        match &self.0 {
            serde_json::Value::Bool(b) => Ok(*b),
            serde_json::Value::String(s) if s.eq_ignore_ascii_case("true") => Ok(true),
            serde_json::Value::String(s) if s.eq_ignore_ascii_case("false") => Ok(false),
            other => Err(ConfigError(format!("expected bool, got {other}"))),
        }
    }
}

impl<'de> Deserializer<'de> for Coerce {
    type Error = ConfigError;

    fn deserialize_bool<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_bool(self.parse_bool()?)
    }
    fn deserialize_i8<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_i64(self.parse_i64()?)
    }
    fn deserialize_i16<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_i64(self.parse_i64()?)
    }
    fn deserialize_i32<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_i64(self.parse_i64()?)
    }
    fn deserialize_i64<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_i64(self.parse_i64()?)
    }
    fn deserialize_u8<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_u64(self.parse_u64()?)
    }
    fn deserialize_u16<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_u64(self.parse_u64()?)
    }
    fn deserialize_u32<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_u64(self.parse_u64()?)
    }
    fn deserialize_u64<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_u64(self.parse_u64()?)
    }
    fn deserialize_f32<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_f64(self.parse_f64()?)
    }
    fn deserialize_f64<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_f64(self.parse_f64()?)
    }

    fn deserialize_str<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::String(s) => v.visit_string(s),
            other => Err(ConfigError(format!("expected string, got {other}"))),
        }
    }
    fn deserialize_string<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        self.deserialize_str(v)
    }

    fn deserialize_option<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::Null => v.visit_none(),
            other => v.visit_some(Coerce(other)),
        }
    }
    fn deserialize_unit<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::Null => v.visit_unit(),
            other => Err(ConfigError(format!("expected null, got {other}"))),
        }
    }
    fn deserialize_unit_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        v: V,
    ) -> Result<V::Value, Self::Error> {
        self.deserialize_unit(v)
    }
    fn deserialize_newtype_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        v: V,
    ) -> Result<V::Value, Self::Error> {
        v.visit_newtype_struct(self)
    }

    fn deserialize_seq<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::Array(items) => v.visit_seq(SeqAccess {
                iter: items.into_iter(),
            }),
            other => Err(ConfigError(format!("expected array, got {other}"))),
        }
    }
    fn deserialize_tuple<V: Visitor<'de>>(
        self,
        _len: usize,
        v: V,
    ) -> Result<V::Value, Self::Error> {
        self.deserialize_seq(v)
    }
    fn deserialize_tuple_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _len: usize,
        v: V,
    ) -> Result<V::Value, Self::Error> {
        self.deserialize_seq(v)
    }

    fn deserialize_map<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::Object(map) => v.visit_map(MapAccess {
                iter: map.into_iter(),
                value: None,
            }),
            other => Err(ConfigError(format!("expected object, got {other}"))),
        }
    }
    fn deserialize_struct<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _fields: &'static [&'static str],
        v: V,
    ) -> Result<V::Value, Self::Error> {
        self.deserialize_map(v)
    }

    fn deserialize_enum<V: Visitor<'de>>(
        self,
        _name: &'static str,
        _variants: &'static [&'static str],
        v: V,
    ) -> Result<V::Value, Self::Error> {
        match self.0 {
            // Unit variant encoded as a bare string.
            serde_json::Value::String(s) => v.visit_enum(s.into_deserializer()),
            // Newtype/struct/tuple variant encoded as a single-key object.
            serde_json::Value::Object(map) if map.len() == 1 => {
                let (tag, val) = map.into_iter().next().unwrap();
                v.visit_enum(EnumAccess { tag, value: val })
            }
            other => Err(ConfigError(format!("expected enum, got {other}"))),
        }
    }

    fn deserialize_ignored_any<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        v.visit_unit()
    }

    fn deserialize_any<V: Visitor<'de>>(self, v: V) -> Result<V::Value, Self::Error> {
        match self.0 {
            serde_json::Value::Null => v.visit_unit(),
            serde_json::Value::Bool(b) => v.visit_bool(b),
            serde_json::Value::Number(n) => {
                if let Some(i) = n.as_i64() {
                    v.visit_i64(i)
                } else if let Some(u) = n.as_u64() {
                    v.visit_u64(u)
                } else {
                    v.visit_f64(n.as_f64().unwrap())
                }
            }
            serde_json::Value::String(s) => {
                // §5.4 order: bool -> i64 -> f64 -> (datetime as string) -> String.
                if s.eq_ignore_ascii_case("true") {
                    return v.visit_bool(true);
                }
                if s.eq_ignore_ascii_case("false") {
                    return v.visit_bool(false);
                }
                if let Ok(i) = s.parse::<i64>() {
                    return v.visit_i64(i);
                }
                if let Ok(f) = s.parse::<f64>() {
                    return v.visit_f64(f);
                }
                v.visit_string(s)
            }
            serde_json::Value::Array(items) => v.visit_seq(SeqAccess {
                iter: items.into_iter(),
            }),
            serde_json::Value::Object(map) => v.visit_map(MapAccess {
                iter: map.into_iter(),
                value: None,
            }),
        }
    }

    forward_to_deserialize_any! { char bytes byte_buf identifier }
}

struct SeqAccess {
    iter: std::vec::IntoIter<serde_json::Value>,
}
impl<'de> de::SeqAccess<'de> for SeqAccess {
    type Error = ConfigError;
    fn next_element_seed<T: de::DeserializeSeed<'de>>(
        &mut self,
        seed: T,
    ) -> Result<Option<T::Value>, Self::Error> {
        match self.iter.next() {
            Some(v) => seed.deserialize(Coerce(v)).map(Some),
            None => Ok(None),
        }
    }
}

struct MapAccess {
    iter: serde_json::map::IntoIter,
    value: Option<serde_json::Value>,
}
impl<'de> de::MapAccess<'de> for MapAccess {
    type Error = ConfigError;
    fn next_key_seed<K: de::DeserializeSeed<'de>>(
        &mut self,
        seed: K,
    ) -> Result<Option<K::Value>, Self::Error> {
        match self.iter.next() {
            Some((k, v)) => {
                self.value = Some(v);
                // Keys are plain strings; feed them through a string deserializer.
                seed.deserialize(k.into_deserializer()).map(Some)
            }
            None => Ok(None),
        }
    }
    fn next_value_seed<V: de::DeserializeSeed<'de>>(
        &mut self,
        seed: V,
    ) -> Result<V::Value, Self::Error> {
        let v = self
            .value
            .take()
            .expect("next_value_seed after next_key_seed");
        seed.deserialize(Coerce(v))
    }
}

struct EnumAccess {
    tag: String,
    value: serde_json::Value,
}
impl<'de> de::EnumAccess<'de> for EnumAccess {
    type Error = ConfigError;
    type Variant = VariantAccess;
    fn variant_seed<V: de::DeserializeSeed<'de>>(
        self,
        seed: V,
    ) -> Result<(V::Value, Self::Variant), Self::Error> {
        let variant = seed.deserialize(self.tag.into_deserializer())?;
        Ok((variant, VariantAccess { value: self.value }))
    }
}

struct VariantAccess {
    value: serde_json::Value,
}
impl<'de> de::VariantAccess<'de> for VariantAccess {
    type Error = ConfigError;
    fn unit_variant(self) -> Result<(), Self::Error> {
        Ok(())
    }
    fn newtype_variant_seed<T: de::DeserializeSeed<'de>>(
        self,
        seed: T,
    ) -> Result<T::Value, Self::Error> {
        seed.deserialize(Coerce(self.value))
    }
    fn tuple_variant<V: Visitor<'de>>(self, _len: usize, v: V) -> Result<V::Value, Self::Error> {
        Coerce(self.value).deserialize_seq(v)
    }
    fn struct_variant<V: Visitor<'de>>(
        self,
        _fields: &'static [&'static str],
        v: V,
    ) -> Result<V::Value, Self::Error> {
        Coerce(self.value).deserialize_map(v)
    }
}

// `de::IntoDeserializer` for the string values above uses serde's built-in
// `StrDeserializer<ConfigError>`; the `Error` type unifies via our `de::Error`.

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

    #[derive(Deserialize, Default, PartialEq, Debug)]
    #[serde(rename_all = "camelCase", default)]
    struct Cfg {
        port: i64,
        enabled: bool,
        ratio: f64,
        label: String,
        retries: Option<u32>,
        tags: Vec<String>,
    }

    #[test]
    fn coerces_string_scalars_into_typed_fields() {
        // Engine sends every scalar as a JSON string.
        let json = r#"{"port":"5","enabled":"true","ratio":"1.5","label":"hi",
                       "retries":"3","tags":["a","b"]}"#;
        let cfg: Cfg = from_json_value(json).unwrap();
        assert_eq!(
            cfg,
            Cfg {
                port: 5,
                enabled: true,
                ratio: 1.5,
                label: "hi".into(),
                retries: Some(3),
                tags: vec!["a".into(), "b".into()],
            }
        );
    }

    #[test]
    fn case_insensitive_bool() {
        let json = r#"{"enabled":"FALSE"}"#;
        let cfg: Cfg = from_json_value(json).unwrap();
        assert!(!cfg.enabled);
    }

    #[test]
    fn null_becomes_none_and_defaults_apply() {
        let json = r#"{"retries":null}"#;
        let cfg: Cfg = from_json_value(json).unwrap();
        assert_eq!(cfg.retries, None);
        assert_eq!(cfg.port, 0); // serde default
    }

    #[test]
    fn native_json_scalars_also_accepted() {
        // Robustness: a bare JSON number/bool still binds.
        let json = r#"{"port":5,"enabled":true}"#;
        let cfg: Cfg = from_json_value(json).unwrap();
        assert_eq!(cfg.port, 5);
        assert!(cfg.enabled);
    }

    #[test]
    fn deserialize_any_applies_5_4_order() {
        // A dynamic target sees §5.4-typed scalars.
        let v: serde_json::Value = from_json_value(r#""42""#).unwrap();
        assert_eq!(v, serde_json::json!(42));
        let v: serde_json::Value = from_json_value(r#""true""#).unwrap();
        assert_eq!(v, serde_json::json!(true));
        let v: serde_json::Value = from_json_value(r#""3.5""#).unwrap();
        assert_eq!(v, serde_json::json!(3.5));
        let v: serde_json::Value = from_json_value(r#""hello""#).unwrap();
        assert_eq!(v, serde_json::json!("hello"));
    }

    #[test]
    fn datetime_string_field_passes_through_for_chrono() {
        #[derive(Deserialize)]
        struct D {
            when: chrono::DateTime<chrono::FixedOffset>,
        }
        let d: D = from_json_value(r#"{"when":"2020-01-02T03:04:05+00:00"}"#).unwrap();
        assert_eq!(d.when.to_rfc3339(), "2020-01-02T03:04:05+00:00");
    }

    #[test]
    fn bad_number_is_a_config_error_not_a_panic() {
        #[derive(Deserialize)]
        #[allow(dead_code)]
        struct D {
            n: i64,
        }
        match from_json_value::<D>(r#"{"n":"not-a-number"}"#) {
            Ok(_) => panic!("expected coercion error"),
            Err(e) => assert!(e.to_string().contains("n") || e.to_string().contains("integer")),
        }
    }
}