tycho-util 0.3.7

Shared utilities for node 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
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
use std::borrow::Cow;
use std::marker::PhantomData;
use std::path::Path;
use std::str::FromStr;

use anyhow::Result;
use base64::prelude::{BASE64_STANDARD, Engine as _};
use bytes::Bytes;
use serde::de::{Error, Expected, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};

pub fn load_json_from_file<T, P>(path: P) -> Result<T>
where
    for<'de> T: Deserialize<'de>,
    P: AsRef<Path>,
{
    let data = std::fs::read_to_string(path)?;
    let de = &mut serde_json::Deserializer::from_str(&data);
    serde_path_to_error::deserialize(de).map_err(Into::into)
}

pub fn save_json_to_file<T, P>(value: T, path: P) -> Result<()>
where
    T: Serialize,
    P: AsRef<Path>,
{
    let data = serde_json::to_string_pretty(&value)?;
    std::fs::write(path, data)?;
    Ok(())
}

pub mod socket_addr {
    use std::net::SocketAddr;

    use super::*;

    pub fn serialize<S: Serializer>(value: &SocketAddr, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            serializer.collect_str(value)
        } else {
            value.serialize(serializer)
        }
    }

    pub fn deserialize<'de, D: Deserializer<'de>>(deserializer: D) -> Result<SocketAddr, D::Error> {
        if deserializer.is_human_readable() {
            deserializer.deserialize_str(StrVisitor::new())
        } else {
            SocketAddr::deserialize(deserializer)
        }
    }
}

pub mod humantime {
    use std::time::{Duration, SystemTime};

    use super::*;

    pub fn serialize<T, S: Serializer>(value: &T, serializer: S) -> Result<S::Ok, S::Error>
    where
        for<'a> Serde<&'a T>: Serialize,
    {
        Serde::from(value).serialize(serializer)
    }

    pub fn deserialize<'a, T, D: Deserializer<'a>>(deserializer: D) -> Result<T, D::Error>
    where
        Serde<T>: Deserialize<'a>,
    {
        Serde::deserialize(deserializer).map(Serde::into_inner)
    }

    pub struct Serde<T>(T);

    impl<T> Serde<T> {
        #[inline]
        pub fn into_inner(self) -> T {
            self.0
        }
    }

    impl<T> From<T> for Serde<T> {
        fn from(value: T) -> Serde<T> {
            Serde(value)
        }
    }

    impl<'de> Deserialize<'de> for Serde<Duration> {
        fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Serde<Duration>, D::Error> {
            struct V;

            impl Visitor<'_> for V {
                type Value = Duration;

                fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                    f.write_str("a duration")
                }

                fn visit_str<E: Error>(self, v: &str) -> Result<Duration, E> {
                    ::humantime::parse_duration(v)
                        .map_err(|_e| E::invalid_value(serde::de::Unexpected::Str(v), &self))
                }
            }

            d.deserialize_str(V).map(Serde)
        }
    }

    impl<'de> Deserialize<'de> for Serde<SystemTime> {
        fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Serde<SystemTime>, D::Error> {
            struct V;

            impl Visitor<'_> for V {
                type Value = SystemTime;

                fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                    f.write_str("a timestamp")
                }

                fn visit_str<E: Error>(self, v: &str) -> Result<SystemTime, E> {
                    ::humantime::parse_rfc3339_weak(v)
                        .map_err(|_e| E::invalid_value(serde::de::Unexpected::Str(v), &self))
                }
            }

            d.deserialize_str(V).map(Serde)
        }
    }

    impl<'de> Deserialize<'de> for Serde<Option<Duration>> {
        fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Serde<Option<Duration>>, D::Error> {
            match Option::<Serde<Duration>>::deserialize(d)? {
                Some(Serde(v)) => Ok(Serde(Some(v))),
                None => Ok(Serde(None)),
            }
        }
    }

    impl<'de> Deserialize<'de> for Serde<Option<SystemTime>> {
        fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Serde<Option<SystemTime>>, D::Error> {
            match Option::<Serde<SystemTime>>::deserialize(d)? {
                Some(Serde(v)) => Ok(Serde(Some(v))),
                None => Ok(Serde(None)),
            }
        }
    }

    impl Serialize for Serde<&Duration> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            serializer.collect_str(&::humantime::format_duration(*self.0))
        }
    }

    impl Serialize for Serde<Duration> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            serializer.collect_str(&::humantime::format_duration(self.0))
        }
    }

    impl Serialize for Serde<&SystemTime> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            serializer.collect_str(&::humantime::format_rfc3339(*self.0))
        }
    }

    impl Serialize for Serde<SystemTime> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            ::humantime::format_rfc3339(self.0)
                .to_string()
                .serialize(serializer)
        }
    }

    impl Serialize for Serde<&Option<Duration>> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            match *self.0 {
                Some(v) => serializer.serialize_some(&Serde(v)),
                None => serializer.serialize_none(),
            }
        }
    }

    impl Serialize for Serde<Option<Duration>> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            Serde(&self.0).serialize(serializer)
        }
    }

    impl Serialize for Serde<&Option<SystemTime>> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            match *self.0 {
                Some(v) => serializer.serialize_some(&Serde(v)),
                None => serializer.serialize_none(),
            }
        }
    }

    impl Serialize for Serde<Option<SystemTime>> {
        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
            Serde(&self.0).serialize(serializer)
        }
    }
}

pub struct Base64BytesWithLimit<const LIMIT: usize>;

impl<const LIMIT: usize> Base64BytesWithLimit<LIMIT> {
    pub fn serialize<S>(value: &[u8], serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        if serializer.is_human_readable() {
            let base64 = BASE64_STANDARD.encode(value);
            serializer.serialize_str(&base64)
        } else {
            serializer.serialize_bytes(value)
        }
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Bytes, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        struct BytesVisitorWithLimit<const LIMIT: usize>;

        impl<'de, const LIMIT: usize> Visitor<'de> for BytesVisitorWithLimit<LIMIT> {
            type Value = Bytes;

            fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                formatter.write_str("byte array")
            }

            #[inline]
            fn visit_seq<V>(self, mut seq: V) -> Result<Self::Value, V::Error>
            where
                V: serde::de::SeqAccess<'de>,
            {
                'valid: {
                    let hint = seq.size_hint().unwrap_or(0);
                    if hint > LIMIT {
                        break 'valid;
                    }

                    let len = std::cmp::min(hint, 4096);
                    let mut values: Vec<u8> = Vec::with_capacity(len);

                    while let Some(value) = seq.next_element()? {
                        if values.len() > LIMIT {
                            break 'valid;
                        }

                        values.push(value);
                    }

                    return Ok(Bytes::from(values));
                }

                Err(Error::custom("slice is too big"))
            }

            #[inline]
            fn visit_bytes<E: Error>(self, v: &[u8]) -> Result<Self::Value, E> {
                if v.len() > LIMIT {
                    return Err(Error::custom("slice is too big"));
                }
                Ok(Bytes::copy_from_slice(v))
            }

            #[inline]
            fn visit_byte_buf<E: Error>(self, v: Vec<u8>) -> Result<Self::Value, E> {
                if v.len() > LIMIT {
                    return Err(Error::custom("slice is too big"));
                }
                Ok(Bytes::from(v))
            }
        }

        if deserializer.is_human_readable() {
            let BorrowedStr(s) = <_>::deserialize(deserializer)?;
            if base64::decoded_len_estimate(s.len()) >= LIMIT {
                return Err(Error::custom("slice is too big"));
            }

            let v = BASE64_STANDARD
                .decode(s.as_ref())
                .map_err(|_e| D::Error::custom("invalid base64"))?;

            Ok(Bytes::from(v))
        } else {
            deserializer.deserialize_bytes(BytesVisitorWithLimit::<LIMIT>)
        }
    }
}

pub mod string {
    use super::*;

    pub fn serialize<S>(value: &dyn std::fmt::Display, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.collect_str(value)
    }

    pub fn deserialize<'de, D, T>(deserializer: D) -> Result<T, D::Error>
    where
        D: serde::Deserializer<'de>,
        T: FromStr,
        T::Err: std::fmt::Display,
    {
        BorrowedStr::deserialize(deserializer)
            .and_then(|data| T::from_str(&data.0).map_err(D::Error::custom))
    }
}

pub mod option_string {
    use super::*;

    pub fn serialize<S, T>(value: &Option<T>, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
        T: std::fmt::Display,
    {
        #[derive(Serialize)]
        #[serde(transparent)]
        #[repr(transparent)]
        struct Helper<'a, T: std::fmt::Display>(#[serde(with = "string")] &'a T);

        value.as_ref().map(Helper).serialize(serializer)
    }

    pub fn deserialize<'de, D, T>(deserializer: D) -> Result<Option<T>, D::Error>
    where
        D: serde::Deserializer<'de>,
        T: FromStr,
        T::Err: std::fmt::Display,
    {
        #[derive(Deserialize)]
        #[serde(transparent)]
        #[repr(transparent)]
        struct Helper<T>(#[serde(with = "string")] T)
        where
            T: FromStr,
            T::Err: std::fmt::Display;

        Option::<Helper<T>>::deserialize(deserializer).map(|x| x.map(|Helper(x)| x))
    }
}

pub mod signature {
    use base64::engine::Engine as _;
    use base64::prelude::BASE64_STANDARD;

    use super::*;

    pub fn serialize<S>(data: &[u8; 64], serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        if serializer.is_human_readable() {
            serializer.serialize_str(&BASE64_STANDARD.encode(data))
        } else {
            data.serialize(serializer)
        }
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Box<[u8; 64]>, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::Error;

        if deserializer.is_human_readable() {
            <BorrowedStr<'_> as Deserialize>::deserialize(deserializer).and_then(
                |BorrowedStr(s)| {
                    let mut buffer = [0u8; 66];
                    match BASE64_STANDARD.decode_slice(s.as_ref(), &mut buffer) {
                        Ok(64) => {
                            let [data @ .., _, _] = buffer;
                            Ok(Box::new(data))
                        }
                        _ => Err(Error::custom("Invalid signature")),
                    }
                },
            )
        } else {
            deserializer
                .deserialize_bytes(BytesVisitor::<64>)
                .map(Box::new)
        }
    }
}

#[derive(Deserialize)]
#[repr(transparent)]
pub struct BorrowedStr<'a>(#[serde(borrow)] pub Cow<'a, str>);

pub struct StrVisitor<S>(PhantomData<S>);

impl<S> StrVisitor<S> {
    pub const fn new() -> Self {
        Self(PhantomData)
    }
}

impl<S> Default for StrVisitor<S> {
    fn default() -> Self {
        Self::new()
    }
}

impl<S: FromStr> Visitor<'_> for StrVisitor<S>
where
    <S as FromStr>::Err: std::fmt::Display,
{
    type Value = S;

    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "a string")
    }

    fn visit_str<E: Error>(self, value: &str) -> Result<Self::Value, E> {
        value.parse::<Self::Value>().map_err(Error::custom)
    }
}

pub struct BytesVisitor<const M: usize>;

impl<'de, const M: usize> Visitor<'de> for BytesVisitor<M> {
    type Value = [u8; M];

    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_fmt(format_args!("a byte array of size {M}"))
    }

    fn visit_bytes<E: Error>(self, v: &[u8]) -> Result<Self::Value, E> {
        v.try_into()
            .map_err(|_e| Error::invalid_length(v.len(), &self))
    }

    fn visit_seq<A>(self, seq: A) -> Result<Self::Value, A::Error>
    where
        A: serde::de::SeqAccess<'de>,
    {
        struct SeqIter<'de, A, T> {
            access: A,
            marker: PhantomData<(&'de (), T)>,
        }

        impl<'de, A, T> SeqIter<'de, A, T> {
            pub(crate) fn new(access: A) -> Self
            where
                A: serde::de::SeqAccess<'de>,
            {
                Self {
                    access,
                    marker: PhantomData,
                }
            }
        }

        impl<'de, A, T> Iterator for SeqIter<'de, A, T>
        where
            A: serde::de::SeqAccess<'de>,
            T: Deserialize<'de>,
        {
            type Item = Result<T, A::Error>;

            fn next(&mut self) -> Option<Self::Item> {
                self.access.next_element().transpose()
            }

            fn size_hint(&self) -> (usize, Option<usize>) {
                match self.access.size_hint() {
                    Some(size) => (size, Some(size)),
                    None => (0, None),
                }
            }
        }

        fn array_from_iterator<I, T, E, const N: usize>(
            mut iter: I,
            expected: &dyn Expected,
        ) -> Result<[T; N], E>
        where
            I: Iterator<Item = Result<T, E>>,
            E: Error,
        {
            use core::mem::MaybeUninit;

            /// # Safety
            /// The following must be true:
            /// - The first `num` elements must be initialized.
            unsafe fn drop_array_elems<T, const N: usize>(
                num: usize,
                mut arr: [MaybeUninit<T>; N],
            ) {
                arr[..num]
                    .iter_mut()
                    .for_each(|item| unsafe { item.assume_init_drop() });
            }

            // SAFETY: It is safe to assume that array of uninitialized values is initialized itself.
            let mut arr: [MaybeUninit<T>; N] = unsafe { MaybeUninit::uninit().assume_init() };

            // NOTE: Leaks memory on panic
            for (i, elem) in arr[..].iter_mut().enumerate() {
                *elem = match iter.next() {
                    Some(Ok(value)) => MaybeUninit::new(value),
                    Some(Err(err)) => {
                        // SAFETY: Items until `i` were initialized.
                        unsafe { drop_array_elems(i, arr) };
                        return Err(err);
                    }
                    None => {
                        // SAFETY: Items until `i` were initialized.
                        unsafe { drop_array_elems(i, arr) };
                        return Err(Error::invalid_length(i, expected));
                    }
                };
            }

            // Everything is initialized. Transmute the array to the initialized type.
            // A normal transmute is not possible because of:
            // https://github.com/rust-lang/rust/issues/61956
            Ok(unsafe { std::mem::transmute_copy(&arr) })
        }

        array_from_iterator(SeqIter::new(seq), &self)
    }
}

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

    #[test]
    fn struct_with_option_string() {
        #[derive(Debug, Eq, PartialEq, Serialize, Deserialize)]
        struct Test {
            #[serde(with = "option_string")]
            value: Option<u64>,
        }

        for value in [Test { value: None }, Test { value: Some(123) }, Test {
            value: Some(u64::MAX),
        }] {
            let test = serde_json::to_string(&value).unwrap();
            println!("{test}");
            let parsed: Test = serde_json::from_str(&test).unwrap();
            assert_eq!(value, parsed);
        }
    }
}